~ubuntu-branches/ubuntu/saucy/autofs/saucy-proposed

« back to all changes in this revision

Viewing changes to 039_updated_manpages

  • Committer: Bazaar Package Importer
  • Author(s): Steinar H. Gunderson
  • Date: 2005-05-13 13:39:52 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20050513133952-teczxws3qt5wo40h
Tags: 4.1.3+4.1.4beta2-10
062_fix_memory_leak: Fix a memory leak in 060_non_replicated_ping.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
diff -ruN autofs-4.0.0pre10.orig/man/autofs.5 autofs-4.0.0pre10/man/autofs.5
 
2
--- autofs-4.0.0pre10.orig/man/autofs.5 2003-02-10 00:13:15.000000000 +0100
 
3
+++ autofs-4.0.0pre10/man/autofs.5      2003-02-10 00:13:01.000000000 +0100
 
4
@@ -21,7 +21,7 @@
 
5
 map!
 
6
 .SH "FORMAT"
 
7
 This is a description of the text file format.  Other methods of specifying
 
8
-these files may exist.  All empty lines or lines beginning with # are
 
9
+these files may exist (e. g. LDAP).  All empty lines or lines beginning with # are
 
10
 ignored. The basic format of one line in such maps is:
 
11
 .P
 
12
 .BI "key [" -options "] location"
 
13
@@ -78,7 +78,9 @@
 
14
 .sp
 
15
 In the first line we have a NFS remote mount of the kernel directory on
 
16
 .IR ftp.kernel.org .
 
17
-This is mounted read-only.  The second line mounts an ext2 volume on a
 
