Skip to content

Commit

Permalink
Fix markup and typos in man pages
Browse files Browse the repository at this point in the history
  • Loading branch information
mariobl committed Dec 27, 2021
1 parent b361992 commit 2bfc361
Show file tree
Hide file tree
Showing 19 changed files with 327 additions and 285 deletions.
35 changes: 19 additions & 16 deletions man/bootlogd.8
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
.\" along with this program; if not, write to the Free Software
.\" Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
.\"
.TH BOOTLOGD 8 "Jul 21, 2003" "" "Linux System Administrator's Manual"
.TH BOOTLOGD 8 "Jul 21, 2003" "sysvinit @VERSION@" "Linux System Administrator's Manual"
.SH NAME
bootlogd \- record boot messages
.SH SYNOPSIS
Expand All @@ -26,25 +26,24 @@ bootlogd \- record boot messages
.RB [ \-r ]
.RB [ \-s ]
.RB [ \-v ]
.RB [ " -l logfile " ]
.RB [ " -p pidfile " ]
.RI [ " \fB-l\fP logfile " ]
.RI [ " \fB-p\fP pidfile " ]
.SH DESCRIPTION
\fBBootlogd\fP runs in the background and copies all strings sent to the
\fI/dev/console\fP device to a logfile. If the logfile is not accessible,
\fBbootlogd\fP runs in the background and copies all strings sent to the
\fI/dev/console\fP device to a logfile. If the \fIlogfile\fP is not accessible,
the messages will be kept in memory until it is.
.SH OPTIONS
.IP \fB\-d\fP
Do not fork and run in the background.
.IP \fB\-e\fP
Print escape characters to the boot log file. This turns off filtering of
escape characters and allows tools like GNU Less to see and use colour control
characters (show the log in colour).
escape characters and allows tools like GNU \fBless\fP(1) to see and use
colour control characters (show the log in colour).
.IP \fB\-c\fP
Attempt to write to the logfile even if it does not yet exist.
Without this option,
.B bootlogd
will wait for the logfile to appear before attempting to write to it.
This behavior prevents bootlogd from creating logfiles under mount points.
Without this option, \fBbootlogd\fP will wait for the logfile to appear before
attempting to write to it. This behavior prevents \fBbootlogd\fP from creating
logfiles under mount points.
.IP \fB\-r\fP
If there is an existing logfile called \fIlogfile\fP rename it to
\fIlogfile~\fP unless \fIlogfile~\fP already exists.
Expand All @@ -61,12 +60,12 @@ Log to this logfile. The default is \fI/var/log/boot\fP.
.IP "\fB\-p\fP \fIpidfile\fP"
Put process-id in this file. The default is no pidfile.
.SH NOTES
bootlogd saves log data which includes control characters. The log is
\fBbootlogd\fP saves log data which includes control characters. The log is
technically a text file, but not very easy for humans to read. To address
this the readbootlog(1) command can be used to display the boot log
this the \fBreadbootlog\fP(1) command can be used to display the boot log
without the control characters.
.SH BUGS
Bootlogd works by redirecting the console output from the console device.
\fBbootlogd\fP works by redirecting the console output from the console device.
(Consequently \fBbootlogd\fP requires PTY support in the kernel configuration.)
It copies that output to the real console device and to a log file.
There is no standard way of ascertaining the real console device
Expand All @@ -77,6 +76,10 @@ If that syntax is ever changed by the kernel, or a console type is used that
\fBbootlogd\fP does not know about then \fBbootlogd\fP will not work.

.SH AUTHOR
Miquel van Smoorenburg, miquels@cistron.nl
.MT miquels@\:cistron\:.nl
Miquel van Smoorenburg
.ME
.SH "SEE ALSO"
.BR dmesg (8), fdatasync (3), readbootlog(1).
.BR dmesg (8),
.BR fdatasync (3),
.BR readbootlog (1)
21 changes: 9 additions & 12 deletions man/fstab-decode.8
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
.\" 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
.\"
.\" Author: Miloslav Trmac <mitr@redhat.com>
.TH fstab-decode 8 "May 2006"
.TH FSTAB-DECODE 8 "May 2006" "sysvinit @VERSION@" "Linux System Administrator's Manual"

.SH NAME
fstab-decode \- run a command with fstab-encoded arguments
Expand All @@ -30,11 +30,9 @@ fstab-decode \- run a command with fstab-encoded arguments
decodes escapes (such as newline characters and other whitespace)
in the specified \fIARGUMENT\fRs and uses them to run \fICOMMAND\fR.
The argument escaping uses the same rules as path escaping in
\fB/etc/fstab\fR,
.B /etc/mtab
and \fB/proc/mtab\fR.
\fI/etc/fstab\fR, \fI/etc/mtab\fR and \fI/proc/mtab\fR.

In essence fstab-decode can be used anytime we want to pass multiple
In essence \fBfstab-decode\fR can be used anytime we want to pass multiple
parameters to a command as a list of command line arguments. It turns output
like this:

