[49451] branches/new-help-system/base/doc

raimue at macports.org raimue at macports.org
Thu Apr 9 19:19:00 PDT 2009 

Revision: 49451
          http://trac.macports.org/changeset/49451
Author:   raimue at macports.org
Date:     2009-04-09 19:18:59 -0700 (Thu, 09 Apr 2009)
Log Message:
-----------
doc:
Revise DESCRIPTION

Modified Paths:
--------------
    branches/new-help-system/base/doc/port.1
    branches/new-help-system/base/doc/port.1.txt

Modified: branches/new-help-system/base/doc/port.1
===================================================================
--- branches/new-help-system/base/doc/port.1	2009-04-10 02:01:54 UTC (rev 49450)
+++ branches/new-help-system/base/doc/port.1	2009-04-10 02:18:59 UTC (rev 49451)
@@ -181,13 +181,13 @@
 .ps +1
 .SH "DESCRIPTION"
 .sp
-port is designed to operate on individual or multiple Mac \fIports\fR, optionally within a single call, based on the requested \fIaction\fR\&. If no \fIportdir\fR or \fIportname\fR is specified, the current working directory is assumed; if no \fIaction\fR is specified the port command enters interactive mode, in which commands are read via stdin\&. Batch commands may be passed via a \fIcmdfile\fR\&. Port \fIoptions\fR are passed as key=value pairs and take precedence over individual \fIportname\fR options as specified in its Portfile and system\-wide settings\&.
+\fBport\fR is designed to operate on individual or multiple \fIports\fR, optionally within a single call, based on the requested \fIaction\fR\&. If no \fIaction\fR is specified the port command enters interactive mode, in which commands are read via stdin\&. If no \fIportdir\fR or \fIportname\fR is specified for an \fIaction\fR, the current working directory is assumed\&. Batch commands may be passed via a \fIcmdfile\fR\&. Port \fIoptions\fR are passed as key=value pairs and take precedence over individual \fIportname\fR options as specified in its Portfile and system\-wide settings\&.
 .sp
-Port \fIvariants\fR can specified as \fI+name\fR, which indicates the variant is desired, or \fI\-name\fR, indicating the contrary\&. In case of ambiguities, a port can be fully specified with the \fI at version_revision+variants\fR format\&.
+Port \fIvariants\fR can be specified as \fI+name\fR, which indicates the variant is desired, or \fI\-name\fR, indicating the contrary\&. In case of ambiguities, a port can be fully specified with the \fI at version_revision+variants\fR format\&.
 .sp
-Installed ports can be activated or deactivated without being uninstalled\&. A port can be installed if all other version/variant(s) combinations installed at any given moment are deactivated\&.
+Installed ports can be activated or deactivated without being uninstalled\&. A port can be installed in multiple versions and variant combinations, but only one of them can be \fIactive\fR\&.
 .sp
-The \fBport\fR command knows various \fIpseudo\-portnames\fR that will expand to the specified set of ports from the available port tree(s)\&. These may be used in place of a \fIportname\fR\&.
+When passing \fIportnames\fR to an \fIaction\fR, \fBport\fR recognizes various \fIpseudo\-portnames\fR that will expand to the specified set of ports from the available port tree(s)\&. These may be used in the same way as a \fIportname\fR\&.
 .PP
 \fBThe \fR\fB\fIpseudo\-portnames\fR\fR\fB are:\fR
 .sp
@@ -288,7 +288,9 @@
 \fIobsolete\fR: set of ports that are installed but no longer exist in any port tree
 .RE
 .sp
