From c372860ddb4a768f7f6c50cd26d60119370d5cd5 Mon Sep 17 00:00:00 2001 From: Benno Schulenberg Date: Sun, 20 Jul 2014 23:15:47 +0200 Subject: docs: bring eight more man pages closer to standard formatting Also, for chcpu, the options -c, -d, -e and -g are mutually exclusive, and for the mode argument the option -p is not optional. For ldattach, use the standard options separator ", " instead of the unusual " | ". And add the missing --version to several of the pages. Besides, improve the wording and the consistency of the spacing. Signed-off-by: Benno Schulenberg --- sys-utils/fsfreeze.8 | 45 ++++++++++++++++++++++----------------------- 1 file changed, 22 insertions(+), 23 deletions(-) (limited to 'sys-utils/fsfreeze.8') diff --git a/sys-utils/fsfreeze.8 b/sys-utils/fsfreeze.8 index f57bbd7d0..364afca1e 100644 --- a/sys-utils/fsfreeze.8 +++ b/sys-utils/fsfreeze.8 @@ -1,7 +1,7 @@ .\" -*- nroff -*- -.TH FSFREEZE 8 "May 2010" "util-linux" "System Administration" +.TH FSFREEZE 8 "July 2014" "util-linux" "System Administration" .SH NAME -fsfreeze \- suspend access to a filesystem (Linux Ext3/4, ReiserFS, JFS, XFS) +fsfreeze \- suspend access to a filesystem (Ext3/4, ReiserFS, JFS, XFS) .SH SYNOPSIS .B fsfreeze .BR \--freeze | \--unfreeze @@ -9,67 +9,66 @@ fsfreeze \- suspend access to a filesystem (Linux Ext3/4, ReiserFS, JFS, XFS) .SH DESCRIPTION .B fsfreeze -suspends and resumes access to an filesystem +suspends or resumes access to a filesystem. .PP .B fsfreeze -halts new access to the filesystem and creates a stable image on disk. +halts any new access to the filesystem and creates a stable image on disk. .B fsfreeze -is intended to be used with hardware RAID devices that support the creation +is intended to be used with hardware RAID devices that support the creation of snapshots. .PP .B fsfreeze is unnecessary for .B device-mapper -devices. The device-mapper (and LVM) -automatically freezes filesystem on the device when a snapshot creation is requested. +devices. The device-mapper (and LVM) automatically freezes a filesystem +on the device when a snapshot creation is requested. For more details see the .BR dmsetup (8) man page. .PP The -.I mount-point +.I mountpoint argument is the pathname of the directory where the filesystem is mounted. The filesystem must be mounted to be frozen (see .BR mount (8)). .PP -Note that access time updates are also suspends if the filesystem is mounted with -the traditional atime semantics (mount option strictatime, for more details see +Note that access-time updates are also suspended if the filesystem is mounted with +the traditional atime behavior (mount option \fBstrictatime\fR, for more details see .BR mount (8)). .SH OPTIONS -.IP "\fB\-h, \-\-help\fP" -Display help text and exit. -.IP "\fB\-f, \-\-freeze\fP" +.TP +.BR \-f , " \-\-freeze" This option requests the specified a filesystem to be frozen from new modifications. When this is selected, all ongoing transactions in the filesystem are allowed to complete, new write system calls are halted, other calls which modify the filesystem are halted, and all dirty data, metadata, and log information are written to disk. Any process attempting to write to the frozen filesystem will block waiting for the filesystem to be unfrozen. - +.sp Note that even after freezing, the on-disk filesystem can contain information on files that are still in the process of unlinking. These files will not be unlinked until the filesystem is unfrozen or a clean mount of the snapshot is complete. -.IP "\fB\-u, \-\-unfreeze\fP +.TP +.BR \-u , " \-\-unfreeze" This option is used to un-freeze the filesystem and allow operations to continue. Any filesystem modifications that were blocked by the freeze are unblocked and allowed to complete. -.IP "\fB\-V, \-\-version\fP" +.TP +.BR \-V , " \-\-version" Display version information and exit. +.TP +.BR \-h , " \-\-help" +Display help text and exit. .SH AUTHOR .PP Written by Hajime Taira. .SH NOTES .PP -This man page based on xfs_freeze. -One of -.B \-f -or -.B \-u -must be supplied to -.BR fsfreeze . +This man page is based on +.BR xfs_freeze (8). .SH SEE ALSO .BR mount (8) .SH AVAILABILITY -- cgit v1.2.3-55-g7522