Commit Graph

30 Commits

Author SHA1 Message Date
Michael Kerrisk (man-pages) a87f49f662 Manual pages: use the term "exit status"
The manual pages currently use a multitude of terms--"exit code",
"error code", "return code", "exit code", and so on--when what
is always meant is "exit status" (the POSIX term). This patch fixes
as many of these erroneous terms as I could find.

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2020-05-20 12:56:52 +02:00
Bjarni Ingi Gislason eb02489380 man pages: Add a comma after "e.g." and "i.e."
Add a comma (,) after "e.g." and "i.e.", or use English words
(man-pages(7) [package "manpages"]).

  Abbreviation points should be protected (usually with the
non-printing, zero width character '\&') from being interpreted as an
end of sentence, if they are not, and that independent of their current
place on the line.

  This is important when typing, as one does not usually know in
advance when the editor jumps to a new line.

Signed-off-by: Bjarni Ingi Gislason <bjarniig@rhi.hi.is>
2019-12-17 12:32:43 +01:00
Sébastien Helleu d673b74e9d docs: replace FTP by HTTPS in kernel.org URLs
The links to ftp://ftp.kernel.org/ are replaced by
https://www.kernel.org/.

Signed-off-by: Karel Zak <kzak@redhat.com>
2016-12-19 11:22:26 +01:00
Mike Frysinger 07b5156790 mkfs: drop hardcoded search path
Rather than maintain a hardcoded search path for looking up tools and
override the user's PATH env setting, respect whatever the user has.
This matches the convention of just about every other tool out there.

It might break on systems that don't have /sbin in their PATH and they
try to run /sbin/mkfs directly, but so be it.

Signed-off-by: Mike Frysinger <vapier@gentoo.org>
2015-04-27 10:28:44 +02:00
Benno Schulenberg 3a60b1c26b docs: remove obsolete and unneeded comments from man-page files
Transform some of them into copyright lines.
Also fix three header lines and snip some trailing whitespace.

Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
2015-01-12 11:03:26 +01:00
Benno Schulenberg f49ccec212 docs: don't use bold or italics for "[option]" in synopsis of man pages
As per the convention shown in Documentation/howto-man-page.txt.
Also make a few other tiny adjustments along the way.

Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
2014-12-19 09:57:23 +01:00
Benno Schulenberg 556c9c4842 various: erase all traces of the long-obsolete xiafs
The xiafs filesystem was removed from the kernel fifteen years ago,
and any kernel that contained it reached end of life ten years ago.
It's time to stop mentioning it in the mount man page and elsewhere.

Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
2014-07-28 11:16:57 +02:00
Bjarni Ingi Gislason 920d44f5fd mkfs: Some typographical changes to the manual
- changed to \- if it means an option

  A full stop (.), that begins or ends a string, protected with \&

  No line adjustment used for section "SEE ALSO" (.na/.ad)

Signed-off-by: Karel Zak <kzak@redhat.com>
2014-04-07 12:30:17 +02:00
Karel Zak 4459245fa3 mkfs: mark this wrapper as DEPRECATED
Theodore Ts'o:

 I'll add that I've never been convinced that the mkfs front end is all
 that useful.  It's probably better for people to explicitly run
 /sbin/mkfs.xfs, /sbin/mkfs.ext4, etc.., so you don't have to worry
 about which options get passed down to the file system specific mkfs
 program, and which ones are interpreted by /sbin/mkfs --- and I don't
 believe /sbin/mkfs adds enough (err, any?) value that using
 "/sbin/mkfs -t xxx" vs "/sbin/mkfs.xxx" makes any sense whatsoever.

... and I absolutely agree.

Reported-by: Theodore Ts'o <tytso@mit.edu>
Signed-off-by: Karel Zak <kzak@redhat.com>
2014-02-21 12:04:18 +01:00
Phillip Susi b5ab5bec73 fix mkfs --verbose and man page
mkfs did not actually accept the long form --verbose option.
Also the man page seemed to indicate that version/verbose/help
options were passed to the filesystem specific utility when this
is not the case.

