share/man/man5/fstab.5

   1 .\" Copyright (c) 1980, 1989, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)fstab.5     8.1 (Berkeley) 6/5/93
  33 .\" $FreeBSD$
  34 .\"
  35 .Dd November 23, 2008
  36 .Dt FSTAB 5
  37 .Os
  38 .Sh NAME
  39 .Nm fstab
  40 .Nd static information about the file systems
  41 .Sh SYNOPSIS
  42 .In fstab.h
  43 .Sh DESCRIPTION
  44 The file
  45 .Nm
  46 contains descriptive information about the various file
  47 systems.
  48 .Nm
  49 is only read by programs, and not written;
  50 it is the duty of the system administrator to properly create
  51 and maintain this file.
  52 Each file system is described on a separate line;
  53 fields on each line are separated by tabs or spaces.
  54 The order of records in
  55 .Nm
  56 is important because
  57 .Xr fsck 8 ,
  58 .Xr mount 8 ,
  59 and
  60 .Xr umount 8
  61 sequentially iterate through
  62 .Nm
  63 doing their thing.
  64 .Pp
  65 The first field,
  66 .Pq Fa fs_spec ,
  67 describes the special device or
  68 remote file system to be mounted.
  69 .Pp
  70 The second field,
  71 .Pq Fa fs_file ,
  72 describes the mount point for the file system.
  73 For swap partitions, this field should be specified as ``none''.
  74 .Pp
  75 The third field,
  76 .Pq Fa fs_vfstype ,
  77 describes the type of the file system.
  78 The system can support various file system types.
  79 Only the root, /usr, and /tmp file systems need be statically
  80 compiled into the kernel;
  81 everything else will be automatically loaded at mount
  82 time.
  83 (Exception: the FFS cannot currently be demand-loaded.)
  84 Some people still prefer to statically
  85 compile other file systems as well.
  86 .Pp
  87 The fourth field,
  88 .Pq Fa fs_mntops ,
  89 describes the mount options associated with the file system.
  90 It is formatted as a comma separated list of options.
  91 It contains at least the type of mount (see
  92 .Fa fs_type
  93 below) plus any additional options appropriate to the file system type.
  94 See the options flag
  95 .Pq Fl o
  96 in the
  97 .Xr mount 8
  98 page and the file system specific page, such as
  99 .Xr mount_nfs 8 ,
 100 for additional options that may be specified.
 101 All options that can be given to the file system specific mount commands
 102 can be used in
 103 .Nm
 104 as well.
 105 They just need to be formatted a bit differently.
 106 The arguments of the
 107 .Fl o
 108 option can be used without the preceding
 109 .Fl o
 110 flag.
 111 Other options need both the file system specific flag and its argument,
 112 separated by an equal sign.
 113 For example, mounting an
 114 .Xr msdosfs 5
 115 filesystem, the options
 116 .Bd -literal -offset indent
 117 -o sync -o noatime -m 644 -M 755 -u foo -g bar
 118 .Ed
 119 .Pp
 120 should be written as
 121 .Bd -literal -offset indent
 122 sync,noatime,-m=644,-M=755,-u=foo,-g=bar
 123 .Ed
 124 .Pp
 125 in the option field of
 126 .Nm .
 127 .Pp
 128 If the options ``userquota'' and/or ``groupquota'' are specified,
 129 the file system is automatically processed by the
 130 .Xr quotacheck 8
 131 command, and user and/or group disk quotas are enabled with
 132 .Xr quotaon 8 .
 133 By default,
 134 file system quotas are maintained in files named
 135 .Pa quota.user
 136 and
 137 .Pa quota.group
 138 which are located at the root of the associated file system.
 139 These defaults may be overridden by putting an equal sign
 140 and an alternative absolute pathname following the quota option.
 141 Thus, if the user quota file for
 142 .Pa /tmp
 143 is stored in
 144 .Pa /var/quotas/tmp.user ,
 145 this location can be specified as:
 146 .Bd -literal -offset indent
 147 userquota=/var/quotas/tmp.user
 148 .Ed
 149 .Pp
 150 If the option ``noauto'' is specified, the file system will not be automatically
 151 mounted at system startup.
 152 Note that, for network file systems
 153 of third party types
 154 (i.e., types supported by additional software
 155 not included in the base system)
 156 to be automatically mounted at system startup,
 157 the
 158 .Va extra_netfs_types
 159 .Xr rc.conf 5
 160 variable must be used to extend the
 161 .Xr rc 8
 162 startup script's list of network file system types.
 163 .Pp
 164 The type of the mount is extracted from the
 165 .Fa fs_mntops
 166 field and stored separately in the
 167 .Fa fs_type
 168 field (it is not deleted from the
 169 .Fa fs_mntops
 170 field).
 171 If
 172 .Fa fs_type
 173 is ``rw'' or ``ro'' then the file system whose name is given in the
 174 .Fa fs_file
 175 field is normally mounted read-write or read-only on the
 176 specified special file.
 177 If
 178 .Fa fs_type
 179 is ``sw'' then the special file is made available as a piece of swap
 180 space by the
 181 .Xr swapon 8
 182 command at the end of the system reboot procedure.
 183 The fields other than
 184 .Fa fs_spec
 185 and
 186 .Fa fs_type
 187 are unused.
 188 If
 189 .Fa fs_type
 190 is specified as ``xx'' the entry is ignored.
 191 This is useful to show disk partitions which are currently unused.
 192 .Pp
 193 The fifth field,
 194 .Pq Fa fs_freq ,
 195 is used for these file systems by the
 196 .Xr dump 8
 197 command to determine which file systems need to be dumped.
 198 If the fifth field is not present, a value of zero is returned and
 199 .Nm dump
 200 will assume that the file system does not need to be dumped.
 201 If the fifth field is greater than 0, then it specifies the number of days
 202 between dumps for this file system.
 203 .Pp
 204 The sixth field,
 205 .Pq Fa fs_passno ,
 206 is used by the
 207 .Xr fsck 8
 208 and
 209 .Xr quotacheck 8
 210 programs to determine the order in which file system and quota
 211 checks are done at reboot time.
 212 The
 213 .Fa fs_passno
 214 field can be any value between 0 and
 215 .Ql INT_MAX Ns -1 .
 216 .Pp
 217 The root file system should be specified with a
 218 .Fa fs_passno
 219 of 1, and other file systems should have a
 220 .Fa fs_passno
 221 of 2 or greater.
 222 A file system with a
 223 .Fa fs_passno
 224 value of 1 is always checked sequentially and be completed before
 225 another file system is processed, and it will be processed before
 226 all file systems with a larger
 227 .Fa fs_passno .
 228 .Pp
 229 For any given value of
 230 .Fa fs_passno ,
 231 file systems within a drive will be checked sequentially,
 232 but file systems on different drives will be checked at the
 233 same time to utilize parallelism available in the hardware.
 234 Once all file system checks are complete for the current
 235 .Fa fs_passno ,
 236 the same process will start over for the next
 237 .Fa fs_passno .
 238 .Pp
 239 If the sixth field is not present or is zero,
 240 a value of zero is returned and
 241 .Xr fsck 8
 242 and
 243 .Xr quotacheck 8
 244 will assume that the file system does not need to be checked.
 245 .Pp
 246 The
 247 .Fa fs_passno
 248 field can be used to implement finer control when
 249 the system utilities may determine that the file system resides
 250 on a different physical device, when it actually does not, as with a
 251 .Xr ccd 4
 252 device.
 253 All file systems with a lower
 254 .Fa fs_passno
 255 value will be completed before starting on file systems with a
 256 higher
 257 .Fa fs_passno
 258 value.
 259 E.g. all file systems with a
 260 .Fa fs_passno
 261 of 2 will be completed before any file systems with a
 262 .Fa fs_passno
 263 of 3 or greater are started.
 264 Gaps are allowed between the different
 265 .Fa fs_passno
 266 values.
 267 E.g. file systems listed in
 268 .Pa /etc/fstab
 269 may have
 270 .Fa fs_passno
 271 values such as 0, 1, 2, 15, 100, 200, 300, and may appear in any order
 272 within
 273 .Pa /etc/fstab .
 274 .Bd -literal
 275 #define FSTAB_RW        "rw"    /* read/write device */
 276 #define FSTAB_RQ        "rq"    /* read/write with quotas */
 277 #define FSTAB_RO        "ro"    /* read-only device */
 278 #define FSTAB_SW        "sw"    /* swap device */
 279 #define FSTAB_XX        "xx"    /* ignore totally */
 280
 281 struct fstab {
 282         char    *fs_spec;       /* block special device name */
 283         char    *fs_file;       /* file system path prefix */
 284         char    *fs_vfstype;    /* File system type, ufs, nfs */
 285         char    *fs_mntops;     /* Mount options ala -o */
 286         char    *fs_type;       /* FSTAB_* from fs_mntops */
 287         int     fs_freq;        /* dump frequency, in days */
 288         int     fs_passno;      /* pass number on parallel fsck */
 289 };
 290 .Ed
 291 .Pp
 292 The proper way to read records from
 293 .Pa fstab
 294 is to use the routines
 295 .Xr getfsent 3 ,
 296 .Xr getfsspec 3 ,
 297 .Xr getfstype 3 ,
 298 and
 299 .Xr getfsfile 3 .
 300 .Sh FILES
 301 .Bl -tag -width /etc/fstab -compact
 302 .It Pa /etc/fstab
 303 The file
 304 .Nm
 305 resides in
 306 .Pa /etc .
 307 .El
 308 .Sh SEE ALSO
 309 .Xr getfsent 3 ,
 310 .Xr getvfsbyname 3 ,
 311 .Xr ccd 4 ,
 312 .Xr dump 8 ,
 313 .Xr fsck 8 ,
 314 .Xr mount 8 ,
 315 .Xr quotacheck 8 ,
 316 .Xr quotaon 8 ,
 317 .Xr swapon 8 ,
 318 .Xr umount 8
 319 .Sh HISTORY
 320 The
 321 .Nm
 322 file format appeared in
 323 .Bx 4.0 .