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