18
+This is mounted read-only. (Note: This example doesn't really work, because
 
19
+.IR ftp.kernel.org
 
20
+doesn't provide NFS services.) The second line mounts an ext2 volume on a
 
21
 local ide drive.  The third makes a share exported from a Windows
 
22
 machine available for automounting.  The rest should be fairly
 
23
 self-explanatory. The last entry (the last three lines) is an example
 
24
@@ -106,6 +108,13 @@
 
25
 This will enable you to access all the home directory of local hosts using
 
26
 the path
 
27
 .RI / mountpoint / hostname / local-path .
 
28
+(But in certain cases it's not recommended to work in such a directory.
 
29
+If a program tries to find a file, let's say \fIconfig.sh\fP, in the
 
30
+parent directories, it will finally reach \fI/mountpoint/config.sh\fP.
 
31
+The automounter will try to mount \fIconfig.sh:/home/config.sh\fP,
 
32
+which will fail. Most probably it will result in a timeout during
 
33
+DNS resolution.)
 
34
+
 
35
 .SS Variable Substitution
 
36
 The following special variables will be substituted in the key and location
 
37
 fields of an automounter map if prefixed with $ as customary from shell
 
38
@@ -133,7 +142,10 @@
 
39
 .B program
 
40
 map will be called as a script with the key as an argument.  It may
 
41
 return no lines of output if there's an error, or one or more lines
 
42
-containing a map (with \\ quoting line breaks).
 
43
+containing a map (with \\ quoting line breaks). The general format
 
44
+of such a line is:
 
45
+.P
 
46
+.BI "[" -options "] location"
 
47
 .P
 
48
 To use a 
 
49
 .B program
 
50
@@ -178,3 +190,4 @@
 
51
 This manual page was written by Christoph Lameter <chris@waterf.org>,
 
52
 for the Debian GNU/Linux system.  Edited by H. Peter Anvin
 
53
 <hpa@transmeta.com> and Jeremy Fitzhardinge <jeremy@goop.org>.
 
54
+Edited by Daniel Lutz <danlutz@debian.org>.
 
55
diff -ruN autofs-4.0.0pre10.orig/man/autofs.8.in autofs-4.0.0pre10/man/autofs.8.in
 
56
--- autofs-4.0.0pre10.orig/man/autofs.8.in      2003-02-10 00:13:09.000000000 +0100
 
57
+++ autofs-4.0.0pre10/man/autofs.8.in   2003-02-10 00:13:01.000000000 +0100
 
58
@@ -4,7 +4,7 @@
 
59
 @@INIT.D@@/autofs \- Control Script for automounter
 
60
 .SH SYNOPSIS
 
61
 .B @@INIT.D@@/autofs
 
62
-.I start|stop|reload
 
63
+.I start|stop|restart|reload|status
 
64
 .SH "DESCRIPTION"
 
65
 .B autofs
 
66
 control the operation of the
 
67
@@ -42,8 +42,19 @@
 
68
 map exists then that map will be processed in the same way as the
 
69
 auto.master map, with any optional arguments.
 
70
 .P
 
71
+.B @@INIT.D@@/autofs start
 
72
+will start daemons for all configured mount points.
 
73
+.P
 
74
+.B @@INIT.D@@/autofs stop
 
75
+will stop all currently running daemons.
 
76
+.P
 
77
+.B @@INIT.D@@/autofs restart
 
78
+will stop and then start agin all currently running daemons.
 
79
+.P
 
80
 .B @@INIT.D@@/autofs reload
 
81
-will check the current auto.master map against running daemons. It will kill
 
82
+will check the current
 
83
+.I auto.master
 
84
+map against running daemons. It will kill
 
85
 those daemons whose entries have changed and then start daemons for new or  
 
86
 changed entries.
 
87
 .P
 
88
@@ -64,4 +75,4 @@
 
89
 .SH AUTHOR
 
90
 This manual page was written by Christoph Lameter <chris@waterf.org>,
 
91
 for the Debian GNU/Linux system.  Edited by H. Peter Anvin
 
92
-<hpa@transmeta.com>.
 
93
+<hpa@transmeta.com>. Edited by Daniel Lutz <danalutz@debian.org>.
 
94
diff -ruN autofs-4.0.0pre10.orig/man/auto.master.5 autofs-4.0.0pre10/man/auto.master.5
 
95
--- autofs-4.0.0pre10.orig/man/auto.master.5    2001-03-28 07:08:23.000000000 +0200
 
96
+++ autofs-4.0.0pre10/man/auto.master.5 2003-02-10 00:13:01.000000000 +0100
 
97
@@ -13,6 +13,25 @@
 
98
 describing the file systems to be mounted under this mountpoint. The access
 
99
 to those maps is governed by a key.
 
100
 .P
 
101
+If the file
 
102
+.B /etc/auto.master
 
103
+exists, only this file is used as master map.
 
104
+If needed, an additional NIS map can be included in this file with:
 
105
+.P
 
106
+.I +map
 
107
+.B [options]
 
108
+.P
 
109
+If
 
110
+.B /etc/auto.master
 
111
+doesn't exist,
 
112
+.BR autofs (8)
 
113
+looks for a NIS map called
 
114
+.B auto.master
 
115
+and processes this map instead. So you can have a global NIS map and
 
116
+optionally add entries in
 
117
+.B /etc/auto.master
 
118
+on the local machine.
 
119
+.P
 
120
 Access to an automounted file system is customarily done using the path scheme:
 
121
 .P
 
122
 .RI / mountpoint / key / path / file ,
 
123
@@ -30,35 +49,70 @@
 
124
 .SH "FORMAT"
 
125
 The file has three fields separated by an arbitrary number of blanks or
 
126
 tabs. Lines beginning with # are comments. The first field is the mount
 
127
-point. Second field is the map file to be consulted for this mount-point.
 
128
+point. Second field is the map to be consulted for this mount-point.
 
129
 The third field is optional and can contain options to be applied to all
 
130
 entries in the map. Options are cumulative, which is a difference to the
 
131
 behavior of the SunOS automounter.
 
132
+.P
 
133
+.BI "mountpoint [" maptype ":]map [" options "]"
 
134
 
 
135
-The format of the map file and the options are described in
 
136
+.SS mountpoint
 
137
+is the path to a directory. This directory must already exist and should
 
138
+be empty. If it's not empty, the contents will be hidden.
 
139
+
 
140
+.SS [maptype:]map
 
141
+is the map to be used. If \fImap\fP is an absolute path, the given file is used.
 
142
+If this file is executable, map type \fBprogram\fP is used, else \fPfile\fP.
 
143
+If \fImap\fP is a filename, /etc/\fImap\fP is used if it exists (map type
 
144
+\fBprogram\fP if it's executable, \fBfile\fP else), else the given
 
145
+map is assumed to be a NIS map. The map can also be \fBhesiod\fP,
 
146
+\fBuserhome\fP, or \fBldap\fP. If it's \fBldap\fP, the following
 
147
+format for the map should be used: \fBldap:[servername:]basedn\fP
 
148
+(this includes the \fImaptype\fP).
 
149
+.P
 
150
+You can explicitly provide a map type specifier. This is done by
 
151
+prepending \fImaptype\fP: to the map. If you do so, the map type
 
152
+specifier and the map are passed to
 
153
+.BR automount(8)
 
154
+as is. See
 
155
+.BR automount(8)
 
156
+for all supported map types.
 
157
+
 
158
+.SS options
 
159
+If options are given, they are prepended to the options given
 
160
+in the map.
 
161
+The format of the map and the options are described in
 
162
 .BR autofs (5).
 
163
+.P
 
164
+There's a special option \fB--timeout=<n>\fP that is passed to
 
165
+.BR automount(8)
 
166
+instead of to the map and to
 
167
+.BR mount(8) .
 
168
+With this option, you can override the default timeout for the
 
169
+given map. See
 
170
+.BR automount(8)
 
171
+for more information about this option.
 
172
+
 
173
 .SH EXAMPLE
 
174
 .sp
 
175
 .RS +.2i
 
176
 .ta 1.0i
 
177
 .nf
 
178
-/home  /etc/auto.home
 
179
-/misc  /etc/auto.misc
 
180
+/home  auto.home
 
181
+/misc  /etc/auto.misc -Dfoo=bar,rsize=8192,wsize=8192,--timeout=10
 
182
+/data  ldap:ldapserver.example.com:ou=auto.data,dc=example,dc=com rsize=8192,wsize=8192
 
183
++auto.master
 
184
 .fi
 
185
 .RE
 
186
 .sp
 
187
-This will generate two mountpoints 
 
188
-.I /home
 
189
-and
 
190
-.IR /misc .
 
191
-All accesses to
 
192
-.I /home
 
193
-will lead to the consultation of the map in
 
194
-.IR /etc/auto.home ,
 
195
-and all accesses to
 
196
-.I /misc
 
197
-will consult the map in
 
198
-.IR /etc/auto.misc .
 
199
+This will generate the three mountpoints 
 
200
+\fI/home\fP, \fI/misc\fP and \fI/data\fP. All accesses to
 
201
+\fI/home\fP will lead to the consultation of the map in
 
202
+\fI/etc/auto.home\fP (or the NIS map \fIauto.home\fP, if
 
203
+\fI/etc/auto.home\fP doesn't exist). All accesses to
 
204
+\fI/misc\fP will consult the map in \fI/etc/auto.misc\fP.
 
205
+And all accesses to \fI/data\fP will lead to the consultation
 
206
+of LDAP entries on the server \fIldapserver.example.com\fP.
 
207
 .SH "SEE ALSO"
 
208
 .BR automount (8),
 
209
 .BR autofs (5),
 
210
@@ -66,3 +120,4 @@
 
211
 .SH AUTHOR
 
212
 This manual page was written by Christoph Lameter <chris@waterf.org>,
 
213
 for the Debian GNU/Linux system.  Edited by <hpa@transmeta.com>.
 
214
+Edited by Daniel Lutz <danlutz@debian.org>.
 
215
diff -ruN autofs-4.0.0pre10.orig/man/automount.8 autofs-4.0.0pre10/man/automount.8
 
216
--- autofs-4.0.0pre10.orig/man/automount.8      2003-02-10 00:13:15.000000000 +0100
 
217
+++ autofs-4.0.0pre10/man/automount.8   2003-02-10 00:13:01.000000000 +0100
 
218
@@ -22,10 +22,13 @@
 
219
 The filesystems are then autounmounted after a period of inactivity.
 
220
 .SH OPTIONS
 
221
 .TP
 
222
-.I "\-p, \-\-pid-file"
 
223
+.I "\-h, \-\-help"
 
224
+Display usage information, then exit.
 
225
+.TP
 
226
+.I "\-p, \-\-pid-file <file>"
 
227
 Write the pid of the daemon to the specified file.
 
228
 .TP
 
229
-.I "\-t, \-\-timeout"
 
230
+.I "\-t, \-\-timeout <n>"
 
231
 Set the minimum timeout, in seconds, until directories are unmounted.
 
232
 The default is 5 minutes.  Setting the timeout to zero disables
 
233
 unmounts completely.
 
234
@@ -84,7 +87,8 @@
 
235
 \fBmap\fP
 
236
 Location of mapfile to use.  This is an absolute UNIX pathname in the case
 
237
 for maps of types \fBfile\fP or \fBprogram\fP, and the name of a database
 
238
-in the case for maps of type \fByp\fP, \fBnisplus\fP, or \fBhesiod\fP.
 
239
+in the case for maps of type \fByp\fP, \fBnisplus\fP, or \fBhesiod\fP,
 
240
+and of the form \fB[servername:]basedn\fP in the case for \fBldap\fP.
 
241
 .TP
 
242
 \fBoptions\fP
 
243
 Any remaining command line arguments without leading dashes (\-) are
 
244
@@ -120,4 +124,4 @@
 
245
 <autofs@linux.kernel.org>.  To join this mailing list, send a message
 
246
 with the line "subscribe autofs" to <majordomo@linux.kernel.org>.
 
247
 .SH AUTHOR
 
248
-H. Peter Anvin <hpa@transmeta.com>
 
249
+H. Peter Anvin <hpa@transmeta.com>. Edited by Daniel Lutz <danlutz@debian.org>.