[70793] branches/new-help-system/base/doc/macports.conf.5

[raimue at macports.org]

Revision: 70793
          http://trac.macports.org/changeset/70793
Author:   raimue at macports.org
Date:     2010-08-21 07:39:32 -0700 (Sat, 21 Aug 2010)
Log Message:
-----------
Generated macports.conf.5 from asciidoc source

Modified Paths:
--------------
    branches/new-help-system/base/doc/macports.conf.5

Modified: branches/new-help-system/base/doc/macports.conf.5
===================================================================
--- branches/new-help-system/base/doc/macports.conf.5	2010-08-21 14:38:06 UTC (rev 70792)
+++ branches/new-help-system/base/doc/macports.conf.5	2010-08-21 14:39:32 UTC (rev 70793)
@@ -1,239 +1,311 @@
-.\" Copyright (c) 2005 Matt Anton <matt at opendarwin.org>
-.\" Copyright (c) 2007 Juan Manuel Palacios <jmpp at macports.org>
-.\" All rights reserved.
-.\"
-.\" Redistribution and use in source and binary forms, with or without
-.\" modification, are permitted provided that the following conditions
-.\" are met:
-.\" 1. Redistributions of source code must retain the above copyright
-.\"    notice, this list of conditions and the following disclaimer.
-.\" 2. Redistributions in binary form must reproduce the above copyright
-.\"    notice, this list of conditions and the following disclaimer in the
-.\"    documentation and/or other materials provided with the distribution.
-.\"
-.\" THIS SOFTWARE IS PROVIDED BY Eric Melville AND CONTRIBUTORS ``AS IS'' AND
-.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
-.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
-.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
-.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
-.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
-.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
-.\" SUCH DAMAGE.
-.\"
-.Dd May 22, 2007
-.Dt MACPORTS.CONF 5 "MacPorts"
-.Os 
-.Sh NAME
-macports.conf
-.Nd Configuration file of the MacPorts system
-.Sh DESCRIPTION
-.Nm macports.conf
-is the configuration file used to bootstrap the MacPorts system. This file is read by the
-.Nm port
-command and determines how it behaves. Lines beginning with '#' are comments, empty lines are ignored.
-The format is that of a simple key/value space or tab separated pair.
-.Pp
+'\" t
+.TH "MACPORTS\&.CONF" "5" "2010\-08\-21" "MacPorts 1\&.9\&.99" "MacPorts Manual"
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
+macports.conf \- Configuration file of the MacPorts system
+.SH "DESCRIPTION"
+.sp
+\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\&.
+.sp
 The file contains entries of the form:
-.Pp
-.Dl Va "<key> <value>"
-.Pp
-The value of any given key can be referred to by the '${<keyname>}' abstraction, where <keyname> expands
-to the key in question.
-.Pp
-.Sh KEYS
-The following keys are used by
-.Nm port
-itself:
-.Pp
-.Bl -tag -width lc
-.It Va prefix
-Sets 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 '${prefix}'.
-.br
-.Ic Default:
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+<key> <value>
+.fi
+.if n \{\
+.RE
+.\}
+.sp
+The 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\&.
+.SH "KEYS"
+.sp
+The following keys are used by \fBport\fR itself:
+.PP
+prefix
+.RS 4
+Sets 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
+\fI${prefix}\fR\&.
+
+\fBDefault:\fR
 /opt/local
-.It Va portdbpath
-Directory where MacPorts keeps working data such as downloaded sources, installed ports' receipts
-and the main registry. The same path restrictions apply as for '${prefix}'.
-.br
-.Ic Default:
+.RE
+.PP
+portdbpath
+.RS 4
+Directory where MacPorts keeps working data such as downloaded sources, installed ports\' receipts and the main registry\&. The same path restrictions apply as for
+\fI${prefix}\fR\&.
+
+\fBDefault:\fR
 ${prefix}/var/macports
