source: trunk/base/doc/port-dir.1.txt

Last change on this file was 123948, checked in by cal@…, 5 years ago

base: unify formatting in manpages

  • all options are printed in bold
  • 'Portfile' is always underlined
  • fix list in port-lint.1
  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 2.5 KB
Line 
1// vim: set et sw=4 ts=8 ft=asciidoc tw=80:
2port-dir(1)
3===========
4$Id: port-dir.1.txt 123948 2014-08-16 13:45:03Z cal@macports.org $
5
6NAME
7----
8port-dir, port-url, port-file, port-location, port-work - Print paths for
9certain properties of a port
10
11SYNOPSIS
12--------
13[cmdsynopsis]
14*port* [*-D* 'portdir'] *dir*
15     [['portname' | 'pseudo-portname' | 'port-expressions' | 'port-url']]
16
17[cmdsynopsis]
18*port* [*-D* 'portdir'] *url*
19     [['portname' | 'pseudo-portname' | 'port-expressions' | 'port-url']]
20
21[cmdsynopsis]
22*port* [*-D* 'portdir'] *file*
23     [['portname' | 'pseudo-portname' | 'port-expressions' | 'port-url']]
24
25[cmdsynopsis]
26*port* [*-q*] [*-D* 'portdir'] *location*
27     [['portname' | 'pseudo-portname' | 'port-expressions' | 'port-url']]
28
29[cmdsynopsis]
30*port* [*-D* 'portdir'] *work*
31     [['portname' | 'pseudo-portname' | 'port-expressions' | 'port-url']]
32
33DESCRIPTION
34-----------
35These commands print a path for each given port. The meaning of the path
36differs by the command given:
37
38*port dir* prints the directory that contains the 'Portfile' for the given port
39expression. This can be quite handy in your shell, if you want to locate
40a 'Portfile':
41
42----
43cd $(port dir <portname>)
44----
45
46*port url* prints a unique URL for the given port expression. This command
47mostly exists for historical reasons and isn't of much use nowadays.
48
49*port file* prints the path of the 'Portfile' for the given port expression.
50This can be useful to locate a port's definition. Note that you can always get
51this by using *port dir* and appending 'Portfile'. You could use *port file* in
52a shell to edit a Portfile, but note that you can also use man:port-edit[1] to
53achieve the same.
54
55*port location* only works for installed ports and prints the location of the
56archive MacPorts internally uses to be able to deactivate and activate a port.
57See man:port-activate[1] for more details on that. This command might be useful
58for you if you want to setup a local binary mirror of MacPorts packages that are
59not available from our official infrastructure due to licensing reasons.
60
61*port work* prints the path to the so-called 'work' directory, i.e., the
62directory used by MacPorts to build a port. No output is generated if no build
63directory exists, e.g., because there is no unfinished build in progress for the
64given port. Work directories are deleted after successful installation or using
65man:port-clean[1].
66
67include::global-flags.txt[]
68
69SEE ALSO
70--------
71man:port[1], man:port-edit[1], man:port-activate[1], man:port-clean[1]
72
73AUTHORS
74-------
75 (C) 2014 The MacPorts Project
76 Clemens Lang <cal@macports.org>
Note: See TracBrowser for help on using the repository browser.