source: trunk/base/doc/ports.conf.5 @ 18777

Last change on this file since 18777 was 15506, checked in by jberry, 15 years ago

Merge to HEAD changes between tags release_1_2-bp and release_1_2_0 on
release_1_2 branch. This should incorporate all changes that were made
on the 1.2 branch between the time it branched from HEAD, and the time
1.2 was tagged.

  • Property svn:eol-style set to native
File size: 6.1 KB
Line 
1.\" Copyright (c) 2005 Matt Anton <matt@opendarwin.org>
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY Eric Melville AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.Dd August 31, 2005
26.Dt PORTS.CONF 5 "OpenDarwin.org"
27.Os
28.Sh NAME
29ports.conf
30.Nd Configuration file of the DarwinPorts system
31.Sh DESCRIPTION
32.Nm ports.conf
33is the configuration file used to bootstrap the DarwinPorts system. This file is read by the
34.Nm port
35command and determines how it behaves. Lines beginning with '#' are comments, empty lines are ignored.
36The format is that of a simple key/value space or tab separated pair.
37.Pp
38The file contains entries of the form:
39.Pp
40.Dl Va "<key> <value>"
41.Pp
42The value of any given key can be referred to by the '${<keyname>}' abstraction, where <keyname> expands
43to the key in question.
44.Pp
45.Sh KEYS
46The following keys are used by
47.Nm port
48itself:
49.Pp
50.Bl -tag -width lc
51.It Va prefix
52Sets the directory where ports are installed. Any path may be used but those with spaces and/or non ascii
53characters should be avoided, as this can broke some ports. This key is often referred to as '${prefix}'.
54.br
55.Ic Default:
56/opt/local
57.It Va portdbpath
58Directory where DarwinPorts keeps working data as downloaded sources, installed ports receipts
59and the main registry. Same path restrictions apply as for '${prefix}'.
60.br
61.Ic Default:
62${prefix}/var/db/dports
63.It Va portdbformat
64Storage type to use for the DarwinPorts registry. Currently the only supportted format is "flat".
65.br
66.Ic Default:
67flat
68.It Va portinstalltype
69Sets the mode in which ports are installed by DarwinPorts. Supported values are 'direct' or 'image'.
70The 'direct' mode is often used on systems that do not support 'image' due to limitations in their
71installed version of TCL. In 'direct' more ports are installed directly into '${prefix}' and only
72one flavor of a port can be installed at any given time. In 'image' mode multiple flavors of a port
73(i.e., different versions and/or any possible combination of its variants) can be installed concurrently
74into '${portdbpath}/software/${portname}' and only one can be "activated" onto '${prefix}' via soft or
75hard links from the former to the latter.
76.br
77.Ic Default:
78image
79.\" I think Paul wrote code to suppot image on Jaguar, so the following comment may no longer be needed.
80.\" is this the case?
81.Pp
82NOTE. Mac OS X 10.2 and Darwin 6.x users should switch to 'direct' mode to have DarwinPorts working properly
83on their systems.
84.It Va x11prefix
85Path containing an X11 installation on your system.
86.br
87.Ic Default:
88/usr/X11R6
89.It Va sources_conf
90Location of the sources file. This file enables rsync synchronization of the default dports tree with the
91OpenDarwin rsync server (through the "sync" target of the
92.Nm port
93commnand) and any other local tree(s) you might have.
94.br
95.Ic Default:
96${prefix}/etc/ports/sources.conf
97.It Va variants_conf
98Location of the optional global variants definition file, listing those that should be used in all installed
99ports if available.
100.br
101.Ic Default:
102${prefix}/etc/ports/variants.conf
103.It Va portarchivemode
104Key governing the creation of binary archives of installed ports for installation/reinstallation ease.
105.br
106.Ic Default:
107yes
108.It Va portarchivepath
109Location where to store/retrieve ports binary archive files from when archive mode is active.
110.br
111.Ic Default:
112${prefix}/var/db/dports/packages
113.It Va portarchivetype
114Colon or comma separated, space free list of supported formats of archives to create or read from when
115\&'${archivemode}' is set to 'yes'. Use of multiple types will cause archive creation to build all the
116specified types in one step. Unarchive uses multiple types as a search list to locate any existing archive,
117with the first found match being used.
118.br
119Supported types are: tgz, tar, tbz2, xar, zip, cpgz, cpio
120.br
121.Ic Default:
122tgz
123.It Va portautoclean
124Automatic cleaning of the build directory of a given port after it has been installed.
125.br
126.Ic Default:
127yes
128.It Va rsync_server
129Default rsync server to connect to when running "selfupdate" through the
130.Nm port
131command to update your entire DarwinPorts
132installation (spanning both the Darwinports infrastucture and the dports tree).
133.br
134.Ic Default:
135rsync.opendarwin.org
136.It Va rsync_dir
137Rsync directory from which to pull the base/ component (infrastructure) of the DarwinPorts system off
138of the default rsync server.
139.br
140.Ic Default:
141dpupdate1/base/ (to pull in the sources from the shipping "release1" branch off of the OpenDarwin rsync
142server)
143.It Va rsync_options
144Default rsync options to use when connecting to the rsync server.
145.br
146.Ic Default:
147-rtzv --delete --delete-after
148.El
149.Sh FILES
150.Bl -tag -width
151.It Va ~/.portsrc
152User configuration file for the DarwinPorts system. This file overrides values listed in the default
153${prefix}/etc/port/ports.conf' one.
154.El
155.Sh SEE ALSO
156.Xr port 1 ,
157.Xr portfile 7 ,
158.Xr portgroup 7 ,
159.Xr portstyle 7
160.Xr porthier 7 ,
161.Sh AUTHORS
162.An "Matt Anton" Aq matt@opendarwin.org
163.An "Juan Manuel Palacios" Aq jmpp@opendarwin.org
Note: See TracBrowser for help on using the repository browser.