-.It Va portdbformat
-Storage type to use for the MacPorts registry. The preferred format is "sqlite", with "flat"
-also available as a legacy format.
-.br
-.Ic Default:
+.RE
+.PP
+portdbformat
+.RS 4
+Storage type to use for the MacPorts registry\&. The preferred format is "sqlite", with "flat" also available as a legacy format\&.
+
+\fBDefault:\fR
 sqlite
-.It Va portinstalltype
-Sets the mode in which ports are installed by MacPorts. Supported values are 'direct' or 'image'.
-The 'direct' mode is often used on systems that do not support 'image' due to limitations in their
-installed version of Tcl. In 'direct' mode ports are installed directly into '${prefix}' and only
-one flavor of a port can be installed at any given time. In 'image' mode multiple flavors of a port
-(i.e., different versions and/or any possible combination of its variants) can be installed concurrently
-into '${portdbpath}/software/${portname}' and only one can be "activated" onto '${prefix}' via soft or
-hard links from the former to the latter.
-.br
-.Ic Default:
+.RE
+.PP
+portinstalltype
+.RS 4
+Sets the mode in which ports are installed by MacPorts\&. Supported values are
+\fIdirect\fR
+or
+\fIimage\fR\&. The
+\fIdirect\fR
+mode is often used on systems that do not sup\- port
+\fIimage\fR
+due to limitations in their installed version of Tcl\&. In
+\fIdirect\fR
+mode ports are installed directly into
+\fI${prefix}\fR
+and only one flavor of a port can be installed at any given time\&. In
+\fIimage\fR
+mode multiple flavors of a port (i\&.e\&., different versions and/or any possible combination of its variants) can be installed concurrently into
+\fI${portdbpath}/software/${portname}\fR
+and only one can be "activated" onto
+\fI${prefix}\fR
+via soft or hard links from the former to the lat\- ter\&.
+
+\fBDefault:\fR
 image
-.It Va applications_dir
-Directory containing Applications installed from ports.
-.br
-.Ic Default:
+.RE
+.PP
+applications_dir
+.RS 4
+Directory containing Applications installed from ports\&.
+
+\fBDefault:\fR
 /Applications/MacPorts
-.It Va frameworks_dir
-Directory containing Frameworks installed from ports.
-.br
-.Ic Default:
+.RE
+.PP
+frameworks_dir
+.RS 4
+Directory containing Frameworks installed from ports\&.
+
+\fBDefault:\fR
 ${prefix}/Library/Frameworks
-.It Va sources_conf
-Location 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
-.Nm port
-command) and any other local tree(s) you might have.
-.br
-.Ic Default:
-${prefix}/etc/macports/sources.conf
-.It Va variants_conf
-Location of the optional global variants definition file, listing those that should be used in all installed
-ports if available.
-.br
-.Ic Default:
-${prefix}/etc/macports/variants.conf
-.It Va portarchivemode
-Key governing the creation of binary archives of installed ports for installation/reinstallation ease.
-.br
-.Ic Default:
+.RE
+.PP
+sources_conf
+.RS 4
+Location 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\&.
+
+\fBDefault:\fR
+${prefix}/etc/macports/sources\&.conf
+.RE
+.PP
+variants_conf
+.RS 4
+Location of the optional global variants definition file, listing those that should be used in all installed ports if available\&.
+
+\fBDefault:\fR
+${prefix}/etc/macports/variants\&.conf
+.RE
+.PP
+portarchivemode
+.RS 4
+Key governing the creation of binary archives of installed ports for installa\- tion/reinstallation ease\&.
+
+\fBDefault:\fR
 yes
-.It Va portarchivepath
-Location to store ports' binary archive files when archive mode is active.
-.br
-.Ic Default:
+.RE
+.PP
+portarchivepath
+.RS 4
+Location to store ports\' binary archive files when archive mode is active\&.
+
+\fBDefault:\fR
 ${portdbpath}/packages
