mount/fstab.5

   1 .\" Copyright (c) 1980, 1989, 1991 The Regents of the University of California.
   2 .\" 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     6.5 (Berkeley) 5/10/91
  33 .\"
  34 .\" Modified Sat Mar  6 20:45:03 1993, faith@cs.unc.edu, for Linux
  35 .\" Sat Oct  9 10:07:10 1993: converted to man format by faith@cs.unc.edu
  36 .\" Sat Nov 20 20:47:38 1993: hpfs documentation added
  37 .\" Sat Nov 27 20:23:32 1993: Updated authorship information
  38 .\" Wed Jul 26 00:00:00 1995: Updated some nfs stuff, joey@infodrom.north.de
  39 .\" Tue Apr  2 00:38:28 1996: added info about "noauto", "user", etc.
  40 .\" Tue Jun 15 20:02:18 1999: added LABEL and UUID
  41 .\" Sat Jul 14 2001: Michael K. Johnson <johnsonm@redhat.com> added -O
  42 .\"
  43 .TH FSTAB 5 "15 June 1999" "Linux 2.2" "Linux Programmer's Manual"
  44 .SH NAME
  45 fstab \- static information about the filesystems
  46 .SH SYNOPSIS
  47 .B #include <fstab.h>
  48 .SH DESCRIPTION
  49 The file
  50 .B fstab
  51 contains descriptive information about the various file systems.
  52 .B fstab
  53 is only read by programs, and not written; it is the duty of the system
  54 administrator to properly create and maintain this file.  Each filesystem
  55 is described on a separate line; fields on each line are separated by tabs
  56 or spaces.  Lines starting with '#' are comments.  The order of records in
  57 .B fstab
  58 is important because
  59 .BR fsck (8),
  60 .BR mount (8),
  61 and
  62 .BR umount (8)
  63 sequentially iterate through
  64 .B fstab
  65 doing their thing.
  66
  67 The first field,
  68 .RI ( fs_spec ),
  69 describes the block special device or
  70 remote filesystem to be mounted.
  71 .LP
  72 For ordinary mounts it will hold (a link to) a block special
  73 device node (as created by
  74 .BR mknod (8))
  75 for the device to be mounted, like `/dev/cdrom' or `/dev/sdb7'.
  76 For NFS mounts one will have <host>:<dir>, e.g., `knuth.aeb.nl:/'.
  77 For procfs, use `proc'.
  78 .LP
  79 Instead of giving the device explicitly, one may indicate
  80 the (ext2 or xfs) filesystem that is to be mounted by its UUID or
  81 volume label (cf.
  82 .BR e2label (8)
  83 or
  84 .BR xfs_admin (8)),
  85 writing LABEL=<label> or UUID=<uuid>,
  86 e.g., `LABEL=Boot' or `UUID=3e6be9de\%-8139\%-11d1\%-9106\%-a43f08d823a6'.
  87 This will make the system more robust: adding or removing a SCSI disk
  88 changes the disk device name but not the filesystem volume label.
  89
  90 The second field,
  91 .RI ( fs_file ),
  92 describes the mount point for the filesystem.  For swap partitions, this
  93 field should be specified as `none'. If the name of the mount point
  94 contains spaces these can be escaped as `\\040'.
  95
  96 The third field,
  97 .RI ( fs_vfstype ),
  98 describes the type of the filesystem.  Linux supports lots
  99 of filesystem types, such as
 100 .IR adfs ,
 101 .IR affs ,
 102 .IR autofs ,
 103 .IR coda ,
 104 .IR coherent ,
 105 .IR cramfs ,
 106 .IR devpts ,
 107 .IR efs ,
 108 .IR ext2 ,
 109 .IR ext3 ,
 110 .IR hfs ,
 111 .IR hpfs ,
 112 .IR iso9660 ,
 113 .IR jfs ,
 114 .IR minix ,
 115 .IR msdos ,
 116 .IR ncpfs ,
 117 .IR nfs ,
 118 .IR ntfs ,
 119 .IR proc ,
 120 .IR qnx4 ,
 121 .IR reiserfs ,
 122 .IR romfs ,
 123 .IR smbfs ,
 124 .IR sysv ,
 125 .IR tmpfs ,
 126 .IR udf ,
 127 .IR ufs ,
 128 .IR umsdos ,
 129 .IR vfat ,
 130 .IR xenix ,
 131 .IR xfs ,
 132 and possibly others. For more details, see
 133 .BR mount (8).
 134 For the filesystems currently supported by the running kernel, see
 135 .IR /proc/filesystems .
 136 An entry
 137 .I swap
 138 denotes a file or partition to be used
 139 for swapping, cf.\&
 140 .BR swapon (8).
 141 An entry
 142 .I ignore
 143 causes the line to be ignored.  This is useful
 144 to show disk partitions which are currently unused.
 145 An entry
 146 .I none
 147 is useful for bind or move mounts.
 148
 149 The fourth field,
 150 .RI ( fs_mntops ),
 151 describes the mount options associated with the filesystem.
 152
 153 It is formatted as a comma separated list of options.  It contains at least
 154 the type of mount plus any additional options appropriate to the filesystem
 155 type.  For documentation on the available options for non-nfs file systems,
 156 see
 157 .BR mount (8).
 158 For documentation on all nfs-specific options have a look at
 159 .BR nfs (5).
 160 Common for all types of file system are the options ``noauto''
 161 (do not mount when "mount -a" is given, e.g., at boot time), ``user''
 162 (allow a user to mount), and ``owner''
 163 (allow device owner to mount), and ``comment''
 164 (e.g., for use by fstab-maintaining programs).
 165 The ``owner'' and ``comment'' options are Linux-specific.
 166 For more details, see
 167 .BR mount (8).
 168
 169 The fifth field,
 170 .RI ( fs_freq ),
 171 is used for these filesystems by the
 172 .BR dump (8)
 173 command to determine which filesystems need to be dumped.  If the fifth
 174 field is not present, a value of zero is returned and
 175 .B dump
 176 will assume that the filesystem does not need to be dumped.
 177
 178 The sixth field,
 179 .RI ( fs_passno ),
 180 is used by the
 181 .BR fsck (8)
 182 program to determine the order in which filesystem checks are done at
 183 reboot time.  The root filesystem should be specified with a
 184 .I fs_passno
 185 of 1, and other filesystems should have a
 186 .I fs_passno
 187 of 2.  Filesystems within a drive will be checked sequentially, but
 188 filesystems on different drives will be checked at the same time to utilize
 189 parallelism available in the hardware.  If the sixth field is not present
 190 or zero, a value of zero is returned and
 191 .B fsck
 192 will assume that the filesystem does not need to be checked.
 193
 194 The proper way to read records from
 195 .B fstab
 196 is to use the routines
 197 .BR getmntent (3).
 198 .SH FILES
 199 .I /etc/fstab
 200 .SH "SEE ALSO"
 201 .BR getmntent (3),
 202 .BR mount (8),
 203 .BR swapon (8),
 204 .BR fs (5),
 205 .BR nfs (5)
 206 .SH HISTORY
 207 The ancestor of this
 208 .B fstab
 209 file format appeared in 4.0BSD.
 210 .\" But without comment convention, and options and vfs_type.
 211 .\" Instead there was a type rw/ro/rq/sw/xx, where xx is the present 'ignore'.
 212 .SH AVAILABILITY
 213 This man page is part of the util-linux-ng package and is available from
 214 ftp://ftp.kernel.org/pub/linux/utils/util-linux-ng/.