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