8322 nl: misleading-indentation
[unleashed/tickless.git] / usr / src / man / man4 / updaters.4
blob1efaf5c3fa19c78c188398ebdc58b465455ab4cf
1 '\" te
2 .\"  Copyright 1989 AT&T  Copyright (c) 1988 Sun Microsystems, Inc. - All Rights Reserved.  All Rights Reserved
3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH UPDATERS 4 "Oct 24, 1996"
7 .SH NAME
8 updaters \- configuration file for NIS updating
9 .SH SYNOPSIS
10 .LP
11 .nf
12 \fB/var/yp/updaters\fR
13 .fi
15 .SH DESCRIPTION
16 .sp
17 .LP
18 The file \fB/var/yp/updaters\fR is a makefile (see \fBmake\fR(1S)) which is
19 used for updating the Network Information Service (NIS) databases. Databases
20 can only be updated in a secure network, that is, one that has a
21 \fBpublickey\fR(4) database. Each entry in the file is a make target for a
22 particular \fBNIS\fR database. For example, if there is an \fBNIS\fR database
23 named \fBpasswd.byname\fR that can be updated, there should be a \fBmake\fR
24 target named \fBpasswd.byname\fR in the \fBupdaters\fR file with the command to
25 update the file.
26 .sp
27 .LP
28 The information necessary to make the update is passed to the update command
29 through standard input. The information passed is described below (all items
30 are followed by a \fBNEWLINE\fR except for 4 and 6):
31 .sp
32 .ne 2
33 .na
34 \fB\fB1.\fR\fR
35 .ad
36 .RS 6n
37 Network name of client wishing to make the update (a string).
38 .RE
40 .sp
41 .ne 2
42 .na
43 \fB\fB2.\fR\fR
44 .ad
45 .RS 6n
46 Kind of update (an integer).
47 .RE
49 .sp
50 .ne 2
51 .na
52 \fB\fB3.\fR\fR
53 .ad
54 .RS 6n
55 Number of bytes in key (an integer).
56 .RE
58 .sp
59 .ne 2
60 .na
61 \fB\fB4.\fR\fR
62 .ad
63 .RS 6n
64 Actual bytes of key.
65 .RE
67 .sp
68 .ne 2
69 .na
70 \fB\fB5.\fR\fR
71 .ad
72 .RS 6n
73 Number of bytes in data (an integer).
74 .RE
76 .sp
77 .ne 2
78 .na
79 \fB\fB6.\fR\fR
80 .ad
81 .RS 6n
82 Actual bytes of data.
83 .RE
85 .sp
86 .LP
87 After receiving this information through standard input, the command  to update
88 the particular database determines whether the user is  allowed to make the
89 change.  If not, it exits with the status \fBYPERR_ACCESS.\fR If the user is
90 allowed to make the change, the command makes the  change and exits with a
91 status of zero. If there are any errors that may prevent the  \fBupdaters\fR
92 from making the change, it should exit with the status that matches a valid
93 \fBNIS\fR error code described in \fB<rpcsvc/ypclnt.h>\fR\&.
94 .SH FILES
95 .sp
96 .ne 2
97 .na
98 \fB\fB/var/yp/updaters\fR\fR
99 .ad
100 .RS 20n
101 The makefile used for updating the  \fBNIS\fR databases.
104 .SH SEE ALSO
107 \fBmake\fR(1S), \fBrpc.ypupdated\fR(1M), \fBpublickey\fR(4)
108 .SH NOTES
111 The Network Information Service (NIS) was formerly known as Sun Yellow Pages
112 (YP).  The functionality of the two remains the same; only the name has
113 changed. The name Yellow Pages is a registered trademark in the United Kingdom
114 of British Telecommunications plc, and may not be used without permission.