Fix various man pages and usage message

Thanks to pete@lyptonyx for doing a close pass editing of e2fsprogs's
man pages.

Signed-off-by: Theodore Ts'o <tytso@mit.edu>
debian
Theodore Ts'o 2016-05-08 22:12:41 -04:00
parent 97d7e2fdb2
commit bc8f1ae523
9 changed files with 63 additions and 24 deletions

View File

@ -34,6 +34,10 @@ e2fsck \- check a Linux ext2/ext3/ext4 file system
.B \-E
.I extended_options
]
[
.B \-z
.I undo_file
]
.I device
.SH DESCRIPTION
.B e2fsck

View File

@ -74,8 +74,7 @@ int journal_enable_debug = -1;
static void usage(e2fsck_t ctx)
{
fprintf(stderr,
_("Usage: %s [-panyrcdfvtDFV] [-b superblock] [-B blocksize]\n"
"\t\t[-I inode_buffer_blocks] [-P process_inode_size]\n"
_("Usage: %s [-panyrcdfktvDFV] [-b superblock] [-B blocksize]\n"
"\t\t[-l|-L bad_blocks_file] [-C fd] [-j external_journal]\n"
"\t\t[-E extended-options] [-z undo_file] device\n"),
ctx->program_name);

View File

@ -39,6 +39,7 @@ synchronous directory updates (D),
extent format (e),
immutable (i),
data journalling (j),
project hierarchy (P),
secure deletion (s),
synchronous updates (S),
no tail-merging (t),
@ -153,6 +154,14 @@ stored inline, within the inode itself. It may not be set or reset using
although it can be displayed by
.BR lsattr (1).
.PP
A directory with the 'P' attribute set will enforce a hierarchical
structure for project id's. This means that files and directory created
in the directory will inhert the project id of the directory, rename
operations are constrained so when a file or directory is moved into
another directory, that the project id's much match. In addition, a
hard link to file can only be created when the project id for the file
and the destination directory match.
.PP
When a file with the 's' attribute set is deleted, its blocks are zeroed
and written back to the disk. Note: please make sure to read the bugs
and limitations section at the end of this document.

View File

@ -11,6 +11,9 @@ e2undo \- Replay an undo log for an ext2/ext3/ext4 filesystem
.B \-f
]
[
.B \-h
]
[
.B \-n
]
[
@ -37,6 +40,9 @@ will refuse to apply the undo log as a safety mechanism. The
.B \-f
option disables this safety mechanism.
.TP
.B \-h
Display a usage message.
.TP
.B \-n
Dry-run; do not actually write blocks back to the filesystem.
.TP

View File

@ -2,19 +2,13 @@
.SH NAME
e4crypt \- ext4 filesystem encryption utility
.SH SYNOPSIS
.B e4crypt \-a \-S
.I salt
[
.B \-k
.I keyring
]
[
.I path\fR ...
]
.B e4crypt add_key -S \fR[\fB -k \fIkeyring\fR ] [\fB-v\fR] [\fB-q\fR] [ \fI path\fR ... ]
.br
.B e4crypt \-s
.I policy
.I path\fR ...
.B e4crypt new_session
.br
.B e4crypt get_policy \fIpath\fR ...
.br
.B e4crypt set_policy \fIpolicy path\fR ...
.SH DESCRIPTION
.B e4crypt
performs encryption management for ext4 file systems.
@ -29,14 +23,17 @@ If one or more directory paths are specified, e4crypt will try to
set the policy of those directories to use the key just entered by
the user.
.TP
.B e4crypt get_policy \fIpath\fR ...
Print the policy for the directories specified on the command line.
.TP
.B e4crypt new_session
Give the invoking process (typically a shell) a new session keyring,
discarding its old session keyring.
.TP
.B set_policy -s \fIpolicy path\fR ...
.B e4crypt set_policy \fIpolicy path\fR ...
Sets the policy for the directories specified on the command line.
All directories must be empty to set the policy; if the directory
already has a policy established, e4crypt will validate that it the
already has a policy established, e4crypt will validate that the
policy matches what was specified. A policy is an encryption key
identifier consisting of 16 hexadecimal characters.
.SH AUTHOR

View File

@ -5,7 +5,7 @@ lsattr \- list file attributes on a Linux second extended file system
.SH SYNOPSIS
.B lsattr
[
.B \-RVadpv
.B \-RVadlpv
]
[
.I files...
@ -29,11 +29,15 @@ List all files in directories, including files that start with `.'.
.B \-d
List directories like other files, rather than listing their contents.
.TP
.B \-v
List the file's version/generation number.
.B \-l
Print the options using a long names instead of a single
character abbreviation.
.TP
.B \-p
List the file's project number.
.TP
.B \-v
List the file's version/generation number.
.SH AUTHOR
.B lsattr
was written by Remy Card <Remy.Card@linux.org>. It is currently being

View File

@ -379,11 +379,14 @@ as default.
Do not attempt to discard blocks at mkfs time.
.TP
.BI quotatype
Specify which quota type ('usr' or 'grp') is to be
initialized. This option has effect only if the
Specify the which quota types (usrquota, grpquota, prjquota) which
should be enabled in the created file system. The argument of this
extended option should be a colon separated list. This option has
effect only if the
.B quota
feature is set. Without this extended option, the default
behavior is to initialize both user and group quotas.
feature is set. The default quota types to be initialized if this
option is not specified is both user and group quotas. If the project
feature is enabled that project quotas will be initialized as well.
.RE
.TP
.BI \-f " fragment-size"

View File

@ -26,6 +26,10 @@ tune2fs \- adjust tunable filesystem parameters on ext2/ext3/ext4 filesystems
.I interval-between-checks
]
[
.B \-I
.I new_inode_size
]
[
.B \-j
]
[
@ -41,6 +45,10 @@ tune2fs \- adjust tunable filesystem parameters on ext2/ext3/ext4 filesystems
.RI [^]mount-options [,...]
]
[
.B \-p
.I mmp_update_interval
]
[
.B \-r
.I reserved-blocks-count
]
@ -291,6 +299,15 @@ checking of the filesystem. Failure to do so may lead to filesystem
corruption (due to bad disks, cables, memory, or kernel bugs) going
unnoticed, ultimately resulting in data loss or corruption.
.TP
.B \-I
Change the inode size used by the file system. This requires rewriting
the inode table, so it requires that the file system is checked for
consistency first using
.BR e2fsck (8).
This operation can also take a while and the file system can be
corrupted and data lost if it is interrupted while in the middle of
converting the file system.
.TP
.B \-j
Add an ext3 journal to the filesystem. If the
.B \-J

View File

@ -131,7 +131,7 @@ int journal_enable_debug = -1;
static void usage(void)
{
fprintf(stderr,
_("Usage: %s [-c max_mounts_count] [-e errors_behavior] "
_("Usage: %s [-c max_mounts_count] [-e errors_behavior] [-f] "
"[-g group]\n"
"\t[-i interval[d|m|w]] [-j] [-J journal_options] [-l]\n"
"\t[-m reserved_blocks_percent] [-o [^]mount_options[,...]]\n"