MFC:
authorThomas Nikolajsen <thomas@dragonflybsd.org>
Mon, 4 Aug 2008 20:48:01 +0000 (4 20:48 +0000)
committerThomas Nikolajsen <thomas@dragonflybsd.org>
Mon, 4 Aug 2008 20:48:01 +0000 (4 20:48 +0000)
Update fstab.5:
 * Add HAMMER to list of common file systems
 * Remove note that block special files has to be used
 * Xref HAMMER.5 and ffs.5
 * Add a bit of markup
 * s/filesystem/file system/ to get consistent spelling

share/man/man5/fstab.5

index e6a94c7..ef080bd 100644 (file)
 .\"
 .\"     @(#)fstab.5    8.1 (Berkeley) 6/5/93
 .\" $FreeBSD: src/share/man/man5/fstab.5,v 1.11.2.8 2003/02/10 12:21:08 des Exp $
-.\" $DragonFly: src/share/man/man5/fstab.5,v 1.4 2007/07/30 22:11:33 swildner Exp $
+.\" $DragonFly: src/share/man/man5/fstab.5,v 1.4.4.1 2008/08/04 20:48:01 thomas Exp $
 .\"
-.Dd June 5, 1993
+.Dd July 27, 2008
 .Dt FSTAB 5
 .Os
 .Sh NAME
 .Nm fstab
-.Nd static information about the filesystems
+.Nd static information about the file systems
 .Sh SYNOPSIS
 .In fstab.h
 .Sh DESCRIPTION
@@ -50,7 +50,7 @@ systems.
 is only read by programs, and not written;
 it is the duty of the system administrator to properly create
 and maintain this file.
-Each filesystem is described on a separate line;
+Each file system is described on a separate line;
 fields on each line are separated by tabs or spaces.
 The order of records in
 .Nm
@@ -65,48 +65,56 @@ doing their thing.
 .Pp
 The first field,
 .Pq Fa fs_spec ,
-describes the block special device or
-remote filesystem to be mounted.
-For filesystems of type
-.Em ufs ,
-the special file name is the block special file name,
-and not the character special file name.
-If a program needs the character special file name,
-the program must create it by appending a ``r'' after the
-last ``/'' in the special file name.
+describes the special file or
+remote file system to be mounted.
 .Pp
 The second field,
 .Pq Fa fs_file ,
-describes the mount point for the filesystem.
-For swap partitions, this field should be specified as ``none''.
+describes the mount point for the file system.
+For swap partitions, this field should be specified as
+.Dq none .
 .Pp
 The third field,
 .Pq Fa fs_vfstype ,
-describes the type of the filesystem.
-The system can support various filesystem types.
-Only the root, /usr, and /tmp filesystems need be statically
+describes the type of the file system.
+The system can support various file system types.
+Only the root,
+.Pa /usr ,
+and
+.Pa /tmp
+file systems need be statically
 compiled into the kernel;
 everything else will be automatically loaded at mount
 time.  (Exception: the UFS family - FFS, MFS, and LFS cannot
 currently be demand-loaded.)  Some people still prefer to statically
-compile other filesystems as well.
+compile other file systems as well.
+.Pp
+The most common file system types are:
 .Bl -tag -width indent -offset indent
+.It Em HAMMER
+a local
+.Xr HAMMER 5
+file system
 .It Em ufs
 a local
+.Xr ffs 5
 .Ux
-filesystem
+file system
 .It Em mfs
 a local memory-based
 .Ux
-filesystem
+file system
 .It Em nfs
-a Sun Microsystems compatible ``Network File System''
+a Sun Microsystems compatible
+.Dq "Network File System"
 .It Em swap
 a disk partition to be used for swapping
 .It Em msdos
-a DOS compatible filesystem
+a local
+.Xr msdos 5
+DOS compatible file system
 .It Em cd9660
-a CD-ROM filesystem (as per ISO 9660)
+a local CD-ROM file system (as per ISO 9660)
 .\" maybe also say Rock Ridge extensions are handled ?
 .It Em procfs
 a file system for accessing process data
@@ -114,30 +122,30 @@ a file system for accessing process data
 .Pp
 The fourth field,
 .Pq Fa fs_mntops ,
-describes the mount options associated with the filesystem.
+describes the mount options associated with the file system.
 It is formatted as a comma separated list of options.
 It contains at least the type of mount (see
 .Fa fs_type
 below) plus any additional options
