autofs: Port autofs from FreeBSD
[dragonfly.git] / usr.sbin / autofs / automount.8
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 April 14, 2016
32 .Dt AUTOMOUNT 8
33 .Os
34 .Sh NAME
35 .Nm automount
36 .Nd update autofs mounts
37 .Sh SYNOPSIS
38 .Nm
39 .Op Fl D Ar name=value
40 .Op Fl L
41 .Op Fl c
42 .Op Fl f
43 .Op Fl o Ar options
44 .Op Fl v
45 .Op Fl u
46 .Sh DESCRIPTION
47 When called without options, the
48 .Nm
49 command parses the
50 .Xr auto_master 5
51 configuration file and any direct maps that it references, and mounts
52 or unmounts
53 .Xr autofs 5
54 filesystems to match.
55 These options are available:
56 .Bl -tag -width ".Fl v"
57 .It Fl D
58 Define a variable.
59 It is only useful with
60 .Fl L .
61 .It Fl L
62 Do not mount or unmount anything.
63 Instead parse
64 .Xr auto_master 5
65 and any direct maps, then print them to standard output.
66 When specified more than once, all the maps, including indirect ones,
67 will be parsed and shown.
68 This is useful when debugging configuration problems.
69 .It Fl c
70 Flush caches, discarding possibly stale information obtained from maps
71 and directory services.
72 .It Fl f
73 Force unmount, to be used with
74 .Fl u .
75 .It Fl o
76 Specify mount options to be used along with the ones specified in the maps.
77 It is only useful with
78 .Fl L .
79 .It Fl u
80 Try to unmount filesystems mounted by
81 .Xr automountd 8 .
82 .Xr autofs 5
83 mounts are not unmounted.
84 To unmount all
85 .Xr autofs
86 mounts, use
87 .Cm "umount -At autofs".
88 .It Fl v
89 Increase verbosity.
90 .El
91 .Sh EXIT STATUS
92 .Ex -std
93 .Sh EXAMPLES
94 Unmount all filesystems mounted by
95 .Xr automountd 8 :
96 .Dl Nm Fl u
97 .Sh SEE ALSO
98 .Xr auto_master 5 ,
99 .Xr autofs 5 ,
100 .Xr automountd 8 ,
101 .Xr autounmountd 8
102 .Sh HISTORY
103 The
104 .Nm
105 command appeared in
106 .Fx 10.1 .
107 The
108 .Nm
109 command appeared in
110 .Dx 4.5 .
111 .Sh AUTHORS
112 The
113 .Nm
114 was developed by
115 .An Edward Tomasz Napierala Aq Mt trasz@FreeBSD.org
116 under sponsorship from the FreeBSD Foundation.
117 .Pp
118 The
119 .Nm
120 was ported to
121 .Dx
122 by
123 .An Tomohiro Kusumi Aq Mt kusumi.tomohiro@gmail.com .