[123948] trunk/base/doc

cal at macports.org cal at macports.org
Sat Aug 16 06:45:03 PDT 2014 

Revision: 123948
          https://trac.macports.org/changeset/123948
Author:   cal at macports.org
Date:     2014-08-16 06:45:03 -0700 (Sat, 16 Aug 2014)
Log Message:
-----------
base: unify formatting in manpages

 - all options are printed in bold
 - 'Portfile' is always underlined
 - fix list in port-lint.1

Modified Paths:
--------------
    trunk/base/doc/port-activate.1.txt
    trunk/base/doc/port-archivefetch.1.txt
    trunk/base/doc/port-contents.1.txt
    trunk/base/doc/port-dir.1.txt
    trunk/base/doc/port-distcheck.1.txt
    trunk/base/doc/port-dmg.1.txt
    trunk/base/doc/port-edit.1.txt
    trunk/base/doc/port-info.1.txt
    trunk/base/doc/port-installed.1.txt
    trunk/base/doc/port-lint.1.txt
    trunk/base/doc/port-rev-upgrade.1.txt
    trunk/base/doc/port-selfupdate.1.txt
    trunk/base/doc/port-uninstall.1.txt

Modified: trunk/base/doc/port-activate.1.txt
===================================================================
--- trunk/base/doc/port-activate.1.txt	2014-08-16 13:38:31 UTC (rev 123947)
+++ trunk/base/doc/port-activate.1.txt	2014-08-16 13:45:03 UTC (rev 123948)
@@ -38,7 +38,7 @@
 OPTIONS
 -------
 
---no-exec::
+*--no-exec*::
     Do not execute any stored pre- or post-uninstall procedures.
 
 

Modified: trunk/base/doc/port-archivefetch.1.txt
===================================================================
--- trunk/base/doc/port-archivefetch.1.txt	2014-08-16 13:38:31 UTC (rev 123947)
+++ trunk/base/doc/port-archivefetch.1.txt	2014-08-16 13:45:03 UTC (rev 123948)
@@ -32,7 +32,7 @@
 
 include::global-flags.txt[]
 
--p::
+*-p*::
     Proceed even if a port fails to fetch. This is useful if you are trying to
     download all available binary images for a number of ports, e.g., if you
     want to install them later without a network connection.

Modified: trunk/base/doc/port-contents.1.txt
===================================================================
--- trunk/base/doc/port-contents.1.txt	2014-08-16 13:38:31 UTC (rev 123947)
+++ trunk/base/doc/port-contents.1.txt	2014-08-16 13:45:03 UTC (rev 123948)
@@ -29,39 +29,39 @@
 OPTIONS
 -------
 
---size::
+*--size*::
     Enable printing a human-readable representation of the files' sizes. The
     size output can be adjusted using the *--units 'unit'* flag.
 
---units 'unit'::
+*--units 'unit'*::
     Used in conjunction with *--size* to choose the unit in which the size is
     given. Valid values for 'unit' are
 
-    B:::
+    *B*:::
         List sizes in bytes.
 
-    K, Ki, or KiB:::
+    *K*, *Ki*, *KiB*:::
         List sizes in KiB, i.e., 1024 bytes.
 
-    Mi, or MiB:::
+    *Mi*, *MiB*:::
         List sizes in MiB, i.e., 1024 * 1024 bytes.
 
-    Gi, or GiB:::
+    *Gi*, *GiB*:::
         List sizes in GiB, i.e., 1024 * 1024 * 1024 bytes.
 
-    k, or kB:::
+    *k*, *kB*:::
         List sizes in kB, i.e., 1000 bytes.
 
-    M, or MB:::
+    *M*, *MB*:::
         List sizes in MB, i.e., 1000 * 1000 bytes.
 
-    G, or GB:::
+    *G*, *GB*:::
         List sizes in GB, i.e., 1000 * 1000 * 1000 bytes.
 
 
 include::global-flags.txt[]
 
--q::
+*-q*::
     Do not print the header line.
 
 

