Hi,
Attached bunch of patches correct some small mistakes in some
help texts and man pages, and additionally make several small
improvements in wording and formatting. They also slice up some
help texts into small chunks, to make things easier to handle for
translators.
In the source tree there are two mount.c files: mount/mount.c
and libmount/samples/mount.c. Is the latter a future replacement
of the first? Or is it a version that can already be used instead of
the former one? If both are valid versions, then the sixth patch
should not be applied and the seventh yes. If the mount.c in
libmount/ is just sample code or a future replacement, then
please apply the sixth patch (although you may want to change
the actual mechanism of the exclusion).
Regards,
Benno
--
http://www.fastmail.fm - Faster than the air-speed velocity of an
unladen european swallow
From 7963665645c2c94f67c0dd5114e575bbc73b3035 Mon Sep 17 00:00:00 2001
From: Benno Schulenberg <bensberg@xxxxxxxxxxxxx>
Date: Sat, 13 Aug 2011 17:15:42 +0200
Subject: [PATCH 01/11] fsck: in usage() unmark type as optional for the -t option
Also fix "specity" typo, spell "filesystem" consistently as one word,
swap the wording of one phrase, and use some semicolons for clarity.
Signed-off-by: Benno Schulenberg <bensberg@xxxxxxxxxxxxx>
---
fsck/fsck.c | 14 +++++++-------
1 files changed, 7 insertions(+), 7 deletions(-)
diff --git a/fsck/fsck.c b/fsck/fsck.c
index 88a67c8..387b5b9 100644
--- a/fsck/fsck.c
+++ b/fsck/fsck.c
@@ -1215,17 +1215,17 @@ static void __attribute__((__noreturn__)) usage(void)
program_invocation_short_name);
puts(_( "\nOptions:\n"
- " -A check all file systems\n"
- " -R skip root, useful only with -A\n"
+ " -A check all filesystems\n"
+ " -R skip root filesystem; useful only with `-A'\n"
" -M do not check mounted filesystems\n"
- " -t [type] specity file system types to be checked\n"
- " type is allowed to be comma-separated list\n"
- " -P check file systems in parallel, including root\n"
+ " -t type specify filesystem types to be checked;\n"
+ " type is allowed to be comma-separated list\n"
+ " -P check filesystems in parallel, including root\n"
" -s serialize fsck operations\n"
- " -l use flock to lock device\n"
+ " -l lock the device using flock()\n"
" -N do not execute, just show what would be done\n"
" -T do not show the title on startup\n"
- " -C [fd] display progress bar, file descriptor is for GUIs\n"
+ " -C [fd] display progress bar; file descriptor is for GUIs\n"
" -V explain what is being done\n"
" -? display this help and exit\n\n"
"See fsck.* commands for fs-options."));
--
1.7.0.4
From 7106f9fa136cf527d2186d0584d591ee878b875b Mon Sep 17 00:00:00 2001
From: Benno Schulenberg <bensberg@xxxxxxxxxxxxx>
Date: Sat, 13 Aug 2011 17:53:09 +0200
Subject: [PATCH 02/11] fsck: in man page say that "options take arguments", not vice versa
Also spell "filesystem" consistently as a single word, improve some
wordings here and there, and fix a few formatting and spacing issues.
Signed-off-by: Benno Schulenberg <bensberg@xxxxxxxxxxxxx>
---
fsck/fsck.8 | 103 ++++++++++++++++++++++++++++------------------------------
1 files changed, 50 insertions(+), 53 deletions(-)
diff --git a/fsck/fsck.8 b/fsck/fsck.8
index 40fe625..07eaaea 100644
--- a/fsck/fsck.8
+++ b/fsck/fsck.8
@@ -4,7 +4,7 @@
.\"
.TH FSCK 8 "February 2009" "Linux" "MAINTENANCE COMMANDS"
.SH NAME
-fsck \- check and repair a Linux file system
+fsck \- check and repair a Linux filesystem
.SH SYNOPSIS
.B fsck
.RB [ \-lsAVRTMNP ]
@@ -17,7 +17,7 @@ fsck \- check and repair a Linux file system
.RI [ fs-specific-options ]
.SH DESCRIPTION
.B fsck
-is used to check and optionally repair one or more Linux file systems.
+is used to check and optionally repair one or more Linux filesystems.
.I filesys
can be a device name (e.g.
.IR /dev/hdc1 ", " /dev/sdb2 ),
@@ -28,8 +28,7 @@ UUID=8868abf6-88c5-4a83-98b8-bfc24057f7bd or LABEL=root).
Normally, the
.B fsck
program will try to handle filesystems on different physical disk drives
-in parallel to reduce the total amount of time needed to check all of the
-filesystems.
+in parallel to reduce the total amount of time needed to check all of them.
.PP
If no filesystems are specified on the command line, and the
.B \-A
@@ -47,11 +46,11 @@ is the sum of the following conditions:
.br
\ 0\ \-\ No errors
.br
-\ 1\ \-\ File system errors corrected
+\ 1\ \-\ Filesystem errors corrected
.br
\ 2\ \-\ System should be rebooted
.br
-\ 4\ \-\ File system errors left uncorrected
+\ 4\ \-\ Filesystem errors left uncorrected
.br
\ 8\ \-\ Operational error
.br
@@ -59,36 +58,36 @@ is the sum of the following conditions:
.br
\ 32\ \-\ Fsck canceled by user request
.br
-\ 128\ \-\ Shared library error
+\ 128\ \-\ Shared-library error
.br
-The exit code returned when multiple file systems are checked
+The exit code returned when multiple filesystems are checked
is the bit-wise OR of the exit codes for each
-file system that is checked.
+filesystem that is checked.
.PP
In actuality,
.B fsck
-is simply a front-end for the various file system checkers
-(\fBfsck\fR.\fIfstype\fR) available under Linux. The file
-system-specific checker is searched for in
+is simply a front-end for the various filesystem checkers
+(\fBfsck\fR.\fIfstype\fR) available under Linux. The
+filesystem-specific checker is searched for in
.I /sbin
first, then in
.I /etc/fs
and
.IR /etc ,
and finally in the directories listed in the PATH environment
-variable. Please see the file system-specific checker manual pages for
+variable. Please see the filesystem-specific checker manual pages for
further details.
.SH OPTIONS
.TP
.B \-l
-Lock whole-disk device by exclusive
+Lock the whole-disk device by an exclusive
.BR flock (2).
-This option can be used with one device only (e.g. -A and -l are mutually
-exclusive). This option is recommended when more
+This option can be used with one device only (this means that \fB-A\fR and
+\fB-l\fR are mutually exclusive). This option is recommended when more
.B fsck (8)
-instances are executed in the same time. The option is ignored when used for
-multiple devices or for non-rotating disk. The fsck does not lock underlying
-devices if executed to check stacked devices (e.g. MD or DM) -- this feature is
+instances are executed in the same time. The option is ignored when used for
+multiple devices or for non-rotating disks. \fBfsck\fR does not lock underlying
+devices when executed to check stacked devices (e.g. MD or DM) -- this feature is
not implemented yet.
.TP
.B \-s
@@ -108,7 +107,7 @@ option, if you wish for errors to be corrected automatically, or the
option if you do not.)
.TP
.BI \-t " fslist"
-Specifies the type(s) of file system to be checked. When the
+Specifies the type(s) of filesystem to be checked. When the
.B \-A
flag is specified, only filesystems that match
.I fslist
@@ -122,12 +121,9 @@ or
.RB ' ! ',
which requests that only those filesystems not listed in
.I fslist
-will be checked. If all of the filesystems in
-.I fslist
-are not prefixed by a negation operator, then only those filesystems
-listed
-in
+will be checked. If none of the filesystems in
.I fslist
+is prefixed by a negation operator, then only those listed filesystems
will be checked.
.sp
Options specifiers may be included in the comma-separated
@@ -180,16 +176,16 @@ given as an argument to the
option,
.B fsck
will use the specified filesystem type. If this type is not
-available, then the default file system type (currently ext2) is used.
+available, then the default filesystem type (currently ext2) is used.
.TP
.B \-A
Walk through the
.I /etc/fstab
-file and try to check all file systems in one run. This option is
+file and try to check all filesystems in one run. This option is
typically used from the
.I /etc/rc
system initialization file, instead of multiple commands for checking
-a single file system.
+a single filesystem.
.sp
The root filesystem will be checked first unless the
.B \-P
@@ -213,7 +209,7 @@ multiple filesystem checks on the same physical disk.
.sp
.B fsck
does not check stacked devices (RAIDs, dm-crypt, ...) in parallel with any other
-device. See below for FSCK_FORCE_ALL_PARALLEL setting. The /sys filesystem is
+device. See below for FSCK_FORCE_ALL_PARALLEL setting. The /sys filesystem is
used to detemine dependencies between devices.
.sp
Hence, a very common configuration in
@@ -234,9 +230,9 @@ excessive paging is a concern.
.sp
.B fsck
normally does not check whether the device actually exists before
-calling a file system specific checker. Therefore non-existing
-devices may cause the system to enter file system repair mode during
-boot if the filesystem specific checker returns a fatal error. The
+calling a filesystem specific checker. Therefore non-existing
+devices may cause the system to enter filesystem repair mode during
+boot if the filesystem specific checker returns a fatal error. The
.B /etc/fstab
mount option
.B nofail
@@ -244,7 +240,7 @@ may be used to have
.B fsck
skip non-existing devices.
.B fsck
-also skips non-existing devices that have the special file system type
+also skips non-existing devices that have the special filesystem type
.B auto
.
.TP
@@ -275,15 +271,16 @@ for those sysadmins who don't want to repartition the root
filesystem to be small and compact (which is really the right solution).
.TP
.B \-R
-When checking all file systems with the
+When checking all filesystems with the
.B \-A
-flag, skip the root file system (in case it's already mounted read-write).
+flag, skip the root filesystem. (This is useful in case the root
+filesystem has already been mounted read-write.)
.TP
.B \-T
Don't show the title on startup.
.TP
.B \-V
-Produce verbose output, including all file system-specific commands
+Produce verbose output, including all filesystem-specific commands
that are executed.
.TP
.B fs-specific-options
@@ -294,20 +291,20 @@ are passed to the filesystem-specific checker. These arguments
not take arguments, as there is no
way for
.B fsck
-to be able to properly guess which arguments take options and which
+to be able to properly guess which options take arguments and which
don't.
.IP
Options and arguments which follow the
.B \-\-
-are treated as file system-specific options to be passed to the
-file system-specific checker.
+are treated as filesystem-specific options to be passed to the
+filesystem-specific checker.
.IP
Please note that fsck is not
designed to pass arbitrarily complicated options to filesystem-specific
checkers. If you're doing something complicated, please just
execute the filesystem-specific checker directly. If you pass
.B fsck
-some horribly complicated option and arguments, and it doesn't do
+some horribly complicated options and arguments, and it doesn't do
what you expect,
.B don't bother reporting it as a bug.
You're almost certainly doing something that you shouldn't be doing
@@ -317,20 +314,20 @@ with
Options to different filesystem-specific fsck's are not standardized.
If in doubt, please consult the man pages of the filesystem-specific
checker. Although not guaranteed, the following options are supported
-by most file system checkers:
+by most filesystem checkers:
.TP
.B \-a
-Automatically repair the file system without any questions (use
+Automatically repair the filesystem without any questions (use
this option with caution). Note that
.BR e2fsck (8)
supports
.B \-a
-for backwards compatibility only. This option is mapped to
+for backward compatibility only. This option is mapped to
.BR e2fsck 's
.B \-p
option which is safe to use, unlike the
.B \-a
-option that some file system checkers support.
+option that some filesystem checkers support.
.TP
.B \-n
For some filesystem-specific checkers, the
@@ -350,7 +347,7 @@ Interactively repair the filesystem (ask for confirmations). Note: It
is generally a bad idea to use this option if multiple fsck's are being
run in parallel. Also note that this is
.BR e2fsck 's
-default behavior; it supports this option for backwards compatibility
+default behavior; it supports this option for backward compatibility
reasons only.
.TP
.B \-y
@@ -364,7 +361,7 @@ all filesystem-specific checkers implement this option. In particular
.BR fsck.minix (8)
and
.BR fsck.cramfs (8)
-does not support the
+do not support the
.B -y
option as of this writing.
.SH AUTHOR
@@ -382,32 +379,32 @@ program's behavior is affected by the following environment variables:
.B FSCK_FORCE_ALL_PARALLEL
If this environment variable is set,
.B fsck
-will attempt to run all of the specified filesystems in parallel, regardless of
+will attempt to check all of the specified filesystems in parallel, regardless of
whether the filesystems appear to be on the same device. (This is useful for
RAID systems or high-end storage systems such as those sold by companies such
-as IBM or EMC.) Note that the fs_passno value is still used.
+as IBM or EMC.) Note that the fs_passno value is still used.
.TP
.B FSCK_MAX_INST
-This environment variable will limit the maximum number of file system
+This environment variable will limit the maximum number of filesystem
checkers that can be running at one time. This allows configurations
which have a large number of disks to avoid
.B fsck
-starting too many file system checkers at once, which might overload
+starting too many filesystem checkers at once, which might overload
CPU and memory resources available on the system. If this value is
zero, then an unlimited number of processes can be spawned. This is
currently the default, but future versions of
.B fsck
-may attempt to automatically determine how many file system checks can
+may attempt to automatically determine how many filesystem checks can
be run based on gathering accounting data from the operating system.
.TP
.B PATH
The
.B PATH
-environment variable is used to find file system checkers. A set of
+environment variable is used to find filesystem checkers. A set of
system directories are searched first:
.BR /sbin ,
.BR /sbin/fs.d ,
-.BR /sbin/fs ,
+.BR /sbin/fs ,
.BR /etc/fs ,
and
.BR /etc .
--
1.7.0.4
From f713493ce0219119aed2f180e4f9bf7b2233b8c1 Mon Sep 17 00:00:00 2001
From: Benno Schulenberg <bensberg@xxxxxxxxxxxxx>
Date: Sat, 13 Aug 2011 20:11:21 +0200
Subject: [PATCH 03/11] getopt: do not bundle help text lines into a single unwieldy chunk
This undoes part of commit 283f8f0256655b73071290b92c58d998e883260a.
Help text lines are best gettextized separately, or in small chunks
of three to five lines, which are easily managed by translators.
Bundling text lines when nothing in those texts changed is discarding
translators' work unnecessarily.
Signed-off-by: Benno Schulenberg <bensberg@xxxxxxxxxxxxx>
---
getopt/getopt.c | 26 +++++++++++++-------------
1 files changed, 13 insertions(+), 13 deletions(-)
diff --git a/getopt/getopt.c b/getopt/getopt.c
index a211bcb..8da3178 100644
--- a/getopt/getopt.c
+++ b/getopt/getopt.c
@@ -313,20 +313,20 @@ static void __attribute__ ((__noreturn__)) print_help(void)
{
fprintf(stderr, _("Usage: %1$s optstring parameters\n"
" %1$s [options] [--] optstring parameters\n"
- " %1$s [options] -o|--options optstring [options] [--] parameters\n"
- "\nOptions:\n"
- " -a, --alternative Allow long options starting with single -\n"
- " -h, --help This small usage guide\n"
- " -l, --longoptions=longopts Long options to be recognized\n"
- " -n, --name=progname The name under which errors are reported\n"
- " -o, --options=optstring Short options to be recognized\n"
- " -q, --quiet Disable error reporting by getopt(3)\n"
- " -Q, --quiet-output No normal output\n"
- " -s, --shell=shell Set shell quoting conventions\n"
- " -T, --test Test for getopt(1) version\n"
- " -u, --unquote Do not quote the output\n"
- " -V, --version Output version information\n\n"),
+ " %1$s [options] -o|--options optstring [options] [--] parameters\n",
program_invocation_short_name);
+ fputs(_("\nOptions:\n"),stderr);
+ fputs(_(" -a, --alternative Allow long options starting with single -\n"),stderr);
+ fputs(_(" -h, --help This small usage guide\n"),stderr);
+ fputs(_(" -l, --longoptions=longopts Long options to be recognized\n"),stderr);
+ fputs(_(" -n, --name=progname The name under which errors are reported\n"),stderr);
+ fputs(_(" -o, --options=optstring Short options to be recognized\n"),stderr);
+ fputs(_(" -q, --quiet Disable error reporting by getopt(3)\n"),stderr);
+ fputs(_(" -Q, --quiet-output No normal output\n"),stderr);
+ fputs(_(" -s, --shell=shell Set shell quoting conventions\n"),stderr);
+ fputs(_(" -T, --test Test for getopt(1) version\n"),stderr);
+ fputs(_(" -u, --unquote Do not quote the output\n"),stderr);
+ fputs(_(" -V, --version Output version information\n"),stderr);
exit(PARAMETER_EXIT_CODE);
}
--
1.7.0.4
From e833ffd88dfe68ea1b5e3d3a4b9fba191d080e74 Mon Sep 17 00:00:00 2001
From: Benno Schulenberg <bensberg@xxxxxxxxxxxxx>
Date: Sat, 13 Aug 2011 21:02:15 +0200
Subject: [PATCH 04/11] hwclock: when cutting up help texts anyway, do it into small chunks
Also do it at sensible boundaries, improve some of the wording, and
indent continuation lines for clarity. Also document -V instead of
-v for --version, to conform to the majority of utilities.
Signed-off-by: Benno Schulenberg <bensberg@xxxxxxxxxxxxx>
---
hwclock/hwclock.c | 54 ++++++++++++++++++++++++++++------------------------
1 files changed, 29 insertions(+), 25 deletions(-)
diff --git a/hwclock/hwclock.c b/hwclock/hwclock.c
index 021e5ac..7bcb20c 100644
--- a/hwclock/hwclock.c
+++ b/hwclock/hwclock.c
@@ -1372,26 +1372,30 @@ static void usage(const char *fmt, ...)
usageto = fmt ? stderr : stdout;
fprintf(usageto,
- _("hwclock - query and set the hardware clock (RTC)\n\n"
- "Usage: hwclock [function] [options...]\n\n" "Functions:\n"
- " -h | --help show this help\n"
+ _("Usage: hwclock [function] [option...]\n\n"
+ "Query or set the hardware clock (the RTC).\n\n"));
+ fprintf(usageto,
+ _( "Functions:\n"
+ " -h | --help show this help text and exit\n"
" -r | --show read hardware clock and print result\n"
- " --set set the rtc to the time given with --date\n"
- " -s | --hctosys set the system time from the hardware clock\n"
- " -w | --systohc set the hardware clock to the current system time\n"
+ " --set set the RTC to the time given with --date\n"));
+ fprintf(usageto,
+ _(" -s | --hctosys set the system time from the hardware clock\n"
+ " -w | --systohc set the hardware clock from the current system time\n"
" --systz set the system time based on the current timezone\n"
- " --adjust adjust the rtc to account for systematic drift since\n"
- " the clock was last set or adjusted\n"));
+ " --adjust adjust the RTC to account for systematic drift since\n"
+ " the clock was last set or adjusted\n"));
#ifdef __linux__
fprintf(usageto,
_(" --getepoch print out the kernel's hardware clock epoch value\n"
" --setepoch set the kernel's hardware clock epoch value to the \n"
- " value given with --epoch\n"));
+ " value given with --epoch\n"));
#endif
fprintf(usageto,
- _(" --predict predict rtc reading at time given with --date\n"
- " -v | --version print out the version of hwclock to stdout\n"
- "\nOptions: \n"
+ _(" --predict predict RTC reading at time given with --date\n"
+ " -V | --version display version information and exit\n"));
+ fprintf(usageto,
+ _("\nOptions:\n"
" -u | --utc the hardware clock is kept in UTC\n"
" --localtime the hardware clock is kept in local time\n"));
#ifdef __linux__
@@ -1400,22 +1404,22 @@ static void usage(const char *fmt, ...)
#endif
fprintf(usageto,
_(" --directisa access the ISA bus directly instead of %s\n"
- " --badyear ignore rtc's year because the bios is broken\n"
- " --date specifies the time to which to set the hardware clock\n"
- " --epoch=year specifies the year which is the beginning of the \n"
- " hardware clock's epoch value\n"
- " --noadjfile do not access %s. Requires the use of\n"
- " either --utc or --localtime\n"
- " --adjfile=path specifies the path to the adjust file (default is\n"
- " %s)\n"
- " --test do everything except actually updating the hardware\n"
- " clock or anything else\n"
- " -D | --debug debug mode\n" "\n"), _PATH_RTC_DEV,
- _PATH_ADJPATH, _PATH_ADJPATH);
+ " --badyear ignore RTC's year because the BIOS is broken\n"
+ " --date=time specifies the time to which to set the hardware clock\n"
+ " --epoch=year specifies the year which is the beginning of the\n"
+ " hardware clock's epoch value\n"), _PATH_RTC_DEV);
+ fprintf(usageto,
+ _(" --noadjfile do not access %s; this requires the use of\n"
+ " either --utc or --localtime\n"
+ " --adjfile=path specifies the path to the adjust file;\n"
+ " the default is %s\n"), _PATH_ADJPATH, _PATH_ADJPATH);
+ fprintf(usageto,
+ _(" --test do not update anything, just show what would happen\n"
+ " -D | --debug debugging mode\n" "\n"));
#ifdef __alpha__
fprintf(usageto,
_(" -J|--jensen, -A|--arc, -S|--srm, -F|--funky-toy\n"
- " tell hwclock the type of alpha you have (see hwclock(8))\n"
+ " tell hwclock the type of Alpha you have (see hwclock(8))\n"
"\n"));
#endif
--
1.7.0.4
From 8cbc1eec2557de210a51d992b79493134acf6ae8 Mon Sep 17 00:00:00 2001
From: Benno Schulenberg <bensberg@xxxxxxxxxxxxx>
Date: Sat, 13 Aug 2011 22:00:41 +0200
Subject: [PATCH 05/11] hwclock: in man page move --date and --epoch from Functions to Options
Also improve the synopsis and some wording and a bit of formatting,
add the --help option, and say that --show is the default function.
Signed-off-by: Benno Schulenberg <bensberg@xxxxxxxxxxxxx>
---
hwclock/hwclock.8 | 118 +++++++++++++++++++++++++++++------------------------
1 files changed, 65 insertions(+), 53 deletions(-)
diff --git a/hwclock/hwclock.8 b/hwclock/hwclock.8
index b693ae2..5134403 100644
--- a/hwclock/hwclock.8
+++ b/hwclock/hwclock.8
@@ -1,23 +1,23 @@
-.TH HWCLOCK 8 "06 August 2008"
+.TH HWCLOCK 8 "August 2011"
.SH NAME
-hwclock \- query and set the hardware clock (RTC)
+hwclock \- query or set the hardware clock (RTC)
.SH SYNOPSIS
.B hwclock
-.RI [ functions ]
-.RI [ options ]
+.RI [ function ]
+.RI [ option ...]
.SH DESCRIPTION
.B hwclock
is a tool for accessing the Hardware Clock. You can display the
current time, set the Hardware Clock to a specified time, set the
-Hardware Clock to the System Time, and set the System Time from the
+Hardware Clock from the System Time, or set the System Time from the
Hardware Clock.
.PP
You can also run
.B hwclock
-periodically to insert or remove time from the Hardware Clock to
-compensate for systematic drift (where the clock consistently gains or
-loses time at a certain rate if left to run).
+periodically to add or subtract time from the Hardware Clock to
+compensate for systematic drift (where the clock consistently loses or
+gains time at a certain rate when left to run).
.SH FUNCTIONS
You need exactly one of the following options to tell
@@ -26,11 +26,12 @@ what function to perform:
.PP
.TP
.BR \-r , \ \-\-show
-Read the Hardware Clock and print the time on Standard Output.
+Read the Hardware Clock and print the time on standard output.
The time shown is always in local time, even if you keep your Hardware Clock
in Coordinated Universal Time. See the
.B \-\-utc
option.
+Showing the Hardware Clock time is the default when no function is specified.
.TP
.B \-\-set
@@ -48,7 +49,7 @@ as
.BR tzset (3)
would interpret them.
The obsolete tz_dsttime field of the kernel's timezone value is set
-to DST_NONE. (For details on what this field used to mean, see
+to DST_NONE. (For details on what this field used to mean, see
.BR settimeofday (2).)
This is a good option to use in one of the system startup scripts.
@@ -66,7 +67,7 @@ as
.BR tzset (3)
would interpret them.
The obsolete tz_dsttime field of the kernel's timezone value is set
-to DST_NONE. (For details on what this field used to mean, see
+to DST_NONE. (For details on what this field used to mean, see
.BR settimeofday (2).)
This is an alternate option to
@@ -85,10 +86,12 @@ Print the kernel's Hardware Clock epoch value to standard output.
This is the number of years into AD to which a zero year value in the
Hardware Clock refers. For example, if you are using the convention
that the year counter in your Hardware Clock contains the number of
-full years since 1952, then the kernel's Hardware Counter epoch value
+full years since 1952, then the kernel's Hardware Clock epoch value
must be 1952.
-This epoch value is used whenever hwclock reads or sets the Hardware Clock.
+This epoch value is used whenever
+.B hwclock
+reads or sets the Hardware Clock.
.TP
.B \-\-setepoch
Set the kernel's Hardware Clock epoch value to the value specified by the
@@ -96,25 +99,44 @@ Set the kernel's Hardware Clock epoch value to the value specified by the
option. See the
.B \-\-getepoch
option for details.
+
+.TP
+.BI \-\-predict
+Predict what the RTC will read at time given by the
+.B \-\-date
+option based on the adjtime file. This is useful for example if you
+need to set an RTC wakeup time to distant future and want to account
+for the RTC drift.
.TP
-.BR \-v , \ \-\-version
-Print the version of
+.BR \-h , \ \-\-help
+Display a help text and exit.
+.TP
+.BR \-V , \ \-\-version
+Display the version of
.B hwclock
-on Standard Output.
+and exit.
+
+.SH OPTIONS
+.PP
+The first two options apply to just a few specific functions,
+the others apply to most functions.
.TP
.BI \-\-date= date_string
You need this option if you specify the
.B \-\-set
-option. Otherwise, it is ignored.
-This specifies the time to which to set the Hardware Clock.
+or
+.B \-\-predict
+functions, otherwise it is ignored.
+It specifies the time to which to set the Hardware Clock, or the
+time for which to predict the Hardware Clock reading.
The value of this option is an argument to the
.BR date (1)
program.
-For example,
+For example:
.sp
-.I hwclock --set --date="9/22/96 16:45:05"
+.B " hwclock" --set --date="2011-08-14 16:45:05"
.sp
-The argument is in local time, even if you keep your Hardware Clock in
+The argument must be in local time, even if you keep your Hardware Clock in
Coordinated Universal time. See the
.B \-\-utc
option.
@@ -122,28 +144,17 @@ option.
.TP
.BI \-\-epoch= year
Specifies the year which is the beginning of the Hardware Clock's
-epoch. I.e. the number of years into AD to which a zero value in the
-Hardware Clock's year counter refers. It is used together with
-the \-\-setepoch option to set the kernel's idea of the epoch of the
+epoch, that is the number of years into AD to which a zero value in the
+Hardware Clock's year counter refers. It is used together with
+the \fB\-\-setepoch\fR option to set the kernel's idea of the epoch of the
Hardware Clock, or otherwise to specify the epoch for use with
direct ISA access.
For example, on a Digital Unix machine:
.sp
-.I hwclock --setepoch --epoch=1952
+.B " hwclock" --setepoch --epoch=1952
.TP
-.BI \-\-predict
-Predict what the RTC will read at time given by the
-.B \-\-date
-option based on the adjtime file. This is useful for example if you
-need to set an RTC wakeup time to distant future and want to account
-for the RTC drift.
-
-.SH OPTIONS
-.PP
-The following options apply to most functions.
-.TP
.BR \-u , \ \-\-utc
.TP
.B \-\-localtime
@@ -160,10 +171,12 @@ will be messed up.
If you specify neither
.B \-\-utc
nor
-.B \-\-localtime
-, the default is whichever was specified the last time
+.BR \-\-localtime ,
+the default is whichever was specified the last time
.B hwclock
-was used to set the clock (i.e. hwclock was successfully run with the
+was used to set the clock (i.e.
+.B hwclock
+was successfully run with the
.BR \-\-set ,
.BR \-\-systohc ,
or
@@ -173,10 +186,10 @@ exist, the default is UTC time.
.TP
.B \-\-noadjfile
-disables the facilities provided by
+Disables the facilities provided by
.IR /etc/adjtime .
.B hwclock
-will not read nor write to that file with this option. Either
+will not read nor write to that file with this option. Either
.B \-\-utc
or
.B \-\-localtime
@@ -184,11 +197,11 @@ must be specified when using this option.
.TP
.BI \-\-adjfile= filename
-overrides the default /etc/adjtime.
+Overrides the default /etc/adjtime.
.TP
.BR \-f , \ \-\-rtc=\fIfilename\fB
-overrides the default /dev file name, which is
+Overrides the default /dev file name, which is
.IR /dev/rtc
on many platforms but may be
.IR /dev/rtc0 ,
@@ -197,8 +210,8 @@ and so on.
.TP
.B \-\-directisa
-is meaningful only on an ISA machine or an Alpha (which implements enough
-of ISA to be, roughly speaking, an ISA machine for
+This option is meaningful only on an ISA machine or an Alpha (which implements
+enough of ISA to be, roughly speaking, an ISA machine for
.BR hwclock 's
purposes). For other machines, it has no effect. This option tells
.B hwclock
@@ -206,10 +219,9 @@ to use explicit I/O instructions to access the Hardware Clock.
Without this option,
.B hwclock
will try to use the /dev/rtc device (which it assumes to be driven by the
-rtc device driver). If it is unable to open the device (for read), it will
+RTC device driver). If it is unable to open the device (for reading), it will
use the explicit I/O instructions anyway.
-The rtc device driver was new in Linux Release 2.
.TP
.B \-\-badyear
Indicates that the Hardware Clock is incapable of storing years outside
@@ -231,9 +243,9 @@ knows it's working with a brain-damaged clock, it ignores the year part of
the Hardware Clock value and instead tries to guess the year based on the
last calibrated date in the adjtime file, by assuming that that date is
within the past year. For this to work, you had better do a
-.I hwclock \-\-set
+.B hwclock \-\-set
or
-.I hwclock \-\-systohc
+.B hwclock \-\-systohc
at least once a year!
Though
@@ -278,14 +290,14 @@ is mounted.
(If you find you need one of these options to make
.B hwclock
work, contact the maintainer to see if the program can be improved
-to detect your system automatically. Output of `hwclock --debug'
+to detect your system automatically. Output of `hwclock --debug'
and `cat /proc/cpuinfo' may be of interest.)
+Option
.B \-\-jensen
-means you are running on a Jensen model.
-
+means you are running on a Jensen model. And
.B \-\-funky\-toy
-means that on your machine, one has to use the UF bit instead
+means that on your machine one has to use the UF bit instead
of the UIP bit in the Hardware Clock to detect a time transition. "Toy"
in the option name refers to the Time Of Year facility of the machine.
--
1.7.0.4
From 62b1bfe5111d1c9b9d2f5eb0f6a752f900bc7eb6 Mon Sep 17 00:00:00 2001
From: Benno Schulenberg <bensberg@xxxxxxxxxxxxx>
Date: Mon, 15 Aug 2011 13:00:18 +0200
Subject: [PATCH 06/11] po: do not search /samples/ subdirectories for translatable strings
Signed-off-by: Benno Schulenberg <bensberg@xxxxxxxxxxxxx>
---
po/update-potfiles | 2 ++
1 files changed, 2 insertions(+), 0 deletions(-)
diff --git a/po/update-potfiles b/po/update-potfiles
index 6cabe71..2a3ff58 100755
--- a/po/update-potfiles
+++ b/po/update-potfiles
@@ -5,6 +5,7 @@
# find all *.c files,
# sort the list
+# exclude /samples/ subdirectories
# exclude ./tests/ from the list
# and remove "./" prefix
@@ -13,5 +14,6 @@
find -name "*.c" | \
sort | \
+ sed ':/samples/:d' | \
gawk '! /^\.\/tests\// { print gensub(/^\.\//, "", 1) }' \
> po/POTFILES.in
--
1.7.0.4
From c36a17ce553478d73cfb3509bf3bc11b5cafaf20 Mon Sep 17 00:00:00 2001
From: Benno Schulenberg <bensberg@xxxxxxxxxxxxx>
Date: Mon, 15 Aug 2011 13:09:42 +0200
Subject: [PATCH 07/11] libmount: cut up mount's help text into manageable chunks
Signed-off-by: Benno Schulenberg <bensberg@xxxxxxxxxxxxx>
---
libmount/samples/mount.c | 41 ++++++++++++++++++++++++-----------------
1 files changed, 24 insertions(+), 17 deletions(-)
diff --git a/libmount/samples/mount.c b/libmount/samples/mount.c
index 30c2610..891c471 100644
--- a/libmount/samples/mount.c
+++ b/libmount/samples/mount.c
@@ -202,43 +202,50 @@ static void __attribute__((__noreturn__)) usage(FILE *out)
fprintf(out, _(
"\nOptions:\n"
" -a, --all mount all filesystems mentioned in fstab\n"
- " -f, --fake dry run, skip mount(2) syscall\n"
- " -F, --fork fork off for each device (use with -a)\n"
- " -h, --help this help\n"
- " -n, --no-mtab don't write to /etc/mtab\n"
- " -r, --read-only mount the filesystem read-only (same as -o ro)\n"
- " -v, --verbose verbose mode\n"
- " -V, --version print version string\n"
- " -w, --read-write mount the filesystem read-write (default)\n"
- " -o, --options <list> comma separated string of mount options\n"
- " -O, --test-opts <list> limit the set of filesystems (use with -a)\n"
- " -t, --types <list> indicate the filesystem type\n"
" -c, --no-canonicalize don't canonicalize paths\n"
+ " -f, --fake dry run; skip the mount(2) syscall\n"
+ " -F, --fork fork off for each device (use with -a)\n"));
+ fprintf(out, _(
+ " -h, --help display this help text and exit\n"
" -i, --internal-only don't call the mount.<type> helpers\n"
" -l, --show-labels lists all mounts with LABELs\n"
+ " -n, --no-mtab don't write to /etc/mtab\n"));
+ fprintf(out, _(
+ " -o, --options <list> comma-separated list of mount options\n"
+ " -O, --test-opts <list> limit the set of filesystems (use with -a)\n"
+ " -r, --read-only mount the filesystem read-only (same as -o ro)\n"
+ " -t, --types <list> limit the set of filesystem types\n"));
+ fprintf(out, _(
+ " -v, --verbose say what is being done\n"
+ " -V, --version display version information and exit\n"
+ " -w, --read-write mount the filesystem read-write (default)\n"));
+ fprintf(out, _(
"\nSource:\n"
" -L, --label <label> synonym for LABEL=<label>\n"
" -U, --uuid <uuid> synonym for UUID=<uuid>\n"
" LABEL=<label> specifies device by filesystem label\n"
- " UUID=<uuid> specifies device by filesystem UUID\n"
+ " UUID=<uuid> specifies device by filesystem UUID\n"));
+ fprintf(out, _(
" <device> specifies device by path\n"
" <directory> mountpoint for bind mounts (see --bind/rbind)\n"
- " <file> regular file for loopdev setup\n"
+ " <file> regular file for loopdev setup\n"));
+ fprintf(out, _(
"\nOperations:\n"
" -B, --bind mount a subtree somewhere else (same as -o bind)\n"
" -M, --move move a subtree to some other place\n"
- " -R, --rbind mount a subtree and all submounts somewhere else\n"
+ " -R, --rbind mount a subtree and all submounts somewhere else\n"));
+ fprintf(out, _(
" --make-shared mark a subtree as shared\n"
" --make-slave mark a subtree as slave\n"
" --make-private mark a subtree as private\n"
- " --make-unbindable mark a subtree as unbindable\n"
+ " --make-unbindable mark a subtree as unbindable\n"));
+ fprintf(out, _(
" --make-rshared recursively mark a whole subtree as shared\n"
" --make-rslave recursively mark a whole subtree as slave\n"
" --make-rprivate recursively mark a whole subtree as private\n"
- " --make-runbindable recursively mark a whole subtree as unbindable\n"
- ));
+ " --make-runbindable recursively mark a whole subtree as unbindable\n"));
fprintf(out, _("\nFor more information see mount(8).\n"));
--
1.7.0.4
From 8030c398c77fbea8d25d8bfe61a4d8a7a47738ab Mon Sep 17 00:00:00 2001
From: Benno Schulenberg <bensberg@xxxxxxxxxxxxx>
Date: Mon, 15 Aug 2011 13:36:50 +0200
Subject: [PATCH 08/11] findmnt: improve spelling, wording and order of help text
Signed-off-by: Benno Schulenberg <bensberg@xxxxxxxxxxxxx>
---
misc-utils/findmnt.c | 28 ++++++++++++++--------------
1 files changed, 14 insertions(+), 14 deletions(-)
diff --git a/misc-utils/findmnt.c b/misc-utils/findmnt.c
index 7e6a8f5..e919a96 100644
--- a/misc-utils/findmnt.c
+++ b/misc-utils/findmnt.c
@@ -772,31 +772,31 @@ static void __attribute__((__noreturn__)) usage(FILE *out)
"\nOptions:\n"
" -s, --fstab search in static table of filesystems\n"
" -m, --mtab search in table of mounted filesystems\n"
- " -k, --kernel search in kernel table of mounted \n"
- " filesystems (default)\n\n"
+ " -k, --kernel search in kernel table of mounted\n"
+ " filesystems (default)\n\n"
" -p, --poll[=<list>] monitor changes in table of mounted filesystems\n"
- " -w, --timeout <num> upper limit in millisecods which --poll will block\n\n"
+ " -w, --timeout <num> upper limit in milliseconds that --poll will block\n\n"
+ " -a, --ascii use ASCII chars for tree formatting\n"
" -c, --canonicalize canonicalize printed paths\n"
- " -d, --direction <word> search direction - 'forward' or 'backward'\n"
- " -e, --evaluate print all TAGs (LABEL/UUID) evaluated\n"
+ " -d, --direction <word> direction of search, 'forward' or 'backward'\n"
+ " -e, --evaluate convert tags (LABEL/UUID) to device names\n"
" -f, --first-only print the first found filesystem only\n"
- " -h, --help print this help\n"
- " -i, --invert invert sense of matching\n"
+ " -h, --help display this help text and exit\n"
+ " -i, --invert invert the sense of matching\n"
" -l, --list use list format output\n"
- " -n, --noheadings don't print headings\n"
+ " -n, --noheadings don't print column headings\n"
" -u, --notruncate don't truncate text in columns\n"
" -O, --options <list> limit the set of filesystems by mount options\n"
- " -o, --output <list> output columns\n"
+ " -o, --output <list> the output columns to be shown\n"
" -P, --pairs use key=\"value\" output format\n"
" -r, --raw use raw output format\n"
- " -a, --ascii use ascii chars for tree formatting\n"
- " -t, --types <list> limit the set of filesystem by FS types\n"
+ " -t, --types <list> limit the set of filesystems by FS types\n"
" -v, --nofsroot don't print [/dir] for bind or btrfs mounts\n"
- " -R, --submounts print all submount for the matching filesystems\n"
- " -S, --source <string> device, LABEL= or UUID=device\n"
- " -T, --target <string> mountpoint\n\n"));
+ " -R, --submounts print all submounts for the matching filesystems\n"
+ " -S, --source <string> the device to mount (by name, LABEL= or UUID=)\n"
+ " -T, --target <string> the mountpoint to use\n\n"));
fprintf(out, _("\nAvailable columns:\n"));
--
1.7.0.4
From a24233277a30792a77b7a577bc7baa7753d63615 Mon Sep 17 00:00:00 2001
From: Benno Schulenberg <bensberg@xxxxxxxxxxxxx>
Date: Mon, 15 Aug 2011 13:39:33 +0200
Subject: [PATCH 09/11] findmnt: slice up the help text into manageable chunks
Signed-off-by: Benno Schulenberg <bensberg@xxxxxxxxxxxxx>
---
misc-utils/findmnt.c | 16 +++++++++++-----
1 files changed, 11 insertions(+), 5 deletions(-)
diff --git a/misc-utils/findmnt.c b/misc-utils/findmnt.c
index e919a96..2c1b20c 100644
--- a/misc-utils/findmnt.c
+++ b/misc-utils/findmnt.c
@@ -773,26 +773,32 @@ static void __attribute__((__noreturn__)) usage(FILE *out)
" -s, --fstab search in static table of filesystems\n"
" -m, --mtab search in table of mounted filesystems\n"
" -k, --kernel search in kernel table of mounted\n"
- " filesystems (default)\n\n"
+ " filesystems (default)\n\n"));
+ fprintf(out, _(
" -p, --poll[=<list>] monitor changes in table of mounted filesystems\n"
- " -w, --timeout <num> upper limit in milliseconds that --poll will block\n\n"
+ " -w, --timeout <num> upper limit in milliseconds that --poll will block\n\n"));
+ fprintf(out, _(
" -a, --ascii use ASCII chars for tree formatting\n"
" -c, --canonicalize canonicalize printed paths\n"
" -d, --direction <word> direction of search, 'forward' or 'backward'\n"
" -e, --evaluate convert tags (LABEL/UUID) to device names\n"
- " -f, --first-only print the first found filesystem only\n"
+ " -f, --first-only print the first found filesystem only\n"));
+
+ fprintf(out, _(
" -h, --help display this help text and exit\n"
" -i, --invert invert the sense of matching\n"
" -l, --list use list format output\n"
" -n, --noheadings don't print column headings\n"
- " -u, --notruncate don't truncate text in columns\n"
+ " -u, --notruncate don't truncate text in columns\n"));
+ fprintf(out, _(
" -O, --options <list> limit the set of filesystems by mount options\n"
" -o, --output <list> the output columns to be shown\n"
" -P, --pairs use key=\"value\" output format\n"
" -r, --raw use raw output format\n"
- " -t, --types <list> limit the set of filesystems by FS types\n"
+ " -t, --types <list> limit the set of filesystems by FS types\n"));
+ fprintf(out, _(
" -v, --nofsroot don't print [/dir] for bind or btrfs mounts\n"
" -R, --submounts print all submounts for the matching filesystems\n"
" -S, --source <string> the device to mount (by name, LABEL= or UUID=)\n"
--
1.7.0.4
From 729474d404a5dbb1c2f8f661bc4f29eb1aafbee4 Mon Sep 17 00:00:00 2001
From: Benno Schulenberg <bensberg@xxxxxxxxxxxxx>
Date: Mon, 15 Aug 2011 14:04:20 +0200
Subject: [PATCH 10/11] logger: improve, sort and slice up usage() help text
Signed-off-by: Benno Schulenberg <bensberg@xxxxxxxxxxxxx>
---
misc-utils/logger.c | 26 ++++++++++++++------------
1 files changed, 14 insertions(+), 12 deletions(-)
diff --git a/misc-utils/logger.c b/misc-utils/logger.c
index 5ecec76..5ad4ae8 100644
--- a/misc-utils/logger.c
+++ b/misc-utils/logger.c
@@ -137,22 +137,24 @@ static void __attribute__ ((__noreturn__)) usage(FILE *out)
{
fprintf(out,
_("\nUsage:\n"
- " %s [options] message\n"),
+ " %s [options] [message]\n"),
program_invocation_short_name);
fprintf(out, _(
"\nOptions:\n"
- " -i, --id log process id\n"
- " -s, --stderr log message to standard error as well\n"
- " -f, --file FILE log contents of the specified file\n"
- " -p, --priority PRI enter message priority\n"
- " -t, --tag TAG mark every line with tag\n"
- " -u, --socket SOCK write to socket\n"
- " -d, --udp use udp (tcp is default)\n"
- " -n, --server ADDR write to remote syslog server\n"
- " -P, --port define port number\n"
- " -V, --version output version information and exit\n"
- " -h, --help display this help and exit\n\n"));
+ " -d, --udp use UDP (TCP is default)\n"
+ " -i, --id log the process ID too\n"
+ " -f, --file FILE log the contents of this file\n"
+ " -h, --help display this help text and exit\n"));
+ fprintf(out, _(
+ " -n, --server NAME write to this remote syslog server\n"
+ " -P, --port NUMBER use this UDP port\n"
+ " -p, --priority PRIO mark given message with this priority\n"
+ " -s, --stderr output message to standard error as well\n"));
+ fprintf(out, _(
+ " -t, --tag TAG mark every line with this tag\n"
+ " -u, --socket SOCKET write to this Unix socket\n"
+ " -V, --version output version information and exit\n\n"));
exit(out == stderr ? EXIT_FAILURE : EXIT_SUCCESS);
}
--
1.7.0.4
From 64ef557cc7999cd0c61df8476e431b782135833b Mon Sep 17 00:00:00 2001
From: Benno Schulenberg <bensberg@xxxxxxxxxxxxx>
Date: Mon, 15 Aug 2011 14:25:44 +0200
Subject: [PATCH 11/11] logger: improve descriptions on man page, sort the options, add -h and -V
Signed-off-by: Benno Schulenberg <bensberg@xxxxxxxxxxxxx>
---
misc-utils/logger.1 | 71 ++++++++++++++++++++++++++-------------------------
1 files changed, 36 insertions(+), 35 deletions(-)
diff --git a/misc-utils/logger.1 b/misc-utils/logger.1
index 4312551..ea634e5 100644
--- a/misc-utils/logger.1
+++ b/misc-utils/logger.1
@@ -41,16 +41,16 @@
.Nd a shell command interface to the syslog(3) system log module
.Sh SYNOPSIS
.Nm logger
-.Op Fl isd
+.Op Fl dhisV
.Op Fl f Ar file
+.Op Fl n Ar server
+.Op Fl P Ar port
.Op Fl p Ar pri
.Op Fl t Ar tag
.Op Fl u Ar socket
-.Op Fl n Ar server
-.Op Fl P Ar udpport
-.Op Ar message ...
+.Op Ar message
.Sh DESCRIPTION
-.Nm Logger
+.Nm logger
makes entries in the system log.
It provides a shell command interface to the
.Xr syslog 3
@@ -59,41 +59,42 @@ system log module.
Options:
.Pp
.Bl -tag -width "message"
+.It Fl d, Fl Fl udp
+Use datagram (UDP) instead of the default stream connection (TCP).
.It Fl i, Fl Fl id
-Log the process id of the logger process
-with each line.
-.It Fl s, Fl Fl stderr
-Log the message to standard error, as well as the system log.
+Log the process ID of the logger process with each line.
.It Fl f, Fl Fl file Ar file
-Log contents of the specified file. This option cannot be
-combined with command line message.
-.It Fl p, Fl Fl priority Ar pri
-Enter the message with the specified priority.
-The priority may be specified numerically or as a ``facility.level''
+Log the contents of the specified \fIfile\fR. This option cannot be
+combined with a command-line message.
+.It Fl h, Fl Fl help
+Display a help text and exit.
+.It Fl n, Fl Fl server Ar server
+Write to the specified remote syslog
+.Ar server
+using UDP instead of to the builtin syslog routines.
+.It Fl P, Fl Fl port Ar port
+Use the specified UDP
+.Ar port .
+The default port number is 514.
+.It Fl p, Fl Fl priority Ar priority
+Enter the message into the log with the specified
+.Ar priority .
+The priority may be specified numerically or as a \fIfacility.level\fR
pair.
-For example, ``\-p local3.info'' logs the message(s) as
-.Ar info Ns rmational
-level in the
-.Ar local3
-facility.
-The default is ``user.notice.''
+For example, \fB-p local3.info\fR logs the message as
+informational in the local3 facility.
+The default is \fIuser.notice\fR.
+.It Fl s, Fl Fl stderr
+Output the message to standard error as well as to the system log.
.It Fl t, Fl Fl tag Ar tag
-Mark every line in the log with the specified
+Mark every line to be logged with the specified
.Ar tag .
-.It Fl u, Fl Fl socket Ar sock
-Write to socket as specified with
+.It Fl u, Fl Fl socket Ar socket
+Write to the specified
.Ar socket
-instead of builtin syslog routines.
-.It Fl d, Fl Fl udp
-Use a datagram instead of a stream connection to this socket.
-.It Fl n, Fl Fl server Ar serv
-Write to remote syslog server using UDP as specified with
-.Ar server
-instead of builtin syslog routines.
-.It Fl P, Fl Fl port Ar port
-Change UDP port to the value as specified with
-.Ar udpport .
-Default port number is 514.
+instead of to the builtin syslog routines.
+.It Fl V, Fl Fl version
+Display version information and exit.
.It --
End the argument list. This is to allow the
.Ar message
@@ -114,7 +115,7 @@ sensitive nature), cron, daemon, ftp, kern (canâ??t be generated from user
process), lpr, mail, news, security (deprecated synonym for auth), syslog,
user, uucp, and local0 to local7, inclusive.
.Pp
-Valid level names are):
+Valid level names are:
alert, crit, debug, emerg, err, error (deprecated synonym for err),
info, notice, panic (deprecated synonym for emerg), warning,
warn (deprecated synonym for warning).
--
1.7.0.4
