Here it goes. Hope this time it doesn't get mangled. Note that in the
case of the of pkg_signify.1, I kept the '-compact' removed, since there
are only two lines in there and it helps the reading by separating.
Please let me know if this time it goes well.
Best Regards,
Salvador Sabaini
Index: pkg_add.1
===================================================================
RCS file: /cvs/src/usr.sbin/pkg_add/pkg_add.1,v
retrieving revision 1.140
diff -u -p -r1.140 pkg_add.1
--- pkg_add.1 1 Jan 2017 01:08:11 -0000 1.140
+++ pkg_add.1 14 Feb 2017 19:37:51 -0000
@@ -297,41 +297,41 @@ Recognized keywords include:
.Pp
.Bl -tag -width "updatedependsXX" -compact
.It Ar allversions
-do not trim older p* variants of packages for updates.
+Do not trim older p* variants of packages for updates.
.It Ar arch
-architecture recorded in package may not match.
+Architecture recorded in package may not match.
.It Ar dontmerge
-by default, if dependencies are too strict,
+By default, if dependencies are too strict,
.Nm
will merge updates together to make sure everything stays in sync.
.Fl D Ar dontmerge
disables that behavior.
.It Ar donttie
-by default,
+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 Ar donttie
disables that behavior.
.It Ar downgrade
-don't filter out package versions older than what's currently installed.
+Don't filter out package versions older than what's currently installed.
.It Ar installed
-in update mode, reinstall an existing package with the same update
signature.
+In update mode, reinstall an existing package with the same update
signature.
.It Ar libdepends
-library specifications may not be fulfilled.
+Library specifications may not be fulfilled.
.It Ar nonroot
-install even if not running as root.
+Install even if not running as root.
.\" .It Ar nosig
.\" do not check digital signatures.
.\" Still displays a very prominent message if a signature is found.
.It Ar paranoid
-very safe update: don't run any @exec/@unexec.
+Very safe update: don't run any @exec/@unexec.
.It Ar repair
-attempt to repair installed packages with missing registration data.
+Attempt to repair installed packages with missing registration data.
.It Ar scripts
-external scripts may fail.
+External scripts may fail.
.It Ar SIGNER
-list of trusted signers, separated by commas.
+List of trusted signers, separated by commas.
Corresponds to list of public keys under
.Pa /etc/signify
we want to trust.
@@ -341,12 +341,12 @@ for packages, and any key matching
.Sq *fw
for firmware.
.It Ar unsigned
-allow the installation of unsigned packages without warnings/errors
+Allow the installation of unsigned packages without warnings/errors
(necessary for
.Xr ports 7 ,
automatically set by the build infrastructure).
.It Ar updatedepends
-force update even if forward dependencies no longer match.
+Force update even if forward dependencies no longer match.
.El
.It Fl I
Force non-interactive mode.
Index: pkg_check.8
===================================================================
RCS file: /cvs/src/usr.sbin/pkg_add/pkg_check.8,v
retrieving revision 1.8
diff -u -p -r1.8 pkg_check.8
--- pkg_check.8 25 Aug 2016 16:27:16 -0000 1.8
+++ pkg_check.8 14 Feb 2017 19:37:51 -0000
@@ -83,7 +83,7 @@ Recognized keywords include:
.Pp
.Bl -tag -width "nosigXXX" -compact
.It Ar nosig
-do not check digital signatures.
+Do not check digital signatures.
.El
.It Fl F
Check the filesystem for random objects.
Index: pkg_delete.1
===================================================================
RCS file: /cvs/src/usr.sbin/pkg_add/pkg_delete.1,v
retrieving revision 1.52
diff -u -p -r1.52 pkg_delete.1
--- pkg_delete.1 14 Jun 2016 17:09:25 -0000 1.52
+++ pkg_delete.1 14 Feb 2017 19:37:52 -0000
@@ -113,15 +113,15 @@ Force removal of the package.
is a keyword that states what failsafe
should be waived.
Recognized keywords include:
-.Bl -tag -width "dependenciesXX"
+.Bl -tag -width "dependenciesXX" -compact
.It Ar baddepend
-force the deletion of packages even if they reference nonexistent
dependencies.
+Force the deletion of packages even if they reference nonexistent
dependencies.
.It Ar dependencies
-also delete the whole set of packages that depends upon the requested
packages.
+Also delete the whole set of packages that depends upon the requested
packages.
.It Ar nonroot
-uninstall even if not running as root.
+Uninstall even if not running as root.
.It Ar scripts
-external scripts may fail.
+External scripts may fail.
.El
.It Fl I
Force non-interactive mode.
Index: pkg_sign.1
===================================================================
RCS file: /cvs/src/usr.sbin/pkg_add/pkg_sign.1,v
retrieving revision 1.9
diff -u -p -r1.9 pkg_sign.1
--- pkg_sign.1 3 Oct 2016 13:11:38 -0000 1.9
+++ pkg_sign.1 14 Feb 2017 19:37:52 -0000
@@ -84,15 +84,15 @@ Source repository for packages to be sig
.Xc
Specify signature parameters for signed packages.
Option parameters are as follows:
-.Bl -tag -width signify2 -compact
+.Bl -tag -width signify2
.It Cm signify2
-choose
+Choose
.Xr signify 1
new style signatures, where the
.Xr gzip 1
compressed data is signed.
.It Ar privkey
-the path to the signer's private key.
+The path to the signer's private key.
For
.Cm signify ,
the private key name is used to set the
On 02/14/17 16:15, Jason McIntyre wrote:
On Mon, Feb 13, 2017 at 12:27:38PM -0300, Salvador Sabaini wrote:
Hello tech@,
These are some minor readability improvements for the
pkg_{add,create,delete,sign,check} man pages. Mostly 'uncompacting' and
adding first capital letters, particularly in the "-D name[=value]" section
of said man pages, to help ease of reading.
Below are the diffs, in case you find them useful.
i agree the text in at least pkg_add(1) runs together too much. having
said that, removing -compact just adds a ton of whitespace, which i'm
not sure is an improvement.
i think just beginning the descriptions with capitals will be a good
compromise. it will make the text easier to read (the point of capital
letters, really) without adding too much empty space.
but... your diff does not apply (i think your mailer is mangling the
lines). if you agree with my comments, i'd take an unmangled diff which
uses capital letters but doesn;t remove -compact.
jmc
Best Regards,
Salvador Sabaini
Index: pkg_add.1
===================================================================
RCS file: /cvs/src/usr.sbin/pkg_add/pkg_add.1,v
retrieving revision 1.140
diff -u -p -r1.140 pkg_add.1
--- pkg_add.1 1 Jan 2017 01:08:11 -0000 1.140
+++ pkg_add.1 13 Feb 2017 14:55:21 -0000
@@ -295,43 +295,43 @@ is a keyword that states what failsafe
should be waived.
Recognized keywords include:
.Pp
-.Bl -tag -width "updatedependsXX" -compact
+.Bl -tag -width "updatedependsXX"
.It Ar allversions
-do not trim older p* variants of packages for updates.
+Do not trim older p* variants of packages for updates.
.It Ar arch
-architecture recorded in package may not match.
+Architecture recorded in package may not match.
.It Ar dontmerge
-by default, if dependencies are too strict,
+By default, if dependencies are too strict,
.Nm
will merge updates together to make sure everything stays in sync.
.Fl D Ar dontmerge
-disables that behavior.
+Disables that behavior.
.It Ar donttie
-by default,
+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 Ar donttie
-disables that behavior.
+Disables that behavior.
.It Ar downgrade
-don't filter out package versions older than what's currently installed.
+Don't filter out package versions older than what's currently installed.
.It Ar installed
-in update mode, reinstall an existing package with the same update
signature.
+In update mode, reinstall an existing package with the same update
signature.
.It Ar libdepends
-library specifications may not be fulfilled.
+Library specifications may not be fulfilled.
.It Ar nonroot
-install even if not running as root.
+Install even if not running as root.
.\" .It Ar nosig
.\" do not check digital signatures.
.\" Still displays a very prominent message if a signature is found.
.It Ar paranoid
-very safe update: don't run any @exec/@unexec.
+Very safe update: don't run any @exec/@unexec.
.It Ar repair
-attempt to repair installed packages with missing registration data.
+Attempt to repair installed packages with missing registration data.
.It Ar scripts
-external scripts may fail.
+External scripts may fail.
.It Ar SIGNER
-list of trusted signers, separated by commas.
+List of trusted signers, separated by commas.
Corresponds to list of public keys under
.Pa /etc/signify
we want to trust.
@@ -341,12 +341,12 @@ for packages, and any key matching
.Sq *fw
for firmware.
.It Ar unsigned
-allow the installation of unsigned packages without warnings/errors
+Allow the installation of unsigned packages without warnings/errors
(necessary for
.Xr ports 7 ,
automatically set by the build infrastructure).
.It Ar updatedepends
-force update even if forward dependencies no longer match.
+Force update even if forward dependencies no longer match.
.El
.It Fl I
Force non-interactive mode.
Index: pkg_check.8
===================================================================
RCS file: /cvs/src/usr.sbin/pkg_add/pkg_check.8,v
retrieving revision 1.8
diff -u -p -r1.8 pkg_check.8
--- pkg_check.8 25 Aug 2016 16:27:16 -0000 1.8
+++ pkg_check.8 13 Feb 2017 14:55:21 -0000
@@ -81,9 +81,9 @@ The options are as follows:
Extra options.
Recognized keywords include:
.Pp
-.Bl -tag -width "nosigXXX" -compact
+.Bl -tag -width "nosigXXX"
.It Ar nosig
-do not check digital signatures.
+Do not check digital signatures.
.El
.It Fl F
Check the filesystem for random objects.
Index: pkg_create.1
===================================================================
RCS file: /cvs/src/usr.sbin/pkg_add/pkg_create.1,v
retrieving revision 1.103
diff -u -p -r1.103 pkg_create.1
--- pkg_create.1 6 Sep 2016 10:41:51 -0000 1.103
+++ pkg_create.1 13 Feb 2017 14:55:21 -0000
@@ -126,7 +126,7 @@ have extra meaning, see
.Xr bsd.port.mk 5
for details:
.Pp
-.Bl -tag -width FULLPKGPATH -compact
+.Bl -tag -width FULLPKGPATH
.It Ar CDROM
Set to the port's Makefile
.Ar PERMIT_PACKAGE_CDROM .
Index: pkg_delete.1
===================================================================
RCS file: /cvs/src/usr.sbin/pkg_add/pkg_delete.1,v
retrieving revision 1.52
diff -u -p -r1.52 pkg_delete.1
--- pkg_delete.1 14 Jun 2016 17:09:25 -0000 1.52
+++ pkg_delete.1 13 Feb 2017 14:55:21 -0000
@@ -115,13 +115,13 @@ should be waived.
Recognized keywords include:
.Bl -tag -width "dependenciesXX"
.It Ar baddepend
-force the deletion of packages even if they reference nonexistent
dependencies.
+Force the deletion of packages even if they reference nonexistent
dependencies.
.It Ar dependencies
-also delete the whole set of packages that depends upon the requested
packages.
+Also delete the whole set of packages that depends upon the requested
packages.
.It Ar nonroot
-uninstall even if not running as root.
+Uninstall even if not running as root.
.It Ar scripts
-external scripts may fail.
+External scripts may fail.
.El
.It Fl I
Force non-interactive mode.
Index: pkg_sign.1
===================================================================
RCS file: /cvs/src/usr.sbin/pkg_add/pkg_sign.1,v
retrieving revision 1.9
diff -u -p -r1.9 pkg_sign.1
--- pkg_sign.1 3 Oct 2016 13:11:38 -0000 1.9
+++ pkg_sign.1 13 Feb 2017 14:55:21 -0000
@@ -84,15 +84,15 @@ Source repository for packages to be sig
.Xc
Specify signature parameters for signed packages.
Option parameters are as follows:
-.Bl -tag -width signify2 -compact
+.Bl -tag -width signify2
.It Cm signify2
-choose
+Choose
.Xr signify 1
new style signatures, where the
.Xr gzip 1
compressed data is signed.
.It Ar privkey
-the path to the signer's private key.
+The path to the signer's private key.
For
.Cm signify ,
the private key name is used to set the
