source: trunk/base/doc/macports.conf.5.txt @ 131109

Last change on this file since 131109 was 131109, checked in by jeremyhu@…, 6 years ago

Fix documentation for default_compilers option

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 8.7 KB
Line 
1// vim: set et sw=4 ts=8 ft=asciidoc tw=80:
2macports.conf(5)
3================
4$Id: macports.conf.5.txt 131109 2015-01-06 07:29:35Z jeremyhu@macports.org $
5
6NAME
7----
8macports.conf - Configuration file of the MacPorts system
9
10DESCRIPTION
11-----------
12*macports.conf* is the configuration file used to bootstrap the MacPorts
13system. This file is read by the *port* command and determines how it behaves.
14Lines beginning with '#' are comments, empty lines are ignored. The format is
15that of a simple key/value space or tab separated pair.
16
17The file contains entries of the form:
18--------
19<key> <value>
20--------
21
22The value of any given key can be referred to by the '$\{<keyname>\}'
23abstraction, where '<keyname>' expands to the key in question.
24
25KEYS
26----
27// Set default style for second-level labeled lists in this section
28:listdef-labeled2.style: horizontal
29
30The following keys are used by *port* itself:
31
32prefix::
33    Sets the directory where ports are installed. Any path may be used but those
34    with spaces and/or non ascii characters should be avoided, as this can break
35    some ports. This key is often referred to as '$\{prefix\}'.
36    *Default:*;; /opt/local
37
38portdbpath::
39    Directory where MacPorts keeps working data such as downloaded sources,
40    installed ports' receipts and the main registry. The same path restrictions
41    apply as for '$\{prefix\}'.
42    *Default:*;; $\{prefix\}/var/macports
43
44portdbformat::
45    Storage type to use for the MacPorts registry. The preferred format is
46    "sqlite", with "flat" also available as a legacy format.
47    *Default:*;; sqlite
48
49applications_dir::
50    Directory containing Applications installed from ports.
51    *Default:*;; /Applications/MacPorts
52
53frameworks_dir::
54    Directory containing Frameworks installed from ports.
55    *Default:*;; $\{prefix\}/Library/Frameworks
56
57sources_conf::
58    Location of the sources file. This file enables rsync synchronization of the
59    default ports tree with the MacPorts rsync server (through the "sync" target
60    of the port command) and any other local tree(s) you might have.
61    *Default:*;; $\{prefix\}/etc/macports/sources.conf
62
63variants_conf::
64    Location of the optional global variants definition file, listing those that
65    should be used in all installed ports if available.
66    *Default:*;; $\{prefix\}/etc/macports/variants.conf
67
68buildfromsource::
69    Controls whether ports are built from source or downloaded as pre-built
70    archives. Setting to 'always' will never use archives, 'never' will always
71    try to use an archive and fail if one is not available. 'ifneeded' will try
72    to fetch an archive and fall back to building from source if that isn't
73    possible.
74    *Default:*;; ifneeded
75
76portarchivetype::
77    Format of archives in which to store port images. This controls both the
78    type of archive cre- ated locally after building from source, and the type
79    to request from remote servers. Changing this will not affect the usability
80    of already installed archives; they can be of any supported type.
81    *Supported types:*;; tgz, tar, tbz, tbz2, tlz, txz, xar, zip, cpgz, cpio
82    *Default:*;; tbz2
83
84configureccache::
85    Use ccache (C/C++ compiler cache). Requires that ccache has been installed.
86    *Default:*;; no
87
88ccache_dir::
89    Location where ccache stores its files
90    *Default:*;; $\{portdbpath\}/build/.ccache
91
92ccache_size::
93    Maximum size ccache may use. Use 'G', 'M', or 'K' suffix for giga-, mega- or
94    kilobytes.
95    *Default:*;; 2G
96
97configuredistcc::
98    Use distcc (distributed compiler). Requires that distcc has been installed.
99    *Default:*;; no
100
101configurepipe::
102    Use pipes rather than intermediate files when compiling C/C++/etc (gcc
103    -pipe)
104    *Default:*;; yes
105
106buildnicevalue::
107    Lowered scheduling priority (0-20) to use for make when building ports
108    *Default:*;; 0
109
110buildmakejobs::
111    Number of simultaneous make jobs (commands) to use when building ports. 0 is
112    a special value meaning "the number of CPU cores or the number of GB of
113    physical memory plus one, whichever is less."
114    *Default:*;; 0
115
116portautoclean::
117    Automatic cleaning of the build directory of a given port after it has been
118    installed.
119    *Default:*;; yes
120
121keeplogs::
122    Keep logs for ports.
123    *Default:*;; no
124
125build_arch::
126    The machine architecture to try to build for in normal use.
127    *Regular architectures include:*;; ppc, i386, ppc64, x86_64
128    *Default (10.6):*;; x86_64 or i386 depending on hardware
129    *Default (10.5 and earlier):*;; i386 or ppc depending on hardware
130
131universal_archs::
132    The machine architectures to use for +universal variant (multiple
133    architecture entries should be space separated).
134    *Regular architectures include:*;; ppc, i386, ppc64, x86_64
135    *Default (10.6):*;; x86_64 i386
136    *Default (10.5 and earlier):*;; i386 ppc
137
138startupitem_type::
139    Set the default type of startupitems to be generated, overridable by
140    Portfiles that explicitly state a startupitem.type key. If set to "default",
141    then a type will be selected that's appropriate to the OS.
142    *Supported types:*;; none, SystemStarter, launchd, default, rcNG.
143    *Default:*;; default
144
145destroot_umask::
146    Umask value to use during the destrooting of a port.
147    *Default:*;; 022
148
149rsync_server::
150    Default rsync server to connect to when running "selfupdate" through the
151    port com- mand to update your base MacPorts infrastructure. While selfupdate
152    also syncs the ports tree, it uses the settings from $\{sources_conf\} to do
153    so.
154    *Default:*;; rsync.macports.org
155
156rsync_dir::
157    Rsync directory from which to pull MacPorts sources from the rsync server.
158    *Default:*;; release/base/ (which pulls sources for the currently shipping
159    MacPorts release)
160
161rsync_options::
162    Default rsync options to use when connecting to the rsync server.
163    *Default:*;; -rtzv --delete-after
164
165binpath::
166    Sets the directory search path for locating system executables used by
167    MacPorts. This variable should contain the paths for locating utilities such
168    as rsync, tar, cvs and others. Don't change this unless you understand and
169    accept the consequences.
170    *Default:*;; $\{prefix\}/bin:$\{prefix\}/sbin:/bin:/sbin:/usr/bin:/usr/sbin
171
172extra_env::
173    List of extra environment variables MacPorts should keep in the user's
174    environment when sanitizing it. Changing this is unsupported.
175
176proxy_override_env::
177    Proxy support. Precedence is: env, macports.conf, System Preferences. That
178    is, if it's set in the environment, that will be used instead of anything
179    here or in System Preferences. Setting proxy_override_env to yes will cause
180    any proxies set here (or in System Preferences if set there but not here) to
181    override what's in the environment. Note that System Preferences doesn't
182    have an rsync proxy definition. Also note, on 10.5, sudo will clear many
183    environment variables including those for proxy support. Equivalent
184    environment variables: http_proxy, HTTPS_PROXY, FTP_PROXY, RSYNC_PROXY,
185    NO_PROXY
186    *Default:*;; yes
187
188proxy_http::
189    HTTP proxy
190    *Default:*;; none
191
192proxy_https::
193    HTTPS proxy
194    *Default:*;; none
195
196proxy_ftp::
197    FTP proxy
198    *Default:*;; none
199
200proxy_rsync::
201    rsync proxy
202    *Default:*;; none
203
204proxy_skip::
205    Hosts not to go through the proxy (comma-separated, applies to HTTP, HTTPS
206    and FTP, but not rsync).
207    *Default:*;; none
208
209host_blacklist::
210    Space separated list of download hosts that should not be used.
211    *Default:*;; none
212
213preferred_hosts::
214    Space separated list of download hosts that should be used preferentially.
215    *Default:*;; none
216
217revupgrade_autorun::
218    Controls whether the rev-upgrade action will be run automatically after
219    upgrading ports.
220    *Default:*;; yes
221
222revupgrade_mode::
223    Controls the rev-upgrade functionality which checks for broken linking and
224    can rebuild ports to fix it. 'rebuild' means ports will automatically be
225    rebuilt when broken linking is detected in their files, while 'report' means
226    broken files will be scanned for and reported but the ports will not be
227    rebuilt.
228    *Default:*;; rebuild
229
230default_compilers::
231    Default value for configure.compiler. This can be a space-separated list.
232    Later entries will be used if earlier entries are unavailable or blacklisted
233    by a port. Setting this is unsupported.
234    *Default:*;; none (internal list based on Xcode version is normally used)
235
236FILES
237-----
238
239$\{prefix\}/etc/macports/macports.conf::
240    Standard system-wide MacPorts configuration file.
241
242~/.macports/macports.conf::
243    User-specific configuration override. This file, if found, will be used
244    instead of the default file at $\{prefix\}/etc/macports/macports.conf.
245
246SEE ALSO
247--------
248man:port[1], man:portfile[7]
249
250AUTHORS
251-------
252  (C) 2007-2011 The MacPorts Project
253  Juan Manuel Palacios <jmpp@macports.org>
254  Matt Anton <matt@opendarwin.org>
255  Rainer Mueller <raimue@macports.org>
Note: See TracBrowser for help on using the repository browser.