Sync usage with man page.
[netbsd-mini2440.git] / usr.bin / ypcat / nicknames.5
blob00ddf21ae18029d45c2d1d7e53277c65d2c2a746
1 .\" $NetBSD: nicknames.5,v 1.1 2009/06/20 19:27:26 christos Exp $
2 .\"
3 .\"
4 .\" Copyright (c) 2003 The NetBSD Foundation
5 .\" All rights reserved.
6 .\"
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
9 .\" are met:
10 .\" 1. Redistributions of source code must retain the above copyright
11 .\"    notice, this list of conditions and the following disclaimer.
12 .\" 2. Redistributions in binary form must reproduce the above copyright
13 .\"    notice, this list of conditions and the following disclaimer in the
14 .\"    documentation and/or other materials provided with the distribution.
15 .\" 3. The name of the author may not be used to endorse or promote
16 .\"    products derived from this software without specific prior written
17 .\"    permission.
18 .\"
19 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
20 .\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21 .\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR 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 .Dd August 28, 2003
32 .Dt NICKNAMES 5
33 .Os
34 .Sh NAME
35 .Nm nicknames
36 .Nd map nickname translation file for NIS (YP)
37 .Sh DESCRIPTION
38 The
39 .Xr ypcat 1 ,
40 .Xr ypmatch 1 ,
41 and
42 .Xr ypwhich 1
43 commands reference NIS (YP) maps as specified by the user.
44 Occasionally it is desirable to use a shorthand reference for a
45 longer map name, hence the
46 .Nm
47 file, kept in
48 .Dq /var/yp/nicknames.
49 .Pp
50 The format of the file is
51 .Pp
52 .Dl nickname map
53 .Pp
54 one pair per line.
55 The default installed nickname map is as follows:
56 .Pp
57 .Bl -tag -width protocols -offset indent -compact
58 .It passwd
59 passwd.byname
60 .It group
61 group.byname
62 .It networks
63 networks.byaddr
64 .It hosts
65 hosts.byname
66 .It protocols
67 protocols.bynumber
68 .It services
69 services.byname
70 .It aliases
71 aliases.byname
72 .It ethers
73 ethers.byname
74 .It master.passwd
75 master.passwd.byname
76 .El
77 .Pp
78 A blank or incomplete
79 .Nm
80 file will affect any scripts which use nicknames for map lookup,
81 whereas if the file is simply missing, the default compiled-in list
82 will be used.
83 .Sh SEE ALSO
84 .Xr ypcat 1 ,
85 .Xr ypmatch 1 ,
86 .Xr ypwhich 1
87 .Sh HISTORY
88 The
89 .Nm
90 file first appeared in Solaris 2.4.