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

raimue at macports.org raimue at macports.org
Sat Aug 21 07:38:09 PDT 2010


Revision: 70792
          http://trac.macports.org/changeset/70792
Author:   raimue at macports.org
Date:     2010-08-21 07:38:06 -0700 (Sat, 21 Aug 2010)
Log Message:
-----------
Converted macports.conf(5) to asciidoc

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

Added: branches/new-help-system/base/doc/macports.conf.5.txt
===================================================================
--- branches/new-help-system/base/doc/macports.conf.5.txt	                        (rev 0)
+++ branches/new-help-system/base/doc/macports.conf.5.txt	2010-08-21 14:38:06 UTC (rev 70792)
@@ -0,0 +1,196 @@
+// vim: set et sw=4 ts=8 ft=asciidoc tw=80:
+macports.conf(5)
+================
+$Id$
+
+NAME
+----
+macports.conf - Configuration file of the MacPorts system
+
+DESCRIPTION
+-----------
+*macports.conf* is the configuration file used to bootstrap the MacPorts
+system. This file is read by the *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.
+
+The file contains entries of the form:
+--------
+<key> <value>
+--------
+
+The value of any given key can be referred to by the '$\{<keyname>\}'
+abstraction, where '<keyname>' expands to the key in question.
+
+KEYS
+----
+The following keys are used by *port* itself:
+
+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\}'. +
+    **Default:** /opt/local
+
+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\}'. +
+    *Default:* $\{prefix\}/var/macports
+
+portdbformat::
+    Storage type to use for the MacPorts registry. The preferred format is "sqlite",
+    with "flat" also available as a legacy format. +
+    *Default:* sqlite
+
+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 sup-
+    port '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 lat-
+    ter. +
+    *Default:* image
+
+applications_dir::
+    Directory containing Applications installed from ports. +
+    *Default:* /Applications/MacPorts
+
+frameworks_dir::
+    Directory containing Frameworks installed from ports. +
+    *Default:* $\{prefix\}/Library/Frameworks
+
+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 port command) and any other local tree(s) you might have. +
+    *Default:* $\{prefix\}/etc/macports/sources.conf
+
+variants_conf::
+    Location of the optional global variants definition file, listing those that
+    should be used in all installed ports if available. +
+    *Default:* $\{prefix\}/etc/macports/variants.conf
+
+portarchivemode::
+    Key governing the creation of binary archives of installed ports for
+    installa- tion/reinstallation ease. +
+    *Default:* yes
+
+portarchivepath::
+    Location to store ports' binary archive files when archive mode is active. +
+    *Default:* $\{portdbpath\}/packages
+
+portarchivetype::
+    Colon or comma separated, space free list of supported formats of archives
+    to cre- ate 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. +
+    *Supported types are:* tgz, tar, tbz, tbz2, tlz, txz, xar, zip, cpgz, cpio +
+    *Default:* tgz
+
+configureccache::
+    Use ccache (C/C++ compiler cache). Requires that ccache has been installed. +
+    *Default:* no
+
+configuredistcc::
+    Use distcc (distributed compiler). Requires that distcc has been installed. +
+    *Default:* no
+
+configurepipe::
+    Use pipes rather than intermediate files when compiling C/C++/etc (gcc
+    -pipe) +
+    *Default:* yes
+
+buildnicevalue::
+    Lowered scheduling priority (0-20) to use for make when building ports +
+    *Default:* 0
+
+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." +
+    *Default:* 0
+
+portautoclean::
+    Automatic cleaning of the build directory of a given port after it has been
+    installed. +
+    *Default:* yes
+
+keeplogs::
+    Keep logs for ports. +
+    *Default:* yes
+
+build_arch::
+    The machine architecture to try to build for in normal use. +
+    *Regular architectures include:* ppc, i386, ppc64, x86_64 +
+    *Default (10.6):* x86_64 or i386 depending on hardware +
+    *Default (10.5 and earlier):* i386 or ppc depending on hardware
+
+universal_archs::
+    The machine architectures to use for +universal variant (multiple architecture
+    entries should be space separated). +
+    *Regular architectures include:* ppc, i386, ppc64, x86_64 +
+    *Default (10.6):* x86_64 i386 +
+    *Default (10.5 and earlier):* i386 ppc +
+
+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, System- Starter, launchd, default, rcNG. +
+    *Default:* default
+
+destroot_umask::
+    Umask value to use during the destrooting of a port. +
+    *Default:* 022
+
+rsync_server::
+    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. +
+    *Default:* rsync.macports.org
+
+rsync_dir::
+    Rsync directory from which to pull MacPorts sources from the rsync server. +
+    *Default:* release/base/ (which pulls sources for the currently shipping
+    MacPorts release)
+
+rsync_options::
+    Default rsync options to use when connecting to the rsync server. +
+    *Default:* -rtzv --delete-after
+
+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. +
+    *Default:* $\{prefix\}/bin:$\{prefix\}/sbin:/bin:/sbin:/usr/bin:/usr/sbin
+
+extra_env::
+    List of extra environment variables MacPorts should keep in the user's environment
+    when sanitizing it.
+
+FILES
+-----
+
+$\{prefix\}/etc/macports/macports.conf::
+    Standard system-wide MacPorts configuration file.
+
+~/.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.
+
+SEE ALSO
+--------
+man:port[1], man:portfile[7]
+
+AUTHORS
+-------
+  Juan Manuel Palacios <jmpp at macports.org>
+  Matt Anton <matt at opendarwin.org>
+  Rainer Mueller <raimue at macports.org>


Property changes on: branches/new-help-system/base/doc/macports.conf.5.txt
___________________________________________________________________
Added: svn:keywords
   + Id
Added: svn:eol-style
   + native
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.macosforge.org/pipermail/macports-changes/attachments/20100821/2ec9f0b3/attachment.html>


More information about the macports-changes mailing list