xref: /dflybsd-src/share/man/man5/autofs.5 (revision e2950f411cf734644d0586c7ed409af918988d76)
1*e2950f41STomohiro Kusumi.\" Copyright (c) 2016 The DragonFly Project
2*e2950f41STomohiro Kusumi.\" Copyright (c) 2014 The FreeBSD Foundation
3*e2950f41STomohiro Kusumi.\" All rights reserved.
4*e2950f41STomohiro Kusumi.\"
5*e2950f41STomohiro Kusumi.\" This software was developed by Edward Tomasz Napierala under sponsorship
6*e2950f41STomohiro Kusumi.\" from the FreeBSD Foundation.
7*e2950f41STomohiro Kusumi.\"
8*e2950f41STomohiro Kusumi.\" Redistribution and use in source and binary forms, with or without
9*e2950f41STomohiro Kusumi.\" modification, are permitted provided that the following conditions
10*e2950f41STomohiro Kusumi.\" are met:
11*e2950f41STomohiro Kusumi.\" 1. Redistributions of source code must retain the above copyright
12*e2950f41STomohiro Kusumi.\"    notice, this list of conditions and the following disclaimer.
13*e2950f41STomohiro Kusumi.\" 2. Redistributions in binary form must reproduce the above copyright
14*e2950f41STomohiro Kusumi.\"    notice, this list of conditions and the following disclaimer in the
15*e2950f41STomohiro Kusumi.\"    documentation and/or other materials provided with the distribution.
16*e2950f41STomohiro Kusumi.\"
17*e2950f41STomohiro Kusumi.\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
18*e2950f41STomohiro Kusumi.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19*e2950f41STomohiro Kusumi.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20*e2950f41STomohiro Kusumi.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
21*e2950f41STomohiro Kusumi.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22*e2950f41STomohiro Kusumi.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23*e2950f41STomohiro Kusumi.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24*e2950f41STomohiro Kusumi.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25*e2950f41STomohiro Kusumi.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26*e2950f41STomohiro Kusumi.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27*e2950f41STomohiro Kusumi.\" SUCH DAMAGE.
28*e2950f41STomohiro Kusumi.\"
29*e2950f41STomohiro Kusumi.\" $FreeBSD$
30*e2950f41STomohiro Kusumi.\"
31*e2950f41STomohiro Kusumi.Dd April 14, 2016
32*e2950f41STomohiro Kusumi.Dt AUTOFS 5
33*e2950f41STomohiro Kusumi.Os
34*e2950f41STomohiro Kusumi.Sh NAME
35*e2950f41STomohiro Kusumi.Nm autofs
36*e2950f41STomohiro Kusumi.Nd "automounter filesystem"
37*e2950f41STomohiro Kusumi.Sh SYNOPSIS
38*e2950f41STomohiro KusumiTo compile this driver into the kernel,
39*e2950f41STomohiro Kusumiplace the following line in the
40*e2950f41STomohiro Kusumikernel configuration file:
41*e2950f41STomohiro Kusumi.Bd -ragged -offset indent
42*e2950f41STomohiro Kusumi.Cd "options AUTOFS"
43*e2950f41STomohiro Kusumi.Ed
44*e2950f41STomohiro Kusumi.Pp
45*e2950f41STomohiro KusumiAlternatively, to load the driver as a
46*e2950f41STomohiro Kusumimodule at boot time, place the following line in
47*e2950f41STomohiro Kusumi.Xr loader.conf 5 :
48*e2950f41STomohiro Kusumi.Bd -literal -offset indent
49*e2950f41STomohiro Kusumiautofs_load="YES"
50*e2950f41STomohiro Kusumi.Ed
51*e2950f41STomohiro Kusumi.Sh DESCRIPTION
52*e2950f41STomohiro KusumiThe
53*e2950f41STomohiro Kusumi.Nm
54*e2950f41STomohiro Kusumidriver is the kernel component of the automounter infrastructure.
55*e2950f41STomohiro KusumiIts job is to pass mount requests to the
56*e2950f41STomohiro Kusumi.Xr automountd 8
57*e2950f41STomohiro Kusumidaemon, and pause the processes trying to access the automounted filesystem
58*e2950f41STomohiro Kusumiuntil the mount is completed.
59*e2950f41STomohiro KusumiIt is mounted by the
60*e2950f41STomohiro Kusumi.Xr automount 8 .
61*e2950f41STomohiro Kusumi.Sh OPTIONS
62*e2950f41STomohiro KusumiThese options are available when
63*e2950f41STomohiro Kusumimounting
64*e2950f41STomohiro Kusumi.Nm
65*e2950f41STomohiro Kusumifile systems:
66*e2950f41STomohiro Kusumi.Bl -tag -width indent
67*e2950f41STomohiro Kusumi.It Cm master_options
68*e2950f41STomohiro KusumiMount options for all filesystems specified in the map entry.
69*e2950f41STomohiro Kusumi.It Cm master_prefix
70*e2950f41STomohiro KusumiFilesystem mountpoint prefix.
71*e2950f41STomohiro Kusumi.El
72*e2950f41STomohiro Kusumi.Sh EXAMPLES
73*e2950f41STomohiro KusumiTo unmount all mounted
74*e2950f41STomohiro Kusumi.Nm
75*e2950f41STomohiro Kusumifilesystems:
76*e2950f41STomohiro Kusumi.Pp
77*e2950f41STomohiro Kusumi.Dl "umount -At autofs"
78*e2950f41STomohiro Kusumi.Pp
79*e2950f41STomohiro KusumiTo mount
80*e2950f41STomohiro Kusumi.Nm
81*e2950f41STomohiro Kusumifilesystems specified in
82*e2950f41STomohiro Kusumi.Xr auto_master 5 :
83*e2950f41STomohiro Kusumi.Pp
84*e2950f41STomohiro Kusumi.Dl "automount"
85*e2950f41STomohiro Kusumi.Sh SEE ALSO
86*e2950f41STomohiro Kusumi.Xr auto_master 5 ,
87*e2950f41STomohiro Kusumi.Xr automount 8 ,
88*e2950f41STomohiro Kusumi.Xr automountd 8 ,
89*e2950f41STomohiro Kusumi.Xr autounmountd 8
90*e2950f41STomohiro Kusumi.Sh HISTORY
91*e2950f41STomohiro KusumiThe
92*e2950f41STomohiro Kusumi.Nm
93*e2950f41STomohiro Kusumidriver first appeared in
94*e2950f41STomohiro Kusumi.Fx 10.1 .
95*e2950f41STomohiro KusumiThe
96*e2950f41STomohiro Kusumi.Nm
97*e2950f41STomohiro Kusumidriver first appeared in
98*e2950f41STomohiro Kusumi.Dx 4.5 .
99*e2950f41STomohiro Kusumi.Sh AUTHORS
100*e2950f41STomohiro KusumiThe
101*e2950f41STomohiro Kusumi.Nm
102*e2950f41STomohiro Kusumiwas developed by
103*e2950f41STomohiro Kusumi.An Edward Tomasz Napierala Aq Mt trasz@FreeBSD.org
104*e2950f41STomohiro Kusumiunder sponsorship from the FreeBSD Foundation.
105*e2950f41STomohiro Kusumi.Pp
106*e2950f41STomohiro KusumiThe
107*e2950f41STomohiro Kusumi.Nm
108*e2950f41STomohiro Kusumiwas ported to
109*e2950f41STomohiro Kusumi.Dx
110*e2950f41STomohiro Kusumiby
111*e2950f41STomohiro Kusumi.An Tomohiro Kusumi Aq Mt kusumi.tomohiro@gmail.com .
112*e2950f41STomohiro Kusumi.Sh BUGS
113*e2950f41STomohiro KusumiThe
114*e2950f41STomohiro Kusumi.Nm
115*e2950f41STomohiro Kusumidriver on
116*e2950f41STomohiro Kusumi.Dx
117*e2950f41STomohiro Kusumicurrently does't support
118*e2950f41STomohiro Kusumi.Pa vfs.autofs.mount_on_stat
119*e2950f41STomohiro Kusumisysctl.
120*e2950f41STomohiro KusumiThis sysctl is disabled by default on both
121*e2950f41STomohiro Kusumi.Fx
122*e2950f41STomohiro Kusumiand
123*e2950f41STomohiro Kusumi.Dx ,
124*e2950f41STomohiro Kusumibut enabling it does nothing on
125*e2950f41STomohiro Kusumi.Dx .
126