Merge branch 'vendor/GDB' into gdb7
[dragonfly.git] / usr.sbin / yp_mkdb / yp_mkdb.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/usr.sbin/yp_mkdb/yp_mkdb.8,v 1.12.2.4 2003/03/11 22:31:35 trhodes Exp $
32 .\" $DragonFly: src/usr.sbin/yp_mkdb/yp_mkdb.8,v 1.3 2004/03/11 12:29:00 hmp Exp $
33 .\"
34 .Dd March 12, 1996
35 .Dt YP_MKDB 8
36 .Os
37 .Sh NAME
38 .Nm yp_mkdb
39 .Nd "generate the NIS databases"
40 .Sh SYNOPSIS
41 .Nm
42 .Fl c
43 .Nm
44 .Fl u Ar dbname
45 .Nm
46 .Op Fl c
47 .Op Fl b
48 .Op Fl s
49 .Op Fl f
50 .Op Fl i Ar inputfile
51 .Op Fl o Ar outputfile
52 .Op Fl d Ar domainname
53 .Op Fl m Ar mastername
54 .Ar inputfile
55 .Ar dbname
56 .Sh DESCRIPTION
57 The
58 .Nm
59 utility creates
60 .Xr db 3
61 style databases for use with
62 .Dx Ns 's
63 NIS server.
64 The
65 .Nm
66 utility reads data from
67 .Ar inputfile ,
68 and writes it to
69 .Ar dbname
70 in
71 .Xr db 3
72 format (using the hash table method).
73 The input should be in 'key data' format, which is to say
74 two fields of
75 .Tn ASCII
76 data separated by white space.
77 The first field
78 is assumed to be the key, and everything else is assumed to be
79 the data.
80 These databases are typically stored in
81 .Pa /var/yp/[domainname]
82 where
83 .Ar domainname
84 is the name of the NIS domain being served.
85 The
86 .Nm
87 utility is usually invoked by
88 .Pa /var/yp/Makefile .
89 The
90 .Nm
91 utility can also be used to dump an NIS database file so that its
92 contents can be examined.
93 For security reasons, all databases that
94 .Nm
95 creates are readable and writable by owner only (and usually the
96 owner is root).
97 .Pp
98 The following options are available:
99 .Bl -tag -width indent
100 .It Fl c
101 Cause
102 .Nm
103 to send a YPPROC_CLEAR request to
104 .Xr ypserv 8
105 on the local host.
106 This signal tells the server to close any open
107 database descriptors and flush out its database cache.
108 If used alone,
109 this flag signals the server and does nothing else.
110 If used as part
111 of a database creation command,
112 .Nm
113 will send the signal only after the new database has been successfully
114 created.
115 .It Fl b
116 Cause
117 .Nm
118 to add a special entry to the database with a key of
119 .Em YP_INTERDOMAIN
120 and an empty data field.
121 If this key is present in a map, it alters the
122 behavior of the 'match' procedure in
123 .Xr ypserv 8
124 slightly.
125 If a match query fails (because the server couldn't find
126 a record that matched the supplied key), and the
127 .Em YP_INTERDOMAIN
128 key exists within the queried map,
129 .Xr ypserv 8
130 will try to match the entry again using a DNS lookup.
131 Note that this
132 special behavior only applies to the
133 .Em hosts
134 maps.
135 Using the
136 .Fl b
137 flag for other maps has no effect.
138 .It Fl s
139 This flag is used to add a special entry to the database with a key of
140 .Em YP_SECURE
141 and an empty data field.
142 If this key is present in a map,
143 .Xr ypserv 8
144 will deny access to the map to any client that is not using a
145 reserved port for its query.
146 This is used mainly for the
147 .Em master.passwd
148 maps, which should be restricted to privileged access only.
149 .It Fl f
150 This flag is used to turn on filtering of lines in the source file
151 input that start with ``+'' or ``-'' characters.
152 These characters
153 have special meaning for the
154 .Pa group ,
155 .Pa passwd
156 and
157 .Pa master.passwd
158 maps and hence should not be allowed to appear in them as the first
159 character of a key or datum.
160 If the
161 .Fl f
162 flag is used,
163 .Nm
164 will reject any source line that starts with a ``+'' or ``-''
165 character and issue a warning message displaying the line that
166 was dropped.
167 .It Fl u Ar dbname
168 Dump (or 'unwind') an NIS database.
169 This option can be used to
170 inspect the contents of an existing NIS database.
171 .It Fl i Ar inputfile
172 When generating an NIS map, encode
173 .Ar inputfile
174 as a special entry in the database with a key of
175 .Em YP_INPUT_FILE .
176 .It Fl o Ar outputfile
177 When generating an NIS map, encode
178 .Ar outputfile
179 as a special entry in the database with a key of
180 .Em YP_OUTPUT_FILE .
181 .It Fl d Ar domainname
182 When generating an NIS map, encode
183 .Ar domainname
184 as a special entry in the database with a key of
185 .Em YP_DOMAIN_NAME .
186 .It Fl m Ar mastername
187 When generating an NIS map, encode
188 .Ar mastername
189 as a special entry in the database with a key of
190 .Em YP_MASTER_NAME .
191 This entry in the database is frequently used by various NIS utilities
192 to determine the name of an NIS master server for a domain.
193 By default,
194 .Nm
195 assumes that the local host is the NIS master; the
196 .Fl m
197 option is used to override this default.
198 .El
199 .Sh FILES
200 .Bl -tag -width /var/yp/Makefile -compact
201 .It Pa /var/yp/Makefile
202 the Makefile that calls
203 .Nm
204 to build the NIS databases
205 .El
206 .Sh SEE ALSO
207 .Xr db 3 ,
208 .Xr ypserv 8
209 .Sh AUTHORS
210 .An Bill Paul Aq wpaul@ctr.columbia.edu