Return-Path: util-linux-owner@vger.kernel.org Received: from mta04.eastlink.ca ([24.224.136.10]:58549 "EHLO mta04.eastlink.ca" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751601AbbBWLKh (ORCPT ); Mon, 23 Feb 2015 06:10:37 -0500 Received: from cmgw05.eastlink.ca ([71.7.199.171]) by mta04.eastlink.ca (Oracle Communications Messaging Exchange Server 7u4-21.01 64bit (built Feb 16 2011)) with ESMTP id <0NK800D791EBTD50@mta04.eastlink.ca> for util-linux@vger.kernel.org; Mon, 23 Feb 2015 07:10:35 -0400 (AST) Received: from tesla ([10.0.0.17]) by llama.cordes.ca with esmtp (Exim 3.36 #1 (Debian)) id 1YPquI-0003MN-00 for ; Mon, 23 Feb 2015 07:10:34 -0400 From: Peter Cordes To: util-linux@vger.kernel.org Subject: [PATCH] docs: fstab(5) grammar / English fixes, and some other updates Date: Mon, 23 Feb 2015 07:10:34 -0400 Message-id: <1424689834-29236-1-git-send-email-peter@cordes.ca> Sender: util-linux-owner@vger.kernel.org List-ID: I proofread the whole thing. I fixed everything that I thought could use improvement. various grammar fixes (commas, word order, etc.). Added an example line. Reworded a couple things to hopefully make it clear to someone that didn't already know about fstab. Expanded on a couple things. Tightened up the wording in some other places to get the point across faster and in less space. Updated the date. Signed-off-by: Peter Cordes --- sys-utils/fstab.5 | 85 +++++++++++++++++++++++++++++++------------------------ 1 file changed, 48 insertions(+), 37 deletions(-) diff --git a/sys-utils/fstab.5 b/sys-utils/fstab.5 index 9287519..4f5369c 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,12 +39,12 @@ 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 +spaces. Lines starting with '#' are comments. Blank lines are ignored. The order of records in .B fstab is important because @@ -56,27 +56,38 @@ sequentially iterate through .B fstab doing their thing. +This is a typical example of an +.B fstab +entry: +.sp 1 +LABEL=t-home2 /home ext4 defaults,auto_da_alloc 0 2 + .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. +Instead of a device name, LABEL=