* Add missing parameters to usage()

* Add missing parameters to manpage synopsis
* Add missing description of -d flag
* Sort flags descriptions

Reviewed by:	allanjude, kib
Approved by:	allanjude
MFC after:	1 week
Sponsored by:	Rubicon Communications (Netgate)
Differential Revision:	https://reviews.freebsd.org/D9152
This commit is contained in:
Renato Botelho 2017-02-14 21:14:24 +00:00
parent b6eed5e4e0
commit db83b1436a
Notes: svn2git 2020-12-20 02:59:44 +00:00
svn path=/head/; revision=313745
2 changed files with 44 additions and 42 deletions

View File

@ -29,7 +29,7 @@
.\" @(#)fsck.8 8.4 (Berkeley) 5/9/95
.\" $FreeBSD$
.\"
.Dd October 5, 2016
.Dd February 14, 2017
.Dt FSCK_FFS 8
.Os
.Sh NAME
@ -38,7 +38,7 @@
.Nd file system consistency check and interactive repair
.Sh SYNOPSIS
.Nm
.Op Fl BEFfnpRryZ
.Op Fl BCdEFfnpRrSyZ
.Op Fl b Ar block
.Op Fl c Ar level
.Op Fl m Ar mode
@ -149,45 +149,6 @@ If unexpected errors are found,
the file system is marked as needing a foreground check and
.Nm
exits without attempting any further cleaning.
.It Fl E
Clear unallocated blocks, notifying the underlying device that they
are not used and that their contents may be discarded.
This is useful for filesystems which have been mounted on systems
without TRIM support, or with TRIM support disabled, as well as
filesystems which have been copied from one device to another.
.Pp
See the
.Fl E
and
.Fl t
flags of
.Xr newfs 8 ,
and
the
.Fl t
flag of
.Xr tunefs 8 .
.It Fl F
Determine whether the file system needs to be cleaned immediately
in foreground, or if its cleaning can be deferred to background.
To be eligible for background cleaning it must have been running
with soft updates, not have been marked as needing a foreground check,
and be mounted and writable when the background check is to be done.
If these conditions are met, then
.Nm
exits with a zero exit status.
Otherwise it exits with a non-zero exit status.
If the file system is clean,
it will exit with a non-zero exit status so that the clean status
of the file system can be verified and reported during the foreground
checks.
Note that when invoked with the
.Fl F
flag, no cleanups are done.
The only thing that
.Nm
does is to determine whether a foreground or background
check is needed and exit with an appropriate status code.
.It Fl b
Use the block specified immediately after the flag as
the super block for the file system.
@ -243,6 +204,47 @@ first line of output from
This option implies the
.Fl f
flag.
.It Fl d
Enable debugging messages.
.It Fl E
Clear unallocated blocks, notifying the underlying device that they
are not used and that their contents may be discarded.
This is useful for filesystems which have been mounted on systems
without TRIM support, or with TRIM support disabled, as well as
filesystems which have been copied from one device to another.
.Pp
See the
.Fl E
and
.Fl t
flags of
.Xr newfs 8 ,
and
the
.Fl t
flag of
.Xr tunefs 8 .
.It Fl F
Determine whether the file system needs to be cleaned immediately
in foreground, or if its cleaning can be deferred to background.
To be eligible for background cleaning it must have been running
with soft updates, not have been marked as needing a foreground check,
and be mounted and writable when the background check is to be done.
If these conditions are met, then
.Nm
exits with a zero exit status.
Otherwise it exits with a non-zero exit status.
If the file system is clean,
it will exit with a non-zero exit status so that the clean status
of the file system can be verified and reported during the foreground
checks.
Note that when invoked with the
.Fl F
flag, no cleanups are done.
The only thing that
.Nm
does is to determine whether a foreground or background
check is needed and exit with an appropriate status code.
.It Fl f
Force
.Nm

View File

@ -670,7 +670,7 @@ static void
usage(void)
{
(void) fprintf(stderr,
"usage: %s [-BEFfnpry] [-b block] [-c level] [-m mode] filesystem ...\n",
"usage: %s [-BCdEFfnpRrSyZ] [-b block] [-c level] [-m mode] filesystem ...\n",
getprogname());
exit(1);
}