Package: libaudit-common
Version: 1:4.0.2-2
Severity: minor
Tags: patch
* What led up to the situation?
Checking for defects with a new version
test-[g|n]roff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z < "man
page"
[Use "groff -e ' $' -e '\\~$' <file>" to find obvious trailing spaces.]
["test-groff" is a script in the repository for "groff"; is not shipped]
(local copy and "troff" slightly changed by me).
[The fate of "test-nroff" was decided in groff bug #55941.]
* What was the outcome of this action?
troff:<stdin>:13: warning: trailing space in the line
an.tmac:<stdin>:14: misuse, warning: .IR is for at least 2 arguments, got 1
Use macro '.I' for one argument or split argument.
an.tmac:<stdin>:15: style: 1 leading space(s) on input line
an.tmac:<stdin>:16: misuse, warning: .IR is for at least 2 arguments, got 1
Use macro '.I' for one argument or split argument.
* What outcome did you expect instead?
No output (no warnings).
-.-
General remarks and further material, if a diff-file exist, are in the
attachments.
-- System Information:
Debian Release: trixie/sid
APT prefers testing
APT policy: (500, 'testing')
Architecture: amd64 (x86_64)
Kernel: Linux 6.12.12-amd64 (SMP w/2 CPU threads; PREEMPT)
Locale: LANG=is_IS.iso88591, LC_CTYPE=is_IS.iso88591 (charmap=ISO-8859-1),
LANGUAGE not set
Shell: /bin/sh linked to /usr/bin/dash
Init: sysvinit (via /sbin/init)
-- no debconf information
Input file is libaudit.conf.5
Output from "mandoc -T lint libaudit.conf.5": (shortened list)
1 input text line longer than 80 bytes: This keyword specifi...
1 input text line longer than 80 bytes: contains configurati...
1 unterminated quoted argument
1 whitespace at end of input line
-.-.
Output from "test-groff -mandoc -t -ww -z libaudit.conf.5": (shortened list)
2 Use macro '.I' for one argument or split argument.
2 .IR is for at least 2 arguments, got 1
1 trailing space in the line
-.-.
Remove space characters (whitespace) at the end of lines.
Use "git apply ... --whitespace=fix" to fix extra space issues, or use
global configuration "core.whitespace".
Number of lines affected is
1
-.-.
Remove space in the first column, if not indented.
Use ".in +<number>n" and ".in" to end it; ".nf" and ".fi" to end
it, for an extra indention.
libaudit.conf.5:15: - meaning do nothing,
-.-.
Wrong distance between sentences in the input file.
Separate the sentences and subordinate clauses; each begins on a new
line. See man-pages(7) ("Conventions for source file layout") and
"info groff" ("Input Conventions").
The best procedure is to always start a new sentence on a new line,
at least, if you are typing on a computer.
Remember coding: Only one command ("sentence") on each (logical) line.
E-mail: Easier to quote exactly the relevant lines.
Generally: Easier to edit the sentence.
Patches: Less unaffected text.
Search for two adjacent words is easier, when they belong to the same line,
and the same phrase.
The amount of space between sentences in the output can then be
controlled with the ".ss" request.
Mark a final abbreviation point as such by suffixing it with "\&".
Some sentences (etc.) do not begin on a new line.
7:contains configuration information for user space applications that link to
libaudit. The applications are responsible for querying the settings in this
file and obeying the admin's preferences. This file contains one configuration
keyword per line, an equal sign, and then followed by appropriate configuration
information. The keywords recognized are:
13:This keyword specifies what action the admin wishes a user space application
to take when there is a failure to send an audit event to the kernel. The
possible values are:
-.-.
Split lines longer than 80 characters into two or more lines.
Appropriate break points are the end of a sentence and a subordinate
clause; after punctuation marks.
Line 7, length 353
contains configuration information for user space applications that link to
libaudit. The applications are responsible for querying the settings in this
file and obeying the admin's preferences. This file contains one configuration
keyword per line, an equal sign, and then followed by appropriate configuration
information. The keywords recognized are:
Line 13, length 172
This keyword specifies what action the admin wishes a user space application to
take when there is a failure to send an audit event to the kernel. The possible
values are:
-.-.
Use \(en (en-dash) for a dash at the beginning (en) of a line,
or between space characters,
not a minus (\-) or a hyphen (-), except in the NAME section.
libaudit.conf.5:15: - meaning do nothing,
libaudit.conf.5:17:- write to syslog the inability to send an audit event, and
libaudit.conf.5:19:- the user space application should exit.
-.-.
Remove quotes when there is a printable
but no space character between them
and the quotes are not for emphasis (markup),
for example as an argument to a macro.
1:.TH LIBAUDIT.CONF "5" "Oct 2009" "Red Hat" "System Administration Utilities"
-.-.
Section headings (.SH and .SS) do not need quoting.
21:.SH "SEE ALSO"
-.-.
Output from "test-groff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z
":
troff:<stdin>:13: warning: trailing space in the line
an.tmac:<stdin>:14: misuse, warning: .IR is for at least 2 arguments, got 1
Use macro '.I' for one argument or split argument.
an.tmac:<stdin>:15: style: 1 leading space(s) on input line
an.tmac:<stdin>:16: misuse, warning: .IR is for at least 2 arguments, got 1
Use macro '.I' for one argument or split argument.
--- libaudit.conf.5 2025-02-12 01:59:07.054774251 +0000
+++ libaudit.conf.5.new 2025-02-12 02:08:02.843145536 +0000
@@ -1,24 +1,35 @@
-.TH LIBAUDIT.CONF "5" "Oct 2009" "Red Hat" "System Administration Utilities"
+.TH LIBAUDIT.CONF 5 "Oct 2009" "Red Hat" "System Administration Utilities"
.SH NAME
libaudit.conf \- libaudit configuration file
.SH DESCRIPTION
The file
.I /etc/libaudit.conf
-contains configuration information for user space applications that link to
libaudit. The applications are responsible for querying the settings in this
file and obeying the admin's preferences. This file contains one configuration
keyword per line, an equal sign, and then followed by appropriate configuration
information. The keywords recognized are:
+contains configuration information for user space applications
+that link to libaudit.
+The applications are responsible for querying the settings in
+this file
+and obeying the admin's preferences.
+This file contains one configuration keyword per line,
+an equal sign,
+and then followed by appropriate configuration information.
+The keywords recognized are:
.IR failure_action ".
These keywords are described below.
.TP
.I failure_action
-This keyword specifies what action the admin wishes a user space application
to take when there is a failure to send an audit event to the kernel. The
possible values are:
-.IR IGNORE
- - meaning do nothing,
-.IR LOG
-- write to syslog the inability to send an audit event, and
+This keyword specifies
+what action the admin wishes a user space application to take
+when there is a failure to send an audit event to the kernel.
+The possible values are:
+.B IGNORE
+\(en meaning do nothing,
+.B LOG
+\(en write to syslog the inability to send an audit event, and
.I TERMINATE
-- the user space application should exit.
+\(en the user space application should exit.
-.SH "SEE ALSO"
+.SH SEE ALSO
.BR get_auditfail_action (3).
.SH AUTHOR
Any program (person), that produces man pages, should check the output
for defects by using (both groff and nroff)
[gn]roff -mandoc -t -ww -b -z -K utf8 <man page>
The same goes for man pages that are used as an input.
For a style guide use
mandoc -T lint
-.-
Any "autogenerator" should check its products with the above mentioned
'groff', 'mandoc', and additionally with 'nroff ...'.
It should also check its input files for too long (> 80) lines.
This is just a simple quality control measure.
The "autogenerator" may have to be corrected to get a better man page,
the source file may, and any additional file may.
Common defects:
Not removing trailing spaces (in in- and output).
The reason for these trailing spaces should be found and eliminated.
Not beginning each input sentence on a new line.
Line length should thus be reduced.
The script "reportbug" uses 'quoted-printable' encoding when a line is
longer than 1024 characters in an 'ascii' file.
See man-pages(7), item "semantic newline".
-.-
The difference between the formatted output of the original and patched file
can be seen with:
nroff -mandoc <file1> > <out1>
nroff -mandoc <file2> > <out2>
diff -d -u <out1> <out2>
and for groff, using
\"printf '%s\n%s\n' '.kern 0' '.ss 12 0' | groff -mandoc -Z - \"
instead of 'nroff -mandoc'
Add the option '-t', if the file contains a table.
Read the output from 'diff -d -u ...' with 'less -R' or similar.
-.-.
If 'man' (man-db) is used to check the manual for warnings,
the following must be set:
The option \"-warnings=w\"
The environmental variable:
export MAN_KEEP_STDERR=yes (or any non-empty value)
or
(produce only warnings):
export MANROFFOPT=\"-ww -b -z\"
export MAN_KEEP_STDERR=yes (or any non-empty value)
-.-