-Other options, also known as \fIpseudo\-portname\fR \fIselectors\fR, matching the most common keys used in a \fIPortfile\fR are also accepted, in both singular and plural form where applicable\&. These are:
+Other options, also known as \fIpseudo\-portname selectors\fR, matching the searchable keys used in a \fIPortfile\fR are also accepted\&. Where applicable, both singular and plural forms are accepted\&.
+.PP
+\fBThe \fR\fB\fIpseudo\-portname selectors\fR\fR\fB are:\fR
 .sp
 .RS 4
 .ie n \{\
@@ -482,7 +484,7 @@
 \fIportdir\fR
 .RE
 .sp
-Search strings that will expand to a set of matching ports can be constructed based on the "\fIpseudo\-portname\fR selector":regex combination used\&. \fIportnames\fR\' containing valid UNIX glob patterns will also expand to the set of matching ports\&. Any action passed to port will be invoked on each of them\&.
+Search strings that will expand to a set of matching ports can be constructed based on the "\fIpseudo\-portname selector\fR":regex combination used\&. \fIportnames\fR containing valid UNIX glob patterns will also expand to the set of matching ports\&. Any action passed to port will be invoked on each of them\&.
 .sp
 For example:
 .sp
@@ -493,9 +495,9 @@
 .ps -1
 .nf
 .BB lightgray
-port list variant:no_ssl
+port info variant:no_ssl
 port uninstall name:sql
-port echo apache*
+port echo \'apache*\'
 .EB lightgray
 .fi
 .fam
@@ -515,7 +517,7 @@
 .ps -1
 .nf
 .BB lightgray
-port upgrade installed and apache*
+port upgrade outdated and \'py25\-*\'
 port echo maintainer:jberry and uninstalled and \e( category:java and not commons* \e)
 .EB lightgray
 .fi
@@ -524,6 +526,24 @@
 .if n \{\
 .RE
 .\}
+.if n \{\
+.sp
+.\}
+.RS 4
+.BM yellow
+.it 1 an-trap
+.nr an-no-space-flag 1
+.nr an-break-flag 1
+.br
+.ps +1
+\fBNote\fR
+.ps -1
+.br
+.sp
+Special shell characters like *, \e( or \e) need to be escaped in order to be passed correctly to \fBport\fR\&.
+.sp .5v
+.EM yellow
+.RE
 .SH "GLOBAL OPTIONS"
 .sp
 The port command recognizes several global flags and options\&.

Modified: branches/new-help-system/base/doc/port.1.txt
===================================================================
--- branches/new-help-system/base/doc/port.1.txt	2009-04-10 02:01:54 UTC (rev 49450)
+++ branches/new-help-system/base/doc/port.1.txt	2009-04-10 02:18:59 UTC (rev 49451)
@@ -16,26 +16,26 @@
 
 DESCRIPTION
 -----------
-port is designed to operate on individual or multiple Mac 'ports', optionally
-within a single call, based on the requested 'action'.  If no 'portdir' or
-'portname' is specified, the current working directory is assumed; if no
-'action' is specified the port command enters interactive mode, in which
-commands are read via stdin. Batch commands may be passed via a 'cmdfile'.
-Port 'options' are passed as key=value pairs and take precedence over
+*port* is designed to operate on individual or multiple 'ports', optionally
+within a single call, based on the requested 'action'. If no 'action' is
+specified the port command enters interactive mode, in which commands are read
+via stdin. If no 'portdir' or 'portname' is specified for an 'action', the
+current working directory is assumed. Batch commands may be passed via a
+'cmdfile'. Port 'options' are passed as key=value pairs and take precedence over
 individual 'portname' options as specified in its Portfile and system-wide
 settings.
 
-Port 'variants' can specified as '+name', which indicates the variant is
+Port 'variants' can be specified as '+name', which indicates the variant is
 desired, or '-name', indicating the contrary. In case of ambiguities, a port
 can be fully specified with the '@version_revision+variants' format.
 
 Installed ports can be activated or deactivated without being uninstalled. A
-port can be installed if all other version/variant(s) combinations installed
-at any given moment are deactivated.
+port can be installed in multiple versions and variant combinations, but only
+one of them can be 'active'.
 
-The *port* command knows various 'pseudo-portnames' that will expand to the
-specified set of ports from the available port tree(s). These may be used in
-place of a 'portname'.
+When passing 'portnames' to an 'action', *port* recognizes various
+'pseudo-portnames' that will expand to the specified set of ports from the
+available port tree(s). These may be used in the same way as a 'portname'.
 
 .The 'pseudo-portnames' are:
 
@@ -50,10 +50,11 @@
     - 'obsolete': set of ports that are installed but no longer exist in any
       port tree
 
-Other options, also known as 'pseudo-portname' 'selectors', matching the most
-common keys used in a 'Portfile' are also accepted, in both singular and plural
-form where applicable. These are:
+Other options, also known as 'pseudo-portname selectors', matching the
+searchable keys used in a 'Portfile' are also accepted. Where applicable, both
+singular and plural forms are accepted.
 
+.The 'pseudo-portname selectors' are:
     - 'name'
     - 'version'
     - 'revision'
@@ -72,15 +73,15 @@
     - 'portdir'
 
 Search strings that will expand to a set of matching ports can be constructed
-based on the "'pseudo-portname' selector":regex combination used. 'portnames''
+based on the "'pseudo-portname selector'":regex combination used. 'portnames'
 containing valid UNIX glob patterns will also expand to the set of matching
 ports. Any action passed to port will be invoked on each of them.
 
 For example:
 --------
-port list variant:no_ssl
+port info variant:no_ssl
 port uninstall name:sql
-port echo apache*
+port echo 'apache*'
 --------
 
 Logical operators "and", "or", "not", "!", "(" and ")" may be used to combine
@@ -89,11 +90,15 @@
 
 For example:
 --------
-port upgrade installed and apache*
+port upgrade outdated and 'py25-*'
 port echo maintainer:jberry and uninstalled and \( category:java and not commons* \)
 --------
 
+[NOTE]
+Special shell characters like \*, \( or \) need to be escaped in order to be
+passed correctly to *port*.
 
+
 GLOBAL OPTIONS
 --------------
 
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.macosforge.org/pipermail/macports-changes/attachments/20090409/56f5f793/attachment.html>

More information about the macports-changes mailing list