source: trunk/base/doc/macports.conf.5 @ 71606

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

Add ccache_dir and ccache_size to macports.conf and man page.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 8.5 KB
Line 
1.\" Copyright (c) 2005 Matt Anton <matt@opendarwin.org>
2.\" Copyright (c) 2007 Juan Manuel Palacios <jmpp@macports.org>
3.\" All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions and the following disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\"    notice, this list of conditions and the following disclaimer in the
12.\"    documentation and/or other materials provided with the distribution.
13.\"
14.\" THIS SOFTWARE IS PROVIDED BY Eric Melville AND CONTRIBUTORS ``AS IS'' AND
15.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
18.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24.\" SUCH DAMAGE.
25.\"
26.Dd May 22, 2007
27.Dt MACPORTS.CONF 5 "MacPorts"
28.Os
29.Sh NAME
30macports.conf
31.Nd Configuration file of the MacPorts system
32.Sh DESCRIPTION
33.Nm macports.conf
34is the configuration file used to bootstrap the MacPorts system. This file is read by the
35.Nm port
36command and determines how it behaves. Lines beginning with '#' are comments, empty lines are ignored.
37The format is that of a simple key/value space or tab separated pair.
38.Pp
39The file contains entries of the form:
40.Pp
41.Dl Va "<key> <value>"
42.Pp
43The value of any given key can be referred to by the '${<keyname>}' abstraction, where <keyname> expands
44to the key in question.
45.Pp
46.Sh KEYS
47The following keys are used by
48.Nm port
49itself:
50.Pp
51.Bl -tag -width lc
52.It Va prefix
53Sets the directory where ports are installed. Any path may be used but those with spaces and/or non ascii
54characters should be avoided, as this can break some ports. This key is often referred to as '${prefix}'.
55.br
56.Ic Default:
57/opt/local
58.It Va portdbpath
59Directory where MacPorts keeps working data such as downloaded sources, installed ports' receipts
60and the main registry. The same path restrictions apply as for '${prefix}'.
61.br
62.Ic Default:
63${prefix}/var/macports
64.It Va portdbformat
65Storage type to use for the MacPorts registry. The preferred format is "sqlite", with "flat"
66also available as a legacy format.
67.br
68.Ic Default:
69sqlite
70.It Va portinstalltype
71Sets the mode in which ports are installed by MacPorts. Supported values are 'direct' or 'image'.
72The 'direct' mode is often used on systems that do not support 'image' due to limitations in their
73installed version of Tcl. In 'direct' mode ports are installed directly into '${prefix}' and only
74one flavor of a port can be installed at any given time. In 'image' mode multiple flavors of a port
75(i.e., different versions and/or any possible combination of its variants) can be installed concurrently
76into '${portdbpath}/software/${portname}' and only one can be "activated" onto '${prefix}' via soft or
77hard links from the former to the latter.
78.br
79.Ic Default:
80image
81.It Va applications_dir
82Directory containing Applications installed from ports.
83.br
84.Ic Default:
85/Applications/MacPorts
86.It Va frameworks_dir
87Directory containing Frameworks installed from ports.
88.br
89.Ic Default:
90${prefix}/Library/Frameworks
91.It Va sources_conf
92Location of the sources file. This file enables rsync synchronization of the default ports tree with the
93MacPorts rsync server (through the "sync" target of the
94.Nm port
95command) and any other local tree(s) you might have.
96.br
97.Ic Default:
98${prefix}/etc/macports/sources.conf
99.It Va variants_conf
100Location of the optional global variants definition file, listing those that should be used in all installed
101ports if available.
102.br
103.Ic Default:
104${prefix}/etc/macports/variants.conf
105.It Va portarchivemode
106Key governing the creation of binary archives of installed ports for installation/reinstallation ease.
107.br
108.Ic Default:
109yes
110.It Va portarchivepath
111Location to store ports' binary archive files when archive mode is active.
112.br
113.Ic Default:
114${portdbpath}/packages
115.It Va portarchivetype
116Colon or comma separated, space free list of supported formats of archives to create or read from when
117\&'${archivemode}' is set to 'yes'. Use of multiple types will cause archive creation to build all the
118specified types in one step. Unarchive uses multiple types as a search list to locate any existing archive,
119with the first found match being used.
120.br
121Supported types are: tgz, tar, tbz, tbz2, tlz, txz, xar, zip, cpgz, cpio
122.br
123.Ic Default:
124tgz
125.It Va configureccache
126Use ccache (C/C++ compiler cache). Requires that ccache has been installed.
127.br
128.Ic Default:
129no
130.It Va ccache_dir
131Location where ccache stores its files
132.br
133.Ic Default:
134${portdbpath}/build/.ccache
135.It Va ccache_size
136Maximum size ccache may use.
137.br
138Use 'G', 'M', or 'K' suffix for giga-, mega- or kilobytes.
139.br
140.Ic Default:
1412G
142.It Va configuredistcc
143Use distcc (distributed compiler). Requires that distcc has been installed.
144.br
145.Ic Default:
146no
147.It Va configurepipe
148Use pipes rather than intermediate files when compiling C/C++/etc (gcc -pipe)
149.br
150.Ic Default:
151yes
152.It Va buildnicevalue
153Lowered scheduling priority (0-20) to use for make when building ports
154.br
155.Ic Default:
1560
157.It Va buildmakejobs
158Number of simultaneous make jobs (commands) to use when building ports. 0 is a
159special value meaning "the number of CPU cores or the number of GB
160of physical memory plus one, whichever is less."
161.br
162.Ic Default:
1630
164.It Va portautoclean
165Automatic cleaning of the build directory of a given port after it has been installed.
166.br
167.Ic Default:
168yes
169.It Va keeplogs
170Keep logs for ports
171.br
172.Ic Default:
173yes
174.It Va build_arch
175The machine architecture to try to build for in normal use
176.br
177Regular architectures include: ppc, i386, ppc64, x86_64
178.br
179.Ic Default (10.6):
180x86_64 or i386 depending on hardware
181.br
182.Ic Default (10.5 and earlier):
183i386 or ppc depending on hardware
184.It Va universal_archs
185The machine architectures to use for +universal variant
186(multiple architecture entries should be space separated)
187.br
188Regular architectures include: ppc, i386, ppc64, x86_64
189.br
190.Ic Default (10.6):
191x86_64 i386
192.br
193.Ic Default (10.5 and earlier):
194i386 ppc
195.It Va startupitem_type
196Set the default type of startupitems to be generated, overridable by Portfiles that explicitly state a
197startupitem.type key. If set to "default", then a type will be selected that's appropriate to the OS.
198Supported types are: none, SystemStarter, launchd, default, rcNG.
199.br
200.Ic Default:
201default
202.It Va destroot_umask
203Umask value to use during the destrooting of a port.
204.br
205.Ic Default:
206022
207.It Va rsync_server
208Default rsync server to connect to when running "selfupdate" through the
209.Nm port
210command to update your base MacPorts infrastructure. While selfupdate also
211syncs the ports tree, it uses the settings from ${sources_conf} to do so.
212.br
213.Ic Default:
214rsync.macports.org
215.It Va rsync_dir
216Rsync directory from which to pull MacPorts sources from the rsync server.
217.br
218.Ic Default:
219release/base/ (which pulls sources for the currently shipping MacPorts release)
220.It Va rsync_options
221Default rsync options to use when connecting to the rsync server.
222.br
223.Ic Default:
224-rtzv --delete-after
225.It Va binpath
226Sets the directory search path for locating system executables used by MacPorts. This variable should contain
227the paths for locating utilities such as rsync, tar, cvs and others. Don't change this unless you understand
228and accept the consequences.
229.br
230.Ic Default:
231${prefix}/bin:${prefix}/sbin:/bin:/sbin:/usr/bin:/usr/sbin
232.It Va extra_env
233List of extra environment variables MacPorts should keep in the user's environment when sanitizing it.
234.El
235.Sh FILES
236.Bl -tag -width
237.It Va ${prefix}/etc/macports/macports.conf
238Standard system-wide MacPorts configuration file.
239.It Va ~/.macports/macports.conf
240User-specific configuration override. This file, if found, will be used instead of the default file at
241${prefix}/etc/macports/macports.conf.
242.El
243.Sh SEE ALSO
244.Xr port 1 ,
245.Xr portfile 7 ,
246.Xr portgroup 7 ,
247.Xr portstyle 7
248.Xr porthier 7 ,
249.Sh AUTHORS
250.An "Juan Manuel Palacios" Aq jmpp@macports.org
251.An "Matt Anton" Aq matt@opendarwin.org
Note: See TracBrowser for help on using the repository browser.