Signed-off-by: Phillip Susi <psusi@ubuntu.com>
2014-02-10 18:58:39 +01:00
Benno Schulenberg b4362b6f84 docs: standardize the phrases for --help and --version in all man pages
Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
2013-10-15 10:28:30 +02:00
Karel Zak 8d8ea18ea7 docs: remove repeated words
Signed-off-by: Karel Zak <kzak@redhat.com>
2013-04-05 13:35:30 +02:00
Benno Schulenberg 4ec32f6a89 mkfs: indicate that specifying fs-type and fs-options are independent
Also standardize and improve the help text, and slice it into strips
for ease of later translation maintenance.

Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
2013-01-30 15:23:59 +01:00
Benno Schulenberg 449a215fc5 docs: tweak the formatting and wording of several disk-utils man pages
Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
2011-08-29 11:24:47 +02:00
Benno Schulenberg 232dc924c4 docs: uniformize the header and footer lines in man pages
Use dates without the day, use the full month name, put "util-linux" in
the lower left corner, and "User Commands" or "System Administration"
at the top center.

Also improve here and there the one-line program description.

Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
2011-08-22 10:39:21 +02:00
Benno Schulenberg c181c31dd9 mkfs: fix small formatting issues in man page
Also spell "filesystem" consistently as one word -- this makes
things clearer when the word is used as an adjective.

Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
2011-08-08 11:58:55 +02:00
Sami Kerola 63ab95247a docs: add long options to mkfs.8
Two switches -c and -l where removed from manual, they might be
supported by the real file system builder but not necessarily.
The -v option was also corrected to be -V.

Signed-off-by: Sami Kerola <kerolasa@iki.fi>
2011-06-29 13:36:52 +02:00
Karel Zak 601d12fb10 rename util-linux-ng back to util-linux
Signed-off-by: Karel Zak <kzak@redhat.com>
2010-11-30 11:41:59 +01:00
Paul Menzel 26b4e7a5ef mkfs: add `mkfs.ext4` to section SEE ALSO of `mkfs.8`.
Signed-off-by: Paul Menzel <paulepanter@users.sourceforge.net>
2010-07-29 17:45:57 +02:00
Peter Breitenlohner 039f35318b mkfs.8: incomplete sentence and formatting
Signed-off-by: Peter Breitenlohner <peb@mppmu.mpg.de>
2009-08-17 12:11:04 +02:00
Karel Zak a512390d92 mkfs: remove nonsense from man page
Signed-off-by: Karel Zak <kzak@redhat.com>
2007-08-02 14:23:38 +02:00
Karel Zak 86d62711a9 man pages: add "AVAILABILITY" section
Signed-off-by: Karel Zak <kzak@redhat.com>
2007-07-03 01:17:04 +02:00
Karel Zak 48d7b13a1e Imported from util-linux-2.13-pre1 tarball. 2006-12-07 00:26:54 +01:00
Karel Zak 63cccae468 Imported from util-linux-2.11t tarball. 2006-12-07 00:25:58 +01:00
Karel Zak c07ebfa1e0 Imported from util-linux-2.11b tarball. 2006-12-07 00:25:46 +01:00
Karel Zak 7eda085c41 Imported from util-linux-2.9v tarball. 2006-12-07 00:25:39 +01:00
Karel Zak 5c36a0eb7c Imported from util-linux-2.9i tarball. 2006-12-07 00:25:37 +01:00
Karel Zak 2b6fc908bc Imported from util-linux-2.8 tarball. 2006-12-07 00:25:35 +01:00
Karel Zak 726f69e29c Imported from util-linux-2.5 tarball. 2006-12-07 00:25:33 +01:00
Karel Zak 6dbe3af945 Imported from util-linux-2.2 tarball. 2006-12-07 00:25:32 +01:00