Mark up command strings with Cm, and variables with Va.

ok jmc@

4 files changed, 62 insertions, 55 deletions

diff --git a/usr.sbin/pkg_add/pkg_add.1 b/usr.sbin/pkg_add/pkg_add.1
index 85b3b806b9c..d85cfa19a48 100644
--- a/usr.sbin/pkg_add/pkg_add.1
+++ b/usr.sbin/pkg_add/pkg_add.1
@@ -1,4 +1,4 @@
-.\"	$OpenBSD: pkg_add.1,v 1.152 2017/10/10 15:38:26 espie Exp $
+.\"	$OpenBSD: pkg_add.1,v 1.153 2018/01/08 05:42:48 bentley Exp $
 .\"
 .\" Documentation and design originally from FreeBSD. All the code has
 .\" been rewritten since. We keep the documentation's notice:
@@ -15,7 +15,7 @@
 .\" Jordan K. Hubbard
 .\"
 .\"
-.Dd $Mdocdate: October 10 2017 $
+.Dd $Mdocdate: January 8 2018 $
 .Dt PKG_ADD 1
 .Os
 .Sh NAME
@@ -55,7 +55,7 @@ rejects unsigned packages unless they come from a trusted source
 .Ev TRUSTED_PKG_PATH
 .Pc
 or option
-.Fl D Ar unsigned
+.Fl D Cm unsigned
 is used.
 .Pp
 If a package is digitally signed:
@@ -301,41 +301,41 @@ should be waived.
 Recognized keywords include:
 .Pp
 .Bl -tag -width "updatedependsXX" -compact
-.It Ar allversions
+.It Cm allversions
 Do not trim older p* variants of packages for updates.
-.It Ar arch
+.It Cm arch
 Architecture recorded in package may not match.
-.It Ar checksum
+.It Cm checksum
 Verify checksums before deleting or tying old files.
-.It Ar dontmerge
+.It Cm dontmerge
 By default, if dependencies are too strict,
 .Nm
 will merge updates together to make sure everything stays in sync.
-.Fl D Ns Ar dontmerge
+.Fl D Ns Cm dontmerge
 disables that behavior.
-.It Ar donttie
+.It Cm donttie
 By default,
 .Nm
 will try to find new files in old packages by comparing the stored sha256,
 and tie the entries together to avoid extracting files needlessly.
-.Fl D Ns Ar donttie
+.Fl D Ns Cm donttie
 disables that behavior.
-.It Ar downgrade
+.It Cm downgrade
 Don't filter out package versions older than what's currently installed.
-.It Ar installed
+.It Cm installed
 In update mode, reinstall an existing package with the same update signature.
-.It Ar libdepends
+.It Cm libdepends
 Library specifications may not be fulfilled.
-.It Ar nonroot
+.It Cm nonroot
 Install even if not running as root.
-.It Ar paranoid
+.It Cm paranoid
 Very safe update: don't run any @exec/@unexec.
 This may break some packages that will need manual intervention.
-.It Ar repair
+.It Cm repair
 Attempt to repair installed packages with missing registration data.
-.It Ar scripts
+.It Cm scripts
 External scripts may fail.
-.It Ar SIGNER
+.It Cm SIGNER
 List of trusted signers, separated by commas.
 Corresponds to list of public keys under
 .Pa /etc/signify
@@ -345,7 +345,7 @@ Defaults to any key matching
 for packages, and any key matching
 .Sq *fw
 for firmware.
-.It Ar snap
+.It Cm snap
 Force
 .Sq %c
 and
@@ -353,12 +353,12 @@ and
 to expand to
 .Sq snapshots ,
 even on a release kernel.
-.It Ar unsigned
+.It Cm unsigned
 Allow the installation of unsigned packages without warnings/errors
 (necessary for
 .Xr ports 7 ,
 automatically set by the build infrastructure).
-.It Ar updatedepends
+.It Cm updatedepends
 Force update even if forward dependencies no longer match.
 .El
 .It Fl I
@@ -435,7 +435,7 @@ will refuse to replace packages as soon as it needs to run scripts that
 might fail
 .Po
 use
-.Fl D Ar update
+.Fl D Cm update
 to force the replacement
 .Pc ;
 .Nm
@@ -443,7 +443,7 @@ will also refuse to replace packages when the dependencies don't quite
 match
 .Po
 use
-.Fl D Ar updatedepends
+.Fl D Cm updatedepends
 to force the replacement
 .Pc .
 .It Fl s
