Merge branch 'vendor/BINUTILS220'
[dragonfly.git] / libexec / mknetid / mknetid.8
1 .\" Copyright (c) 1995, 1996
2 .\"     Bill Paul <wpaul@ctr.columbia.edu>.  All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\"    notice, this list of conditions and the following disclaimer in the
11 .\"    documentation and/or other materials provided with the distribution.
12 .\" 3. All advertising materials mentioning features or use of this software
13 .\"    must display the following acknowledgement:
14 .\"     This product includes software developed by Bill Paul.
15 .\" 4. 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 Bill Paul 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 Bill Paul 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 .\" $FreeBSD: src/libexec/mknetid/mknetid.8,v 1.7.2.5 2002/02/01 15:51:17 ru Exp $
32 .\" $DragonFly: src/libexec/mknetid/mknetid.8,v 1.4 2008/04/15 19:19:49 swildner Exp $
33 .\"
34 .Dd June 23, 1996
35 .Dt MKNETID 8
36 .Os
37 .Sh NAME
38 .Nm mknetid
39 .Nd "generate netid map data"
40 .Sh SYNOPSIS
41 .Nm
42 .Op Fl q
43 .Op Fl g Ar group_file
44 .Op Fl p Ar passwd_file
45 .Op Fl h Ar hosts_file
46 .Op Fl n Ar netid_file
47 .Op Fl d Ar domain
48 .Sh DESCRIPTION
49 .Nm Mknetid
50 processes the contents of the
51 .Xr group 5 ,
52 .Xr passwd 5 ,
53 .Xr hosts 5
54 and
55 .Xr netid 5
56 files into the format used to generate the
57 .Pa netid.byname
58 .Tn NIS
59 map.
60 This map is used to hold credential information for both users
61 and hosts in an operating system independent format.
62 .Pp
63 The
64 .Nm
65 command checks for duplicate occurrences of netids and filters
66 them out.
67 .Pp
68 The
69 .Nm
70 command prints its results on the standard output.
71 It is usually called
72 only by
73 .Pa /var/yp/Makefile
74 when rebuilding the
75 .Tn NIS
76 maps.
77 .Sh OPTIONS
78 The
79 .Nm
80 command supports the following options:
81 .Bl -tag -width indent
82 .It Fl q
83 Normally,
84 .Nm
85 prints a warning message when it encounters a duplicate netid.
86 This flag turns on 'quiet' mode, allowing the warnings to be
87 suppressed.
88 Other error messages may still be generated.
89 .It Fl g Ar group_file
90 Specify the location of the group information
91 file.
92 The compiled-in default is
93 .Pa /etc/group .
94 .It Fl p Ar passwd_file
95 Specify the location of the passwd information
96 file.
97 The compiled-in default is
98 .Pa /etc/passwd .
99 .It Fl h Ar hosts_file
100 Specify the location of the hosts database
101 file.
102 The compiled-in default is
103 .Pa /etc/hosts .
104 .It Fl n Ar netid_file
105 Specify the location of the netid information
106 file.
107 The compiled-in default is
108 .Pa /etc/netid .
109 Note that no error is generated if the netid database can't be
110 found.
111 The netid database is not likely to be present on most systems
112 until
113 .Tn Secure RPC
114 support is added to
115 .Dx .
116 .It Fl d Ar domain
117 By default, the
118 .Nm
119 command uses the system domainname when generating netid records.
120 If
121 the system domainname is not set, the domain must be specified on the
122 command line with the
123 .Fl d
124 flag.
125 If the domainname is set, the
126 .Fl d
127 flag may be used to override it.
128 .El
129 .Sh FILES
130 .Bl -tag -width /var/yp/Makefile -compact
131 .It Pa /var/yp/Makefile
132 the Makefile that calls
133 .Nm yp_mkdb
134 and
135 .Nm
136 to build the
137 .Tn NIS
138 databases
139 .It Pa /etc/group
140 the default group database file
141 .It Pa /etc/passwd
142 the default passwd database file
143 .It Pa /etc/hosts
144 the default hosts database file
145 .It Pa /etc/netid
146 the default netid database file
147 .El
148 .Sh SEE ALSO
149 .Xr yp 8 ,
150 .Xr yp_mkdb 8
151 .Sh AUTHORS
152 .An Bill Paul Aq wpaul@ctr.columbia.edu