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