]> git.ipfire.org Git - thirdparty/util-linux.git/commitdiff
doc: term-utils/*: fix some warnings from "mandoc -T lint"
authorBjarni Ingi Gislason <bjarniig@rhi.hi.is>
Thu, 11 Jun 2020 01:26:37 +0000 (01:26 +0000)
committerKarel Zak <kzak@redhat.com>
Mon, 15 Jun 2020 09:28:01 +0000 (11:28 +0200)
mandoc: ./term-utils/agetty.8:224:36: WARNING: undefined escape, printing literally: \\
mandoc: ./term-utils/agetty.8:12:2: STYLE: fill mode already enabled, skipping: fi
mandoc: ./term-utils/agetty.8:307:2: WARNING: skipping paragraph macro: PP empty
mandoc: ./term-utils/agetty.8:489:2: STYLE: fill mode already enabled, skipping: fi
mandoc: ./term-utils/agetty.8:503:2: STYLE: fill mode already enabled, skipping: fi

mandoc: ./term-utils/script.1:198:2: WARNING: skipping paragraph macro: PP empty
mandoc: ./term-utils/script.1:244:2: WARNING: empty block: RS
mandoc: ./term-utils/script.1:261:2: WARNING: skipping paragraph macro: PP empty

mandoc: ./term-utils/scriptlive.1:77:2: STYLE: fill mode already disabled, skipping: nf

mandoc: ./term-utils/scriptreplay.1:122:2: STYLE: fill mode already disabled, skipping: nf

###

  Additional change:

1)  Changed '  ' once to ' ' in "agetty.8"

2)  Change in the output from "groff":

'-' changed to '\-' in "agetty.8".

Signed-off-by: Bjarni Ingi Gislason <bjarniig@rhi.hi.is>
term-utils/agetty.8
term-utils/script.1
term-utils/scriptlive.1
term-utils/scriptreplay.1

index c8d9796c503b36418689edb19cc9327e794ac2d6..76ba9e280a3c5d2f408d5d343c62b96441a8b2dd 100644 (file)
@@ -9,7 +9,6 @@ agetty \- alternative Linux getty
 
 .SH DESCRIPTION
 .ad
-.fi
 \fBagetty\fP opens a tty port, prompts for a login name and invokes
 the /bin/login command.  It is normally invoked by \fBinit\fP(8).
 
@@ -217,11 +216,11 @@ program that \fBagetty\fR starts (usually /bin/login) is run as root.
 Do not print a newline before writing out /etc/issue.
 .TP
 \-o, \-\-login\-options "\fIlogin_options\fP"
-Options  and arguments that  are passed to \fBlogin\fP(1). Where \\u is
+Options and arguments that  are passed to \fBlogin\fP(1). Where \eu is
 replaced by the login name. For example:
 .RS
 .IP "" 4
-.B "\-\-login\-options '-h darkstar -- \\\u'"
+.B "\-\-login\-options '\-h darkstar \-\- \eu'"
 .PP
 See \fB\-\-autologin\fR, \fB\-\-login\-program\fR and \fB\-\-remote\fR.
 .PP
@@ -304,7 +303,6 @@ Display version information and exit.
 .TP
 \-\-help
 Display help text and exit.
-.PP
 .SH EXAMPLE
 This section shows examples for the process field of an entry in the
 \fI/etc/inittab\fP file.  You'll have to prepend appropriate values
@@ -486,7 +484,6 @@ problem reports (if syslog(3) is not used).
 \fIinit\fP(8) configuration file for SysV-style init daemon.
 .SH BUGS
 .ad
-.fi
 The baud-rate detection feature (the \fB\-\-extract\-baud\fP option) requires that
 \fBagetty\fP be scheduled soon enough after completion of a dial-in
 call (within 30 ms with modems that talk at 2400 baud).  For robustness,
@@ -500,7 +497,6 @@ The baud-rate detection feature (the \fB\-\-extract\-baud\fP option) requires th
 the modem emits its status message \fIafter\fP raising the DCD line.
 .SH DIAGNOSTICS
 .ad
-.fi
 Depending on how the program was configured, all diagnostics are
 written to the console device or reported via the \fBsyslog\fR(3) facility.
 Error messages are produced if the \fIport\fP argument does not
index ce6b124a47cd41bd4d4bdb2a858713fd79b4cab9..59c8b25728725f0f077d1dacb9f33b20f6cf1265 100644 (file)
@@ -195,7 +195,6 @@ Upon receiving
 .BR SIGUSR1 ,
 .B script
 immediately flushes the output files.
-.PP
 .SH ENVIRONMENT
 The following environment variable is utilized by
 .BR script :
@@ -241,8 +240,6 @@ is always interactive, and this could lead to unexpected results.  If you use
 in the shell initialization file, you have to avoid entering an infinite
 loop.  You can use for example the \fB\%.profile\fR file, which is read
 by login shells only:
-.RS
-.RE
 .sp
 .na
 .RS
@@ -258,7 +255,6 @@ fi
 You should also avoid use of script in command pipes, as
 .B script
 can read more input than you would expect.
-.PP
 .SH HISTORY
 The
 .B script
index 78694dcbbc3d4461df2ba3b0119c23c1a0839c04..236868b8f9705781e45cd14be84f2fe7a2a2de7d 100644 (file)
@@ -74,7 +74,7 @@ Script started, file is script.out
 % exit
 Script done, file is script.out
 % scriptlive --log-timing file.tm --log-in script.in
-.nf
+.fi
 .SH AUTHORS
 .MT kzak@\:redhat.com
 Karel Zak
index 7f1487561ae07fa2a313c773861c8cd8143b12be..99bf9c3d2b9e9b22c1d4c9be2c021477874d7c42 100644 (file)
@@ -119,7 +119,7 @@ Script started, file is script.out
 % exit
 Script done, file is script.out
 % scriptreplay --log-timing file.tm --log-out script.out
-.nf
+.fi
 .SH AUTHORS
 The original
 .B scriptreplay