source: trunk/doc-new/man/xml/port.1.xml @ 31428

Last change on this file since 31428 was 31428, checked in by boeyms@…, 13 years ago

port.1.xml: Beginnings of a new DocBook man page for port(1).

File size: 5.2 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
2<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
4<refentry>
5  <refmeta>
6    <refentrytitle>PORT</refentrytitle>
7    <manvolnum>1</manvolnum>
8                <refmiscinfo role="name">The MacPorts Project</refmiscinfo>
9                <refmiscinfo role="productname">MacPorts</refmiscinfo>
10                <refmiscinfo role="productnumber">1.6</refmiscinfo>
11  </refmeta>
12
13  <refnamediv>
14    <refname>port</refname>
15
16    <refpurpose>operate on individual or multiple Mac ports</refpurpose>
17  </refnamediv>
18
19  <refsynopsisdiv>
20    <cmdsynopsis>
21      <command>port</command>
22                        <!-- Detailed option description omitted in favour of general one
23                        <group>
24                                <arg choice="plain">-v</arg>
25                                <arg choice="plain">-d</arg>
26                                <arg choice="plain">-q</arg>
27                        </group>
28                        <group>
29                                <arg choice="plain">-n</arg>
30                                <arg choice="plain">-R</arg>
31                        </group>
32                        <group>
33                                <arg choice="plain">-s</arg>
34                                <arg choice="plain">-b</arg>
35                        </group>
36                        <group>
37                                <arg choice="plain">-c</arg>
38                                <arg choice="plain">-k</arg>
39                        </group>
40      <arg>-D <replaceable>portdir</replaceable></arg>
41      <arg>-F <replaceable>cmdfile</replaceable></arg>
42                        -->
43                        <arg><replaceable>options</replaceable></arg>
44                        <group>
45                                <arg choice="plain"><replaceable>action</replaceable></arg>
46                                <group>
47                                        <arg choice="plain"><replaceable>actionoptions</replaceable></arg>
48                                </group>
49                        </group>
50                        <!--
51      <group>
52          <arg choice="plain"><replaceable>portname</replaceable></arg>
53          <arg choice="plain"><replaceable>pseudo-portname</replaceable></arg>
54          <arg choice="plain"><replaceable>port-url</replaceable></arg>
55      </group>
56                        -->
57                        <arg rep="repeat"><replaceable>target</replaceable>&nbsp;</arg>
58                        <!--
59                        <group rep="repeat">
60                                <arg>
61                                        <replaceable>@version</replaceable>
62                                </arg>
63                                <group rep="repeat">
64                                        <arg choice="plain">
65                                                +/-<replaceable>variant</replaceable>
66                                        </arg>
67                                </group>
68                        </group>
69                        -->
70                        <arg rep="repeat">
71                                <replaceable>setting</replaceable>=<replaceable>value</replaceable>&nbsp;
72                        </arg>
73    </cmdsynopsis>
74  </refsynopsisdiv>
75
76  <refsection>
77    <title>Description</title>
78
79                <para>
80                        <!--
81                        <command>port</command> is designed to operate on individual or
82                        multiple Mac <option>ports</option>, optionally within a single call,
83                        based on the requested <option>action</option>.  If no
84                        <option>portdir</option> or <option>portname</option> is specified, the
85                        current working directory is assumed; if no <option>action</option> is
86                        specified the port command enters interactive mode, in which commands are
87                        read via stdin. Batch commands may be passed via a
88                        <option>cmdfile</option>.  Port <option>options</option> are passed as
89                        key=value pairs and take precedence over individual
90                        <option>portname</option> options as specified in its Portfile and
91                        system-wide settings.
92                        -->
93                        <command>port</command> is the command-line interface to the MacPorts
94                        ports system.  It provides access to information about available ports and
95                        allows the management of their installation, upgrading and removal.
96                </para>
97
98                <para>
99                        When run without an <replaceable>action</replaceable>,
100                        <command>port</command> enters an interactive mode interpreter where
101                        multiple actions can be entered in succession.  Otherwise,
102                        <command>port</command> acts like an ordinary command-line program.
103                </para>
104                <!--
105                <para>
106                        Port <option>variants</option> can specified as
107                        <option>+name</option>, which indicates the variant is desired, or
108                        <option>-name</option>, indicating the contrary. In case of ambiguities, a
109                        port can be fully specified with the
110                        <option>@version_revision+variants</option> format.
111                </para>
112                -->
113  </refsection>
114
115  <refsection>
116    <title>SEE ALSO</title>
117
118    <para><citerefentry>
119        <refentrytitle>port</refentrytitle>
120
121        <manvolnum>1</manvolnum>
122      </citerefentry>, <citerefentry>
123        <refentrytitle>macports.conf</refentrytitle>
124
125        <manvolnum>5</manvolnum>
126      </citerefentry>, <citerefentry>
127        <refentrytitle>portgroup</refentrytitle>
128
129        <manvolnum>7</manvolnum>
130      </citerefentry>, <citerefentry>
131        <refentrytitle>portstyle</refentrytitle>
132
133        <manvolnum>7</manvolnum>
134      </citerefentry>, <citerefentry>
135        <refentrytitle>porthier</refentrytitle>
136
137        <manvolnum>7</manvolnum>
138      </citerefentry>, <citerefentry>
139        <refentrytitle>file</refentrytitle>
140
141        <manvolnum>n</manvolnum>
142      </citerefentry></para>
143  </refsection>
144
145  <refsection>
146    <title>AUTHORS</title>
147
148    <para>Landon Fuller <email>landonf@macports.org</email></para>
149
150    <para>Juan Manuel Palacios <email>jmpp@macports.org</email></para>
151
152    <para>Mark Duling <email>markd@macports.org</email></para>
153
154    <para>Kevin Van Vechten <email>kevin@opendarwin.org</email></para>
155
156    <para>Jordan K. Hubbard <email>jkh@macports.org</email></para>
157
158    <para>Chris Ridd <email>cjr@opendarwin.org</email></para>
159
160    <para>Kevin Ballard <email>eridius@macports.org</email></para>
161
162    <para>Markus W. Weissmann <email>mww@macports.org</email></para>
163
164    <para>Boey Maun Suang <email>boeyms@macports.org</email></para>
165  </refsection>
166</refentry>
Note: See TracBrowser for help on using the repository browser.