From 8a78a4fe2ff3e5f750b4f149f5310b56a4193166 Mon Sep 17 00:00:00 2001 From: Sami Kerola Date: Sat, 2 Jun 2012 21:57:31 +0200 Subject: docs: clean up dmesg.1 manual * Add lightness to synopsis. * Add few missing italic highlights to text segments which refer command line argument(s). * Turn off bold where ever possible (makes text unnecessarily heavy). * Add spaces after dots (English spacing). * Use URL and email macros where appropriate. Signed-off-by: Sami Kerola --- sys-utils/dmesg.1 | 154 ++++++++++++++++++++++++++++++------------------------ 1 file changed, 86 insertions(+), 68 deletions(-) (limited to 'sys-utils/dmesg.1') diff --git a/sys-utils/dmesg.1 b/sys-utils/dmesg.1 index 9e90ca5db..1d1aaf8fa 100644 --- a/sys-utils/dmesg.1 +++ b/sys-utils/dmesg.1 @@ -1,72 +1,82 @@ .\" Copyright 1993 Rickard E. Faith (faith@cs.unc.edu) .\" May be distributed under the GNU General Public License -.TH DMESG 1 "July 2011" "util-linux" "User Commands" +.TH DMESG "1" "July 2012" "util-linux" "User Commands" .SH NAME dmesg \- print or control the kernel ring buffer .SH SYNOPSIS .B dmesg .RB [ options ] .sp -.B dmesg \-\-clear -.sp -.B dmesg \-\-read-clear -.RB [ options ] -.sp -.B dmesg \-\-console-level -.I level -.sp -.B dmesg \-\-console-on -.sp -.B dmesg \-\-console-off +dmesg \-\-clear +.br +dmesg \-\-read-clear [options] +.br +dmesg \-\-console-level level +.br +dmesg \-\-console-on +.br +dmesg \-\-console-off .SH DESCRIPTION .B dmesg is used to examine or control the kernel ring buffer. - +.PP The default action is to read all messages from kernel ring buffer. - .SH OPTIONS -The --clear, --read-clear, --console-on, --console-off and --console-level -options are mutually exclusive. - -.IP "\fB\-C, \-\-clear\fP" +The \-\-clear, \-\-read-clear, \-\-console-on, \-\-console-off and +\-\-console-level options are mutually exclusive. +.PP +.IP "\fB\-C\fR, \fB\-\-clear\fR" Clear the ring buffer. -.IP "\fB\-c, \-\-read-clear\fP" +.IP "\fB\-c\fR, \fB\-\-read-clear\fR" Clear the ring buffer contents after printing. -.IP "\fB\-D, \-\-console-off\fP" +.IP "\fB\-D\fR, \fB\-\-console-off\fR" Disable printing messages to the console. -.IP "\fB\-d, \-\-show-delta\fP" -Display the timestamp and time delta spent between messages. If used together -with --notime then only the time delta without the timestamp is printed. -.IP "\fB\-E, \-\-console-on\fP" +.IP "\fB\-d\fR, \fB\-\-show-delta\fR" +Display the timestamp and time delta spent between messages. If used +together with +.B \-\-notime +then only the time delta without the timestamp is printed. +.IP "\fB\-E\fR, \fB\-\-console-on\fR" Enable printing messages to the console. -.IP "\fB\-F, \-\-file \fIfile\fP" -Read log from file. -.IP "\fB\-f, \-\-facility \fIlist\fP" -Restrict output to defined (comma separated) list of facilities. For example -.sp - dmesg --facility=daemon -.sp -will print messages from system daemons only. For all supported facilities see +.IP "\fB\-F\fR, \fB\-\-file \fIfile\fR" +Read log from +.IR file . +.IP "\fB\-f\fR, \fB\-\-facility \fIlist\fR" +Restrict output to defined (comma separated) +.I list +of facilities. For example +.PP +.RS 14 +dmesg \-\-facility=daemon +.RE +.IP +will print messages from system daemons only. For all supported facilities +see .B dmesg \-\-help output. -.IP "\fB\-h, \-\-help\fP" +.IP "\fB\-h\fR, \fB\-\-help\fR" Print a help text and exit. -.IP "\fB\-k, \-\-kernel\fP" +.IP "\fB\-k\fR, \fB\-\-kernel\fR" Print kernel messages. -.IP "\fB\-l, \-\-level \fIlist\fP" -Restrict output to defined (comma separated) list of levels. For example -.sp - dmesg --level=err,warn -.sp -will print error and warning messages only. For all supported levels see +.IP "\fB\-l\fR, \fB\-\-level \fIlist\fR" +Restrict output to defined (comma separated) +.I list +of levels. For example +.PP +.RS 14 +dmesg \-\-level=err,warn +.RE +.IP +will print error and warning messages only. For all supported levels see .B dmesg \-\-help output. -.IP "\fB\-n, \-\-console-level \fIlevel\fP +.IP "\fB\-n\fR, \fB\-\-console-level \fIlevel\fR Set the .I level -at which logging of messages is done to the console. The +at which logging of messages is done to the console. The .I level -is a level number or abbreviation of the level name. For all supported levels see +is a level number or abbreviation of the level name. For all supported +levels see .B dmesg \-\-help output. .sp @@ -74,48 +84,56 @@ For example, .B \-n 1 or .B \-n alert -prevents all messages, except emergency (panic) messages, from appearing on the -console. All levels of messages are still written to +prevents all messages, except emergency (panic) messages, from appearing on +the console. All levels of messages are still written to .IR /proc/kmsg , so .BR syslogd (8) -can still be used to control exactly where kernel messages appear. When -the +can still be used to control exactly where kernel messages appear. When the .B \-n option is used, .B dmesg will .I not print or clear the kernel ring buffer. -.IP "\fB\-r, \-\-raw\fP" -Print the raw message buffer, i.e., don't strip the log level prefixes. -.IP "\fB\-s, \-\-buffer-size \fIsize\fP +.IP "\fB\-r\fR, \fB\-\-raw\fR" +Print the raw message buffer, i.e., do not strip the log level prefixes. +.IP "\fB\-s\fR, \fB\-\-buffer-size \fIsize\fR Use a buffer of .I size -to query the kernel ring buffer. This is 16392 by default. -(The default kernel syslog buffer size was 4096 -at first, 8192 since 1.3.54, 16384 since 2.1.113.) -If you have set the kernel buffer to be larger than the default +to query the kernel ring buffer. This is 16392 by default. (The default +kernel syslog buffer size was 4096 at first, 8192 since 1.3.54, 16384 since +2.1.113.) If you have set the kernel buffer to be larger than the default then this option can be used to view the entire buffer. -.IP "\fB\-T, \-\-ctime\fP" -Print human readable timestamps. The timestamp could be inaccurate! - -.B The time source used for the logs is not updated after system SUSPEND/RESUME. -.IP "\fB\-t, \-\-notime\fP" -Don't print kernel's timestampts. -.IP "\fB\-u, \-\-userspace\fP" +.IP "\fB\-T\fR, \fB\-\-ctime\fR" +Print human readable timestamps. The timestamp could be inaccurate! +.IP +The +.B time +source used for the logs is +.B not updated after +system +.BR SUSPEND / RESUME . +.IP "\fB\-t\fR, \fB\-\-notime\fR" +Do not print kernel's timestampts. +.IP "\fB\-u\fR, \fB\-\-userspace\fR" Print userspace messages. -.IP "\fB\-V, \-\-version\fP" +.IP "\fB\-V\fR, \fB\-\-version\fR" Output version information and exit. -.IP "\fB\-x, \-\-decode\fP" +.IP "\fB\-x\fR, \fB\-\-decode\fR" Decode facility and level (priority) number to human readable prefixes. .SH SEE ALSO .BR syslogd (8) .SH AUTHORS -.nf -Karel Zak -Theodore Ts'o -.fi +.MT kzak@redhat.com +Karel Zak +.ME +.br +.MT tytso@athena.mit.edu +Theodore Ts'o +.ME .SH AVAILABILITY The dmesg command is part of the util-linux package and is available from -ftp://ftp.kernel.org/pub/linux/utils/util-linux/. +.UR ftp://\:ftp.kernel.org\:/pub\:/linux\:/utils\:/util-linux/ +Linux Kernel Archive +.UE . -- cgit v1.2.3-55-g7522