-.It Va portarchivetype
-Colon or comma separated, space free list of supported formats of archives to create or read from when
-\&'${archivemode}' is set to 'yes'. Use of multiple types will cause archive creation to build all the
-specified types in one step. Unarchive uses multiple types as a search list to locate any existing archive,
-with the first found match being used.
-.br
-Supported types are: tgz, tar, tbz, tbz2, tlz, txz, xar, zip, cpgz, cpio
-.br
-.Ic Default:
+.RE
+.PP
+portarchivetype
+.RS 4
+Colon or comma separated, space free list of supported formats of archives to cre\- ate or read from when
+\fI${archivemode}\fR
+is set to
+\fIyes\fR\&. Use of multiple types will cause archive creation to build all the specified types in one step\&. Unarchive uses multiple types as a search list to locate any existing archive, with the first found match being used\&.
+
+\fBSupported types are:\fR
+tgz, tar, tbz, tbz2, tlz, txz, xar, zip, cpgz, cpio
+
+\fBDefault:\fR
 tgz
-.It Va configureccache
-Use ccache (C/C++ compiler cache). Requires that ccache has been installed.
-.br
-.Ic Default:
+.RE
+.PP
+configureccache
+.RS 4
+Use ccache (C/C++ compiler cache)\&. Requires that ccache has been installed\&.
+
+\fBDefault:\fR
 no
-.It Va configuredistcc
-Use distcc (distributed compiler). Requires that distcc has been installed.
-.br
-.Ic Default:
+.RE
+.PP
+configuredistcc
+.RS 4
+Use distcc (distributed compiler)\&. Requires that distcc has been installed\&.
+
+\fBDefault:\fR
 no
-.It Va configurepipe
-Use pipes rather than intermediate files when compiling C/C++/etc (gcc -pipe)
-.br
-.Ic Default:
+.RE
+.PP
+configurepipe
+.RS 4
+Use pipes rather than intermediate files when compiling C/C++/etc (gcc \-pipe)
+
+\fBDefault:\fR
 yes
-.It Va buildnicevalue
-Lowered scheduling priority (0-20) to use for make when building ports
-.br
-.Ic Default:
+.RE
+.PP
+buildnicevalue
+.RS 4
+Lowered scheduling priority (0\-20) to use for make when building ports
+
+\fBDefault:\fR
 0
-.It Va buildmakejobs
-Number 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."
-.br
-.Ic Default:
+.RE
+.PP
+buildmakejobs
+.RS 4
+Number 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\&."
+
+\fBDefault:\fR
 0
-.It Va portautoclean
-Automatic cleaning of the build directory of a given port after it has been installed.
-.br
-.Ic Default:
+.RE
+.PP
+portautoclean
+.RS 4
+Automatic cleaning of the build directory of a given port after it has been installed\&.
+
+\fBDefault:\fR
 yes
-.It Va keeplogs 
-Keep logs for ports
-.br
-.Ic Default:
+.RE
+.PP
+keeplogs
+.RS 4
+Keep logs for ports\&.
+
+\fBDefault:\fR
 yes
-.It Va build_arch
-The machine architecture to try to build for in normal use
-.br
-Regular architectures include: ppc, i386, ppc64, x86_64
-.br
-.Ic Default (10.6):
+.RE
+.PP
+build_arch
+.RS 4
+The machine architecture to try to build for in normal use\&.
+
+\fBRegular architectures include:\fR
+ppc, i386, ppc64, x86_64
+
+\fBDefault (10\&.6):\fR
 x86_64 or i386 depending on hardware
-.br
-.Ic Default (10.5 and earlier):
+
+\fBDefault (10\&.5 and earlier):\fR
 i386 or ppc depending on hardware
-.It Va universal_archs
-The machine architectures to use for +universal variant
-(multiple architecture entries should be space separated)
-.br
-Regular architectures include: ppc, i386, ppc64, x86_64
-.br
-.Ic Default (10.6):
+.RE
+.PP
+universal_archs
+.RS 4
+The machine architectures to use for +universal variant (multiple architecture entries should be space separated)\&.
+
+\fBRegular architectures include:\fR
+ppc, i386, ppc64, x86_64
+
+\fBDefault (10\&.6):\fR
 x86_64 i386
-.br
-.Ic Default (10.5 and earlier):
+
+\fBDefault (10\&.5 and earlier):\fR
 i386 ppc
