manuals: System message vs kernel message

Wordsmith mentions throughout the manual of syslog and dmesg, to clearly
differentiate them in an externally consisteny way, increasing operator
onboarding speed and elegance.

The daemon that handles general system messages, syslog, describes them
as "system messages", and "messages" is the standard filename. Rewrite
syslog related manual titles to align search results with this, and hier
entries to align the index. Use care to maintain keywords and not add
extra lines. Newsyslog trades "maintain" with "rotate" for visibility.

MFC after:	3 days
Reviewed by:	markj
Closes:		https://github.com/freebsd/freebsd-src/pull/2067
This commit is contained in:
Alexander Ziaee
2026-03-08 03:23:17 -04:00
parent 1e2c9bcc4e
commit 04d58d529a
6 changed files with 14 additions and 18 deletions
+2 -2
View File
@@ -25,7 +25,7 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE. .\" SUCH DAMAGE.
.\" .\"
.Dd July 3, 2023 .Dd March 8, 2026
.Dt SYSLOG 3 .Dt SYSLOG 3
.Os .Os
.Sh NAME .Sh NAME
@@ -34,7 +34,7 @@
.Nm openlog , .Nm openlog ,
.Nm closelog , .Nm closelog ,
.Nm setlogmask .Nm setlogmask
.Nd control system log .Nd control system message log
.Sh LIBRARY .Sh LIBRARY
.Lb libc .Lb libc
.Sh SYNOPSIS .Sh SYNOPSIS
+3 -3
View File
@@ -25,12 +25,12 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE. .\" SUCH DAMAGE.
.\" .\"
.Dd May 7, 2022 .Dd March 7, 2026
.Dt DMESG 8 .Dt DMESG 8
.Os .Os
.Sh NAME .Sh NAME
.Nm dmesg .Nm dmesg
.Nd "display the system message buffer" .Nd display the kernel message buffer
.Sh SYNOPSIS .Sh SYNOPSIS
.Nm .Nm
.Op Fl ac .Op Fl ac
@@ -38,7 +38,7 @@
.Sh DESCRIPTION .Sh DESCRIPTION
The The
.Nm .Nm
utility displays the contents of the system message buffer. utility displays the contents of the kernel message buffer.
If the If the
.Fl M .Fl M
option is not specified, the buffer is read from the currently running kernel option is not specified, the buffer is read from the currently running kernel
+3 -3
View File
@@ -327,7 +327,7 @@ Explicitly distrusted certificates; see
kernel state defaults; see kernel state defaults; see
.Xr sysctl.conf 5 .Xr sysctl.conf 5
.It Pa syslog.conf .It Pa syslog.conf
system log configuration system message log configuration
.It Pa ttys .It Pa ttys
tty creation configuration; see tty creation configuration; see
.Xr getty 8 .Xr getty 8
@@ -851,7 +851,7 @@ default log for system daemons
.It Pa devd.log .It Pa devd.log
default log for device state change daemon default log for device state change daemon
.It Pa dmesg.today .It Pa dmesg.today
system message buffer log, rotates to kernel message buffer log, rotates to
.Pa dmesg.yesterday .Pa dmesg.yesterday
.It Pa debug.log .It Pa debug.log
undiscarded debug syslog messages undiscarded debug syslog messages
@@ -862,7 +862,7 @@ logs for the line printer spooler daemon; see
.Xr sendmail 8 .Xr sendmail 8
log, rotates and compresses to maillog.0.bz2 log, rotates and compresses to maillog.0.bz2
.It Pa messages .It Pa messages
general system log; see general system message log; see
.Xr syslogd 8 .Xr syslogd 8
.It Pa mount.today .It Pa mount.today
currently loaded currently loaded
+2 -2
View File
@@ -14,12 +14,12 @@
.\" the suitability of this software for any purpose. It is .\" the suitability of this software for any purpose. It is
.\" provided "as is" without express or implied warranty. .\" provided "as is" without express or implied warranty.
.\" .\"
.Dd September 22, 2025 .Dd March 8, 2026
.Dt NEWSYSLOG 8 .Dt NEWSYSLOG 8
.Os .Os
.Sh NAME .Sh NAME
.Nm newsyslog .Nm newsyslog
.Nd maintain system log files to manageable sizes .Nd rotate system message log files to maintain manageable sizes
.Sh SYNOPSIS .Sh SYNOPSIS
.Nm .Nm
.Op Fl CFNPnrsv .Op Fl CFNPnrsv
+2 -4
View File
@@ -18,14 +18,12 @@
.\" the suitability of this software for any purpose. It is .\" the suitability of this software for any purpose. It is
.\" provided "as is" without express or implied warranty. .\" provided "as is" without express or implied warranty.
.\" .\"
.Dd February 4, 2026 .Dd March 8, 2026
.Dt NEWSYSLOG.CONF 5 .Dt NEWSYSLOG.CONF 5
.Os .Os
.Sh NAME .Sh NAME
.Nm newsyslog.conf .Nm newsyslog.conf
.Nd .Nd system message log rotator configuration file
.Xr newsyslog 8
configuration file
.Sh DESCRIPTION .Sh DESCRIPTION
The The
.Nm .Nm
+2 -4
View File
@@ -25,14 +25,12 @@
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE. .\" SUCH DAMAGE.
.\" .\"
.Dd December 10, 2020 .Dd March 8, 2026
.Dt SYSLOG.CONF 5 .Dt SYSLOG.CONF 5
.Os .Os
.Sh NAME .Sh NAME
.Nm syslog.conf .Nm syslog.conf
.Nd .Nd syslogd system message log configuration file
.Xr syslogd 8
configuration file
.Sh DESCRIPTION .Sh DESCRIPTION
The The
.Nm .Nm