share/man/man5/autofs.5

   1 .\" Copyright (c) 2014 The FreeBSD Foundation
   2 .\" All rights reserved.
   3 .\"
   4 .\" This software was developed by Edward Tomasz Napierala under sponsorship
   5 .\" from the FreeBSD Foundation.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\" $FreeBSD$
  29 .\"
  30 .Dd December 2, 2017
  31 .Dt AUTOFS 5
  32 .Os
  33 .Sh NAME
  34 .Nm autofs
  35 .Nd "automounter filesystem"
  36 .Sh SYNOPSIS
  37 To compile this driver into the kernel,
  38 place the following line in the
  39 kernel configuration file:
  40 .Bd -ragged -offset indent
  41 .Cd "options AUTOFS"
  42 .Ed
  43 .Pp
  44 Alternatively, to load the driver as a
  45 module at boot time, place the following line in
  46 .Xr loader.conf 5 :
  47 .Bd -literal -offset indent
  48 autofs_load="YES"
  49 .Ed
  50 .Sh DESCRIPTION
  51 The
  52 .Nm
  53 driver is the kernel component of the automounter infrastructure.
  54 Its job is to pass mount requests to the
  55 .Xr automountd 8
  56 daemon, and pause the processes trying to access the automounted filesystem
  57 until the mount is completed.
  58 It is mounted by the
  59 .Xr automount 8 .
  60 .Sh OPTIONS
  61 These options are available when
  62 mounting
  63 .Nm
  64 file systems:
  65 .Bl -tag -width indent
  66 .It Cm master_options
  67 Mount options for all filesystems specified in the map entry.
  68 .It Cm master_prefix
  69 Filesystem mountpoint prefix.
  70 .El
  71 .Sh SYSCTL VARIABLES
  72 The following variables are available as both
  73 .Xr sysctl 8
  74 variables and
  75 .Xr loader 8
  76 tunables:
  77 .Bl -tag -width indent
  78 .It Va vfs.autofs.debug
  79 Verbosity level for log messages from the
  80 .Nm
  81 driver.
  82 Set to 0 to disable logging or 1 to warn about potential problems.
  83 Larger values enable debugging output.
  84 Defaults to 1.
  85 .It Va vfs.autofs.interruptible
  86 Set to 1 to allow mount requests to be interrupted by signal.
  87 Defaults to 1.
  88 .It Va vfs.autofs.retry_delay
  89 Number of seconds before retrying mount requests.
  90 Defaults to 1.
  91 .It Va vfs.autofs.retry_attempts
  92 Number of attempts before failing mount.
  93 Defaults to 3.
  94 .It Va vfs.autofs.cache
  95 Number of seconds to wait before reinvoking
  96 .Xr automountd 8
  97 for any given file or directory.
  98 Defaults to 600.
  99 .It Va vfs.autofs.timeout
 100 Number of seconds to wait for
 101 .Xr automountd 8
 102 to handle the mount request.
 103 Defaults to 30.
 104 .It Va vfs.autofs.mount_on_stat
 105 Set to 1 to trigger mount on
 106 .Xr stat 2
 107 on mountpoint.
 108 Defaults to 0.
 109 .El
 110 .Sh EXAMPLES
 111 To unmount all mounted
 112 .Nm
 113 filesystems:
 114 .Pp
 115 .Dl "umount -At autofs"
 116 .Pp
 117 To mount
 118 .Nm
 119 filesystems specified in
 120 .Xr auto_master 5 :
 121 .Pp
 122 .Dl "automount"
 123 .Sh SEE ALSO
 124 .Xr auto_master 5 ,
 125 .Xr automount 8 ,
 126 .Xr automountd 8 ,
 127 .Xr autounmountd 8
 128 .Sh HISTORY
 129 The
 130 .Nm
 131 driver first appeared in
 132 .Fx 10.1 .
 133 .Sh AUTHORS
 134 The
 135 .Nm
 136 was developed by
 137 .An Edward Tomasz Napierala Aq Mt trasz@FreeBSD.org
 138 under sponsorship from the FreeBSD Foundation.