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