share/man/man5/autofs.5

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