| 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 h |
| 14 |
.Op Fl f |
| 15 |
.Op Fl v |
| 16 |
.Op Fl C |
| 17 |
.Op Fl S |
| 18 |
.Op Fl p Ar path |
| 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 system derives the |
| 27 |
.Em user |
| 28 |
part of the string by performing a password or group lookup. |
| 29 |
The lookup mechanism is configured in |
| 30 |
.Pa /etc/idmapd.conf |
| 31 |
.Pp |
| 32 |
By default, the |
| 33 |
.Em domain |
| 34 |
part of the string is the system's DNS domain name. |
| 35 |
It can also be specified in |
| 36 |
.Pa /etc/idmapd.conf |
| 37 |
if the system is multi-homed, |
| 38 |
or if the system's DNS domain name does |
| 39 |
not match the name of the system's Kerberos realm. |
| 40 |
.Pp |
| 41 |
When the domain is not specified in /etc/idmapd.conf |
| 42 |
the local DNS server will be queried for the |
| 43 |
.Sy _nfsv4idmapdomain |
| 44 |
text record. If the record exists |
| 45 |
that will be used as the domain. When the record |
| 46 |
does not exist, the domain part of the DNS domain |
| 47 |
will used. |
| 48 |
.Pp |
| 49 |
Note that on more recent kernels only the NFSv4 server uses |
| 50 |
.Nm . |
| 51 |
The NFSv4 client instead uses |
| 52 |
.Xr nfsidmap 8 , |
| 53 |
and only falls back to |
| 54 |
.Nm |
| 55 |
if there was a problem running the |
| 56 |
.Xr nfsidmap 8 |
| 57 |
program. |
| 58 |
.Pp |
| 59 |
The options are as follows: |
| 60 |
.Bl -tag -width Ds_imagedir |
| 61 |
.It Fl h |
| 62 |
Display usage message. |
| 63 |
.It Fl v |
| 64 |
Increases the verbosity level (can be specified multiple times). |
| 65 |
.It Fl f |
| 66 |
Runs |
| 67 |
.Nm |
| 68 |
in the foreground and prints all output to the terminal. |
| 69 |
.It Fl p Ar path |
| 70 |
Specifies the location of the RPC pipefs to be |
| 71 |
.Ar path . |
| 72 |
The default value is \&"/var/lib/nfs/rpc_pipefs\&". |
| 73 |
.It Fl c Ar path |
| 74 |
Use configuration file |
| 75 |
.Ar path . |
| 76 |
This option is deprecated. |
| 77 |
.It Fl C |
| 78 |
Client-only: perform no idmapping for any NFS server, even if one is detected. |
| 79 |
.It Fl S |
| 80 |
Server-only: perform no idmapping for any NFS client, even if one is detected. |
| 81 |
.El |
| 82 |
.Sh CONFIGURATION FILES |
| 83 |
.Nm |
| 84 |
recognizes the following value from the |
| 85 |
.Sy [general] |
| 86 |
section of the |
| 87 |
.Pa /etc/nfs.conf |
| 88 |
configuration file: |
| 89 |
.Bl -tag -width Ds_imagedir |
| 90 |
.It Sy pipefs-directory |
| 91 |
Equivalent to |
| 92 |
.Sy -p . |
| 93 |
.El |
| 94 |
.Pp |
| 95 |
All other settings related to id mapping are found in the |
| 96 |
.Pa /etc/idmapd.conf |
| 97 |
configuration file. |
| 98 |
.Sh EXAMPLES |
| 99 |
.Cm rpc.idmapd -f -vvv |
| 100 |
.Pp |
| 101 |
Runs |
| 102 |
.Nm |
| 103 |
printing all |
| 104 |
messages to console, and with a verbosity level of 3. |
| 105 |
.\" This next request is for sections 2 and 3 function return values only. |
| 106 |
.\" .Sh RETURN VALUES |
| 107 |
.\" The next request is for sections 2 and 3 error and signal handling only. |
| 108 |
.\" .Sh ERRORS |
| 109 |
.\" This next request is for section 4 only. |
| 110 |
.\" .Sh DIAGNOSTICS |
| 111 |
.\" This next request is for sections 1, 6, 7 & 8 only. |
| 112 |
.\" .Sh ENVIRONMENT |
| 113 |
.Sh FILES |
| 114 |
.Pa /etc/idmapd.conf , |
| 115 |
.Pa /etc/nfs.conf |
| 116 |
.Sh SEE ALSO |
| 117 |
.Xr idmapd.conf 5 , |
| 118 |
.Xr nfs.conf 5 , |
| 119 |
.Xr nfsidmap 8 |
| 120 |
.\".Sh SEE ALSO |
| 121 |
.\".Xr nylon.conf 4 |
| 122 |
.\" .Sh COMPATIBILITY |
| 123 |
.\".Sh STANDARDS |
| 124 |
.\".Sh ACKNOWLEDGEMENTS |
| 125 |
.Sh AUTHORS |
| 126 |
The |
| 127 |
.Nm |
| 128 |
software has been developed by Marius Aamodt Eriksen |
| 129 |
.Aq [email protected] . |
| 130 |
.\" .Sh HISTORY |
| 131 |
.\".Sh BUGS |
| 132 |
.\"Please report any bugs to Marius Aamodt Eriksen |
| 133 |
.\".Aq [email protected] . |
| 134 |
.\" .Sh CAVEATS |