share/man/man5/autofs.5

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