~ubuntu-branches/ubuntu/oneiric/nis/oneiric-proposed

« back to all changes in this revision

Viewing changes to ypserv-2.18/ypxfr/ypxfr.8.in

  • Committer: Bazaar Package Importer
  • Author(s): Scott James Remnant
  • Date: 2005-11-16 23:42:06 UTC
  • mfrom: (1.1.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20051116234206-p00omaw5ji5q0qhr
Tags: 3.15-3ubuntu1
Resynchronise with Debian.  (me)

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.\" Copyright (c) 1996, 1997, 1999, 2001 Thorsten Kukuk <kukuk@suse.de>
 
2
.TH YPSERV 8 "August 2001" "YP Server" ""
 
3
.SH NAME
 
4
ypxfr - transfer NIS database from remote server to local host
 
5
.SH SYNOPSIS
 
6
.B @YPBINDIR@/ypxfr
 
7
[
 
8
.B \-f
 
9
]
 
10
[
 
11
.B \-c
 
12
]
 
13
[
 
14
.B \-d
 
15
.I target domain
 
16
]
 
17
.if n .ti +5n
 
18
[
 
19
.B \-h
 
20
.I source host
 
21
]
 
22
[
 
23
.B \-s
 
24
.I source domain
 
25
]
 
26
.if n .ti +5n
 
27
[
 
28
.B \-C
 
29
.I taskid
 
30
.I program-number
 
31
.I ipaddr port
 
32
]
 
33
.if n .ti +5n
 
34
[
 
35
.B \-p
 
36
.I yp_path
 
37
]
 
38
mapname ...
 
39
 
 
40
.SH DESCRIPTION
 
41
.B ypxfr
 
42
copies an NIS database from one NIS server to the local host by
 
43
using the NIS service.
 
44
.B ypxfr
 
45
is generally invoked by
 
46
.B ypinit
 
47
or by
 
48
.B ypserv,
 
49
when
 
50
.B ypserv
 
51
receives a map transfer request from
 
52
.B yppush.
 
53
It creates a temporary map in the directory
 
54
.B @YPMAPDIR@/domain
 
55
(this  directory  must already  exist;
 
56
.I domain
 
57
is the default domainname for the local host), fills it by getting
 
58
the map's entries and fetches the map parameters (master and order number).
 
59
If the transfer was successful, the old version of the map will be
 
60
deleted and the temporary copy will be moved into its place.
 
61
Then,
 
62
.B ypxfr
 
63
will attempt to send a "clear current map" request to the local
 
64
.B ypserv.
 
65
 
 
66
If  run interactively,
 
67
.B ypxfr
 
68
writes its output to stderr.
 
69
However, if it is invoked without a controlling terminal, it will
 
70
log the output to syslog.
 
71
 
 
72
.B ypxfr
 
73
is used primarily in environments where several NIS servers are in use.
 
74
For all maps, you have a NIS master server, which  maintains a canonical
 
75
copy of the NIS map, and all the other servers, the NIS slaves, copy
 
76
the new version of the map from the master whenever a update was made.
 
77
Normally, you have one NIS master for all maps.
 
78
 
 
79
In order to maintain consistency across all NIS servers,
 
80
.B ypxfr
 
81
can be run periodically in a
 
82
.B cron
 
83
job. Maps which change infrequently need only be updated once a day
 
84
(preferably late at night when system usage is lowest), where those
 
85
with frequent changes (such as
 
86
.I passwd.byname
 
87
and
 
88
.I passwd.byuid )
 
89
should be updated perhaps once every hour.
 
90
Examples are in
 
91
.B @YPBINDIR@: ypxfr_1perday, ypxfr_2perday,
 
92
and
 
93
.B ypxfr_1perhour.
 
94
They can serve as reasonable first cuts.
 
95
 
 
96
Normally all updates should be propagated by
 
97
.B yppush
 
98
when
 
99
.B @YPMAPDIR@/Makefile
 
100
is run on the NIS master server, however it is a good practice
 
101
on large networks where possible outages could cause NIS slaves to
 
102
fall out of sync with the master.
 
103
 
 
104
 
 
105
.SH OPTIONS
 
106
The following options are supported:
 
107
.TP
 
108
.B \-f
 
109
Force a map transfer. Normally,
 
110
.B ypxfr
 
111
will not transfer a map if it determines that the NIS master's copy
 
112
is not newer than the existing copy already on the local host. This
 
113
flag forces a transfer regardless of which server's version is more
 
114
recent.
 
115
.TP
 
116
.B \-c
 
117
Do not send a "clear current map" request to the
 
118
.B ypserv
 
119
process running on the local host. This flag is normally used when
 
120
invoking
 
121
.B ypxfr
 
122
by
 
123
.B ypinit
 
124
or if
 
125
.B ypserv
 
126
is not  running  locally  at  the time you are running
 
127
.B ypxfr.
 
128
Otherwise,
 
129
.B ypxfr
 
130
will complain that it cannot talk to the local
 
131
.B ypserv,
 
132
and the transfer will fail.
 
133
.TP
 
134
.BI \-d " domain"
 
135
Specify a domain other than the default NIS domain.
 
136
.TP
 
137
.BI \-h " source host"
 
138
Get the map from
 
139
.IR host ,
 
140
regardless of what the map says the master is.  If
 
141
.I host
 
142
is not specified,
 
143
.B ypxfr
 
144
asks the
 
145
.SM NIS
 
146
service for the name of the master, and tries to get the
 
147
map from there. This option is used to insure that ypxfr only copies
 
148
maps from the NIS master server.
 
149
.TP
 
150
.BI \-s " source domain"
 
151
Specify a source domain from which to transfer a map that should be the same
 
152
across domains.
 
153
.TP
 
154
.BI \-C  " taskid progam-number ipaddr port"
 
155
This option is
 
156
.B only
 
157
for use by
 
158
.B ypserv .
 
159
When
 
160
.B ypserv
 
161
invokes
 
162
.BR ypxfr ,
 
163
it specifies that
 
164
.B ypxfr
 
165
should call back a
 
166
.B yppush
 
167
process at the host with
 
168
.SM IP
 
169
address
 
170
.IR ipaddr ,
 
171
registered as program number
 
172
.IR progam-number ,
 
173
listening on port
 
174
.IR port ,
 
175
and waiting for a response to transaction
 
176
.IR taskid .
 
177
.TP
 
178
.BI \-p " yp_path"
 
179
Change the directory for the maps to
 
180
\fIyp_path/[domainname]/\fP, the default
 
181
is \fI@YPMAPDIR@/[domainname]\fP.
 
182
.TP
 
183
.I mapname
 
184
One or more names of the map to transfer.
 
185
.SH FILES
 
186
@YPMAPDIR@/[domainname]/[maps]
 
187
.SH "SEE ALSO"
 
188
.BR ypserv (8),
 
189
.BR yppush (8),
 
190
.BR ypinit (8),
 
191
.BR cron (8),
 
192
.BR crontab (5)
 
193
.SH AUTHOR
 
194
Thorsten Kukuk <kukuk@suse.de>