source: branches/gsoc09-logging/base/doc/macports.conf.5 @ 136621

Last change on this file since 136621 was 59527, checked in by blb@…, 11 years ago

Merge from trunk (may be a few missed bits to be picked up later)

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 8.0 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 broke 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 as downloaded sources, installed ports receipts
60and the main registry. 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. Currently the only supported format is "flat".
66.br
67.Ic Default:
68flat
69.It Va portinstalltype
70Sets the mode in which ports are installed by MacPorts. Supported values are 'direct' or 'image'.
71The 'direct' mode is often used on systems that do not support 'image' due to limitations in their
72installed version of Tcl. In 'direct' mode ports are installed directly into '${prefix}' and only
73one flavor of a port can be installed at any given time. In 'image' mode multiple flavors of a port
74(i.e., different versions and/or any possible combination of its variants) can be installed concurrently
75into '${portdbpath}/software/${portname}' and only one can be "activated" onto '${prefix}' via soft or
76hard links from the former to the latter.
77.br
78.Ic Default:
79image
80.It Va applications_dir
81Directory containing Applications installed from ports.
82.br
83.Ic Default:
84/Applications/MacPorts
85.It Va frameworks_dir
86Directory containing Frameworks installed from ports.
87.br
88.Ic Default:
89${prefix}/Library/Frameworks
90.It Va sources_conf
91Location of the sources file. This file enables rsync synchronization of the default ports tree with the
92MacPorts rsync server (through the "sync" target of the
93.Nm port
94command) and any other local tree(s) you might have.
95.br
96.Ic Default:
97${prefix}/etc/macports/sources.conf
98.It Va variants_conf
99Location of the optional global variants definition file, listing those that should be used in all installed
100ports if available.
101.br
102.Ic Default:
103${prefix}/etc/macports/variants.conf
104.It Va portarchivemode
105Key governing the creation of binary archives of installed ports for installation/reinstallation ease.
106.br
107.Ic Default:
108yes
109.It Va portarchivepath
110Location where to store/retrieve ports binary archive files from when archive mode is active.
111.br
112.Ic Default:
113${portdbpath}/packages
114.It Va portarchivetype
115Colon or comma separated, space free list of supported formats of archives to create or read from when
116\&'${archivemode}' is set to 'yes'. Use of multiple types will cause archive creation to build all the
117specified types in one step. Unarchive uses multiple types as a search list to locate any existing archive,
118with the first found match being used.
119.br
120Supported types are: tgz, tar, tbz, tbz2, tlz, txz, xar, zip, cpgz, cpio
121.br
122.Ic Default:
123tgz
124.It Va configureccache
125Use ccache (C/C++ compiler cache). Requires that ccache has been installed.
126.br
127.Ic Default:
128no
129.It Va configuredistcc
130Use distcc (distributed compiler). Requires that distcc has been installed.
131.br
132.Ic Default:
133no
134.It Va configurepipe
135Use pipes rather than intermediate files when compiling C/C++/etc (gcc -pipe)
136.br
137.Ic Default:
138no
139.It Va buildnicevalue
140Lowered scheduling priority (0-20) to use for make when building ports
141.br
142.Ic Default:
1430
144.It Va buildmakejobs
145Number of simultaneous make jobs (commands) to use when building ports
146.br
147.Ic Default:
1481
149.It Va portautoclean
150Automatic cleaning of the build directory of a given port after it has been installed.
151.br
152.Ic Default:
153yes
154.It Va keeplogs
155Keep logs for ports
156.br
157.Ic Default:
158yes
159.It Va build_arch
160The machine architecture to try to build for in normal use
161.br
162Regular architectures include: ppc, i386, ppc64, x86_64
163.br
164.Ic Default (10.6):
165x86_64 or i386 depending on hardware
166.br
167.Ic Default (10.5 and earlier):
168i386 or ppc depending on hardware
169.It Va universal_archs
170The machine architectures to use for +universal variant
171(multiple architecture entries should be space separated)
172.br
173Regular architectures include: ppc, i386, ppc64, x86_64
174.br
175.Ic Default (10.6):
176x86_64 i386
177.br
178.Ic Default (10.5 and earlier):
179i386 ppc
180.It Va startupitem_type
181Set the default type of startupitems to be generated, overridable by Portfiles that explicitly state a
182startupitem.type key. If set to "default", then a type will be selected that's appropriate to the OS.
183Supported types are: none, SystemStarter, launchd, default, rcNG.
184.br
185.Ic Default:
186default
187.It Va destroot_umask
188Umask value to use during the destrooting or a port.
189.br
190.Ic Default:
191022
192.It Va rsync_server
193Default rsync server to connect to when running "selfupdate" through the
194.Nm port
195command to update your entire MacPorts
196installation (spanning both the MacPorts infrastructure and the ports tree).
197.br
198.Ic Default:
199rsync.macports.org
200.It Va rsync_dir
201Rsync directory from which to pull MacPorts sources from the rsync server.
202.br
203.Ic Default:
204release/base/ (which pulls sources for the currently shipping MacPorts release)
205.It Va rsync_options
206Default rsync options to use when connecting to the rsync server.
207.br
208.Ic Default:
209-rtzv --delete-after
210.It Va binpath
211Sets the directory search path for locating system executables used by MacPorts. This variable should contain
212the paths for locating utilities such as rsync, tar, cvs and others.
213.br
214.Ic Default:
215${prefix}/bin:${prefix}/sbin:/bin:/sbin:/usr/bin:/usr/sbin
216.It Va extra_env
217List of extra environment variables MacPorts should keep in the user's environment when sanitizing it.
218.El
219.Sh FILES
220.Bl -tag -width
221.It Va ${prefix}/etc/macports/macports.conf
222Standard system-wide MacPorts configuration file.
223.It Va ~/.macports/macports.conf
224User-specific configuration override. This file, if found, will be used instead of the default file at
225${prefix}/etc/macports/macports.conf.
226.El
227.Sh SEE ALSO
228.Xr port 1 ,
229.Xr portfile 7 ,
230.Xr portgroup 7 ,
231.Xr portstyle 7
232.Xr porthier 7 ,
233.Sh AUTHORS
234.An "Juan Manuel Palacios" Aq jmpp@macports.org
235.An "Matt Anton" Aq matt@opendarwin.org
Note: See TracBrowser for help on using the repository browser.