[49448] branches/new-help-system/base/doc
raimue at macports.org
raimue at macports.org
Thu Apr 9 18:22:54 PDT 2009
Revision: 49448
http://trac.macports.org/changeset/49448
Author: raimue at macports.org
Date: 2009-04-09 18:22:54 -0700 (Thu, 09 Apr 2009)
Log Message:
-----------
doc:
Add categories and classify global options, reorder SYNOPSIS accordingly
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 01:05:01 UTC (rev 49447)
+++ branches/new-help-system/base/doc/port.1 2009-04-10 01:22:54 UTC (rev 49448)
@@ -173,7 +173,7 @@
.fam C
.ps -1
.nf
-\fBport\fR [\fB\-vdqfonRusbckixpt\fR] [\fB\-D\fR \fIportdir\fR] [\fB\-F\fR \fIcmdfile\fR] [\fIaction\fR] [\fIactionflags\fR]
+\fBport\fR [\fB\-vdqnRuysbckxpotf\fR] [\fB\-D\fR \fIportdir\fR] [\fB\-F\fR \fIcmdfile\fR] [\fIaction\fR] [\fIactionflags\fR]
[[\fIportname\fR | \fIpseudo\-portname\fR | \fIport\-expressions\fR | \fIport\-url\fR]]
[[\fI at version\fR] [+/\-variant \&...] \&... [option=value \&...]]
.fi
@@ -524,10 +524,12 @@
.if n \{\
.RE
.\}
-.SH "OPTIONS"
+.SH "GLOBAL OPTIONS"
.sp
-The port command also recognizes several command line flags and targets:
+The port command recognizes several global flags and options\&.
.PP
+\fBOutput control\fR
+.PP
\-v
.RS 4
Verbose mode, generates verbose messages
@@ -543,6 +545,8 @@
Quiet mode, suppress informational messages to a minimum
.RE
.PP
+\fBInstallation and upgrade\fR
+.PP
\-n
.RS 4
Don\(cqt follow dependencies in upgrade (only for
@@ -560,15 +564,12 @@
Uninstall inactive ports when upgrading and uninstalling
.RE
.PP
-\-f
+\-y
.RS 4
-Force mode, ignore state file
+Perform a dry run\&. All of the steps to build the ports and their dependencies are computed, but not actually performed\&. With the verbose flag, every step is reported; otherwise there is just one message per port, which allows you to easily determine the recursive deps of a port (and the order in which they will be built)\&.
.RE
.PP
-\-o
-.RS 4
-Honor state files older than Portfile
-.RE
+\fBSources\fR
.PP
\-s
.RS 4
@@ -584,6 +585,8 @@
is enabled)
.RE
.PP
+\fBCleaning\fR
+.PP
\-c
.RS 4
Autoclean mode, execute clean after
@@ -596,20 +599,8 @@
\fIinstall\fR
.RE
.PP
-\-D
-.RS 4
-Specfiy
-\fIportdir\fR
-.RE
+\fBExit status\fR
.PP
-\-F
-.RS 4
-Read and process the
-\fIfile\fR
-of commands specified by the argument\&. If the argument is
-\fI\-\fR, then read commands from stdin\&. If the option is given multiple times, then multiple files will be read\&.
-.RE
-.PP
\-x
.RS 4
In batch and interactive mode, exit on the first error encountered\&. Otherwise, errors during batch execution are simply reported\&.
@@ -620,9 +611,11 @@
Despite any errors encountered, proceed to process multiple ports and commands\&.
.RE
.PP
-\-y
+\fBDevelopment\fR
+.PP
+\-o
.RS 4
-Perform a dry run\&. All of the steps to build the ports and their dependencies are computed, but not actually performed\&. With the verbose flag, every step is reported; otherwise there is just one message per port, which allows you to easily determine the recursive deps of a port (and the order in which they will be built)\&.
+Honor state files older than Portfile
.RE
.PP
\-t
@@ -631,6 +624,27 @@
This feature is two\-folded\&. It consists in automatically detecting and reporting undeclared dependencies based on what files the port reads or what programs the port executes\&. In verbose mode, it will also report unused dependencies for each stage of the port installation\&. It also consists in forbidding and reporting file creation and file writes outside allowed
.RE
+.PP
+\fBMisc\fR
+.PP
+\-f
+.RS 4
+Force mode, ignore state file
+.RE
+.PP
+\-D \fIportdir\fR
+.RS 4
+Specfiy
+\fIportdir\fR
+.RE
+.PP
+\-F \fIcmdfile\fR
+.RS 4
+Read and process the
+\fIfile\fR
+of commands specified by the argument\&. If the argument is
+\fI\-\fR, then read commands from stdin\&. If the option is given multiple times, then multiple files will be read\&.
+.RE
.SH "USER TARGETS"
.sp
Targets most commonly used by regular MacPorts users are:
Modified: branches/new-help-system/base/doc/port.1.txt
===================================================================
--- branches/new-help-system/base/doc/port.1.txt 2009-04-10 01:05:01 UTC (rev 49447)
+++ branches/new-help-system/base/doc/port.1.txt 2009-04-10 01:22:54 UTC (rev 49448)
@@ -10,7 +10,7 @@
SYNOPSIS
--------
[verse]
-*port* [*-vdqfonRusbckixpty*] [*-D* 'portdir'] [*-F* 'cmdfile'] ['action'] ['actionflags']
+*port* [*-vdqnRuysbckxpotf*] [*-D* 'portdir'] [*-F* 'cmdfile'] ['action'] ['actionflags']
[['portname' | 'pseudo-portname' | 'port-expressions' | 'port-url']]
[['@version'] [+/-variant ...] ... [option=value ...]]
@@ -94,11 +94,12 @@
--------
-OPTIONS
--------
+GLOBAL OPTIONS
+--------------
-The port command also recognizes several command line flags and targets:
+The port command recognizes several global flags and options.
+.Output control
-v::
Verbose mode, generates verbose messages
@@ -108,6 +109,7 @@
-q::
Quiet mode, suppress informational messages to a minimum
+.Installation and upgrade
-n::
Don't follow dependencies in upgrade (only for 'upgrade')
@@ -117,12 +119,14 @@
-u::
Uninstall inactive ports when upgrading and uninstalling
--f::
- Force mode, ignore state file
+-y::
+ Perform a dry run. All of the steps to build the ports and their
+ dependencies are computed, but not actually performed. With the verbose
+ flag, every step is reported; otherwise there is just one message per port,
+ which allows you to easily determine the recursive deps of a port (and the
+ order in which they will be built).
--o::
- Honor state files older than Portfile
-
+.Sources
-s::
Source-only mode, build and install from source, ignore any existing binary
archives; do not create/recreate binary archives. (Applies only when
@@ -133,20 +137,14 @@
abort if no archive present; do not create/recreate binary archives from
source. (Applies only when 'archive mode' is enabled)
+.Cleaning
-c::
Autoclean mode, execute clean after 'install'
-k::
Keep mode, do not autoclean after 'install'
--D::
- Specfiy 'portdir'
-
--F::
- Read and process the 'file' of commands specified by the argument. If the
- argument is '-', then read commands from stdin. If the option is given
- multiple times, then multiple files will be read.
-
+.Exit status
-x::
In batch and interactive mode, exit on the first error encountered.
Otherwise, errors during batch execution are simply reported.
@@ -155,12 +153,9 @@
Despite any errors encountered, proceed to process multiple ports and
commands.
--y::
- Perform a dry run. All of the steps to build the ports and their
- dependencies are computed, but not actually performed. With the verbose
- flag, every step is reported; otherwise there is just one message per port,
- which allows you to easily determine the recursive deps of a port (and the
- order in which they will be built).
+.Development
+-o::
+ Honor state files older than Portfile
-t::
Enable trace mode debug facilities on platforms that support it, currently
@@ -172,7 +167,19 @@
forbidding and reporting file creation and file writes outside allowed
directories (temporary directories and ${workpath}).
+.Misc
+-f::
+ Force mode, ignore state file
+-D 'portdir'::
+ Specfiy 'portdir'
+
+-F 'cmdfile'::
+ Read and process the 'file' of commands specified by the argument. If the
+ argument is '-', then read commands from stdin. If the option is given
+ multiple times, then multiple files will be read.
+
+
USER TARGETS
------------
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.macosforge.org/pipermail/macports-changes/attachments/20090409/466952f1/attachment-0001.html>
More information about the macports-changes
mailing list