@@ -655,7 +655,9 @@ A check is made to determine if a similar package is already installed.
 If so, its full update signature is computed, which contains all the
 necessary dependency information along with the actual package version.
 If that signature is identical to that of the new package, no replacement
-is performed (unless -D installed is specified).
+is performed (unless
+.Fl D Cm installed
+is specified).
 .It
 A check is made to determine what old package(s) the new package(s) should
 replace, using conflicts.
@@ -671,8 +673,11 @@ update to those packages.
 .It
 A check is made to determine whether the old packages will be deleted without
 issue, and whether the new packages will install correctly.
-This includes refusing to run any code (unless -D update), and verifying
-that the new package still matches dependencies (unless -D updatedepends).
+This includes refusing to run any code (unless
+.Fl D Cm update ) ,
+and verifying
+that the new package still matches dependencies (unless
+.Fl D Cm updatedepends ) .
 .It
 Shared libraries deserve special treatment: each shared library from the old
 packages that does no longer exist in the new packages, but that is required
@@ -719,7 +724,9 @@ package first, which may contain exceptions to these rules.
 This special package contains global information, such as packages that
 can be deleted because they're now part of base, or stem changes.
 .It
-Version matching occurs: unless -D downgrade, only packages with newer
+Version matching occurs: unless
+.Fl D Cm downgrade ,
+only packages with newer
 versions will be considered as update candidates.
 Note that version matching is costly, thus
 .Ev PKG_PATH
@@ -774,7 +781,7 @@ If set, any package retrieved from a distant location will be copied to
 that directory as well.
 .It Ev PKG_CHECKSUM
 If set, verify files checksums during deletion, exactly like
-.Fl D Ns Ar checksum .
+.Fl D Ns Cm checksum .
 .It Ev PKG_DBDIR
 Where to register packages instead of
 .Pa /var/db/pkg .
diff --git a/usr.sbin/pkg_add/pkg_check.8 b/usr.sbin/pkg_add/pkg_check.8
index ff29cb3bee0..b33fe5dbd8c 100644
--- a/usr.sbin/pkg_add/pkg_check.8
+++ b/usr.sbin/pkg_add/pkg_check.8
@@ -1,4 +1,4 @@
-.\"	$OpenBSD: pkg_check.8,v 1.9 2017/02/15 13:19:08 jmc Exp $
+.\"	$OpenBSD: pkg_check.8,v 1.10 2018/01/08 05:42:48 bentley Exp $
 .\"
 .\" Copyright (c) 2010 Marc Espie <espie@openbsd.org>
 .\"
@@ -14,7 +14,7 @@
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"
-.Dd $Mdocdate: February 15 2017 $
+.Dd $Mdocdate: January 8 2018 $
 .Dt PKG_CHECK 8
 .Os
 .Sh NAME
@@ -81,7 +81,7 @@ The options are as follows:
 Extra options.
 Recognized keywords include:
 .Bl -tag -width "nosigXXX"
-.It Ar nosig
+.It Cm nosig
 Do not check digital signatures.
 .El
 .It Fl F
diff --git a/usr.sbin/pkg_add/pkg_create.1 b/usr.sbin/pkg_add/pkg_create.1
index 69234e5d272..45e9595500a 100644
--- a/usr.sbin/pkg_add/pkg_create.1
+++ b/usr.sbin/pkg_add/pkg_create.1
@@ -1,4 +1,4 @@
-.\"	$OpenBSD: pkg_create.1,v 1.107 2017/09/18 14:10:11 espie Exp $
+.\"	$OpenBSD: pkg_create.1,v 1.108 2018/01/08 05:42:48 bentley Exp $
 .\"
 .\" Documentation and design originally from FreeBSD. All the code has
 .\" been rewritten since. We keep the documentation's notice:
@@ -21,7 +21,7 @@
 .\" [jkh] Took John's changes back and made some additional extensions for
 .\" better integration with FreeBSD's new ports collection.
 .\"
-.Dd $Mdocdate: September 18 2017 $
+.Dd $Mdocdate: January 8 2018 $
 .Dt PKG_CREATE 1
 .Os
 .Sh NAME
@@ -128,26 +128,26 @@ have extra meaning, see
 for details:
 .Pp
 .Bl -tag -width FULLPKGPATH -compact
-.It Ar CDROM
+.It Cm CDROM
 Set to the port's Makefile
