usr/src/man/man4/autofs.4

   1 '\" te
   2 .\"  Copyright (c) 2002 Sun Microsystems, Inc. All rights reserved.
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH AUTOFS 4 "Aug 2, 2005"
   7 .SH NAME
   8 autofs \- file containing parameter values for automountd daemon and automount
   9 command
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fB/etc/default/autofs\fR
  14 .fi
  15
  16 .SH DESCRIPTION
  17 .sp
  18 .LP
  19 The \fBautofs\fR file resides in directory \fB/etc/default\fR and supplies
  20 default parameters for the \fBautomountd\fR(1M) daemon and the
  21 \fBautomount\fR(1M) command.
  22 .sp
  23 .LP
  24 The \fBautofs\fR file format is \fBASCII\fR; comment lines begin with the
  25 crosshatch (\fB#\fR) character. Parameters consist of a keyword followed by an
  26 equal sign followed by the parameter value, of the form:
  27 .sp
  28 .in +2
  29 .nf
  30 \fIkeyword\fR=\fIvalue\fR
  31 .fi
  32 .in -2
  33 .sp
  34
  35 .sp
  36 .LP
  37 As shipped, the parameters in the \fBautofs\fR file are commented out. As root,
  38 you must uncomment a keyword-value line to make the value for that parameter
  39 take effect.
  40 .sp
  41 .LP
  42 Administrators can make changes to the startup parameters for \fBautomountd\fR
  43 by logging in as root and editing the \fBautofs\fR file. Changes made to
  44 \fBautofs\fR values on an \fBautomount\fR or \fBautomountd\fR command line
  45 override values in \fB/etc/default/autofs\fR. The \fB/etc/default/autofs\fR
  46 file is preserved across operating system upgrades.
  47 .sp
  48 .LP
  49 The following parameters are currently supported in the \fBautofs\fR file:
  50 .sp
  51 .ne 2
  52 .na
  53 \fB\fBAUTOMOUNT_TIMEOUT=\fR\fI<num>\fR\fR
  54 .ad
  55 .sp .6
  56 .RS 4n
  57 Specifies a duration, in seconds, that a file system is to remain mounted when
  58 not in use. The default value is 600 (10 minutes). Equivalent to the \fB-t\fR
  59 option in \fBautomount\fR.
  60 .RE
  61
  62 .sp
  63 .ne 2
  64 .na
  65 \fB\fBAUTOMOUNT_VERBOSE=\fR\fBTRUE | FALSE\fR\fR
  66 .ad
  67 .sp .6
  68 .RS 4n
  69 Verbose mode. Causes you to be notified of non-critical events, suchs as
  70 \fBautofs\fR mounts and unmounts. The default value is \fBFALSE\fR. Equivalent
  71 to the \fB-v\fR option in \fBautomount\fR.
  72 .RE
  73
  74 .sp
  75 .ne 2
  76 .na
  77 \fB\fBAUTOMOUNTD_VERBOSE=\fR\fBTRUE | FALSE\fR\fR
  78 .ad
  79 .sp .6
  80 .RS 4n
  81 Verbose mode. Causes status messages to be logged to
  82 \fB/var/svc/log/system-filesystem-autofs:default.log\fR. (See \fBsmf\fR(5).)
  83 The default value is \fBFALSE\fR. Equivalent to the \fB-v\fR option in
  84 \fBautomountd\fR.
  85 .RE
  86
  87 .sp
  88 .ne 2
  89 .na
  90 \fB\fBAUTOMOUNTD_NOBROWSE=\fR\fI<num>\fR\fR
  91 .ad
  92 .sp .6
  93 .RS 4n
  94 Turn on or off browsing for all \fBautofs\fR mount points. The default value is
  95 \fBFALSE\fR. Equivalent to the \fB-n\fR option in \fBautomountd\fR.
  96 .RE
  97
  98 .sp
  99 .ne 2
 100 .na
 101 \fB\fBAUTOMOUNTD_TRACE=\fR\fI<num>\fR\fR
 102 .ad
 103 .sp .6
 104 .RS 4n
 105 Expands each RPC call and logs it to
 106 \fB/var/svc/log/system-filesystem-autofs:default.log\fR. (See \fBsmf\fR(5).)
 107 The default value, \fB0\fR, turns off such tracing. Starting with 1, with each
 108 higher value, the verbosity of trace output increases.
 109 .RE
 110
 111 .sp
 112 .ne 2
 113 .na
 114 \fB\fBAUTOMOUNTD_ENV\fR=\fI<name>\fR\fB=\fR\fI<value>\fR\fR
 115 .ad
 116 .sp .6
 117 .RS 4n
 118 Environment variables. Each environment variable-value pairing must be on its
 119 own line. You can specify multiple such pairings. There are no environment
 120 variable settings supplied. For example: \fBAUTOMOUNTD_ENV=DAY=TUES\fR
 121 .RE
 122
 123 .SH SEE ALSO
 124 .sp
 125 .LP
 126 \fBautomount\fR(1M), \fBautomountd\fR(1M), \fBsmf\fR(5)