[103912] branches/new-help-system/base/doc
raimue at macports.org
raimue at macports.org
Sat Mar 9 16:58:45 PST 2013
Revision: 103912
https://trac.macports.org/changeset/103912
Author: raimue at macports.org
Date: 2013-03-09 16:58:45 -0800 (Sat, 09 Mar 2013)
Log Message:
-----------
doc:
Regenerate man pages
Modified Paths:
--------------
branches/new-help-system/base/doc/macports.conf.5
branches/new-help-system/base/doc/port.1
branches/new-help-system/base/doc/portgroup.7
Modified: branches/new-help-system/base/doc/macports.conf.5
===================================================================
--- branches/new-help-system/base/doc/macports.conf.5 2013-03-10 00:57:29 UTC (rev 103911)
+++ branches/new-help-system/base/doc/macports.conf.5 2013-03-10 00:58:45 UTC (rev 103912)
@@ -1,5 +1,5 @@
'\" t
-.TH "MACPORTS\&.CONF" "5" "2012\-12\-15" "MacPorts 2\&.1\&.99" "MacPorts Manual"
+.TH "MACPORTS\&.CONF" "5" "2013\-03\-10" "MacPorts 2\&.1\&.99" "MacPorts Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -46,58 +46,107 @@
.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\&.
-
+.TS
+tab(:);
+lt lt.
+T{
\fBDefault:\fR
+T}:T{
/opt/local
+T}
+.TE
+.sp 1
.RE
.PP
portdbpath
.RS 4
Directory where MacPorts keeps working data such as downloaded sources, installed ports\*(Aq receipts and the main registry\&. The same path restrictions apply as for
\fI${prefix}\fR\&.
-
+.TS
+tab(:);
+lt lt.
+T{
\fBDefault:\fR
+T}:T{
${prefix}/var/macports
+T}
+.TE
+.sp 1
.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\&.
-
+.TS
+tab(:);
+lt lt.
+T{
\fBDefault:\fR
+T}:T{
sqlite
+T}
+.TE
+.sp 1
.RE
.PP
applications_dir
.RS 4
Directory containing Applications installed from ports\&.
-
+.TS
+tab(:);
+lt lt.
+T{
\fBDefault:\fR
+T}:T{
/Applications/MacPorts
+T}
+.TE
+.sp 1
.RE
.PP
frameworks_dir
.RS 4
Directory containing Frameworks installed from ports\&.
-
+.TS
+tab(:);
+lt lt.
+T{
\fBDefault:\fR
+T}:T{
${prefix}/Library/Frameworks
+T}
+.TE
+.sp 1
.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\&.
-
+.TS
+tab(:);
+lt lt.
+T{
\fBDefault:\fR
+T}:T{
${prefix}/etc/macports/sources\&.conf
+T}
+.TE
+.sp 1
.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\&.
-
+.TS
+tab(:);
+lt lt.
+T{
\fBDefault:\fR
+T}:T{
${prefix}/etc/macports/variants\&.conf
+T}
+.TE
+.sp 1
.RE
.PP
buildfromsource
@@ -109,33 +158,67 @@
will always try to use an archive and fail if one is not available\&.
\fIifneeded\fR
will try to fetch an archive and fall back to building from source if that isn\(cqt possible\&.
-
+.TS
+tab(:);
+lt lt.
+T{
\fBDefault:\fR
+T}:T{
ifneeded
+T}
+.TE
+.sp 1
.RE
.PP
portarchivetype
.RS 4
Format 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\&.
-
+.TS
+tab(:);
+lt lt
+lt lt.
+T{
\fBSupported types:\fR
+T}:T{
tgz, tar, tbz, tbz2, tlz, txz, xar, zip, cpgz, cpio
-
+T}
+T{
\fBDefault:\fR
+T}:T{
tbz2
+T}
+.TE
+.sp 1
.RE
.PP
configureccache
.RS 4
Use ccache (C/C++ compiler cache)\&. Requires that ccache has been installed\&.
-
+.TS
+tab(:);
+lt lt.
+T{
\fBDefault:\fR
+T}:T{
no
+T}
+.TE
+.sp 1
.RE
.PP
ccache_dir
.RS 4
Location where ccache stores its files
+.TS
+tab(:);
+lt lt.
+T{
+\fBDefault:\fR
+T}:T{
+${portdbpath}/build/\&.ccache
+T}
+.TE
+.sp 1
.RE
.PP
ccache_size
@@ -145,136 +228,256 @@
\fIM\fR, or
\fIK\fR
suffix for giga\-, mega\- or kilobytes\&.
-
+.TS
+tab(:);
+lt lt.
+T{
\fBDefault:\fR
+T}:T{
2G
+T}
+.TE
+.sp 1
.RE
.PP
configuredistcc
.RS 4
Use distcc (distributed compiler)\&. Requires that distcc has been installed\&.
-
+.TS
+tab(:);
+lt lt.
+T{
\fBDefault:\fR
+T}:T{
no
+T}
+.TE
+.sp 1
.RE
.PP
configurepipe
.RS 4
Use pipes rather than intermediate files when compiling C/C++/etc (gcc \-pipe)
-
+.TS
+tab(:);
+lt lt.
+T{
\fBDefault:\fR
+T}:T{
yes
+T}
+.TE
+.sp 1
.RE
.PP
buildnicevalue
.RS 4
Lowered scheduling priority (0\-20) to use for make when building ports
-
+.TS
+tab(:);
+lt lt.
+T{
\fBDefault:\fR
+T}:T{
0
+T}
+.TE
+.sp 1
.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\&."
-
+.TS
+tab(:);
+lt lt.
+T{
\fBDefault:\fR
+T}:T{
0
+T}
+.TE
+.sp 1
.RE
.PP
portautoclean
.RS 4
Automatic cleaning of the build directory of a given port after it has been installed\&.
-
+.TS
+tab(:);
+lt lt.
+T{
\fBDefault:\fR
+T}:T{
yes
+T}
+.TE
+.sp 1
.RE
.PP
keeplogs
.RS 4
Keep logs for ports\&.
-
+.TS
+tab(:);
+lt lt.
+T{
\fBDefault:\fR
+T}:T{
no
+T}
+.TE
+.sp 1
.RE
.PP
build_arch
.RS 4
The machine architecture to try to build for in normal use\&.
-
+.TS
+tab(:);
+lt lt
+lt lt
+lt lt.
+T{
\fBRegular architectures include:\fR
+T}:T{
ppc, i386, ppc64, x86_64
-
+T}
+T{
\fBDefault (10\&.6):\fR
+T}:T{
x86_64 or i386 depending on hardware
-
+T}
+T{
\fBDefault (10\&.5 and earlier):\fR
+T}:T{
i386 or ppc depending on hardware
+T}
+.TE
+.sp 1
.RE
.PP
universal_archs
.RS 4
The machine architectures to use for +universal variant (multiple architecture entries should be space separated)\&.
-
+.TS
+tab(:);
+lt lt
+lt lt
+lt lt.
+T{
\fBRegular architectures include:\fR
+T}:T{
ppc, i386, ppc64, x86_64
-
+T}
+T{
\fBDefault (10\&.6):\fR
+T}:T{
x86_64 i386
-
+T}
+T{
\fBDefault (10\&.5 and earlier):\fR
+T}:T{
i386 ppc
+T}
+.TE
+.sp 1
.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\&.
-
+.TS
+tab(:);
+lt lt
+lt lt.
+T{
\fBSupported types:\fR
+T}:T{
none, SystemStarter, launchd, default, rcNG\&.
-
+T}
+T{
\fBDefault:\fR
+T}:T{
default
+T}
+.TE
+.sp 1
.RE
.PP
destroot_umask
.RS 4
Umask value to use during the destrooting of a port\&.
-
+.TS
+tab(:);
+lt lt.
+T{
\fBDefault:\fR
+T}:T{
022
+T}
+.TE
+.sp 1
.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\&.
-
+.TS
+tab(:);
+lt lt.
+T{
\fBDefault:\fR
+T}:T{
rsync\&.macports\&.org
+T}
+.TE
+.sp 1
.RE
.PP
rsync_dir
.RS 4
Rsync directory from which to pull MacPorts sources from the rsync server\&.
-
+.TS
+tab(:);
+lt lt.
+T{
\fBDefault:\fR
+T}:T{
release/base/ (which pulls sources for the currently shipping MacPorts release)
+T}
+.TE
+.sp 1
.RE
.PP
rsync_options
.RS 4
Default rsync options to use when connecting to the rsync server\&.
-
+.TS
+tab(:);
+lt lt.
+T{
\fBDefault:\fR
+T}:T{
\-rtzv \-\-delete\-after
+T}
+.TE
+.sp 1
.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\&.
-
+.TS
+tab(:);
+lt lt.
+T{
\fBDefault:\fR
+T}:T{
${prefix}/bin:${prefix}/sbin:/bin:/sbin:/usr/bin:/usr/sbin
+T}
+.TE
+.sp 1
.RE
.PP
extra_env
@@ -285,73 +488,136 @@
proxy_override_env
.RS 4
Proxy 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
-
+.TS
+tab(:);
+lt lt.
+T{
\fBDefault:\fR
+T}:T{
yes
+T}
+.TE
+.sp 1
.RE
.PP
proxy_http
.RS 4
HTTP proxy
-
+.TS
+tab(:);
+lt lt.
+T{
\fBDefault:\fR
+T}:T{
none
+T}
+.TE
+.sp 1
.RE
.PP
proxy_https
.RS 4
HTTPS proxy
-
+.TS
+tab(:);
+lt lt.
+T{
\fBDefault:\fR
+T}:T{
none
+T}
+.TE
+.sp 1
.RE
.PP
proxy_ftp
.RS 4
FTP proxy
-
+.TS
+tab(:);
+lt lt.
+T{
\fBDefault:\fR
+T}:T{
none
+T}
+.TE
+.sp 1
.RE
.PP
proxy_rsync
.RS 4
rsync proxy
-
+.TS
+tab(:);
+lt lt.
+T{
\fBDefault:\fR
+T}:T{
none
+T}
+.TE
+.sp 1
.RE
.PP
proxy_skip
.RS 4
Hosts not to go through the proxy (comma\-separated, applies to HTTP, HTTPS and FTP, but not rsync)\&.
-
+.TS
+tab(:);
+lt lt.
+T{
\fBDefault:\fR
+T}:T{
none
+T}
+.TE
+.sp 1
.RE
.PP
host_blacklist
.RS 4
Space separated list of download hosts that should not be used\&.
-
+.TS
+tab(:);
+lt lt.
+T{
\fBDefault:\fR
+T}:T{
none
+T}
+.TE
+.sp 1
.RE
.PP
preferred_hosts
.RS 4
Space separated list of download hosts that should be used preferentially\&.
-
+.TS
+tab(:);
+lt lt.
+T{
\fBDefault:\fR
+T}:T{
none
+T}
+.TE
+.sp 1
.RE
.PP
revupgrade_autorun
.RS 4
Controls whether the rev\-upgrade action will be run automatically after upgrading ports\&.
-
+.TS
+tab(:);
+lt lt.
+T{
\fBDefault:\fR
+T}:T{
yes
+T}
+.TE
+.sp 1
.RE
.PP
revupgrade_mode
@@ -361,17 +627,31 @@
means ports will automatically be rebuilt when broken linking is detected in their files, while
\fIreport\fR
means broken files will be scanned for and reported but the ports will not be rebuilt\&.
-
+.TS
+tab(:);
+lt lt.
+T{
\fBDefault:\fR
+T}:T{
rebuild
+T}
+.TE
+.sp 1
.RE
.PP
default_compiler
.RS 4
Default 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\&.
-
+.TS
+tab(:);
+lt lt.
+T{
\fBDefault:\fR
+T}:T{
none (internal list based on Xcode version is normally used)
+T}
+.TE
+.sp 1
.RE
.SH "FILES"
.PP
Modified: branches/new-help-system/base/doc/port.1
===================================================================
--- branches/new-help-system/base/doc/port.1 2013-03-10 00:57:29 UTC (rev 103911)
+++ branches/new-help-system/base/doc/port.1 2013-03-10 00:58:45 UTC (rev 103912)
@@ -1,5 +1,5 @@
'\" t
-.TH "PORT" "1" "2013\-01\-07" "MacPorts 2\&.1\&.99" "MacPorts Manual"
+.TH "PORT" "1" "2013\-03\-10" "MacPorts 2\&.1\&.99" "MacPorts Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -569,7 +569,7 @@
.RS 4
Enable trace mode debug facilities on platforms that support it, currently only Mac OS X\&.
-This feature is two\-folded\&. It consists in automatically detecting and reporting undeclared dependencies based on what files the port reads or what programs the port executes\&. In verbose mode, it will also report unused dependencies for each stage of the port installation\&. It also consists in forbidding and reporting file creation and file writes outside allowed
+This feature is two\-folded\&. It consists in automatically detecting and reporting undeclared dependencies based on what files the port reads or what programs the port executes\&. In verbose mode, it will also report unused dependencies for each stage of the port installation\&. It also consists in forbidding and reporting file creation and file writes outside allowed directories (temporary directories and ${workpath})\&.
.RE
.PP
\fBMisc\fR
@@ -713,7 +713,7 @@
.PP
select
.RS 4
-For a given group, selects a version to be the default by creating appropriate symbolic links\&. For instance, python might be linked to python2\&.6\&. Available select groups are installed as subdirec\- tories of \-\-list\&. To see which version is currently selected for a group, use \-\-show\&. To change the selected version for a group, use \-\-set\&.
+For a given group, selects a version to be the default by creating appropriate symbolic links\&. For instance, python might be linked to python2\&.6\&. Available select groups are installed as subdirec\- tories of ${prefix}/etc/select/\&. To list the available versions in a group, use \-\-list\&. To see which version is currently selected for a group, use \-\-show\&. To change the selected version for a group, use \-\-set\&.
.sp
For example:
.sp
@@ -990,7 +990,6 @@
to specify message category (msg, info, debug)\&.
.sp
For example:
-.RE
.sp
.if n \{\
.RS 4
@@ -1002,6 +1001,7 @@
.if n \{\
.RE
.\}
+.RE
.PP
logfile
.RS 4
Modified: branches/new-help-system/base/doc/portgroup.7
===================================================================
--- branches/new-help-system/base/doc/portgroup.7 2013-03-10 00:57:29 UTC (rev 103911)
+++ branches/new-help-system/base/doc/portgroup.7 2013-03-10 00:58:45 UTC (rev 103912)
@@ -1,5 +1,5 @@
'\" t
-.TH "PORTGROUP" "7" "2013\-01\-06" "MacPorts 2\&.1\&.99" "MacPorts Manual"
+.TH "PORTGROUP" "7" "2013\-03\-10" "MacPorts 2\&.1\&.99" "MacPorts Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -73,10 +73,16 @@
xcode\&.project
.RS 4
Path (relative to ${build\&.dir} and ${destroot\&.dir}) of the Xcode project\&. If unset, let xcode tool figure it out\&. It usually succeeds if there is a single project in the directory\&.
-
+.TS
+tab(:);
+lt lt.
+T{
\fBType:\fR
+T}:T{
optional
-
+T}
+.TE
+.sp 1
\fBExample:\fR
.sp
.if n \{\
@@ -93,13 +99,22 @@
xcode\&.configuration
.RS 4
Project configuration/buildstyle to use\&.
-
+.TS
+tab(:);
+lt lt
+lt lt.
+T{
\fBType:\fR
+T}:T{
optional
-
+T}
+T{
\fBDefault:\fR
+T}:T{
Deployment
-
+T}
+.TE
+.sp 1
\fBExample:\fR
.sp
.if n \{\
@@ -116,18 +131,31 @@
xcode\&.target
.RS 4
If present, overrides build\&.target and destroot\&.target\&.
-
+.TS
+tab(:);
+lt lt.
+T{
\fBType:\fR
+T}:T{
optional
+T}
+.TE
+.sp 1
.RE
.PP
xcode\&.build\&.settings
.RS 4
Additional settings passed to the xcode build tool during the build phase\&. These settings should be in the X=Y form\&.
-
+.TS
+tab(:);
+lt lt.
+T{
\fBType:\fR
+T}:T{
optional
-
+T}
+.TE
+.sp 1
\fBExample:\fR
.sp
.if n \{\
@@ -144,13 +172,22 @@
xcode\&.destroot\&.type
.RS 4
Type of project that will be installed\&. This tells Xcode PortGroup how to destroot the project\&. Correct values are application and framework\&.
-
+.TS
+tab(:);
+lt lt
+lt lt.
+T{
\fBType:\fR
+T}:T{
optional
-
+T}
+T{
\fBDefault:\fR
+T}:T{
application
-
+T}
+.TE
+.sp 1
\fBExample:\fR
.sp
.if n \{\
@@ -167,20 +204,37 @@
xcode\&.destroot\&.path
.RS 4
Where to install the build product\&.
-
+.TS
+tab(:);
+lt lt
+lt lt.
+T{
\fBType:\fR
+T}:T{
optional
-
-on xcode\&.destroot\&.type
+T}
+T{
+\fBDefault:\fR
+T}:T{
+${prefix}/Library/Frameworks or /Applications/MacPorts depending on xcode\&.destroot\&.type
+T}
+.TE
+.sp 1
.RE
.PP
xcode\&.destroot\&.settings
.RS 4
Additional settings passed to the xcode build tool during the destroot phase\&. These settings should be in the X=Y form\&.
-
+.TS
+tab(:);
+lt lt.
+T{
\fBType:\fR
+T}:T{
optional
-
+T}
+.TE
+.sp 1
\fBExample:\fR
.sp
.if n \{\
@@ -206,7 +260,7 @@
.RS 4
The command to invoke to build the project\&.
\fBxcode PortGroup\fR
-sets this
+sets this variable to ${xcodebuildcmd}\&.
.RE
.PP
build\&.target
@@ -219,30 +273,61 @@
build\&.pre_args
.RS 4
Additional parameters for ${build\&.cmd}\&.
-
+.TS
+tab(:);
+lt lt.
+T{
\fBDefault:\fR
+T}:T{
none
+T}
+.TE
+.sp 1
.RE
.PP
build\&.args
.RS 4
Main parameters for ${build\&.cmd}\&.
-
+.TS
+tab(:);
+lt lt.
+T{
\fBDefault:\fR
+T}:T{
build
+T}
+.TE
+.sp 1
.RE
.PP
build\&.post_args
.RS 4
Additional parameters for ${build\&.cmd}\&.
-
+.TS
+tab(:);
+lt lt.
+T{
\fBDefault:\fR
+T}:T{
none
+T}
+.TE
+.sp 1
.RE
.PP
build\&.dir
.RS 4
Where to build the project from (i\&.e\&. where the Xcode project is)\&.
+.TS
+tab(:);
+lt lt.
+T{
+\fBDefault:\fR
+T}:T{
+${worksrcpath}
+T}
+.TE
+.sp 1
.RE
.PP
destroot\&.cmd
@@ -262,30 +347,61 @@
destroot\&.pre_args
.RS 4
Additional parameters for ${destroot\&.cmd}\&.
-
+.TS
+tab(:);
+lt lt.
+T{
\fBDefault:\fR
+T}:T{
none
+T}
+.TE
+.sp 1
.RE
.PP
destroot\&.args
.RS 4
Main parameters for ${destroot\&.cmd}\&.
-
+.TS
+tab(:);
+lt lt.
+T{
\fBDefault:\fR
+T}:T{
install
+T}
+.TE
+.sp 1
.RE
.PP
destroot\&.post_args
.RS 4
Additional parameters for ${destroot\&.cmd}\&.
-
+.TS
+tab(:);
+lt lt.
+T{
\fBDefault:\fR
+T}:T{
none
+T}
+.TE
+.sp 1
.RE
.PP
destroot\&.dir
.RS 4
Where to destroot the project from (i\&.e\&. where the Xcode project is)\&.
+.TS
+tab(:);
+lt lt.
+T{
+\fBDefault:\fR
+T}:T{
+${worksrcpath}
+T}
+.TE
+.sp 1
.RE
.SH "GNUSTEP PORTGROUP"
.sp
@@ -413,11 +529,17 @@
.PP
gnustep\&.post_flags
.RS 4
-an associative array which specifies the sub\-directories relative to GNUmakefile\&.preamble in those sub\-directories\&. This helps making the patching process easier on Darwin\&.
-
+an associative array which specifies the sub\-directories relative to ${worksrcpath} and the SHARED_LD_POSTFLAGS variables to be added to GNUmakefile\&.preamble in those sub\-directories\&. This helps making the patching process easier on Darwin\&.
+.TS
+tab(:);
+lt lt.
+T{
\fBType:\fR
+T}:T{
optional
-
+T}
+.TE
+.sp 1
\fBExample:\fR
.sp
.if n \{\
@@ -437,13 +559,22 @@
.PP
gnustep\&.cc
.RS 4
-
+.TS
+tab(:);
+lt lt
+lt lt.
+T{
\fBType:\fR
+T}:T{
optional
-
+T}
+T{
\fBDefault:\fR
+T}:T{
gcc\-mp\-4\&.2
-
+T}
+.TE
+.sp 1
\fBExample:\fR
.sp
.if n \{\
@@ -460,10 +591,16 @@
variant with_docs
.RS 4
Many GNUstep packages include a Documentation sub\-directory that is not built by default\&. Enabling this variant builds and installs the included documentation\&.
-
+.TS
+tab(:);
+lt lt.
+T{
\fBType:\fR
+T}:T{
optional
-
+T}
+.TE
+.sp 1
\fBExample:\fR
.sp
.if n \{\
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.macosforge.org/pipermail/macports-changes/attachments/20130309/6a92500d/attachment-0001.html>
More information about the macports-changes
mailing list