[123682] trunk/base/doc

[cal at macports.org]

Revision: 123682
          https://trac.macports.org/changeset/123682
Author:   cal at macports.org
Date:     2014-08-12 05:29:39 -0700 (Tue, 12 Aug 2014)
Log Message:
-----------
base: generate roff from asciidoc

Added Paths:
-----------
    trunk/base/doc/port-deps.1
    trunk/base/doc/port-rdeps.1

Added: trunk/base/doc/port-deps.1
===================================================================
--- trunk/base/doc/port-deps.1	                        (rev 0)
+++ trunk/base/doc/port-deps.1	2014-08-12 12:29:39 UTC (rev 123682)
@@ -0,0 +1,91 @@
+'\" t
+.TH "PORT\-DEPS" "1" "2014\-08\-12" "MacPorts 2\&.3\&.99" "MacPorts Manual"
+.\" -----------------------------------------------------------------
+.\" * Define some portability stuff
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
+port-deps, port-rdeps \- Display a dependency listing for the given port(s)
+.SH "SYNOPSIS"
+.sp
+.nf
+\fBport\fR [\fB\-D\fR \fIportdir\fR] \fBdeps\fR
+     [\-\-index] [\-\-no\-build]
+     [[\fIportname\fR | \fIpseudo\-portname\fR | \fIport\-expressions\fR | \fIport\-url\fR]]
+.fi
+.sp
+.nf
+\fBport\fR [\fB\-D\fR \fIportdir\fR] \fBrdeps\fR
+     [\-\-full] [\-\-index] [\-\-no\-build]
+     [[\fIportname\fR | \fIpseudo\-portname\fR | \fIport\-expressions\fR | \fIport\-url\fR]]
+.fi
+.SH "DESCRIPTION"
+.sp
+\fBport deps\fR lists all dependencies of the given port(s), i\&.e\&., the ports that need to be installed to build or use a port\&.
+.sp
+\fBport rdeps\fR recursively descends into the dependencies and displays a tree of dependencies for a given port\&.
+.SH "OPTIONS"
+.PP
+\fB\-\-full\fR
+.RS 4
+When using
+\fBrdeps\fR, display all branches of the dependency tree instead of listing each dependency only once\&.
+.RE
+.PP
+\fB\-\-index\fR
+.RS 4
+Do not read Portfiles, but instead rely solely on the PortIndex information\&. Note that this option will prevent the dependencies reported from reflecting the effects of any variants specified\&.
+.RE
+.PP
+\fB\-\-no\-build\fR
+.RS 4
+Exclude dependencies only required at build time, i\&.e\&., fetch, extract, and build dependencies\&.
+.RE
+.SH "GLOBAL OPTIONS"
+.sp
+Please see the section \fBGLOBAL OPTIONS\fR in the \fBport\fR(1) man page for a description of global port options\&.
+.SH "DEPENDENCY RELATIONS"
+.sp
+Do not confuse \fIdependents\fR and \fIdependencies\fR (or, shortened, \fIdeps\fR)\&. Refer to the following example to understand the difference:
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+portA \-\-> portB
+.fi
+.if n \{\
+.RE
+.\}
+.sp
+\fBportA\fR depends on \fBportB\fR, i\&.e\&., \fBportA\fR needs \fBportB\fR to run\&. Because of that, \fBportB\fR is a \fIdependency\fR (or \fIdep\fR) of \fBportA\fR\&. After installing \fBportA\fR, \fBportB\fR has been automatically installed\&. At this point, \fBportA\fR has become a \fIdependent\fR of \fBportB\fR\&. You can only uninstall \fBportB\fR once all of its dependents (i\&.e\&., including \fBportA\fR) have been uninstalled\&.
+.SH "SEE ALSO"
+.sp
+\fBport\fR(1), \fBport-variants\fR(1)
+.SH "AUTHORS"
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+(C) 2014 The MacPorts Project
+Clemens Lang <cal at macports\&.org>
+.fi
+.if n \{\
+.RE
+.\}

Added: trunk/base/doc/port-rdeps.1
===================================================================
--- trunk/base/doc/port-rdeps.1	                        (rev 0)
+++ trunk/base/doc/port-rdeps.1	2014-08-12 12:29:39 UTC (rev 123682)
@@ -0,0 +1 @@
+.so man1/port-deps.1
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.macosforge.org/pipermail/macports-changes/attachments/20140812/d017da2e/attachment-0001.html>