9front - general discussion about 9front
 help / color / mirror / Atom feed
* [9front] sysinfo(1): use tag paragraph for option descriptions
@ 2021-11-06 22:51 Kyle Milz
  0 siblings, 0 replies; only message in thread
From: Kyle Milz @ 2021-11-06 22:51 UTC (permalink / raw)
  To: 9front

[-- Attachment #1: sysinfo_options_table.diff --]
[-- Type: text/plain, Size: 1632 bytes --]


diff below modifies the sysinfo(1) manual to use .TP tag paragraphs
for its options descriptions. it also modifies the descriptions
slightly, attempting imperative mood.

also while here use the .BI macro for the option that takes a parameter.
this makes no difference when viewing the manual on the terminal,
but does have a difference in, say,  proof mode. i think this better
conveys that the parameter is a variable, and not, say, a literal.

the quote character in .BI is necessary otherwise no whitespace
is left between the option and its parameter in terminal viewing mode.


diff cd7480f68f3496b84ae25f916c2d700fc5afb42f uncommitted
--- a/sys/man/1/sysinfo
+++ b/sys/man/1/sysinfo
@@ -4,7 +4,7 @@
 .B sysinfo
-.B -e e-mail
+.BI -e " e-mail
 .B -p
@@ -16,22 +16,24 @@
 executes a number of commands that report information
 about the hardware and software configuration of
 the running system, concatenating the output to
+stdout. Its options are:
 .B -p
-flag causes the output to be posted at a website
+Post output to a website archive,
 .B http://sysinfo.9front.org,
 which in turn forwards the message to a
 mailing list,
 .B 9front-sysinfo@9front.org.
 A URL pointing to the archived output is returned.
-.B -e
-flag causes a reply-to e-mail address to be included
-in the message (the e-mail address is not divulged
+.BI -e " e-mail
+Include a reply-to
+.I e-mail
+address in the message (the
+.I e-mail
+address is not divulged
 to the mailing list).
 These flags are useful for reporting new installs to the
 development team.

^ permalink raw reply	[flat|nested] only message in thread

only message in thread, other threads:[~2021-11-06 23:07 UTC | newest]

Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-11-06 22:51 [9front] sysinfo(1): use tag paragraph for option descriptions Kyle Milz

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).