2 .\" Copyright (c) 1997-2006 Erez Zadok
3 .\" Copyright (c) 1989 Jan-Simon Pendry
4 .\" Copyright (c) 1989 Imperial College of Science, Technology & Medicine
5 .\" Copyright (c) 1989 The Regents of the University of California.
6 .\" All rights reserved.
8 .\" This code is derived from software contributed to Berkeley by
9 .\" Jan-Simon Pendry at Imperial College, London.
11 .\" Redistribution and use in source and binary forms, with or without
12 .\" modification, are permitted provided that the following conditions
14 .\" 1. Redistributions of source code must retain the above copyright
15 .\" notice, this list of conditions and the following disclaimer.
16 .\" 2. Redistributions in binary form must reproduce the above copyright
17 .\" notice, this list of conditions and the following disclaimer in the
18 .\" documentation and/or other materials provided with the distribution.
19 .\" 3. All advertising materials mentioning features or use of this software
20 .\" must display the following acknowledgment:
21 .\" This product includes software developed by the University of
22 .\" California, Berkeley and its contributors.
23 .\" 4. Neither the name of the University nor the names of its contributors
24 .\" may be used to endorse or promote products derived from this software
25 .\" without specific prior written permission.
27 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
28 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
30 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
31 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
32 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
33 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
34 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
35 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
36 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
39 .\" %W% (Berkeley) %G%
41 .\" $Id: amd.8,v 1.14.2.1 2006/01/02 18:48:23 ezk Exp $
49 .Nd automatically mount file systems
57 .Op Fl a Ar mount_point
60 .Op Fl k Ar kernel-arch
62 .Op Fl o Ar op_sys_ver
63 .Op Fl t Ar timeout.retransmit
65 .Op Fl x Ar log-option
68 .Op Fl C Ar cluster-name
71 .Op Fl O Ar op_sys_name
82 is a daemon that automatically mounts file systems
83 whenever a file or directory
84 within that file system is accessed.
85 File systems are automatically unmounted when they
86 appear to be quiescent.
91 operates by attaching itself as an
93 server to each of the specified
95 Lookups within the specified directories
98 which uses the map defined by
100 to determine how to resolve the lookup.
101 Generally, this will be a host name, some file system information
102 and some mount options for the given file system.
104 In the first form depicted above,
106 will print a short help string.
107 In the second form, if no options are
112 will read configuration parameters from the file
116 The last form is described below.
118 .Bl -tag -width indent
119 .It Fl a Ar temporary-directory
120 Specify an alternative location for the real mount points.
126 in seconds, that a looked up name remains
127 cached when not in use.
128 The default is 5 minutes.
130 Specify the local domain name.
131 If this option is not
132 given the domain name is determined from the hostname.
133 .It Fl k Ar kernel-arch
134 Specifies the kernel architecture.
136 to set the ${karch} selector.
138 Specify a logfile in which to record mount and unmount events.
143 then the log messages will be sent to the system log daemon by
145 The default syslog facility used is
148 wish to change it, append its name to the log file name, delimited by a
156 will log messages via
160 facility (if it exists on the system).
163 The name referred to by ${rhost} is normalized relative to the
164 host database before being used.
165 The effect is to translate
169 .It Fl o Ar op_sys_ver
170 Override the compiled-in version number of the operating system.
172 when the built in version is not desired for backward compatibility reasons.
173 For example, if the build in version is
175 you can override it to
177 and use older maps that were written with the latter in mind.
180 Outputs the process ID of
182 to standard output where it can be saved into a file.
184 Restart existing mounts.
188 will scan the mount file table to determine which file systems
189 are currently mounted.
190 Whenever one of these would have
195 .It Fl t Ar timeout.retransmit
199 in tenths of a second, between
201 retries (for UDP only).
204 The second value alters the retransmit counter, which
205 defaults to 11 retransmissions.
206 Both of these values are used by the kernel
207 to communicate with amd.
208 Useful defaults are supplied if either or both
214 relies on the kernel RPC retransmit mechanism to trigger mount retries.
215 The values of these parameters change the overall retry interval.
217 an interval gives poor interactive response; too short an interval causes
221 Displays version and configuration information on standard error.
225 in seconds, between attempts to dismount
226 file systems that have exceeded their cached times.
227 The default is 2 minutes.
229 Specify run-time logging options.
230 The options are a comma separated
232 .Li fatal , error , user , warn , info , map , stats , all .
234 Specify an alternative
236 domain from which to fetch the
239 The default is the system domain name.
240 This option is ignored if
242 support is not available.
244 Specifies the OS architecture.
245 This is used solely to set the ${arch}
247 .It Fl C Ar cluster-name
248 Specify an alternative HP-UX cluster name to use.
250 Select from a variety of debug options.
252 option with the string
254 reverses the effect of that option.
255 Options are cumulative.
256 The most useful option is
261 is only used for debugging other options are not documented here:
262 the current supported set of options is listed by the
265 and a fuller description is available in the program source.
266 .It Fl F Ar conf_file
269 configuration file to use.
272 for description of this file's format.
273 This configuration file is used to
274 specify any options in lieu of typing many of them on the command line.
277 file includes directives for every command line option amd has, and many
278 more that are only available via the configuration file facility.
280 configuration file specified by this option is processed after all other
281 options had been processed, regardless of the actual location of this option
284 Print help and usage string.
285 .It Fl O Ar op_sys_name
286 Override the compiled-in name of the operating system.
288 built in name is not desired for backward compatibility reasons.
290 example, if the build in name is
292 you can override it to
294 and use older maps which were written with the latter in mind.
296 Do not lock the running executable pages of
301 performance, systems that support the
306 This way there is less chance
307 the operating system will schedule, page out, and swap the
311 This tends to improve
313 performance, at the cost of reserving the
316 process (making it unavailable for other processes).
317 If this behavior is not desired, use the
321 Specify a tag to use with
323 All map entries tagged with
326 Map entries that are not tagged are always processed.
327 Map entries that are tagged with a tag other than
329 will not be processed.
332 .Bl -tag -width ".Pa /etc/amd.conf"
334 directory under which file systems are dynamically mounted
336 default configuration file
339 Some care may be required when creating a mount map.
343 file system can be incredibly inefficient.
344 In most implementations of
346 their interpolations are not cached
347 by the kernel and each time a symbolic link is encountered during a
349 translation it costs an
354 It would appear that a large improvement in real-time
355 performance could be gained by adding a cache somewhere.
356 Replacing symlinks with a suitable incarnation of the auto-mounter
357 results in a large real-time speedup, but also causes a large
358 number of process context switches.
360 A weird imagination is most useful to gain full advantage of all
377 .%B "Linux NFS and Automounter Administration"
378 .%O ISBN 0-7821-2739-8
383 .Pa http://www.am-utils.org/
385 .%T Amd \- The 4.4 BSD Automounter
390 utility first appeared in
393 .An Jan-Simon Pendry Aq jsp@doc.ic.ac.uk ,
394 Department of Computing, Imperial College, London, UK.
396 .An Erez Zadok Aq ezk@cs.sunysb.edu ,
397 Computer Science Department, Stony Brook
398 University, Stony Brook, New York, USA.
400 Other authors and contributors to am-utils are listed in the
402 file distributed with am-utils.