share/man/man5/fstab.5

   1 .\"     $NetBSD: fstab.5,v 1.35 2009/01/11 20:51:18 pooka Exp $
   2 .\"
   3 .\" Copyright (c) 1980, 1989, 1991, 1993
   4 .\"     The Regents of the University of California.  All rights reserved.
   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 .\" 3. Neither the name of the University nor the names of its contributors
  15 .\"    may be used to endorse or promote products derived from this software
  16 .\"    without specific prior written permission.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28 .\" SUCH DAMAGE.
  29 .\"
  30 .\"     @(#)fstab.5     8.1 (Berkeley) 6/5/93
  31 .\"
  32 .Dd January 11, 2009
  33 .Dt FSTAB 5
  34 .Os
  35 .Sh NAME
  36 .Nm fstab
  37 .Nd filesystem table for devices, types, and mount points
  38 .Sh SYNOPSIS
  39 .In fstab.h
  40 .Sh DESCRIPTION
  41 The file
  42 .Nm
  43 contains descriptive information about the various file systems.
  44 .Nm
  45 is only read by programs, and not written;
  46 it is the duty of the system administrator to properly create
  47 and maintain this file.
  48 Each filesystem is described on a separate line;
  49 fields on each line are separated by tabs or spaces.
  50 Lines beginning
  51 with
  52 .Dq #
  53 are comments.
  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 respective tasks.
  64 .Pp
  65 Each configuration line/record in
  66 .Nm
  67 has the format:
  68 .Dl fs_spec fs_file fs_vfstype fs_mntops fs_freq fs_passno
  69 .Pp
  70 The first field,
  71 .Pq Fa fs_spec ,
  72 describes the block special device or
  73 remote filesystem to be mounted.
  74 For filesystems of type
  75 .Em ffs ,
  76 the special file name is the block special file name,
  77 and not the character special file name.
  78 If a program needs the character special file name,
  79 the program must create it by appending a
  80 .Dq r
  81 after the
  82 last
  83 .Dq /
  84 in the special file name.
  85 .Pp
  86 The second field,
  87 .Pq Fa fs_file ,
  88 describes the mount point for the filesystem.
  89 For swap and dump partitions, this field should be specified as
  90 .Dq none .
  91 .Pp
  92 The third field,
  93 .Pq Fa fs_vfstype ,
  94 describes the type of the filesystem.
  95 The system currently supports these filesystems:
  96 .Bl -tag -width filecore -offset indent
  97 .It Em adosfs
  98 an
  99 .Tn AmigaDOS
 100 filesystem.
 101 .It Em cd9660
 102 an
 103 .Tn ISO
 104 9660 CD-ROM filesystem.
 105 .It Em ext2fs
 106 an implementation of the Linux
 107 .Dq Second Extended File-system .
 108 .It Em fdesc
 109 an implementation of
 110 .Pa /dev/fd .
 111 .It Em ffs
 112 a local
 113 .Ux
 114 filesystem.
 115 .It Em filecore
 116 a filesystem for
 117 .Tn RISC\ OS .
 118 .It Em kernfs
 119 various and sundry kernel statistics.
 120 .It Em lfs
 121 a log-structured file-system.
 122 .It Em mfs
 123 a local memory-based
 124 .Ux
 125 filesystem.
 126 .It Em msdos
 127 an
 128 .Tn MS-DOS
 129 .Dq FAT filesystem .
 130 .It Em nfs
 131 a Sun Microsystems compatible
 132 .Dq Network File System .
 133 .It Em ntfs
 134 a filesystem used by
 135 .Tn Windows NT .
 136 Still experimental.
 137 .It Em null
 138 a loop-back filesystem, allowing parts of the system to be viewed
 139 elsewhere.
 140 .It Em overlay
 141 a demonstration of layered filesystems.
 142 .It Em portal
 143 a general filesystem interface, currently supports TCP and FS mounts.
 144 .It Em procfs
 145 a local filesystem of process information.
 146 .It Em ptyfs
 147 a pseudo-terminal device file system.
 148 .It Em smbfs
 149 a shared resource from an SMB/CIFS file server.
 150 .It Em swap
 151 a disk partition to be used for swapping and paging.
 152 .It Em tmpfs
 153 an efficient memory file system.
 154 .It Em umap
 155 a user and group re-mapping filesystem.
 156 .It Em union
 157 a translucent filesystem.
 158 .El
 159 .Pp
 160 The fourth field,
 161 .Pq Fa fs_mntops ,
 162 describes the mount options associated with the filesystem.
 163 It is formatted as a comma separated list of options.
 164 It contains at least the type of mount (see
 165 .Fa fs_type
 166 below) plus any additional options
 167 appropriate to the filesystem type.
 168 .Pp
 169 The option
 170 .Dq auto
 171 can be used in the
 172 .Dq noauto
 173 form to cause
 174 a file system not to be mounted automatically (with
 175 .Dq mount -a
 176 ,
 177 or system boot time).
 178 .Pp
 179 If the options
 180 .Dq userquota
 181 and/or
 182 .Dq groupquota
 183 are specified,
 184 the filesystem is automatically processed by the
 185 .Xr quotacheck 8
 186 command, and user and/or group disk quotas are enabled with
 187 .Xr quotaon 8 .
 188 By default,
 189 filesystem quotas are maintained in files named
 190 .Pa quota.user
 191 and
 192 .Pa quota.group
 193 which are located at the root of the associated filesystem.
 194 These defaults may be overridden by putting an equal sign
 195 and an alternative absolute pathname following the quota option.
 196 Thus, if the user quota file for
 197 .Pa /tmp
 198 is stored in
 199 .Pa /var/quotas/tmp.user ,
 200 this location can be specified as:
 201 .Bd -literal -offset indent
 202 userquota=/var/quotas/tmp.user
 203 .Ed
 204 .Pp
 205 The option
 206 .Dq rump
 207 is used to mount the file system using a
 208 .Xr rump 3
 209 userspace server instead of the kernel server.
 210 .Pp
 211 The type of the mount is extracted from the
 212 .Fa fs_mntops
 213 field and stored separately in the
 214 .Fa fs_type
 215 field (it is not deleted from the
 216 .Fa fs_mntops
 217 field).
 218 If
 219 .Fa fs_type
 220 is
 221 .Dq rw
 222 or
 223 .Dq ro
 224 then the filesystem whose name is given in the
 225 .Fa fs_file
 226 field is normally mounted read-write or read-only on the
 227 specified special file.
 228 If
 229 .Fa fs_type
 230 is
 231 .Dq sw
 232 or
 233 .Dq dp
 234 then the special file is made available as a piece of swap
 235 or dump
 236 space by the
 237 .Xr swapctl 8
 238 command towards the beginning of the system reboot procedure.
 239 See
 240 .Xr swapctl 8
 241 for more information on configuring swap and dump devices.
 242 The fields other than
 243 .Fa fs_spec
 244 and
 245 .Fa fs_type
 246 are unused.
 247 If
 248 .Fa fs_type
 249 is specified as
 250 .Dq xx
 251 the entry is ignored.
 252 This is useful to show disk partitions which are currently unused.
 253 .Pp
 254 The fifth field,
 255 .Pq Fa fs_freq ,
 256 is used for these filesystems by the
 257 .Xr dump 8
 258 command to determine which filesystems need to be dumped.
 259 If the fifth field is not present, a value of zero is returned and
 260 .Xr dump 8
 261 will assume that the filesystem does not need to be dumped.
 262 .Pp
 263 The sixth field,
 264 .Pq Fa fs_passno ,
 265 is used by the
 266 .Xr fsck 8
 267 program to determine the order in which filesystem checks are done
 268 at reboot time.
 269 The root filesystem should be specified with a
 270 .Fa fs_passno
 271 of 1, and other filesystems should have a
 272 .Fa fs_passno
 273 of 2.
 274 Filesystems within a drive will be checked sequentially,
 275 but filesystems on different drives will be checked at the
 276 same time to use parallelism available in the hardware.
 277 If the sixth field is not present or zero,
 278 a value of zero is returned and
 279 .Xr fsck 8
 280 will assume that the filesystem does not need to be checked.
 281 .Bd -literal
 282 #define FSTAB_RW        "rw"    /* read-write device */
 283 #define FSTAB_RQ        "rq"    /* read/write with quotas */
 284 #define FSTAB_RO        "ro"    /* read-only device */
 285 #define FSTAB_SW        "sw"    /* swap device */
 286 #define FSTAB_DP        "dp"    /* dump device */
 287 #define FSTAB_XX        "xx"    /* ignore totally */
 288
 289 struct fstab {
 290         char    *fs_spec;       /* block special device name */
 291         char    *fs_file;       /* filesystem path prefix */
 292         char    *fs_vfstype;    /* type of filesystem */
 293         char    *fs_mntops;     /* comma separated mount options */
 294         char    *fs_type;       /* rw, ro, sw, or xx */
 295         int     fs_freq;        /* dump frequency, in days */
 296         int     fs_passno;      /* pass number on parallel fsck */
 297 };
 298 .Ed
 299 .Pp
 300 The proper way to read records from
 301 .Pa fstab
 302 is to use the routines
 303 .Xr getfsent 3 ,
 304 .Xr getfsspec 3 ,
 305 and
 306 .Xr getfsfile 3 .
 307 .Sh FILES
 308 .Bl -tag -width /etc/fstab
 309 .It Pa /etc/fstab
 310 The location of
 311 .Nm
 312 configuration file.
 313 .It Pa /usr/share/examples/fstab/
 314 Some useful configuration examples.
 315 .El
 316 .Sh SEE ALSO
 317 .Xr getfsent 3 ,
 318 .Xr mount 8 ,
 319 .Xr swapctl 8
 320 .Sh HISTORY
 321 The
 322 .Nm
 323 file format appeared in
 324 .Bx 4.0 .