-.Ar PERMIT_PACKAGE_CDROM .
-.It Ar COMMENT
+.Va PERMIT_PACKAGE_CDROM .
+.It Cm COMMENT
 Set package
 .Dq one line description
 (mandatory).
-.It Ar HISTORY_DIR
+.It Cm HISTORY_DIR
 Record checksums of files in permanent location
 .Pa ${HISTORY_DIR}/${FULLPKGPATH:S,/,./g} .
-.It Ar FTP
+.It Cm FTP
 Set to the port's Makefile
-.Ar PERMIT_PACKAGE_FTP .
-.It Ar FULLPKGPATH
+.Va PERMIT_PACKAGE_FTP .
+.It Cm FULLPKGPATH
 Strongly recommended, otherwise updates won't work.
-.It Ar HOMEPAGE
+.It Cm HOMEPAGE
 If defined, appended to the description.
-.It Ar MAINTAINER
+.It Cm MAINTAINER
 If defined, appended to the description.
-.It Ar USE_GROFF
+.It Cm USE_GROFF
 Set to 1 to have groff format manpages behind the scenes during
 package creation.
 .El
@@ -330,7 +330,7 @@ Can also be used to comment out elements that update-plist
 will insist in inserting in a packing-list.
 .Pp
 The special comment
-.Cm @comment Ar "no checksum"
+.Cm @comment no checksum
 can be used to tag the next file as special: even though its characteristics
 will be recorded in the package, it can be altered after installation, and
 .Xr pkg_delete 1
@@ -599,21 +599,21 @@ Effects vary depending on
 .Ar name .
 These are the user settable options
 .Bl -tag -width indent
-.It Ar always-update
+.It Cm always-update
 By default,
 .Xr pkg_add 1
 uses some simplified information to decide whether an installed package
 needs updating.
 With this option, the package is updated whenever anything changes.
 To be used sparingly, as this is more expensive.
-.It Ar is-branch
+.It Cm is-branch
 Annotate the few rare ports where several branches are present in the
 ports tree (such as autoconf), to help
 .Xr pkg_info 1
 produce
 .Ar stem Ns % Ns Ar branch
 annotations when needed.
-.It Ar no-default-conflict
+.It Cm no-default-conflict
 By default, a package conflicts with other versions of the same package.
 With this option, the older package version will still be noticed, but the
 installation will proceed anyway.
diff --git a/usr.sbin/pkg_add/pkg_delete.1 b/usr.sbin/pkg_add/pkg_delete.1
index 8fd962eff09..0903e0a578f 100644
--- a/usr.sbin/pkg_add/pkg_delete.1
+++ b/usr.sbin/pkg_add/pkg_delete.1
@@ -1,4 +1,4 @@
-.\"	$OpenBSD: pkg_delete.1,v 1.57 2017/03/25 19:53:33 espie Exp $
+.\"	$OpenBSD: pkg_delete.1,v 1.58 2018/01/08 05:42:48 bentley Exp $
 .\"
 .\" Documentation and design originally from FreeBSD. All the code has
 .\" been rewritten since. We keep the documentation's notice:
@@ -15,7 +15,7 @@
 .\" Jordan K. Hubbard
 .\"
 .\"
-.Dd $Mdocdate: March 25 2017 $
+.Dd $Mdocdate: January 8 2018 $
 .Dt PKG_DELETE 1
 .Os
 .Sh NAME
@@ -108,15 +108,15 @@ should be waived.
 Recognized keywords include:
 .Pp
 .Bl -tag -width "dependenciesXX" -compact
-.It Ar baddepend
+.It Cm baddepend
 Force the deletion of packages even if they reference nonexistent dependencies.
-.It Ar checksum
+.It Cm checksum
 Verify checksums before deleting files.
-.It Ar dependencies
+.It Cm dependencies
 Also delete the whole set of packages that depends upon the requested packages.
-.It Ar nonroot
+.It Cm nonroot
 Uninstall even if not running as root.
-.It Ar scripts
+.It Cm scripts
 External scripts may fail.
 .El
 .It Fl I
@@ -187,7 +187,7 @@ will list those dependent packages and refuse to delete the package.
 .Bl -tag -width PKG_CHECKSUM
 .It Ev PKG_CHECKSUM
 If set, verify files checksums during deletion, exactly like
-.Fl D Ns Ar checksum .
+.Fl D Ns Cm checksum .
 .It Ev PKG_DBDIR
 Where to look for installed packages instead of
 .Pa /var/db/pkg .