[123889] trunk/base/doc

cal at macports.org cal at macports.org
Fri Aug 15 13:06:28 PDT 2014


Revision: 123889
          https://trac.macports.org/changeset/123889
Author:   cal at macports.org
Date:     2014-08-15 13:06:28 -0700 (Fri, 15 Aug 2014)
Log Message:
-----------
base: document port cd, distfiles, dmg, mdmg, pkg, mpkg, echo, exit, quit, gohome, info; #44530

Modified Paths:
--------------
    trunk/base/doc/port-cd.1.txt

Added Paths:
-----------
    trunk/base/doc/port-distfiles.1.txt
    trunk/base/doc/port-dmg.1.txt
    trunk/base/doc/port-echo.1.txt
    trunk/base/doc/port-exit.1.txt
    trunk/base/doc/port-gohome.1.txt
    trunk/base/doc/port-info.1.txt
    trunk/base/doc/port-mdmg.1.soelim
    trunk/base/doc/port-mpkg.1.soelim
    trunk/base/doc/port-pkg.1.soelim
    trunk/base/doc/port-quit.1.soelim

Modified: trunk/base/doc/port-cd.1.txt
===================================================================
--- trunk/base/doc/port-cd.1.txt	2014-08-15 19:57:24 UTC (rev 123888)
+++ trunk/base/doc/port-cd.1.txt	2014-08-15 20:06:28 UTC (rev 123889)
@@ -11,6 +11,7 @@
 --------
 To be used only in interactive mode:
 
+[cmdsynopsis]
 *cd*
     ['portname' | 'pseudo-portname' | 'port-expressions' | 'port-url']
 
@@ -21,7 +22,9 @@
 port. The second parameter is not optional, as it usually is with *cd* in your
 shell.
 
-Note that *port cd* can be used from the command line, but is a no-op.
+BUGS
+----
+*port cd* can be used from the command line, but is a no-op.
 
 SEE ALSO
 --------

Copied: trunk/base/doc/port-distfiles.1.txt (from rev 123711, trunk/base/doc/port-cat.1.txt)
===================================================================
--- trunk/base/doc/port-distfiles.1.txt	                        (rev 0)
+++ trunk/base/doc/port-distfiles.1.txt	2014-08-15 20:06:28 UTC (rev 123889)
@@ -0,0 +1,32 @@
+// vim: set et sw=4 ts=8 ft=asciidoc tw=80:
+port-distfiles(1)
+=================
+$Id$
+
+NAME
+----
+port-distfiles - Print a list of distribution files for a port
+
+SYNOPSIS
+--------
+[cmdsynopsis]
+*port* [*-qvd*] [*-D* 'portdir'] *distfiles*
+     [['portname' | 'pseudo-portname' | 'port-expressions' | 'port-url']]
+
+DESCRIPTION
+-----------
+Print a list of source archives required to build the given port along with the
+checksums for the file and a list of mirrors. If you want to verify that all
+mirrors actually serve the same file see man:port-distcheck[1].
+
+To delete the distfiles once they have been downloaded, use *port clean --dist*.
+See man:port-clean[1] for more information regarding the *clean* command.
+
+SEE ALSO
+--------
+man:port[1], man:port-distcheck[1], man:port-clean[1]
+
+AUTHORS
+-------
+ (C) 2014 The MacPorts Project
+ Clemens Lang <cal at macports.org>

Copied: trunk/base/doc/port-dmg.1.txt (from rev 123825, trunk/base/doc/port-dir.1.txt)
===================================================================
--- trunk/base/doc/port-dmg.1.txt	                        (rev 0)
+++ trunk/base/doc/port-dmg.1.txt	2014-08-15 20:06:28 UTC (rev 123889)
@@ -0,0 +1,67 @@
+// vim: set et sw=4 ts=8 ft=asciidoc tw=80:
+port-dmg(1)
+===========
+$Id$
+
+NAME
+----
+port-dmg, port-mdmg, port-pkg, port-mpkg - Create binary archives of a port, and
+optionally its dependencies.
+
+SYNOPSIS
+--------
+[cmdsynopsis]
+*port* [*-vdqysbckpotf*] [*-D* 'portdir'] *dmg*
+     [['portname' | 'pseudo-portname' | 'port-expressions' | 'port-url']]
+
+[cmdsynopsis]
+*port* [*-vdqysbckpotf*] [*-D* 'portdir'] *mdmg*
+     [['portname' | 'pseudo-portname' | 'port-expressions' | 'port-url']]
+
+[cmdsynopsis]
+*port* [*-vdqysbckpotf*] [*-D* 'portdir'] *pkg*
+     [['portname' | 'pseudo-portname' | 'port-expressions' | 'port-url']]
+
+[cmdsynopsis]
+*port* [*-vdqysbckpotf*] [*-D* 'portdir'] *mpkg*
+     [['portname' | 'pseudo-portname' | 'port-expressions' | 'port-url']]
+
+DESCRIPTION
+-----------
+These commands create OS X-native binary archives of a given port. Depending on
+the command, either a .dmg disk image file, or a .pkg installer package is
+created.
+
+*port dmg* creates an OS X disk image. *port pkg* wraps the same files in an OS
+X installer package. In most cases you probably want to package a port and all
+its library and runtime dependencies in a single package suitable for binary
+redistribution. You can use a metapackage to do this. Create one using *port
+mdmg* or *port mpkg*.
+
+All packages are placed in a port's work directory, which can be located using
+man:port-work[1].
+
+[WARNING]
+====
+If you want to create installer packages using MacPorts for redistribution, make
+sure you do not use a standard installation of MacPorts in '/opt/local'. If you
+do that, your installer package will conflict on systems that *do* have MacPorts
+installed.
+
+Instead, follow guide:installing.macports.source.multiple[Section 2.2.4 of the
+MacPorts Guide] and choose a prefix specific to the software you are trying to
+package, e.g., '/opt/logrotate' for 'logrotate'. Then use this custom MacPorts
+installation to build your package.
+====
+
+include::global-flags.txt[]
+
+SEE ALSO
+--------
+man:port[1], man:port-work[1], guide:installing.macports.source.multiple[Section
+2.2.4 of the MacPorts Guide]
+
+AUTHORS
+-------
+ (C) 2014 The MacPorts Project
+ Clemens Lang <cal at macports.org>

