Merge from vendor branch NTPD:
[dragonfly.git] / libexec / mknetid / netid.5
1 .\" Copyright (c) 1996 Mats O Jansson <moj@stacken.kth.se>
2 .\" 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 Mats O Jansson
15 .\" 4. The name of the author may not be used to endorse or promote products
16 .\"    derived from this software without specific prior written permission.
17 .\"
18 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
19 .\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20 .\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
22 .\" DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 .\" SUCH DAMAGE.
29 .\"
30 .\" $FreeBSD: src/libexec/mknetid/netid.5,v 1.1.2.2 2002/02/01 15:51:17 ru Exp $
31 .\" $DragonFly: src/libexec/mknetid/netid.5,v 1.2 2003/06/17 04:27:07 dillon Exp $
32 .\"
33 .Dd January 13, 1996
34 .Dt NETID 5
35 .Os
36 .Sh NAME
37 .Nm netid
38 .Nd
39 .Tn YP
40 network credential file
41 .Sh DESCRIPTION
42 Files in
43 .Nm
44 format are rare.
45 One lives in the
46 .Tn YP
47 map
48 .Pa netid.byname .
49 The format is rather simple.
50 Each row consists of two items: a key and a value.
51 When created by
52 .Xr mknetid 8
53 there are three types of records.
54 .Pp
55 The first type is information about which GIDs a UID has:
56 .Pp
57 .Sm off
58 .Li unix . Ao Ar uid Ac @ Aq Ar yp-domain
59 .Sm on
60 .Sm off
61 .Ao Ar uid Ac : Ao Ar gid Ac , Aq Ar gid
62 .Sm on
63 .Pp
64 The second type contains information about hosts:
65 .Pp
66 .Sm off
67 .Li unix . Ao Ar hostname Ac @ Aq Ar yp-domain
68 .Sm on
69 .Sm off
70 .Li 0 : Aq Ar hostname
71 .Sm on
72 .Pp
73 The third type refers to records from a
74 .Xr netid 5
75 file other than the two types above.
76 .Sh EXAMPLES
77 A configuration file might look like the following:
78 .Bd -literal
79 unix.10714@kaka 10714:400,10
80 unix.jodie@kaka 0:jodie
81 .Ed
82 .Sh FILES
83 .Bl -tag -width ".Pa /etc/netid" -compact
84 .It Pa /etc/netid
85 for lines not generated automatically by
86 .Xr mknetid 8
87 .El
88 .Sh SEE ALSO
89 .Xr mknetid 8 ,
90 .Xr yp 8
91 .Sh AUTHORS
92 .An Mats O Jansson Aq moj@stacken.kth.se