Add the idmapd files...
[nfs-utils.git] / utils / idmapd / idmapd.man
1 .\"     $OpenBSD: mdoc.template,v 1.6 2001/02/03 08:22:44 niklas Exp $
2 .\"
3 .\" The following requests are required for all man pages.
4 .Dd February 3, 2003
5 .Dt RPC.IDMAPD 8
6 .Os
7 .Sh NAME
8 .Nm rpc.idmapd
9 .Nd NFSv4 ID <-> Name Mapper
10 .Sh SYNOPSIS
11 .\" For a program:  program [-abc] file ...
12 .Nm rpc.idmapd
13 .Op Fl v
14 .Op Fl f
15 .Op Fl d Ar domain
16 .Op Fl p Ar path
17 .Op Fl U Ar username
18 .Op Fl G Ar groupname
19 .Op Fl c Ar path
20 .Sh DESCRIPTION
21 .Nm
22 is the NFSv4 ID <-> name mapping daemon.  It provides functionality to
23 the NFSv4 kernel client and server, to which it communicates via
24 upcalls, by translating user and group IDs to names, and vice versa.
25 .Pp
26 The options are as follows:
27 .Bl -tag -width Ds_imagedir
28 .It Fl v
29 Increases the verbosity level (can be specified multiple times).
30 .It Fl f
31 Runs
32 .Nm
33 in the foreground and prints all output to the terminal.
34 .It Fl d Ar domain
35 Set domain to
36 .Ar domain .
37 This is used internally by NFSv4 and is typically assigned by the
38 system administrator.  By default,
39 .Ar domain
40 is set to be the FQDN of the host, minus the hostname.
41 .It Fl p Ar path
42 Specifies the location of the RPC pipefs to be
43 .Ar path .
44 The default value is \&"/var/lib/nfs/rpc_pipefs\&".
45 .It Fl U Ar username
46 Specifies the NFSv4 nobody user to be
47 .Ar username .
48 The default value is \&"nobody\&".
49 .It Fl G Ar groupname
50 Specifies the NFSv4 nobody group to be
51 .Ar groupname .
52 The default value is \&"nobody\&".
53 .It Fl c Ar path
54 Use configuration file
55 .Ar path .
56 .It Fl C
57 Client-only: perform no idmapping for any NFS server, even if one is detected.
58 .It Fl S
59 Server-only: perform no idmapping for any NFS client, even if one is detected.
60 .El
61 .Sh EXAMPLES
62 .Cm rpc.idmapd -d \&"citi.umich.edu\&" -f -vvv
63 .Pp
64 Runs
65 .Nm
66 with the domain \&"citi.umich.edu\&" in the foreground, printing all
67 messages to console, and with a verbosity level of 3.
68 .\" This next request is for sections 2 and 3 function return values only.
69 .\" .Sh RETURN VALUES
70 .\" The next request is for sections 2 and 3 error and signal handling only.
71 .\" .Sh ERRORS
72 .\" This next request is for section 4 only.
73 .\" .Sh DIAGNOSTICS
74 .\" This next request is for sections 1, 6, 7 & 8 only.
75 .\" .Sh ENVIRONMENT
76 .Sh FILES
77 .Pa /etc/idmapd.conf
78 .Sh SEE ALSO
79 .Xr idmapd.conf 5
80 .\".Sh SEE ALSO
81 .\".Xr nylon.conf 4
82 .\" .Sh COMPATIBILITY
83 .\".Sh STANDARDS
84 .\".Sh ACKNOWLEDGEMENTS
85 .Sh AUTHORS
86 The
87 .Nm
88 software has been developed by Marius Aamodt Eriksen
89 .Aq marius@citi.umich.edu .
90 .\" .Sh HISTORY
91 .\".Sh BUGS
92 .\"Please report any bugs to Marius Aamodt Eriksen
93 .\".Aq marius@monkey.org .
94 .\" .Sh CAVEATS