-.It Va startupitem_type
-Set 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's appropriate to the OS.
-Supported types are: none, SystemStarter, launchd, default, rcNG.
-.br
-.Ic Default:
+.RE
+.PP
+startupitem_type
+.RS 4
+Set 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\&. Supported types are: none, System\- Starter, launchd, default, rcNG\&.
+
+\fBDefault:\fR
 default
-.It Va destroot_umask
-Umask value to use during the destrooting of a port.
-.br
-.Ic Default:
+.RE
+.PP
+destroot_umask
+.RS 4
+Umask value to use during the destrooting of a port\&.
+
+\fBDefault:\fR
 022
-.It Va rsync_server
-Default rsync server to connect to when running "selfupdate" through the
-.Nm port
-command to update your base MacPorts infrastructure. While selfupdate also
-syncs the ports tree, it uses the settings from ${sources_conf} to do so.
-.br
-.Ic Default:
-rsync.macports.org
-.It Va rsync_dir
-Rsync directory from which to pull MacPorts sources from the rsync server.
-.br
-.Ic Default:
+.RE
+.PP
+rsync_server
+.RS 4
+Default 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\&.
+
+\fBDefault:\fR
+rsync\&.macports\&.org
+.RE
+.PP
+rsync_dir
+.RS 4
+Rsync directory from which to pull MacPorts sources from the rsync server\&.
+
+\fBDefault:\fR
 release/base/ (which pulls sources for the currently shipping MacPorts release)
-.It Va rsync_options
-Default rsync options to use when connecting to the rsync server.
-.br
-.Ic Default:
--rtzv --delete-after
-.It Va binpath
-Sets 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't change this unless you understand
-and accept the consequences.
-.br
-.Ic Default:
+.RE
+.PP
+rsync_options
+.RS 4
+Default rsync options to use when connecting to the rsync server\&.
+
+\fBDefault:\fR
+\-rtzv \-\-delete\-after
+.RE
+.PP
+binpath
+.RS 4
+Sets 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\&.
+
+\fBDefault:\fR
 ${prefix}/bin:${prefix}/sbin:/bin:/sbin:/usr/bin:/usr/sbin
-.It Va extra_env
-List of extra environment variables MacPorts should keep in the user's environment when sanitizing it.
-.El
-.Sh FILES
-.Bl -tag -width
-.It Va ${prefix}/etc/macports/macports.conf
-Standard system-wide MacPorts configuration file.
-.It Va ~/.macports/macports.conf
-User-specific configuration override. This file, if found, will be used instead of the default file at
-${prefix}/etc/macports/macports.conf.
-.El
-.Sh SEE ALSO
-.Xr port 1 ,
-.Xr portfile 7 ,
-.Xr portgroup 7 ,
-.Xr portstyle 7
-.Xr porthier 7 ,
-.Sh AUTHORS
-.An "Juan Manuel Palacios" Aq jmpp at macports.org
-.An "Matt Anton" Aq matt at opendarwin.org
+.RE
+.PP
+extra_env
+.RS 4
+List of extra environment variables MacPorts should keep in the user\(cqs environment when sanitizing it\&.
+.RE
+.SH "FILES"
+.PP
+${prefix}/etc/macports/macports\&.conf
+.RS 4
+Standard system\-wide MacPorts configuration file\&.
+.RE
+.PP
+~/\&.macports/macports\&.conf
+.RS 4
+User\-specific configuration override\&. This file, if found, will be used instead of the default file at ${prefix}/etc/macports/macports\&.conf\&.
+.RE
+.SH "SEE ALSO"
+.sp
+\fBport\fR(1), \fBportfile\fR(7)
+.SH "AUTHORS"
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+Juan Manuel Palacios <jmpp at macports\&.org>
+Matt Anton <matt at opendarwin\&.org>
+Rainer Mueller <raimue at macports\&.org>
+.fi
+.if n \{\
+.RE
+.\}
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.macosforge.org/pipermail/macports-changes/attachments/20100821/663d6e12/attachment-0001.html>