xref: /freebsd/share/man/man4/autofs.4 (revision 56b17de1e8360fe131d425de20b5e75ff3ea897c)
1.\" Copyright (c) 2014 The FreeBSD Foundation
2.\"
3.\" This software was developed by Edward Tomasz Napierala under sponsorship
4.\" from the FreeBSD Foundation.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
16.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
19.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25.\" SUCH DAMAGE.
26.\"
27.Dd December 2, 2017
28.Dt AUTOFS 4
29.Os
30.Sh NAME
31.Nm autofs
32.Nd "automounter filesystem"
33.Sh SYNOPSIS
34To compile this driver into the kernel,
35place the following line in the
36kernel configuration file:
37.Bd -ragged -offset indent
38.Cd "options AUTOFS"
39.Ed
40.Pp
41Alternatively, to load the driver as a
42module at boot time, place the following line in
43.Xr loader.conf 5 :
44.Bd -literal -offset indent
45autofs_load="YES"
46.Ed
47.Sh DESCRIPTION
48The
49.Nm
50driver is the kernel component of the automounter infrastructure.
51Its job is to pass mount requests to the
52.Xr automountd 8
53daemon, and pause the processes trying to access the automounted filesystem
54until the mount is completed.
55It is mounted by the
56.Xr automount 8 .
57.Sh OPTIONS
58These options are available when
59mounting
60.Nm
61file systems:
62.Bl -tag -width indent
63.It Cm master_options
64Mount options for all filesystems specified in the map entry.
65.It Cm master_prefix
66Filesystem mountpoint prefix.
67.El
68.Sh SYSCTL VARIABLES
69The following variables are available as both
70.Xr sysctl 8
71variables and
72.Xr loader 8
73tunables:
74.Bl -tag -width indent
75.It Va vfs.autofs.debug
76Verbosity level for log messages from the
77.Nm
78driver.
79Set to 0 to disable logging or 1 to warn about potential problems.
80Larger values enable debugging output.
81Defaults to 1.
82.It Va vfs.autofs.interruptible
83Set to 1 to allow mount requests to be interrupted by signal.
84Defaults to 1.
85.It Va vfs.autofs.retry_delay
86Number of seconds before retrying mount requests.
87Defaults to 1.
88.It Va vfs.autofs.retry_attempts
89Number of attempts before failing mount.
90Defaults to 3.
91.It Va vfs.autofs.cache
92Number of seconds to wait before reinvoking
93.Xr automountd 8
94for any given file or directory.
95Defaults to 600.
96.It Va vfs.autofs.timeout
97Number of seconds to wait for
98.Xr automountd 8
99to handle the mount request.
100Defaults to 30.
101.It Va vfs.autofs.mount_on_stat
102Set to 1 to trigger mount on
103.Xr stat 2
104on mountpoint.
105Defaults to 0.
106.El
107.Sh EXAMPLES
108To unmount all mounted
109.Nm
110filesystems:
111.Pp
112.Dl "umount -At autofs"
113.Pp
114To mount
115.Nm
116filesystems specified in
117.Xr auto_master 5 :
118.Pp
119.Dl "automount"
120.Sh SEE ALSO
121.Xr auto_master 5 ,
122.Xr automount 8 ,
123.Xr automountd 8 ,
124.Xr autounmountd 8
125.Sh HISTORY
126The
127.Nm
128driver first appeared in
129.Fx 10.1 .
130.Sh AUTHORS
131The
132.Nm
133was developed by
134.An Edward Tomasz Napierala Aq Mt trasz@FreeBSD.org
135under sponsorship from the FreeBSD Foundation.
136