aboutsummaryrefslogtreecommitdiffstats
path: root/man/automount.8
blob: 7bbed2b2c6f066d4d091494f10d710520e897e0f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
.\" Linux man page by B. James Phillippe, 1997 <bryan@Terran.ORG>
.\"
.\" This page was written to contribute to the Linux kernel autofs
.\" implementation by H. Peter Anvin (1997).  It is loosly based on
.\" the documentation for mount(8) and amd(8) Linux manpages.
.\"
.\" This is free documentation.
.\"
.\" $Id$
.\"
.TH AUTOMOUNT 8 "17 Sep 1997"
.SH NAME
automount \- configure mount points for autofs
.SH SYNOPSIS
\fBautomount\fP [\fIoptions\fP] \fImount-point\fP \fImap-type\fP[,\fIformat\fP] \fImap\fP [\fImap-options\fP]
.SH DESCRIPTION
The \fBautomount\fP program is used to configure a mount point for
autofs, the inlined Linux automounter.  \fBautomount\fP works by
taking a base \fImount-point\fP and \fImap\fP file, and using these 
(combined with other \fIoptions\fP) to automatically mount filesystems 
within the base \fImount-point\fP when they are accessed in any way.
The filesystems are then autounmounted after a period of inactivity.
.SH OPTIONS
.TP
.I "\-p, \-\-pid-file"
Write the pid of the daemon to the specified file.
.TP
.I "\-t, \-\-timeout"
Set the minimum timeout, in seconds, until directories are unmounted.
The default is 5 minutes.  Setting the timeout to zero disables
unmounts completely.
.TP
.I "\-v, \-\-version"
Display the version number, then exit.
.SH ARGUMENTS
\fBautomount\fP takes at least three arguments.  Mandatory arguments 
include \fImount-point\fP, \fImap-type\fP and \fImap\fP.  Both mandatory
and optional arguments are described below.
.TP
\fBmount-point\fP
Base location for autofs-mounted filesystems to be attached.  This is a
directory name which must already exist.
.TP
\fBmap-type\fP
Type of map used for this invocation of \fBautomount\fP.  The following are
valid map types:
.RS
.TP
.B file
The map is a regular text file.
.TP
.B program
The map is an executable program, which is passed a key on the command
line and returns an entry on stdout if successful.
.TP
.B yp
The map is an NIS (YP) database.
.RE
.TP
\fBformat\fP
Format of the map data; currently the only format
recognized is \fBsun\fP, which is a subset of the Sun automounter map
format.  The default format is technically map type dependent,
although currently all map types default to \fBsun\fP format.
.TP
\fBmap\fP
Location of mapfile to use.  This is an absolute UNIX pathname in the case
for maps of types \fBfile\fP and \fBprogram\fP, and the name of an NIS
database in the case for maps of type \fByp\fP.
.TP
\fBoptions\fP
Any remaining command line arguments without leading dashes (\-) are
taken as options (\fI\-o\fP) to \fBmount\fP.  Arguments with leading
dashes are considered options for the maps.
.SH NOTES
If the \fBautomount\fP daemon catches signal USR1, it will unmount all
currently unused autofs-mounted filesystems and continue running
(forced unmount.)  If it catches signal USR2 it will unmount all
unused autofs-mounted filesystems and exit if all filesystems were
unmounted.  Busy filesystems will not be unmounted.
.SH "SEE ALSO"
.BR autofs (5),
.BR mount (8).
.SH BUGS
A whole slew of missing desirable features (see \fBTODO\fP file).

The documentation leaves a lot to be desired.

Please report other bugs along with a detailed description to
<autofs@linux.kernel.org>.  To join this mailing list, send a message
with the line "subscribe autofs" to <majordomo@linux.kernel.org>.
.SH AUTHOR
H. Peter Anvin <hpa@transmeta.com>