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

Last change on this file since 103400 was 103400, checked in by cal@…, 8 years ago

base: remove portsubmit and its dependencies.

See

https://lists.macosforge.org/pipermail/macports-dev/2013-February/021981.html

and following.

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