From f064d8f4b9e9c14fc5034ece7ad54b6727fc9dd1 Mon Sep 17 00:00:00 2001 From: Jesse Smith Date: Mon, 12 Nov 2018 20:58:44 -0400 Subject: [PATCH] Added reference to readbootlog to the bootlogd manual page. This should allow Debian bug #725123 to be closed. --- doc/Changelog | 3 ++- man/bootlogd.8 | 7 ++++++- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/doc/Changelog b/doc/Changelog index ab724de..93d8d94 100644 --- a/doc/Changelog +++ b/doc/Changelog @@ -52,7 +52,8 @@ sysvinit (2.92) unreleased; urgency=low produced by bootlogd. The output is displayed cleaned up so there are no control characters. This avoids the need to use sed or related tools to try to clean up the contents of the log. - * Added manual page for readbootlog program. + * Added manual page for readbootlog program. Updated bootlogd page + to reference it. Closes Debian bug #725123. sysvinit (2.91) world; urgency=low diff --git a/man/bootlogd.8 b/man/bootlogd.8 index cab345b..90d145b 100644 --- a/man/bootlogd.8 +++ b/man/bootlogd.8 @@ -55,6 +55,11 @@ Show version. 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 +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 +without the control characters. .SH BUGS Bootlogd works by redirecting the console output from the console device. (Consequently \fBbootlogd\fP requires PTY support in the kernel configuration.) @@ -69,4 +74,4 @@ If that syntax is ever changed by the kernel, or a console type is used that .SH AUTHOR Miquel van Smoorenburg, miquels@cistron.nl .SH "SEE ALSO" -.BR dmesg (8), fdatasync (3). +.BR dmesg (8), fdatasync (3), readbootlog(1).