From: Bjarni Ingi Gislason <bjarniig@rhi.hi.is>
To: util-linux@vger.kernel.org
Subject: [PATCH] doc: term-utils/*: fix some warnings from "mandoc -T lint"
Date: Thu, 11 Jun 2020 01:26:37 +0000 [thread overview]
Message-ID: <20200611012637.GA28369@rhi.hi.is> (raw)
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 | 8 ++------
term-utils/script.1 | 4 ----
term-utils/scriptlive.1 | 2 +-
term-utils/scriptreplay.1 | 2 +-
4 files changed, 4 insertions(+), 12 deletions(-)
diff --git a/term-utils/agetty.8 b/term-utils/agetty.8
index c8d9796c5..76ba9e280 100644
--- a/term-utils/agetty.8
+++ b/term-utils/agetty.8
@@ -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
diff --git a/term-utils/script.1 b/term-utils/script.1
index ce6b124a4..59c8b2572 100644
--- a/term-utils/script.1
+++ b/term-utils/script.1
@@ -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
diff --git a/term-utils/scriptlive.1 b/term-utils/scriptlive.1
index 78694dcbb..236868b8f 100644
--- a/term-utils/scriptlive.1
+++ b/term-utils/scriptlive.1
@@ -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
diff --git a/term-utils/scriptreplay.1 b/term-utils/scriptreplay.1
index 7f1487561..99bf9c3d2 100644
--- a/term-utils/scriptreplay.1
+++ b/term-utils/scriptreplay.1
@@ -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
--
2.26.2
--
Bjarni I. Gíslason
reply other threads:[~2020-06-11 1:26 UTC|newest]
Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200611012637.GA28369@rhi.hi.is \
--to=bjarniig@rhi.hi.is \
--cc=util-linux@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).