Expand All @@ -47,7 +45,7 @@ Into one long list of parameters, "/root /mnt/remote-disk /home". This
can be useful when trying to work with multiple filesystems at once. For
instance, we can use it to unmount multiple NFS shares. This program also
removes whitespace and other characters which might cause programs such
as mount or umount to fail.
as \fBmount\fR(8) or \fBumount\fR(8) to fail.

.SH EXIT STATUS
.B fstab-decode
Expand All @@ -57,13 +55,12 @@ can't be run.
Otherwise it exits with the status returned by \fICOMMAND\fR.

.SH EXAMPLES
.nf
The following example reads fstab, finds all instances of VFAT filesystems and
prints their mount points (argument 2 in the fstab file). fstab-decode then runs
the specified program, umount, and passes it the list of VFAT mountpoints.
This unmounts all VFAT partitions.

The following example reads \fIfstab\fR, finds all instances of VFAT filesystems
and prints their mount points (argument 2 in the \fIfstab\fR file).
\fBfstab-decode\fR then runs the specified program, \fBumount\fR(8), and passes
it the list of VFAT mountpoints. This unmounts all VFAT partitions.

.nf
.B fstab-decode umount $(awk \[aq]$3 == \[dq]vfat\[dq] { print $2 }\[aq] /etc/fstab)
.fi

Expand Down
20 changes: 11 additions & 9 deletions man/halt.8
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@
.\"
.\"{{{}}}
.\"{{{ Title
.TH HALT 8 "Nov 6, 2001" "" "Linux System Administrator's Manual"
.TH HALT 8 "Nov 6, 2001" "sysvinit @VERSION@" "Linux System Administrator's Manual"
.\"}}}
.\"{{{ Name
.SH NAME
halt, reboot, poweroff \- stop the system.
halt, reboot, poweroff \- stop the system
.\"}}}
.\"{{{ Synopsis
.SH SYNOPSIS
Expand Down Expand Up @@ -61,7 +61,7 @@ normally, \fBshutdown\fP will be invoked instead (with the \fB-h\fP
or \fB-r\fP flag). For more info see the \fBshutdown\fP(8)
manpage.
.PP
The rest of this manpage describes the behaviour in runlevels 0
The rest of this manpage describes the behavior in runlevels 0
and 6, that is when the systems shutdown scripts are being run.
.\"}}}
.\"{{{ Options
Expand All @@ -77,13 +77,13 @@ Don't write the wtmp record.
.IP \fB\-f\fP
Force halt or reboot, don't call \fBshutdown\fP(8).
.IP \fB\-i\fP
Shut down all network interfaces just before halt or reboot.
Shut down all network interfaces just before \fBhalt\fR or \fBreboot\fR.
Warning: This may not work on interfaces which do not have an IP address
and should ideally be handled by a network manager service.
.IP \fB\-h\fP
Put all hard drives on the system in stand-by mode just before halt or power-off.
.IP \fB\-p\fP
When halting the system, switch off the power. This is the default when halt is
When halting the system, switch off the power. This is the default when \fBhalt\fR is
called as \fBpoweroff\fP.
.\"}}}
.\"{{{ Diagnostics
Expand All @@ -92,12 +92,12 @@ If you're not the superuser, you will get the message `must be superuser'.
.\"}}}
.\"{{{ Notes
.SH NOTES
Under older \fBsysvinit\fP releases , \fBreboot\fP and \fBhalt\fP should
Under older \fBsysvinit\fP releases, \fBreboot\fP and \fBhalt\fP should
never be called directly. From release 2.74 on \fBhalt\fP and \fBreboot\fP
invoke \fBshutdown\fP(8) if the system is not in runlevel 0 or 6. This
means that if \fBhalt\fP or \fBreboot\fP cannot find out the current
runlevel (for example, when \fI/var/run/utmp\fP hasn't been initialized
correctly and /var/run/runlevel does not exist) \fBshutdown\fP will be called,
correctly and \fI/var/run/runlevel\fR does not exist) \fBshutdown\fP will be called,
which might not be what you want.
Use the \fB-f\fP flag if you want to do a hard \fBhalt\fP or \fBreboot\fP.
.PP
Expand All @@ -107,14 +107,16 @@ effect of putting the drive in stand-by mode is that the write cache
on the disk is flushed. This is important for IDE drives, since the
kernel doesn't flush the write cache itself before power-off.
.PP
The \fBhalt\fP program uses /proc/ide/hd* to find all IDE disk devices,
The \fBhalt\fP program uses \fI/proc/ide/hd*\fR to find all IDE disk devices,
which means that \fI/proc\fP needs to be mounted when \fBhalt\fP or
\fBpoweroff\fP is called or the \fB-h\fP switch will do nothing.
.PP
.\"}}}
.\"{{{ Author
.SH AUTHOR
Miquel van Smoorenburg, miquels@cistron.nl
.MT miquels@\:cistron\:.nl
Miquel van Smoorenburg
.ME
.\"}}}
.\"{{{ See also
.SH "SEE ALSO"
Expand Down
Loading

0 comments on commit 2bfc361

Please sign in to comment.