Modified: trunk/base/doc/port-dir.1.txt
===================================================================
--- trunk/base/doc/port-dir.1.txt	2014-08-16 13:38:31 UTC (rev 123947)
+++ trunk/base/doc/port-dir.1.txt	2014-08-16 13:45:03 UTC (rev 123948)
@@ -35,9 +35,9 @@
 These commands print a path for each given port. The meaning of the path
 differs by the command given:
 
-*port dir* prints the directory that contains the Portfile for the given port
+*port dir* prints the directory that contains the 'Portfile' for the given port
 expression. This can be quite handy in your shell, if you want to locate
-a Portfile:
+a 'Portfile':
 
 ----
 cd $(port dir <portname>)
@@ -46,9 +46,9 @@
 *port url* prints a unique URL for the given port expression. This command
 mostly exists for historical reasons and isn't of much use nowadays.
 
-*port file* prints the path of the Portfile for the given port expression. This
-can be useful to locate a port's definition. Note that you can always get this
-by using *port dir* and appending 'Portfile'. You could use *port file* in
+*port file* prints the path of the 'Portfile' for the given port expression.
+This can be useful to locate a port's definition. Note that you can always get
+this by using *port dir* and appending 'Portfile'. You could use *port file* in
 a shell to edit a Portfile, but note that you can also use man:port-edit[1] to
 achieve the same.
 

