From mboxrd@z Thu Jan  1 00:00:00 1970
X-Spam-Checker-Version: SpamAssassin 3.4.4 (2020-01-24) on inbox.vuxu.org
X-Spam-Level: 
X-Spam-Status: No, score=0.2 required=5.0 tests=DKIM_ADSP_CUSTOM_MED,
	DKIM_INVALID,DKIM_SIGNED,FREEMAIL_FROM autolearn=no autolearn_force=no
	version=3.4.4
Received: (qmail 3549 invoked from network); 6 Nov 2021 23:07:20 -0000
Received: from 4ess.inri.net (216.126.196.42)
  by inbox.vuxu.org with ESMTPUTF8; 6 Nov 2021 23:07:20 -0000
Received: from mail-oi1-f177.google.com ([209.85.167.177]) by 4ess; Sat Nov  6 19:00:00 -0400 2021
Received: by mail-oi1-f177.google.com with SMTP id y11so20973348oih.7
        for <9front@9front.org>; Sat, 06 Nov 2021 15:59:52 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
        d=gmail.com; s=20210112;
        h=date:from:to:subject:message-id:mime-version:content-disposition;
        bh=a8kdgCmC78EUhNJYOmgMAza3m9IMUG+7bt3vHGLc90o=;
        b=Gygqi03UKkp2bUQXb4h4rTsJSfI9NHaiE0aC3jrc0YtIG8uupQ+BX0RjoAY8057tdh
         sWeRENxoeTRSFkRbBFRSl5rcIUKyqIZHvip5eZ6F4524Y10Ak5Z/9Dr/eUmCPnkjtDbc
         fS5WC5kmQNWjMw+CNi7pCaAtNvsGLvXC4zH30jFG/sa6pdEdZqfA1kp6xrsIFWqoN5+A
         6B5KfPvkXfP7MZxXCk0zbHLfs8OZfzQ1CVfzcay/g4ndHBdivEESYaYWqK2B5UDjaJ/m
         Gy0qUNjtvta60hvefMGHUyYEtyPIcxf78vpR3RMUBcl4R+tFRLoXTbI0ThSK1N3YXR+f
         BOpg==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
        d=1e100.net; s=20210112;
        h=x-gm-message-state:date:from:to:subject:message-id:mime-version
         :content-disposition;
        bh=a8kdgCmC78EUhNJYOmgMAza3m9IMUG+7bt3vHGLc90o=;
        b=FNDZIQnFxWG1Yif/j0/amutQi4EXa/RzuIqBD7DDuHPR+3gwZm5dteMmu5qxWqGcaM
         V5y+VZJ2UxflPUhNzZk1YJ7IEQgV/8PTX5qDbNLgfxJ83+vZNioi/y2BWCsSCRyUr1/1
         xbdpPZmiAoKRqjpj/H/pQez9udjRMvHNpAfdRqvB0VAyCc6Fs/q6e53XRLlup39grPSH
         9e7L5lDfowehdrI5pnaddn4NiyNfzEFb/LhL1DAAkMTr5l15NhomSD6+nEqGoTRt98/P
         3kVqurDjLtsMRBVkuLTnXFg7neCxX8xcUt4bCbAdJ5dRQVy4Utfdev0xszABTg52iN8/
         E7Ig==
X-Gm-Message-State: AOAM5302+FGt6e0z5azZdduVyjgJhSZnWUstjEXHKpHg6ZwF+fPoUSMm
	6M5bwfT22plPk89IHMwyFh9lanfpmA8=
X-Google-Smtp-Source: ABdhPJwyG7WCMpam9asQzvKmsdooW2GM/zZ0ibvbcr0UNezqCEKbC5KJEBd5LKW4hlrw5065qrNrOg==
X-Received: by 2002:a17:90a:4d0c:: with SMTP id c12mr1827274pjg.151.1636239097214;
        Sat, 06 Nov 2021 15:51:37 -0700 (PDT)
Return-Path: <krwmilz@gmail.com>
Received: from imac.0x30.net (d205-250-121-157.bchsia.telus.net. [205.250.121.157])
        by smtp.gmail.com with ESMTPSA id l21sm11055835pfu.213.2021.11.06.15.51.36
        for <9front@9front.org>
        (version=TLS1_3 cipher=TLS_CHACHA20_POLY1305_SHA256 bits=256/256);
        Sat, 06 Nov 2021 15:51:36 -0700 (PDT)
Date: Sat, 6 Nov 2021 15:51:34 -0700
From: Kyle Milz <krwmilz@gmail.com>
To: 9front@9front.org
Message-ID: <YYcG9mudyLNoGnG3@imac.0x30.net>
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline; filename="sysinfo_options_table.diff"
List-ID: <9front.9front.org>
List-Help: <http://lists.9front.org>
X-Glyph: ➈
X-Bullshit: persistence rich-client optimizer 
Subject: [9front] sysinfo(1): use tag paragraph for option descriptions
Reply-To: 9front@9front.org
Precedence: bulk

hi,

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.


kyle

diff cd7480f68f3496b84ae25f916c2d700fc5afb42f uncommitted
--- a/sys/man/1/sysinfo
+++ b/sys/man/1/sysinfo
@@ -4,7 +4,7 @@
 .SH SYNOPSIS
 .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.
-.PP
-The
+stdout. Its options are:
+.TP
 .B -p
-flag causes the output to be posted at a website
-archive,
+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.
-The
-.B -e
-flag causes a reply-to e-mail address to be included
-in the message (the e-mail address is not divulged
+.TP
+.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).
+.PP
 These flags are useful for reporting new installs to the
 development team.
 .PP