Changeset 123949


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

base: regenerate roff from asciidoc source

Location:
trunk/base/doc
Files:
13 edited

Legend:

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

    r123827 r123949  
    11'\" t
    2 .TH "PORT\-ACTIVATE" "1" "2014\-08\-14" "MacPorts 2\&.3\&.99" "MacPorts Manual"
     2.TH "PORT\-ACTIVATE" "1" "2014\-08\-16" "MacPorts 2\&.3\&.99" "MacPorts Manual"
    33.\" -----------------------------------------------------------------
    44.\" * Define some portability stuff
     
    5252.SH "OPTIONS"
    5353.PP
    54 \-\-no\-exec
     54\fB\-\-no\-exec\fR
    5555.RS 4
    5656Do not execute any stored pre\- or post\-uninstall procedures\&.
  • trunk/base/doc/port-archivefetch.1

    r123072 r123949  
    11'\" t
    2 .TH "PORT\-ARCHIVEFETCH" "1" "2014\-08\-04" "MacPorts 2\&.3\&.99" "MacPorts Manual"
     2.TH "PORT\-ARCHIVEFETCH" "1" "2014\-08\-16" "MacPorts 2\&.3\&.99" "MacPorts Manual"
    33.\" -----------------------------------------------------------------
    44.\" * Define some portability stuff
     
    4747Please see the section \fBGLOBAL OPTIONS\fR in the \fBport\fR(1) man page for a description of global port options\&.
    4848.PP
    49 \-p
     49\fB\-p\fR
    5050.RS 4
    5151Proceed 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\&.
  • trunk/base/doc/port-contents.1

    r123029 r123949  
    11'\" t
    2 .TH "PORT\-CONTENTS" "1" "2014\-08\-03" "MacPorts 2\&.3\&.99" "MacPorts Manual"
     2.TH "PORT\-CONTENTS" "1" "2014\-08\-16" "MacPorts 2\&.3\&.99" "MacPorts Manual"
    33.\" -----------------------------------------------------------------
    44.\" * Define some portability stuff
     
    4646.SH "OPTIONS"
    4747.PP
    48 \-\-size
     48\fB\-\-size\fR
    4949.RS 4
    5050Enable printing a human\-readable representation of the files\*(Aq sizes\&. The size output can be adjusted using the
     
    5353.RE
    5454.PP
    55 \-\-units \fIunit\fR
     55\fB\-\-units \fR\fB\fIunit\fR\fR
    5656.RS 4
    5757Used in conjunction with
     
    6161are
    6262.PP
    63 B
     63\fBB\fR
    6464.RS 4
    6565List sizes in bytes\&.
    6666.RE
    6767.PP
    68 K, Ki, or KiB
     68\fBK\fR, \fBKi\fR, \fBKiB\fR
    6969.RS 4
    7070List sizes in KiB, i\&.e\&., 1024 bytes\&.
    7171.RE
    7272.PP
    73 Mi, or MiB
     73\fBMi\fR, \fBMiB\fR
    7474.RS 4
    7575List sizes in MiB, i\&.e\&., 1024 * 1024 bytes\&.
    7676.RE
    7777.PP
    78 Gi, or GiB
     78\fBGi\fR, \fBGiB\fR
    7979.RS 4
    8080List sizes in GiB, i\&.e\&., 1024 * 1024 * 1024 bytes\&.
    8181.RE
    8282.PP
    83 k, or kB
     83\fBk\fR, \fBkB\fR
    8484.RS 4
    8585List sizes in kB, i\&.e\&., 1000 bytes\&.
    8686.RE
    8787.PP
    88 M, or MB
     88\fBM\fR, \fBMB\fR
    8989.RS 4
    9090List sizes in MB, i\&.e\&., 1000 * 1000 bytes\&.
    9191.RE
    9292.PP
    93 G, or GB
     93\fBG\fR, \fBGB\fR
    9494.RS 4
    9595List sizes in GB, i\&.e\&., 1000 * 1000 * 1000 bytes\&.
     
    100100Please see the section \fBGLOBAL OPTIONS\fR in the \fBport\fR(1) man page for a description of global port options\&.
    101101.PP
    102 \-q
     102\fB\-q\fR
    103103.RS 4
    104104Do not print the header line\&.
  • trunk/base/doc/port-dir.1

    r123827 r123949  
    11'\" t
    2 .TH "PORT\-DIR" "1" "2014\-08\-14" "MacPorts 2\&.3\&.99" "MacPorts Manual"
     2.TH "PORT\-DIR" "1" "2014\-08\-16" "MacPorts 2\&.3\&.99" "MacPorts Manual"
    33.\" -----------------------------------------------------------------
    44.\" * Define some portability stuff
     
    5252These commands print a path for each given port\&. The meaning of the path differs by the command given:
    5353.sp
    54 \fBport dir\fR 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:
     54\fBport dir\fR prints the directory that contains the \fIPortfile\fR for the given port expression\&. This can be quite handy in your shell, if you want to locate a \fIPortfile\fR:
    5555.sp
    5656.if n \{\
     
    6666\fBport url\fR prints a unique URL for the given port expression\&. This command mostly exists for historical reasons and isn\(cqt of much use nowadays\&.
    6767.sp
    68 \fBport file\fR prints the path of the Portfile for the given port expression\&. This can be useful to locate a port\(cqs definition\&. Note that you can always get this by using \fBport dir\fR and appending \fIPortfile\fR\&. You could use \fBport file\fR in a shell to edit a Portfile, but note that you can also use \fBport-edit\fR(1) to achieve the same\&.
     68\fBport file\fR prints the path of the \fIPortfile\fR for the given port expression\&. This can be useful to locate a port\(cqs definition\&. Note that you can always get this by using \fBport dir\fR and appending \fIPortfile\fR\&. You could use \fBport file\fR in a shell to edit a Portfile, but note that you can also use \fBport-edit\fR(1) to achieve the same\&.
    6969.sp
    7070\fBport location\fR only works for installed ports and prints the location of the archive MacPorts internally uses to be able to deactivate and activate a port\&. See \fBport-activate\fR(1) for more details on that\&. This command might be useful for you if you want to setup a local binary mirror of MacPorts packages that are not available from our official infrastructure due to licensing reasons\&.
  • trunk/base/doc/port-distcheck.1

    r123943 r123949  
    3030.SH "DESCRIPTION"
    3131.sp
    32 \fBport distcheck\fR downloads all source files for a given port from all available mirrors (including MacPorts\*(Aq 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\&.
     32\fBport distcheck\fR downloads all source files for a given port from all available mirrors (including MacPorts\*(Aq mirror infrastructure) and checks that the modification date of the file on the mirror is not more recent than the modification date of the \fIPortfile\fR\&.
    3333.sp
    34 Distcheck can be switched to verify the file size of the downloaded files instead by setting the \fIdistcheck\&.type\fR option to \fIfilesize\fR in the Portfile for the tested port\&.
     34Distcheck can be switched to verify the file size of the downloaded files instead by setting the \fIdistcheck\&.type\fR option to \fIfilesize\fR in the \fIPortfile\fR for the tested port\&.
    3535.SH "BUGS"
    3636.sp
    37 \fBport distcheck\fR 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 \fBport-checksum\fR(1)\&.
     37\fBport distcheck\fR should not rely on timestamps or file sizes but use the checksums available in the \fIPortfile\fR to verify the integrity of the files on the mirrors instead\&. See \fBport-checksum\fR(1)\&.
    3838.sp
    3939Meanwhile, you can use \m[blue]\fBport\-checkmirrors\fR\m[]\&\s-2\u[1]\d\s+2 from contrib to do that\&.
  • trunk/base/doc/port-dmg.1

    r123943 r123949  
    4949\fBport pkg\fR creates an OS X installer package that installs all files that belong to a given port\&. \fBport dmg\fR wraps this installer package in a disk image\&. In most cases you probably want to package a port and all its library and runtime dependencies in a single package suitable for binary distribution\&. \fBport pkg\fR and \fBport dmg\fR don\(cqt do that, so those are only useful if you are going to take care of the dependencies separately\&. \fBport mpkg\fR creates an \&.mpkg installer image that contains installer packages for each of the dependencies and is suitable for standalone redistribution\&. \fBport mdmg\fR wraps this \&.mpkg package in a disk image\&.
    5050.sp
    51 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\&.
     51On OS X 10\&.6 and later, the generated installer packages are in \(lqflat\(rq 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\&.
    5252.sp
    5353All packages are placed in a port\(cqs work directory, which can be located using \fBport-work\fR(1)\&.
  • trunk/base/doc/port-edit.1

    r123013 r123949  
    11'\" t
    2 .TH "PORT\-EDIT" "1" "2014\-08\-03" "MacPorts 2\&.3\&.99" "MacPorts Manual"
     2.TH "PORT\-EDIT" "1" "2014\-08\-16" "MacPorts 2\&.3\&.99" "MacPorts Manual"
    33.\" -----------------------------------------------------------------
    44.\" * Define some portability stuff
     
    3131.SH "DESCRIPTION"
    3232.sp
    33 \fBport edit\fR will open the associated Portfile in an editor\&. It will try to determine your favorite editor by respecting the environment variables \fB$VISUAL\fR or \fB$EDITOR\fR in this order\&. If none has been set it will fallback to \fI/usr/bin/vi\fR\&. Your shell will be blocked until the editor returns\&. The path to the Portfile is passed as one single argument to the editor\&.
     33\fBport edit\fR will open the associated \fIPortfile\fR in an editor\&. It will try to determine your favorite editor by respecting the environment variables \fB$VISUAL\fR or \fB$EDITOR\fR in this order\&. If none has been set it will fallback to \fI/usr/bin/vi\fR\&. Your shell will be blocked until the editor returns\&. The path to the \fIPortfile\fR is passed as one single argument to the editor\&.
    3434.sp
    3535If you specify multiple ports, the editor is executed multiple times for each of them one after another\&.
  • trunk/base/doc/port-info.1

    r123943 r123949  
    4141The following options do not select fields for the output but change how the information is obtained or formatted:
    4242.PP
    43 \-\-index
     43\fB\-\-index\fR
    4444.RS 4
    45 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\&.
     45Do not read the
     46\fIPortfile\fR, 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\&.
    4647.RE
    4748.PP
    48 \-\-line
     49\fB\-\-line\fR
    4950.RS 4
    5051Print a single line for each port\&. Fields are separated by spaces\&.
    5152.RE
    5253.PP
    53 \-\-pretty
     54\fB\-\-pretty\fR
    5455.RS 4
    5556Format the output in a convenient, human\-readable fashion\&. This is the default when no options are specified\&.
     
    5859The rest of the options affect which fields will be given in the output:
    5960.PP
    60 \-\-category, \-\-categories
     61\fB\-\-category\fR, \fB\-\-categories\fR
    6162.RS 4
    6263List the categories of a port\&.
    6364.RE
    6465.PP
    65 \-\-depends, \-\-depends_fetch, \-\-depends_extract, \-\-depends_build, \-\-depends_lib, \-\-depends_run
     66\fB\-\-depends\fR, \fB\-\-depends_fetch\fR, \fB\-\-depends_extract\fR, \fB\-\-depends_build\fR, \fB\-\-depends_lib\fR, \fB\-\-depends_run\fR
    6667.RS 4
    6768List the specified dependencies of a port\&.
     
    7172.RE
    7273.PP
    73 \-\-description, \-\-long_description
     74\fB\-\-description\fR, \fB\-\-long_description\fR
    7475.RS 4
    7576Print the short or long description of a port, respectively\&.
    7677.RE
    7778.PP
    78 \-\-epoch, \-\-version, \-\-revision
     79\fB\-\-epoch\fR, \fB\-\-version\fR, \fB\-\-revision\fR
    7980.RS 4
    8081List the components of a MacPorts version tuple, epoch, version and revision, respectively\&.
    8182.RE
    8283.PP
    83 \-\-fullname
     84\fB\-\-fullname\fR
    8485.RS 4
    85 Print name and the full MacPorts version tuple, e\&.g\&., "yubico\-pam @2\&.16"\&.
     86Print name and the full MacPorts version tuple, e\&.g\&., \(lqyubico\-pam @2\&.16\(rq\&.
    8687.RE
    8788.PP
    88 \-\-heading
     89\fB\-\-heading\fR
    8990.RS 4
    9091Like
     
    9394.RE
    9495.PP
    95 \-\-homepage
     96\fB\-\-homepage\fR
    9697.RS 4
    9798List the homepage of a port\&.
    9899.RE
    99100.PP
    100 \-\-license
     101\fB\-\-license\fR
    101102.RS 4
    102103Print the license that applies to the source code of a port\&.
    103104.RE
    104105.PP
    105 \-\-maintainer, \-\-maintainers
     106\fB\-\-maintainer\fR, \fB\-\-maintainers\fR
    106107.RS 4
    107108List the email address(es) of a port\(cqs maintainer(s)\&.
    108109.RE
    109110.PP
    110 \-\-name
     111\fB\-\-name\fR
    111112.RS 4
    112113Print the name of a port\&.
    113114.RE
    114115.PP
    115 \-\-platform, \-\-platforms
     116\fB\-\-platform\fR, \fB\-\-platforms\fR
    116117.RS 4
    117118List the platforms supported by a port\&. This field exists for historical reasons only\&. In modern MacPorts, this is always
     
    119120.RE
    120121.PP
    121 \-\-portdir
     122\fB\-\-portdir\fR
    122123.RS 4
    123124Print the path to a port\(cqs directory relative to the port tree root\&.
    124125.RE
    125126.PP
    126 \-\-replaced_by
     127\fB\-\-replaced_by\fR
    127128.RS 4
    128129List the name of the port that replaces a port, if any\&.
    129130.RE
    130131.PP
    131 \-\-subports
     132\fB\-\-subports\fR
    132133.RS 4
    133 Print a list of subports defined by this port\(cqs Portfile, i\&.e\&., ports that are defined in the same Portfile because they share common parts\&.
     134Print a list of subports defined by this port\(cqs
     135\fIPortfile\fR, i\&.e\&., ports that are defined in the same
     136\fIPortfile\fR
     137because they share common parts\&.
    134138.RE
    135139.PP
    136 \-\-variant, \-\-variants
     140\fB\-\-variant\fR, \fB\-\-variants\fR
    137141.RS 4
    138142List the variants defined by a port by name\&.
     
    142146Please see the section \fBGLOBAL OPTIONS\fR in the \fBport\fR(1) man page for a description of global port options\&.
    143147.PP
    144 \-q
     148\fB\-q\fR
    145149.RS 4
    146150Do not print the field description when using
  • trunk/base/doc/port-installed.1

    r123943 r123949  
    3737Please see the section \fBGLOBAL OPTIONS\fR in the \fBport\fR(1) man page for a description of global port options\&.
    3838.PP
    39 \-v
     39\fB\-v\fR
    4040.RS 4
    4141Print the platform at install time (i\&.e\&., your OS X version) and the architecture(s) of the installed port\&.
    4242.RE
    4343.PP
    44 \-q
     44\fB\-q\fR
    4545.RS 4
    4646Do not print the header line\&. This is useful when parsing the output of
  • trunk/base/doc/port-lint.1

    r123945 r123949  
    3131.SH "DESCRIPTION"
    3232.sp
    33 \fBport lint\fR 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\&.
     33\fBport lint\fR checks the \fIPortfile\fR of a given port for potential errors\&. It is a useful tool for port maintainers to check for possible typos, mistakes and missing definitions\&.
    3434.sp
    35 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\&.
     35For example, it verifies that
    3636.sp
    37 If problems are found, \fBport lint\fR 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\&.
     37.RS 4
     38.ie n \{\
     39\h'-04'\(bu\h'+03'\c
     40.\}
     41.el \{\
     42.sp -1
     43.IP \(bu 2.3
     44.\}
     45Portfiles are valid UTF\-8
     46.RE
     47.sp
     48.RS 4
     49.ie n \{\
     50\h'-04'\(bu\h'+03'\c
     51.\}
     52.el \{\
     53.sp -1
     54.IP \(bu 2.3
     55.\}
     56all mandatory properties are present
     57.RE
     58.sp
     59.RS 4
     60.ie n \{\
     61\h'-04'\(bu\h'+03'\c
     62.\}
     63.el \{\
     64.sp -1
     65.IP \(bu 2.3
     66.\}
     67all dependencies actually exist, and
     68.RE
     69.sp
     70.RS 4
     71.ie n \{\
     72\h'-04'\(bu\h'+03'\c
     73.\}
     74.el \{\
     75.sp -1
     76.IP \(bu 2.3
     77.\}
     78no deprecated features are used\&.
     79.RE
     80.sp
     81If problems are found, \fBport lint\fR emits warnings and error messages explaining the problem\&. Please fix all errors and consider fixing any warnings before submitting your \fIPortfile\fR or your changes to MacPorts\&.
    3882.SH "OPTIONS"
    3983.PP
     
    5397\fB\-d\fR
    5498.RS 4
    55 Print the Portfile, and debugging information parsed from the Portfile\&.
     99Print the
     100\fIPortfile\fR, and debugging information parsed from the
     101\fIPortfile\fR\&.
    56102.RE
    57103.PP
  • trunk/base/doc/port-rev-upgrade.1

    r123015 r123949  
    11'\" t
    2 .TH "PORT\-REV\-UPGRADE" "1" "2014\-08\-03" "MacPorts 2\&.3\&.99" "MacPorts Manual"
     2.TH "PORT\-REV\-UPGRADE" "1" "2014\-08\-16" "MacPorts 2\&.3\&.99" "MacPorts Manual"
    33.\" -----------------------------------------------------------------
    44.\" * Define some portability stuff
     
    3535.SH "OPTIONS"
    3636.PP
    37 \-\-id\-loadcmd\-check
     37\fB\-\-id\-loadcmd\-check\fR
    3838.RS 4
    3939Check 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 against this library\&. This option verifies that this is the case and will detect incorrect or non\-absolute paths\&. Since this check is only helpful for port maintainers, it is disabled by default\&.
  • trunk/base/doc/port-selfupdate.1

    r123023 r123949  
    11'\" t
    2 .TH "PORT\-SELFUPDATE" "1" "2014\-08\-03" "MacPorts 2\&.3\&.99" "MacPorts Manual"
     2.TH "PORT\-SELFUPDATE" "1" "2014\-08\-16" "MacPorts 2\&.3\&.99" "MacPorts Manual"
    33.\" -----------------------------------------------------------------
    44.\" * Define some portability stuff
     
    3434.SH "OPTIONS"
    3535.PP
    36 \-\-nosync
     36\fB\-\-nosync\fR
    3737.RS 4
    3838Only check for updates \- and install if available \- for MacPorts itself\&. Do not update the ports tree\&.
     
    4242Please see the section \fBGLOBAL OPTIONS\fR in the \fBport\fR(1) man page for a description of global port options\&.
    4343.PP
    44 \-q
     44\fB\-q\fR
    4545.RS 4
    4646Supress status output, be as silent as possible\&.
    4747.RE
    4848.PP
    49 \-f
     49\fB\-f\fR
    5050.RS 4
    5151Do not check whether the downloaded MacPorts version is newer than the currently installed one, but always rebuild and reinstall MacPorts\&.
  • trunk/base/doc/port-uninstall.1

    r123026 r123949  
    11'\" t
    2 .TH "PORT\-INSTALL" "1" "2014\-08\-03" "MacPorts 2\&.3\&.99" "MacPorts Manual"
     2.TH "PORT\-INSTALL" "1" "2014\-08\-16" "MacPorts 2\&.3\&.99" "MacPorts Manual"
    33.\" -----------------------------------------------------------------
    44.\" * Define some portability stuff
     
    3737.SH "OPTIONS"
    3838.PP
    39 \-\-follow\-dependents
     39\fB\-\-follow\-dependents\fR
    4040.RS 4
    4141Also uninstall all ports recursively depending directly or indirectly on one of the specified ports before uninstalling the port itself\&.
    4242.RE
    4343.PP
    44 \-\-follow\-dependencies
     44\fB\-\-follow\-dependencies\fR
    4545.RS 4
    4646Also 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\&.
    4747.RE
    4848.PP
    49 \-\-no\-exec
     49\fB\-\-no\-exec\fR
    5050.RS 4
    5151Do not execute any stored pre\- or post\-uninstall procedures\&.
Note: See TracChangeset for help on using the changeset viewer.