Merge branch 'vendor/TNFTP'
[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 .\"
33 .Dd June 23, 1996
34 .Dt MKNETID 8
35 .Os
36 .Sh NAME
37 .Nm mknetid
38 .Nd "generate netid map data"
39 .Sh SYNOPSIS
40 .Nm
41 .Op Fl q
42 .Op Fl g Ar group_file
43 .Op Fl p Ar passwd_file
44 .Op Fl h Ar hosts_file
45 .Op Fl n Ar netid_file
46 .Op Fl d Ar domain
47 .Sh DESCRIPTION
48 .Nm Mknetid
49 processes the contents of the
50 .Xr group 5 ,
51 .Xr passwd 5 ,
52 .Xr hosts 5
53 and
54 .Xr netid 5
55 files into the format used to generate the
56 .Pa netid.byname
57 .Tn NIS
58 map.
59 This map is used to hold credential information for both users
60 and hosts in an operating system independent format.
61 .Pp
62 The
63 .Nm
64 command checks for duplicate occurrences of netids and filters
65 them out.
66 .Pp
67 The
68 .Nm
69 command prints its results on the standard output.
70 It is usually called
71 only by
72 .Pa /var/yp/Makefile
73 when rebuilding the
74 .Tn NIS
75 maps.
76 .Sh OPTIONS
77 The
78 .Nm
79 command supports the following options:
80 .Bl -tag -width indent
81 .It Fl q
82 Normally,
83 .Nm
84 prints a warning message when it encounters a duplicate netid.
85 This flag turns on 'quiet' mode, allowing the warnings to be
86 suppressed.
87 Other error messages may still be generated.
88 .It Fl g Ar group_file
89 Specify the location of the group information
90 file.
91 The compiled-in default is
92 .Pa /etc/group .
93 .It Fl p Ar passwd_file
94 Specify the location of the passwd information
95 file.
96 The compiled-in default is
97 .Pa /etc/passwd .
98 .It Fl h Ar hosts_file
99 Specify the location of the hosts database
100 file.
101 The compiled-in default is
102 .Pa /etc/hosts .
103 .It Fl n Ar netid_file
104 Specify the location of the netid information
105 file.
106 The compiled-in default is
107 .Pa /etc/netid .
108 Note that no error is generated if the netid database can't be
109 found.
110 The netid database is not likely to be present on most systems
111 until
112 .Tn Secure RPC
113 support is added to
114 .Dx .
115 .It Fl d Ar domain
116 By default, the
117 .Nm
118 command uses the system domainname when generating netid records.
119 If
120 the system domainname is not set, the domain must be specified on the
121 command line with the
122 .Fl d
123 flag.
124 If the domainname is set, the
125 .Fl d
126 flag may be used to override it.
127 .El
128 .Sh FILES
129 .Bl -tag -width /var/yp/Makefile -compact
130 .It Pa /var/yp/Makefile
131 the Makefile that calls
132 .Nm yp_mkdb
133 and
134 .Nm
135 to build the
136 .Tn NIS
137 databases
138 .It Pa /etc/group
139 the default group database file
140 .It Pa /etc/passwd
141 the default passwd database file
142 .It Pa /etc/hosts
143 the default hosts database file
144 .It Pa /etc/netid
145 the default netid database file
146 .El
147 .Sh SEE ALSO
148 .Xr yp 8 ,
149 .Xr yp_mkdb 8
150 .Sh AUTHORS
151 .An Bill Paul Aq Mt wpaul@ctr.columbia.edu