Copied: trunk/base/doc/port-echo.1.txt (from rev 123711, trunk/base/doc/port-contents.1.txt)
===================================================================
--- trunk/base/doc/port-echo.1.txt	                        (rev 0)
+++ trunk/base/doc/port-echo.1.txt	2014-08-15 20:06:28 UTC (rev 123889)
@@ -0,0 +1,48 @@
+// vim: set et sw=4 ts=8 ft=asciidoc tw=80:
+port-echo(1)
+============
+$Id$
+
+NAME
+----
+port-echo - Print the list of ports the argument expands to
+
+SYNOPSIS
+--------
+[cmdsynopsis]
+*port* *echo*
+     [['portname' | 'pseudo-portname' | 'port-expressions' | 'port-url']]
+
+DESCRIPTION
+-----------
+*port echo* expands its argument list according to MacPorts' rules and prints
+a list of ports that match the expression given as argument. It can be useful to
+see what a pseudo-portname or a pseudo-portname selector (see man:port[1])
+expands to.
+
+EXAMPLES
+--------
+Common use cases are:
+
+----
+port echo depends:zlib
+port echo inactive
+port echo obsolete
+port echo requested
+port echo leaves
+port echo category:^mail$
+----
+
+Note that *echo* is usually 'not' used to list outdated ports, since a separate
+action man:port-outdated[1] exists for that. *port outdated* has the advantage
+compared to *port echo outdated* that it gives the reason why MacPorts considers
+the port outdated.
+
+SEE ALSO
+--------
+man:port[1], man:port-outdated[1]
+
+AUTHORS
+-------
+ (C) 2014 The MacPorts Project
+ Clemens Lang <cal at macports.org>

Copied: trunk/base/doc/port-exit.1.txt (from rev 123711, trunk/base/doc/port-cd.1.txt)
===================================================================
--- trunk/base/doc/port-exit.1.txt	                        (rev 0)
+++ trunk/base/doc/port-exit.1.txt	2014-08-15 20:06:28 UTC (rev 123889)
@@ -0,0 +1,36 @@
+// vim: set et sw=4 ts=8 ft=asciidoc tw=80:
+port-exit(1)
+============
+$Id$
+
+NAME
+----
+port-exit - Exit interactive mode
+
+SYNOPSIS
+--------
+To be used only in interactive mode:
+
+[cmdsynopsis]
+*exit*
+
+[cmdsynopsis]
+*quit*
+
+DESCRIPTION
+-----------
+*exit* or *quit* can only be used in interactive mode of *port* (see
+man:port-interactive[7]). It causes the interactive interpreter to exit.
+
+BUGS
+----
+*port exit* and *port quit* can be used from the command line, but are no-ops.
+
+SEE ALSO
+--------
+man:port[1], man:port-interactive[7]
+
+AUTHORS
+-------
+ (C) 2014 The MacPorts Project
+ Clemens Lang <cal at macports.org>

Copied: trunk/base/doc/port-gohome.1.txt (from rev 123711, trunk/base/doc/port-deps.1.txt)
===================================================================
--- trunk/base/doc/port-gohome.1.txt	                        (rev 0)
+++ trunk/base/doc/port-gohome.1.txt	2014-08-15 20:06:28 UTC (rev 123889)
@@ -0,0 +1,27 @@
+// vim: set et sw=4 ts=8 ft=asciidoc tw=80:
+port-gohome(1)
+==============
+$Id$
+
+NAME
+----
+port-gohome - Open the homepage(s) of the given port(s)
+
+SYNOPSIS
+--------
+[cmdsynopsis]
+*port* [*-D* 'portdir'] *gohome*
+     [['portname' | 'pseudo-portname' | 'port-expressions' | 'port-url']]
+
+DESCRIPTION
+-----------
+*port gohome* opens the homepage of the given port(s) in your default browser.
+
+SEE ALSO
+--------
+man:port[1]
+
+AUTHORS
+-------
+ (C) 2014 The MacPorts Project
+ Clemens Lang <cal at macports.org>

