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

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

doc-new: Fixed "SEE ALSO" links.

File size: 8.9 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      <group>
23        <synopfragmentref linkend="options">options</synopfragmentref>
24      </group>
25      <group>
26        <arg choice="plain"><replaceable>action</replaceable></arg>
27        <group>
28          <arg choice="plain"><replaceable>actionoptions</replaceable></arg>
29        </group>
30      </group>
31      <group rep="repeat"><synopfragmentref linkend="target">
32          target</synopfragmentref>&nbsp;</group>
33      <arg rep="repeat">
34        <replaceable>setting</replaceable>=<replaceable>value</replaceable>&nbsp;
35      </arg>
36      <synopfragment id="options">
37        <arg>-vdqfonRusbckixpt</arg>
38        <arg>-D <replaceable>portdir</replaceable></arg>
39        <arg>-F <replaceable>cmdfile</replaceable></arg>
40      </synopfragment>
41
42      <synopfragment id="target">
43        <group>
44          <arg choice="plain"><replaceable>portname</replaceable></arg>
45          <arg choice="plain"><replaceable>pseudo-portname</replaceable></arg>
46          <arg choice="plain"><replaceable>port-url</replaceable></arg>
47        </group>
48        <sbr />
49        <group rep="repeat">
50          <arg>
51            <replaceable>@version</replaceable>
52          </arg>
53          <group rep="repeat">
54            <arg choice="plain">
55              +<replaceable>variant</replaceable>
56            </arg>
57            <arg choice="plain">
58              -<replaceable>variant</replaceable>
59            </arg>
60          </group>
61          &#xA0;
62        </group>
63      </synopfragment>
64
65    </cmdsynopsis>
66  </refsynopsisdiv>
67
68  <refsection>
69    <title>Description</title>
70
71    <para>
72      <command>port</command> is the command-line interface to the MacPorts
73      ports system.  It provides access to information about available ports and
74      allows the management of their installation, upgrading and removal.
75    </para>
76
77    <para>
78      When run without an <replaceable>action</replaceable>,
79      <command>port</command> enters an interactive mode interpreter where
80      multiple actions can be entered in succession.  Otherwise,
81      <command>port</command> acts like an ordinary command-line program.
82    </para>
83  </refsection>
84
85  <refsection>
86    <title>GLOBAL OPTIONS</title>
87
88    <variablelist>
89      <varlistentry>
90        <term><option>-q</option></term>
91
92        <listitem>
93          <para>quiet mode (suppress messages)</para>
94        </listitem>
95      </varlistentry>
96
97      <varlistentry>
98        <term><option>-v</option></term>
99
100        <listitem>
101          <para>verbose mode (generate verbose messages)</para>
102        </listitem>
103      </varlistentry>
104
105      <varlistentry>
106        <term><option>-n</option></term>
107
108        <listitem>
109          <para>debug mode (generate debugging messages, implies
110          <option>-v</option>)</para>
111        </listitem>
112      </varlistentry>
113
114      <varlistentry>
115        <term><option>-n</option></term>
116
117        <listitem>
118          <para>don&rsquo;t follow dependencies in upgrade (only for
119          upgrading)</para>
120        </listitem>
121      </varlistentry>
122
123      <varlistentry>
124        <term><option>-R</option></term>
125
126        <listitem>
127          <para>also upgrade dependents (only for upgrading)</para>
128        </listitem>
129      </varlistentry>
130
131      <varlistentry>
132        <term><option>-u</option></term>
133
134        <listitem>
135          <para>uninstall non-active ports when upgrading and
136          uninstalling</para>
137        </listitem>
138      </varlistentry>
139
140      <varlistentry>
141        <term><option>-f</option></term>
142
143        <listitem>
144          <para>force mode (ignore state file)</para>
145        </listitem>
146      </varlistentry>
147
148      <varlistentry>
149        <term><option>-o</option></term>
150
151        <listitem>
152          <para>honor state files older than Portfile</para>
153        </listitem>
154      </varlistentry>
155
156      <varlistentry>
157        <term><option>-s</option></term>
158
159        <listitem>
160          <para>source-only mode (build and install from source, ignore all
161          binary archives, do not create/recreate binary archives) (only
162          applies when archive mode is enabled)</para>
163        </listitem>
164      </varlistentry>
165
166      <varlistentry>
167        <term><option>-b</option></term>
168
169        <listitem>
170          <para>binary-only mode (build and install from binary archives,
171          ignore source, abort if no archive present; do not create/recreate
172          binary archives from source) (only applies when archive mode is
173          enabled)</para>
174        </listitem>
175      </varlistentry>
176
177      <varlistentry>
178        <term><option>-c</option></term>
179
180        <listitem>
181          <para>autoclean mode (execute clean after install)</para>
182        </listitem>
183      </varlistentry>
184
185      <varlistentry>
186        <term><option>-k</option></term>
187
188        <listitem>
189          <para>keep mode (don't autoclean after install)</para>
190        </listitem>
191      </varlistentry>
192
193      <varlistentry>
194        <term><option>-D</option></term>
195
196        <listitem>
197          <para>specify <replaceable>portdir</replaceable>, the home directory
198          for a port (see ... below)</para>
199        </listitem>
200      </varlistentry>
201
202      <varlistentry>
203        <term><option>-F</option></term>
204
205        <listitem>
206          <para>Read and process the <replaceable>file</replaceable> of
207          commands specified by the argument. If the argument is '-', then
208          read commands from stdin. If the option is given multiple times,
209          then multiple files will be read.</para>
210        </listitem>
211      </varlistentry>
212
213      <varlistentry>
214        <term><option>-i</option></term>
215
216        <listitem>
217          <para>Read commands from stdin. Short for <option>-F</option>
218          -</para>
219        </listitem>
220      </varlistentry>
221
222      <varlistentry>
223        <term><option>-x</option></term>
224
225        <listitem>
226          <para>In batch and interactive mode, exit on the first error
227          encountered. Otherwise, errors during batch execution are simply
228          reported.</para>
229        </listitem>
230      </varlistentry>
231
232      <varlistentry>
233        <term><option>-p</option></term>
234
235        <listitem>
236          <para>Despite any errors encountered, proceed to process multiple
237          ports and commands.</para>
238        </listitem>
239      </varlistentry>
240
241      <varlistentry>
242        <term><option>-t</option></term>
243
244        <listitem>
245          <para>enable trace mode debug facilities on platforms that support
246          it (Mac OS X). This feature is two-folded. It consists in
247          automatically detecting and reporting undeclared dependencies based
248          on what files the port reads or what programs the port executes. In
249          verbose mode, it will also report unused dependencies for each stage
250          of the port installation. It also consists in forbidding and
251          reporting file creation and file writes outside allowed directories
252          (temporary directories and <varname>${workpath}</varname>).</para>
253        </listitem>
254      </varlistentry>
255    </variablelist>
256  </refsection>
257
258  <refsection>
259    <title>SEE ALSO</title>
260
261    <para>
262      <citerefentry>
263        <refentrytitle>macports.conf</refentrytitle>
264        <manvolnum>5</manvolnum>
265      </citerefentry>,
266      <citerefentry>
267        <refentrytitle>portfile</refentrytitle>
268        <manvolnum>7</manvolnum>
269      </citerefentry>,
270      <citerefentry>
271        <refentrytitle>portgroup</refentrytitle>
272        <manvolnum>7</manvolnum>
273      </citerefentry>,
274      <citerefentry>
275        <refentrytitle>portstyle</refentrytitle>
276        <manvolnum>7</manvolnum>
277      </citerefentry>,
278      <citerefentry>
279        <refentrytitle>porthier</refentrytitle>
280        <manvolnum>7</manvolnum>
281      </citerefentry>
282    </para>
283  </refsection>
284
285  <refsection>
286    <title>AUTHORS</title>
287
288    <para>Landon Fuller <email>landonf@macports.org</email></para>
289
290    <para>Juan Manuel Palacios <email>jmpp@macports.org</email></para>
291
292    <para>Mark Duling <email>markd@macports.org</email></para>
293
294    <para>Kevin Van Vechten <email>kevin@opendarwin.org</email></para>
295
296    <para>Jordan K. Hubbard <email>jkh@macports.org</email></para>
297
298    <para>Chris Ridd <email>cjr@opendarwin.org</email></para>
299
300    <para>Kevin Ballard <email>eridius@macports.org</email></para>
301
302    <para>Markus W. Weissmann <email>mww@macports.org</email></para>
303
304    <para>Boey Maun Suang <email>boeyms@macports.org</email></para>
305  </refsection>
306</refentry>
Note: See TracBrowser for help on using the repository browser.