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

Last change on this file since 48206 was 48206, checked in by blb@…, 10 years ago

doc/macports.conf.5 - fix typo, ticket #18871

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