xref: /netbsd-src/share/man/man5/autofs.5 (revision b94e44675e4c2360dbf55042b06acad015836368)
1.\" $NetBSD: autofs.5,v 1.5 2019/11/21 15:24:17 tkusumi Exp $
2.\"
3.\" Copyright (c) 2017 The NetBSD Foundation, Inc.
4.\" Copyright (c) 2016 The DragonFly Project
5.\" Copyright (c) 2014 The FreeBSD Foundation
6.\" All rights reserved.
7.\"
8.\" This code is derived from software contributed to The NetBSD Foundation
9.\" by Tomohiro Kusumi.
10.\"
11.\" This software was developed by Edward Tomasz Napierala under sponsorship
12.\" from the FreeBSD Foundation.
13.\"
14.\" Redistribution and use in source and binary forms, with or without
15.\" modification, are permitted provided that the following conditions
16.\" are met:
17.\" 1. Redistributions of source code must retain the above copyright
18.\"    notice, this list of conditions and the following disclaimer.
19.\" 2. Redistributions in binary form must reproduce the above copyright
20.\"    notice, this list of conditions and the following disclaimer in the
21.\"    documentation and/or other materials provided with the distribution.
22.\"
23.\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS 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 AUTHORS 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
33.\" SUCH DAMAGE.
34.\"
35.\" $FreeBSD$
36.\"
37.Dd November 25, 2017
38.Dt AUTOFS 5
39.Os
40.Sh NAME
41.Nm autofs
42.Nd "automounter filesystem"
43.Sh SYNOPSIS
44.\"To compile this driver into the kernel,
45.\"place the following line in the
46.\"kernel configuration file:
47.\".Bd -ragged -offset indent
48.Cd "options AUTOFS"
49.\".Ed
50.\".Pp
51.\"Alternatively, to load the driver as a
52.\"module at boot time, place the following line in
53.\".Xr loader.conf 5 :
54.\".Bd -literal -offset indent
55.\"autofs_load="YES"
56.\".Ed
57.Sh DESCRIPTION
58The
59.Nm
60driver is the kernel component of the automounter infrastructure.
61Its job is to pass mount requests to the
62.Xr automountd 8
63daemon, and pause the processes trying to access the automounted filesystem
64until the mount is completed.
65It is mounted by the
66.Xr automount 8 .
67.Sh OPTIONS
68These options are available when
69mounting
70.Nm
71file systems:
72.Bl -tag -width indent
73.It Cm master_options
74Mount options for all filesystems specified in the map entry.
75.It Cm master_prefix
76Filesystem mountpoint prefix.
77.El
78.Sh EXAMPLES
79To unmount all mounted
80.Nm
81filesystems:
82.Pp
83.Dl "umount -At autofs"
84.Pp
85To mount
86.Nm
87filesystems specified in
88.Xr auto_master 5 :
89.Pp
90.Dl "automount"
91.Sh SEE ALSO
92.Xr auto_master 5 ,
93.Xr automount 8 ,
94.Xr automountd 8 ,
95.Xr autounmountd 8 ,
96.Xr mount_autofs 8
97.Sh HISTORY
98The
99.Nm
100driver first appeared in
101.Fx 10.1 .
102The
103.Nm
104driver first appeared in
105.Dx 4.5 .
106The
107.Nm
108driver first appeared in
109.Nx 9.0 .
110.Sh AUTHORS
111.An -nosplit
112The
113.Nm
114was developed by
115.An Edward Tomasz Napierala Aq Mt trasz@FreeBSD.org
116under sponsorship from the FreeBSD Foundation.
117.Pp
118The
119.Nm
120was ported to
121.Dx
122and
123.Nx
124by
125.An Tomohiro Kusumi Aq Mt tkusumi@netbsd.org .
126