source: trunk/base/src/port/port-help.tcl @ 106617

Last change on this file since 106617 was 106617, checked in by jmr@…, 7 years ago

bring back clean --archive since files can persist in incoming/ in some circumstances

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 10.8 KB
Line 
1# This file contains help strings for the various commands/topics in port(1)
2#
3# Many of these strings are place-holders right now.  Replace with genuinely
4# helpful text and then delete this message.
5#
6# port-help.tcl
7# $Id: port-help.tcl 106617 2013-06-01 08:55:55Z jmr@macports.org $
8
9
10set porthelp(activate) {
11Activate the given ports
12
13--no-exec   Do not execute any stored pre- or post-activate procedures
14}
15
16set porthelp(archive) {
17Archive the given ports, i.e. install the port image but do not activate
18}
19
20set porthelp(archivefetch) {
21Fetch archive for the given ports
22}
23
24set porthelp(build) {
25Build the given ports
26}
27
28set porthelp(cat) {
29Writes the Portfiles of the given ports to stdout
30}
31
32set porthelp(cd) {
33Changes to the directory of the given port
34
35Only in interactive mode.
36}
37
38set porthelp(checksum) {
39Compares the checksums for the downloaded files of the given ports
40}
41
42set porthelp(clean) {
43Removes files associated with the given ports
44
45--archive     Removes temporary archives
46--dist        Removes downloaded distfiles
47--logs        Removes log files
48--work        Removes work directory (default)
49--all         Removes everything from above
50}
51
52set porthelp(configure) {
53Configure the given ports
54}
55
56set porthelp(contents) {
57Returns a list of files installed by given ports
58}
59
60set porthelp(deactivate) {
61Deactivates the given ports
62
63--no-exec   Do not execute any stored pre- or post-deactivate procedures
64}
65
66set porthelp(dependents) {
67Returns a list of installed dependents for each of the given ports
68
69Note: Don't get fooled by the language!
70Dependents are those ports which depend on the given port, not vice-versa!
71}
72
73set porthelp(rdependents) {
74Recursive version of dependents
75
76--full          Display all branches of the tree of dependents instead of only
77                showing each port once.
78}
79
80set porthelp(deps) {
81Display a dependency listing for the given ports
82
83--index         Do not read the Portfile, instead rely solely on the PortIndex
84                information. Note this option will prevent the dependencies
85                reported from reflecting the effects of any variants specified.
86--no-build      Exclude dependencies only required at build time, i.e.
87                depends_fetch, depends_extract, and depends_build.
88}
89
90set porthelp(rdeps) {
91Display a recursive dependency listing for the given ports
92
93--full          Display all branches of the dependency tree instead of only
94                showing each port once.
95--index         Do not read the Portfile, instead rely solely on the PortIndex
96                information. Note this option will prevent the dependencies
97                reported from reflecting the effects of any variants specified.
98--no-build      Exclude dependencies only required at build time, i.e.
99                depends_fetch, depends_extract, and depends_build.
100}
101
102set porthelp(destroot) {
103Destroot the given ports
104}
105
106set porthelp(dir) {
107Returns the directories of the given ports
108
109This can be quite handy to be used in your shell:
110cd $(port dir <portname>)
111}
112
113set porthelp(distcheck) {
114Checks if the given ports can be fetched from all of its master_sites
115}
116
117set porthelp(distfiles) {
118Returns a list of distfiles for the given port
119}
120
121set porthelp(dmg) {
122Creates a dmg for each of the given ports
123}
124
125set porthelp(dpkg) {
126Creates a dpkg for each of the given ports
127}
128
129set porthelp(echo) {
130Returns the list of ports the argument expands to
131
132This can be useful to see what a pseudo-port expression expands to.
133}
134
135set porthelp(edit) {
136Edit given ports
137}
138
139set porthelp(exit) {
140Exit port
141
142Only in interactive mode.
143}
144
145set porthelp(extract) {
146Extract the downloaded files of the given ports
147}
148
149set porthelp(fetch) {
150Downloaded distfiles for the given ports
151}
152
153set porthelp(file) {
154Returns the path to the Portfile for each of the given ports
155}
156
157set porthelp(gohome) {
158Opens the homepages of the given ports in your browser
159}
160
161set porthelp(help) {
162Displays short help texts for the given actions
163}
164
165set porthelp(info) {
166Returns information about the given ports. Most of the options specify a field
167to be included in the resulting report. Multiple fields may be specified, in
168which case all will be included.  If no fields are specified, a useful default
169set will be used.  The other options which do not correspond to fields are:
170   --depends   An abbreviation for all depends_* fields
171   --index     Do not read the Portfile, instead rely solely on the index
172               information. Note this option will prevent the information
173               reported from reflecting the effects of any variants specified.
174   --line      Report on each port on a single line, with fields separated
175               by spaces.  Handy for automatically processing the output of
176               info called on a large number of ports.
177   --pretty    Format the output in a convenient, human-readable fashion. Note
178               that this option is the default when no options are specified to
179               info.
180}
181
182set porthelp(install) {
183Installs the given ports.
184    --no-rev-upgrade    Do not run rev-upgrade after the installation.
185    --unrequested       Do not mark the port as requested.
186}
187
188set porthelp(installed) {
189List installed versions of the given port, or all installed ports if no port is given
190}
191
192set porthelp(lint) {
193Checks if the Portfile is lint-free for each of the given ports
194}
195
196set porthelp(list) {
197List the available version for each of the given ports
198}
199
200set porthelp(livecheck) {
201Checks if a new version of the software is available
202}
203
204set porthelp(load) {
205Interface to launchctl(1) for ports providing startup items
206}
207
208set porthelp(location) {
209Returns the install location for each of the given ports
210}
211
212set porthelp(log) {
213Shows main log for given ports
214
215--phase <phase>         Filters by phase (fetch, checksum, extract, patch, configure, build, destroot)
216--level <level>         Filter messages above verbosity level (error, warn, msg, info, debug)
217}
218
219set porthelp(mdmg) {
220Creates a dmg containing an mpkg for each of the given ports and their dependencies
221}
222
223set porthelp(mirror) {
224Fetches distfiles for the given ports
225}
226
227set porthelp(mpkg) {
228Creates an mpkg for each of the given ports and their dependencies
229}
230
231set porthelp(notes) {
232Displays informational notes for each of the given ports
233}
234
235set porthelp(outdated) {
236Returns a list of outdated ports
237}
238
239set porthelp(patch) {
240Applies patches to each of the given ports
241}
242
243set porthelp(pkg) {
244Creates a pkg for each of the given ports
245}
246
247set porthelp(platform) {
248Returns the current platform that port is running on
249}
250
251set porthelp(provides) {
252Return which port provides each of the files given
253}
254
255set porthelp(quit) $porthelp(exit)
256
257set porthelp(rev-upgrade) {
258Scan for broken binaries in the installed ports and rebuild them as needed. Can
259be run with -y to only report broken ports, but not automatically rebuild them.
260
261You normally wouldn't have to run rev-upgrade manually; it is run automatically
262after each install and upgrade by default. Rev-upgrade doesn't honor package
263names, e.g.
264        upgrade outdated
265will not run rev-upgrade only on outdated, because ports not in outdated might
266have been broken by upgrade outdated. Rev-upgrade will always run on all your
267active ports.
268
269See man 1 port, section rev-upgrade, and man 5 macports.conf, directives
270starting with revupgrade_ for configuration and more information.
271}
272
273set porthelp(rpm) {
274Creates a rpm for each of the given ports
275}
276
277set porthelp(search) {
278Search for a port
279
280--case-sensitive   match the search string in a case-sensitive manner
281--exact   match the literal search string exactly
282--glob    treat the given search string as a glob (default)
283--line    print each result on a single line
284--regex   treat the given search string as a regular expression
285--<field> match against <field>, default is '--name --description'
286}
287
288set porthelp(select) {
289Select between multiple versions of a versioned port
290
291This allows you to choose which version, among several installed versions
292of a port, is to be considered primary.  What this means is which version
293becomes the one most would consider the default, e.g. the one run without
294specifying any version.
295
296One example is the set of python ports, where there are (among others)
297python25, python26, and python31.  The select action lets you set which
298of these becomes the version run when you simply use 'python'.
299
300<arguments> must include the group upon which to be acted, and may include
301a version if --set is used.
302
303--list   List available versions for the group
304--set    Select the given version for the group
305--show   Show which version is currently selected for the group (default if
306         none given)
307}
308
309set porthelp(selfupdate) {
310Upgrade MacPorts itself and run the sync target
311}
312
313set porthelp(space) {
314Show the disk space used by the given ports
315
316--units <units> Specify units to use. Accepted units are: B, kB, KiB, MB, MiB,
317                GB, GiB. The 'B' may be omitted.
318--total         Display the grand total only
319}
320
321set porthelp(srpm) {
322Creates a srpm for each of the given ports
323}
324
325set porthelp(setrequested) {
326Marks each of the given ports as requested
327}
328
329set porthelp(unsetrequested) {
330Marks each of the given ports as unrequested
331}
332
333set porthelp(sync) {
334Synchronize the set of Portfiles
335}
336
337set porthelp(test) {
338Run tests on each of the given ports
339}
340
341set porthelp(unarchive) {
342Unarchive the destroot of the given ports from installed images
343}
344
345set porthelp(uninstall) {
346Uninstall the given ports
347
348--follow-dependents     Recursively uninstall all ports that depend on the
349                        specified port before uninstalling the port itself.
350--follow-dependencies   Also recursively uninstall all ports that the
351                        specified port depended on. This will not uninstall
352                        dependencies that are marked as requested or that
353                        have other dependents.
354--no-exec               Do not execute any stored pre- or post-uninstall
355                        procedures.
356}
357
358set porthelp(unload) $porthelp(load)
359
360set porthelp(upgrade) {
361Upgrades the given ports to the latest version. Respects global options
362-n, -R, and -u (see the port man page).  Note that in selecting variants
363to use in the upgraded build of the port, the order of precedence is variants
364specified on the command line, then variants active in the latest installed
365version of the port, then the variants.conf file.
366
367--force             Ignore circumstances that would normally cause ports to be
368                    skipped (e.g. not outdated).
369--enforce-variants  If the installed variants do not match those requested,
370                    upgrade even if the port is not outdated.
371--no-replace        Do not replace one port with another according to the
372                    replaced_by field
373}
374
375set porthelp(url) {
376Returns the URL for each of the given ports
377}
378
379set porthelp(usage) {
380Returns basic usage of the port command
381}
382
383set porthelp(variants) {
384Returns a list of variants provided by the given ports, with descriptions if present
385}
386
387set porthelp(version) {
388Returns the version of MacPorts
389}
Note: See TracBrowser for help on using the repository browser.