Changeset 123948


Ignore:
Timestamp:
Aug 16, 2014, 1:45:03 PM (5 years ago)
Author:
cal@…
Message:

base: unify formatting in manpages

  • all options are printed in bold
  • 'Portfile' is always underlined
  • fix list in port-lint.1
Location:
trunk/base/doc
Files:
13 edited

Legend:

Unmodified
Added
Removed
  • trunk/base/doc/port-activate.1.txt

    r123824 r123948  
    3939-------
    4040
    41 --no-exec::
     41*--no-exec*::
    4242    Do not execute any stored pre- or post-uninstall procedures.
    4343
  • trunk/base/doc/port-archivefetch.1.txt

    r123071 r123948  
    3333include::global-flags.txt[]
    3434
    35 -p::
     35*-p*::
    3636    Proceed even if a port fails to fetch. This is useful if you are trying to
    3737    download all available binary images for a number of ports, e.g., if you
  • trunk/base/doc/port-contents.1.txt

    r123028 r123948  
    3030-------
    3131
    32 --size::
     32*--size*::
    3333    Enable printing a human-readable representation of the files' sizes. The
    3434    size output can be adjusted using the *--units 'unit'* flag.
    3535
    36 --units 'unit'::
     36*--units 'unit'*::
    3737    Used in conjunction with *--size* to choose the unit in which the size is
    3838    given. Valid values for 'unit' are
    3939
    40     B:::
     40    *B*:::
    4141        List sizes in bytes.
    4242
    43     K, Ki, or KiB:::
     43    *K*, *Ki*, *KiB*:::
    4444        List sizes in KiB, i.e., 1024 bytes.
    4545
    46     Mi, or MiB:::
     46    *Mi*, *MiB*:::
    4747        List sizes in MiB, i.e., 1024 * 1024 bytes.
    4848
    49     Gi, or GiB:::
     49    *Gi*, *GiB*:::
    5050        List sizes in GiB, i.e., 1024 * 1024 * 1024 bytes.
    5151
    52     k, or kB:::
     52    *k*, *kB*:::
    5353        List sizes in kB, i.e., 1000 bytes.
    5454
    55     M, or MB:::
     55    *M*, *MB*:::
    5656        List sizes in MB, i.e., 1000 * 1000 bytes.
    5757
    58     G, or GB:::
     58    *G*, *GB*:::
    5959        List sizes in GB, i.e., 1000 * 1000 * 1000 bytes.
    6060
     
    6262include::global-flags.txt[]
    6363
    64 -q::
     64*-q*::
    6565    Do not print the header line.
    6666
  • trunk/base/doc/port-dir.1.txt

    r123825 r123948  
    3636differs by the command given:
    3737
    38 *port dir* prints the directory that contains the Portfile for the given port
     38*port dir* prints the directory that contains the 'Portfile' for the given port
    3939expression. This can be quite handy in your shell, if you want to locate
    40 a Portfile:
     40a 'Portfile':
    4141
    4242----
     
    4747mostly exists for historical reasons and isn't of much use nowadays.
    4848
    49 *port file* prints the path of the Portfile for the given port expression. This
    50 can be useful to locate a port's definition. Note that you can always get this
    51 by using *port dir* and appending 'Portfile'. You could use *port file* in
     49*port file* prints the path of the 'Portfile' for the given port expression.
     50This can be useful to locate a port's definition. Note that you can always get
     51this by using *port dir* and appending 'Portfile'. You could use *port file* in
    5252a shell to edit a Portfile, but note that you can also use man:port-edit[1] to
    5353achieve the same.
  • trunk/base/doc/port-distcheck.1.txt

    r123940 r123948  
    1919mirrors (including MacPorts' mirror infrastructure) and checks that the
    2020modification date of the file on the mirror is not more recent than the
    21 modification date of the Portfile.
     21modification date of the 'Portfile'.
    2222
    2323Distcheck can be switched to verify the file size of the downloaded files
    24 instead by setting the 'distcheck.type' option to 'filesize' in the Portfile for
    25 the tested port.
     24instead by setting the 'distcheck.type' option to 'filesize' in the 'Portfile'
     25for the tested port.
    2626
    2727BUGS
    2828----
    2929*port distcheck* should not rely on timestamps or file sizes but use the
    30 checksums available in the Portfile to verify the integrity of the files on the
    31 mirrors instead. See man:port-checksum[1].
     30checksums available in the 'Portfile' to verify the integrity of the files on
     31the mirrors instead. See man:port-checksum[1].
    3232
    3333Meanwhile, you can use source:contrib/port-checkmirrors[port-checkmirrors] from
  • trunk/base/doc/port-dmg.1.txt

    r123939 r123948  
    4343a disk image.
    4444
    45 On OS X 10.6 and later, the generated installer packages are in "flat" format,
     45On OS X 10.6 and later, the generated installer packages are in ``flat'' format,
    4646such that wrapping them in a disk image is no longer necessary for online
    4747redistribution. Prior to OS X 10.6, generated installer packages could not be
  • trunk/base/doc/port-edit.1.txt

    r123002 r123948  
    1717DESCRIPTION
    1818-----------
    19 *port edit* will open the associated Portfile in an editor. It will try to
     19*port edit* will open the associated 'Portfile' in an editor. It will try to
    2020determine your favorite editor by respecting the environment variables *$VISUAL*
    2121or *$EDITOR* in this order. If none has been set it will fallback to
    2222'/usr/bin/vi'. Your shell will be blocked until the editor returns. The path to
    23 the Portfile is passed as one single argument to the editor.
     23the 'Portfile' is passed as one single argument to the editor.
    2424
    2525If you specify multiple ports, the editor is executed multiple times for
  • trunk/base/doc/port-info.1.txt

    r123941 r123948  
    3333information is obtained or formatted:
    3434
    35 --index::
    36     Do not read the Portfile, but rely solely on the port index information.
     35*--index*::
     36    Do not read the 'Portfile', but rely solely on the port index information.
    3737    Note that this option will prevent the information reported from reflecting
    3838    the effects of any variants specified.
    3939
    40 --line::
     40*--line*::
    4141    Print a single line for each port. Fields are separated by spaces.
    4242
    43 --pretty::
     43*--pretty*::
    4444    Format the output in a convenient, human-readable fashion. This is the
    4545    default when no options are specified.
     
    4747The rest of the options affect which fields will be given in the output:
    4848
    49 --category, --categories::
     49*--category*, *--categories*::
    5050    List the categories of a port.
    5151
    52 --depends, --depends_fetch, --depends_extract, --depends_build, --depends_lib, --depends_run::
     52*--depends*, *--depends_fetch*, *--depends_extract*, *--depends_build*, *--depends_lib*, *--depends_run*::
    5353    List the specified dependencies of a port. *--depends* is a shorthand option
    5454    for all other *--depends_** options.
    5555
    56 --description, --long_description::
     56*--description*, *--long_description*::
    5757    Print the short or long description of a port, respectively.
    5858
    59 --epoch, --version, --revision::
     59*--epoch*, *--version*, *--revision*::
    6060    List the components of a MacPorts version tuple, epoch, version and
    6161    revision, respectively.
    6262
    63 --fullname::
    64     Print name and the full MacPorts version tuple, e.g., "yubico-pam @2.16".
     63*--fullname*::
     64    Print name and the full MacPorts version tuple, e.g., ``yubico-pam @2.16''.
    6565
    66 --heading::
     66*--heading*::
    6767    Like *--fullname* but including the categories.
    6868
    69 --homepage::
     69*--homepage*::
    7070    List the homepage of a port.
    7171
    72 --license::
     72*--license*::
    7373    Print the license that applies to the source code of a port.
    7474
    75 --maintainer, --maintainers::
     75*--maintainer*, *--maintainers*::
    7676    List the email address(es) of a port's maintainer(s).
    7777
    78 --name::
     78*--name*::
    7979    Print the name of a port.
    8080
    81 --platform, --platforms::
     81*--platform*, *--platforms*::
    8282    List the platforms supported by a port. This field exists for historical
    8383    reasons only. In modern MacPorts, this is always 'darwin', i.e., OS X.
    8484
    85 --portdir::
     85*--portdir*::
    8686    Print the path to a port's directory relative to the port tree root.
    8787
    88 --replaced_by::
     88*--replaced_by*::
    8989    List the name of the port that replaces a port, if any.
    9090
    91 --subports::
    92     Print a list of subports defined by this port's Portfile, i.e., ports that
    93     are defined in the same Portfile because they share common parts.
     91*--subports*::
     92    Print a list of subports defined by this port's 'Portfile', i.e., ports that
     93    are defined in the same 'Portfile' because they share common parts.
    9494
    95 --variant, --variants::
     95*--variant*, *--variants*::
    9696    List the variants defined by a port by name.
    9797
    9898include::global-flags.txt[]
    9999
    100 -q::
     100*-q*::
    101101    Do not print the field description when using *--pretty* output.
    102102
  • trunk/base/doc/port-installed.1.txt

    r123942 r123948  
    2727include::global-flags.txt[]
    2828
    29 -v::
     29*-v*::
    3030    Print the platform at install time (i.e., your OS X version) and the
    3131    architecture(s) of the installed port.
    3232
    33 -q::
     33*-q*::
    3434    Do not print the header line. This is useful when parsing the output of
    3535    *port installed* in scripts for further processing.
  • trunk/base/doc/port-lint.1.txt

    r123944 r123948  
    1717DESCRIPTION
    1818-----------
    19 *port lint* checks the Portfile of a given port for potential errors. It is
     19*port lint* checks the 'Portfile' of a given port for potential errors. It is
    2020a useful tool for port maintainers to check for possible typos, mistakes and
    2121missing definitions.
    2222
    2323For example, it verifies that
    24  - Portfiles are valid UTF-8
    25  - all mandatory properties are present
    26  - all dependencies actually exist, and
    27  - no deprecated features are used.
     24
     25 * Portfiles are valid UTF-8
     26 * all mandatory properties are present
     27 * all dependencies actually exist, and
     28 * no deprecated features are used.
    2829
    2930If problems are found, *port lint* emits warnings and error messages explaining
    3031the problem. Please fix all errors and consider fixing any warnings before
    31 submitting your Portfile or your changes to MacPorts.
     32submitting your 'Portfile' or your changes to MacPorts.
    3233
    3334OPTIONS
     
    4344
    4445*-d*::
    45     Print the Portfile, and debugging information parsed from the Portfile.
     46    Print the 'Portfile', and debugging information parsed from the 'Portfile'.
    4647
    4748*-q*::
  • trunk/base/doc/port-rev-upgrade.1.txt

    r123014 r123948  
    3030-------
    3131
    32 --id-loadcmd-check::
     32*--id-loadcmd-check*::
    3333    Check the ID load command in each library installed by MacPorts. This load
    3434    command contains a path that should always reference the library itself,
  • trunk/base/doc/port-selfupdate.1.txt

    r123022 r123948  
    2727-------
    2828
    29 --nosync::
     29*--nosync*::
    3030    Only check for updates - and install if available - for MacPorts itself. Do
    3131    not update the ports tree.
     
    3333include::global-flags.txt[]
    3434
    35 -q::
     35*-q*::
    3636    Supress status output, be as silent as possible.
    3737
    38 -f::
     38*-f*::
    3939    Do not check whether the downloaded MacPorts version is newer than the
    4040    currently installed one, but always rebuild and reinstall MacPorts.
  • trunk/base/doc/port-uninstall.1.txt

    r123025 r123948  
    2929-------
    3030
    31 --follow-dependents::
     31*--follow-dependents*::
    3232    Also uninstall all ports recursively depending directly or indirectly on one
    3333    of the specified ports before uninstalling the port itself.
    3434
    35 --follow-dependencies::
     35*--follow-dependencies*::
    3636    Also recursively uninstall all ports that the specified port depends on.
    3737    This will not uninstall dependencies that are marked as requested or that
    3838    have other dependents.
    3939
    40 --no-exec::
     40*--no-exec*::
    4141    Do not execute any stored pre- or post-uninstall procedures.
    4242
Note: See TracChangeset for help on using the changeset viewer.