-appropriate to the filesystem type.  See the options flag
+appropriate to the file system type.  See the options flag
 .Pq Fl o
 in the
 .Xr mount 8
-page and the filesystem specific page, such as
+page and the file system specific page, such as
 .Xr mount_nfs 8 ,
 for additional options that may be specified.
 .Pp
 If the options ``userquota'' and/or ``groupquota'' are specified,
-the filesystem is automatically processed by the
+the file system is automatically processed by the
 .Xr quotacheck 8
 command, and user and/or group disk quotas are enabled with
 .Xr quotaon 8 .
 By default,
-filesystem quotas are maintained in files named
+file system quotas are maintained in files named
 .Pa quota.user
 and
 .Pa quota.group
-which are located at the root of the associated filesystem.
+which are located at the root of the associated file system.
 These defaults may be overridden by putting an equal sign
 and an alternative absolute pathname following the quota option.
 Thus, if the user quota file for
@@ -149,9 +157,9 @@ this location can be specified as:
 userquota=/var/quotas/tmp.user
 .Ed
 .Pp
-If the option ``noauto'' is specified, the filesystem will not be automatically
+If the option ``noauto'' is specified, the file system will not be automatically
 mounted at system startup.
-This is recommended for all remote filesystems other than NFS,
+This is recommended for all remote file systems other than NFS,
 since only NFS mounts are delayed until after network initialization
 by the
 .Xr rc 8
@@ -166,7 +174,7 @@ field (it is not deleted from the
 field).
 If
 .Fa fs_type
-is ``rw'' or ``ro'' then the filesystem whose name is given in the
+is ``rw'' or ``ro'' then the file system whose name is given in the
 .Fa fs_file
 field is normally mounted read-write or read-only on the
 specified special file.
@@ -188,31 +196,31 @@ This is useful to show disk partitions which are currently unused.
 .Pp
 The fifth field,
 .Pq Fa fs_freq ,
-is used for these filesystems by the
+is used for these file systems by the
 .Xr dump 8
-command to determine which filesystems need to be dumped.
+command to determine which file systems need to be dumped.
 If the fifth field is not present, a value of zero is returned and
 .Nm dump
-will assume that the filesystem does not need to be dumped.
+will assume that the file system does not need to be dumped.
 .Pp
 The sixth field,
 .Pq Fa fs_passno ,
 is used by the
 .Xr fsck 8
-program to determine the order in which filesystem checks are done
+program to determine the order in which file system checks are done
 at reboot time.
-The root filesystem should be specified with a
+The root file system should be specified with a
 .Fa fs_passno
-of 1, and other filesystems should have a
+of 1, and other file systems should have a
 .Fa fs_passno
 of 2.
-Filesystems within a drive will be checked sequentially,
-but filesystems on different drives will be checked at the
+File systems within a drive will be checked sequentially,
+but file systems on different drives will be checked at the
 same time to utilize parallelism available in the hardware.
 If the sixth field is not present or is zero,
 a value of zero is returned and
 .Xr fsck 8
-will assume that the filesystem does not need to be checked.
+will assume that the file system does not need to be checked.
 .Bd -literal
 #define        FSTAB_RW        "rw"    /* read/write device */
 #define        FSTAB_RQ        "rq"    /* read/write with quotas */
@@ -222,7 +230,7 @@ will assume that the filesystem does not need to be checked.
 
 struct fstab {
        char    *fs_spec;       /* block special device name */
-       char    *fs_file;       /* filesystem path prefix */
+       char    *fs_file;       /* file system path prefix */
        char    *fs_vfstype;    /* File system type, ufs, nfs */
        char    *fs_mntops;     /* Mount options ala -o */
        char    *fs_type;       /* FSTAB_* from fs_mntops */
@@ -232,7 +240,7 @@ struct fstab {
 .Ed
 .Pp
 The proper way to read records from
-.Pa fstab
+.Nm
 is to use the routines
 .Xr getfsent 3 ,
 .Xr getfsspec 3 ,
@@ -250,6 +258,7 @@ resides in
 .Sh SEE ALSO
 .Xr getfsent 3 ,
 .Xr getvfsbyname 3 ,
+.Xr HAMMER 5 ,
 .Xr dump 8 ,
 .Xr fsck 8 ,
 .Xr mount 8 ,