source: branches/gsoc13-tests/doc/macports.conf.5 @ 139170

Last change on this file since 139170 was 99275, checked in by pixilla@…, 8 years ago

base/doc/macports.conf.5:

  • Add startupitem_install, proxy_override_env, proxy_http, proxy_https, proxy_ftp proxy_rsync, proxy_skip, host_blacklist and preferred_hosts to man.

base/doc/macports.conf.in:

  • Add host_blacklist and preferred_hosts.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 10.1 KB
Line 
1.\" Copyright (c) 2005 Matt Anton <matt@opendarwin.org>
2.\" Copyright (c) 2007 Juan Manuel Palacios <jmpp@macports.org>
3.\" Copyright (c) 2007-2011 The MacPorts Project
4.\" All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\"
15.\" THIS SOFTWARE IS PROVIDED BY Eric Melville AND CONTRIBUTORS ``AS IS'' AND
16.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
19.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25.\" SUCH DAMAGE.
26.\"
27.Dd May 22, 2007
28.Dt MACPORTS.CONF 5 "MacPorts"
29.Os
30.Sh NAME
31macports.conf
32.Nd Configuration file of the MacPorts system
33.Sh DESCRIPTION
34.Nm macports.conf
35is the configuration file used to bootstrap the MacPorts system. This file is read by the
36.Nm port
37command and determines how it behaves. Lines beginning with '#' are comments, empty lines are ignored.
38The format is that of a simple key/value space or tab separated pair.
39.Pp
40The file contains entries of the form:
41.Pp
42.Dl Va "<key> <value>"
43.Pp
44The value of any given key can be referred to by the '${<keyname>}' abstraction, where <keyname> expands
45to the key in question.
46.Pp
47.Sh KEYS
48The following keys are used by
49.Nm port
50itself:
51.Pp
52.Bl -tag -width lc
53.It Va prefix
54Sets the directory where ports are installed. Any path may be used but those with spaces and/or non ascii
55characters should be avoided, as this can break some ports. This key is often referred to as '${prefix}'.
56.br
57.Ic Default:
58/opt/local
59.It Va portdbpath
60Directory where MacPorts keeps working data such as downloaded sources, installed ports' receipts
61and the main registry. The same path restrictions apply as for '${prefix}'.
62.br
63.Ic Default:
64${prefix}/var/macports
65.It Va portdbformat
66Storage type to use for the MacPorts registry. The preferred format is "sqlite", with "flat"
67also available as a legacy format.
68.br
69.Ic Default:
70sqlite
71.It Va applications_dir
72Directory containing Applications installed from ports.
73.br
74.Ic Default:
75/Applications/MacPorts
76.It Va frameworks_dir
77Directory containing Frameworks installed from ports.
78.br
79.Ic Default:
80${prefix}/Library/Frameworks
81.It Va sources_conf
82Location of the sources file. This file enables rsync synchronization of the default ports tree with the
83MacPorts rsync server (through the "sync" target of the
84.Nm port
85command) and any other local tree(s) you might have.
86.br
87.Ic Default:
88${prefix}/etc/macports/sources.conf
89.It Va variants_conf
90Location of the optional global variants definition file, listing those that should be used in all installed
91ports if available.
92.br
93.Ic Default:
94${prefix}/etc/macports/variants.conf
95.It Va buildfromsource
96Controls whether ports are built from source or downloaded as pre-built
97archives. Setting to 'always' will never use archives, 'never' will always
98try to use an archive and fail if one is not available. 'ifneeded' will try to
99fetch an archive and fall back to building from source if that isn't possible.
100.br
101.Ic Default:
102ifneeded
103.It Va portarchivetype
104Format of archives in which to store port images. This controls both the type
105of archive created locally after building from source, and the type to request
106from remote servers. Changing this will not affect the usability of already
107installed archives; they can be of any supported type.
108.br
109Supported types are: tgz, tar, tbz, tbz2, tlz, txz, xar, zip, cpgz, cpio
110.br
111.Ic Default:
112tbz2
113.It Va configureccache
114Use ccache (C/C++ compiler cache). Requires that ccache has been installed.
115.br
116.Ic Default:
117no
118.It Va ccache_dir
119Location where ccache stores its files
120.br
121.Ic Default:
122${portdbpath}/build/.ccache
123.It Va ccache_size
124Maximum size ccache may use.
125.br
126Use 'G', 'M', or 'K' suffix for giga-, mega- or kilobytes.
127.br
128.Ic Default:
1292G
130.It Va configuredistcc
131Use distcc (distributed compiler). Requires that distcc has been installed.
132.br
133.Ic Default:
134no
135.It Va configurepipe
136Use pipes rather than intermediate files when compiling C/C++/etc (gcc -pipe)
137.br
138.Ic Default:
139yes
140.It Va buildnicevalue
141Lowered scheduling priority (0-20) to use for make when building ports
142.br
143.Ic Default:
1440
145.It Va buildmakejobs
146Number of simultaneous make jobs (commands) to use when building ports. 0 is a
147special value meaning "the number of CPU cores or the number of GB
148of physical memory plus one, whichever is less."
149.br
150.Ic Default:
1510
152.It Va portautoclean
153Automatic cleaning of the build directory of a given port after it has been installed.
154.br
155.Ic Default:
156yes
157.It Va keeplogs
158Keep logs for ports
159.br
160.Ic Default:
161no
162.It Va build_arch
163The machine architecture to try to build for in normal use
164.br
165Regular architectures include: ppc, i386, ppc64, x86_64
166.br
167.Ic Default (10.6):
168x86_64 or i386 depending on hardware
169.br
170.Ic Default (10.5 and earlier):
171i386 or ppc depending on hardware
172.It Va universal_archs
173The machine architectures to use for +universal variant
174(multiple architecture entries should be space separated)
175.br
176Regular architectures include: ppc, i386, ppc64, x86_64
177.br
178.Ic Default (10.6):
179x86_64 i386
180.br
181.Ic Default (10.5 and earlier):
182i386 ppc
183.It Va startupitem_type
184Set the default type of startupitems to be generated, overridable by Portfiles that explicitly state a
185startupitem.type key. If set to "default", then a type will be selected that's appropriate to the OS.
186Supported types are: none, SystemStarter, launchd, default, rcNG.
187.br
188.Ic Default:
189default
190.It Va startupitem_install
191Option to install symlinks into /Library/LaunchAgents or
192/Library/LaunchDaemons; startupitem_install may be empty, "yes" or "no";
193if the option is NOT "no" then a symlink for the startupitem will be
194created in the appropriate system directory.
195.br
196.Ic Default:
197yes
198.It Va destroot_umask
199Umask value to use during the destrooting of a port.
200.br
201.Ic Default:
202022
203.It Va rsync_server
204Default rsync server to connect to when running "selfupdate" through the
205.Nm port
206command to update your base MacPorts infrastructure. While selfupdate also
207syncs the ports tree, it uses the settings from ${sources_conf} to do so.
208.br
209.Ic Default:
210rsync.macports.org
211.It Va rsync_dir
212Rsync directory from which to pull MacPorts sources from the rsync server.
213.br
214.Ic Default:
215release/base/ (which pulls sources for the currently shipping MacPorts release)
216.It Va rsync_options
217Default rsync options to use when connecting to the rsync server.
218.br
219.Ic Default:
220-rtzv --delete-after
221.It Va binpath
222Sets the directory search path for locating system executables used by MacPorts. This variable should contain
223the paths for locating utilities such as rsync, tar, cvs and others. Changing this is unsupported; don't do so
224unless you understand and accept the consequences.
225.br
226.Ic Default:
227${prefix}/bin:${prefix}/sbin:/bin:/sbin:/usr/bin:/usr/sbin
228.It Va extra_env
229List of extra environment variables MacPorts should keep in the user's environment when sanitizing it.
230Changing this is unsupported.
231.It Va proxy_override_env
232Proxy support. Precedence is: env, macports.conf, System Preferences.
233That is, if it's set in the environment, that will be used instead of
234anything here or in System Preferences. Setting proxy_override_env to
235yes will cause any proxies set here (or in System Preferences if set
236there but not here) to override what's in the environment. Note that
237System Preferences doesn't have an rsync proxy definition. Also note, on
23810.5, sudo will clear many environment variables including those for
239proxy support. Equivalent environment variables: http_proxy,
240HTTPS_PROXY, FTP_PROXY, RSYNC_PROXY, NO_PROXY
241.br
242.Ic Default:
243yes
244.It Va proxy_http
245HTTP proxy
246.br
247.Ic Default:
248none
249.It Va proxy_https
250HTTPS proxy
251.br
252.Ic Default:
253none
254.It Va proxy_ftp
255FTP proxy
256.br
257.Ic Default:
258none
259.It Va proxy_rsync
260rsync proxy
261.br
262.Ic Default:
263none
264.It Va proxy_skip
265Hosts not to go through the proxy (comma-separated, applies to HTTP,
266HTTPS and FTP, but not rsync):
267.br
268.Ic Default:
269none
270.It Va host_blacklist
271Space separated list of download hosts that should not be used.
272.br
273.Ic Default:
274none
275.It Va preferred_hosts
276Space separated list of download hosts that should be used preferentially.
277.br
278.Ic Default:
279none
280.It Va revupgrade_autorun
281Controls whether the rev-upgrade action will be run automatically after
282upgrading ports.
283.br
284.Ic Default:
285yes
286.It Va revupgrade_mode
287Controls the rev-upgrade functionality which checks for broken linking and can
288rebuild ports to fix it. 'rebuild' means ports will automatically be rebuilt
289when broken linking is detected in their files, while 'report' means broken
290files will be scanned for and reported but the ports will not be rebuilt.
291.br
292.Ic Default:
293rebuild
294.It Va default_compiler
295Default value for configure.compiler. This can be a space-separated list. Later
296entries will be used if earlier entries are unavailable or blacklisted by a
297port. Setting this is unsupported.
298.br
299.Ic Default:
300none (internal list based on Xcode version is normally used)
301.El
302.Sh FILES
303.Bl -tag -width
304.It Va ${prefix}/etc/macports/macports.conf
305Standard system-wide MacPorts configuration file.
306.It Va ~/.macports/macports.conf
307User-specific configuration override. This file, if found, will be used instead of the default file at
308${prefix}/etc/macports/macports.conf.
309.El
310.Sh SEE ALSO
311.Xr port 1 ,
312.Xr portfile 7 ,
313.Xr portgroup 7 ,
314.Xr portstyle 7
315.Xr porthier 7 ,
316.Sh AUTHORS
317.An "Juan Manuel Palacios" Aq jmpp@macports.org
318.An "Matt Anton" Aq matt@opendarwin.org
Note: See TracBrowser for help on using the repository browser.