source: branches/gsoc11-statistics/base/doc/macports.conf.5 @ 79661

Last change on this file since 79661 was 78933, checked in by derek@…, 9 years ago

Added a description of the stats_participate variable to the macports.conf.5 man page

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 7.7 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 applications_dir
71Directory containing Applications installed from ports.
72.br
73.Ic Default:
74/Applications/MacPorts
75.It Va frameworks_dir
76Directory containing Frameworks installed from ports.
77.br
78.Ic Default:
79${prefix}/Library/Frameworks
80.It Va sources_conf
81Location of the sources file. This file enables rsync synchronization of the default ports tree with the
82MacPorts rsync server (through the "sync" target of the
83.Nm port
84command) and any other local tree(s) you might have.
85.br
86.Ic Default:
87${prefix}/etc/macports/sources.conf
88.It Va variants_conf
89Location of the optional global variants definition file, listing those that should be used in all installed
90ports if available.
91.br
92.Ic Default:
93${prefix}/etc/macports/variants.conf
94.It Va portarchivetype
95Format of archives in which to store port images. This controls both the type
96of archive created locally after building from source, and the type to request
97from remote servers. Changing this will not affect the usability of already
98installed archives; they can be of any supported type.
99.br
100Supported types are: tgz, tar, tbz, tbz2, tlz, txz, xar, zip, cpgz, cpio
101.br
102.Ic Default:
103tbz2
104.It Va configureccache
105Use ccache (C/C++ compiler cache). Requires that ccache has been installed.
106.br
107.Ic Default:
108no
109.It Va ccache_dir
110Location where ccache stores its files
111.br
112.Ic Default:
113${portdbpath}/build/.ccache
114.It Va ccache_size
115Maximum size ccache may use.
116.br
117Use 'G', 'M', or 'K' suffix for giga-, mega- or kilobytes.
118.br
119.Ic Default:
1202G
121.It Va configuredistcc
122Use distcc (distributed compiler). Requires that distcc has been installed.
123.br
124.Ic Default:
125no
126.It Va configurepipe
127Use pipes rather than intermediate files when compiling C/C++/etc (gcc -pipe)
128.br
129.Ic Default:
130yes
131.It Va buildnicevalue
132Lowered scheduling priority (0-20) to use for make when building ports
133.br
134.Ic Default:
1350
136.It Va buildmakejobs
137Number of simultaneous make jobs (commands) to use when building ports. 0 is a
138special value meaning "the number of CPU cores or the number of GB
139of physical memory plus one, whichever is less."
140.br
141.Ic Default:
1420
143.It Va portautoclean
144Automatic cleaning of the build directory of a given port after it has been installed.
145.br
146.Ic Default:
147yes
148.It Va keeplogs
149Keep logs for ports
150.br
151.Ic Default:
152no
153.It Va build_arch
154The machine architecture to try to build for in normal use
155.br
156Regular architectures include: ppc, i386, ppc64, x86_64
157.br
158.Ic Default (10.6):
159x86_64 or i386 depending on hardware
160.br
161.Ic Default (10.5 and earlier):
162i386 or ppc depending on hardware
163.It Va universal_archs
164The machine architectures to use for +universal variant
165(multiple architecture entries should be space separated)
166.br
167Regular architectures include: ppc, i386, ppc64, x86_64
168.br
169.Ic Default (10.6):
170x86_64 i386
171.br
172.Ic Default (10.5 and earlier):
173i386 ppc
174.It Va startupitem_type
175Set the default type of startupitems to be generated, overridable by Portfiles that explicitly state a
176startupitem.type key. If set to "default", then a type will be selected that's appropriate to the OS.
177Supported types are: none, SystemStarter, launchd, default, rcNG.
178.br
179.Ic Default:
180default
181.It Va destroot_umask
182Umask value to use during the destrooting of a port.
183.br
184.Ic Default:
185022
186.It Va rsync_server
187Default rsync server to connect to when running "selfupdate" through the
188.Nm port
189command to update your base MacPorts infrastructure. While selfupdate also
190syncs the ports tree, it uses the settings from ${sources_conf} to do so.
191.br
192.Ic Default:
193rsync.macports.org
194.It Va rsync_dir
195Rsync directory from which to pull MacPorts sources from the rsync server.
196.br
197.Ic Default:
198release/base/ (which pulls sources for the currently shipping MacPorts release)
199.It Va rsync_options
200Default rsync options to use when connecting to the rsync server.
201.br
202.Ic Default:
203-rtzv --delete-after
204.It Va binpath
205Sets the directory search path for locating system executables used by MacPorts. This variable should contain
206the paths for locating utilities such as rsync, tar, cvs and others. Don't change this unless you understand
207and accept the consequences.
208.br
209.Ic Default:
210${prefix}/bin:${prefix}/sbin:/bin:/sbin:/usr/bin:/usr/sbin
211.It Va extra_env
212List of extra environment variables MacPorts should keep in the user's environment when sanitizing it.
213.It Va stats_participate
214Participate in MacPorts usage statistics collection program. If set to "yes"
215a weekly launchd task will submit information to the MacPorts project. This
216submission will include details of about your build environment and the
217ports that you have installed.
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.