From 14160b7bd08f54f977993cae4c4ed2cbfcb9d1ae Mon Sep 17 00:00:00 2001 From: Peter Cordes Date: Tue, 24 Feb 2015 22:40:41 -0400 Subject: docs: fstab(5) grammar / English fixes, and some other updates I proofread the whole thing. I fixed everything that I thought could use improvement. various grammar and man page style-guide fixes (commas, word order, etc.). Reworded a couple things to hopefully make it clear to someone that didn't already know about fstab. Re-ordered the intro paragraphs for easier skimming. And added an example line. Expanded on a couple things other things. Tightened up the wording in some other places to get the point across faster and in less space. Thanks to Benno Schulenberg for several improvements. Signed-off-by: Peter Cordes --- sys-utils/fstab.5 | 99 ++++++++++++++++++++++++++++++++----------------------- 1 file changed, 58 insertions(+), 41 deletions(-) (limited to 'sys-utils/fstab.5') diff --git a/sys-utils/fstab.5 b/sys-utils/fstab.5 index 9287519dc..2f20fed06 100644 --- a/sys-utils/fstab.5 +++ b/sys-utils/fstab.5 @@ -31,7 +31,7 @@ .\" .\" @(#)fstab.5 6.5 (Berkeley) 5/10/91 .\" -.TH FSTAB 5 "August 2010" "util-linux" "File Formats" +.TH FSTAB 5 "February 2015" "util-linux" "File Formats" .SH NAME fstab \- static information about the filesystems .SH SYNOPSIS @@ -39,13 +39,10 @@ fstab \- static information about the filesystems .SH DESCRIPTION The file .B fstab -contains descriptive information about the various file systems. +contains descriptive information about the filesystems the system can mount. .B fstab 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; fields on each line are separated by tabs or -spaces. Lines starting with '#' are comments, blank lines are ignored. The -order of records in +administrator to properly create and maintain this file. The order of records in .B fstab is important because .BR fsck (8), @@ -56,27 +53,46 @@ sequentially iterate through .B fstab doing their thing. +Each filesystem is described on a separate line. +Fields on each line are separated by tabs or spaces. +Lines starting with '#' are comments. Blank lines are ignored. +.PP +The following is a typical example of an +.B fstab +entry: +.sp +.RS 7 +LABEL=t-home2 /home ext4 defaults,auto_da_alloc 0 2 +.RE + .B The first field .RI ( fs_spec ). .RS This field describes the block special device or remote filesystem to be mounted. .LP -For ordinary mounts it will hold (a link to) a block special +For ordinary mounts, it will hold (a link to) a block special device node (as created by .BR mknod (8)) for the device to be mounted, like `/dev/cdrom' or `/dev/sdb7'. -For NFS mounts one will have :, e.g., `knuth.aeb.nl:/'. -For procfs, use `proc'. +For NFS mounts, this field is :, e.g., `knuth.aeb.nl:/'. +For filesystems with no storage, any string can be used, and will show up in +.BR df (1) +output, for example. Typical usage is `proc' for procfs; `mem', `none', +or `tmpfs' for tmpfs. Other special filesystems, like udev and sysfs, +are typically not listed in +.BR fstab . .LP -Instead of giving the device explicitly, one may indicate -the filesystem that is to be mounted by its UUID or -LABEL (cf. -.BR e2label (8) +LABEL=