2 .\" Copyright (c) 1997-2014 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. Neither the name of the University nor the names of its contributors
20 .\" may be used to endorse or promote products derived from this software
21 .\" without specific prior written permission.
23 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36 .\" File: am-utils/amd/amd.8
44 .Nd automatically mount file systems
52 .Op Fl a Ar mount_point
55 .Op Fl k Ar kernel-arch
57 .Op Fl o Ar op_sys_ver
58 .Op Fl t Ar timeout.retransmit
60 .Op Fl x Ar log-option
63 .Op Fl C Ar cluster-name
66 .Op Fl O Ar op_sys_name
75 This daemon is obsolete.
76 Users are advised to use
84 is a daemon that automatically mounts file systems
85 whenever a file or directory
86 within that file system is accessed.
87 File systems are automatically unmounted when they
88 appear to be quiescent.
93 operates by attaching itself as an
95 server to each of the specified
97 Lookups within the specified directories
100 which uses the map defined by
102 to determine how to resolve the lookup.
103 Generally, this will be a host name, some file system information
104 and some mount options for the given file system.
106 In the first form depicted above,
108 will print a short help string.
109 In the second form, if no options are
114 will read configuration parameters from the file
118 The last form is described below.
120 .Bl -tag -width indent
121 .It Fl a Ar temporary-directory
122 Specify an alternative location for the real mount points.
128 in seconds, that a looked up name remains
129 cached when not in use.
130 The default is 5 minutes.
132 Specify the local domain name.
133 If this option is not
134 given the domain name is determined from the hostname.
135 .It Fl k Ar kernel-arch
136 Specifies the kernel architecture.
138 to set the ${karch} selector.
140 Specify a logfile in which to record mount and unmount events.
145 then the log messages will be sent to the system log daemon by
147 The default syslog facility used is
150 wish to change it, append its name to the log file name, delimited by a
158 will log messages via
162 facility (if it exists on the system).
165 The name referred to by ${rhost} is normalized relative to the
166 host database before being used.
167 The effect is to translate
171 .It Fl o Ar op_sys_ver
172 Override the compiled-in version number of the operating system.
174 when the built in version is not desired for backward compatibility reasons.
175 For example, if the build in version is
177 you can override it to
179 and use older maps that were written with the latter in mind.
182 Outputs the process ID of
184 to standard output where it can be saved into a file.
186 Restart existing mounts.
190 will scan the mount file table to determine which file systems
191 are currently mounted.
192 Whenever one of these would have
197 .It Fl t Ar timeout.retransmit
201 in tenths of a second, between
203 retries (for UDP only).
206 The second value alters the retransmit counter, which
207 defaults to 11 retransmissions.
208 Both of these values are used by the kernel
209 to communicate with amd.
210 Useful defaults are supplied if either or both
216 relies on the kernel RPC retransmit mechanism to trigger mount retries.
217 The values of these parameters change the overall retry interval.
219 an interval gives poor interactive response; too short an interval causes
223 Displays version and configuration information on standard error.
227 in seconds, between attempts to dismount
228 file systems that have exceeded their cached times.
229 The default is 2 minutes.
232 Specify run-time logging options. The options are a comma separated
234 .Li fatal, error, user, warn, info, map, stats, defaults, all .
235 Note that "fatal" and "error" are mandatory and cannot be turned off.
238 Specify an alternative
240 domain from which to fetch the
243 The default is the system domain name. This option is ignored if NIS
244 support is not available.
246 Specifies the OS architecture.
247 This is used solely to set the ${arch}
249 .It Fl C Ar cluster-name
250 Specify an alternative HP-UX cluster name to use.
252 Select from a variety of debug options.
254 option with the string
256 reverses the effect of that option.
257 Options are cumulative.
258 The most useful option is
263 is only used for debugging other options are not documented here:
264 the current supported set of options is listed by the
267 and a fuller description is available in the program source.
268 .It Fl F Ar conf_file
271 configuration file to use.
274 for description of this file's format.
275 This configuration file is used to
276 specify any options in lieu of typing many of them on the command line.
279 file includes directives for every command line option amd has, and many
280 more that are only available via the configuration file facility.
282 configuration file specified by this option is processed after all other
283 options had been processed, regardless of the actual location of this option
286 Print help and usage string.
287 .It Fl O Ar op_sys_name
288 Override the compiled-in name of the operating system.
290 built in name is not desired for backward compatibility reasons.
292 example, if the build in name is
294 you can override it to
296 and use older maps which were written with the latter in mind.
298 Do not lock the running executable pages of
303 performance, systems that support the
308 This way there is less chance
309 the operating system will schedule, page out, and swap the
313 This tends to improve
315 performance, at the cost of reserving the
318 process (making it unavailable for other processes).
319 If this behavior is not desired, use the
323 Specify a tag to use with
325 All map entries tagged with
328 Map entries that are not tagged are always processed.
329 Map entries that are tagged with a tag other than
331 will not be processed.
334 .Bl -tag -width ".Pa /etc/amd.conf"
336 directory under which file systems are dynamically mounted
338 default configuration file
341 Some care may be required when creating a mount map.
345 file system can be incredibly inefficient.
346 In most implementations of
348 their interpolations are not cached
349 by the kernel and each time a symbolic link is encountered during a
351 translation it costs an
356 It would appear that a large improvement in real-time
357 performance could be gained by adding a cache somewhere.
358 Replacing symlinks with a suitable incarnation of the auto-mounter
359 results in a large real-time speedup, but also causes a large
360 number of process context switches.
362 A weird imagination is most useful to gain full advantage of all
380 .%B "Linux NFS and Automounter Administration"
381 .%O ISBN 0-7821-2739-8
386 .Pa http://www.am-utils.org/
388 .%T Amd \- The 4.4 BSD Automounter
393 utility first appeared in
396 .An Jan-Simon Pendry Aq jsp@doc.ic.ac.uk ,
397 Department of Computing, Imperial College, London, UK.
399 .An Erez Zadok Aq ezk@cs.sunysb.edu ,
400 Computer Science Department, Stony Brook
401 University, Stony Brook, New York, USA.
403 Other authors and contributors to am-utils are listed in the
405 file distributed with am-utils.