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