xref: /illumos-gate/usr/src/man/man5/autofs.5 (revision d48be21240dfd051b689384ce2b23479d757f2d8)
1.\"
2.\" The contents of this file are subject to the terms of the
3.\" Common Development and Distribution License (the "License").
4.\" You may not use this file except in compliance with the License.
5.\"
6.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
7.\" or http://www.opensolaris.org/os/licensing.
8.\" See the License for the specific language governing permissions
9.\" and limitations under the License.
10.\"
11.\" When distributing Covered Code, include this CDDL HEADER in each
12.\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
13.\" If applicable, add the following below this CDDL HEADER, with the
14.\" fields enclosed by brackets "[]" replaced with your own identifying
15.\" information: Portions Copyright [yyyy] [name of copyright owner]
16.\"
17.\"
18.\" Copyright (c) 2002 Sun Microsystems, Inc. All rights reserved.
19.\" Copyright 2016 Nexenta Systems, Inc.
20.\"
21.Dd March 1, 2016
22.Dt AUTOFS 5
23.Os
24.Sh NAME
25.Nm autofs
26.Nd automount configuration properties
27.Sh DESCRIPTION
28The behavior of the
29.Xr automount 8
30command and the
31.Xr automountd 8
32daemon is controlled by property values that are stored in the Service
33Management Facility,
34.Xr smf 7 .
35The
36.Xr sharectl 8
37command should be used to query or change values for these properties.
38.Pp
39Changes made to
40.Nm
41property values on an
42.Nm automount
43or
44.Nm automountd
45command line override the values set using
46.Xr sharectl 8 .
47.Pp
48The following list describes the properties:
49.Bl -tag -width Ds
50.It Sy timeout Ns = Ns Ar num
51Specifies a duration, in seconds, that a file system is to remain mounted when
52not in use.
53The default value is 600
54.Pq 10 minutes .
55Equivalent to the
56.Fl t
57option in
58.Nm automount .
59.It Sy automount_verbose Ns = Ns Sy true Ns | Ns Sy false
60Verbose mode.
61Causes you to be notified of non-critical events, such as
62.Nm
63mounts and unmounts.
64The default value is
65.Sy false .
66Equivalent to the
67.Fl v
68option in
69.Nm automount .
70.It Sy automountd_verbose Ns = Ns Sy true Ns | Ns Sy false
71Verbose mode.
72Causes status messages to be logged to the svc:/system/filesystem/autofs:default
73log file.
74The default value is
75.Sy false .
76Equivalent to the
77.Fl v
78option in
79.Nm automountd .
80.It Sy nobrowse Ns = Ns Sy true Ns | Ns Sy false
81Turn on or off browsing for all
82.Nm
83mount points.
84The default value is
85.Sy false .
86Equivalent to the
87.Fl n
88option in
89.Nm automountd .
90.It Sy trace Ns = Ns Ar num
91Expands each RPC call and logs it to svc:/system/filesystem/autofs:default
92log file.
93The default value, 0, turns off such tracing.
94Starting with 1, with each higher value, the verbosity of trace output
95increases.
96.It Xo
97.Sy environment Ns = Ns Ar name Ns = Ns Ar value Ns
98.Oo , Ns Ar name Ns = Ns Ar value Oc Ns ...
99.Xc
100Specifies a comma separated list of environment variables.
101If an environment variable has more than one value, those values should be
102separated with a comma, preceded by a backslash as an escape character
103.Pq Qq Sy \e, .
104For example:
105.Bd -literal -offset indent
106VAR1=val1,VAR2=val2\e,val3
107.Ed
108.El
109.Sh SEE ALSO
110.Xr smf 7 ,
111.Xr automount 8 ,
112.Xr automountd 8 ,
113.Xr sharectl 8
114