Modified: trunk/base/doc/port-distcheck.1.txt
===================================================================
--- trunk/base/doc/port-distcheck.1.txt	2014-08-16 13:38:31 UTC (rev 123947)
+++ trunk/base/doc/port-distcheck.1.txt	2014-08-16 13:45:03 UTC (rev 123948)
@@ -18,17 +18,17 @@
 *port distcheck* downloads all source files for a given port from all available
 mirrors (including MacPorts' mirror infrastructure) and checks that the
 modification date of the file on the mirror is not more recent than the
-modification date of the Portfile.
+modification date of the 'Portfile'.
 
 Distcheck can be switched to verify the file size of the downloaded files
-instead by setting the 'distcheck.type' option to 'filesize' in the Portfile for
-the tested port.
+instead by setting the 'distcheck.type' option to 'filesize' in the 'Portfile'
+for the tested port.
 
 BUGS
 ----
 *port distcheck* should not rely on timestamps or file sizes but use the
-checksums available in the Portfile to verify the integrity of the files on the
-mirrors instead. See man:port-checksum[1].
+checksums available in the 'Portfile' to verify the integrity of the files on
+the mirrors instead. See man:port-checksum[1].
 
 Meanwhile, you can use source:contrib/port-checkmirrors[port-checkmirrors] from
 contrib to do that.

Modified: trunk/base/doc/port-dmg.1.txt
===================================================================
--- trunk/base/doc/port-dmg.1.txt	2014-08-16 13:38:31 UTC (rev 123947)
+++ trunk/base/doc/port-dmg.1.txt	2014-08-16 13:45:03 UTC (rev 123948)
@@ -42,7 +42,7 @@
 suitable for standalone redistribution. *port mdmg* wraps this .mpkg package in
 a disk image.
 
-On OS X 10.6 and later, the generated installer packages are in "flat" format,
+On OS X 10.6 and later, the generated installer packages are in ``flat'' format,
 such that wrapping them in a disk image is no longer necessary for online
 redistribution. Prior to OS X 10.6, generated installer packages could not be
 used for online distribution without a wrapping disk image.

Modified: trunk/base/doc/port-edit.1.txt
===================================================================
--- trunk/base/doc/port-edit.1.txt	2014-08-16 13:38:31 UTC (rev 123947)
+++ trunk/base/doc/port-edit.1.txt	2014-08-16 13:45:03 UTC (rev 123948)
@@ -16,11 +16,11 @@
 
 DESCRIPTION
 -----------
-*port edit* will open the associated Portfile in an editor. It will try to
+*port edit* will open the associated 'Portfile' in an editor. It will try to
 determine your favorite editor by respecting the environment variables *$VISUAL*
 or *$EDITOR* in this order. If none has been set it will fallback to
 '/usr/bin/vi'. Your shell will be blocked until the editor returns. The path to
-the Portfile is passed as one single argument to the editor.
+the 'Portfile' is passed as one single argument to the editor.
 
 If you specify multiple ports, the editor is executed multiple times for
 each of them one after another.

Modified: trunk/base/doc/port-info.1.txt
===================================================================
--- trunk/base/doc/port-info.1.txt	2014-08-16 13:38:31 UTC (rev 123947)
+++ trunk/base/doc/port-info.1.txt	2014-08-16 13:45:03 UTC (rev 123948)
@@ -32,72 +32,72 @@
 The following options do not select fields for the output but change how the
 information is obtained or formatted:
 
---index::
-    Do not read the Portfile, but rely solely on the port index information.
+*--index*::
+    Do not read the 'Portfile', but rely solely on the port index information.
     Note that this option will prevent the information reported from reflecting
     the effects of any variants specified.
 
---line::
+*--line*::
     Print a single line for each port. Fields are separated by spaces.
 
---pretty::
+*--pretty*::
     Format the output in a convenient, human-readable fashion. This is the
     default when no options are specified.
 
 The rest of the options affect which fields will be given in the output:
 
---category, --categories::
+*--category*, *--categories*::
     List the categories of a port.
 
---depends, --depends_fetch, --depends_extract, --depends_build, --depends_lib, --depends_run::
+*--depends*, *--depends_fetch*, *--depends_extract*, *--depends_build*, *--depends_lib*, *--depends_run*::
     List the specified dependencies of a port. *--depends* is a shorthand option
     for all other *--depends_** options.
 
---description, --long_description::
+*--description*, *--long_description*::
     Print the short or long description of a port, respectively.
 
---epoch, --version, --revision::
+*--epoch*, *--version*, *--revision*::
     List the components of a MacPorts version tuple, epoch, version and
     revision, respectively.
 
---fullname::
-    Print name and the full MacPorts version tuple, e.g., "yubico-pam @2.16".
+*--fullname*::
+    Print name and the full MacPorts version tuple, e.g., ``yubico-pam @2.16''.
 
---heading::
+*--heading*::
     Like *--fullname* but including the categories.
 
---homepage::
+*--homepage*::
     List the homepage of a port.
 
---license::
+*--license*::
     Print the license that applies to the source code of a port.
 
---maintainer, --maintainers::
+*--maintainer*, *--maintainers*::
     List the email address(es) of a port's maintainer(s).
 
---name::
+*--name*::
     Print the name of a port.
 
---platform, --platforms::
+*--platform*, *--platforms*::
     List the platforms supported by a port. This field exists for historical
     reasons only. In modern MacPorts, this is always 'darwin', i.e., OS X.
 
---portdir::
+*--portdir*::
     Print the path to a port's directory relative to the port tree root.
 
---replaced_by::
+*--replaced_by*::
     List the name of the port that replaces a port, if any.
 
---subports::
-    Print a list of subports defined by this port's Portfile, i.e., ports that
-    are defined in the same Portfile because they share common parts.
+*--subports*::
+    Print a list of subports defined by this port's 'Portfile', i.e., ports that
+    are defined in the same 'Portfile' because they share common parts.
 
---variant, --variants::
+*--variant*, *--variants*::
     List the variants defined by a port by name.
 
 include::global-flags.txt[]
 
--q::
+*-q*::
     Do not print the field description when using *--pretty* output.
 
 SEE ALSO

Modified: trunk/base/doc/port-installed.1.txt
===================================================================
--- trunk/base/doc/port-installed.1.txt	2014-08-16 13:38:31 UTC (rev 123947)
+++ trunk/base/doc/port-installed.1.txt	2014-08-16 13:45:03 UTC (rev 123948)
@@ -26,11 +26,11 @@
 
 include::global-flags.txt[]
 
--v::
+*-v*::
     Print the platform at install time (i.e., your OS X version) and the
     architecture(s) of the installed port.
 
--q::
+*-q*::
     Do not print the header line. This is useful when parsing the output of
     *port installed* in scripts for further processing.
 

Modified: trunk/base/doc/port-lint.1.txt
===================================================================
--- trunk/base/doc/port-lint.1.txt	2014-08-16 13:38:31 UTC (rev 123947)
+++ trunk/base/doc/port-lint.1.txt	2014-08-16 13:45:03 UTC (rev 123948)
@@ -16,19 +16,20 @@
 
 DESCRIPTION
 -----------
-*port lint* checks the Portfile of a given port for potential errors. It is
+*port lint* checks the 'Portfile' of a given port for potential errors. It is
 a useful tool for port maintainers to check for possible typos, mistakes and
 missing definitions.
 
 For example, it verifies that
- - Portfiles are valid UTF-8
- - all mandatory properties are present
- - all dependencies actually exist, and
- - no deprecated features are used.
 
+ * Portfiles are valid UTF-8
+ * all mandatory properties are present
+ * all dependencies actually exist, and
+ * no deprecated features are used.
+
 If problems are found, *port lint* emits warnings and error messages explaining
 the problem. Please fix all errors and consider fixing any warnings before
-submitting your Portfile or your changes to MacPorts.
+submitting your 'Portfile' or your changes to MacPorts.
 
 OPTIONS
 -------
@@ -42,7 +43,7 @@
     Print messages for successful tests.
 
 *-d*::
-    Print the Portfile, and debugging information parsed from the Portfile.
+    Print the 'Portfile', and debugging information parsed from the 'Portfile'.
 
 *-q*::
     Supress the header line, warning and error count; only print warnings and

Modified: trunk/base/doc/port-rev-upgrade.1.txt
===================================================================
--- trunk/base/doc/port-rev-upgrade.1.txt	2014-08-16 13:38:31 UTC (rev 123947)
+++ trunk/base/doc/port-rev-upgrade.1.txt	2014-08-16 13:45:03 UTC (rev 123948)
@@ -29,7 +29,7 @@
 OPTIONS
 -------
 
---id-loadcmd-check::
+*--id-loadcmd-check*::
     Check the ID load command in each library installed by MacPorts. This load
     command contains a path that should always reference the library itself,
     because the path will be copied into all binaries and libraries that link

Modified: trunk/base/doc/port-selfupdate.1.txt
===================================================================
--- trunk/base/doc/port-selfupdate.1.txt	2014-08-16 13:38:31 UTC (rev 123947)
+++ trunk/base/doc/port-selfupdate.1.txt	2014-08-16 13:45:03 UTC (rev 123948)
@@ -26,16 +26,16 @@
 OPTIONS
 -------
 
---nosync::
+*--nosync*::
     Only check for updates - and install if available - for MacPorts itself. Do
     not update the ports tree.
 
 include::global-flags.txt[]
 
--q::
+*-q*::
     Supress status output, be as silent as possible.
 
--f::
+*-f*::
     Do not check whether the downloaded MacPorts version is newer than the
     currently installed one, but always rebuild and reinstall MacPorts.
     +

Modified: trunk/base/doc/port-uninstall.1.txt
===================================================================
--- trunk/base/doc/port-uninstall.1.txt	2014-08-16 13:38:31 UTC (rev 123947)
+++ trunk/base/doc/port-uninstall.1.txt	2014-08-16 13:45:03 UTC (rev 123948)
@@ -28,16 +28,16 @@
 OPTIONS
 -------
 
---follow-dependents::
+*--follow-dependents*::
     Also uninstall all ports recursively depending directly or indirectly on one
     of the specified ports before uninstalling the port itself.
 
---follow-dependencies::
+*--follow-dependencies*::
     Also recursively uninstall all ports that the specified port depends on.
     This will not uninstall dependencies that are marked as requested or that
     have other dependents.
 
---no-exec::
+*--no-exec*::
     Do not execute any stored pre- or post-uninstall procedures.
 
 
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.macosforge.org/pipermail/macports-changes/attachments/20140816/97406a7e/attachment-0001.html>

More information about the macports-changes mailing list