xref: /openbsd-src/usr.sbin/portmap/portmap.8 (revision 337a50c064c7e7f9e8b2b411efdd078be761dc54)
1*337a50c0Sjmc.\"	$OpenBSD: portmap.8,v 1.11 2019/03/03 18:28:33 jmc Exp $
29d0b46bcSjmc.\"
3df930be7Sderaadt.\" Copyright (c) 1987 Sun Microsystems
4df930be7Sderaadt.\" Copyright (c) 1990, 1991 The Regents of the University of California.
5df930be7Sderaadt.\" All rights reserved.
6df930be7Sderaadt.\"
7df930be7Sderaadt.\" Redistribution and use in source and binary forms, with or without
8df930be7Sderaadt.\" modification, are permitted provided that the following conditions
9df930be7Sderaadt.\" are met:
10df930be7Sderaadt.\" 1. Redistributions of source code must retain the above copyright
11df930be7Sderaadt.\"    notice, this list of conditions and the following disclaimer.
12df930be7Sderaadt.\" 2. Redistributions in binary form must reproduce the above copyright
13df930be7Sderaadt.\"    notice, this list of conditions and the following disclaimer in the
14df930be7Sderaadt.\"    documentation and/or other materials provided with the distribution.
1529295d1cSmillert.\" 3. Neither the name of the University nor the names of its contributors
16df930be7Sderaadt.\"    may be used to endorse or promote products derived from this software
17df930be7Sderaadt.\"    without specific prior written permission.
18df930be7Sderaadt.\"
19df930be7Sderaadt.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20df930be7Sderaadt.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21df930be7Sderaadt.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22df930be7Sderaadt.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23df930be7Sderaadt.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24df930be7Sderaadt.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25df930be7Sderaadt.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26df930be7Sderaadt.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27df930be7Sderaadt.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28df930be7Sderaadt.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29df930be7Sderaadt.\" SUCH DAMAGE.
30df930be7Sderaadt.\"
31df930be7Sderaadt.\"     from: @(#)portmap.8	5.3 (Berkeley) 3/16/91
32df930be7Sderaadt.\"
33db513ec1Sderaadt.Dd $Mdocdate: March 3 2019 $
34df930be7Sderaadt.Dt PORTMAP 8
35fc8533a3Saaron.Os
36df930be7Sderaadt.Sh NAME
37df930be7Sderaadt.Nm portmap
38db513ec1Sderaadt.Nd Internet protocol port to RPC program number mapper
39df930be7Sderaadt.Sh SYNOPSIS
40df930be7Sderaadt.Nm portmap
41df930be7Sderaadt.Op Fl d
42df930be7Sderaadt.Sh DESCRIPTION
43fc8533a3Saaron.Nm portmap
44*337a50c0Sjmcis a server that converts RPC program numbers into Internet
45df930be7Sderaadtprotocol port numbers.
46e34c0550SschwarzeIt must be running in order to make RPC calls.
47df930be7Sderaadt.Pp
48e34c0550SschwarzeWhen an RPC server is started, it will tell
49df930be7Sderaadt.Nm portmap
50e34c0550Sschwarzewhat port number it is listening to, and what RPC
51df930be7Sderaadtprogram numbers it is prepared to serve.
52e34c0550SschwarzeWhen a client wishes to make an RPC
53df930be7Sderaadtcall to a given program number,
54df930be7Sderaadtit will first contact
55df930be7Sderaadt.Nm portmap
56df930be7Sderaadton the server machine to determine
57e34c0550Sschwarzethe port number where RPC packets should be sent.
58df930be7Sderaadt.Pp
59fc8533a3Saaron.Nm portmap
60e34c0550Sschwarzemust be started before any RPC servers are invoked.
61df930be7Sderaadt.Pp
62df930be7SderaadtNormally
63df930be7Sderaadt.Nm portmap
64df930be7Sderaadtforks and dissociates itself from the terminal
65df930be7Sderaadtlike any other daemon.
66fc8533a3Saaron.Nm portmap
67df930be7Sderaadtthen logs errors using
68df930be7Sderaadt.Xr syslog 3 .
69df930be7Sderaadt.Pp
7028b8f0eaSjmcThe options are as follows:
71df930be7Sderaadt.Bl -tag -width Ds
72df930be7Sderaadt.It Fl d
73df930be7Sderaadt(debug) prevents
74df930be7Sderaadt.Nm portmap
75df930be7Sderaadtfrom running as a daemon,
76df930be7Sderaadtand causes errors and debugging information
77df930be7Sderaadtto be printed to the standard error output.
78df930be7Sderaadt.El
79df930be7Sderaadt.Sh SEE ALSO
80350bb3b8Salex.Xr inetd 8 ,
81350bb3b8Salex.Xr rpcinfo 8
82df930be7Sderaadt.Sh HISTORY
83df930be7SderaadtThe
84df930be7Sderaadt.Nm
85df930be7Sderaadtcommand appeared in
8629d0a930Sjmc.Bx 4.3 .
879d0b46bcSjmc.Sh BUGS
889d0b46bcSjmcIf
899d0b46bcSjmc.Nm portmap
909d0b46bcSjmccrashes, all servers must be restarted.
91