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

Last change on this file since 129850 was 123013, checked in by cal@…, 5 years ago

base: rebuild manpages

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 11.4 KB
Line 
1'\" t
2.TH "MACPORTS\&.CONF" "5" "2014\-08\-03" "MacPorts 2\&.3\&.99" "MacPorts Manual"
3.\" -----------------------------------------------------------------
4.\" * Define some portability stuff
5.\" -----------------------------------------------------------------
6.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7.\" http://bugs.debian.org/507673
8.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
9.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
10.ie \n(.g .ds Aq \(aq
11.el       .ds Aq '
12.\" -----------------------------------------------------------------
13.\" * set default formatting
14.\" -----------------------------------------------------------------
15.\" disable hyphenation
16.nh
17.\" disable justification (adjust text to left margin only)
18.ad l
19.\" -----------------------------------------------------------------
20.\" * MAIN CONTENT STARTS HERE *
21.\" -----------------------------------------------------------------
22.SH "NAME"
23macports.conf \- Configuration file of the MacPorts system
24.SH "DESCRIPTION"
25.sp
26\fBmacports\&.conf\fR is the configuration file used to bootstrap the MacPorts system\&. This file is read by the \fBport\fR command and determines how it behaves\&. Lines beginning with \fI#\fR are comments, empty lines are ignored\&. The format is that of a simple key/value space or tab separated pair\&.
27.sp
28The file contains entries of the form:
29.sp
30.if n \{\
31.RS 4
32.\}
33.nf
34<key> <value>
35.fi
36.if n \{\
37.RE
38.\}
39.sp
40The value of any given key can be referred to by the \fI${<keyname>}\fR abstraction, where \fI<keyname>\fR expands to the key in question\&.
41.SH "KEYS"
42.sp
43The following keys are used by \fBport\fR itself:
44.PP
45prefix
46.RS 4
47Sets the directory where ports are installed\&. Any path may be used but those with spaces and/or non ascii characters should be avoided, as this can break some ports\&. This key is often referred to as
48\fI${prefix}\fR\&.
49.TS
50tab(:);
51lt lt.
52T{
53\fBDefault:\fR
54T}:T{
55/opt/local
56T}
57.TE
58.sp 1
59.RE
60.PP
61portdbpath
62.RS 4
63Directory where MacPorts keeps working data such as downloaded sources, installed ports\*(Aq receipts and the main registry\&. The same path restrictions apply as for
64\fI${prefix}\fR\&.
65.TS
66tab(:);
67lt lt.
68T{
69\fBDefault:\fR
70T}:T{
71${prefix}/var/macports
72T}
73.TE
74.sp 1
75.RE
76.PP
77portdbformat
78.RS 4
79Storage type to use for the MacPorts registry\&. The preferred format is "sqlite", with "flat" also available as a legacy format\&.
80.TS
81tab(:);
82lt lt.
83T{
84\fBDefault:\fR
85T}:T{
86sqlite
87T}
88.TE
89.sp 1
90.RE
91.PP
92applications_dir
93.RS 4
94Directory containing Applications installed from ports\&.
95.TS
96tab(:);
97lt lt.
98T{
99\fBDefault:\fR
100T}:T{
101/Applications/MacPorts
102T}
103.TE
104.sp 1
105.RE
106.PP
107frameworks_dir
108.RS 4
109Directory containing Frameworks installed from ports\&.
110.TS
111tab(:);
112lt lt.
113T{
114\fBDefault:\fR
115T}:T{
116${prefix}/Library/Frameworks
117T}
118.TE
119.sp 1
120.RE
121.PP
122sources_conf
123.RS 4
124Location of the sources file\&. This file enables rsync synchronization of the default ports tree with the MacPorts rsync server (through the "sync" target of the port command) and any other local tree(s) you might have\&.
125.TS
126tab(:);
127lt lt.
128T{
129\fBDefault:\fR
130T}:T{
131${prefix}/etc/macports/sources\&.conf
132T}
133.TE
134.sp 1
135.RE
136.PP
137variants_conf
138.RS 4
139Location of the optional global variants definition file, listing those that should be used in all installed ports if available\&.
140.TS
141tab(:);
142lt lt.
143T{
144\fBDefault:\fR
145T}:T{
146${prefix}/etc/macports/variants\&.conf
147T}
148.TE
149.sp 1
150.RE
151.PP
152buildfromsource
153.RS 4
154Controls whether ports are built from source or downloaded as pre\-built archives\&. Setting to
155\fIalways\fR
156will never use archives,
157\fInever\fR
158will always try to use an archive and fail if one is not available\&.
159\fIifneeded\fR
160will try to fetch an archive and fall back to building from source if that isn\(cqt possible\&.
161.TS
162tab(:);
163lt lt.
164T{
165\fBDefault:\fR
166T}:T{
167ifneeded
168T}
169.TE
170.sp 1
171.RE
172.PP
173portarchivetype
174.RS 4
175Format of archives in which to store port images\&. This controls both the type of archive cre\- ated locally after building from source, and the type to request from remote servers\&. Changing this will not affect the usability of already installed archives; they can be of any supported type\&.
176.TS
177tab(:);
178lt lt
179lt lt.
180T{
181\fBSupported types:\fR
182T}:T{
183tgz, tar, tbz, tbz2, tlz, txz, xar, zip, cpgz, cpio
184T}
185T{
186\fBDefault:\fR
187T}:T{
188tbz2
189T}
190.TE
191.sp 1
192.RE
193.PP
194configureccache
195.RS 4
196Use ccache (C/C++ compiler cache)\&. Requires that ccache has been installed\&.
197.TS
198tab(:);
199lt lt.
200T{
201\fBDefault:\fR
202T}:T{
203no
204T}
205.TE
206.sp 1
207.RE
208.PP
209ccache_dir
210.RS 4
211Location where ccache stores its files
212.TS
213tab(:);
214lt lt.
215T{
216\fBDefault:\fR
217T}:T{
218${portdbpath}/build/\&.ccache
219T}
220.TE
221.sp 1
222.RE
223.PP
224ccache_size
225.RS 4
226Maximum size ccache may use\&. Use
227\fIG\fR,
228\fIM\fR, or
229\fIK\fR
230suffix for giga\-, mega\- or kilobytes\&.
231.TS
232tab(:);
233lt lt.
234T{
235\fBDefault:\fR
236T}:T{
2372G
238T}
239.TE
240.sp 1
241.RE
242.PP
243configuredistcc
244.RS 4
245Use distcc (distributed compiler)\&. Requires that distcc has been installed\&.
246.TS
247tab(:);
248lt lt.
249T{
250\fBDefault:\fR
251T}:T{
252no
253T}
254.TE
255.sp 1
256.RE
257.PP
258configurepipe
259.RS 4
260Use pipes rather than intermediate files when compiling C/C++/etc (gcc \-pipe)
261.TS
262tab(:);
263lt lt.
264T{
265\fBDefault:\fR
266T}:T{
267yes
268T}
269.TE
270.sp 1
271.RE
272.PP
273buildnicevalue
274.RS 4
275Lowered scheduling priority (0\-20) to use for make when building ports
276.TS
277tab(:);
278lt lt.
279T{
280\fBDefault:\fR
281T}:T{
2820
283T}
284.TE
285.sp 1
286.RE
287.PP
288buildmakejobs
289.RS 4
290Number of simultaneous make jobs (commands) to use when building ports\&. 0 is a special value meaning "the number of CPU cores or the number of GB of physical memory plus one, whichever is less\&."
291.TS
292tab(:);
293lt lt.
294T{
295\fBDefault:\fR
296T}:T{
2970
298T}
299.TE
300.sp 1
301.RE
302.PP
303portautoclean
304.RS 4
305Automatic cleaning of the build directory of a given port after it has been installed\&.
306.TS
307tab(:);
308lt lt.
309T{
310\fBDefault:\fR
311T}:T{
312yes
313T}
314.TE
315.sp 1
316.RE
317.PP
318keeplogs
319.RS 4
320Keep logs for ports\&.
321.TS
322tab(:);
323lt lt.
324T{
325\fBDefault:\fR
326T}:T{
327no
328T}
329.TE
330.sp 1
331.RE
332.PP
333build_arch
334.RS 4
335The machine architecture to try to build for in normal use\&.
336.TS
337tab(:);
338lt lt
339lt lt
340lt lt.
341T{
342\fBRegular architectures include:\fR
343T}:T{
344ppc, i386, ppc64, x86_64
345T}
346T{
347\fBDefault (10\&.6):\fR
348T}:T{
349x86_64 or i386 depending on hardware
350T}
351T{
352\fBDefault (10\&.5 and earlier):\fR
353T}:T{
354i386 or ppc depending on hardware
355T}
356.TE
357.sp 1
358.RE
359.PP
360universal_archs
361.RS 4
362The machine architectures to use for +universal variant (multiple architecture entries should be space separated)\&.
363.TS
364tab(:);
365lt lt
366lt lt
367lt lt.
368T{
369\fBRegular architectures include:\fR
370T}:T{
371ppc, i386, ppc64, x86_64
372T}
373T{
374\fBDefault (10\&.6):\fR
375T}:T{
376x86_64 i386
377T}
378T{
379\fBDefault (10\&.5 and earlier):\fR
380T}:T{
381i386 ppc
382T}
383.TE
384.sp 1
385.RE
386.PP
387startupitem_type
388.RS 4
389Set the default type of startupitems to be generated, overridable by Portfiles that explicitly state a startupitem\&.type key\&. If set to "default", then a type will be selected that\(cqs appropriate to the OS\&.
390.TS
391tab(:);
392lt lt
393lt lt.
394T{
395\fBSupported types:\fR
396T}:T{
397none, SystemStarter, launchd, default, rcNG\&.
398T}
399T{
400\fBDefault:\fR
401T}:T{
402default
403T}
404.TE
405.sp 1
406.RE
407.PP
408destroot_umask
409.RS 4
410Umask value to use during the destrooting of a port\&.
411.TS
412tab(:);
413lt lt.
414T{
415\fBDefault:\fR
416T}:T{
417022
418T}
419.TE
420.sp 1
421.RE
422.PP
423rsync_server
424.RS 4
425Default rsync server to connect to when running "selfupdate" through the port com\- mand to update your base MacPorts infrastructure\&. While selfupdate also syncs the ports tree, it uses the settings from ${sources_conf} to do so\&.
426.TS
427tab(:);
428lt lt.
429T{
430\fBDefault:\fR
431T}:T{
432rsync\&.macports\&.org
433T}
434.TE
435.sp 1
436.RE
437.PP
438rsync_dir
439.RS 4
440Rsync directory from which to pull MacPorts sources from the rsync server\&.
441.TS
442tab(:);
443lt lt.
444T{
445\fBDefault:\fR
446T}:T{
447release/base/ (which pulls sources for the currently shipping MacPorts release)
448T}
449.TE
450.sp 1
451.RE
452.PP
453rsync_options
454.RS 4
455Default rsync options to use when connecting to the rsync server\&.
456.TS
457tab(:);
458lt lt.
459T{
460\fBDefault:\fR
461T}:T{
462\-rtzv \-\-delete\-after
463T}
464.TE
465.sp 1
466.RE
467.PP
468binpath
469.RS 4
470Sets the directory search path for locating system executables used by MacPorts\&. This variable should contain the paths for locating utilities such as rsync, tar, cvs and others\&. Don\(cqt change this unless you understand and accept the consequences\&.
471.TS
472tab(:);
473lt lt.
474T{
475\fBDefault:\fR
476T}:T{
477${prefix}/bin:${prefix}/sbin:/bin:/sbin:/usr/bin:/usr/sbin
478T}
479.TE
480.sp 1
481.RE
482.PP
483extra_env
484.RS 4
485List of extra environment variables MacPorts should keep in the user\(cqs environment when sanitizing it\&. Changing this is unsupported\&.
486.RE
487.PP
488proxy_override_env
489.RS 4
490Proxy support\&. Precedence is: env, macports\&.conf, System Preferences\&. That is, if it\(cqs set in the environment, that will be used instead of anything here or in System Preferences\&. Setting proxy_override_env to yes will cause any proxies set here (or in System Preferences if set there but not here) to override what\(cqs in the environment\&. Note that System Preferences doesn\(cqt have an rsync proxy definition\&. Also note, on 10\&.5, sudo will clear many environment variables including those for proxy support\&. Equivalent environment variables: http_proxy, HTTPS_PROXY, FTP_PROXY, RSYNC_PROXY, NO_PROXY
491.TS
492tab(:);
493lt lt.
494T{
495\fBDefault:\fR
496T}:T{
497yes
498T}
499.TE
500.sp 1
501.RE
502.PP
503proxy_http
504.RS 4
505HTTP proxy
506.TS
507tab(:);
508lt lt.
509T{
510\fBDefault:\fR
511T}:T{
512none
513T}
514.TE
515.sp 1
516.RE
517.PP
518proxy_https
519.RS 4
520HTTPS proxy
521.TS
522tab(:);
523lt lt.
524T{
525\fBDefault:\fR
526T}:T{
527none
528T}
529.TE
530.sp 1
531.RE
532.PP
533proxy_ftp
534.RS 4
535FTP proxy
536.TS
537tab(:);
538lt lt.
539T{
540\fBDefault:\fR
541T}:T{
542none
543T}
544.TE
545.sp 1
546.RE
547.PP
548proxy_rsync
549.RS 4
550rsync proxy
551.TS
552tab(:);
553lt lt.
554T{
555\fBDefault:\fR
556T}:T{
557none
558T}
559.TE
560.sp 1
561.RE
562.PP
563proxy_skip
564.RS 4
565Hosts not to go through the proxy (comma\-separated, applies to HTTP, HTTPS and FTP, but not rsync)\&.
566.TS
567tab(:);
568lt lt.
569T{
570\fBDefault:\fR
571T}:T{
572none
573T}
574.TE
575.sp 1
576.RE
577.PP
578host_blacklist
579.RS 4
580Space separated list of download hosts that should not be used\&.
581.TS
582tab(:);
583lt lt.
584T{
585\fBDefault:\fR
586T}:T{
587none
588T}
589.TE
590.sp 1
591.RE
592.PP
593preferred_hosts
594.RS 4
595Space separated list of download hosts that should be used preferentially\&.
596.TS
597tab(:);
598lt lt.
599T{
600\fBDefault:\fR
601T}:T{
602none
603T}
604.TE
605.sp 1
606.RE
607.PP
608revupgrade_autorun
609.RS 4
610Controls whether the rev\-upgrade action will be run automatically after upgrading ports\&.
611.TS
612tab(:);
613lt lt.
614T{
615\fBDefault:\fR
616T}:T{
617yes
618T}
619.TE
620.sp 1
621.RE
622.PP
623revupgrade_mode
624.RS 4
625Controls the rev\-upgrade functionality which checks for broken linking and can rebuild ports to fix it\&.
626\fIrebuild\fR
627means ports will automatically be rebuilt when broken linking is detected in their files, while
628\fIreport\fR
629means broken files will be scanned for and reported but the ports will not be rebuilt\&.
630.TS
631tab(:);
632lt lt.
633T{
634\fBDefault:\fR
635T}:T{
636rebuild
637T}
638.TE
639.sp 1
640.RE
641.PP
642default_compiler
643.RS 4
644Default value for configure\&.compiler\&. This can be a space\-separated list\&. Later entries will be used if earlier entries are unavailable or blacklisted by a port\&. Setting this is unsupported\&.
645.TS
646tab(:);
647lt lt.
648T{
649\fBDefault:\fR
650T}:T{
651none (internal list based on Xcode version is normally used)
652T}
653.TE
654.sp 1
655.RE
656.SH "FILES"
657.PP
658${prefix}/etc/macports/macports\&.conf
659.RS 4
660Standard system\-wide MacPorts configuration file\&.
661.RE
662.PP
663~/\&.macports/macports\&.conf
664.RS 4
665User\-specific configuration override\&. This file, if found, will be used instead of the default file at ${prefix}/etc/macports/macports\&.conf\&.
666.RE
667.SH "SEE ALSO"
668.sp
669\fBport\fR(1), \fBportfile\fR(7)
670.SH "AUTHORS"
671.sp
672.if n \{\
673.RS 4
674.\}
675.nf
676(C) 2007\-2011 The MacPorts Project
677Juan Manuel Palacios <jmpp@macports\&.org>
678Matt Anton <matt@opendarwin\&.org>
679Rainer Mueller <raimue@macports\&.org>
680.fi
681.if n \{\
682.RE
683.\}
Note: See TracBrowser for help on using the repository browser.