Copied: trunk/base/doc/port-info.1.txt (from rev 123711, trunk/base/doc/port-deps.1.txt)
===================================================================
--- trunk/base/doc/port-info.1.txt	                        (rev 0)
+++ trunk/base/doc/port-info.1.txt	2014-08-15 20:06:28 UTC (rev 123889)
@@ -0,0 +1,110 @@
+// vim: set et sw=4 ts=8 ft=asciidoc tw=80:
+port-info(1)
+============
+$Id$
+
+NAME
+----
+port-info - Return information about the given ports.
+
+SYNOPSIS
+--------
+[cmdsynopsis]
+*port* [*-q*] [*-D* 'portdir'] *info*
+     [--categories|--category] [--depends] [--depends_fetch] [--depends_extract]
+     [--depends_build] [--depends_lib] [--depends_run] [--description] [--epoch]
+     [--fullname] [--heading] [--homepage] [--index] [--license] [--line]
+     [--long_description] [--maintainer|--maintainers] [--name]
+     [--platform|--platforms] [--portdir] [--pretty] [--replaced_by]
+     [--revision] [--subports] [--variant|--variants] [--version]
+     [['portname' | 'pseudo-portname' | 'port-expressions' | 'port-url']]
+
+DESCRIPTION
+-----------
+*port info* prints information about the given ports. Specifying at least one of
+the options limits the output to the corresponding field. If no fields are
+specified, a useful default set consisting of name, epoch, version, revision,
+categories, replaced_by, variants, description, homepage, dependencies,
+platforms, license, and maintainers is shown.
+
+OPTIONS
+-------
+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.
+    Note that this option will prevent the information reported from reflecting
+    the effects of any variants specified.
+
+--line::
+    Print a single line for each port. Fields are separated by spaces.
+
+--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, or --categories::
+    List the categories of a port.
+
+--depends, --depends_fetch, --depends_extract, --depends_build, --depends_lib, and --depends_run::
+    List the specified dependencies of a port. *--depends* is a shorthand option
+    for all other *--depends_** options.
+
+--description, and --long_description::
+    Print the short, and long description of a port, respectively.
+
+--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".
+
+--heading::
+    Like *--fullname* but including the categories.
+
+--homepage::
+    List the homepage of a port.
+
+--license::
+    Print the license that applies to the source code of a port.
+
+--maintainer, or --maintainers::
+    List the email address(es) of a port's maintainer(s).
+
+--name::
+    Print the name of a port.
+
+--platform, or --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::
+    Print the path to a port's directory relative to the port tree root.
+
+--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.
+
+--variant, or --variants::
+    List the variants defined by a port by name.
+
+include::global-flags.txt[]
+
+-q::
+    Do not print the field description when using *--pretty* output.
+
+SEE ALSO
+--------
+man:port[1]
+
+AUTHORS
+-------
+ (C) 2014 The MacPorts Project
+ Clemens Lang <cal at macports.org>

Added: trunk/base/doc/port-mdmg.1.soelim
===================================================================
--- trunk/base/doc/port-mdmg.1.soelim	                        (rev 0)
+++ trunk/base/doc/port-mdmg.1.soelim	2014-08-15 20:06:28 UTC (rev 123889)
@@ -0,0 +1 @@
+.so man1/port-dmg.1

Added: trunk/base/doc/port-mpkg.1.soelim
===================================================================
--- trunk/base/doc/port-mpkg.1.soelim	                        (rev 0)
+++ trunk/base/doc/port-mpkg.1.soelim	2014-08-15 20:06:28 UTC (rev 123889)
@@ -0,0 +1 @@
+.so man1/port-dmg.1

Added: trunk/base/doc/port-pkg.1.soelim
===================================================================
--- trunk/base/doc/port-pkg.1.soelim	                        (rev 0)
+++ trunk/base/doc/port-pkg.1.soelim	2014-08-15 20:06:28 UTC (rev 123889)
@@ -0,0 +1 @@
+.so man1/port-dmg.1

Added: trunk/base/doc/port-quit.1.soelim
===================================================================
--- trunk/base/doc/port-quit.1.soelim	                        (rev 0)
+++ trunk/base/doc/port-quit.1.soelim	2014-08-15 20:06:28 UTC (rev 123889)
@@ -0,0 +1 @@
+.so man1/port-exit.1
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.macosforge.org/pipermail/macports-changes/attachments/20140815/f683b393/attachment.html>


More information about the macports-changes mailing list