[123812] trunk/base/doc

cal at macports.org cal at macports.org
Thu Aug 14 14:41:49 PDT 2014


Revision: 123812
          https://trac.macports.org/changeset/123812
Author:   cal at macports.org
Date:     2014-08-14 14:41:49 -0700 (Thu, 14 Aug 2014)
Log Message:
-----------
base: document port-{dir,file,location,url,work}, #44530

Modified Paths:
--------------
    trunk/base/doc/Makefile.in

Added Paths:
-----------
    trunk/base/doc/port-dir.1.txt
    trunk/base/doc/port-file.1.soelim
    trunk/base/doc/port-location.1.soelim
    trunk/base/doc/port-url.1.soelim
    trunk/base/doc/port-work.1.soelim

Modified: trunk/base/doc/Makefile.in
===================================================================
--- trunk/base/doc/Makefile.in	2014-08-14 21:40:52 UTC (rev 123811)
+++ trunk/base/doc/Makefile.in	2014-08-14 21:41:49 UTC (rev 123812)
@@ -30,16 +30,21 @@
 		port-dependents.1 \
 		port-deps.1 \
 		port-destroot.1 \
+		port-dir.1 \
 		port-edit.1 \
 		port-extract.1 \
 		port-fetch.1 \
+		port-file.1 \
 		port-help.1 \
 		port-install.1 \
+		port-location.1 \
 		port-patch.1 \
 		port-rdeps.1 \
 		port-rev-upgrade.1 \
 		port-selfupdate.1 \
 		port-uninstall.1 \
+		port-url.1 \
+		port-work.1 \
 		port.1 \
 
 MAN5=		macports.conf.5

Copied: trunk/base/doc/port-dir.1.txt (from rev 123711, trunk/base/doc/port-deps.1.txt)
===================================================================
--- trunk/base/doc/port-dir.1.txt	                        (rev 0)
+++ trunk/base/doc/port-dir.1.txt	2014-08-14 21:41:49 UTC (rev 123812)
@@ -0,0 +1,76 @@
+// vim: set et sw=4 ts=8 ft=asciidoc tw=80:
+port-deps(1)
+============
+$Id$
+
+NAME
+----
+port-dir, port-url, port-file, port-location, port-work - Print paths for
+certain properties of a port
+
+SYNOPSIS
+--------
+[cmdsynopsis]
+*port* [*-D* 'portdir'] *dir*
+     [['portname' | 'pseudo-portname' | 'port-expressions' | 'port-url']]
+
+[cmdsynopsis]
+*port* [*-D* 'portdir'] *url*
+     [['portname' | 'pseudo-portname' | 'port-expressions' | 'port-url']]
+
+[cmdsynopsis]
+*port* [*-D* 'portdir'] *file*
+     [['portname' | 'pseudo-portname' | 'port-expressions' | 'port-url']]
+
+[cmdsynopsis]
+*port* [*-q*] [*-D* 'portdir'] *location*
+     [['portname' | 'pseudo-portname' | 'port-expressions' | 'port-url']]
+
+[cmdsynopsis]
+*port* [*-D* 'portdir'] *work*
+     [['portname' | 'pseudo-portname' | 'port-expressions' | 'port-url']]
+
+DESCRIPTION
+-----------
+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
+expression. This can be quite handy in your shell, if you want to locate
+a Portfile:
+
+----
+cd $(port dir <portname>)
+----
+
+*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
+a shell to edit a Portfile, but note that you can also use man:port-edit[1] to
+achieve the same.
+
+*port location* 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 man:port-activate[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.
+
+*port work* prints the path to the so-called 'work' directory, i.e., the
+directory used by MacPorts to build a port. No output is generated if no build
+directory exists, e.g., because there is no unfinished build in progress for the
+given port. Work directories are deleted after successful installation or using
+man:port-clean[1].
+
+include::global-flags.txt[]
+
+SEE ALSO
+--------
+man:port[1], man:port-edit[1], man:port-activate[1], man:port-clean[1]
+
+AUTHORS
+-------
+ (C) 2014 The MacPorts Project
+ Clemens Lang <cal at macports.org>

Added: trunk/base/doc/port-file.1.soelim
===================================================================
--- trunk/base/doc/port-file.1.soelim	                        (rev 0)
+++ trunk/base/doc/port-file.1.soelim	2014-08-14 21:41:49 UTC (rev 123812)
@@ -0,0 +1 @@
+.so man1/port-dir.1

Added: trunk/base/doc/port-location.1.soelim
===================================================================
--- trunk/base/doc/port-location.1.soelim	                        (rev 0)
+++ trunk/base/doc/port-location.1.soelim	2014-08-14 21:41:49 UTC (rev 123812)
@@ -0,0 +1 @@
+.so man1/port-dir.1

Added: trunk/base/doc/port-url.1.soelim
===================================================================
--- trunk/base/doc/port-url.1.soelim	                        (rev 0)
+++ trunk/base/doc/port-url.1.soelim	2014-08-14 21:41:49 UTC (rev 123812)
@@ -0,0 +1 @@
+.so man1/port-dir.1

Added: trunk/base/doc/port-work.1.soelim
===================================================================
--- trunk/base/doc/port-work.1.soelim	                        (rev 0)
+++ trunk/base/doc/port-work.1.soelim	2014-08-14 21:41:49 UTC (rev 123812)
@@ -0,0 +1 @@
+.so man1/port-dir.1
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.macosforge.org/pipermail/macports-changes/attachments/20140814/2dac2d9d/attachment.html>


More information about the macports-changes mailing list