<pre style='margin:0'>

Rainer Müller (raimue) pushed a commit to branch master

in repository macports-guide.

</pre>

<p><a href="https://github.com/macports/macports-guide/commit/38e3ed882c0548c19a01ea63e7f6df9d397706ca">https://github.com/macports/macports-guide/commit/38e3ed882c0548c19a01ea63e7f6df9d397706ca</a></p>

<pre style="white-space: pre; background: #F8F8F8"><span style='display:block; white-space:pre;color:#808000;'>commit 38e3ed882c0548c19a01ea63e7f6df9d397706ca

</span>Author: Rainer Müller <raimue@macports.org>

AuthorDate: Tue May 1 16:20:38 2018 +0200

<span style='display:block; white-space:pre;color:#404040;'>    adoc: Regenerate with patched docbookrx

</span><span style='display:block; white-space:pre;color:#404040;'>    

</span><span style='display:block; white-space:pre;color:#404040;'>    Regenerated with docbookrx with these patches applied:

</span><span style='display:block; white-space:pre;color:#404040;'>    https://github.com/raimue/docbookrx/compare/master...76d3c9ac857e696a386c79d3c91a4e3edaae7155

</span>---

 guide/adoc/glossary.adoc              |   4 +-

 guide/adoc/guide.adoc                 |  73 +++---

 guide/adoc/installing.adoc            | 167 ++++++------

 guide/adoc/internals-hier.adoc        |   2 +-

 guide/adoc/internals-tests.adoc       |  48 ++--

 guide/adoc/internals.adoc             |  76 +++---

 guide/adoc/intro.adoc                 |  14 +-

 guide/adoc/macports.conf.adoc         |  60 ++---

 guide/adoc/macros.adoc                |   4 +-

 guide/adoc/portfile-dependencies.adoc |  32 +--

 guide/adoc/portfile-keywords.adoc     |  23 +-

 guide/adoc/portfile-livecheck.adoc    |  24 +-

 guide/adoc/portfile-phase.adoc        | 283 ++++++++++----------

 guide/adoc/portfile-startupitem.adoc  |  69 ++---

 guide/adoc/portfile-tcl.adoc          |  44 ++--

 guide/adoc/portfile-variables.adoc    |  24 +-

 guide/adoc/portfile-variants.adoc     |  23 +-

 guide/adoc/portfiledev.adoc           | 146 +++++------

 guide/adoc/portfileref.adoc           | 102 +++++---

 guide/adoc/portgroup-github.adoc      |  22 +-

 guide/adoc/portgroup-gnustep.adoc     |   8 +-

 guide/adoc/portgroup-haskell.adoc     |   6 +-

 guide/adoc/portgroup-perl.adoc        |  10 +-

 guide/adoc/portgroup-python.adoc      |  32 +--

 guide/adoc/portgroup-ruby.adoc        |   8 +-

 guide/adoc/portgroup-xcode.adoc       |  28 +-

 guide/adoc/portgroups.adoc            |   4 +-

 guide/adoc/project.adoc               | 417 +++++++++++++-----------------

 guide/adoc/using.adoc                 | 473 +++++++++++++++++-----------------

 29 files changed, 1100 insertions(+), 1126 deletions(-)

<span style='display:block; white-space:pre;color:#808080;'>diff --git a/guide/adoc/glossary.adoc b/guide/adoc/glossary.adoc

</span><span style='display:block; white-space:pre;color:#808080;'>index 6aad8a0..7e0ca51 100644

</span><span style='display:block; white-space:pre;background:#e0e0ff;'>--- a/guide/adoc/glossary.adoc

</span><span style='display:block; white-space:pre;background:#e0e0ff;'>+++ b/guide/adoc/glossary.adoc

</span><span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1,10 +1,12 @@

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_guide_terms]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[guide-terms]]

</span> = MacPorts Guide Glossary

 :doctype: book

 :sectnums:

 :toc: left

 :icons: font

 :experimental:

<span style='display:block; white-space:pre;background:#e0ffe0;'>+:idprefix:

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+:idseparator: -

</span> :sourcedir: .

 This section defines a number of words which may be new to the reader.

<span style='display:block; white-space:pre;color:#808080;'>diff --git a/guide/adoc/guide.adoc b/guide/adoc/guide.adoc

</span><span style='display:block; white-space:pre;color:#808080;'>index ac093e8..abfa9b5 100644

</span><span style='display:block; white-space:pre;background:#e0e0ff;'>--- a/guide/adoc/guide.adoc

</span><span style='display:block; white-space:pre;background:#e0e0ff;'>+++ b/guide/adoc/guide.adoc

</span><span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1,57 +1,62 @@

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-= 

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-                    Mark

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-                    Duling

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-                ; 

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-                    Dr

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-                    Michael

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-                    Maibaum

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-                    A

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-                ; 

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-                    Will

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-                    Barton

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-                ; 

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-                    Clemens

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-                    Lang

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-                

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+= MacPorts Guide

</span> :doctype: book

 :sectnums:

 :toc: left

 :icons: font

 :experimental:

<span style='display:block; white-space:pre;background:#e0ffe0;'>+:idprefix:

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+:idseparator: -

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+:leveloffset: +1

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-:leveloffset: 1

</span> include::intro.adoc[]

<span style='display:block; white-space:pre;background:#ffe0e0;'>-:leveloffset: 0

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-:leveloffset: 1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+:leveloffset: -1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+:leveloffset: +1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+

</span> include::installing.adoc[]

<span style='display:block; white-space:pre;background:#ffe0e0;'>-:leveloffset: 0

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-:leveloffset: 1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+:leveloffset: -1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+:leveloffset: +1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+

</span> include::using.adoc[]

<span style='display:block; white-space:pre;background:#ffe0e0;'>-:leveloffset: 0

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-:leveloffset: 1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+:leveloffset: -1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+:leveloffset: +1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+

</span> include::portfiledev.adoc[]

<span style='display:block; white-space:pre;background:#ffe0e0;'>-:leveloffset: 0

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-:leveloffset: 1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+:leveloffset: -1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+:leveloffset: +1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+

</span> include::portfileref.adoc[]

<span style='display:block; white-space:pre;background:#ffe0e0;'>-:leveloffset: 0

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-:leveloffset: 1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+:leveloffset: -1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+:leveloffset: +1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+

</span> include::internals.adoc[]

<span style='display:block; white-space:pre;background:#ffe0e0;'>-:leveloffset: 0

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-:leveloffset: 1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+:leveloffset: -1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+:leveloffset: +1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+

</span> include::project.adoc[]

<span style='display:block; white-space:pre;background:#ffe0e0;'>-:leveloffset: 0

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-:leveloffset: 1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+:leveloffset: -1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+:leveloffset: +1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+

</span> include::glossary.adoc[]

<span style='display:block; white-space:pre;background:#ffe0e0;'>-:leveloffset: 0

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-:leveloffset: 1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+:leveloffset: -1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+:leveloffset: +1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+

</span> include::macros.adoc[]

<span style='display:block; white-space:pre;background:#ffe0e0;'>-:leveloffset: 0

</span>\ No newline at end of file

<span style='display:block; white-space:pre;background:#e0ffe0;'>+

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+:leveloffset: -1

</span>\ No newline at end of file

<span style='display:block; white-space:pre;color:#808080;'>diff --git a/guide/adoc/installing.adoc b/guide/adoc/installing.adoc

</span><span style='display:block; white-space:pre;color:#808080;'>index bc80c57..e336984 100644

</span><span style='display:block; white-space:pre;background:#e0e0ff;'>--- a/guide/adoc/installing.adoc

</span><span style='display:block; white-space:pre;background:#e0e0ff;'>+++ b/guide/adoc/installing.adoc

</span><span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1,20 +1,22 @@

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_installing]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[installing]]

</span> = Installing MacPorts

 :doctype: book

 :sectnums:

 :toc: left

 :icons: font

 :experimental:

<span style='display:block; white-space:pre;background:#e0ffe0;'>+:idprefix:

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+:idseparator: -

</span> :sourcedir: .

 This chapter shows you how to install MacPorts and its prerequisites step-by-step.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Note that the section about <<_installing.xcode,installing Xcode>> is macOS-specific.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-If you wish to install MacPorts on another platform, first make sure you have a working C compiler installed, skip ahead to <<_installing.macports.source,installing MacPorts from source>>, and continue to the end of the chapter.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Note that the section about <<installing.xcode,installing Xcode>> is macOS-specific.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+If you wish to install MacPorts on another platform, first make sure you have a working C compiler installed, skip ahead to <<installing.macports.source,installing MacPorts from source>>, and continue to the end of the chapter.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_installing.xcode]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[installing.xcode]]

</span> == Install Xcode

<span style='display:block; white-space:pre;background:#ffe0e0;'>-link:Xcode is a package provided by Apple containing compilers, libraries and additional tools required to develop applications for macOS.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+https://developer.apple.com/xcode/[Xcode] is a package provided by Apple containing compilers, libraries and additional tools required to develop applications for macOS.

</span> 

 [NOTE]

 ====

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -24,25 +26,25 @@ Also note that Xcode is not updated via OS X's Software Update utility on OS ver

</span> 

 Follow the instructions for your version of macOS:

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_installing.xcode.mavericks]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[installing.xcode.mavericks]]

</span> === Install Xcode on OS X 10.9 or Later

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Download the latest version of Xcode link:from the Apple developer website or get it link:using the Mac App

<span style='display:block; white-space:pre;background:#ffe0e0;'>-                    Store.

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+Download the latest version of Xcode https://developer.apple.com/downloads/index.action[from the Apple developer website] or get it https://itunes.apple.com/us/app/xcode/id497799835[using the Mac App

<span style='display:block; white-space:pre;background:#e0ffe0;'>+                    Store].

</span> 

 Once you have Xcode installed, open a terminal, run ``xcode-select --install``, and click the Install button to install the required command line developer tools.

 Don't worry if you see a message telling you the software cannot be installed because it is not currently available from the Software Update Server.

 This usually means you already have the latest version installed.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-You can also get the command line tools from link:the

<span style='display:block; white-space:pre;background:#ffe0e0;'>-                    Apple developer website.

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+You can also get the command line tools from https://developer.apple.com/downloads/index.action[the

<span style='display:block; white-space:pre;background:#e0ffe0;'>+                    Apple developer website].

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_installing.xcode.lion]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[installing.xcode.lion]]

</span> === Install Xcode on OS X 10.7 Lion or OS X 10.8 Mountain Lion

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Download the latest version of Xcode link:from the Apple developer website or get it link:using the Mac App

<span style='display:block; white-space:pre;background:#ffe0e0;'>-                    Store.

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+Download the latest version of Xcode https://developer.apple.com/downloads/index.action[from the Apple developer website] or get it https://itunes.apple.com/us/app/xcode/id497799835[using the Mac App

<span style='display:block; white-space:pre;background:#e0ffe0;'>+                    Store].

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_installing.xcode.lion.43]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[installing.xcode.lion.43]]

</span> ==== Xcode 4.3 and Later

 Xcode 4.3 and later do not automatically install the command line tools, but MacPorts requires them.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -53,7 +55,7 @@ If you wish to create Installer packages with ``port pkg``, you will also need t

The download page for this package can be opened via the Xcode -> Open Developer Tool -> More Developer Tools... menu item.

 After downloading and mounting the disk image, drag the PackageMaker application to your /Applications directory.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_installing.xcode.snowleopard]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[installing.xcode.snowleopard]]

</span> === Install Xcode on Mac OS X 10.6 Snow Leopard

 If you are using Mac OS X 10.6, there are two branches of Xcode which could be considered to be the latest, 3.2.x and 4.x.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -63,8 +65,8 @@ There are two options for downloading it:

. Xcode 3.2 - smaller download, but you will need to run Software Update after installing to get the latest version. Note that Apple might at some point discontinue providing these updates via their update servers.

 . Xcode 3.2.6 and iOS SDK 4.3 - includes the iOS SDK which is not needed for MacPorts.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Both are available from the link:Apple

<span style='display:block; white-space:pre;background:#ffe0e0;'>-                    developer website.

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+Both are available from the https://developer.apple.com/downloads/index.action[Apple

<span style='display:block; white-space:pre;background:#e0ffe0;'>+                    developer website].

You may also be able to install Xcode 3.2 from your Mac OS X 10.6 DVD and then run Software Update to get the latest version.

 Ensure that those of the following options that are available in the installer for your version of Xcode are selected:

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -75,10 +77,10 @@ Ensure that those of the following options that are available in the installer f

</span> * btn:[Command Line Support]

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_installing.xcode.other]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[installing.xcode.other]]

</span> === Install Xcode on Older Releases of Mac OS X

<span style='display:block; white-space:pre;background:#ffe0e0;'>-If you have an earlier release of Mac OS X, you may download the latest version of Xcode for Mac OS X 10.5 (Xcode 3.0 and Xcode 3.1 Developer Tools) or 10.4 (Xcode 2.4.1 and Xcode 2.5 Developer Tools) from the link:Apple developer website.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+If you have an earlier release of Mac OS X, you may download the latest version of Xcode for Mac OS X 10.5 (Xcode 3.0 and Xcode 3.1 Developer Tools) or 10.4 (Xcode 2.4.1 and Xcode 2.5 Developer Tools) from the https://developer.apple.com/downloads/index.action[Apple developer website].

</span> 

 Ensure that those of the following options that are available in the installer for your version of Xcode are selected:

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -88,29 +90,27 @@ Ensure that those of the following options that are available in the installer f

</span> * btn:[Command Line Support]

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_installing.macports]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[installing.macports]]

</span> == Install MacPorts

<span style='display:block; white-space:pre;background:#ffe0e0;'>-If you are using macOS, you should install MacPorts using the macOS package installer unless you do not wish to install it to [path]_/opt/local/_, the default MacPorts location, or if you wish to install a pre-release version of MacPorts base.

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-However, if you wish to <<_installing.macports.source.multiple,install multiple copies of MacPorts>> or install MacPorts on another OS platform, you must <<_installing.macports.source,install MacPorts from

<span style='display:block; white-space:pre;background:#ffe0e0;'>-                the source code>>.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+If you are using macOS, you should install MacPorts using the macOS package installer unless you do not wish to install it to [path]`/opt/local/`, the default MacPorts location, or if you wish to install a pre-release version of MacPorts base.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+However, if you wish to <<installing.macports.source.multiple,install multiple copies of MacPorts>> or install MacPorts on another OS platform, you must <<installing.macports.source,install MacPorts from the source code>>.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_installing.macports.binary]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[installing.macports.binary]]

</span> === macOS Package Install

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The macOS package installer automatically installs MacPorts, <<_installing.shell,sets the

<span style='display:block; white-space:pre;background:#ffe0e0;'>-                    shell environment>>, and runs a <<_using.port.selfupdate,selfupdate>> operation to update the ports tree and MacPorts base with the latest release.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+The macOS package installer automatically installs MacPorts, <<installing.shell,sets the shell environment>>, and runs a <<using.port.selfupdate,selfupdate>> operation to update the ports tree and MacPorts base with the latest release.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-. Download the latest [path]_MacPorts-2.4.3-....pkg_ installer from the releases link:on GitHub. Here are direct links for the latest versions of macOS:

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+. Download the latest [path]`MacPorts-2.4.3-....pkg` installer from the releases https://github.com/macports/macports-base/releases/[on GitHub]. Here are direct links for the latest versions of macOS:

</span> +

  macOS 10.13 High Sierra: ::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-link:MacPorts-2.4.3-10.13-HighSierra.pkg

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+https://github.com/macports/macports-base/releases/download/v2.4.3/MacPorts-2.4.3-10.13-HighSierra.pkg[MacPorts-2.4.3-10.13-HighSierra.pkg]

</span>  macOS 10.12 Sierra: ::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-link:MacPorts-2.4.3-10.12-Sierra.pkg

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+https://github.com/macports/macports-base/releases/download/v2.4.3/MacPorts-2.4.3-10.12-Sierra.pkg[MacPorts-2.4.3-10.12-Sierra.pkg]

</span>  OS X 10.11 El Capitan: ::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-link:MacPorts-2.4.3-10.11-ElCapitan.pkg

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+https://github.com/macports/macports-base/releases/download/v2.4.3/MacPorts-2.4.3-10.11-ElCapitan.pkg[MacPorts-2.4.3-10.11-ElCapitan.pkg]

. Double-click the downloaded package installer to perform the default "`easy`" install.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-. After this step you are done already, MacPorts is now installed and your shell environment was set up automatically by the installer. To confirm the installation is working as expected, now try using `port` in a _new_ terminal window.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+. After this step you are done already, MacPorts is now installed and your shell environment was set up automatically by the installer. To confirm the installation is working as expected, now try using [cmd]``port`` in a _new_ terminal window.

</span> +

 [source]

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -123,17 +123,17 @@ $ port version

</span> Version: 2.4.3

 ----

 +

<span style='display:block; white-space:pre;background:#ffe0e0;'>-In case of problems such as "`command not found`", make sure that you opened a new terminal window or consult <<_installing.shell>>.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Otherwise, please skip the remainder of this chapter and continue with <<_using>> in this guide.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+In case of problems such as "`command not found`", make sure that you opened a new terminal window or consult <<installing.shell>>.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Otherwise, please skip the remainder of this chapter and continue with <<using>> in this guide.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_installing.macports.source]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[installing.macports.source]]

</span> === Source Install

 If you installed MacPorts using the package installer, skip this section.

 To install MacPorts from the source code, follow the steps below.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-. Download and extract the link: MacPorts 2.4.3 tarball. Either do so using your browser and the Finder, or use the given commands in a terminal window.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+. Download and extract the https://distfiles.macports.org/MacPorts/MacPorts-2.4.3.tar.bz2[ MacPorts 2.4.3 tarball]. Either do so using your browser and the Finder, or use the given commands in a terminal window.

</span> +

 [source]

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -141,7 +141,7 @@ To install MacPorts from the source code, follow the steps below.

</span> $ curl -O https://distfiles.macports.org/MacPorts/MacPorts-2.4.3.tar.bz2

 $ tar xf MacPorts-2.4.3.tar.bz2

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-. Afterwards, perform the commands shown in the terminal window. If you wish to use a path other than [path]_/opt/local_, follow the instructions for <<_installing.macports.source.multiple,installing multiple copies of MacPorts>> instead.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+. Afterwards, perform the commands shown in the terminal window. If you wish to use a path other than [path]`/opt/local`, follow the instructions for <<installing.macports.source.multiple,installing multiple copies of MacPorts>> instead.

</span> +

 [source]

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -151,10 +151,10 @@ $ ./configure

</span> $ make

 $ sudo make install

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-. Please continue with <<_installing.shell>> to set up your shell environment.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+. Please continue with <<installing.shell>> to set up your shell environment.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_installing.macports.git]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[installing.macports.git]]

</span> === Git Install

 If you installed MacPorts using the package installer, skip this section.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -164,13 +164,13 @@ Maybe there's a new feature that you'd like to use, or it fixes an issue you've

These steps explain how to setup MacPorts for developers, using only Git to keep MacPorts up to date.

 Though a distinction is made between pre-release and release versions of MacPorts base, the ports collection supports no such distinction or versioning.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The <<_using.port.selfupdate,selfupdate>> command installs the latest ports tree, and updates MacPorts base to the latest released version.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+The <<using.port.selfupdate,selfupdate>> command installs the latest ports tree, and updates MacPorts base to the latest released version.

</span> 

 . Check out MacPorts source

 +

 Pick a location to store a working copy of the MacPorts code.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-For this example, [path]_/opt/mports_ will be used, but you can put the source anywhere.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-This example will create [path]_/opt/mports/macports-base_ containing everything needed for MacPorts.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+For this example, [path]`/opt/mports` will be used, but you can put the source anywhere.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+This example will create [path]`/opt/mports/macports-base` containing everything needed for MacPorts.

</span> +

 [source]

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -183,8 +183,8 @@ $ git checkout v2.4.3  # skip this if you want to use the development version

</span> . Build and Install MacPorts

 +

 MacPorts uses autoconf and makefiles for installation.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-These commands will build and install MacPorts to [path]_/opt/local_.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-You can add [option]``--prefix`` to [path]_./configure_ to relocate MacPorts to another directory if needed.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+These commands will build and install MacPorts to [path]`/opt/local`.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+You can add `--prefix` to [path]`./configure` to relocate MacPorts to another directory if needed.

</span> +

 [source]

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -207,7 +207,7 @@ $ cd /opt/mports

</span> $ git clone https://github.com/macports/macports-ports.git

 ----

 +

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Then open [path]_/opt/local/etc/macports/sources.conf_ in a text editor.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Then open [path]`/opt/local/etc/macports/sources.conf` in a text editor.

</span> The last line should look like this:

 +

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -227,15 +227,15 @@ file:///opt/mports/macports-ports [default]

Now MacPorts will look for portfiles in the working copy and use Git instead of rsync to update your ports tree.

 . Environment

 +

<span style='display:block; white-space:pre;background:#ffe0e0;'>-You should setup your PATH and other environment options according to <<_installing.shell>>.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+You should setup your PATH and other environment options according to <<installing.shell>>.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_installing.macports.source.multiple]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[installing.macports.source.multiple]]

</span> === Install Multiple MacPorts Copies

 Occasionally a MacPorts developer may wish to install more than one MacPorts instance on the same host.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Only one copy of MacPorts may use the default prefix [path]_/opt/local_, so for additional installations use the option [option]``--prefix`` as shown below.

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-It's also recommended to change the applications dir using [option]``--with-applications-dir`` to avoid conflicts in [path]_/Applications/MacPorts_. 

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Only one copy of MacPorts may use the default prefix [path]`/opt/local`, so for additional installations use the option `--prefix` as shown below.

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+It's also recommended to change the applications dir using `--with-applications-dir` to avoid conflicts in [path]`/Applications/MacPorts`. 

</span> 

 [NOTE]

 ====

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -256,21 +256,21 @@ After installing the second instance you might need to add

</span> ----

 startupitem_install no

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-to [path]_$MP_PREFIX/etc/macports/macports.conf_ to avoid conflicts in [path]_/Library/LaunchAgents_.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+to [path]`$MP_PREFIX/etc/macports/macports.conf` to avoid conflicts in [path]`/Library/LaunchAgents`.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_installing.macports.upgrade]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[installing.macports.upgrade]]

</span> == MacPorts Upgrade

<span style='display:block; white-space:pre;background:#ffe0e0;'>-MacPorts base upgrades are performed automatically (when a newer release is available) during a <<_using.port.selfupdate,selfupdate>> operation.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-To upgrade a copy of MacPorts that was installed from source to the newer release of the source code, simply repeat the <<_installing.macports.source,source install>> with the newer version of the MacPorts source code.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+MacPorts base upgrades are performed automatically (when a newer release is available) during a <<using.port.selfupdate,selfupdate>> operation.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+To upgrade a copy of MacPorts that was installed from source to the newer release of the source code, simply repeat the <<installing.macports.source,source install>> with the newer version of the MacPorts source code.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_installing.macports.uninstalling]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[installing.macports.uninstalling]]

</span> == Uninstall

 Uninstalling MacPorts can be a drastic step, and depending on the issue you are experiencing, you may not need to do so.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-If you are unsure, ask on the link:macports-users mailing list first.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+If you are unsure, ask on the https://lists.macports.org/mailman/listinfo/macports-users[macports-users] mailing list first.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-If you need to uninstall MacPorts, and `port` is functioning, first uninstall all the installed ports by running this command in the Terminal:

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+If you need to uninstall MacPorts, and [cmd]``port`` is functioning, first uninstall all the installed ports by running this command in the Terminal:

</span> 

 [source]

 ----

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -279,10 +279,10 @@ $ sudo port -fp uninstall installed

</span> 

 All that will be left in your installation prefix now will be files that were not registered to any port.

 This includes configuration files, databases, any files which MacPorts renamed in order to allow a forced installation or upgrade, and the base MacPorts software itself.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-You may wish to save your configuration files (most are in [path]_$prefix/etc_), databases, or any other unique data by moving it aside.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+You may wish to save your configuration files (most are in [path]`$prefix/etc`), databases, or any other unique data by moving it aside.

</span> 

 To remove all remaining traces of MacPorts, run the following command in the Terminal.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-If you have changed [var]``prefix``, [var]``applications_dir`` or [var]``frameworks_dir`` from their default values, then replace [path]_/opt/local_ with your [var]``prefix``, replace [path]_/Applications/MacPorts_ with your [var]``applications_dir``, and/or add your [var]``frameworks_dir`` to the list, respectively.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+If you have changed ``prefix``, `applications_dir` or `frameworks_dir` from their default values, then replace [path]`/opt/local` with your ``prefix``, replace [path]`/Applications/MacPorts` with your ``applications_dir``, and/or add your `frameworks_dir` to the list, respectively.

</span> 

 [source]

 ----

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -303,27 +303,26 @@ If you use a shell other than bash (perhaps tcsh), you may need to adjust the ab

Also note that depending on which version of MacPorts you have and which ports you have installed, not all of the above paths will exist on your system.

 This is OK.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_installing.shell]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[installing.shell]]

</span> == MacPorts and the Shell

 MacPorts requires that some environment variables be set in the shell.

 When MacPorts is installed using the macOS package installer, a "`postflight`" script is run after installation that automatically adds or modifies a shell configuration file in your home directory, ensuring that it defines variables according to the rules described in the following section.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Those <<_installing.macports.source,installing MacPorts from source code>> must modify their environment manually using the rules as a guide.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Those <<installing.macports.source,installing MacPorts from source code>> must modify their environment manually using the rules as a guide.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Depending on your shell and which configuration files already exist, the installer may use [path]_.profile_, [path]_.bash_login_, [path]_.bash_profile_, [path]_.tcshrc_, or [path]_.cshrc_.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Depending on your shell and which configuration files already exist, the installer may use [path]`.profile`, [path]`.bash_login`, [path]`.bash_profile`, [path]`.tcshrc`, or [path]`.cshrc`.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_installing.shell.postflight]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[installing.shell.postflight]]

</span> === The Postflight Script

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The postflight script automatically sets the [var]``PATH`` variable, and optionally the [var]``MANPATH`` and [var]``DISPLAY`` variables according to the rules described below.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+The postflight script automatically sets the `PATH` variable, and optionally the `MANPATH` and `DISPLAY` variables according to the rules described below.

If a current shell configuration file exists at installation time it is renamed to "`mpsaved_$timestamp`".

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Those <<_installing.macports.source,installing MacPorts

<span style='display:block; white-space:pre;background:#ffe0e0;'>-                    from source code>> must modify their environment manually using the rules as a guide.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Those <<installing.macports.source,installing MacPorts from source code>> must modify their environment manually using the rules as a guide.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* Required: [var]``PATH`` variable

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* Required: `PATH` variable

</span> +

 This variable is set by the postflight script to prepend the MacPorts executable paths to the current path as shown.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-This puts the MacPorts paths at the front of [var]``PATH`` so that the MacPorts binaries will take precedence over vendor-supplied binaries.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+This puts the MacPorts paths at the front of `PATH` so that the MacPorts binaries will take precedence over vendor-supplied binaries.

</span> +

 [source]

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -335,31 +334,23 @@ export PATH=/opt/local/bin:/opt/local/sbin:$PATH

</span> [NOTE]

 ====

 The user environment's $PATH is not in effect while ports are being installed, because the $PATH is scrubbed before ports are installed, and restored afterwards.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-To change the search path for locating system executables (rsync, tar, etc.) during port installation, see the <<_internals.configuration_files.macports_conf,macports.conf>> file variable [var]``binpath``.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+To change the search path for locating system executables (rsync, tar, etc.) during port installation, see the <<internals.configuration-files.macports-conf,macports.conf>> file variable ``binpath``.

But changing this variable is for advanced users only, and is not generally needed or recommended.

 ====

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* Optional: [var]``MANPATH`` variable

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* Optional: `MANPATH` variable

</span> +

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Condition: If prior to MacPorts installation a [var]``MANPATH`` variable exists in a current [path]_.profile_ that contains neither the value [path]_${prefix}/share/man,_ nor any empty values, the postflight script sets the [var]``MANPATH`` variable as shown below.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Otherwise, the [var]``MANPATH`` variable is omitted.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Condition: If prior to MacPorts installation a `MANPATH` variable exists in a current [path]`.profile` that contains neither the value [path]`${prefix}/share/man,` nor any empty items separated by a colon, the postflight script sets the `MANPATH` variable as shown below.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Otherwise, the `MANPATH` variable is omitted.

</span> +

 [source]

 ----

 export MANPATH=/opt/local/share/man:$MANPATH

 ----

<span style='display:block; white-space:pre;background:#e0ffe0;'>+* Optional: `DISPLAY` variable

</span> +

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Here are some examples of paths that contain empty values:

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-+

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-// <simplelist>

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-//                         <member>/usr/share/man:</member>

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-//                         <member>:/usr/share/man</member>

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-//                         <member>/usr/share/man::/usr/X11R6/man</member>

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-//                     </simplelist>

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-* Optional: [var]``DISPLAY`` variable

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-+

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Condition: If installing on a Mac OS X version earlier than 10.5 (Leopard), and if a shell configuration file exists at time of MacPorts installation without a [var]``DISPLAY`` variable, the postflight script sets a [var]``DISPLAY`` variable as shown below.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The [var]``DISPLAY`` variable is always omitted on Mac OS X 10.5 or higher.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Condition: If installing on a Mac OS X version earlier than 10.5 (Leopard), and if a shell configuration file exists at time of MacPorts installation without a `DISPLAY` variable, the postflight script sets a `DISPLAY` variable as shown below.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+The `DISPLAY` variable is always omitted on Mac OS X 10.5 or higher.

</span> +

 [source]

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -368,11 +359,11 @@ export DISPLAY=:0.0

</span> ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_installing.shell.verifyprofile]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[installing.shell.verifyprofile]]

</span> === Verify the Configuration File

<span style='display:block; white-space:pre;background:#ffe0e0;'>-To verify that the file containing the MacPorts variables is in effect, type `env` in the terminal to verify the current environment settings after the file has been created.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Example output for `env` is shown below.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+To verify that the file containing the MacPorts variables is in effect, type [cmd]``env`` in the terminal to verify the current environment settings after the file has been created.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Example output for [cmd]``env`` is shown below.

</span> 

 [NOTE]

 ====

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -398,12 +389,12 @@ SECURITYSESSIONID=b0cea0

</span> _=/usr/bin/env

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_installing.shell.editorvar]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[installing.shell.editorvar]]

</span> === Optional Editor Variables

<span style='display:block; white-space:pre;background:#ffe0e0;'>-You can set an environment variable in order to use your favorite text editor with the `port edit` command.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+You can set an environment variable in order to use your favorite text editor with the [cmd]``port edit`` command.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-MacPorts will check [var]``MP_EDITOR``, [var]``VISUAL`` and [var]``EDITOR`` in this order, allowing you to either use a default editor shared with other programs ([var]``VISUAL`` and [var]``EDITOR``) or a MacPorts-specific one ([var]``MP_EDITOR``).

<span style='display:block; white-space:pre;background:#e0ffe0;'>+MacPorts will check ``MP_EDITOR``, `VISUAL` and `EDITOR` in this order, allowing you to either use a default editor shared with other programs (``VISUAL`` and ``EDITOR``) or a MacPorts-specific one (``MP_EDITOR``).

</span> 

 For example, to use the nano editor, add this line to your bash config:

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -412,7 +403,7 @@ For example, to use the nano editor, add this line to your bash config:

</span> export EDITOR=/usr/bin/nano

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-To use the user-friendly GUI editor link:BBEdit (installation required), add this line:

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+To use the user-friendly GUI editor https://www.barebones.com/products/bbedit/[BBEdit] (installation required), add this line:

</span> 

 [source]

 ----

<span style='display:block; white-space:pre;color:#808080;'>diff --git a/guide/adoc/internals-hier.adoc b/guide/adoc/internals-hier.adoc

</span><span style='display:block; white-space:pre;color:#808080;'>index 57e9a11..d54eef5 100644

</span><span style='display:block; white-space:pre;background:#e0e0ff;'>--- a/guide/adoc/internals-hier.adoc

</span><span style='display:block; white-space:pre;background:#e0e0ff;'>+++ b/guide/adoc/internals-hier.adoc

</span><span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1,4 +1,4 @@

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-// <refentry xml:id="porthier">

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+// <refentry xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="porthier">

</span> //   <refmeta>

 //     <refentrytitle>PORTHIER</refentrytitle>

 // 

<span style='display:block; white-space:pre;color:#808080;'>diff --git a/guide/adoc/internals-tests.adoc b/guide/adoc/internals-tests.adoc

</span><span style='display:block; white-space:pre;color:#808080;'>index 7f7a307..edfe596 100644

</span><span style='display:block; white-space:pre;background:#e0e0ff;'>--- a/guide/adoc/internals-tests.adoc

</span><span style='display:block; white-space:pre;background:#e0e0ff;'>+++ b/guide/adoc/internals-tests.adoc

</span><span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1,17 +1,17 @@

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_internals.tests]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[internals.tests]]

</span> = Tests

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The MacPorts testing framework uses link:tcltest for its unit tests as well as regression tests.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+The MacPorts testing framework uses http://wiki.tcl.tk/1502[tcltest] for its unit tests as well as regression tests.

</span> The framework was developed during Google Summer of Code 2013 by Marius Coțofană (marius@). 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-To keep things simple, each module of MacPorts ( link:macports1.0, link:package1.0, link:port1.0, link:registry2.0 ) has its own [path]_tests/_ directory.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Each Tcl script in a module (e.g. link:macports.tcl) has its own test script located in the [path]_tests_ directory, with the same name and the '.test' extension (e.g. link:macports.test). Every proc in a script (e.g. ``proc macports::findBinary``) should have its own test proc (e.g. ``test findBinary``) in the corresponding test file.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+To keep things simple, each module of MacPorts ( https://github.com/macports/macports-base/tree/master/src/macports1.0[macports1.0], https://github.com/macports/macports-base/tree/master/src/package1.0[package1.0], https://github.com/macports/macports-base/tree/master/src/port1.0[port1.0], https://github.com/macports/macports-base/tree/master/src/registry2.0[registry2.0] ) has its own [path]`tests/` directory.

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+Each Tcl script in a module (e.g. https://github.com/macports/macports-base/blob/master/src/macports1.0/macports.tcl[macports.tcl]) has its own test script located in the [path]`tests` directory, with the same name and the '.test' extension (e.g. https://github.com/macports/macports-base/blob/master/src/macports1.0/tests/macports.test[macports.test]). Every proc in a script (e.g. ``proc macports::findBinary``) should have its own test proc (e.g. ``test findBinary``) in the corresponding  [...]

</span> Test procs should maintain the order in the original script and should be independent one of another. 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_internals.tests.running]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[internals.tests.running]]

</span> == Running tests

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Tests can be run only on an installed version of MacPorts (so make sure you have run ``sudo make install``). 

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+Tests can be run only on an installed version of MacPorts (so make sure you have run [cmd]``sudo make install``). 

</span> 

 The easiest way to run all the tests, is to use the target in the Makefile. 

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -20,9 +20,9 @@ The easiest way to run all the tests, is to use the target in the Makefile.

</span> $ make test

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Each [path]_tests/_ directory has a [path]_test.tcl_ file, used by the make target to run all tests and format the output, making it easy to read.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Each [path]`tests/` directory has a [path]`test.tcl` file, used by the make target to run all tests and format the output, making it easy to read.

The script just runs the tests individually, printing the test file name, the total number of tests, number of passed, skipped, failed as well as constraints or errors of failed tests.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-This is one possible output when running [path]_macports.test_: 

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+This is one possible output when running [path]`macports.test`: 

</span> 

 ----

 Total:31 Passed:31 Failed:0 Skipped:0  macports.test

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -76,19 +76,19 @@ $ tclsh test.tcl -t macports.test

</span> $ tclsh test.tcl -h

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Specific test cases can be run using the `'-match'` argument for the file that contains the test, from its parent directory. 

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+Specific test cases can be run using the [cmd]``'-match'`` argument for the file that contains the test, from its parent directory. 

</span> 

 [source]

 ----

 $ tclsh macports.test -match mportclose

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Regression tests can be found in link:tests/test/ and can be run just as unit tests, using `make test` from the parent directory. 

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+Regression tests can be found in https://github.com/macports/macports-base/tree/master/tests/test/[tests/test/] and can be run just as unit tests, using [cmd]``make test`` from the parent directory. 

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_internals.tests.mustknow]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[internals.tests.mustknow]]

</span> == Must know

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* regression tests have their own directory, found in link:trunk/base/tests/test

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* regression tests have their own directory, found in https://github.com/macports/macports-base/tree/master/tests/test/[trunk/base/tests/test]

</span> * each module of MacPorts (port1.0, macports1.0, package1.0) has its own '`tests/`' directory where the test files are located and also additional files needed (Portfile, test.tcl)

 * each file in a module has a corresponding test file (.test extension) in the '`tests/`' directory

 * each proc in a file has a corresponding test case (test proc_name) in the

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -100,7 +100,7 @@ Regression tests can be found in link:tests/test/ and can be run just as unit te

</span> * for some tests in package1.0, an update of the ports tree is required; this is done automatically if they are run using the 'test' target in the Makefile, with root privileges 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_internals.tests.sample_file]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[internals.tests.sample-file]]

</span> == Sample file

 [source]

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -187,20 +187,20 @@ test mportclose {

</span> cleanupTests

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_internals.tests.addtional_files]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[internals.tests.addtional-files]]

</span> == Additional files

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* In all tests we use this link:Portfile.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* This is the link:test.tcl file used to run and parse the output of all the tests in a module.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* A worker_init copy, without using sub-interpreters link:library.tcl.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* Example of link:sources.conf.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* An example of a test file link:macports.test.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* A link:library.tcl of useful procs in regression testing.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+* In all tests we use this https://github.com/macports/macports-base/blob/master/src/macports1.0/tests/Portfile[Portfile].

<span style='display:block; white-space:pre;background:#e0ffe0;'>+* This is the https://github.com/macports/macports-base/blob/master/src/macports1.0/tests/test.tcl[test.tcl] file used to run and parse the output of all the tests in a module.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+* A worker_init copy, without using sub-interpreters https://github.com/macports/macports-base/blob/master/src/package1.0/tests/library.tcl[library.tcl].

<span style='display:block; white-space:pre;background:#e0ffe0;'>+* Example of https://github.com/macports/macports-base/blob/master/src/macports1.0/tests/sources.conf[sources.conf].

<span style='display:block; white-space:pre;background:#e0ffe0;'>+* An example of a test file https://github.com/macports/macports-base/blob/master/src/macports1.0/tests/macports.test[macports.test].

<span style='display:block; white-space:pre;background:#e0ffe0;'>+* A https://github.com/macports/macports-base/blob/master/tests/test/library.tcl[library.tcl] of useful procs in regression testing.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_internals.tests.resources]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[internals.tests.resources]]

</span> == Resources

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* link:Tcltest official wiki page

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-* link:Getting started with tcltest

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-* link:Official tcltest documentation

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* http://wiki.tcl.tk/1502[Tcltest official wiki page]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* http://web.archive.org/web/20080617153002/www.tclscripting.com/articles/apr06/article1.html[Getting started with tcltest]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* http://www.tcl.tk/man/tcl8.5/TclCmd/tcltest.htm[Official tcltest documentation]

</span><span style='display:block; white-space:pre;color:#808080;'>diff --git a/guide/adoc/internals.adoc b/guide/adoc/internals.adoc

</span><span style='display:block; white-space:pre;color:#808080;'>index 0e17366..5865503 100644

</span><span style='display:block; white-space:pre;background:#e0e0ff;'>--- a/guide/adoc/internals.adoc

</span><span style='display:block; white-space:pre;background:#e0e0ff;'>+++ b/guide/adoc/internals.adoc

</span><span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1,32 +1,38 @@

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_internals]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[internals]]

</span> = MacPorts Internals

 :doctype: book

 :sectnums:

 :toc: left

 :icons: font

 :experimental:

<span style='display:block; white-space:pre;background:#e0ffe0;'>+:idprefix:

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+:idseparator: -

</span> :sourcedir: .

 This chapter contains information about the MacPorts file layout, configuration files, a few fundamental port installation concepts, and the MacPorts APIs.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_internals.hierarchy]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[internals.hierarchy]]

</span> == File Hierarchy

<span style='display:block; white-space:pre;background:#ffe0e0;'>-:leveloffset: 2

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+:leveloffset: +1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+

</span> include::internals-hier.adoc[]

<span style='display:block; white-space:pre;background:#ffe0e0;'>-:leveloffset: 0

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-:leveloffset: 1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+:leveloffset: -1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+:leveloffset: +1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+

</span> include::macports.conf.adoc[]

<span style='display:block; white-space:pre;background:#ffe0e0;'>-:leveloffset: 0

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_internals.images]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+:leveloffset: -1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[internals.images]]

</span> == Port Images

 MacPorts has a unique ability to allow multiple versions, revisions, and variants of the same port to be installed at the same time, so you may test new port versions without uninstalling a previous working version.

 This capability derives from the fact that a MacPorts port by default is not installed into its final or "`activated`" location, but rather to an intermediate location that is only made available to other ports and end-users after an activation phase that extracts all its files from the image repository.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Deactivating a port only removes the files from their activated locations (usually under [var]``${prefix}``)--the deactivated port's image is not disturbed.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Deactivating a port only removes the files from their activated locations (usually under ``${prefix}``)--the deactivated port's image is not disturbed.

</span> 

 The location of an installed port's image can be seen by running: 

 [source]

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -34,7 +40,7 @@ The location of an installed port's image can be seen by running:

</span> %% port location PORTNAME

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_internals.apis]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[internals.apis]]

</span> == APIs and Libs

 The MacPorts system is composed of three Tcl libraries:

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -44,10 +50,10 @@ The MacPorts system is composed of three Tcl libraries:

</span> * pextlib - C extensions to Tcl

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_internals.apis.ports]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[internals.apis.ports]]

</span> === Ports API

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The code for the Port API is located in [path]_base/src/port1.0_.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+The code for the Port API is located in [path]`base/src/port1.0`.

The Port API provides all the primitives required for a Portfile to be parsed, queried, and executed.

 It also provides a single procedure call that the MacPorts API uses to kick off execution: ``eval_targets``.

 The port Tcl library supplies these procedures, all of which are generated at run-time using the `options` procedure in portutil.tcl.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -70,12 +76,12 @@ The Ports API performs the following functions:

* Provides simple access to the ui_event mechanism by providing the various ui_ procedures (i.e., ui_msg, ui_error).

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_internals.apis.macports]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[internals.apis.macports]]

</span> === MacPorts API

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The code for the MacPorts API is located in [path]_base/src/macports1.0_.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The MacPorts API provides a public API into the MacPorts system by providing simple primitives for handling Portfiles, dependencies, and registry operations, and exports the MacPorts API for the `port` command line utility, or any other.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The API has very little information about the contents Portfiles; instead, it relies entirely upon the `port` Tcl library.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+The code for the MacPorts API is located in [path]`base/src/macports1.0`.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+The MacPorts API provides a public API into the MacPorts system by providing simple primitives for handling Portfiles, dependencies, and registry operations, and exports the MacPorts API for the [cmd]``port`` command line utility, or any other.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+The API has very little information about the contents Portfiles; instead, it relies entirely upon the [cmd]``port`` Tcl library.

By keeping the high level API simple and generic, revisions to the underlying ports system will not necessarily require a revision of the high level MacPorts API.

 The MacPorts API is also responsible for loading user specified options into a sub-interpreter to be evaluated by the ports API.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -96,26 +102,26 @@ UI Abstractions are handled at this layer.

Each port action is provided a context, and a mechanism for posting user interface events is exported to the Port API (ui_event).

 * Registry management routines.

 +

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Manages the SQLite port registry in [path]_${prefix}/var/macports/registry/_.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-See also <<_internals.registry>>.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Manages the SQLite port registry in [path]`${prefix}/var/macports/registry/`.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+See also <<internals.registry>>.

* Exports the MacPorts API for use by client applications.

 +

 The following routines are defined.

 ** `mportinit:` Initializes the MacPorts system. Should be called before trying to use any other procedure.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-** `mportsearch:` Given a regexp, searches the [path]_PortIndex_ for ports with matching names.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+** `mportsearch:` Given a regexp, searches the [path]`PortIndex` for ports with matching names.

** `mportopen:` Given a URI to a port, opens a Portfile and returns an opaque handle to it.

 ** `mportclose:` Given a port handle, closes a Portfile.

 ** `mportexec:` Given a port handle, executes a target (e.g., install).

<span style='display:block; white-space:pre;background:#ffe0e0;'>-** `mportinfo:` Given a port handle, this returns the PortInfo array (as a flat list of array elements). This is a little tricky and unstable and only used by ``portindex``.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+** `mportinfo:` Given a port handle, this returns the PortInfo array (as a flat list of array elements). This is a little tricky and unstable and only used by [cmd]``portindex``.

** `mportdepends:` Given a port handle, returns a list of ports upon which the specified port depends.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-For an example of the MacPorts API, when one executes ``port search cm3``, the port utility:

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+For an example of the MacPorts API, when one executes [cmd]``port search cm3``, the port utility:

</span> 

 * Calls the `mportsearch` function to find all ports containing "`cm3`".

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* Returns Tcl array(s) containing data from the [path]_PortIndex_: port name, version, revision, variants, etc.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+* Returns Tcl array(s) containing data from the [path]`PortIndex`: port name, version, revision, variants, etc.

* Formats the list of arrays in the standard viewing format.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-For another MacPorts API example, when one executes ``port

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+For another MacPorts API example, when one executes [cmd]``port

</span>       install cm3``, the port utility:

 * Calls the `mportsearch` function to find the first port that matches the name "`cm3`".

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -124,12 +130,12 @@ For another MacPorts API example, when one executes ``port

* Calls the `mportclose` function to close the port.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_internals.apis.pextlib]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[internals.apis.pextlib]]

</span> === pextlib

 The pextlib Tcl library provides a variety of C extensions to add capabilities to Tcl procedures; for example, an interface to flock(2) and mkstemp(3).

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_internals.registry]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[internals.registry]]

</span> == The MacPorts Registry

 This chapter provides an overview of the MacPorts registry and its API.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -143,22 +149,22 @@ The registry allows MacPorts utilities to:

* Maintain dependency trees of installed ports.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_internals.registry.files]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[internals.registry.files]]

</span> === Registry Files

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The SQLite registry used by default is located at [path]_${portdbpath}/registry_, which by default would be [path]_${prefix}/var/macports/registry_.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-All data is stored in a single file named [path]_registry.db_, although the additional directory [path]_portfiles_ is used temporarily for extracting stored Portfiles from the registry.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Furthermore, access to the registry may be locked using [path]_.registry.lock_ with the `registry::exclusive_lock` and `registry::exclusive_unlock` APIs.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+The SQLite registry used by default is located at [path]`${portdbpath}/registry`, which by default would be [path]`${prefix}/var/macports/registry`.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+All data is stored in a single file named [path]`registry.db`, although the additional directory [path]`portfiles` is used temporarily for extracting stored Portfiles from the registry.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Furthermore, access to the registry may be locked using [path]`.registry.lock` with the `registry::exclusive_lock` and `registry::exclusive_unlock` APIs.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The legacy flat file registry files are contained in [path]_${portdbpath}/receipts_, which by default is location [path]_${prefix}/var/macports/receipts_.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-File mappings and dependency mappings are tracked in the flat file registry by [path]_file_map.db_ and [path]_dep_map.bz2_.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+The legacy flat file registry files are contained in [path]`${portdbpath}/receipts`, which by default is location [path]`${prefix}/var/macports/receipts`.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+File mappings and dependency mappings are tracked in the flat file registry by [path]`file_map.db` and [path]`dep_map.bz2`.

</span> If found, these will be automatically converted to the new SQLite registry. 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_internals.registry.api]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[internals.registry.api]]

</span> === The Registry API

 The MacPorts registry provides a public API in the registry1.0 Tcl package.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Using this API listed below you can access the MacPorts Registry using the default receipt storage mechanism chosen in [path]_macports.conf_.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Using this API listed below you can access the MacPorts Registry using the default receipt storage mechanism chosen in [path]`macports.conf`.

</span> 

 `registry::new_entry {name version {revision 0} {variants ""}}`::

 Begin the creation of a new registry entry for the given port.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -244,6 +250,8 @@ Unregister the given dependency of the given type as a dependency of the given p

</span> `registry::write_dep_map {args}`::

 Write changes to the dependency map.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-:leveloffset: 1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+:leveloffset: +1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+

</span> include::internals-tests.adoc[]

<span style='display:block; white-space:pre;background:#ffe0e0;'>-:leveloffset: 0

</span>\ No newline at end of file

<span style='display:block; white-space:pre;background:#e0ffe0;'>+

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+:leveloffset: -1

</span>\ No newline at end of file

<span style='display:block; white-space:pre;color:#808080;'>diff --git a/guide/adoc/intro.adoc b/guide/adoc/intro.adoc

</span><span style='display:block; white-space:pre;color:#808080;'>index e4dee1d..f0a1d4d 100644

</span><span style='display:block; white-space:pre;background:#e0e0ff;'>--- a/guide/adoc/intro.adoc

</span><span style='display:block; white-space:pre;background:#e0e0ff;'>+++ b/guide/adoc/intro.adoc

</span><span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -4,16 +4,18 @@

</span> :toc: left

 :icons: font

 :experimental:

<span style='display:block; white-space:pre;background:#e0ffe0;'>+:idprefix:

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+:idseparator: -

</span> :sourcedir: .

 MacPorts is an easy to use system for compiling, installing, and managing open source software.

 MacPorts may be conceptually divided into two main parts: the infrastructure, known as MacPorts base, and the set of available ports.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-A MacPorts port is a set of specifications contained in a <<_development.introduction,Portfile>> that defines an application, its characteristics, and any files or special instructions required to install it.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+A MacPorts port is a set of specifications contained in a <<development.introduction,Portfile>> that defines an application, its characteristics, and any files or special instructions required to install it.

This allows you to use a single command to tell MacPorts to automatically download, compile, and install applications and libraries.

 But using MacPorts to manage your open source software provides several other significant advantages.

 For example, MacPorts:

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* Installs automatically any required support software, known as <<_reference.dependencies,dependencies>>, for a given port.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+* Installs automatically any required support software, known as <<reference.dependencies,dependencies>>, for a given port.

* Provides for uninstalls and upgrades for installed ports.

 * Confines ported software to a private "`sandbox`" that keeps it from intermingling with your operating system and its vendor-supplied software to prevent them from becoming corrupted.

 * Allows you to create pre-compiled binary installers of ported applications to quickly install software on remote computers without compiling from source code.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -42,7 +44,7 @@ Command output to a terminal window.

File text.

 ----

 * Other special text types.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-** A hyperlink: link:spontaneous combustion.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-** A file: [path]_/var/log/system.log_.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-** A command: ``ifconfig``.

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-** An option: port [option]``install``

<span style='display:block; white-space:pre;background:#e0ffe0;'>+** A hyperlink: https://en.wikipedia.org/wiki/Spontaneous_combustion[spontaneous combustion].

<span style='display:block; white-space:pre;background:#e0ffe0;'>+** A file: [path]`/var/log/system.log`.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+** A command: [cmd]``ifconfig``.

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+** An option: port `install`

</span><span style='display:block; white-space:pre;color:#808080;'>diff --git a/guide/adoc/macports.conf.adoc b/guide/adoc/macports.conf.adoc

</span><span style='display:block; white-space:pre;color:#808080;'>index d8e9cf0..afd70f6 100644

</span><span style='display:block; white-space:pre;background:#e0e0ff;'>--- a/guide/adoc/macports.conf.adoc

</span><span style='display:block; white-space:pre;background:#e0e0ff;'>+++ b/guide/adoc/macports.conf.adoc

</span><span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1,17 +1,17 @@

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_internals.configuration_files]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[internals.configuration-files]]

</span> = Configuration Files

 The MacPorts configuration files often do not need to be modified for the general end user.

 They contain options that may be of use to advanced users and port developers.

 Some automatically configured options may need to be updated when migrating to a new CPU architecture or a new OS version.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-There are three MacPorts configuration files that define important variables used by the MacPorts system: [path]_macports.conf_, [path]_sources.conf_, and [path]_variants.conf_.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-All MacPorts configurations files are located in [path]_${prefix}/etc/macports_.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+There are three MacPorts configuration files that define important variables used by the MacPorts system: [path]`macports.conf`, [path]`sources.conf`, and [path]`variants.conf`.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+All MacPorts configurations files are located in [path]`${prefix}/etc/macports`.

</span> 

 MacPorts configuration file format is a simple key/value pair separated by either a space or a tab.

 Lines beginning with '#' are comments, empty lines are ignored.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_internals.configuration_files.macports_conf]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[internals.configuration-files.macports-conf]]

</span> == macports.conf

 macports.conf is the configuration file used to bootstrap the MacPorts system.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -22,12 +22,12 @@ Options locating other .conf files.

</span> sources_conf::

 Where to find the sources list.

 +

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Default: [path]_${prefix}/etc/macports/sources.conf_

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+Default: [path]`${prefix}/etc/macports/sources.conf`

</span> 

 variants_conf::

 Where to find global variants definition file (optional).

 +

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Default: [path]_${prefix}/etc/macports/variants.conf_

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+Default: [path]`${prefix}/etc/macports/variants.conf`

</span> 

 Options for MacPorts general operating characteristics.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -35,7 +35,7 @@ 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 because it can break some ports.

 +

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Default: [path]_/opt/local_

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+Default: [path]`/opt/local`

</span> 

 portdbpath::

 Directory where MacPorts keeps working data such as downloaded sources, installed port receipts, and the main registry.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -47,7 +47,7 @@ portdbformat::

Formerly selected the storage type to use for the MacPorts registry: flat or sqlite.

 Currently, only sqlite can be used.

 +

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Default: [option]``sqlite``

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+Default: `sqlite`

</span> 

 build_arch::

 The machine architecture for which to build in normal use.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -55,31 +55,31 @@ Options include: ppc, i386, ppc64, x86_64

</span> +

 Default: 

 +

<span style='display:block; white-space:pre;background:#ffe0e0;'>-(Snow Leopard and later) [option]``x86_64`` or [option]``i386`` depending on hardware

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+(Snow Leopard and later) `x86_64` or `i386` depending on hardware

</span> +

<span style='display:block; white-space:pre;background:#ffe0e0;'>-(Leopard/Tiger) [option]``i386`` or [option]``ppc`` depending on hardware

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+(Leopard/Tiger) `i386` or `ppc` depending on hardware

</span> 

 applications_dir::

 Directory in which ports will install native macOS application bundles.

 +

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Default: [path]_/Applications/MacPorts_

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+Default: [path]`/Applications/MacPorts`

</span> 

 frameworks_dir::

 Directory in which ports will install native macOS frameworks.

 +

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Default: [path]_${prefix}/Library/Frameworks_

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+Default: [path]`${prefix}/Library/Frameworks`

</span> 

 developer_dir::

 Directory where Xcode is installed.

 +

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Default: [path]_/Developer_

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+Default: [path]`/Developer`

</span> 

 buildfromsource::

 Controls whether ports are built from source or downloaded as pre-built archives.

 Setting to 'always' will never use archives, 'never' will always try to use an archive and fail if one is not available.

 'ifneeded' will try to fetch an archive and fall back to building from source if that isn't possible.

 +

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Default: [option]``ifneeded``

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+Default: `ifneeded`

</span> 

 portarchivetype::

 Format of archives in which to store port images.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -87,22 +87,22 @@ This controls both the type of archive created locally after building from sourc

Changing this will not affect the usability of already installed archives; they can be of any supported type.

 Supported types are: tgz, tar, tbz, tbz2, tlz, txz, xar, zip, cpgz, cpio

 +

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Default: [path]_tbz2_

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+Default: [path]`tbz2`

</span> 

 configureccache::

 Use ccache (C/C++ compiler cache) - see https://ccache.samba.org/

 +

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Default: [option]``no``

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+Default: `no`

</span> 

 configuredistcc::

 Use distcc (distributed compiler) - see https://distcc.samba.org/

 +

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Default: [option]``no``

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+Default: `no`

</span> 

 configurepipe::

 Use pipes rather than intermediate files when compiling C/C++/etc

 +

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Default: [option]``yes``

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+Default: `yes`

</span> 

 buildnicevalue::

 Lowered scheduling priority (0-20) to use for make when building ports.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -118,7 +118,7 @@ Default: 0

</span> portautoclean::

 Set whether to automatically execute "`clean`" after "`install`" of ports.

 +

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Default: [option]``yes``

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+Default: `yes`

</span> 

 rsync_server::

 Rsync server from which to fetch MacPorts sources.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -128,7 +128,7 @@ Default: rsync.macports.org

</span> rsync_dir::

 Rsync directory from which to pull the base/ component (infrastructure) of MacPorts.

 +

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Default: [path]_release/tarballs/base.tar_

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+Default: [path]`release/tarballs/base.tar`

</span> 

 rsync_options::

 Rsync options

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -185,7 +185,7 @@ Options for MacPorts Universal Binaries (+universal variant)

</span> universal_archs::

 The machine architectures to use for +universal variant (multiple entries must be space delimited). Options include: ppc, i386, ppc64, x86_64

 +

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Default: [option]``x86_64 i386`` ([option]``ppc

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+Default: `x86_64 i386` (``ppc

</span> i386`` for 10.5 and earlier)

 Options for StartupItems

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -195,14 +195,14 @@ Options for generated startup items, though this may be overridden by the `start

Options are "`default`" option, "`SystemStarter`", "`launchd`", or "`none`".

 For an empty or "`default`" option, a startupitem type appropriate to the platform is used; if "`none`", no port startupitems are installed.

 +

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Default: [option]``default``

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+Default: `default`

</span> 

 startupitem_install::

 Create system-level symlinks to generated StartupItems.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-If set to "`no`", symlinks will not be created; otherwise, symlinks will be placed in [path]_/Library/LaunchDaemons_ or [path]_/Library/LaunchAgents_ as appropriate.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+If set to "`no`", symlinks will not be created; otherwise, symlinks will be placed in [path]`/Library/LaunchDaemons` or [path]`/Library/LaunchAgents` as appropriate.

This setting only applies when building ports from source.

 +

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Default: [option]``yes``

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+Default: `yes`

</span> 

 Other options

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -219,17 +219,17 @@ For example, some developers keep their ports tree synchronized across multiple

</span> +

 Default: yes

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_internals.configuration_files.sources_conf]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[internals.configuration-files.sources-conf]]

</span> == sources.conf

<span style='display:block; white-space:pre;background:#ffe0e0;'>-This file enables rsync synchronization of the default ports tree with the MacPorts rsync server when either of the commands `port

<span style='display:block; white-space:pre;background:#ffe0e0;'>-    selfupdate` or `port sync` are run.

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+This file enables rsync synchronization of the default ports tree with the MacPorts rsync server when either of the commands [cmd]``port

<span style='display:block; white-space:pre;background:#e0ffe0;'>+    selfupdate`` or [cmd]``port sync`` are run.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Default: [path]_rsync://rsync.macports.org/macports/release/tarballs/ports.tar [default]_

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+Default: [path]`rsync://rsync.macports.org/macports/release/tarballs/ports.tar [default]`

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Optional local repositories are enabled using a file url: [replaceable]``file:///path/to/localportsrepository``

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+Optional local repositories are enabled using a file url: `file:///path/to/localportsrepository`

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_internals.configuration_files.variants_conf]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[internals.configuration-files.variants-conf]]

</span> == variants.conf

 This optional file specifies any variants you'd like to be invoked globally.

<span style='display:block; white-space:pre;color:#808080;'>diff --git a/guide/adoc/macros.adoc b/guide/adoc/macros.adoc

</span><span style='display:block; white-space:pre;color:#808080;'>index 054d73c..53120ae 100644

</span><span style='display:block; white-space:pre;background:#e0e0ff;'>--- a/guide/adoc/macros.adoc

</span><span style='display:block; white-space:pre;background:#e0e0ff;'>+++ b/guide/adoc/macros.adoc

</span><span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -4,10 +4,12 @@

</span> :toc: left

 :icons: font

 :experimental:

<span style='display:block; white-space:pre;background:#e0ffe0;'>+:idprefix:

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+:idseparator: -

</span> :sourcedir: .

 [WARNING]

 ====

 This section is outdated and needs to be reworked.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Please see <<_project.docs>> if you can contribute updated instructions. 

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+Please see <<project.docs>> if you can contribute updated instructions. 

</span> ====

\ No newline at end of file

<span style='display:block; white-space:pre;color:#808080;'>diff --git a/guide/adoc/portfile-dependencies.adoc b/guide/adoc/portfile-dependencies.adoc

</span><span style='display:block; white-space:pre;color:#808080;'>index d6dfc22..b9578aa 100644

</span><span style='display:block; white-space:pre;background:#e0e0ff;'>--- a/guide/adoc/portfile-dependencies.adoc

</span><span style='display:block; white-space:pre;background:#e0e0ff;'>+++ b/guide/adoc/portfile-dependencies.adoc

</span><span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1,4 +1,4 @@

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.dependencies]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.dependencies]]

</span> = Dependencies

 Free and open source software is highly modular, and MacPorts ports often require that other ports be installed beforehand; these prerequisites for a given port are called a port's "`dependencies`".

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -9,30 +9,30 @@ For example, you may not uninstall a port that is a library dependency for anoth

Likewise, if you run the fetch target for a port, only the fetch dependencies will be installed first, so they should be all that is needed for that target.

 depends_fetch::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The list of dependencies to check before phases [option]``fetch``, [option]``checksum``, [option]``extract``, [option]``patch``, [option]``configure``, [option]``build``, [option]``destroot``, [option]``install``, and [option]``package``.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+The list of dependencies to check before phases ``fetch``, ``checksum``, ``extract``, ``patch``, ``configure``, ``build``, ``destroot``, ``install``, and ``package``.

Fetch dependencies are needed to download the distfiles for a port, and are not needed at all once the software is installed.

 depends_extract::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The list of dependencies to check before phases [option]``extract``, [option]``patch``, [option]``configure``, [option]``build``, [option]``destroot``, [option]``install``, and [option]``package``.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+The list of dependencies to check before phases ``extract``, ``patch``, ``configure``, ``build``, ``destroot``, ``install``, and ``package``.

Extract dependencies are needed to unpack a port's distfiles into the work directory, and are not needed at all once the software is installed.

 depends_build::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The list of dependencies to check before phases [option]``configure``, [option]``build``, [option]``destroot``, [option]``install``, and [option]``package``.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+The list of dependencies to check before phases ``configure``, ``build``, ``destroot``, ``install``, and ``package``.

Build dependencies are needed when software is being built, but not needed at all once it is installed.

 depends_lib::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The list of dependencies to check before phases [option]``configure``, [option]``build``, [option]``destroot``, [option]``install``, and [option]``package``.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+The list of dependencies to check before phases ``configure``, ``build``, ``destroot``, ``install``, and ``package``.

Library dependencies are needed both at build time (for headers and libraries to link against) and at run time.

 depends_test::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The list of dependencies to check before phase [option]``test``.

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-Test dependencies are only needed when the port enables testing (i.e. [option]``test.run            yes``). 

<span style='display:block; white-space:pre;background:#e0ffe0;'>+The list of dependencies to check before phase ``test``.

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+Test dependencies are only needed when the port enables testing (i.e. ``test.run            yes``). 

</span> 

 depends_run::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The list of dependencies to check before phases [option]``destroot``, [option]``install``, and [option]``package``.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+The list of dependencies to check before phases ``destroot``, ``install``, and ``package``.

Run dependencies are needed when the software is run, but not to compile it.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.dependencies.types]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.dependencies.types]]

</span> == Port and File Dependencies

 There are two types of dependencies: port dependencies and file dependencies.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -53,17 +53,17 @@ depends_run         port:apache2 port:php5

</span> ----

 File dependencies should only be used if one of the reasons listed above applies.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-There are three types: [option]``bin`` for programs, [option]``lib`` for libraries, and [option]``path`` for any installed file.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-File dependencies are specified in the form: [replaceable]``<type>``:[replaceable]``<filespec>``:[replaceable]``<port>``.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+There are three types: `bin` for programs, `lib` for libraries, and `path` for any installed file.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+File dependencies are specified in the form: ``<type>``:``<filespec>``:``<port>``.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-For [option]``bin`` dependencies, [replaceable]``<filespec>`` is the name of a program in a bin directory like [path]_${prefix}/bin_, /usr/bin, /bin, and the associated sbin directories.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+For `bin` dependencies, `<filespec>` is the name of a program in a bin directory like [path]`${prefix}/bin`, /usr/bin, /bin, and the associated sbin directories.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-For [option]``lib`` dependencies, [replaceable]``<filespec>`` is the name of a library (but without its extension) in a lib directory like [path]_${prefix}/lib_, /usr/lib, /lib, some Framework directories, and those found in environment variables like DYLD_LIBRARY_PATH.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+For `lib` dependencies, `<filespec>` is the name of a library (but without its extension) in a lib directory like [path]`${prefix}/lib`, /usr/lib, /lib, some Framework directories, and those found in environment variables like DYLD_LIBRARY_PATH.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-For [option]``path`` dependencies, [replaceable]``<filespec>`` is the complete absolute path to the file, or more usually, when the file is inside [path]_${prefix}_, it is specified relative to [path]_${prefix}_.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Since [option]``path`` dependencies are the only ones which would find files only in an absolute path or a path inside [path]_${prefix}_ they are - in cases when a port needs to be more restrictive - often used instead of [option]``bin`` and [option]``lib`` dependencies .

<span style='display:block; white-space:pre;background:#e0ffe0;'>+For `path` dependencies, `<filespec>` is the complete absolute path to the file, or more usually, when the file is inside [path]`${prefix}`, it is specified relative to [path]`${prefix}`.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Since `path` dependencies are the only ones which would find files only in an absolute path or a path inside [path]`${prefix}` they are - in cases when a port needs to be more restrictive - often used instead of `bin` and `lib` dependencies .

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Note that the [replaceable]``<port>`` specified is only installed if the specified library, binary, or file is not found.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Note that the `<port>` specified is only installed if the specified library, binary, or file is not found.

</span> See the examples below:

 [source]

<span style='display:block; white-space:pre;color:#808080;'>diff --git a/guide/adoc/portfile-keywords.adoc b/guide/adoc/portfile-keywords.adoc

</span><span style='display:block; white-space:pre;color:#808080;'>index 81daf1a..788a15a 100644

</span><span style='display:block; white-space:pre;background:#e0e0ff;'>--- a/guide/adoc/portfile-keywords.adoc

</span><span style='display:block; white-space:pre;background:#e0e0ff;'>+++ b/guide/adoc/portfile-keywords.adoc

</span><span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1,4 +1,4 @@

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.keywords]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.keywords]]

</span> = Global Keywords

 MacPorts keywords are used to specify required or optional items within a Portfile, or to override default options used by MacPorts base for individual ports.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -86,18 +86,10 @@ GitHub usernames start with an `@` symbol.

</span> Email addresses are preferably listed in the obfuscated form below to hide them from spambots:

 * For addresses in domain @macports.org, simply omit the domain name.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* For addresses in other domains, e.g., 

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-+

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-// <email>account@example.org</email>

<span style='display:block; white-space:pre;background:#ffe0e0;'>-, use the convention `example.org:account` to specify the address.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+* For addresses in other domains, e.g., mailto:account@example.org[], use the convention `example.org:account` to specify the address.

</span> 

 +

<span style='display:block; white-space:pre;background:#ffe0e0;'>-In the example below, the port is maintained by a GitHub user named neverpanic, and the owners of the two email addresses 

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-+

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-// <email>jdoe@macports.org</email>

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- and 

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-// <email>julesverne@example.org</email>

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+In the example below, the port is maintained by a GitHub user named neverpanic, and the owners of the two email addresses mailto:jdoe@macports.org[] and mailto:julesverne@example.org[]

</span> +

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -109,10 +101,7 @@ maintainers         @neverpanic \

</span> ----

 +

 Braces can be used to express that these refer to the same person, for example the GitHub username and an email.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-In the following example, the port is maintained by a GitHub user named jverne, that can also be contacted directly at 

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-+

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-// <email>julesverne@example.org</email>

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-$$.$$

<span style='display:block; white-space:pre;background:#e0ffe0;'>+In the following example, the port is maintained by a GitHub user named jverne, that can also be contacted directly at mailto:julesverne@example.org[].

</span> +

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -164,7 +153,7 @@ A list of the platforms on which the port has been tested.

Required, but not interpreted in any way by the software at this time; it is purely informational for users.

 Possible values: `darwin` (= `macosx` or ``puredarwin``), ``macosx``, ``puredarwin``, ``freebsd``, ``linux``, ``sunos``, ``netbsd``.

 In general, it can just be set to ``darwin``.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-(``puredarwin`` is an OS based on Apple's open-source Darwin releases without any of Apple's proprietary bits.) See also [var]``os.platform``. 

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+(``puredarwin`` is an OS based on Apple's open-source Darwin releases without any of Apple's proprietary bits.) See also ``os.platform``. 

</span> +

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -176,7 +165,7 @@ supported_archs::

The CPU architectures for which this port can be built.

 Archs currently supported by macOS are: i386, ppc, ppc64, x86_64.

 If this option is not set, it is assumed that the port can build for all archs.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-If a port does not install any architecture-specific files, use the special value [option]``noarch``.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+If a port does not install any architecture-specific files, use the special value ``noarch``.

</span> +

 If the building architecture isn't among supported_archs, port fails with an error message, except when building on x86_64 and supported_archs contains i386 or when building on ppc64 and supported_archs contains ppc, in which case the port will be built in 32-bit mode.

 +

<span style='display:block; white-space:pre;color:#808080;'>diff --git a/guide/adoc/portfile-livecheck.adoc b/guide/adoc/portfile-livecheck.adoc

</span><span style='display:block; white-space:pre;color:#808080;'>index af4e2c7..61d12f3 100644

</span><span style='display:block; white-space:pre;background:#e0e0ff;'>--- a/guide/adoc/portfile-livecheck.adoc

</span><span style='display:block; white-space:pre;background:#e0e0ff;'>+++ b/guide/adoc/portfile-livecheck.adoc

</span><span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1,4 +1,4 @@

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.livecheck]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.livecheck]]

</span> = Livecheck / Distcheck

 Options livecheck and distcheck are especially useful for port maintainers, but others may also find this information valuable.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -8,13 +8,13 @@ Livecheck checks to see if MacPorts can query the developer's download site to d

</span> livecheck.type::

 Specify what kind of update check to perform.

 +

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Open source mirror site options are to use the project's latest file release from [option]``sourceforge`` or the project's `date_updated` XML tag for [option]``freecode``.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-These options are automatically used if a matching [var]``${master_sites}`` URL is used.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Open source mirror site options are to use the project's latest file release from `sourceforge` or the project's `date_updated` XML tag for ``freecode``.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+These options are automatically used if a matching `${master_sites}` URL is used.

</span> +

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Generic download site options are to specify a [option]``moddate`` (modification date of a URL resource), a [option]``regex`` (retrieve the version by applying a regex to a URL resource), [option]``regexm`` (retrieve the version by applying a multi-line regex to a URL resource), [option]``md5`` (compares the md5 sum of a URL resource) or [option]``none`` (no check).

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Generic download site options are to specify a `moddate` (modification date of a URL resource), a `regex` (retrieve the version by applying a regex to a URL resource), `regexm` (retrieve the version by applying a multi-line regex to a URL resource), `md5` (compares the md5 sum of a URL resource) or `none` (no check).

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* Default: [option]``sourceforge`` or [option]``googlecode`` if the [var]``${master_sites}`` is one of these, else [option]``freecode``.

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-* Values: [option]``freecode``[option]``sourceforge``[option]``googlecode``[option]``moddate``[option]``regex``[option]``regexm``[option]``md5``[option]``none``

<span style='display:block; white-space:pre;background:#e0ffe0;'>+* Default: `sourceforge` or `googlecode` if the `${master_sites}` is one of these, else ``freecode``.

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* Values: `freecode```sourceforge````googlecode````moddate````regex````regexm````md5````none``

</span> * Examples:

 +

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -29,7 +29,7 @@ livecheck.name::

Name of the project for live checks.

 Is only used with freecode, sourceforge

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* Default: [var]``${name}`` or the sourceforge, freecode project name if it can be guessed from [var]``${master_sites}``.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+* Default: `${name}` or the sourceforge, freecode project name if it can be guessed from ``${master_sites}``.

</span> * Example:

 +

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -43,7 +43,7 @@ Name of the file release for sourceforge checks.

Use the name of the package release.

 You may use this keyword without `livecheck.version` if you replace the version part of the name with "``(.*)``".

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* Default: sourceforge: [var]``${livecheck.name}``

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* Default: sourceforge: `${livecheck.name}`

</span> * Example:

 +

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -55,7 +55,7 @@ livecheck.distname  faad2.src

</span> livecheck.version::

 Version of the project for a check; used for regex-based checks.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* Default: [var]``${version}``

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* Default: `${version}`

</span> * Example:

 +

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -68,7 +68,7 @@ livecheck.url::

URL to query for a check.

 * Default:

<span style='display:block; white-space:pre;background:#ffe0e0;'>-** [var]``${homepage}`` or the first hit among the following sites:

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+** `${homepage}` or the first hit among the following sites:

</span> ** `http://freecode.com/projects-xml/${livecheck.name}/${livecheck.name}.xml`

 ** `https://sourceforge.net/api/file/index/project-name/${livecheck.name}/rss`

 ** `https://code.google.com/p/${livecheck.name}/downloads/list`

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -111,9 +111,9 @@ Examples are given below.

</span> 

 distcheck.check::

 This option can be used to disable distcheck.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-It specifies what kind of check should be performed on distfiles: [option]``moddate`` (check if the Portfile is older than the distfile) or [option]``none`` (no check).

<span style='display:block; white-space:pre;background:#e0ffe0;'>+It specifies what kind of check should be performed on distfiles: `moddate` (check if the Portfile is older than the distfile) or `none` (no check).

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* Default: [option]``moddate``

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* Default: `moddate`

</span> * Example:

 +

<span style='display:block; white-space:pre;color:#808080;'>diff --git a/guide/adoc/portfile-phase.adoc b/guide/adoc/portfile-phase.adoc

</span><span style='display:block; white-space:pre;color:#808080;'>index e73ef3a..e1eef5f 100644

</span><span style='display:block; white-space:pre;background:#e0e0ff;'>--- a/guide/adoc/portfile-phase.adoc

</span><span style='display:block; white-space:pre;background:#e0e0ff;'>+++ b/guide/adoc/portfile-phase.adoc

</span><span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1,67 +1,66 @@

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.phases]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.phases]]

</span> = Port Phases

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.phases.introduction]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.phases.introduction]]

</span> == Introduction

 The MacPorts port installation process has a number of distinct phases that are described in detail in this section.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The default scripts coded into MacPorts base performs the standard ``configure``, ``make``, and `make

<span style='display:block; white-space:pre;background:#ffe0e0;'>-    install` steps.

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-For applications that do not conform to this standard, installation phases may be declared in a Portfile to <<_development.examples.augment,augment>> or <<_development.examples.override,override>> the default behavior as described in the <<_development,Portfile

<span style='display:block; white-space:pre;background:#ffe0e0;'>-    Development>> chapter.

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+The default scripts coded into MacPorts base performs the standard [cmd]``configure``, [cmd]``make``, and [cmd]``make

<span style='display:block; white-space:pre;background:#e0ffe0;'>+    install`` steps.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+For applications that do not conform to this standard, installation phases may be declared in a Portfile to <<development.examples.augment,augment>> or <<development.examples.override,override>> the default behavior as described in the <<development,Portfile Development>> chapter.

</span> 

 fetch::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Fetch the [var]``${distfiles}`` from [var]``${master_sites}`` and place it in [path]_${prefix}/var/macports/distfiles/${name}_.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Fetch the `${distfiles}` from `${master_sites}` and place it in [path]`${prefix}/var/macports/distfiles/${name}`.

</span> 

 checksum::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Compare [var]``${checksums}`` specified in a [path]_Portfile_ to the checksums of the fetched ${distfiles}.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Compare `${checksums}` specified in a [path]`Portfile` to the checksums of the fetched ${distfiles}.

</span> 

 extract::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Unzip and untar the [var]``${distfiles}`` into the path ${prefix}/var/macports/build/..../work

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+Unzip and untar the `${distfiles}` into the path ${prefix}/var/macports/build/..../work

</span> 

 patch::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Apply optional link:patch files specified in [var]``${patchfiles}`` to modify a port's source code file(s).

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Apply optional https://en.wikipedia.org/wiki/Patch_(Unix)[patch] files specified in `${patchfiles}` to modify a port's source code file(s).

</span> 

 configure::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Execute [var]``${configure.cmd}`` in [var]``${worksrcpath}``.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Execute `${configure.cmd}` in ``${worksrcpath}``.

</span> 

 build::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Execute [var]``${build.cmd}`` in [var]``${worksrcpath}``.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Execute `${build.cmd}` in ``${worksrcpath}``.

</span> 

 test::

 Execute commands to run test suites bundled with a port, available only for a fraction of ports.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-This is an optional phase, run only if `port test` is executed, and always works with a build from source, not a binary.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+This is an optional phase, run only if [cmd]``port test`` is executed, and always works with a build from source, not a binary.

A failure is only for the user's information, and does not block a subsequent installation from the build.

 destroot::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Execute the command `make install`[var]``DESTDIR=${destroot}``in [var]``${worksrcpath}``.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Execute the command [cmd]``make install````DESTDIR=${destroot}``in ``${worksrcpath}``.

</span> +

 [NOTE]

 ====

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Using a link:DESTDIR

<span style='display:block; white-space:pre;background:#ffe0e0;'>-            variable is a part of standard GNU coding practices, and this variable must be supported in an application's install routines for MacPorts' destroot phase to work without manual Portfile scripting or source patching.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Urge developers to fully support [var]``DESTDIR`` in their applications.

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+Using a https://www.gnu.org/prep/standards/html_node/DESTDIR.html[DESTDIR

<span style='display:block; white-space:pre;background:#e0ffe0;'>+            variable] is a part of standard GNU coding practices, and this variable must be supported in an application's install routines for MacPorts' destroot phase to work without manual Portfile scripting or source patching.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Urge developers to fully support `DESTDIR` in their applications.

</span> ====

 +

 Understanding the destroot phase is critical to understanding MacPorts, because, unlike some package management systems, MacPorts "`stages`" an installation into an intermediate location, not the final file destination.

 MacPorts uses the destroot phase to provide:

 * Port uninstalls - a port's files may be cleanly uninstalled because all files and directories are recorded during install.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* Multiple port versions may be installed on the same host, since a port's files are not directly inserted into [var]``${prefix}`` but rather hard-linked into [var]``${prefix}`` from an intermediate location during a later activation phase.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+* Multiple port versions may be installed on the same host, since a port's files are not directly inserted into `${prefix}` but rather hard-linked into `${prefix}` from an intermediate location during a later activation phase.

</span> 

 +

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Any empty directories in [var]``${destroot}`` upon completion of the destroot phase are removed unless a directory name is placed in the value field of the optional `destroot.keepdirs` keyword.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Any empty directories in `${destroot}` upon completion of the destroot phase are removed unless a directory name is placed in the value field of the optional `destroot.keepdirs` keyword.

</span> 

 install::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Archive a port's destrooted files into [path]_${prefix}/var/macports/software_.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-See <<_internals.images,Port Images>> in the <<_internals,MacPorts Internals>> chapter for details.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Archive a port's destrooted files into [path]`${prefix}/var/macports/software`.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+See <<internals.images,Port Images>> in the <<internals,MacPorts Internals>> chapter for details.

</span> 

 activate::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Extract the port's files from the archive in [path]_${prefix}/var/macports/software_ to their final installed locations, usually inside [var]``${prefix}``.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Extract the port's files from the archive in [path]`${prefix}/var/macports/software` to their final installed locations, usually inside ``${prefix}``.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.phases.installation]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.phases.installation]]

</span> == Installation Phase Keywords

 MacPorts keywords are used to specify required or optional items within a Portfile, or to override default options used by MacPorts base for individual ports.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -69,7 +68,7 @@ Keywords are to be used within the "`global`" and "`variant`" sections of Portfi

</span> 

 In other words, port phase keywords are not located within port phase declarations, but rather they _refer_ to port phases and set options for those phases, and they take effect whether or not phase declarations have been explicitly defined in a Portfile.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.phases.installation.list_modifiers]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.phases.installation.list-modifiers]]

</span> === Keyword List Modifiers (-append, -delete, -replace, -strsed)

 Keyword list modifiers are keywords that end in -append, -delete or -replace.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -77,7 +76,7 @@ Keywords that support list modifiers are identified under appropriate reference

</span> 

 -append adds a value to the keyword, -delete removes a previously added item.

 -replace takes two arguments and replaces the first value from the keyword with the second value.

<span style='display:block; white-space:pre;background:#ffe0e0;'>--strsed treats the keyword value as a string and filters it through <<_reference.tcl_extensions.strsed,strsed>> using the given pattern.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+-strsed treats the keyword value as a string and filters it through <<reference.tcl-extensions.strsed,strsed>> using the given pattern.

There is also a deprecated syntax for -replace which takes only one argument and behaves the same as -strsed.

 Keyword list modifiers are most frequently used for these three purposes:

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -101,32 +100,32 @@ Use the appropriate keywords, for example:

</span> ** `patchfiles-append` or `patchfiles-delete` or `patchfiles-replace`

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.phases.installation.argument_modifiers]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.phases.installation.argument-modifiers]]

</span> === Keyword Argument Modifiers (.pre_args / .post_args)

 Keywords that support pre_args and post_args are used to assemble command strings together in a row, as described in the reference sections below.

 But it should be noted that all keyword argument modifiers implicitly support keyword list modifiers.

 For example, the keyword `configure.pre_args` also supports `configure.pre_args-append` and ``configure.pre_args-delete``.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.phases.fetch]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.phases.fetch]]

</span> == Fetch Phase Keywords

 The list of keywords related to the fetch phase.

 master_sites::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-A list of URLs from which a port's [var]``${distfiles}`` may be retrieved.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+A list of URLs from which a port's `${distfiles}` may be retrieved.

</span> +

 Keyword values for `master_sites` may include predefined site lists known as "`mirrors`", such as sourceforge, gnu, etc.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The file(s) declared in [var]``${distfiles}`` will be fetched from one of the locations defined in ``master_sites``, while trying to find the best reachable mirror for the user's connection.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+The file(s) declared in `${distfiles}` will be fetched from one of the locations defined in ``master_sites``, while trying to find the best reachable mirror for the user's connection.

</span> +

<span style='display:block; white-space:pre;background:#ffe0e0;'>-For a complete list of mirrors and their list of sites, see the file [path]_mirror_sites.tcl_ located in [path]__resources/port1.0/fetch/_ in the ports tree.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+For a complete list of mirrors and their list of sites, see the file [path]`mirror_sites.tcl` located in [path]`_resources/port1.0/fetch/` in the ports tree.

</span> +

 [NOTE]

 ====

 If a `master_sites` keyword has multiple values, after any mirrors are expanded the list of sites is sorted by ping response times.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The sites are then tried in sorted order until matching [var]``${distfiles}`` are found.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+The sites are then tried in sorted order until matching `${distfiles}` are found.

</span> ====

 * Default: `none` (but the `macports_distfiles` mirror is always implicitly appended)

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -148,7 +147,7 @@ Here the sourceforge, gnu, and freebsd mirrors are used.

</span> master_sites        sourceforge gnu freebsd

 ----

 +

<span style='display:block; white-space:pre;background:#ffe0e0;'>-When using mirror master_sites, the subdirectory [var]``${name}`` is checked on every mirror.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+When using mirror master_sites, the subdirectory `${name}` is checked on every mirror.

If the mirror subdirectory does not match ${name}, then you may specify it using after the mirror separated by a colon.

 +

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -161,7 +160,7 @@ master_sites        sourceforge:widget \

For ports that must fetch multiple download files from different locations, you must label the files with tags and match the tags to a `distfiles` keyword.

 The format is ``mirror:subdirectory:tag``.

 +

<span style='display:block; white-space:pre;background:#ffe0e0;'>-In the example below, file_one.tar.gz is fetched from sourceforge mirrors in subdirectory [var]``${name}``; file tagtwo.tar.gz is fetched from the gnu mirrors in subdirectory sources.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+In the example below, file_one.tar.gz is fetched from sourceforge mirrors in subdirectory ``${name}``; file tagtwo.tar.gz is fetched from the gnu mirrors in subdirectory sources.

</span> +

 [source]

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -174,9 +173,9 @@ distfiles           file_one.tar.gz:tagone \

</span> ----

 master_sites.mirror_subdir::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Subdirectory to append to all mirror sites for any list specified in [var]``${master_sites}``.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Subdirectory to append to all mirror sites for any list specified in ``${master_sites}``.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* Default: [var]``${name}``

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* Default: `${name}`

</span> * Example:

 +

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -188,7 +187,7 @@ master_sites.mirror_subdir  magic

</span> patch_sites::

 A list of sites from which a port's patchfiles may be downloaded, where applicable.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* Default: [var]``${master_sites}``

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* Default: `${master_sites}`

</span> * Example:

 +

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -198,9 +197,9 @@ patch_sites         ftp://ftp.patchcityrepo.com/pub/magic/patches

</span> ----

 patch_sites.mirror_subdir::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Subdirectory to append to all mirror sites for any list specified in [var]``${patch_sites}``.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Subdirectory to append to all mirror sites for any list specified in ``${patch_sites}``.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* Default: [var]``${name}``

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* Default: `${name}`

</span> * Example:

 +

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -212,7 +211,7 @@ patch_sites.mirror_subdir   magic

</span> distname::

 The name of the distribution filename, not including the extract suffix (see below).

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* Default: [var]``${name}-${version}``

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* Default: `${name}-${version}`

</span> * Example:

 +

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -225,7 +224,7 @@ distfiles::

The full distribution filename, including the extract suffix.

 Used to specify non-default distribution filenames; this keyword must be specified (and tags used) when a port has multiple download files (see master_sites).

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* Default: [var]``${distname}${extract.suffix}``

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* Default: `${distname}${extract.suffix}`

</span> * Examples:

 +

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -242,11 +241,11 @@ distfiles           file_one.tar.gz:tagone \

</span> ----

 dist_subdir::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The last path component of [var]``${distpath}``.

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-Override it to store multiple ports' distfiles in the same directory (such as multiple ports providing different versions of the same software), or if a link:stealth

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-update has occurred. 

<span style='display:block; white-space:pre;background:#e0ffe0;'>+The last path component of ``${distpath}``.

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+Override it to store multiple ports' distfiles in the same directory (such as multiple ports providing different versions of the same software), or if a https://trac.macports.org/wiki/PortfileRecipes#stealth-updates[stealth

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+update] has occurred. 

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* Default: [var]``${name}``

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* Default: `${name}`

</span> * Examples:

 +

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -266,7 +265,7 @@ Sets the path to source directory relative to workpath.

It can be used if the extracted source directory has a different name then the distfile.

 Also used if the source to be built is in a subdirectory.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* Default: [var]``${distname}``

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* Default: `${distname}`

</span> * Examples:

 +

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -281,17 +280,17 @@ worksrcdir          ${name}-src-${version}

</span> worksrcdir          ${distname}/src

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.phases.fetch.advanced]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.phases.fetch.advanced]]

</span> === Advanced Fetch Options

 Some mirrors require special options for a resource to be properly fetched.

 fetch.type::

 Change the fetch type.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-This is only necessary if a <<_reference.phases.fetch.bzr,bzr>>, <<_reference.phases.fetch.cvs,cvs>>, <<_reference.phases.fetch.git,git>>, <<_reference.phases.fetch.hg,hg>>, or <<_reference.phases.fetch.svn,svn>> checkout is being used. [option]``standard`` is used for a normal http or ftp fetch using [var]``${distfiles}`` and is used as default.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+This is only necessary if a <<reference.phases.fetch.bzr,bzr>>, <<reference.phases.fetch.cvs,cvs>>, <<reference.phases.fetch.git,git>>, <<reference.phases.fetch.hg,hg>>, or <<reference.phases.fetch.svn,svn>> checkout is being used. `standard` is used for a normal http or ftp fetch using `${distfiles}` and is used as default.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* Default: [option]``standard``

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-* Values: [option]``standard``[option]``bzr``[option]``cvs``[option]``git``[option]``hg``[option]``svn``

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* Default: `standard`

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* Values: `standard```bzr````cvs````git````hg````svn``

</span> * Example:

 +

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -329,7 +328,7 @@ TODO: add example

</span> fetch.use_epsv::

 Whether to use EPSV command for FTP transfers.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* Default: [option]``yes``

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* Default: `yes`

</span> * Example:

 +

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -341,7 +340,7 @@ fetch.use_epsv      no

</span> fetch.ignore_sslcert::

 Whether to ignore the host SSL certificate (for HTTPS).

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* Default: [option]``no``

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* Default: `no`

</span> * Example:

 +

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -350,13 +349,13 @@ Whether to ignore the host SSL certificate (for HTTPS).

</span> fetch.ignore_sslcert    yes

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.phases.fetch.bzr]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.phases.fetch.bzr]]

</span> === Fetch from BZR

<span style='display:block; white-space:pre;background:#ffe0e0;'>-link:Bzr may be used as an alternative method of fetching distribution files using the keywords in this section.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+https://bazaar.canonical.com/en/[Bzr] may be used as an alternative method of fetching distribution files using the keywords in this section.

However, fetching via bzr may cause non-reproducible builds, so it is strongly discouraged.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The [option]``bzr``<<_reference.phases.fetch.advanced.fetch_type,fetch.type>> is used to fetch source code from a bzr repository.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+The `bzr`<<reference.phases.fetch.advanced.fetch-type,fetch.type>> is used to fetch source code from a bzr repository.

</span> 

 bzr.url::

 This specifies the url from which to fetch files.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -388,13 +387,13 @@ Optional tag for fetching with bzr, this specifies the revision to checkout

</span> bzr.revision          2209

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.phases.fetch.cvs]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.phases.fetch.cvs]]

</span> === Fetch from CVS

<span style='display:block; white-space:pre;background:#ffe0e0;'>-link:CVS may be used as an alternative method of fetching distribution files using the keywords in this section.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+http://www.nongnu.org/cvs/[CVS] may be used as an alternative method of fetching distribution files using the keywords in this section.

However, fetching via CVS may cause non-reproducible builds, so it is strongly discouraged.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The [option]``cvs``<<_reference.phases.fetch.advanced.fetch_type,fetch.type>> is used to fetch source code from a CVS repository.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+The `cvs`<<reference.phases.fetch.advanced.fetch-type,fetch.type>> is used to fetch source code from a CVS repository.

</span> 

 cvs.root::

 Specify the url from which to fetch files.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -456,13 +455,13 @@ A CVS module from which to check out the code.

</span> cvs.module          Sources

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.phases.fetch.git]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.phases.fetch.git]]

</span> === Fetch from Git

<span style='display:block; white-space:pre;background:#ffe0e0;'>-link:Git may be used as an alternative method of fetching distribution files using the keywords in this section.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+https://git-scm.com/[Git] may be used as an alternative method of fetching distribution files using the keywords in this section.

However, fetching via Git may cause non-reproducible builds, so it is strongly discouraged.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The [option]``git``<<_reference.phases.fetch.advanced.fetch_type,fetch.type>> is used to fetch source code from a git repository.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+The `git`<<reference.phases.fetch.advanced.fetch-type,fetch.type>> is used to fetch source code from a git repository.

</span> 

 git.url::

 This specifies the url from which to fetch files.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -501,13 +500,13 @@ git.branch             72bf1c8

</span> git.branch             origin/next

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.phases.fetch.hg]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.phases.fetch.hg]]

</span> === Fetch from Mercurial

<span style='display:block; white-space:pre;background:#ffe0e0;'>-link:Mercurial may be used as an alternative method of fetching distribution files using the keywords in this section.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+https://mercurial.selenic.com/[Mercurial] may be used as an alternative method of fetching distribution files using the keywords in this section.

However, fetching via Mercurial may cause non-reproducible builds, so it is strongly discouraged.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The [option]``hg``<<_reference.phases.fetch.advanced.fetch_type,fetch.type>> is used to fetch source code from a Mercurial repository.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+The `hg`<<reference.phases.fetch.advanced.fetch-type,fetch.type>> is used to fetch source code from a Mercurial repository.

</span> 

 hg.url::

 This specifies the url from which to fetch files.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -547,13 +546,13 @@ hg.tag              v1.3

</span> hg.tag              ceb884843737

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.phases.fetch.svn]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.phases.fetch.svn]]

</span> === Fetch from Subversion

<span style='display:block; white-space:pre;background:#ffe0e0;'>-link:Subversion may be used as an alternative method of fetching distribution files using the keywords in this section.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+https://subversion.apache.org/[Subversion] may be used as an alternative method of fetching distribution files using the keywords in this section.

However, fetching via Subversion may cause non-reproducible builds, so it is strongly discouraged.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The [option]``svn``<<_reference.phases.fetch.advanced.fetch_type,fetch.type>> is used to fetch source code from an svn repository.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+The `svn`<<reference.phases.fetch.advanced.fetch-type,fetch.type>> is used to fetch source code from an svn repository.

</span> 

 svn.url::

 This specifies the url from which to fetch files.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -598,7 +597,7 @@ An export is preferable because it takes half the disk space, but some software

</span> svn.method          checkout

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.phases.checksum]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.phases.checksum]]

</span> == Checksum Phase Keywords

 The list of keywords related to the checksum phase.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -630,7 +629,7 @@ checksums           ${distname}${extract.suffix} \

</span>                         sha256  2c3afd16915e9f8eac2351673f8b599f5fd2ff9064d4dfe61f750d72bab740b3

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.phases.extract]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.phases.extract]]

</span> == Extract Phase Keywords

 The list of keywords related to the extract phase.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -638,7 +637,7 @@ The list of keywords related to the extract phase.

</span> extract.asroot::

 This keyword is used to specify that the extract phase should be done as the root user.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* Default: [option]``no``

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* Default: `no`

</span> * Example:

 +

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -650,7 +649,7 @@ extract.asroot      no

</span> extract.suffix::

 This keyword is used to specify the extract suffix type.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* Default: [path]_.tar.gz_

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* Default: [path]`.tar.gz`

</span> * Example:

 +

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -666,7 +665,7 @@ When invoked, it automatically sets:

</span>   extract.suffix = .7z

   extract.cmd    = 7za

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* Default: [option]``no``

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* Default: `no`

</span> * Example:

 +

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -682,7 +681,7 @@ When invoked, it automatically sets:

</span>   extract.suffix = .tar.bz2

   extract.cmd    = bzip

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* Default: [option]``no``

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* Default: `no`

</span> * Example:

 +

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -698,7 +697,7 @@ When invoked, it automatically sets:

</span>   extract.suffix    = .lzma

   extract.cmd       = lzma

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* Default: [option]``no``

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* Default: `no`

</span> * Example:

 +

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -716,7 +715,7 @@ When invoked, it automatically sets:

</span>   extract.pre_args  = -q

   extract.post_args = "-d ${extract.dir}"

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* Default: [option]``no``

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* Default: `no`

</span> * Example:

 +

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -732,7 +731,7 @@ When invoked, it automatically sets:

</span>   extract.suffix    = .tar.xz

   extract.cmd       = xz

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* Default: [option]``no``

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* Default: `no`

</span> * Example:

 +

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -742,10 +741,10 @@ use_xz             yes

</span> ----

 extract.mkdir::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-This keyword is used to specify if the directory [path]_worksrcdir_ is part of the distfile or if it should be created automatically and the distfiles should be extracted there instead.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-This is useful for distfiles with a flat structure which would pollute the [path]_worksrcdir_ with lots of files.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+This keyword is used to specify if the directory [path]`worksrcdir` is part of the distfile or if it should be created automatically and the distfiles should be extracted there instead.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+This is useful for distfiles with a flat structure which would pollute the [path]`worksrcdir` with lots of files.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* Default: [option]``no``

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* Default: `no`

</span> * Example:

 +

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -755,10 +754,10 @@ extract.mkdir       yes

</span> ----

 extract.only::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-List of files to extract into [var]``${worksrcpath}``.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+List of files to extract into ``${worksrcpath}``.

Only use if default extract behavior is not correct for your port.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* Default: [var]``${distfiles}``

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* Default: `${distfiles}`

</span> * Example:

 +

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -777,7 +776,7 @@ extract.only-delete     foo.tar.gz

</span> extract.cmd::

 Command to perform extraction.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* Default: `gzip`

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* Default: [cmd]``gzip``

</span> * Example:

 +

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -787,9 +786,9 @@ extract.cmd         gunzip

</span> ----

 extract.args::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Main arguments to [var]``extract.cmd``; additional arguments passed before and after the main arguments.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Main arguments to ``extract.cmd``; additional arguments passed before and after the main arguments.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* Default: [var]``${distpath}/${distfile}``

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* Default: `${distpath}/${distfile}`

</span> * Example:

 +

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -812,7 +811,7 @@ extract.pre_args    xf

</span> extract.post_args   "| gnutar -x"

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.phases.patch]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.phases.patch]]

</span> == Patch Phase Keywords

 The list of keywords related to the patch phase.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -820,7 +819,7 @@ The list of keywords related to the patch phase.

</span> patch.dir::

 Specify the base path for patch files.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* Default: [var]``${worksrcpath}``

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* Default: `${worksrcpath}`

</span> * Example:

 +

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -832,7 +831,7 @@ patch.dir           ${worksrcpath}/util

</span> patch.cmd::

 Specify the command to be used for patching files.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* Default: `patch`

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* Default: [cmd]``patch``

</span> * Example:

 +

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -862,7 +861,7 @@ patchfiles-delete   patch-destdir-variable-fix.diff

</span> ----

 patch.args::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Main arguments to [var]``patch.cmd``; optional argument modifiers pass arguments before and after the main arguments.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Main arguments to ``patch.cmd``; optional argument modifiers pass arguments before and after the main arguments.

</span> 

 * Default: none

 * Example:

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -887,7 +886,7 @@ patch.pre_args      -p1

</span> patch.post_args     ???

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.phases.configure]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.phases.configure]]

</span> == Configure Phase Keywords

 The list of keywords related to the configure phase.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -897,9 +896,9 @@ For example, MacPorts base sets default `configure.cflags` so you should always

</span> 

 use_configure::

 Sets if the configure phase should be run.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Can be used if the port has no [path]_./configure_ script.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Can be used if the port has no [path]`./configure` script.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* Default: [option]``yes``

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* Default: `yes`

</span> * Example:

 +

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -922,7 +921,7 @@ configure.cmd       ./config.sh

</span> 

 configure.env::

 Set environment variables for configure; list modifiers add and delete items from a previous Portfile configure.env keyword, or a default set by MacPorts base.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-If available, it is encouraged to use the predefined options (like <<_reference.phases.configure.cflags,configure.cflags>>) instead of modifying configure.env directly.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+If available, it is encouraged to use the predefined options (like <<reference.phases.configure.cflags,configure.cflags>>) instead of modifying configure.env directly.

</span> 

 * Default: `CFLAGS=-I${prefix}/include LDFLAGS=-L${prefix}/lib`

 * Example:

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1200,15 +1199,15 @@ configure.compiler::

Select a compiler suite to fill the compiler environment variables.

 All variables/tools a compiler suite can provide are set.

 Manually set variables are not overwritten.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Keep in mind that not all compiler suites might be available on your platform: [option]``gcc-3.3`` is available on Mac OS X 10.3 and 10.4 PowerPC, [option]``gcc-4.0`` is available on 10.4 and 10.5, [option]``gcc-4.2`` and [option]``llvm-gcc-4.2`` are available on 10.5 and 10.6, and [option]``clang`` is available on 10.6 and later.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Keep in mind that not all compiler suites might be available on your platform: `gcc-3.3` is available on Mac OS X 10.3 and 10.4 PowerPC, `gcc-4.0` is available on 10.4 and 10.5, `gcc-4.2` and `llvm-gcc-4.2` are available on 10.5 and 10.6, and `clang` is available on 10.6 and later.

</span> +

 Only use it if a port really needs a different compiler.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* Default: [option]``apple-gcc-4.2`` on Mac OS X 10.4

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-* Default: [option]``gcc-4.2`` with Xcode 3.x on Mac OS X 10.5 and 10.6

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-* Default: [option]``llvm-gcc-4.2`` with Xcode 4.0 through 4.2 on Mac OS X 10.6 and 10.7

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-* Default: [option]``clang`` with Xcode 4.3 and later on OS X 10.7 and later

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-* Values: [option]``gcc-3.3``[option]``gcc-4.0``[option]``gcc-4.2``[option]``llvm-gcc-4.2``[option]``clang``[option]``macports-clang-3.3``[option]``macports-clang-3.4``[option]``macports-clang-3.7``[option]``macports-clang-3.8``[option]``macports-clang-3.9``[option]``macports-clang-4.0``[option]``macports-clang-5.0``[option]``macports-clang-6.0``[option]``apple-gcc-4.0``[option]``apple-gcc-4.2``[option]``macports-gcc-4.3``[option]``macports-gcc-4.4``[option]``macports-gcc-4.5``[option]`` [...]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* Default: `apple-gcc-4.2` on Mac OS X 10.4

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* Default: `gcc-4.2` with Xcode 3.x on Mac OS X 10.5 and 10.6

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* Default: `llvm-gcc-4.2` with Xcode 4.0 through 4.2 on Mac OS X 10.6 and 10.7

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* Default: `clang` with Xcode 4.3 and later on OS X 10.7 and later

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* Values: `gcc-3.3```gcc-4.0````gcc-4.2````llvm-gcc-4.2````clang````macports-clang-3.3````macports-clang-3.4````macports-clang-3.7````macports-clang-3.8````macports-clang-3.9````macports-clang-4.0````macports-clang-5.0````macports-clang-6.0````apple-gcc-4.0````apple-gcc-4.2````macports-gcc-4.3````macports-gcc-4.4````macports-gcc-4.5````macports-gcc-4.6````macports-gcc-4.7````macports-gcc-4.8````macports-gcc-4.9````macports-gcc-5````macports-gcc-6````macports-gcc-7````macports-gcc-8``

</span> * Example:

 +

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1256,7 +1255,7 @@ configure.ruby      ${prefix}/bin/ruby

</span> configure.install::

 Set `INSTALL` flag for selecting an install tool; used for copying files and creating directories.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* Default: [path]_/usr/bin/install_

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* Default: [path]`/usr/bin/install`

</span> * Example:

 +

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1339,7 +1338,7 @@ configure.pre_args  --prefix=${prefix}/share/bro

</span> configure.post_args OPT="-D__DARWIN_UNIX03"

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.phases.configure.universal]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.phases.configure.universal]]

</span> === Configure Universal

 Universal keywords are used to make a port compile on OS X for multiple architectures.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1433,7 +1432,7 @@ Additional flags to put in the LDFLAGS environment variable when invoking the co

</span> TODO: add example

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.phases.configure.automake_autoconf]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.phases.configure.automake-autoconf]]

</span> === Automake, Autoconf, and Autoreconf

 The list of configure keywords available for ports that need automake and/or autoconf.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1441,7 +1440,7 @@ The list of configure keywords available for ports that need automake and/or aut

</span> use_autoreconf::

 Whether or not to use autoreconf

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* Default: [option]``no``

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* Default: `no`

</span> * Example:

 +

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1453,7 +1452,7 @@ use_autoreconf      yes

</span> use_automake::

 Whether or not to use automake.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* Default: [option]``no``

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* Default: `no`

</span> * Example:

 +

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1487,9 +1486,9 @@ automake.args       --foreign

</span> ----

 automake.dir::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Directory in which to run [var]``${automake.cmd}``.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Directory in which to run ``${automake.cmd}``.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* Default: [var]``${worksrcpath}``

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* Default: `${worksrcpath}`

</span> * Example:

 +

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1501,7 +1500,7 @@ automake.dir        ./src

</span> use_autoconf::

 Whether or not to use autoconf.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* Default: [option]``no``

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* Default: `no`

</span> * Example:

 +

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1535,9 +1534,9 @@ autoconf.args       "-l src/aclocaldir"

</span> ----

 autoconf.dir::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Directory in which to run [var]``${autoconf.cmd}``.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Directory in which to run ``${autoconf.cmd}``.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* Default: [var]``${worksrcpath}``

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* Default: `${worksrcpath}`

</span> * Example:

 +

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1546,16 +1545,16 @@ Directory in which to run [var]``${autoconf.cmd}``.

</span> autoconf.dir        src

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.phases.build]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.phases.build]]

</span> == Build Phase Keywords

 The list of keywords related to the build phase.

 build.cmd::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Make command to run in [var]``${worksrcdir}``.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Make command to run in ``${worksrcdir}``.

Only use it if you can't use ``build.type``.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* Default: `make`

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* Default: [cmd]``make``

</span> * Example:

 +

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1565,11 +1564,11 @@ build.cmd           scons

</span> ----

 build.type::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Defines which build software is required and sets [var]``${build.cmd}`` accordingly.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Defines which build software is required and sets `${build.cmd}` accordingly.

</span> The available options are BSD Make, GNU Make, and Xcode. 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* Default: [option]``default`` (the default Make on the current platform) 

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-* Values: [option]``default``[option]``bsd``[option]``gnu``[option]``xcode``

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* Default: `default` (the default Make on the current platform) 

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* Values: `default```bsd````gnu````xcode``

</span> * Example:

 +

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1579,7 +1578,7 @@ build.type          bsd

</span> ----

 build.args::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Main arguments to [var]``${build.cmd}``; optional argument modifiers pass arguments before and after the main arguments.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Main arguments to ``${build.cmd}``; optional argument modifiers pass arguments before and after the main arguments.

</span> 

 * Default: none

 * Example:

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1593,7 +1592,7 @@ build.args          -DNOWARN

</span> +

 The following argument modifiers are available:

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* ``build.pre_args``, defaults to: [var]``${build.target}``

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* ``build.pre_args``, defaults to: `${build.target}`

</span> * ``build.post_args``, defaults to: none

 * Examples:

 +

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1605,7 +1604,7 @@ build.post_args     CFLAGS_SYS="-DUSE_FREETYPE -DPREFER_FREETYPE"

</span> ----

 build.target::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Build target to pass to [var]``${build.cmd}``; list modifiers add or delete items from a previous Portfile build.target keyword or the default set by MacPorts base.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Build target to pass to ``${build.cmd}``; list modifiers add or delete items from a previous Portfile build.target keyword or the default set by MacPorts base.

</span> 

 * Default: `all`

 * Example:

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1630,9 +1629,9 @@ Set environment variables for build; list modifiers add and delete items from a

</span> 

 use_parallel_build::

 This keyword is for specifying whether or not it is safe for a port to use multiple CPUs or multiple cores in parallel during its build phase.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-If `use_parallel_build` is not set to "`no`" in a given port, the option [option]``-j${build.jobs}`` is passed to [var]``${build.cmd}`` (if [var]``${build.cmd}`` is `make` or ``scons``).

<span style='display:block; white-space:pre;background:#e0ffe0;'>+If `use_parallel_build` is not set to "`no`" in a given port, the option `-j${build.jobs}` is passed to `${build.cmd}` (if `${build.cmd}` is [cmd]``make`` or [cmd]``scons``).

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* Default: [option]``yes``

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* Default: `yes`

</span> * Example:

 +

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1643,11 +1642,11 @@ use_parallel_build  no

</span> 

 build.jobs::

 The number of simultaneous jobs to run when parallel build is enabled.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The default value is based on the variable [var]``buildmakejobs`` in [path]_macports.conf_.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+The default value is based on the variable `buildmakejobs` in [path]`macports.conf`.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* Default: If [var]``buildmakejobs`` is 0, the number of CPU cores in the machine, or the number of GB of physical memory plus one, whichever is less. Otherwise,  the actual value of ``${buildmakejobs}``.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+* Default: If `buildmakejobs` is 0, the number of CPU cores in the machine, or the number of GB of physical memory plus one, whichever is less. Otherwise,  the actual value of ``${buildmakejobs}``.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.phases.test]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.phases.test]]

</span> == Test Phase Keywords

 The list of keywords related to the test phase.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1655,7 +1654,7 @@ The list of keywords related to the test phase.

</span> test.run::

 Enable running test suites bundled with a port.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* Default: [option]``no``

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* Default: `no`

</span> * Example:

 +

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1665,9 +1664,9 @@ test.run            yes

</span> ----

 test.cmd::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Test command to run relative to [var]``${worksrcdir}``.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Test command to run relative to ``${worksrcdir}``.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* Default: [var]``${build.cmd}``

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* Default: `${build.cmd}`

</span> * Example:

 +

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1677,7 +1676,7 @@ test.cmd            checks.sh

</span> ----

 test.target::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Test target to pass to [var]``${test.cmd}``.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Test target to pass to ``${test.cmd}``.

</span> 

 * Default: `test`

 * Example:

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1689,7 +1688,7 @@ test.target         checks

</span> ----

 test.args::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Main arguments to [var]``test.cmd``; optional argument modifiers pass arguments before and after the main arguments.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Main arguments to ``test.cmd``; optional argument modifiers pass arguments before and after the main arguments.

</span> 

 * Default: none

 * Example:

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1720,15 +1719,15 @@ Often `DYLD_LIBRARY_PATH` is set here to support testing dynamically linked libr

</span> test.env       DYLD_LIBRARY_PATH=${worksrcpath}/src/.libs

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.phases.destroot]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.phases.destroot]]

</span> == Destroot Phase Keywords

 The list of keywords related to the destroot phase.

 destroot.cmd::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Install command to run relative to [var]``${worksrcdir}``.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Install command to run relative to ``${worksrcdir}``.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* Default: [var]``${build.cmd}``

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* Default: `${build.cmd}`

</span> * Example:

 +

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1738,7 +1737,7 @@ destroot.cmd        scons

</span> ----

 destroot.args::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Main arguments to [var]``${destroot.cmd}``; optional argument modifiers pass arguments before and after the main arguments.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Main arguments to ``${destroot.cmd}``; optional argument modifiers pass arguments before and after the main arguments.

</span> 

 * Default: none

 * Example:

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1752,8 +1751,8 @@ destroot.args       BINDIR=${prefix}/bin

</span> +

 The following argument modifiers are available:

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* ``destroot.pre_args``, defaults to: [var]``${destroot.target}``

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-* ``destroot.post_args``, defaults to: [var]``${destroot.destdir}``

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* ``destroot.pre_args``, defaults to: `${destroot.target}`

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* ``destroot.post_args``, defaults to: `${destroot.destdir}`

</span> * Examples:

 +

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1764,7 +1763,7 @@ destroot.post_args  INSTDIR=${destroot}${prefix}

</span> ----

 destroot.target::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Install target to pass to [var]``${destroot.cmd}``; list modifiers add or delete items from a previous Portfile destroot.target keyword or the default set by MacPorts base.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Install target to pass to ``${destroot.cmd}``; list modifiers add or delete items from a previous Portfile destroot.target keyword or the default set by MacPorts base.

</span> 

 * Default: `install`

 * Example:

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1783,7 +1782,7 @@ destroot.target-delete  install-commandmode

</span> ----

 destroot.destdir::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Arguments passed to [var]``${destroot.cmd}`` via [var]``${destroot.post_args}`` to install correctly into the destroot.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Arguments passed to `${destroot.cmd}` via `${destroot.post_args}` to install correctly into the destroot.

</span> 

 * Default: `DESTDIR=${destroot}`

 * Example:

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1829,12 +1828,12 @@ destroot.keepdirs   ${destroot}${prefix}/var/run \

</span> ----

 destroot.violate_mtree::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-MacPorts tests for compliance to the common directory structure in [var]``${prefix}``.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-If a port is not compliant with the standard, set it to [option]``yes``.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+MacPorts tests for compliance to the common directory structure in ``${prefix}``.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+If a port is not compliant with the standard, set it to ``yes``.

</span> +

<span style='display:block; white-space:pre;background:#ffe0e0;'>-You can find the macports standard in <<_internals.hierarchy,MacPorts File Hierarchy>> or in the porthier(7) man page.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+You can find the macports standard in <<internals.hierarchy,MacPorts File Hierarchy>> or in the porthier(7) man page.

</span> +

<span style='display:block; white-space:pre;background:#ffe0e0;'>-If `destroot.violate_mtree` is set to [option]``yes``, the following warning is issued during the installation.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+If `destroot.violate_mtree` is set to ``yes``, the following warning is issued during the installation.

</span> +

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1842,11 +1841,11 @@ If `destroot.violate_mtree` is set to [option]``yes``, the following warning is

Warning: portname requests to install files outside the common directory structure!

 ----

 +

<span style='display:block; white-space:pre;background:#ffe0e0;'>-This means that the port installed files outside of their normal locations in [var]``${prefix}``.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-These could be files totally outside of [var]``${prefix}``, which could cause problems on your computer, or files inside of [var]``${prefix}`` that are not in a standard location.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Use `port contents [replaceable]``portname``` to see the location for all files that were installed by a given port.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+This means that the port installed files outside of their normal locations in ``${prefix}``.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+These could be files totally outside of ``${prefix}``, which could cause problems on your computer, or files inside of `${prefix}` that are not in a standard location.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Use `port contents ``portname``` to see the location for all files that were installed by a given port.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* Default: [option]``no``

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* Default: `no`

</span> * Example:

 +

<span style='display:block; white-space:pre;color:#808080;'>diff --git a/guide/adoc/portfile-startupitem.adoc b/guide/adoc/portfile-startupitem.adoc

</span><span style='display:block; white-space:pre;color:#808080;'>index f167e38..30beab7 100644

</span><span style='display:block; white-space:pre;background:#e0e0ff;'>--- a/guide/adoc/portfile-startupitem.adoc

</span><span style='display:block; white-space:pre;background:#e0e0ff;'>+++ b/guide/adoc/portfile-startupitem.adoc

</span><span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1,19 +1,19 @@

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.startupitems]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.startupitems]]

</span> = StartupItems

 A StartupItem is a MacPorts facility to run "`daemons,`" a Unix term for programs that run continuously in the background, rather than under the direct control of a user; for example, mail servers, network listeners, etc.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Ports that use StartupItem keywords create scripts for link:launchd, which is the Apple facility introduced with Mac OS X 10.4 to replace xinetd for starting and managing daemons.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-To support ``launchd``, a program named `daemondo` is provided by MacPorts base that serves as an adapter between `launchd` and daemons ("`executable`" StartupItems) or traditional Unix startup scripts that start daemons ("`script`" StartupItems).

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Ports that use StartupItem keywords create scripts for https://developer.apple.com/macosx/launchd.html[launchd], which is the Apple facility introduced with Mac OS X 10.4 to replace xinetd for starting and managing daemons.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+To support [cmd]``launchd``, a program named [cmd]``daemondo`` is provided by MacPorts base that serves as an adapter between [cmd]``launchd`` and daemons ("`executable`" StartupItems) or traditional Unix startup scripts that start daemons ("`script`" StartupItems).

</span> 

 There are three categories of StartupItem keywords.

 Those that trigger StartupItem creation and logging, those that specify attributes of "`executable`" StartupItems, and those that specify attributes of "`script`" StartupItems.

 [NOTE]

 ====

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The variable [var]``startupitem_type`` in [path]_${prefix}/etc/macports/macports.conf_ may be set to [option]``none`` to globally override all StartupItem keywords found in Portfiles; this prevents StartupItems from being created.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+The variable `startupitem_type` in [path]`${prefix}/etc/macports/macports.conf` may be set to `none` to globally override all StartupItem keywords found in Portfiles; this prevents StartupItems from being created.

</span> ====

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.startupitems.attributes]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.startupitems.attributes]]

</span> == StartupItem Attributes

 The keywords in this section may be used with either "`executable`" or "`script`" StartupItems (see below).

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -21,7 +21,7 @@ The keywords in this section may be used with either "`executable`" or "`script`

</span> startupitem.create::

 Trigger the creation of a StartupItem.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* Default: [option]``no``

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* Default: `no`

</span> * Example:

 +

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -34,7 +34,7 @@ startupitem.name::

Sets the name for the StartupItem.

 Defaults to the name of the port, so this keyword is usually unnecessary.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* Default: [var]``${name}``

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* Default: `${name}`

</span> * Example:

 +

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -47,7 +47,7 @@ startupitem.logfile::

Path to a logfile for logging events about the lifetime of the StartupItem.

 Depending on the type of StartupItem, and the manner in which it is started, standard output from the daemon may also be directed to the logfile.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* Default: [path]_/dev/null_

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* Default: [path]`/dev/null`

</span> * Example:

 +

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -60,7 +60,7 @@ startupitem.logevents::

Control whether or not to log events to the log file.

 If logevents is set, events with timestamps are logged to the logfile.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* Default: [option]``no``

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* Default: `no`

</span> * Example:

 +

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -72,7 +72,7 @@ startupitem.logevents   yes

</span> startupitem.netchange::

 Cause the daemon to be restarted when a change in network state is detected.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* Default: [option]``no``

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* Default: `no`

</span> * Example:

 +

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -81,17 +81,16 @@ Cause the daemon to be restarted when a change in network state is detected.

</span> startupitem.netchange   yes

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.startupitems.executable]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.startupitems.executable]]

</span> == Executable StartupItems

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Daemons run continuously, so monitoring the health of daemon processes and restarting them if they die is an important StartupItems' feature. "`Executable`" StartupItems are preferred over "`script`" StartupItems because `daemondo` launches the daemon __directly__, rather than _indirectly_ via a script, and therefore it automatically knows how to monitor a daemon process and restart it if it dies.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Daemons run continuously, so monitoring the health of daemon processes and restarting them if they die is an important StartupItems' feature. "`Executable`" StartupItems are preferred over "`script`" StartupItems because [cmd]``daemondo`` launches the daemon __directly__, rather than _indirectly_ via a script, and therefore it automatically knows how to monitor a daemon process and restart it if it dies.

Daemons used with "`executable`" StartupItems may be programs or scripts (shell, perl, python, etc.) as long as the script _itself_ is the daemon, rather than merely what launches the daemon.

 In the latter case "`script`" StartupItems are to be used.

 [NOTE]

 ====

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Since "`script`" and "`executable`" are mutually exclusive StartupItem types, the `startupitem.executable` keyword may not be used in a Portfile that uses any keywords listed in the <<_reference.startupitems.script,Script StartupItems

<span style='display:block; white-space:pre;background:#ffe0e0;'>-      section>>.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Since "`script`" and "`executable`" are mutually exclusive StartupItem types, the `startupitem.executable` keyword may not be used in a Portfile that uses any keywords listed in the <<reference.startupitems.script,Script StartupItems section>>.

</span> ====

 startupitem.executable::

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -146,14 +145,14 @@ generates a .plist file with these tags:

</span> </array>

 ----

 ====

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.startupitems.script]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.startupitems.script]]

</span> == Script StartupItems

<span style='display:block; white-space:pre;background:#ffe0e0;'>-StartupItems of type "`script`" create a wrapper during port installation for `daemondo` that will be used to launch a daemon startup script present in an application's source distribution (MacPorts does not create daemon startup scripts) for daemons that require a script.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+StartupItems of type "`script`" create a wrapper during port installation for [cmd]``daemondo`` that will be used to launch a daemon startup script present in an application's source distribution (MacPorts does not create daemon startup scripts) for daemons that require a script.

</span> 

 [NOTE]

 ====

<span style='display:block; white-space:pre;background:#ffe0e0;'>-"`Executable`" StartupItems are the preferred type since "`script`" StartupItems launch daemons __indirectly__, and this requires that port authors use the `startupitem.pidfile` keyword so that `daemondo` can check this pid file to see is a daemon process has died and restart it.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+"`Executable`" StartupItems are the preferred type since "`script`" StartupItems launch daemons __indirectly__, and this requires that port authors use the `startupitem.pidfile` keyword so that [cmd]``daemondo`` can check this pid file to see is a daemon process has died and restart it.

Any time a script (or an executable) itself serves as a daemon, use the "`executable`" StartupItem type so daemondo will launch it directly and track its health automatically.

 Additionally, since "`script`" and "`executable`" are mutually exclusive StartupItem types, the `startupitem.executable` keyword may not be used in a Portfile that uses "`script`" StartupItem keywords.

 ====

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -207,7 +206,7 @@ startupitem.init        BIN=${prefix}/sbin/bacula-fd

</span> ----

 startupitem.pidfile::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-This keyword must be defined properly for `daemondo` to be able to monitor daemons launched via "`script`" StartupItems and restart them if they die.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+This keyword must be defined properly for [cmd]``daemondo`` to be able to monitor daemons launched via "`script`" StartupItems and restart them if they die.

It specifies two things: a process id (PID) file handling method, and a pidfile name and path.

 * {empty}

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -217,11 +216,11 @@ Default: `none

</span> ${prefix}/var/run/${name}.pid`

 +

 +

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Default: [none] | [[path]_${prefix}/var/run/${name}.pid_]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+Default: [none] | [[path]`${prefix}/var/run/${name}.pid`]

</span> * {empty}

 +

 +

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Values [none auto manual clean] [[replaceable]``/path/to/pidfile``]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+Values [none auto manual clean] [``/path/to/pidfile``]

</span> * Example:

 +

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -234,36 +233,36 @@ startupitem.pidfile     auto ${prefix}/var/run/${name}.pidfile

</span> +

 PID file handling options:

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* [option]``none`` - daemondo will not create or track a PID file, so it won't know when a daemon dies.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* [option]``auto`` - The started process is expected to create a PID file that contains the PID of the running daemon; daemondo then reads the PID from the file and tracks the process. The started process must delete the PID file if this is necessary.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* [option]``clean`` - The started process is expected to create a PID file that contains the PID of the running daemon; daemondo then reads the PID from the file and tracks the process, and deletes the PID file if it detects the daemon has died.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* [option]``manual`` - This option should only be used if an "`executable`" StartupItem could be used (daemondo launches a daemon directly) _and_ a port author wants a PID file written for some special use. A PID file is not needed to detect process death for daemons launched directly by daemondo. As with executable StartupItems, daemondo remembers the PID of the launched process and tracks it automatically.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+* `none` - daemondo will not create or track a PID file, so it won't know when a daemon dies.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+* `auto` - The started process is expected to create a PID file that contains the PID of the running daemon; daemondo then reads the PID from the file and tracks the process. The started process must delete the PID file if this is necessary.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+* `clean` - The started process is expected to create a PID file that contains the PID of the running daemon; daemondo then reads the PID from the file and tracks the process, and deletes the PID file if it detects the daemon has died.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+* `manual` - This option should only be used if an "`executable`" StartupItem could be used (daemondo launches a daemon directly) _and_ a port author wants a PID file written for some special use. A PID file is not needed to detect process death for daemons launched directly by daemondo. As with executable StartupItems, daemondo remembers the PID of the launched process and tracks it automatically.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.startupitems.launchd]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.startupitems.launchd]]

</span> == Loading / Unloading StartupItems into launchd

<span style='display:block; white-space:pre;background:#ffe0e0;'>-A port with a StartupItem places a link to a .plist file for the port's daemon within [path]_/Library/LaunchDaemons/_.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+A port with a StartupItem places a link to a .plist file for the port's daemon within [path]`/Library/LaunchDaemons/`.

A .plist file is an XML file; MacPorts installs .plist files tagged as "`disabled`" for the sake of security.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-You may enable a startup script (tag the.plist file as "`enabled`") and load it into `launchd` with a single command as shown.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+You may enable a startup script (tag the.plist file as "`enabled`") and load it into [cmd]``launchd`` with a single command as shown.

</span> 

 [source]

 ----

 %% sudo launchctl load -w /Library/LaunchDaemons/org.macports.mysql5.plist

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-You may stop a running startup script, disable it (tag the.plist file as "`disabled`"), and unload it from `launchd` with a single command as shown.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+You may stop a running startup script, disable it (tag the.plist file as "`disabled`"), and unload it from [cmd]``launchd`` with a single command as shown.

</span> 

 [source]

 ----

 %% sudo launchctl unload -w /Library/LaunchDaemons/org.macports.mysql5.plist

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.startupitems.internals]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.startupitems.internals]]

</span> == StartupItem Internals

<span style='display:block; white-space:pre;background:#ffe0e0;'>-During port installation a MacPorts StartupItem creates a .plist file in [path]_${prefix}/etc/LaunchDaemons/_, and places a symbolic link to the .plist file within [path]_/Library/LaunchDaemons/_.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+During port installation a MacPorts StartupItem creates a .plist file in [path]`${prefix}/etc/LaunchDaemons/`, and places a symbolic link to the .plist file within [path]`/Library/LaunchDaemons/`.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-For example, the StartupItem for the mysql5 port is [path]_org.macports.mysql5.plist_, and it is linked as shown.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+For example, the StartupItem for the mysql5 port is [path]`org.macports.mysql5.plist`, and it is linked as shown.

</span> 

 [source]

 ----

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -272,18 +271,22 @@ For example, the StartupItem for the mysql5 port is [path]_org.macports.mysql5.p

</span> 

 ----

 org.macports.mysql5.plist ->

<span style='display:block; white-space:pre;background:#ffe0e0;'>-     /opt/local/etc/LaunchDaemons/org.macports.mysql5/org.macports.mysql5.plist

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+/opt/local/etc/LaunchDaemons/org.macports.mysql5/org.macports.mysql5.plist

</span> ----

 For "`script`" StartupItems, in addition to a .plist file, a wrapper is also created.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+

</span> [source]

 ----

 %% ls -l /opt/local/etc/LaunchDaemons/org.macports.mysql5/

 ----

<span style='display:block; white-space:pre;background:#e0ffe0;'>+

</span> ----

 -rwxr-xr-x   2 root  wheel  475 Aug  2 14:16 mysql5.wrapper

 -rw-r--r--   2 root  wheel  975 Aug  2 14:16 org.macports.mysql5.plist

<span style='display:block; white-space:pre;background:#ffe0e0;'>-----The wrapper manipulates the script as specified in the startupitem.start and startupitem.stop keywords.

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+----

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+

<span style='display:block; white-space:pre;background:#e0ffe0;'>+The wrapper manipulates the script as specified in the startupitem.start and startupitem.stop keywords.

An example wrapper script snippet is shown below.

 [source]

<span style='display:block; white-space:pre;color:#808080;'>diff --git a/guide/adoc/portfile-tcl.adoc b/guide/adoc/portfile-tcl.adoc

</span><span style='display:block; white-space:pre;color:#808080;'>index f99ac13..7965a00 100644

</span><span style='display:block; white-space:pre;background:#e0e0ff;'>--- a/guide/adoc/portfile-tcl.adoc

</span><span style='display:block; white-space:pre;background:#e0e0ff;'>+++ b/guide/adoc/portfile-tcl.adoc

</span><span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1,14 +1,14 @@

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.tcl_extensions]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.tcl-extensions]]

</span> = Tcl Extensions & Useful Tcl Commands

<span style='display:block; white-space:pre;background:#ffe0e0;'>-A MacPorts Portfile is a Tcl script, so it may contain any arbitrary Tcl code you may learn about in a link:Tcl reference manual.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+A MacPorts Portfile is a Tcl script, so it may contain any arbitrary Tcl code you may learn about in the https://www.tcl.tk/doc/[Tcl documentation].

However, few authors will use arbitrary Tcl code; the vast majority will use a subset of Tcl commands and a number of Tcl extensions that are coded within MacPorts for performing the most common tasks needed for Portfiles.

 The list below is a list of useful Tcl commands for Portfile development and Tcl extensions provided by MacPorts base.

 file::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The standard Tcl `file` command can be used for a number of operations on files, such as moving, renaming, deleting, or creating directories, among others.

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-For a complete list, consult the link:Tcl

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-reference manual for the file command, or the Tcl file manpage in the [option]``n`` section of manpages on your machine using `man n file`

<span style='display:block; white-space:pre;background:#e0ffe0;'>+The standard Tcl [cmd]``file`` command can be used for a number of operations on files, such as moving, renaming, deleting, or creating directories, among others.

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+For a complete list, consult the https://www.tcl.tk/man/tcl/TclCmd/file.htm[Tcl

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+reference manual for the file command], or the Tcl file manpage in the `n` section of manpages on your machine using [cmd]``man n file``

</span> 

 file copy::

 Copy a file.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -17,12 +17,12 @@ file rename::

Rename a file.

 file delete [-force]::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Remove a file or (with [option]``-force``) a directory and its contents.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Remove a file or (with ``-force``) a directory and its contents.

</span> 

 file mkdir::

 Create a directory.

 macros::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-For the above operations provided by Tcl's `file` command, MacPorts provides the following shorthands.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+For the above operations provided by Tcl's [cmd]``file`` command, MacPorts provides the following shorthands.

These should be used in preference to the Tcl commands above, as they may work around certain bugs.

 copy::

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -42,24 +42,24 @@ Mimics the BSD ln command.

</span> xinstall::

 xinstall copies files and creates directories; it is intended to be compatible with install(1).

<span style='display:block; white-space:pre;background:#ffe0e0;'>-xinstall [-o [replaceable]``owner``] [-g [replaceable]``group``] [-m [replaceable]``mode``] [[replaceable]``file1 file2 ...``] [replaceable]``directory``::

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+xinstall [-o ``owner``] [-g ``group``] [-m ``mode``] [``file1 file2 ...``] `directory`::

Install the specified file(s) to a destination directory.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-xinstall [-o [replaceable]``owner``] [-g [replaceable]``group``] [-m [replaceable]``mode``] [-W [replaceable]``dir``] [[replaceable]``file1 file2 ...``] [replaceable]``directory``::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Change to [option]``dir`` and install file(s) to a destination directory.

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+xinstall [-o ``owner``] [-g ``group``] [-m ``mode``] [-W ``dir``] [``file1 file2 ...``] `directory`::

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Change to `dir` and install file(s) to a destination directory.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-xinstall [-o [replaceable]``owner``] [-g [replaceable]``group``] [-m [replaceable]``mode``] {*}[glob [replaceable]``pattern``] [replaceable]``directory``::

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+xinstall [-o ``owner``] [-g ``group``] [-m ``mode``] {*}[glob ``pattern``] `directory`::

Install the file(s) matching the glob pattern to a destination directory.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Note the use of the [option]``{*}`` operator to convert the list returned by `glob` into separate arguments to ``xinstall``.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Note the use of the `{*}` operator to convert the list returned by [cmd]``glob`` into separate arguments to [cmd]``xinstall``.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-xinstall -d [-o [replaceable]``owner``] [-g [replaceable]``group``] [-m [replaceable]``mode``] [replaceable]``directory``::

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+xinstall -d [-o ``owner``] [-g ``group``] [-m ``mode``] `directory`::

Create a directory including parent directories if necessary.

 +

 Defaults:

 * owner -

 * group -

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* mode - [option]``0755``

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* mode - `0755`

</span> 

 +

 Examples:

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -95,15 +95,15 @@ strsed::

strsed can be used for string manipulations using regular expressions.

 It supports a small subset of the commands known from sed(1).

<span style='display:block; white-space:pre;background:#ffe0e0;'>-strsed [replaceable]``string`` s/[replaceable]``regex``/[replaceable]``replacement``/ ::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Replaces the first instance of [replaceable]``regex`` with [replaceable]``replacement``.

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+strsed `string` s/``regex``/``replacement``/ ::

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Replaces the first instance of `regex` with ``replacement``.

Refer to re_format(7) for a definition of regular expression syntax.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-strsed [replaceable]``string`` g/[replaceable]``regex``/[replaceable]``replacement``/ ::

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+strsed `string` g/``regex``/``replacement``/ ::

The same as the previous format, except all instances of the pattern will be replaced, not only the first (mnemonic: 'g' is for global).

 reinplace::

 Allows text specified by a regular expression to be replaced by new text, in-place (the file will be updated itself, no need to place output into a new file and rename).

<span style='display:block; white-space:pre;background:#ffe0e0;'>- reinplace [-locale [replaceable]``locale``] [-n] [-W [replaceable]``dir``] [--] [replaceable]``command``[replaceable]``file ...``::

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ reinplace [-locale ``locale``] [-n] [-W ``dir``] [--] `command```file ...``::

Replace text given by the regular expression portion of the command with the replacement text, in all files specified.

 +

 Use -locale to set the locale.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -137,10 +137,10 @@ reinplace "s|@@PREFIX@@|${prefix}|g" ${worksrcpath}/Makefile

</span> user/group::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-adduser username [uxml:id=[replaceable]``uid``] [gxml:id=[replaceable]``gid``] [passwd=[replaceable]``passwd``] [realname=[replaceable]``realname``] [home=[replaceable]``home``] [shell=[replaceable]``shell``]::

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+adduser username [uxml:id=``uid``] [gxml:id=``gid``] [passwd=``passwd``] [realname=``realname``] [home=``home``] [shell=``shell``]::

Add a new local user to the system with the specified uid, gid, password, real name, home directory and login shell.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-existsuser [replaceable]``username``::

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+existsuser `username`::

Check if a local user exists.

 Returns the uid for the given user, or 0 if the user wasn't found.

 Checking for the root user is not supported because its uid is 0, and it will always exist anyway.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -148,10 +148,10 @@ Checking for the root user is not supported because its uid is 0, and it will al

</span> nextuid::

 Returns the highest used uid plus one.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-addgroup [replaceable]``group`` [gxml:id=[replaceable]``gid``] [passwd=[replaceable]``passwd``] [realname=[replaceable]``realname``] [users=[replaceable]``users``]::

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+addgroup `group` [gxml:id=``gid``] [passwd=``passwd``] [realname=``realname``] [users=``users``]::

Add a new local group to the system, with the specified gid, password, real name, and with a list of users as members.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-existsgroup [replaceable]``group``::

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+existsgroup `group`::

Check if a local group exists and return the corresponding gid.

 This can be used with adduser:

 +

<span style='display:block; white-space:pre;color:#808080;'>diff --git a/guide/adoc/portfile-variables.adoc b/guide/adoc/portfile-variables.adoc

</span><span style='display:block; white-space:pre;color:#808080;'>index 33bc552..164efb1 100644

</span><span style='display:block; white-space:pre;background:#e0e0ff;'>--- a/guide/adoc/portfile-variables.adoc

</span><span style='display:block; white-space:pre;background:#e0e0ff;'>+++ b/guide/adoc/portfile-variables.adoc

</span><span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1,54 +1,54 @@

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.variables]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.variables]]

</span> = Global Variables

 Global variables are variables available to any Portfile.

 For a list of additional variables available to ports that are assigned to a MacPorts Portgroup, see portgroup(7).

<span style='display:block; white-space:pre;background:#ffe0e0;'>-All of these variables except [var]``prefix`` are read-only!

<span style='display:block; white-space:pre;background:#e0ffe0;'>+All of these variables except `prefix` are read-only!

</span> 

 prefix::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Installation prefix, set at compile time and displayed in [path]_${prefix}/etc/macports/macports.conf_ --- may be overridden on a per-port basis, for example to install into a wholly-contained subdirectory of ${prefix}, but most ports should have no reason to do so.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Installation prefix, set at compile time and displayed in [path]`${prefix}/etc/macports/macports.conf` --- may be overridden on a per-port basis, for example to install into a wholly-contained subdirectory of ${prefix}, but most ports should have no reason to do so.

</span> +

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Default: [path]_/opt/local_

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+Default: [path]`/opt/local`

</span> 

 libpath::

 Path to the MacPorts Tcl libraries.

 portpath::

 Full path to the Portfile of the port being executed.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Portfile repositories are defined in the file <<_internals.configuration_files.sources_conf,sources.conf>>.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Portfile repositories are defined in the file <<internals.configuration-files.sources-conf,sources.conf>>.

</span> +

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Default: [path]_${prefix}/var/macports/sources/rsync.macports.org/macports/release/tarballs/ports/<category>/<portname>/_

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+Default: [path]`${prefix}/var/macports/sources/rsync.macports.org/macports/release/tarballs/ports/<category>/<portname>/`

</span> 

 filesdir::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Path to files directory relative to [var]``${portpath}``.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Path to files directory relative to ``${portpath}``.

</span> +

 Value: `files`

 filespath::

 Full path to files directory.

 +

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Value: [var]``${portpath}/${filesdir}``

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+Value: `${portpath}/${filesdir}`

</span> 

 workpath::

 Full path to work directory.

 +

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Value: [var]``${portbuildpath}/work``

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+Value: `${portbuildpath}/work`

</span> 

 worksrcpath::

 Full path to extracted source code.

 +

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Value: [var]``${workpath}/${worksrcdir}``

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+Value: `${workpath}/${worksrcdir}`

</span> 

 destroot::

 Full path into which software will be destrooted.

 +

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Value: [var]``${workpath}/destroot``

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+Value: `${workpath}/destroot`

</span> 

 distpath::

 Location to store downloaded distfiles.

 +

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Value: [var]``${portdbpath}/distfiles/${dist_subdir}/``

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+Value: `${portdbpath}/distfiles/${dist_subdir}/`

</span> 

 install.user::

 The Unix user at the time of port installation.

<span style='display:block; white-space:pre;color:#808080;'>diff --git a/guide/adoc/portfile-variants.adoc b/guide/adoc/portfile-variants.adoc

</span><span style='display:block; white-space:pre;color:#808080;'>index 444544f..0d7adfc 100644

</span><span style='display:block; white-space:pre;background:#e0e0ff;'>--- a/guide/adoc/portfile-variants.adoc

</span><span style='display:block; white-space:pre;background:#e0e0ff;'>+++ b/guide/adoc/portfile-variants.adoc

</span><span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1,11 +1,11 @@

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.variants]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.variants]]

</span> = Variants

 MacPorts variants are conditional modifications of port installation behavior during port installation.

 There are two types of variants: user-selected variants and platform variants.

 User-selected variants are options selected by a user when a port is installed; platform variants are selected automatically by MacPorts base according to the OS or hardware platform (darwin, freebsd, linux, i386, powerpc, etc.).

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.variants.user_selected]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.variants.user-selected]]

</span> == User-Selected Variants

 User-selected variants are those that are defined so a user can invoke them to enable port options at install time.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -17,7 +17,7 @@ Variant names may contain only letters, numbers and underscore characters.

In particular, the hyphen is not a valid character in variant names because it would conflict with the notation for deselecting a variant.

 ====

<span style='display:block; white-space:pre;background:#ffe0e0;'>-variant [replaceable]``name`` [requires [replaceable]``variant1 variant2 ...``] [conflicts [replaceable]``variant1 variant2 ...``] [description [replaceable]``description``]::

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+variant `name` [requires ``variant1 variant2 ...``] [conflicts ``variant1 variant2 ...``] [description ``description``]::

The variant declaration may contain any keywords that can be placed in a Portfile's global section.

 If you wish to execute system (shell) calls or Tcl extensions during the execution of a port phase, you should place those statements within a `variant_isset` conditional within a phase declaration and not within the variant declaration itself.

 Dependencies and conflicts with other variants in the same port can be expressed with `requires` and `conflicts` options as shown below.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -67,10 +67,9 @@ Default variants may be suppressed by preceding a variant name with a "`-`" as s

</span> ----

 universal_variant::

 When using MacPorts on macOS, a universal variant is defined by default to configure ports with universal flags.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The variant can be overridden if the default code does not work (see the <<_reference.phases.configure.universal,Configure

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Universal>> section above), or suppressed if a universal variant does not function properly for a given port.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+The variant can be overridden if the default code does not work (see the <<reference.phases.configure.universal,Configure Universal>> section above), or suppressed if a universal variant does not function properly for a given port.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* Default: [option]``yes``

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* Default: `yes`

</span> * Example:

 +

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -79,7 +78,7 @@ Universal>> section above), or suppressed if a universal variant does not functi

</span> universal_variant   no

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.variants.descriptions]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.variants.descriptions]]

</span> == User-Selected Variant Descriptions

 User-selected variants ought to provide a description, which will be displayed when using command ``port variants foo``.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -99,15 +98,15 @@ Thus, it would be better to write "`Build with support for

</span> 

 Variant descriptions are strings, so one should take care not to put whitespace between the brackets and the beginning and end of the variant description, and also not to use unnecessary whitespace, unlike with port descriptions and long_descriptions.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.variants.platform]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.variants.platform]]

</span> == Platform Variants

 Platform variants are either defined by default in MacPorts base, or defined by a port author to customize a port's installation according to OS (operating system) or hardware platform.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-platform [replaceable]``os`` [[replaceable]``version``] [[replaceable]``arch``]::

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+platform `os` [``version``] [``arch``]::

MacPorts allows platform-specific port options to be specified in a Portfile for handling differences between platforms and versions of the same platform.

 +

<span style='display:block; white-space:pre;background:#ffe0e0;'>-`platform darwin [replaceable]``version``` can be used to handle different tasks depending on the version of Darwin, the core operating system underlying macOS. [replaceable]``version`` is the major version of Darwin, and can be `17` for macOS High Sierra v10.13, `16` for macOS Sierra v10.12, `15` for OS X El Capitan v10.11, and so on.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+`platform darwin ``version``` can be used to handle different tasks depending on the version of Darwin, the core operating system underlying macOS. `version` is the major version of Darwin, and can be `17` for macOS High Sierra v10.13, `16` for macOS Sierra v10.12, `15` for OS X El Capitan v10.11, and so on.

</span> 

 * Examples:

 +

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -138,8 +137,10 @@ platform darwin 8 powerpc {

</span> }

 ----

<span style='display:block; white-space:pre;background:#e0ffe0;'>+

</span> [NOTE]

<span style='display:block; white-space:pre;background:#ffe0e0;'>-====Though a combination of OS version and hardware platform may be specified in a single platform statement (e.g., darwin 8 i386), it is not possible to specify a range of platforms with a single statement.

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+====

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Though a combination of OS version and hardware platform may be specified in a single platform statement (e.g., darwin 8 i386), it is not possible to specify a range of platforms with a single statement.

For example, to select Darwin versions 9 and 10 while excluding all others, you would need two statements: `platform darwin 9` and ``platform darwin 10``.

 Alternately, you could make that behavior the port's default, and add a `platform darwin 8` block to remove it again.

 ====

\ No newline at end of file

<span style='display:block; white-space:pre;color:#808080;'>diff --git a/guide/adoc/portfiledev.adoc b/guide/adoc/portfiledev.adoc

</span><span style='display:block; white-space:pre;color:#808080;'>index 47a1a6f..aa0c73c 100644

</span><span style='display:block; white-space:pre;background:#e0e0ff;'>--- a/guide/adoc/portfiledev.adoc

</span><span style='display:block; white-space:pre;background:#e0e0ff;'>+++ b/guide/adoc/portfiledev.adoc

</span><span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1,28 +1,30 @@

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_development]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[development]]

</span> = Portfile Development

 :doctype: book

 :sectnums:

 :toc: left

 :icons: font

 :experimental:

<span style='display:block; white-space:pre;background:#e0ffe0;'>+:idprefix:

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+:idseparator: -

</span> :sourcedir: .

 A port is a distribution of software that can be compiled and installed using MacPorts.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-A [path]_Portfile_ describes all the required steps such as where to get the source code from upstream, which patches have to be applied and which other tools and commands are required to build the source code.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+A [path]`Portfile` describes all the required steps such as where to get the source code from upstream, which patches have to be applied and which other tools and commands are required to build the source code.

</span> 

 Each port consists of multiple files in a directory, usually within a category subdirectory of the root of a ports tree.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The MacPorts Project distributes the main ports tree that is by default <<_internals.configuration_files.sources_conf,configured>> in all installations of MacPorts.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+The MacPorts Project distributes the main ports tree that is by default <<internals.configuration-files.sources-conf,configured>> in all installations of MacPorts.

This section serves as a reference for the directory structure of a single port and the layout of the files within.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The only required file in a port is the [path]_Portfile_.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+The only required file in a port is the [path]`Portfile`.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_development.introduction]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[development.introduction]]

</span> == Portfile Introduction

<span style='display:block; white-space:pre;background:#ffe0e0;'>-A MacPorts Portfile is a link:Tcl script that usually contains only the simple keyword/value combinations and Tcl extensions as described in the <<_reference,Portfile Reference>> chapter, though it may also contain arbitrary Tcl code.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+A MacPorts Portfile is a https://en.wikipedia.org/wiki/Tcl[Tcl] script that usually contains only the simple keyword/value combinations and Tcl extensions as described in the <<reference,Portfile Reference>> chapter, though it may also contain arbitrary Tcl code.

Every port has a corresponding Portfile, but Portfiles do not completely define a port's installation behavior since MacPorts base has default port installation characteristics coded within it.

 Therefore Portfiles need only specify required options, though some ports may require non-default options.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-A common way for Portfiles to augment or override MacPorts base default installation phase characteristics is by using [path]_Portfile_ phase declaration(s). If you use Portfile phase declaration(s), you should know how to identify the "`global`" section of a Portfile.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+A common way for Portfiles to augment or override MacPorts base default installation phase characteristics is by using [path]`Portfile` phase declaration(s). If you use Portfile phase declaration(s), you should know how to identify the "`global`" section of a Portfile.

Any statements not contained within a phase declaration, no matter where they are located in a Portfile, are said to be in the global section of the Portfile; therefore the global section need not be contiguous.

 Likewise, to remove statements from the global section they must be placed within a phase declaration.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -35,26 +37,26 @@ The main phases you need to be aware of when making a Portfile are these:

</span> * Build

 * Destroot

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The default installation phase behavior performed by the MacPorts base works fine for applications that use the standard ``configure``, ``make``, and `make

<span style='display:block; white-space:pre;background:#ffe0e0;'>-    install` steps, which conform to phases configure, build, and destroot respectively.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-For applications that do not conform to this standard behavior, any installation phase may be augmented using <<_development.examples.augment,pre- and/or post- phases>>, or even <<_development.examples.override,overridden>> or <<_development.examples.eliminate,eliminated>>.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-See <<_development.examples,Example Portfiles>> below.

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+The default installation phase behavior performed by the MacPorts base works fine for applications that use the standard [cmd]``configure``, [cmd]``make``, and [cmd]``make

<span style='display:block; white-space:pre;background:#e0ffe0;'>+    install`` steps, which conform to phases configure, build, and destroot respectively.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+For applications that do not conform to this standard behavior, any installation phase may be augmented using <<development.examples.augment,pre- and/or post- phases>>, or even <<development.examples.override,overridden>> or <<development.examples.eliminate,eliminated>>.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+See <<development.examples,Example Portfiles>> below.

</span> 

 [NOTE]

 ====

<span style='display:block; white-space:pre;background:#ffe0e0;'>-For a detailed description of all port phases, see the <<_reference.phases,Portfile Reference>> chapter.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+For a detailed description of all port phases, see the <<reference.phases,Portfile Reference>> chapter.

</span> ====

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_development.creating_portfile]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[development.creating-portfile]]

</span> == Creating a Portfile

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Here we list the individual Portfile components for an application that conforms to the standard ``configure``, ``make``, and `make install` steps of most open source application installs.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Here we list the individual Portfile components for an application that conforms to the standard [cmd]``configure``, [cmd]``make``, and [cmd]``make install`` steps of most open source application installs.

</span> 

 . Modeline

 +

 This should be the first line of a Portfile.

 It sets the correct editing options for vim and emacs.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-See <<_development.practices.portstyle,Port Style>> for more information.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+See <<development.practices.portstyle,Port Style>> for more information.

Its use is optional and up to the port maintainer.

 +

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -105,10 +107,7 @@ platforms           darwin

</span> +

 A port's maintainers are the people who have agreed to take responsibility for keeping the port up-to-date.

 The `maintainers` keyword lists the maintainers' GitHub usernames or email addresses, preferably in the obfuscated form which hides them from spambots.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-For more, see the full explanation of the <<_reference.keywords.maintainers,maintainers

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-keyword>> in the <<_reference.keywords,Global

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-Keywords>> section of the <<_reference,Portfile

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Reference>> chapter.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+For more, see the full explanation of the <<reference.keywords.maintainers,maintainers keyword>> in the <<reference.keywords,Global Keywords>> section of the <<reference,Portfile Reference>> chapter.

</span> +

 [source]

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -231,13 +230,12 @@ configure.args      --enable-perl-site-install \

</span> ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_development.examples]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[development.examples]]

</span> == Example Portfiles

<span style='display:block; white-space:pre;background:#ffe0e0;'>-In this section we begin by taking a look at a complete simple Portfile; then we see how to <<_development.examples.augment,augment default phases>> by defining pre- and post- phases, how to <<_development.examples.override,override default phases>>, and finally how to <<_development.examples.eliminate,eliminate port

<span style='display:block; white-space:pre;background:#ffe0e0;'>-    phases>>.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+In this section we begin by taking a look at a complete simple Portfile; then we see how to <<development.examples.augment,augment default phases>> by defining pre- and post- phases, how to <<development.examples.override,override default phases>>, and finally how to <<development.examples.eliminate,eliminate port phases>>.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_development.examples.basic]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[development.examples.basic]]

</span> === A Basic Portfile

 [source]

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -269,7 +267,7 @@ configure.args      --enable-perl-site-install \

</span>                     --mandir=${prefix}/share/man

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_development.examples.augment]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[development.examples.augment]]

</span> === Augment Phases Using pre- / post-

 To augment a port's installation phase, and not override it, you may use pre- and post- installation phases as shown in this example.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -284,7 +282,7 @@ post-destroot {

</span> }

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_development.examples.override]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[development.examples.override]]

</span> === Overriding Phases

 To override the automatic MacPorts installation phase processing, define your own installation phases as shown in this example.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -297,7 +295,7 @@ destroot {

</span> }

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_development.examples.eliminate]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[development.examples.eliminate]]

</span> === Eliminating Phases

 To eliminate a default phase, simply define a phase with no contents as shown.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -309,12 +307,12 @@ build {}

</span> 

 [NOTE]

 ====

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Because many software packages do not use [option]``configure``, a keyword is provided to eliminate the [option]``configure`` phase.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Another exception is the [option]``destroot`` phase may not be eliminated.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-See the chapter <<_reference,Portfile Reference>> for full information.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Because many software packages do not use ``configure``, a keyword is provided to eliminate the `configure` phase.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Another exception is the `destroot` phase may not be eliminated.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+See the chapter <<reference,Portfile Reference>> for full information.

</span> ====

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_development.examples.startupitem]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[development.examples.startupitem]]

</span> === Creating a StartupItem

 Startupitems may be placed in the global section of a Portfile.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -326,14 +324,13 @@ startupitem.name        nmicmpd

</span> startupitem.executable  "${prefix}/bin/nmicmpd"

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_development.variants]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[development.variants]]

</span> == Port Variants

 Variants are a way for port authors to provide options that may be invoked at install time.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-They are declared in the global section of a Portfile using the "`variant`" keyword, and should include <<_reference.variants.descriptions,carefully chosen variant

<span style='display:block; white-space:pre;background:#ffe0e0;'>-    descriptions>>.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+They are declared in the global section of a Portfile using the "`variant`" keyword, and should include <<reference.variants.descriptions,carefully chosen variant descriptions>>.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_development.variants.options]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[development.variants.options]]

</span> === Example Variants

 The most common actions for user-selected variants is to add or remove dependencies, configure arguments, and build arguments according to various options a port author wishes to provide.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -395,7 +392,7 @@ variant x11 description {Builds port as an X11 program with Lucid widgets} {

</span> }

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_development.variants.phase]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[development.variants.phase]]

</span> === Variant Actions in a Phase

 If a variant requires options in addition to those provided by keywords using -append and/or -delete, in other words, any actions that would normally take place within a port installation phase, do not try to do this within the variant declaration.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -415,7 +412,7 @@ post-destroot {

</span> }

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_development.variants.default]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[development.variants.default]]

</span> === Default Variants

 Variants are used to specify actions that lie outside the core functions of an application or port, but there may be some cases where you wish to specify these non-core functions by default.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -431,12 +428,12 @@ default_variants    +foo +bar

The default_variant keyword may only be used in the global Portfile section.

 ====

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_development.patches]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[development.patches]]

</span> == Patch Files

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Patch files are files created with the Unix command `diff` that are applied using the command `patch` to modify text files to fix bugs or extend functionality.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Patch files are files created with the Unix command [cmd]``diff`` that are applied using the command [cmd]``patch`` to modify text files to fix bugs or extend functionality.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_development.patches.portfile]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[development.patches.portfile]]

</span> === Creating Portfile Patches

 If you wish to contribute modifications or fixes to a Portfile, you should do so in the form of a patch.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -450,7 +447,7 @@ Follow the steps below to create Portfile patch files

</span> %% cp -p Portfile Portfile.orig

 ----

 . Edit the file to make it as you want it to be after it is fetched.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-. Now use the Unix command ``diff -u ``to create a "`unified`" diff patch file. Put the name of the port in the patchfile, for example, Portfile-rrdtool.diff.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+. Now use the Unix command [cmd]``diff -u ``to create a "`unified`" diff patch file. Put the name of the port in the patchfile, for example, Portfile-rrdtool.diff.

</span> +

 [source]

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -486,14 +483,14 @@ Follow the steps below to create Portfile patch files

</span> 

 Now you may attach the patch file to a MacPorts Trac ticket for the port author to evaluate.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_development.patches.source]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[development.patches.source]]

</span> === Creating Source Code Patches

 Necessary or useful patches to application source code should generally be sent to the application developer rather than the port author so the modifications may be included in the next version of the application.

 Generally speaking, you should create one patch file for each logical change that needs to be applied.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Patchfile filenames should uniquely distinguish the file and generally be of the form [path]_patch-_[replaceable]``<identifier>``[path]_.diff_, where the [replaceable]``identifier`` is a reference to the problem or bug it is supposed to solve.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-An example filename would be [path]_patch-_[replaceable]``destdir-variable-fix``[path]_.diff_.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Patchfile filenames should uniquely distinguish the file and generally be of the form [path]`patch-```<identifier>``[path]`.diff`, where the `identifier` is a reference to the problem or bug it is supposed to solve.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+An example filename would be [path]`patch-```destdir-variable-fix``[path]`.diff`.

</span> 

 To create a patch to modify a single file, follow the steps below.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -506,7 +503,7 @@ To create a patch to modify a single file, follow the steps below.

</span> %% cp -p Makefile.in Makefile.in.orig

 ----

 . Edit the file and modify the text to reflect your corrections.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-. Now `cd` to the top-level directory of the unpacked source, and use the Unix command `diff -u` to create a "`unified`" diff patch file.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+. Now [cmd]``cd`` to the top-level directory of the unpacked source, and use the Unix command [cmd]``diff -u`` to create a "`unified`" diff patch file.

</span> +

 [source]

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -515,15 +512,14 @@ To create a patch to modify a single file, follow the steps below.

</span> %% diff -u src/Makefile.in.orig src/Makefile.in > patch-destdir-variable-fix.diff

 ----

 +

<span style='display:block; white-space:pre;background:#ffe0e0;'>-You should execute `diff` from the top-level directory of the unpacked source code, because during the patch phase MacPorts by default uses the patch argument [option]``-p0``, which does not strip prefixes with any leading slashes from file names found in the patch file (as opposed to [option]``-p1`` that strips one, etc), and any path not relative to the top-level directory of the unpacked source will fail during the patch phase.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+You should execute [cmd]``diff`` from the top-level directory of the unpacked source code, because during the patch phase MacPorts by default uses the patch argument ``-p0``, which does not strip prefixes with any leading slashes from file names found in the patch file (as opposed to `-p1` that strips one, etc), and any path not relative to the top-level directory of the unpacked source will fail during the patch phase.

</span> +

 [NOTE]

 ====

<span style='display:block; white-space:pre;background:#ffe0e0;'>-If you find an existing source file patch you wish to use that contains leading path information (diff was executed from a directory higher than the top-level source directory), you will need to use the <<_reference.phases.patch,patch phase

<span style='display:block; white-space:pre;background:#ffe0e0;'>-            keyword>>``patch.pre_args`` to specify a [option]``-px`` value for how many prefixes with leading slashes are to be stripped off.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+If you find an existing source file patch you wish to use that contains leading path information (diff was executed from a directory higher than the top-level source directory), you will need to use the <<reference.phases.patch,patch phase keyword>>``patch.pre_args`` to specify a `-px` value for how many prefixes with leading slashes are to be stripped off.

</span> ====

<span style='display:block; white-space:pre;background:#ffe0e0;'>-. A patch file that is a "`unified`" diff file is the easiest to interpret by humans and this type should always be used for ports. See the example below where a patch adds [var]``DESTDIR`` support to [path]_Makefile.in_.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+. A patch file that is a "`unified`" diff file is the easiest to interpret by humans and this type should always be used for ports. See the example below where a patch adds `DESTDIR` support to [path]`Makefile.in`.

</span> +

 [source]

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -540,7 +536,7 @@ If you find an existing source file patch you wish to use that contains leading

</span> -       cp $(TEXT) $(INSTALL_LIB)/

 +       cp $(TEXT) $(DESTDIR)$(INSTALL_LIB)/

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-. Place the patch [path]_patch-destdir-variable-fix.diff_ in the directory [path]_${portpath}/files_ and use it in a port using the `patchfiles` keyword. [var]``${portpath}`` may be in a local Portfile repository during development, or [path]_files/_ may be in a port's [var]``${portpath}`` in the global MacPorts repository.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+. Place the patch [path]`patch-destdir-variable-fix.diff` in the directory [path]`${portpath}/files` and use it in a port using the `patchfiles` keyword. `${portpath}` may be in a local Portfile repository during development, or [path]`files/` may be in a port's `${portpath}` in the global MacPorts repository.

</span> +

 [source]

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -549,7 +545,7 @@ patchfiles          patch-destdir-variable-fix.diff

</span> ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_development.patches.applying]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[development.patches.applying]]

</span> === Manually Applying Patches

 MacPorts applies patch files automatically, but you may want to know how to apply patch files manually if you want to test patch files you have created or you wish to apply uncommitted Portfile patches.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -575,13 +571,13 @@ patching file Portfile

</span> ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_development.local_repositories]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[development.local-repositories]]

</span> == Local Portfile Repositories

 To create and test Portfiles that are not yet published in the MacPorts ports tree, you may create a local Portfile repository as shown.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Replace the hypothetical user [path]_julesverne_ with your username in the example below.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Replace the hypothetical user [path]`julesverne` with your username in the example below.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-. Open [path]_sources.conf_ in a text editor. For example, to open it into TextEdit:

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+. Open [path]`sources.conf` in a text editor. For example, to open it into TextEdit:

</span> +

 [source]

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -600,7 +596,7 @@ rsync://rsync.macports.org/macports/release/tarballs/ports.tar [default]

</span> 

 [NOTE]

 ====

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The file URL should always appear before the rsync URL so that local Portfiles can be tested that are duplicated in the MacPorts tree, because `port` will always operate on the first Portfile it encounters.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+The file URL should always appear before the rsync URL so that local Portfiles can be tested that are duplicated in the MacPorts tree, because [cmd]``port`` will always operate on the first Portfile it encounters.

</span> ====

 . Place the Portfiles you create inside a directory whose name matches the port, which should in turn be placed inside a directory that reflects the port's primary category (the first category entry in the Portfile). For example, to create the directory for a hypothetical port "`bestevergame`" and to begin editing its Portfile in TextEdit, you can use these commands:

 +

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -615,8 +611,8 @@ The file URL should always appear before the rsync URL so that local Portfiles c

</span> +

 See other sections in the Guide for help writing Portfiles.

 If you've already written the Portfile elsewhere, you can instead copy the Portfile into this directory.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-. If your Portfile needs to apply any patches to the port's source files, create a [path]_files_ directory and place the patchfiles in it, and reference the patchfiles in your Portfile, as explained in <<_development.patches.source,Creating Source Code Patches>>.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-. After you create or update your Portfile, use `portindex` in the local repository's directory to create or update the index of the ports in your local repository.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+. If your Portfile needs to apply any patches to the port's source files, create a [path]`files` directory and place the patchfiles in it, and reference the patchfiles in your Portfile, as explained in <<development.patches.source,Creating Source Code Patches>>.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+. After you create or update your Portfile, use [cmd]``portindex`` in the local repository's directory to create or update the index of the ports in your local repository.

</span> +

 [source]

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -635,7 +631,7 @@ Ports successfully parsed:      1

</span> Ports failed:                   0

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Once the local port is added to the [path]_PortIndex_, it becomes available for searching or installation as with any other Portfile in the MacPorts tree:

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+Once the local port is added to the [path]`PortIndex`, it becomes available for searching or installation as with any other Portfile in the MacPorts tree:

</span> 

 [source]

 ----

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -647,13 +643,13 @@ bestevergame @1.1 (games)

</span>     The Best Ever Game

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_development.practices]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[development.practices]]

</span> == Portfile Best Practices

 This section contains practical guidelines for creating Portfiles that install smoothly and provide consistency between ports.

 The following sections are on the TODO list.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_development.practices.portstyle]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[development.practices.portstyle]]

</span> === Port Style

 Portfiles may be thought of as a set of declarations rather than a piece of code.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -710,27 +706,27 @@ destroot.keepdirs    ${destroot}${prefix}/var/run \

</span>                      ${destroot}${prefix}/var/cache/mrtg

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_development.practices.dont_overwrite]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[development.practices.dont-overwrite]]

</span> === Don't Overwrite Config Files

 TODO:

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_development.practices.install_docs]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[development.practices.install-docs]]

</span> === Install Docs and Examples

 TODO:

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_development.practices.provide_messages]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[development.practices.provide-messages]]

</span> === Provide User Messages

 TODO:

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_development.practices.use_variables]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[development.practices.use-variables]]

</span> === Use Variables

 TODO: Set variables so changing paths may be done in one place; use them anytime it makes updates simpler: distname ${name}-src-${version}

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_development.practices.rename_replace_port]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[development.practices.rename-replace-port]]

</span> === Renaming or replacing a port

 If there is the need to replace a port with another port or a renaming is necessary for some reason, the port should be marked as ``replaced_by``.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -740,7 +736,7 @@ This port had been used for testing new versions of skrooge, but it turned out t

</span> 

 At the end of this section the use of the obsolete PortGroup is suggested as an even shorter approach to the below described workflow.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_development.replaced_by]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[development.replaced_by]]

</span> ==== The long way

 Skrooge's original devel port file looked like this:

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -919,7 +915,7 @@ Error: Status 1 encountered during processing.

</span> To report a bug, see <https://guide.macports.org/#project.tickets>

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_development.obsolete_portgroup]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[development.obsolete-portgroup]]

</span> ==== The shortcut: PortGroup obsolete

 Using the PortGroup obsolete makes the task described in the previous subsection much easier:

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -942,33 +938,33 @@ categories          kde finance

</span> 

 The PortGroup defines a number of reasonable defaults for a port that is only there to inform users that they should uninstall it and install something else instead.

 You might want to override some of the defaults though.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-For details have a look at the PortGroup's source code in [path]_${prefix}/var/macports/sources/rsync.macports.org/macports/release/tarballs/ports/_resources/port1.0/group/obsolete-1.0.tcl_.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+For details have a look at the PortGroup's source code in [path]`${prefix}/var/macports/sources/rsync.macports.org/macports/release/tarballs/ports/_resources/port1.0/group/obsolete-1.0.tcl`.

</span> 

 [NOTE]

 ====

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[var]``replaced_by`` can be specified before or after the [var]``PortGroup`` line.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+`replaced_by` can be specified before or after the `PortGroup` line.

</span> ====

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_development.practices.removing_port]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[development.practices.removing-port]]

</span> === Removing a port

<span style='display:block; white-space:pre;background:#ffe0e0;'>-If a port has to be removed from MacPorts one should consider the hints concerning replacing it by some alternative port given <<_development.practices.rename_replace_port,above>>.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+If a port has to be removed from MacPorts one should consider the hints concerning replacing it by some alternative port given <<development.practices.rename-replace-port,above>>.

</span> It is recommended to wait one year before the port directory is actually removed from the MacPorts ports tree. 

 If there is no replacement for a port, it can simply be deleted immediately.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_development.buildbot]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[development.buildbot]]

</span> == MacPorts' buildbot

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The link:buildbot is a port build service which builds ports using the MacPorts Buildbot (link:MPBB) scripts.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+The https://build.macports.org/[buildbot] is a port build service which builds ports using the MacPorts Buildbot (https://github.com/macports/mpbb[MPBB]) scripts.

</span> 

 Every time a maintainer commits changes to MacPorts' ports Git repository the buildbot will check whether a rebuild of the corresponding port(s) would be necessary.

 If the port(s) in question are distributable their binary archives will be kept for subsequent distribution for all versions of the Mac operating system for which build machines are available.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-See the link:list

<span style='display:block; white-space:pre;background:#ffe0e0;'>-        of builders to find out which platforms these currently are.

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+See the https://build.macports.org/builders[list

<span style='display:block; white-space:pre;background:#e0ffe0;'>+        of builders] to find out which platforms these currently are.

</span> 

 If a build error occurred for a port its maintainer will be informed via an email so that problems which did not surface on the maintainer's machine will not go unnoticed.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Port maintainers will find the link:waterfall and the link:builders views most useful since they give information about the build status and offer the possibility to build one's port(s) on specific builders.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Port maintainers will find the https://build.macports.org/waterfall[waterfall] and the https://build.macports.org/builders[builders] views most useful since they give information about the build status and offer the possibility to build one's port(s) on specific builders.

</span> 

 Thus the buildbot helps to keep MacPorts consistent on various macOS versions, i.e., a maintainer does not need access to these versions anymore in order to assure that the port(s) maintained build without problems.

 Currently only the default port variants will be built and kept.

\ No newline at end of file

<span style='display:block; white-space:pre;color:#808080;'>diff --git a/guide/adoc/portfileref.adoc b/guide/adoc/portfileref.adoc

</span><span style='display:block; white-space:pre;color:#808080;'>index 10703d3..e2d9c3f 100644

</span><span style='display:block; white-space:pre;background:#e0e0ff;'>--- a/guide/adoc/portfileref.adoc

</span><span style='display:block; white-space:pre;background:#e0e0ff;'>+++ b/guide/adoc/portfileref.adoc

</span><span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1,77 +1,111 @@

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference]]

</span> = Portfile Reference

 :doctype: book

 :sectnums:

 :toc: left

 :icons: font

 :experimental:

<span style='display:block; white-space:pre;background:#e0ffe0;'>+:idprefix:

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+:idseparator: -

</span> :sourcedir: .

 This chapter serves as a reference for the major elements of a Portfile: port phases, dependencies, StartupItems, variables, keywords, and Tcl extensions.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-:leveloffset: 1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+:leveloffset: +1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+

</span> include::portfile-keywords.adoc[]

<span style='display:block; white-space:pre;background:#ffe0e0;'>-:leveloffset: 0

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-:leveloffset: 1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+:leveloffset: -1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+:leveloffset: +1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+

</span> include::portfile-variables.adoc[]

<span style='display:block; white-space:pre;background:#ffe0e0;'>-:leveloffset: 0

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-:leveloffset: 1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+:leveloffset: -1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+:leveloffset: +1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+

</span> include::portfile-phase.adoc[]

<span style='display:block; white-space:pre;background:#ffe0e0;'>-:leveloffset: 0

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-:leveloffset: 1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+:leveloffset: -1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+:leveloffset: +1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+

</span> include::portfile-dependencies.adoc[]

<span style='display:block; white-space:pre;background:#ffe0e0;'>-:leveloffset: 0

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-:leveloffset: 1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+:leveloffset: -1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+:leveloffset: +1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+

</span> include::portfile-variants.adoc[]

<span style='display:block; white-space:pre;background:#ffe0e0;'>-:leveloffset: 0

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-:leveloffset: 1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+:leveloffset: -1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+:leveloffset: +1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+

</span> include::portfile-tcl.adoc[]

<span style='display:block; white-space:pre;background:#ffe0e0;'>-:leveloffset: 0

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-:leveloffset: 1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+:leveloffset: -1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+:leveloffset: +1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+

</span> include::portfile-startupitem.adoc[]

<span style='display:block; white-space:pre;background:#ffe0e0;'>-:leveloffset: 0

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-:leveloffset: 1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+:leveloffset: -1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+:leveloffset: +1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+

</span> include::portfile-livecheck.adoc[]

<span style='display:block; white-space:pre;background:#ffe0e0;'>-:leveloffset: 0

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.portgroup]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+:leveloffset: -1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.portgroup]]

</span> == PortGroups

<span style='display:block; white-space:pre;background:#ffe0e0;'>-:leveloffset: 2

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+:leveloffset: +1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+

</span> include::portgroups.adoc[]

<span style='display:block; white-space:pre;background:#ffe0e0;'>-:leveloffset: 0

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-:leveloffset: 2

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+:leveloffset: -1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+:leveloffset: +1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+

</span> include::portgroup-github.adoc[]

<span style='display:block; white-space:pre;background:#ffe0e0;'>-:leveloffset: 0

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-:leveloffset: 2

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+:leveloffset: -1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+:leveloffset: +1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+

</span> include::portgroup-gnustep.adoc[]

<span style='display:block; white-space:pre;background:#ffe0e0;'>-:leveloffset: 0

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-:leveloffset: 2

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+:leveloffset: -1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+:leveloffset: +1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+

</span> include::portgroup-haskell.adoc[]

<span style='display:block; white-space:pre;background:#ffe0e0;'>-:leveloffset: 0

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-:leveloffset: 2

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+:leveloffset: -1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+:leveloffset: +1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+

</span> include::portgroup-perl.adoc[]

<span style='display:block; white-space:pre;background:#ffe0e0;'>-:leveloffset: 0

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-:leveloffset: 2

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+:leveloffset: -1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+:leveloffset: +1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+

</span> include::portgroup-python.adoc[]

<span style='display:block; white-space:pre;background:#ffe0e0;'>-:leveloffset: 0

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-:leveloffset: 2

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+:leveloffset: -1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+:leveloffset: +1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+

</span> include::portgroup-ruby.adoc[]

<span style='display:block; white-space:pre;background:#ffe0e0;'>-:leveloffset: 0

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-:leveloffset: 2

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+:leveloffset: -1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+:leveloffset: +1

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+

</span> include::portgroup-xcode.adoc[]

<span style='display:block; white-space:pre;background:#ffe0e0;'>-:leveloffset: 0

</span>\ No newline at end of file

<span style='display:block; white-space:pre;background:#e0ffe0;'>+

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+:leveloffset: -1

</span>\ No newline at end of file

<span style='display:block; white-space:pre;color:#808080;'>diff --git a/guide/adoc/portgroup-github.adoc b/guide/adoc/portgroup-github.adoc

</span><span style='display:block; white-space:pre;color:#808080;'>index 2780e76..6434d85 100644

</span><span style='display:block; white-space:pre;background:#e0e0ff;'>--- a/guide/adoc/portgroup-github.adoc

</span><span style='display:block; white-space:pre;background:#e0e0ff;'>+++ b/guide/adoc/portgroup-github.adoc

</span><span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1,9 +1,9 @@

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.portgroup.github]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.portgroup.github]]

</span> = PortGroup github

 The `github` portgroup allows for efficient porting of software hosted on GitHub.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.portgroup.github.description]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.portgroup.github.description]]

</span> == Description

 This portgroup greatly simplifies the porting of software hosted on GitHub.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -16,7 +16,7 @@ The `github` portgroup is indeed capable of configuring, amongst other things:

* The `livecheck` parameters.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.portgroup.github.setup]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.portgroup.github.setup]]

</span> == Setting up the GitHub repository coordinates

 The main port configuration is triggered by the usage of the `github.setup` keyword: 

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -38,19 +38,19 @@ If, for example, the project uses tags such as ``v1.0.0``, then the `tag_prefix`

</span> github.setup        author project version v

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.portgroup.github.distfilestrategy]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.portgroup.github.distfilestrategy]]

</span> == Choosing a distfile strategy

 GitHub, and as a consequence the `github` portgroup, offers multiple mechanisms to get a distfile: 

 * Distfile from a `git` commit or tag.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* Distfile from a GitHub link:release. 

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-* Distfile from a GitHub link:download. 

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* Distfile from a GitHub https://github.com/blog/1547-release-your-software[release]. 

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* Distfile from a GitHub https://github.com/blog/1302-goodbye-uploads[download]. 

</span> 

 The default behaviour of the portgroup is using GitHub automatically generated distfile from a `git` commit or tag.

 However, the best practice should be using a GitHub release. 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.portgroup.github.distfile]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.portgroup.github.distfile]]

</span> == Distfile from tag or commit

 The default behaviour of the `github` portgroup is leveraging GitHub's ability to create a distfile from a `git` tag or commit.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -68,7 +68,7 @@ github.setup        someone someproject 0ff25277c3842598d919cd3c73d60768

</span> version             20140401

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.portgroup.github.releases]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.portgroup.github.releases]]

</span> == Distfile from a GitHub release

 The `github` portgroup allows maintainers to easily configure the distfiles when the project uses GitHub releases.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -87,10 +87,10 @@ distname            ${github.project}-${github.version}

</span> ----

 However, GitHub does not enforce any rule for release distfiles, so port maintainers may need to override the `distname` as they would do for other ports. 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.portgroup.github.downloads]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.portgroup.github.downloads]]

</span> == Distfile from a GitHub download

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Older projects use the discontinued link:downloads service.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Older projects use the discontinued https://github.com/blog/1302-goodbye-uploads[downloads] service.

</span> New GitHub downloads can no longer be created, but old ones are still available. 

 If the project doesn't have GitHub releases but does have GitHub downloads, they can be used using the following keyword: 

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -101,7 +101,7 @@ github.tarball_from downloads

</span> ----

 Since GitHub doesn't enforce any naming rules for downloads, the portgroup can only provide a sensible default value for ``distname``, which can be overridden if necessary. 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.portgroup.github.submodule]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.portgroup.github.submodule]]

</span> == Using repositories with git submodules

 If the project uses `git` submodules, some projects' tag- or commit-based distfiles will not contain all the necessary files.

<span style='display:block; white-space:pre;color:#808080;'>diff --git a/guide/adoc/portgroup-gnustep.adoc b/guide/adoc/portgroup-gnustep.adoc

</span><span style='display:block; white-space:pre;color:#808080;'>index 45127f8..4e00761 100644

</span><span style='display:block; white-space:pre;background:#e0e0ff;'>--- a/guide/adoc/portgroup-gnustep.adoc

</span><span style='display:block; white-space:pre;background:#e0e0ff;'>+++ b/guide/adoc/portgroup-gnustep.adoc

</span><span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1,10 +1,10 @@

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.portgroup.gnustep]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.portgroup.gnustep]]

</span> = PortGroup gnustep

 PortGroup gnustep allows for efficient porting of GNUstep-based open source software using the GNU objective-C runtime that defines options for the configuration, build, and destroot phases, and also defines some values for GNUstep-based software.

 A minimum Portfile using the gnustep PortGroup class need only define the fetch and the checksum phases.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.portgroup.gnustep.portgroup_keywords]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.portgroup.gnustep.portgroup-keywords]]

</span> == gnustep PortGroup Specific Keywords

 Portfiles using the gnustep PortGroup allow for port authors to set the following keywords in addition to the general Portfile keywords.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -53,7 +53,7 @@ Enabling this variant builds and installs the included documentation.

</span> %% port install gnustep-gui +with_docs

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.portgroup.gnustep.filesystem_keywords]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.portgroup.gnustep.filesystem-keywords]]

</span> == gnustep FilesystemLayout Keywords

 PortGroup gnustep supports both the traditional gnustep file layout and the new fhs file layout.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -75,7 +75,7 @@ Sets GNUSTEP_SYSTEM_LIBRARY according to the FilesystemLayout

</span> set_local_library::

 Sets GNUSTEP_LOCAL_LIBRARY according to the FilesystemLayout

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.portgroup.gnustep.sugar]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.portgroup.gnustep.sugar]]

</span> == gnustep PortGroup Sugar

 Portfiles using PortGroup gnustep do not need to define the following variables:

<span style='display:block; white-space:pre;color:#808080;'>diff --git a/guide/adoc/portgroup-haskell.adoc b/guide/adoc/portgroup-haskell.adoc

</span><span style='display:block; white-space:pre;color:#808080;'>index 4bb3735..d6864bd 100644

</span><span style='display:block; white-space:pre;background:#e0e0ff;'>--- a/guide/adoc/portgroup-haskell.adoc

</span><span style='display:block; white-space:pre;background:#e0e0ff;'>+++ b/guide/adoc/portgroup-haskell.adoc

</span><span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1,9 +1,9 @@

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.portgroup.haskell]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.portgroup.haskell]]

</span> = PortGroup haskell

 PortGroup haskell simplifies the addition of Haskell packages.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.portgroup.haskell.keywords]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.portgroup.haskell.keywords]]

</span> == haskell PortGroup Specific Keywords

 Portfiles using the haskell PortGroup allow for port authors to set the following keywords in addition to the general Portfile keywords.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -21,7 +21,7 @@ This keyword sets a number of port variables.

</span> haskell.setup   digest 0.0.0.2

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.portgroup.haskell.sugar]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.portgroup.haskell.sugar]]

</span> == haskell PortGroup Sugar

 Portfiles using PortGroup haskell do not need to define the following variables:

<span style='display:block; white-space:pre;color:#808080;'>diff --git a/guide/adoc/portgroup-perl.adoc b/guide/adoc/portgroup-perl.adoc

</span><span style='display:block; white-space:pre;color:#808080;'>index 49ec4d9..a267a33 100644

</span><span style='display:block; white-space:pre;background:#e0e0ff;'>--- a/guide/adoc/portgroup-perl.adoc

</span><span style='display:block; white-space:pre;background:#e0e0ff;'>+++ b/guide/adoc/portgroup-perl.adoc

</span><span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1,9 +1,9 @@

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.portgroup.perl]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.portgroup.perl]]

</span> = PortGroup perl5

 PortGroup perl5 allows for efficient porting of perl modules and other perl open source software.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.portgroup.perl.keywords]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.portgroup.perl.keywords]]

</span> == perl5 PortGroup Specific Keywords

 Portfiles using the perl5 PortGroup allow for port authors to set the following keywords in addition to the general Portfile keywords.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -33,7 +33,7 @@ Use this keyword if a module must be built using Module::Build instead.

</span> perl5.use_module_build

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.portgroup.perl.sugar]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.portgroup.perl.sugar]]

</span> == perl5 PortGroup Sugar

 Portfiles using PortGroup perl5 do not need to define the following variables:

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -50,7 +50,7 @@ Default: perl5.26

</span> use_configure::

 Default: no

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.portgroup.perl.variables]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.portgroup.perl.variables]]

</span> == perl5 PortGroup Specific Variables

 When the perl5 PortGroup is declared within a Portfile, the following variables are provided during port install.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -59,7 +59,7 @@ perl5.version::

The MacPorts Perl version.

 perl5.bin::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The Perl binary path (i.e., [path]_${prefix}/bin/perl_).

<span style='display:block; white-space:pre;background:#e0ffe0;'>+The Perl binary path (i.e., [path]`${prefix}/bin/perl`).

</span> 

 perl5.lib::

 Path to the Perl vendor directory.

<span style='display:block; white-space:pre;color:#808080;'>diff --git a/guide/adoc/portgroup-python.adoc b/guide/adoc/portgroup-python.adoc

</span><span style='display:block; white-space:pre;color:#808080;'>index 9b364d8..0acb532 100644

</span><span style='display:block; white-space:pre;background:#e0e0ff;'>--- a/guide/adoc/portgroup-python.adoc

</span><span style='display:block; white-space:pre;background:#e0e0ff;'>+++ b/guide/adoc/portgroup-python.adoc

</span><span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1,9 +1,9 @@

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.portgroup.python]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.portgroup.python]]

</span> = PortGroup python

 PortGroup python allows for efficient porting of python-based open source software.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.portgroup.python.keywords]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.portgroup.python.keywords]]

</span> == python PortGroup Specific Keywords

 Portfiles using the python PortGroup allow for port authors to set the following keywords in addition to the general Portfile keywords.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -43,7 +43,7 @@ python.default_version     32

</span> ----

 python.link_binaries::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-When "`yes`" (the default), tells the PortGroup to automatically link any executable binaries installed in the bin/ directory within the framework into [path]_${prefix}/bin_.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+When "`yes`" (the default), tells the PortGroup to automatically link any executable binaries installed in the bin/ directory within the framework into [path]`${prefix}/bin`.

</span> 

 * Type: optional

 * Example:

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -55,11 +55,11 @@ python.link_binaries     no

</span> ----

 python.link_binaries_suffix::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Suffix to add to the names of the links created in [path]_${prefix}/bin_ when [var]``${python.link_binaries}`` is enabled.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Suffix to add to the names of the links created in [path]`${prefix}/bin` when `${python.link_binaries}` is enabled.

Can be cleared if no suffix is desired.

 * Type: optional

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* Default: -[var]``${python.branch}``

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* Default: -``${python.branch}``

</span> 

 python.add_archflags::

 When yes (the default), the PortGroup will automatically try to pass the correct arch-specific flags during build time (via the standard CFLAGS, LDFLAGS, etc environment variables). Set this to "`no`" and set up those variables in `build.env` manually if the default does not work.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -73,7 +73,7 @@ When yes (the default), the PortGroup will automatically try to pass the correct

</span> python.add_archflags     no

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.portgroup.python.variables]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.portgroup.python.variables]]

</span> == python PortGroup Specific Variables

 When the python PortGroup is declared within a Portfile, the following variables are provided.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -88,25 +88,25 @@ For example, if `python.version` is "`26`", `python.branch` will be "`2.6`".

</span> 

 python.prefix::

 The prefix in which the current python version is installed.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-For framework builds, this is [path]_${frameworks_dir}/Python.framework/Versions/${python.branch}_, whereas for non-framework builds, it is the same as [var]``${prefix}``.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+For framework builds, this is [path]`${frameworks_dir}/Python.framework/Versions/${python.branch}`, whereas for non-framework builds, it is the same as ``${prefix}``.

</span> 

 python.bin::

 The path to the MacPorts Python executable.

 python.lib::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The Python dynamic library path, i.e., [path]_${python.prefix}/Python_ (framework builds) or [path]_${prefix}/lib/libpython2.4.dylib_ (python24).

<span style='display:block; white-space:pre;background:#e0ffe0;'>+The Python dynamic library path, i.e., [path]`${python.prefix}/Python` (framework builds) or [path]`${prefix}/lib/libpython2.4.dylib` (python24).

</span> 

 python.libdir::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The path to python's lib directory, i.e., [path]_${python.prefix}/lib/python${python.branch}_.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+The path to python's lib directory, i.e., [path]`${python.prefix}/lib/python${python.branch}`.

</span> 

 python.include::

 Path to the Python include directory.

 python.pkgd::

 Path to the Python site-packages directory.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-(i.e., [path]_${python.prefix}/lib/python${python.branch}/site-packages_).

<span style='display:block; white-space:pre;background:#e0ffe0;'>+(i.e., [path]`${python.prefix}/lib/python${python.branch}/site-packages`).

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.portgroup.python.sugar]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.portgroup.python.sugar]]

</span> == python PortGroup Sugar

 Portfiles using PortGroup python do not need to define the following variables:

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -115,22 +115,22 @@ categories::

</span> Default: python

 depends_lib::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Default: port:python[var]``${python.version}``

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+Default: port:python``${python.version}``

</span> 

 use_configure::

 Default: no

 build.cmd::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Default: [var]``${python.bin}`` setup.py --no-user-cfg

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+Default: `${python.bin}` setup.py --no-user-cfg

</span> 

 build.target::

 Default: build

 destroot.cmd::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Default: [var]``${python.bin}`` setup.py --no-user-cfg

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+Default: `${python.bin}` setup.py --no-user-cfg

</span> 

 destroot.destdir::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Default: --prefix=[var]``${python.prefix}`` --root=[var]``${destroot}``

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+Default: --prefix=``${python.prefix}`` --root=``${destroot}``

</span> 

 pre-destroot::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Default: creates directory [path]_${destroot}${prefix}/share/doc/${subport}/examples_.

</span>\ No newline at end of file

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Default: creates directory [path]`${destroot}${prefix}/share/doc/${subport}/examples`.

</span>\ No newline at end of file

<span style='display:block; white-space:pre;color:#808080;'>diff --git a/guide/adoc/portgroup-ruby.adoc b/guide/adoc/portgroup-ruby.adoc

</span><span style='display:block; white-space:pre;color:#808080;'>index 3f9845c..48b0dfb 100644

</span><span style='display:block; white-space:pre;background:#e0e0ff;'>--- a/guide/adoc/portgroup-ruby.adoc

</span><span style='display:block; white-space:pre;background:#e0e0ff;'>+++ b/guide/adoc/portgroup-ruby.adoc

</span><span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1,9 +1,9 @@

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.portgroup.ruby]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.portgroup.ruby]]

</span> = PortGroup ruby

 PortGroup ruby allows for efficient porting of ruby-based open source software.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.portgroup.ruby.variables]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.portgroup.ruby.variables]]

</span> == ruby PortGroup Specific Variables

 When the ruby PortGroup is declared within a Portfile, the following variables are provided during port install.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -15,10 +15,10 @@ ruby.bin::

The Ruby binary location.

 ruby.lib::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Path to the Ruby vendorlibdir directory (i.e., [path]_${prefix}/lib/ruby/vendor_ruby/${ruby.version}_)

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+Path to the Ruby vendorlibdir directory (i.e., [path]`${prefix}/lib/ruby/vendor_ruby/${ruby.version}`)

</span> 

 ruby.arch::

 The name for the Ruby architecture-dependent directory name (i.e., ``i686-darwin8.10.1``).

 ruby.archlib::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Path to the Ruby vendor archdir (i.e., [path]_${ruby.lib}/${ruby.arch}_).

</span>\ No newline at end of file

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Path to the Ruby vendor archdir (i.e., [path]`${ruby.lib}/${ruby.arch}`).

</span>\ No newline at end of file

<span style='display:block; white-space:pre;color:#808080;'>diff --git a/guide/adoc/portgroup-xcode.adoc b/guide/adoc/portgroup-xcode.adoc

</span><span style='display:block; white-space:pre;color:#808080;'>index 28e8ba5..a459bb8 100644

</span><span style='display:block; white-space:pre;background:#e0e0ff;'>--- a/guide/adoc/portgroup-xcode.adoc

</span><span style='display:block; white-space:pre;background:#e0e0ff;'>+++ b/guide/adoc/portgroup-xcode.adoc

</span><span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1,4 +1,4 @@

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.portgroup.xcode]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.portgroup.xcode]]

</span> = PortGroup xcode

 `PortGroup xcode` allows for efficient porting of Xcode-based opensource software.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -8,13 +8,13 @@ It also defines some values for Xcode-based software.

</span> 

 Using `PortGroup xcode` is a way to make your port able to tolerate Xcode version updates because the PortGroup is tested against all supported macOS and Xcode versions.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.portgroup.xcode.keywords]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.portgroup.xcode.keywords]]

</span> == xcode PortGroup Specific Keywords

 Portfiles using `PortGroup xcode` allow for port authors to set the following keywords in addition to the general Portfile keywords.

 xcode.project::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The path relative to [var]``${build.dir}`` and [var]``${destroot.dir}`` of the Xcode project.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+The path relative to `${build.dir}` and `${destroot.dir}` of the Xcode project.

If unset, Xcode Tools should be able to determine it automatically.

 It usually succeeds if there is only a single project in the directory.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -32,7 +32,7 @@ xcode.configuration::

Project configuration/buildstyle to use.

 * Type: optional

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* Default: [option]``Deployment``

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* Default: `Deployment`

</span> * Example:

 +

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -42,7 +42,7 @@ xcode.configuration Main

</span> ----

 xcode.target::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-If present, it overrides [var]``build.target`` and [var]``destroot.target``.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+If present, it overrides `build.target` and ``destroot.target``.

</span> 

 * Type: optional

 * Default: none

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -71,10 +71,10 @@ xcode.build.settings FRAMEWORK_SEARCH_PATHS=${frameworks_dir}

</span> xcode.destroot.type::

 Type of project that will be installed.

 This tells the PortGroup xcode how to destroot the project.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Correct values are [option]``application`` and [option]``framework``.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Correct values are `application` and ``framework``.

</span> 

 * Type: optional

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* Default: [option]``application``

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* Default: `application`

</span> * Example:

 +

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -87,7 +87,7 @@ xcode.destroot.path::

Where to install the build product.

 * Type: optional

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* Default: [path]_${frameworks_dir}_ or [path]_${applications_dir}_ depending on ``xcode.destroot.type``.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+* Default: [path]`${frameworks_dir}` or [path]`${applications_dir}` depending on ``xcode.destroot.type``.

</span> 

 xcode.destroot.settings::

 Additional settings passed to the xcodebuild tool during the destroot phase.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -117,7 +117,7 @@ The argument may be an absolute path to an SDK, or the canonical name of an SDK.

</span> * Type: optional

 * Default: `${universal_sysroot}`

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.portgroup.xcode.sugar]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.portgroup.xcode.sugar]]

</span> == xcode PortGroup Sugar

 Portfiles using the PortGroup xcode do not need to define the following variables:

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -131,7 +131,7 @@ Default: macosx

</span> use_configure::

 Default: no

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.portgroup.xcode.phase_keywords]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.portgroup.xcode.phase-keywords]]

</span> == Portfile-Phase Keywords Affecting the PortGroup xcode

 The following Portfile phase keywords affect the PortGroup xcode in a unique way.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -145,20 +145,20 @@ See

</span> 

 build.cmd::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Default: [var]``${xcodebuildcmd}``.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Default: ``${xcodebuildcmd}``.

</span> 

 build.target::

 Default: ""

 +

<span style='display:block; white-space:pre;background:#ffe0e0;'>-This variable will be ignored if [var]``xcode.target`` is set.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+This variable will be ignored if `xcode.target` is set.

</span> 

 build.args::

 Default: `build`

 destroot.cmd::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Default: [var]``${xcodebuildcmd}``

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+Default: `${xcodebuildcmd}`

</span> 

 destroot.target::

 Default: ""

 +

<span style='display:block; white-space:pre;background:#ffe0e0;'>-This variable will be ignored if [var]``xcode.target`` is set.

</span>\ No newline at end of file

<span style='display:block; white-space:pre;background:#e0ffe0;'>+This variable will be ignored if `xcode.target` is set.

</span>\ No newline at end of file

<span style='display:block; white-space:pre;color:#808080;'>diff --git a/guide/adoc/portgroups.adoc b/guide/adoc/portgroups.adoc

</span><span style='display:block; white-space:pre;color:#808080;'>index e508ea1..a1c5bd8 100644

</span><span style='display:block; white-space:pre;background:#e0e0ff;'>--- a/guide/adoc/portgroups.adoc

</span><span style='display:block; white-space:pre;background:#e0e0ff;'>+++ b/guide/adoc/portgroups.adoc

</span><span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1,4 +1,4 @@

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_reference.portgroup.intro]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[reference.portgroup.intro]]

</span> = PortGroup Introduction

 PortGroups are simply include files for portfiles.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -6,7 +6,7 @@ They can define as much or as little as a portgroup author feels is necessary to

</span> 

 See the following folder for PortGroup definitions:

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[path]_${prefix}/var/macports/sources/rsync.macports.org/macports/release/tarballs/ports/_resources/port1.0/group/_

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[path]`${prefix}/var/macports/sources/rsync.macports.org/macports/release/tarballs/ports/_resources/port1.0/group/`

</span> 

 A sample listing follows:

<span style='display:block; white-space:pre;color:#808080;'>diff --git a/guide/adoc/project.adoc b/guide/adoc/project.adoc

</span><span style='display:block; white-space:pre;color:#808080;'>index 1ffb68f..aeeff72 100644

</span><span style='display:block; white-space:pre;background:#e0e0ff;'>--- a/guide/adoc/project.adoc

</span><span style='display:block; white-space:pre;background:#e0e0ff;'>+++ b/guide/adoc/project.adoc

</span><span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1,19 +1,21 @@

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_project]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[project]]

</span> = MacPorts Project

 :doctype: book

 :sectnums:

 :toc: left

 :icons: font

 :experimental:

<span style='display:block; white-space:pre;background:#e0ffe0;'>+:idprefix:

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+:idseparator: -

</span> :sourcedir: .

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_project.tickets]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[project.tickets]]

</span> == Using Trac for Tickets

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The MacPorts Project uses a system called link:Trac to file tickets to report bugs and enhancement requests.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Though anyone may search Trac for tickets, you must have a link:GitHub account in order to login to link:Trac to create tickets.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+The MacPorts Project uses a system called https://trac.macports.org/[Trac] to file tickets to report bugs and enhancement requests.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Though anyone may search Trac for tickets, you must have a https://github.com/join[GitHub account] in order to login to https://trac.macports.org/[Trac] to create tickets.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_project.tickets.prerequisites]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[project.tickets.prerequisites]]

</span> === Before Filing a New Ticket

 * Clean and try again

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -23,52 +25,41 @@ Sometimes this causes new problems, and even if it doesn't, it means that log me

Before filing a ticket, `sudo port clean` the port that failed, then try again.

 * Check the problem hotlist

 +

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The link:Problem

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Hotlist contains possible solutions to problems that affect many MacPorts users.

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+The https://trac.macports.org/wiki/ProblemHotlist[Problem

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Hotlist] contains possible solutions to problems that affect many MacPorts users.

</span> If a solution to your problem listed there works, don't file a ticket. 

 * Search to see if a Trac ticket has already been filed

 +

 Avoid filing duplicate bugs.

 Search for duplicates by: 

 ** using the search bar that appears on each page

<span style='display:block; white-space:pre;background:#ffe0e0;'>-** using link:the search page

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-** browsing the list of link:categorized reports

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-** making an advanced search by constructing a link:custom query

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+** using https://trac.macports.org/search?portsummarysearch=on[the search page]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+** browsing the list of https://trac.macports.org/report[categorized reports]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+** making an advanced search by constructing a https://trac.macports.org/query[custom query]

* Is the problem an application error and not related to compiling and installing?

 +

 In general, application bugs should be reported to the developers of the app ("`upstream`"), not MacPorts.

 An application bug that affects a large number of MacPorts users might merit a MacPorts bug for informational purposes only, but this should be done sparingly. 

 * Is the problem with a 'port upgrade' operation?

 +

<span style='display:block; white-space:pre;background:#ffe0e0;'>-If so, try a 'port uninstall [replaceable]``foo``' and then reinstall.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-You might also want to run 'port -nR upgrade --force [replaceable]``foo``' to rebuild ports depending upon port [replaceable]``foo``.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+If so, try a 'port uninstall ``foo``' and then reinstall.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+You might also want to run 'port -nR upgrade --force ``foo``' to rebuild ports depending upon port ``foo``.

Note that it is safest and recommended that most users always upgrade with 'port upgrade outdated' to update all ports at once.

 Upgrading a single port can lead to software errors in other ports that have not yet been upgraded. 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_project.tickets.creating]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[project.tickets.creating]]

</span> === Creating Trac Tickets

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Once you are logged into Trac, you may click link:New Ticket and you will be presented with a new ticket window shown in the graphic below.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Once you are logged into Trac, you may click https://trac.macports.org/newticket[New Ticket] and you will be presented with a new ticket window shown in the graphic below.

Follow the Trac ticket guidelines below to fill out the form.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-If you are reporting a failed port install and a log was mentioned in the error, please use the *>I have files to attach to this ticket* checkbox to add that log file to the ticket.

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-// <screenshot>

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-//         <info>

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-//           <title>A new Trac ticket</title>

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-//         </info>

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-// 

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-//         <mediaobject>

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-//           <textobject>

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-//             <phrase>screenshot of a new ticket on the Trac system</phrase>

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-//           </textobject>

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-//           <imageobject>

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-//             <imagedata fileref="trac-default.png"/>

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-//           </imageobject>

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-//         </mediaobject>

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-//       </screenshot>

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_project.tickets.guidelines]]

<span style='display:block; white-space:pre;background:#e0ffe0;'>+If you are reporting a failed port install and a log was mentioned in the error, please use the *I have files to attach to this ticket* checkbox to add that log file to the ticket.

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+.A new Trac ticket

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+image::trac-default.png[screenshot of a new ticket on the Trac system]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[project.tickets.guidelines]]

</span> === Trac Ticket Guidelines

 This is a short overview of the guidelines for Trac tickets.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -83,119 +74,115 @@ Please see below for longer and more detailed explanations.

</span> | Content

<span style='display:block; white-space:pre;background:#ffe0e0;'>-|**>Summary**

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+|**Summary**

</span> |

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[replaceable]``$port``[replaceable]``$version``[replaceable]``[$variants]``: [replaceable]``short

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-                      problem summary``

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+`$port```$version````[$variants]``: `short

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+                      problem summary`

</span> 

 *Example:* openssl @1.0.1e_1+universal: DTLS handshake error messages with openconnect 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-|**>Description**

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+|**Description**

</span> |

                   Describe your problem. Preformatted text (such as terminal

<span style='display:block; white-space:pre;background:#ffe0e0;'>-                  output) should be put in ``{{{[replaceable]``three curly

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+                  output) should be put in ``{{{``three curly

</span>                       brackets``}}}``. Please attach large

                   amounts of output rather than pasting. Use the preview

                   button! 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-|**>Type**

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+|**Type**

</span> |

 // <tbody>

 //                     <row>

<span style='display:block; white-space:pre;background:#ffe0e0;'>-//                       <entry><emphasis role="strong">&gt;defect</emphasis></entry>

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+//                       <entry><emphasis role="strong">defect</emphasis></entry>

</span> //                       <entry>Bugs, build failures, documentation fixes</entry>

 //                     </row>

 //                     <row>

<span style='display:block; white-space:pre;background:#ffe0e0;'>-//                       <entry><emphasis role="strong">&gt;enhancement</emphasis></entry>

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+//                       <entry><emphasis role="strong">enhancement</emphasis></entry>

</span> //                       <entry>Improving existing work</entry>

 //                     </row>

 //                     <row>

<span style='display:block; white-space:pre;background:#ffe0e0;'>-//                       <entry><emphasis role="strong">&gt;update</emphasis></entry>

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+//                       <entry><emphasis role="strong">update</emphasis></entry>

</span> //                       <entry>Update requests or patch submissions for ports</entry>

 //                     </row>

 //                     <row>

<span style='display:block; white-space:pre;background:#ffe0e0;'>-//                       <entry><emphasis role="strong">&gt;submissions</emphasis></entry>

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+//                       <entry><emphasis role="strong">submissions</emphasis></entry>

</span> //                       <entry>Submission of new <filename>Portfile</filename>s</entry>

 //                     </row>

 //                     <row>

<span style='display:block; white-space:pre;background:#ffe0e0;'>-//                       <entry><emphasis role="strong">&gt;request</emphasis></entry>

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+//                       <entry><emphasis role="strong">request</emphasis></entry>

</span> //                       <entry>Requests for new ports</entry>

 //                     </row>

 //                   </tbody>

<span style='display:block; white-space:pre;background:#ffe0e0;'>-|**>Priority**

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+|**Priority**

</span> |

<span style='display:block; white-space:pre;background:#ffe0e0;'>-                  Use *>normal* or **>low**. *>High* is reserved for MacPorts developers. 

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+                  Use *normal* or **low**. *High* is reserved for MacPorts developers. 

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-|**>Milestone**

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+|**Milestone**

|Leave empty.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-|**>Component**

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+|**Component**

</span> |

 // <tbody>

 //                     <row>

<span style='display:block; white-space:pre;background:#ffe0e0;'>-//                       <entry><emphasis role="strong">&gt;base</emphasis></entry>

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+//                       <entry><emphasis role="strong">base</emphasis></entry>

</span> //                       <entry>Tickets affecting MacPorts itself</entry>

 //                     </row>

 //                     <row>

<span style='display:block; white-space:pre;background:#ffe0e0;'>-//                       <entry><emphasis role="strong">&gt;guide</emphasis></entry>

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+//                       <entry><emphasis role="strong">guide</emphasis></entry>

</span> //                       <entry>Use for documentation</entry>

 //                     </row>

 //                     <row>

<span style='display:block; white-space:pre;background:#ffe0e0;'>-//                       <entry><emphasis role="strong">&gt;ports</emphasis></entry>

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+//                       <entry><emphasis role="strong">ports</emphasis></entry>

</span> //                       <entry>Tickets affecting specific ports. Remember to set

<span style='display:block; white-space:pre;background:#ffe0e0;'>-//                         the <emphasis role="strong">&gt;port</emphasis> field!</entry>

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+//                         the <emphasis role="strong">port</emphasis> field!</entry>

</span> //                     </row>

 //                     <row>

<span style='display:block; white-space:pre;background:#ffe0e0;'>-//                       <entry><emphasis role="strong">&gt;server/hosting</emphasis></entry>

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+//                       <entry><emphasis role="strong">server/hosting</emphasis></entry>

</span> //                       <entry>Use for infrastructure issues</entry>

 //                     </row>

 //                     <row>

<span style='display:block; white-space:pre;background:#ffe0e0;'>-//                       <entry><emphasis role="strong">&gt;website</emphasis></entry>

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+//                       <entry><emphasis role="strong">website</emphasis></entry>

</span> //                       <entry>Enhancements and fixes for the web site</entry>

 //                     </row>

 //                     <row>

<span style='display:block; white-space:pre;background:#ffe0e0;'>-//                       <entry><emphasis role="strong">&gt;wiki</emphasis></entry>

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+//                       <entry><emphasis role="strong">wiki</emphasis></entry>

</span> //                       <entry>Enhancements and fixes for the wiki (or just edit

 //                         it directly!)</entry>

 //                     </row>

 //                   </tbody>

<span style='display:block; white-space:pre;background:#ffe0e0;'>-|**>Version**

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+|**Version**

|The version of MacPorts you are running.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-|**>Keywords**

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+|**Keywords**

</span> |``maintainer`` if you are the port's

                   maintainer. `haspatch` if you are attaching

<span style='display:block; white-space:pre;background:#ffe0e0;'>-                  a patch. link:Full

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-                    list. 

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+                  a patch. https://trac.macports.org/wiki/TicketsKeywordGuidelines[Full

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+                    list]. 

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-|**>Port**

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+|**Port**

</span> |The name of the port affected by this ticket. Separate

                   multiple using spaces. Leave empty for non-port

                   tickets.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-|**>Owner**/**>Cc**

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+|**Owner**/**Cc**

</span> |Full email address or GitHub username of the port's

<span style='display:block; white-space:pre;background:#ffe0e0;'>-                  maintainer. Run `port info --maintainer [replaceable]``<portname>``` to

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-                  look this up. Do not add 

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-// <email>nomaintainer@macports.org</email>

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- or 

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-// <email>openmaintainer@macports.org</email>

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-$$.$$ For ports with

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-                  multiple maintainers, only put the first maintainer into the *>Owner* field and all others in the *>Cc* field. You do not need to Cc

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+                  maintainer. Run [cmd]``port info --maintainer ``<portname>```` to

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+                  look this up. Do not add mailto:nomaintainer@macports.org[] or mailto:openmaintainer@macports.org[]. For ports with

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+                  multiple maintainers, only put the first maintainer into the *Owner* field and all others in the *Cc* field. You do not need to Cc

yourself.

 |===

 ====

 There are certain conventions used to ensure that Trac tickets convey as much accurate information as possible so problems and contributions may be acted upon efficiently.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* *>Summary:*[replaceable]``[port]``[replaceable]``[version]``[replaceable]``[concise description]``

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* *Summary:*``[port]````[version]````[concise description]``

</span> ** Example: "rrdtool @1.2.23 +python Configure error - build failure"

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* *>Description:* All details that might be relevant to someone reading the ticket. Be sure to mention the versions of your operating system and Xcode install. link:Wiki formatting should be used to ensure that text is formatted correctly. Use the Preview button before submitting. If you want to post preformatted text such as a log or terminal output, make sure you use `{{{[replaceable]``$$...$$``}}}` around the text or it could break the page layout. Example:

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* *Description:* All details that might be relevant to someone reading the ticket. Be sure to mention the versions of your operating system and Xcode install. https://trac.macports.org/wiki/WikiFormatting[Wiki formatting] should be used to ensure that text is formatted correctly. Use the Preview button before submitting. If you want to post preformatted text such as a log or terminal output, make sure you use `{{{``$$...$$``}}}` around the text or it could break the page layout. Example:

</span> 

 ....

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -208,66 +195,61 @@ Submitters are advised to trim inline pastes and logs to what's really relevant

Long output, such as the full log from a port build, should be added as an attachment, not pasted inline.

 See [label]#I have files to attach to this

 ticket# below.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* *>Type:* There are five types of tickets.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-** *>defect* - The default; any port/MacPorts build/runtime failures and/or documentation corrections.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-** *>enhancement* - Tickets, with or without patches, created to enhance something that isn't failing its intended purpose.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-** *>update* - Tickets, with or without patches, involving updating a port to a newer upstream version.

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-** *>submission* - Tickets created to submit Portfiles for software not currently available in MacPorts. 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-** *>request* - Tickets created to request the creation of a new port.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* *>Priority:* Assign a priority level to the ticket.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-** *>High* - Reserved for the use of MacPorts team members, as they are the best fit to determine which reports warrant a higher priority over others.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-** *>Normal* - The default. For normal port failures, non-critical enhancement requests, non-critical port failures.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-** *>Low* - For mostly cosmetic improvements, documentation corrections/improvements, etc.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-** *>Not set* - Anything that doesn't fit the categories high, normal, or low.

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-* *>Milestone:* Leave this blank. MacPorts developers will set this to the version of MacPorts that contains a fix for the ticket when they commit a change. Note that this is only meaningful for changes in MacPorts itself, since changes to ports are continuously provided to users. If the milestone is *>MacPorts Future* no version of MacPorts with the fix has been released yet. 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* *>Component:* Set what part of the MacPorts Project the ticket is to be filed against.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-** *>base* - Tickets related to MacPorts base code.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-** *>guide* - Documentation enhancements and error corrections, or patches to the MacPorts Guide.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-** *>ports* - Tickets related to ports.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-** *>server/hosting* - For MacPorts hosting & server-side issues.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-** *>website* - MacPorts website enhancements and error corrections.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-** *>wiki* - MacPorts Wiki enhancements and error corrections.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* *>Version:* Select the MacPorts version you are using when it is applicable.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* *>Keywords:* Type any keywords that might help when searching for tickets. It is not useful to list words here that already appear elsewhere in the ticket. Keywords also serve as tags; for example, use "`tiger`" if reporting a bug that only affects Mac OS X 10.4, "`haspatch`" if a fix is attached to the ticket, "`maintainer`" if you are the port's maintainer, or "`LP64`" if reporting an issue that only affects 64-bit platforms.

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-+

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-See link:the

<span style='display:block; white-space:pre;background:#ffe0e0;'>-TicketsKeywordGuidelines wiki page for a clickable list of all keywords.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* *>Cc:* Anyone else besides the ticket reporter and assignee who would like to be kept involved in the development of the ticket. Multiple email addresses or GitHub usernames should be separated with a comma and a space (e.g., ``neverpanic, you@example.org, maintainer@macports.org``).

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-+

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-When reporting port-related tickets, make sure you add the port maintainers email address or GitHub username to the *>Cc:* field so they are notified of the ticket (unless you have commit access, then see [label]#Assign

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-To:# below). You can obtain the email address or GitHub username of the port maintainer by running `port info

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>---maintainers [replaceable]``[port]```

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* *>Assign To:* Only users with commit access can edit this field. If this is not you, see the section on the *>Cc* field above.

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-+

<span style='display:block; white-space:pre;background:#ffe0e0;'>-For tickets on ports, enter the email address or GitHub username of the port's maintainer (use `port info [replaceable]``[port]``` to find this). If multiple maintainers are listed, enter the first maintainer's email address or GitHub username here and enter the remaining maintainers' email addresses or GitHub usernames in the *>Cc* field.

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-Exclude the email address 

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-+

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-// <email>openmaintainer@macports.org</email>

<span style='display:block; white-space:pre;background:#ffe0e0;'>- if it appears.

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-If the maintainer's email address is 

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-// <email>nomaintainer@macports.org</email>

<span style='display:block; white-space:pre;background:#ffe0e0;'>-, leave the field blank.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* *>Port:* For tickets on ports, enter the name of the port (or ports, space-separated, when multiple are affected).

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* *>I have files to attach to this ticket:* Use this checkbox to attach files to the ticket immediately after you create it. Or you can attach files later using the *>Attach File* button.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+* *Type:* There are five types of tickets.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+** *defect* - The default; any port/MacPorts build/runtime failures and/or documentation corrections.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+** *enhancement* - Tickets, with or without patches, created to enhance something that isn't failing its intended purpose.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+** *update* - Tickets, with or without patches, involving updating a port to a newer upstream version.

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+** *submission* - Tickets created to submit Portfiles for software not currently available in MacPorts. 

<span style='display:block; white-space:pre;background:#e0ffe0;'>+** *request* - Tickets created to request the creation of a new port.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+* *Priority:* Assign a priority level to the ticket.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+** *High* - Reserved for the use of MacPorts team members, as they are the best fit to determine which reports warrant a higher priority over others.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+** *Normal* - The default. For normal port failures, non-critical enhancement requests, non-critical port failures.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+** *Low* - For mostly cosmetic improvements, documentation corrections/improvements, etc.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+** *Not set* - Anything that doesn't fit the categories high, normal, or low.

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+* *Milestone:* Leave this blank. MacPorts developers will set this to the version of MacPorts that contains a fix for the ticket when they commit a change. Note that this is only meaningful for changes in MacPorts itself, since changes to ports are continuously provided to users. If the milestone is *MacPorts Future* no version of MacPorts with the fix has been released yet. 

<span style='display:block; white-space:pre;background:#e0ffe0;'>+* *Component:* Set what part of the MacPorts Project the ticket is to be filed against.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+** *base* - Tickets related to MacPorts base code.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+** *guide* - Documentation enhancements and error corrections, or patches to the MacPorts Guide.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+** *ports* - Tickets related to ports.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+** *server/hosting* - For MacPorts hosting & server-side issues.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+** *website* - MacPorts website enhancements and error corrections.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+** *wiki* - MacPorts Wiki enhancements and error corrections.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+* *Version:* Select the MacPorts version you are using when it is applicable.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+* *Keywords:* Type any keywords that might help when searching for tickets. It is not useful to list words here that already appear elsewhere in the ticket. Keywords also serve as tags; for example, use "`tiger`" if reporting a bug that only affects Mac OS X 10.4, "`haspatch`" if a fix is attached to the ticket, "`maintainer`" if you are the port's maintainer, or "`LP64`" if reporting an issue that only affects 64-bit platforms.

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>++

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+See https://trac.macports.org/wiki/TicketsKeywordGuidelines[the

<span style='display:block; white-space:pre;background:#e0ffe0;'>+TicketsKeywordGuidelines wiki page] for a clickable list of all keywords.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+* *Cc:* Anyone else besides the ticket reporter and assignee who would like to be kept involved in the development of the ticket. Multiple email addresses or GitHub usernames should be separated with a comma and a space (e.g., ``neverpanic, you@example.org, maintainer@macports.org``).

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>++

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+When reporting port-related tickets, make sure you add the port maintainers email address or GitHub username to the *Cc:* field so they are notified of the ticket (unless you have commit access, then see [label]#Assign

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+To:# below). You can obtain the email address or GitHub username of the port maintainer by running [cmd]``port info

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+--maintainers ``[port]````

<span style='display:block; white-space:pre;background:#e0ffe0;'>+* *Assign To:* Only users with commit access can edit this field. If this is not you, see the section on the *Cc* field above.

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>++

<span style='display:block; white-space:pre;background:#e0ffe0;'>+For tickets on ports, enter the email address or GitHub username of the port's maintainer (use [cmd]``port info ``[port]```` to find this). If multiple maintainers are listed, enter the first maintainer's email address or GitHub username here and enter the remaining maintainers' email addresses or GitHub usernames in the *Cc* field.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Exclude the email address mailto:openmaintainer@macports.org[] if it appears.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+If the maintainer's email address is mailto:nomaintainer@macports.org[], leave the field blank.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+* *Port:* For tickets on ports, enter the name of the port (or ports, space-separated, when multiple are affected).

<span style='display:block; white-space:pre;background:#e0ffe0;'>+* *I have files to attach to this ticket:* Use this checkbox to attach files to the ticket immediately after you create it. Or you can attach files later using the *Attach File* button.

</span> +

 If the file you are attaching is larger than 256 KiB, please compress it with bzip2 or gzip first to save space on the server and bandwidth for those downloading it, as Trac will not preview files above that size anyway.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_project.github]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[project.github]]

</span> == Using Git and GitHub

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The MacPorts project uses the link:Git distributed version

<span style='display:block; white-space:pre;background:#ffe0e0;'>-    control system to manage the code for the entire project.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Our master repositories are hosted on link:GitHub.

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+The MacPorts project uses the https://git-scm.com/[Git distributed version

<span style='display:block; white-space:pre;background:#e0ffe0;'>+    control system] to manage the code for the entire project.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Our master repositories are hosted on https://github.com/[GitHub].

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-We maintain link:

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-      public repositories for almost all our project code and documentation, including a GitHub repository for the link:

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-        MacPorts system itself, for the link:MacPorts

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-        ports, and link:even for

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-        the guide you are reading right now. 

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+We maintain https://github.com/macports[

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+      public repositories] for almost all our project code and documentation, including a GitHub repository for the https://github.com/macports/macports-base[

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+        MacPorts system itself], for the https://github.com/macports/macports-ports[MacPorts

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+        ports], and https://github.com/macports/macports-guide[even for

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+        the guide you are reading right now]. 

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-If you're not familiar with Git and need an introduction, we recommend the book link:Pro Git, by Scott

<span style='display:block; white-space:pre;background:#ffe0e0;'>-      Chacon and Ben Straub.

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+If you're not familiar with Git and need an introduction, we recommend the book https://git-scm.com/book/en/v2[Pro Git, by Scott

<span style='display:block; white-space:pre;background:#e0ffe0;'>+      Chacon and Ben Straub].

</span> The book is available for free online, and is published under a Creative Commons license. 

 You should feel free to fork any of our code repositories, make improvements to the code, and contribute them back to us via a GitHub pull request.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -276,14 +258,14 @@ We are grateful for improvements to absolutely everything, including new ports,

</span> The main steps for submitting a pull request are: 

 . Make your changes in your own Git repository:

<span style='display:block; white-space:pre;background:#ffe0e0;'>-.. Fork the appropriate repository, say link:macports-ports.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+.. Fork the appropriate repository, say https://github.com/macports/macports-ports[macports-ports].

.. Create a branch for your changes.

 .. Make your changes.

 +

 For changes to ports and code, please follow the information elsewhere in this guide, and test your changes carefully.

 +

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Changes to Portfiles should also pass ``port lint``.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-.. Commit your changes to your branch, making sure to follow the link: MacPorts standard for commit messages.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Changes to Portfiles should also pass [cmd]``port lint``.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+.. Commit your changes to your branch, making sure to follow the https://trac.macports.org/wiki/CommitMessages[ MacPorts standard for commit messages].

.. Be sure to rebase your changes so as to minimize the number of commits. Ideally, you should have just one.

 +

 (There are exceptions.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -293,21 +275,19 @@ The point is to minimize them, ideally with one commit per logical change.)

. Make a pull request from your branch in your own git repository to the appropriate MacPorts repository.

 +

 You can do this on the appropriate GitHub page.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-For example, you can request a pull of a Portfile on link:

<span style='display:block; white-space:pre;background:#ffe0e0;'>-the macports-ports repository pull request page.

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+For example, you can request a pull of a Portfile on https://github.com/macports/macports-ports/pulls[

<span style='display:block; white-space:pre;background:#e0ffe0;'>+the macports-ports repository pull request page].

</span> . Go through the process of waiting for the CI system to build your new port, receiving feedback from our team, possibly being asked to make changes to your requested pull, and making those changes. (If you are asked for additional changes, please squish them to avoid unnecessary commits.)

 We try to process pull requests very quickly.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-If you do not see activity on your request within a few days, please feel free to get in touch with us on the 

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-// <email>macports-dev@lists.macports.org</email>

<span style='display:block; white-space:pre;background:#ffe0e0;'>- mailing list to request a review and/or commit.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+If you do not see activity on your request within a few days, please feel free to get in touch with us on the mailto:macports-dev@lists.macports.org[] mailing list to request a review and/or commit.

Please include a link to the pull request in your email.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_project.contributing]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[project.contributing]]

</span> == Contributing to MacPorts

 You may contribute new ports and enhancements of any kind to already existing ports using Trac tickets.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-However, we prefer that you open a pull request on link:GitHub, in which case no Trac ticket is required. 

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+However, we prefer that you open a pull request on https://github.com/macports/macports-ports/pulls[GitHub], in which case no Trac ticket is required. 

</span> 

 _

       The GitHub pull request method is strongly preferred over

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -316,11 +296,11 @@ _

</span>       contribution being merged into MacPorts much faster, as the

       workflow is much easier for the maintainers. _

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_project.contributing.new]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[project.contributing.new]]

</span> === New Ports

 Ports are contributed by following these steps.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-See the <<_project.tickets,Ticket Submission Guidelines>> for a description of all fields.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+See the <<project.tickets,Ticket Submission Guidelines>> for a description of all fields.

</span> 

 . Please run 

 +

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -330,27 +310,23 @@ See the <<_project.tickets,Ticket Submission Guidelines>> for a description of a

</span> ----

 where `$portname` is the name of the port you are submitting.

 Please fix any warnings and errors.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-. Either submit the new port through link:a pull request on GitHub...

<span style='display:block; white-space:pre;background:#e0ffe0;'>+. Either submit the new port through https://github.com/macports/macports-ports/pulls[a pull request on GitHub]...

. $$...$$or create a Trac ticket.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-.. Set the type to **>submission**.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-.. Set the component to **>ports**.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-.. Set the *>port* field to the name of the new port.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-.. Attach the [path]_Portfile_ and any required patchfiles to the ticket.

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-. If your ticket or pull request doesn't receive any attention within a few days you may send an email to 

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-+

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-// <email>macports-dev@lists.macports.org</email>

<span style='display:block; white-space:pre;background:#ffe0e0;'>- and request a review and/or commit.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Please include a link to the ticket or pull request.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+.. Set the type to **submission**.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+.. Set the component to **ports**.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+.. Set the *port* field to the name of the new port.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+.. Attach the [path]`Portfile` and any required patchfiles to the ticket.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+. If your ticket or pull request doesn't receive any attention within a few days you may send an email to mailto:macports-dev@lists.macports.org[] and request a review and/or commit. Please include a link to the ticket or pull request.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_project.contributing.updates]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[project.contributing.updates]]

</span> === Port Enhancements

 Enhancements to existing ports may comprise new functionality for a given port, bug fixes or even simple version updates.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-They should always be contributed as patches against the current [path]_Portfile_.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-See the <<_project.tickets,Ticket Submission Guidelines>> for a description of all fields.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+They should always be contributed as patches against the current [path]`Portfile`.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+See the <<project.tickets,Ticket Submission Guidelines>> for a description of all fields.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-. Create a [path]_Portfile_ patch with your changes. See <<_development,Portfile Development>> for more information on how to edit Portfiles.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+. Create a [path]`Portfile` patch with your changes. See <<development,Portfile Development>> for more information on how to edit Portfiles.

</span> . Please run 

 +

 [source]

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -359,32 +335,24 @@ See the <<_project.tickets,Ticket Submission Guidelines>> for a description of a

</span> ----

 where `$portname` is the name of the port you modified.

 Please fix any warnings and errors before submitting your changes.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-. Either submit the port update through link:a pull request on GitHub...

<span style='display:block; white-space:pre;background:#e0ffe0;'>+. Either submit the port update through https://github.com/macports/macports-ports/pulls[a pull request on GitHub]...

. $$...$$or create a Trac ticket.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-.. Set the type to *>enhancement* for miscellaneous enhancements, to *>defect* for bug fixes, or to *>update* for version updates.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-.. Set the component to **>ports**.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-.. Set the *>port* field to the name of the port you want to change.

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-.. Put the maintainer's email address or GitHub username into the *>Cc* field. You can use 

<span style='display:block; white-space:pre;background:#e0ffe0;'>+.. Set the type to *enhancement* for miscellaneous enhancements, to *defect* for bug fixes, or to *update* for version updates.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+.. Set the component to **ports**.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+.. Set the *port* field to the name of the port you want to change.

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+.. Put the maintainer's email address or GitHub username into the *Cc* field. You can use 

</span> +

 [source]

 ----

 %% port info --maintainer $portname

 ----

 where `$portname` is the name of the port you want to modify.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Note that 

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-// <email>openmaintainer@macports.org</email>

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- and 

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-// <email>nomaintainer@macports.org</email>

<span style='display:block; white-space:pre;background:#ffe0e0;'>- are not real people and should thus not be Cc'd.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Note that mailto:openmaintainer@macports.org[] and mailto:nomaintainer@macports.org[] are not real people and should thus not be Cc'd.

.. Attach your Portfile patch file and any new or changed patch files to the ticket.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-. If your ticket or pull request doesn't receive any attention within a few days you may send an email to 

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-+

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-// <email>macports-dev@lists.macports.org</email>

<span style='display:block; white-space:pre;background:#ffe0e0;'>- and request a review and/or commit.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Please include a link to the ticket or pull request.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+. If your ticket or pull request doesn't receive any attention within a few days you may send an email to mailto:macports-dev@lists.macports.org[] and request a review and/or commit. Please include a link to the ticket or pull request.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_project.contributing.maintaining]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[project.contributing.maintaining]]

</span> === Becoming a Port Maintainer

 MacPorts is always looking for people that want to take care of a certain package.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -392,17 +360,14 @@ If you notice an outdated port, a bug in a port or simply a port without maintai

</span> To become a maintainer you need:

 * An email address and a GitHub account.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* A copy of the [path]_Portfile_. Do not worry if you don't know where to find one yet. There's more documentation on that below.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* An account in the link:MacPorts Trac, preferably with the email address you want to use for your port.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+* A copy of the [path]`Portfile`. Do not worry if you don't know where to find one yet. There's more documentation on that below.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+* An account in the https://trac.macports.org/[MacPorts Trac], preferably with the email address you want to use for your port.

* Interest in the software you want to maintain and some time.

 You do _not_ need:

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* Commit access to the MacPorts repository. Instead, you open pull requests in GitHub (or create patches and open tickets in Trac.) You can, however, <<_project.membership,apply for commit access>> once you have some experience in maintaining ports. In fact, we would like to encourage you to apply after a few months.

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-* Expert knowledge of the software you want to maintain or experience in [path]_Portfile_ programming. You can pick those up along the way. Your knowledge about the software you want to maintain is probably more than what most other MacPorts developers have, given the number of ports MacPorts has. Consult <<_development>> chapter and <<_reference>> on how to write a [path]_Portfile_. If your questions are not answered there, please ask on the 

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-+

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-// <email>macports-dev@lists.macports.org</email>

<span style='display:block; white-space:pre;background:#ffe0e0;'>- mailing list.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+* Commit access to the MacPorts repository. Instead, you open pull requests in GitHub (or create patches and open tickets in Trac.) You can, however, <<project.membership,apply for commit access>> once you have some experience in maintaining ports. In fact, we would like to encourage you to apply after a few months.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+* Expert knowledge of the software you want to maintain or experience in [path]`Portfile` programming. You can pick those up along the way. Your knowledge about the software you want to maintain is probably more than what most other MacPorts developers have, given the number of ports MacPorts has. Consult <<development>> chapter and <<reference>> on how to write a [path]`Portfile`. If your questions are not answered there, please ask on the mailto:macports-dev@lists.macports.org[] mailing list.

</span> 

 To become the maintainer of a port, first check whether the port already has a maintainer.

 Run 

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -420,16 +385,16 @@ If the output lists a different email address, you can still co-maintain the por

</span> 

 Once you have verified that a port is unmaintained or the existing maintainer has invited you to co-maintain the port of your choice, follow these steps to become a maintainer: 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-. Locate the port's directory and make a copy. MacPorts can help you locate the directory that contains the [path]_Portfile_ by running ``port dir $portname``. Copy this directory to a separate location (so you can easily generate a patch later) that is readable by the macports user. In general, your home directory does not fulfill that requirement, but [path]_/var/tmp_ does. 

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+. Locate the port's directory and make a copy. MacPorts can help you locate the directory that contains the [path]`Portfile` by running ``port dir $portname``. Copy this directory to a separate location (so you can easily generate a patch later) that is readable by the macports user. In general, your home directory does not fulfill that requirement, but [path]`/var/tmp` does. 

</span> +

 [source]

 ----

 %% cp -r $(port dir $portname) /var/tmp

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Check [path]_/var/tmp_ for the new directory.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Check [path]`/var/tmp` for the new directory.

In most cases, its name should be equal to the name of the port you want to maintain.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-In those few cases where it is not (i.e., the so-called [option]``subports`` feature is used), check the output of `port dir $portname` for the correct name. 

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-. Change to the new directory and run `port info` to make sure everything went right. Note that running any port command without a port name tries to use the [path]_Portfile_ in the current directory. This is very helpful when testing modifications or new ports, so keep this in mind. 

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+In those few cases where it is not (i.e., the so-called `subports` feature is used), check the output of `port dir $portname` for the correct name. 

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+. Change to the new directory and run `port info` to make sure everything went right. Note that running any port command without a port name tries to use the [path]`Portfile` in the current directory. This is very helpful when testing modifications or new ports, so keep this in mind. 

</span> +

 [source]

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -448,15 +413,15 @@ To use the current port, you must be in a port's directory.

</span> ----

 +

 Pay attention to the part in the brackets in the first line.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-It will either contain a permission problem (in which case you need to adjust the permissions of your [path]_Portfile_ and the folders leading up to it), or a Tcl error message, in case of syntax errors in the [path]_Portfile_.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+It will either contain a permission problem (in which case you need to adjust the permissions of your [path]`Portfile` and the folders leading up to it), or a Tcl error message, in case of syntax errors in the [path]`Portfile`.

Also check that the copy of the working directory is in fact the current working directory in your shell.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-. Open the [path]_Portfile_ in your favorite editor and look for the line that starts with [option]``maintainer``. Delete [option]``nomaintainer`` from the line if it exists and add your own GitHub username or email address. For GitHub usernames, prefix your username with an `@` sign. Email addresses should be written in the form ``domain.tld:localpart``. The address is obfuscated to prevent email harvesters from automatically grabbing your address. If you want, you can start fixing bugs [...]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+. Open the [path]`Portfile` in your favorite editor and look for the line that starts with ``maintainer``. Delete `nomaintainer` from the line if it exists and add your own GitHub username or email address. For GitHub usernames, prefix your username with an `@` sign. Email addresses should be written in the form ``domain.tld:localpart``. The address is obfuscated to prevent email harvesters from automatically grabbing your address. If you want, you can start fixing bugs in the [path]`Por [...]

</span> +

<span style='display:block; white-space:pre;background:#ffe0e0;'>-At this point, please read <<_project.update_policies.nonmaintainer>> and familiarize yourself with the meaning of [option]``openmaintainer``.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Consider adding [option]``openmaintainer`` to speed up and simplify small updates of your port.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-If you decided to allow minor updates without consultation, add ``openmaintainer``, separated with a space, to the [option]``maintainer`` line of the [path]_Portfile_.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+At this point, please read <<project.update-policies.nonmaintainer>> and familiarize yourself with the meaning of ``openmaintainer``.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Consider adding `openmaintainer` to speed up and simplify small updates of your port.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+If you decided to allow minor updates without consultation, add ``openmaintainer``, separated with a space, to the `maintainer` line of the [path]`Portfile`.

</span> +

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Once you are done, save the file and verify the [path]_Portfile_ structure using MacPorts' builtin lint check:

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+Once you are done, save the file and verify the [path]`Portfile` structure using MacPorts' builtin lint check:

</span> +

 [source]

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -472,7 +437,7 @@ Error: Portfile parent directory tmp does not match primary category $XYZ

</span> ----

 +

 You can safely ignore _this_ message.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-It is printed because the copy of the port's directory is not in a directory named after the port's primary category, but in [path]_/var/tmp_ instead.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+It is printed because the copy of the port's directory is not in a directory named after the port's primary category, but in [path]`/var/tmp` instead.

Please try to address all other warnings and error messages, though.

 If you need help, feel free to continue and add a note to the ticket you will create asking for instructions.

 +

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -490,8 +455,8 @@ If you see

</span> Error: Unable to execute port: Could not open file: /private/var/tmp/somewhere/Portfile

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-check the permissions of the [path]_Portfile_ and all folders above it.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-They must be readable by the [option]``macports`` user.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+check the permissions of the [path]`Portfile` and all folders above it.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+They must be readable by the `macports` user.

</span> The easiest way to ensure this is to run

 [source]

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -499,11 +464,11 @@ The easiest way to ensure this is to run

</span> %% chmod -R go+rX /var/tmp/$portname

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-If the port fails to build, see the [path]_main.log_ referenced in the error message for details.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+If the port fails to build, see the [path]`main.log` referenced in the error message for details.

</span> If the build completes successfully, run `sudo

                 port clean` to clean up all leftovers.

 ====

<span style='display:block; white-space:pre;background:#ffe0e0;'>-. Create a patch from the changes you made to the [path]_Portfile_ and possible related files. To do that, run

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+. Create a patch from the changes you made to the [path]`Portfile` and possible related files. To do that, run

</span> +

 [source]

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -511,60 +476,42 @@ If the build completes successfully, run `sudo

</span> %% diff -uR $(port dir $portname) . > change-$portname-maintainer.diff

 ----

 +

<span style='display:block; white-space:pre;background:#ffe0e0;'>-in the directory where you edited the [path]_Portfile_.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-You can inspect the generated unified diff in [path]_change-$portname-maintainer.diff_ if you want.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-. If you are only changing the maintainer, link:file a pull request on GitHub.

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-. You may also link:file a new ticket in Trac to change the maintainer, though GitHub pull requests are preferred. Set *>type* to **>enhancement**. Leave the *>milestone* field empty. If you added yourself as co-maintainer, add the other maintainers in the *>Cc* field. Finally, fill in the *>port* field, set *>keywords* to `haspatch` (because you are attaching a patch), check the box that you want to attach files to the ticket and submit. After submission, attach the patch you created in [...]

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-. If you are also fixing a bug, make a separate commit for that in your pull request, or attach a separate patch for that change to the same ticket. If you are fixing a bug that already has a ticket, attach a patch fixing the bug there and file the maintainer change in a separate ticket (with a separate patch) as discussed above. In general, please create a separate patch for each semantic change. Doing so simplifies reviewing. It enables each independent change to be accepted without wo [...]

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-. If your pull request or ticket doesn't receive any attention within a few days you may send an email to 

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-+

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-// <email>macports-dev@lists.macports.org</email>

<span style='display:block; white-space:pre;background:#ffe0e0;'>- and request a review and/or commit.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Please include a link to the pull request or ticket.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+in the directory where you edited the [path]`Portfile`.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+You can inspect the generated unified diff in [path]`change-$portname-maintainer.diff` if you want.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+. If you are only changing the maintainer, https://github.com/macports/macports-ports/pulls[file a pull request on GitHub].

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+. You may also https://trac.macports.org/newticket[file a new ticket in Trac] to change the maintainer, though GitHub pull requests are preferred. Set *type* to **enhancement**. Leave the *milestone* field empty. If you added yourself as co-maintainer, add the other maintainers in the *Cc* field. Finally, fill in the *port* field, set *keywords* to `haspatch` (because you are attaching a patch), check the box that you want to attach files to the ticket and submit. After submission, attac [...]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+. If you are also fixing a bug, make a separate commit for that in your pull request, or attach a separate patch for that change to the same ticket. If you are fixing a bug that already has a ticket, attach a patch fixing the bug there and file the maintainer change in a separate ticket (with a separate patch) as discussed above. In general, please create a separate patch for each semantic change. Doing so simplifies reviewing. It enables each independent change to be accepted without wo [...]

<span style='display:block; white-space:pre;background:#e0ffe0;'>+. If your pull request or ticket doesn't receive any attention within a few days you may send an email to mailto:macports-dev@lists.macports.org[] and request a review and/or commit. Please include a link to the pull request or ticket.

</span> 

 Once you are the maintainer for a port, all new pull requests and tickets for this port will be assigned to you.

 You are expected to take a look at these pull requests and tickets, give advice and try to debug problems.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-If you are stuck, do not hesitate to ask on the 

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-// <email>macports-dev@lists.macports.org</email>

<span style='display:block; white-space:pre;background:#ffe0e0;'>- list.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+If you are stuck, do not hesitate to ask on the mailto:macports-dev@lists.macports.org[] list.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_project.update_policies]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[project.update-policies]]

</span> == Port Update Policies

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Port maintainers normally are given commit privileges to the Git repository so they can make updates to their own ports as described in <<_project.membership>>.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Port maintainers normally are given commit privileges to the Git repository so they can make updates to their own ports as described in <<project.membership>>.

However, The MacPorts Project does not restrict commit privileges for maintainers, so before a person other than a port's maintainer updates a port it is a good practice to inform a port's maintainer.

 See details below.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_project.update_policies.nonmaintainer]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[project.update-policies.nonmaintainer]]

</span> === Non-Maintainer Port Updates

 If you have a port update or bugfix for a port you do not maintain, to respect the rights of the port maintainer you should follow the following guidelines:

<span style='display:block; white-space:pre;background:#ffe0e0;'>-. If a port's maintainer is 

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-+

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-// <email>nomaintainer@macports.org</email>

<span style='display:block; white-space:pre;background:#ffe0e0;'>-, you may feel free to make updates and/or take maintainership of the port.

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-. If a port's maintainer contains the address 

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-+

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-// <email>openmaintainer@macports.org</email>

<span style='display:block; white-space:pre;background:#ffe0e0;'>-, this means that the author allows minor updates to the port without contacting him first.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-But permission should still be sought for major changes.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+. If a port's maintainer is mailto:nomaintainer@macports.org[], you may feel free to make updates and/or take maintainership of the port.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+. If a port's maintainer contains the address mailto:openmaintainer@macports.org[], this means that the author allows minor updates to the port without contacting him first. But permission should still be sought for major changes.

. Create patch file(s) as necessary, attach them to a Trac ticket, and assign the ticket to the maintainer (or Cc him or her, if you are unable to assign tickets).

 . Wait for a response from the maintainer. The maintainer should apply the patches and close the ticket within 72 hours.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-However, for maintained ports without 

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-// <email>openmaintainer@macports.org</email>

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-, there are some conditions under which maintainer permission may be waived:

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+However, for maintained ports without mailto:openmaintainer@macports.org[], there are some conditions under which maintainer permission may be waived:

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-* If the maintainer does not respond within 72 hours, you or another committer may review the patches and update the port. The log message of this commit must explain that you are taking advantage of maintainer timeout and include a reference to the ticket. If you are not a committer you may send an email to 

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-+

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-// <email>macports-dev@lists.macports.org</email>

<span style='display:block; white-space:pre;background:#ffe0e0;'>- and request the updates be committed.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+* If the maintainer does not respond within 72 hours, you or another committer may review the patches and update the port. The log message of this commit must explain that you are taking advantage of maintainer timeout and include a reference to the ticket. If you are not a committer you may send an email to mailto:macports-dev@lists.macports.org[] and request the updates be committed.

* A port is abandoned by its current maintainer. A port against which a Port Abandoned ticket has been filed (see below) can be updated without contacting the maintainer.

 * A critical port is broken that affects many users.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_project.update_policies.abandonment]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[project.update-policies.abandonment]]

</span> === Port Abandonment

 A port may be considered abandoned if any of the following apply:

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -575,7 +522,7 @@ A port may be considered abandoned if any of the following apply:

</span> 

 If you wish to initiate the Port Abandonment protocol and optionally volunteer as the new maintainer:

<span style='display:block; white-space:pre;background:#ffe0e0;'>-. File a new Trac ticket with the summary line: [Port Abandoned] **>portname**.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+. File a new Trac ticket with the summary line: [Port Abandoned] **portname**.

. The ticket should be assigned to the maintainer. Non-macports team members should Cc the maintainer.

 . Set the ticket Type to Defect.

 . In the Description field, refer to any unacknowledged ticket(s).

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -583,17 +530,17 @@ If you wish to initiate the Port Abandonment protocol and optionally volunteer a

. The Port Abandoned ticket may be closed when the new maintainer is assigned, and the original ticket(s) with the updates may be resolved as usual. The former maintainer should be removed from all other tickets on which they were assigned as owner. The Port Abandoned ticket should stay open for the usual 72-hour timeout period, to give the maintainer one last chance to indicate that they have not actually abandoned the port.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_project.docs]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[project.docs]]

</span> == Updating Documentation

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_project.docs.guide]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[project.docs.guide]]

</span> === Updating the Guide

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The sources for this guide are kept in a link:

<span style='display:block; white-space:pre;background:#ffe0e0;'>-        Git repository on GitHub.

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+The sources for this guide are kept in a https://github.com/macports/macports-guide[

<span style='display:block; white-space:pre;background:#e0ffe0;'>+        Git repository on GitHub].

</span> If you spot any error or outdated information, you are encouraged to submit a pull request following the steps outlined below. 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_project.docs.guide.one_time]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[project.docs.guide.one-time]]

</span> ==== Preparing Changes

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -615,19 +562,19 @@ $ sudo port install libxslt docbook-xsl

</span> ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_project.docs.guide.each_time]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[project.docs.guide.each-time]]

</span> ==== Proposing a Change

 For each change you want to make:

<span style='display:block; white-space:pre;background:#ffe0e0;'>-.. Make your changes to the file in the [path]_guide/xml/_ directory that corresponds to the section you want to make changes to.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+.. Make your changes to the file in the [path]`guide/xml/` directory that corresponds to the section you want to make changes to.

</span> +

 [source]

 ----

 $ $EDITOR guide/xml/guide.xml

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-.. Verify your changes are still valid XML. If the `make validate` command reports errors, fix the XML sources until you see no more error messages

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+.. Verify your changes are still valid XML. If the [cmd]``make validate`` command reports errors, fix the XML sources until you see no more error messages

</span> +

 [source]

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -642,7 +589,7 @@ $ make validate

</span> $ make guide

 $ open guide/html/index.html

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-.. Commit your changes to the local branch and describe your changes in the commit message. See also our wiki page link:CommitMessages that explains how to write good commit messages.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+.. Commit your changes to the local branch and describe your changes in the commit message. See also our wiki page https://trac.macports.org/wiki/CommitMessages[CommitMessages] that explains how to write good commit messages.

</span> +

 [source]

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -651,7 +598,7 @@ $ git commit -a

</span> ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_project.membership]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[project.membership]]

</span> == MacPorts Membership

 A requirement for a person to become a MacPorts committer is to first become involved and contribute to the project.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -662,21 +609,19 @@ This may be done by having a record of contribution to the project in several of

*** Involvement on MacPorts development and/or user support mailing lists.

 *** Contributing with documentation.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-To apply for MacPorts commit rights, send a brief email to the PortMgr team at 

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-// <email>macports-mgr@lists.macports.org</email>

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- entitled "Commit access: [replaceable]``Your Name``" with the following contents:

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+To apply for MacPorts commit rights, send a brief email to the PortMgr team at mailto:macports-mgr@lists.macports.org[] entitled "Commit access: ``Your Name``" with the following contents:

*** a description of your application and why you think you deserve commit rights. Include evidence of contributions to MacPorts as described above; at best add direct links to Trac tickets or Trac searches that make the review easier for the PortMgr team.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-*** your github username. This will be used as the identity the "handle", as part of your `[replaceable]``handle``@macports.org` alias.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+*** your github username. This will be used as the identity the "handle", as part of your ```handle``@macports.org` alias.

*** a real e-mail address to which you'd like your MacPorts alias to forward.

 The PortMgr team will consider all applications and provide an appropriate response as soon as they get to it.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_project.portmgr]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[project.portmgr]]

</span> == The PortMgr Team

 The MacPorts PortMgr team is the steering group for The MacPorts Project.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Its membership is usually determined by public elections among project members; the current members of the team can be found on the link:MacPorts

<span style='display:block; white-space:pre;background:#ffe0e0;'>-    Developers wiki page.

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+Its membership is usually determined by public elections among project members; the current members of the team can be found on the https://trac.macports.org/wiki/MacPortsDevelopers[MacPorts

<span style='display:block; white-space:pre;background:#e0ffe0;'>+    Developers wiki page].

</span> 

 They are responsible for matters such as:

 *** approving new project members (i.e., granting commit rights);

<span style='display:block; white-space:pre;color:#808080;'>diff --git a/guide/adoc/using.adoc b/guide/adoc/using.adoc

</span><span style='display:block; white-space:pre;color:#808080;'>index ccab52c..bde09f2 100644

</span><span style='display:block; white-space:pre;background:#e0e0ff;'>--- a/guide/adoc/using.adoc

</span><span style='display:block; white-space:pre;background:#e0e0ff;'>+++ b/guide/adoc/using.adoc

</span><span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1,24 +1,26 @@

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_using]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[using]]

</span> = Using MacPorts

 :doctype: book

 :sectnums:

 :toc: left

 :icons: font

 :experimental:

<span style='display:block; white-space:pre;background:#e0ffe0;'>+:idprefix:

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+:idseparator: -

</span> :sourcedir: .

<span style='display:block; white-space:pre;background:#ffe0e0;'>-This chapter describes using ``port``, port variants, common tasks and port binaries.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+This chapter describes using [cmd]``port``, port variants, common tasks and port binaries.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_using.port]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[using.port]]

</span> == The port Command

<span style='display:block; white-space:pre;background:#ffe0e0;'>-`port` is the main utility used to interact with MacPorts.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-It is used to update [path]_Portfile_s and the MacPorts infrastructure, and install and manage ports.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+[cmd]``port`` is the main utility used to interact with MacPorts.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+It is used to update [path]`Portfile`s and the MacPorts infrastructure, and install and manage ports.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_using.port.help]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[using.port.help]]

</span> === port help

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The [option]``help`` action shows some brief information about the specified action, or if no action is specified, shows basic usage information for `port` in general.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+The `help` action shows some brief information about the specified action, or if no action is specified, shows basic usage information for [cmd]``port`` in general.

</span> 

 [source]

 ----

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -36,10 +38,10 @@ Upgrade MacPorts itself and run the sync target

MacPorts.

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_using.port.selfupdate]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[using.port.selfupdate]]

</span> === port selfupdate

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The [option]``selfupdate`` action should be used regularly to update the local ports tree with the global MacPorts ports repository so you will have the latest versions of software packages available.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+The `selfupdate` action should be used regularly to update the local ports tree with the global MacPorts ports repository so you will have the latest versions of software packages available.

It also checks for new releases of MacPorts itself, and upgrades it when necessary.

 [source]

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -56,7 +58,7 @@ MacPorts base version 2.4.3 downloaded.

</span> ---> MacPorts base is already the latest version

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-If [option]``selfupdate`` detects that a newer version of MacPorts is available, it automatically updates the installed copy of MacPorts base to the latest released version.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+If `selfupdate` detects that a newer version of MacPorts is available, it automatically updates the installed copy of MacPorts base to the latest released version.

</span> In that case, you will see this message:

 ----

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -69,14 +71,14 @@ MacPorts base version 2.4.3 downloaded.

</span> Installing new MacPorts release in /opt/local as root:admin; permissions 755

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-If the [option]``selfupdate`` procedure fails you'll see a message like this:

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+If the `selfupdate` procedure fails you'll see a message like this:

</span> 

 ----

 Error installing new MacPorts base: command execution failed

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-As always, you can use the debug flag [option]``-d`` to enable verbose output.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-If your [option]``selfupdate`` failed, re-run it with debug output enabled to see all output generated by the build system.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+As always, you can use the debug flag `-d` to enable verbose output.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+If your `selfupdate` failed, re-run it with debug output enabled to see all output generated by the build system.

</span> 

 [source]

 ----

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -85,32 +87,30 @@ $ sudo port -d selfupdate

</span> 

 The output may give you an idea why the build failed.

 Look for the first occurrences of "`error`".

<span style='display:block; white-space:pre;background:#ffe0e0;'>-If you cannot figure out what's wrong yourself, feel free to ask on the 

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-// <email>macports-users@lists.macports.org</email>

<span style='display:block; white-space:pre;background:#ffe0e0;'>- mailing list and attach the output generated by ``sudo port -d selfupdate``.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+If you cannot figure out what's wrong yourself, feel free to ask on the mailto:macports-users@lists.macports.org[] mailing list and attach the output generated by [cmd]``sudo port -d selfupdate``.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[option]``selfupdate`` accepts a single switch:

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+`selfupdate` accepts a single switch:

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[option]``--nosync``::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Only update MacPorts itself, do not update the tree of [path]_Portfile_s.

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+`--nosync`::

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Only update MacPorts itself, do not update the tree of [path]`Portfile`s.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_using.port.sync]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[using.port.sync]]

</span> === port sync

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The [option]``sync`` action performs a subset of [option]``selfupdate``.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-It synchronizes the ports tree, as does [option]``selfupdate``, but it does not check for MacPorts upgrades.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-On macOS, unless there is a special reason not to do so, run <<_using.port.selfupdate,selfupdate>> instead.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+The `sync` action performs a subset of ``selfupdate``.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+It synchronizes the ports tree, as does ``selfupdate``, but it does not check for MacPorts upgrades.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+On macOS, unless there is a special reason not to do so, run <<using.port.selfupdate,selfupdate>> instead.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[option]``sync`` does not accept any switches.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+`sync` does not accept any switches.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_using.port.diagnose]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[using.port.diagnose]]

</span> === port diagnose

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The [option]``diagnose`` action checks for common issues in the user's environment and reports all issues it finds to the user, along with possible fixes for said problem.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+The `diagnose` action checks for common issues in the user's environment and reports all issues it finds to the user, along with possible fixes for said problem.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[option]``diagnose`` accepts a single switch:

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+`diagnose` accepts a single switch:

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[option]``--quiet``::

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+`--quiet`::

Only displays warnings and errors, rather than the status of all tests run.

 [NOTE]

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -118,23 +118,23 @@ Only displays warnings and errors, rather than the status of all tests run.

This command will only be available in MacPorts version 2.4 and above.

 ====

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_using.port.reclaim]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[using.port.reclaim]]

</span> === port reclaim

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The [option]``reclaim`` action attempts to reclaim space by uninstalling inactive ports, and removing unnecessary files that were downloaded during the installation process. 

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+The `reclaim` action attempts to reclaim space by uninstalling inactive ports, and removing unnecessary files that were downloaded during the installation process. 

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[option]``reclaim`` does not accept any switches.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+`reclaim` does not accept any switches.

</span> 

 [NOTE]

 ====

 This command will only be available in MacPorts version 2.4 and above.

 ====

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_using.port.list]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[using.port.list]]

</span> === port list

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The [option]``list`` action lists the currently available version of the specified ports, or if no ports are specified, displays a list of all available ports.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The list of available ports is very long, so use <<_using.port.search,search>> if you are looking for a specific port.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+The `list` action lists the currently available version of the specified ports, or if no ports are specified, displays a list of all available ports.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+The list of available ports is very long, so use <<using.port.search,search>> if you are looking for a specific port.

</span> 

 [source]

 ----

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -143,39 +143,39 @@ $ port list

</span> 

 [NOTE]

 ====

<span style='display:block; white-space:pre;background:#ffe0e0;'>-`port list` always lists the most recent version available in MacPorts, which is not necessarily the version you have installed.

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-For this reason, `port list

<span style='display:block; white-space:pre;background:#ffe0e0;'>-                        installed` likely produces unexpected output.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-In most cases where you would [option]``list``, using [option]``installed`` or [option]``echo`` is the better choice instead.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Both `port installed` and `port echo installed` would produce the output you might expect from the command, `port list installed` will not (and, to make matters worse, will be slow).

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-

<span style='display:block; white-space:pre;background:#ffe0e0;'>-You will hardly need `port list` at all to work with MacPorts.

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-When searching, `port search` is the better choice and when trying to list ports, `port

<span style='display:block; white-space:pre;background:#ffe0e0;'>-                        installed` and `port echo` are much more useful.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+[cmd]``port list`` always lists the most recent version available in MacPorts, which is not necessarily the version you have installed.

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+For this reason, [cmd]``port list

<span style='display:block; white-space:pre;background:#e0ffe0;'>+                        installed`` likely produces unexpected output.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+In most cases where you would ``list``, using `installed` or `echo` is the better choice instead.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Both [cmd]``port installed`` and [cmd]``port echo installed`` would produce the output you might expect from the command, [cmd]``port list installed`` will not (and, to make matters worse, will be slow).

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+

<span style='display:block; white-space:pre;background:#e0ffe0;'>+You will hardly need [cmd]``port list`` at all to work with MacPorts.

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+When searching, [cmd]``port search`` is the better choice and when trying to list ports, [cmd]``port

<span style='display:block; white-space:pre;background:#e0ffe0;'>+                        installed`` and [cmd]``port echo`` are much more useful.

</span> ====

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_using.port.search]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[using.port.search]]

</span> === port search

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The [option]``search`` action allows finding ports by partial matches of the name or description.

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-Other fields can be matched against, and matched in different ways, by using options. `port

<span style='display:block; white-space:pre;background:#ffe0e0;'>-                    search` is the tool of choice if you are looking for a specific software in MacPorts.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+The `search` action allows finding ports by partial matches of the name or description.

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+Other fields can be matched against, and matched in different ways, by using options. [cmd]``port

<span style='display:block; white-space:pre;background:#e0ffe0;'>+                    search`` is the tool of choice if you are looking for a specific software in MacPorts.

We recommend you read up on some of its flags to improve your efficiency when searching for ports.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Run `port help search` for an exhaustive list of possible switches.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Run [cmd]``port help search`` for an exhaustive list of possible switches.

</span> 

 Suppose you are looking for PHP in MacPorts.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-You might start with `port search php` and notice your query produces a lot of output.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+You might start with [cmd]``port search php`` and notice your query produces a lot of output.

In fact, at the time of writing this, this search produces 661 matches.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-By default, `port search` searches both name and description of a port.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-While we're looking for PHP, we can reduce the number of hits by using the [option]``--name`` flag.

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-Furthermore, we only want ports whose name starts with "`php`", so we add the [option]``--glob`` flag (actually, we could leave it out because it is the default) and modify the search term to ``php*``:

<span style='display:block; white-space:pre;background:#e0ffe0;'>+By default, [cmd]``port search`` searches both name and description of a port.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+While we're looking for PHP, we can reduce the number of hits by using the `--name` flag.

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+Furthermore, we only want ports whose name starts with "`php`", so we add the `--glob` flag (actually, we could leave it out because it is the default) and modify the search term to ``php*``:

</span> 

 [source]

 ----

 $ port search --name --glob 'php*'

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Furthermore, we can enable compact output by using the [option]``--line`` switch.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Furthermore, we can enable compact output by using the `--line` switch.

</span> This causes only a single line to be printed for each match:

 [source]

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -183,10 +183,10 @@ This causes only a single line to be printed for each match:

</span> $ port search --name --line --glob 'php*'

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Among a large number of PHP modules you will find the main PHP ports, which are named php[var]``<version>``.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Among a large number of PHP modules you will find the main PHP ports, which are named php``<version>``.

Choose one to install.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-If you know regex and know about the format of the PHP versions, you can further reduce the output of ``port search``:

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+If you know regex and know about the format of the PHP versions, you can further reduce the output of [cmd]``port search``:

</span> 

 [source]

 ----

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -253,58 +253,55 @@ rrdtool @1.4.7_5 (net)

Found 11 ports.

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The possible switches to [option]``search`` and their meaning are:

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+The possible switches to `search` and their meaning are:

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[option]``--case-sensitive``::

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+`--case-sensitive`::

Match the search string in a case-sensitive manner.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[option]``--exact``::

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+`--exact`::

Match the literal search string exactly.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[option]``--glob``::

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-Treat the given search string as glob search string (i.e., expand wildcards [option]``\*``, [option]``?``, and 

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-+

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-// <optional>chars</optional>

<span style='display:block; white-space:pre;background:#ffe0e0;'>-). This is the default behavior.

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+`--glob`::

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Treat the given search string as glob search string (i.e., expand wildcards ``\*``, ``?``, and ``[chars]``). This is the default behavior.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[option]``--regex``::

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+`--regex`::

Treat the given search string as regular expression.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[option]``--field``::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Test the search string against [var]``<field>``.

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+`--field`::

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Test the search string against ``<field>``.

Can be specified multiple times to test against multiple fields.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The default is [option]``--name --description``.

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-Possible values for [var]``<field>`` are

<span style='display:block; white-space:pre;background:#e0ffe0;'>+The default is ``--name --description``.

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+Possible values for `<field>` are

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[option]``--category``, [option]``--categories``::

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+``--category``, `--categories`::

Search for ports in a given category.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[option]``--depends``, [option]``--depends_build``, [option]``--depends_extract``, [option]``--depends_fetch``, [option]``--depends_lib``, [option]``--depends_run``::

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+``--depends``, ``--depends_build``, ``--depends_extract``, ``--depends_fetch``, ``--depends_lib``, `--depends_run`::

Search for ports that depend on the port given as search string.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The [option]``--depends`` is an alias for all other [option]``--depends_`` options combined.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+The `--depends` is an alias for all other `--depends_` options combined.

Note that only dependencies specified in default variants will be found.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[option]``--description``, [option]``--long_description``::

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+``--description``, `--long_description`::

Test the search string against ports' descriptions.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[option]``--homepage``::

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+`--homepage`::

Test the search string against the homepage field of all ports.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[option]``--maintainer``, [option]``--maintainers``::

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+``--maintainer``, `--maintainers`::

Search for ports maintained by a specific maintainer.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[option]``--name``::

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+`--name`::

Search only ports' names.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[option]``--portdir``::

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+`--portdir`::

Test the search string against the path of the directory that contains the port.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[option]``--variant``, [option]``--variants``::

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+``--variant``, `--variants`::

Search for variant names.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_using.port.info]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[using.port.info]]

</span> === port info

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The [option]``info`` action is used to get information about a port: name, version, description, variants, homepage, dependencies, license, and maintainers.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+The `info` action is used to get information about a port: name, version, description, variants, homepage, dependencies, license, and maintainers.

</span> 

 [source]

 ----

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -330,10 +327,10 @@ License:              BSD

</span> Maintainers:          cal@macports.org

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_using.port.deps]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[using.port.deps]]

</span> === port deps

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The [option]``deps`` action lists the dependencies of a port.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+The `deps` action lists the dependencies of a port.

Dependencies are the packages are required by a port at runtime (library and runtime dependencies) or required to install it (build, fetch, and extract dependencies).

 [source]

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -347,7 +344,7 @@ Library Dependencies: apr, apr-util, expat, openssl, pcre, perl5, zlib

</span> ----

 Note that the list of dependencies might depend on the variants you chose.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-For example, choosing the [option]``\+openldap`` variant of [option]``apache2`` adds a dependency on [option]``openldap``:

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+For example, choosing the `\+openldap` variant of `apache2` adds a dependency on ``openldap``:

</span> 

 [source]

 ----

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -359,23 +356,23 @@ Full Name: apache2 @2.2.27_0+openldap+preforkmpm

</span> Library Dependencies: apr, apr-util, expat, openssl, pcre, perl5, zlib, openldap

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[option]``deps`` accepts two switches:

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+`deps` accepts two switches:

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[option]``--index``::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Do not read the [path]_Portfile_ to determine dependencies.

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+`--index`::

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Do not read the [path]`Portfile` to determine dependencies.

Instead, rely on the information cached in the port index.

 Note that (despite specifying them), this option will ignore any effects of variants.

 It is, however, much faster.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[option]``--no-build``::

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+`--no-build`::

Exclude dependencies only required at build time, i.e., fetch, extract, and build dependencies.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_using.port.variants]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[using.port.variants]]

</span> === port variants

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The [option]``variants`` action allows you to check what variations of a port are available before you install it.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+The `variants` action allows you to check what variations of a port are available before you install it.

Variants are a way for port authors to provide options you can use to customize your build at install time.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-See <<_using.variants.invoking,Invoking Port Variants>> below to install ports that have variants.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+See <<using.variants.invoking,Invoking Port Variants>> below to install ports that have variants.

</span> 

 [source]

 ----

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -397,18 +394,18 @@ apache2 has the variants:

</span> 

 This output lists all variants followed by their description.

 If a variant depends on or conflicts with other variants, a line detailing that follows.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-A variant name prefixed by [option]``\+`` indicates that it has been enabled (on the command line), while a prefix [option]``-`` indicates that it has been disabled.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-When bracketed, a prefix [option]``\+`` means that the variant is enabled by default.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Any [option]``[]`` are derived from the [path]_Portfile_.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-While [option]``()`` are derived from the [path]_variants.conf_.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-See <<_internals.configuration_files.variants_conf>> for more information on [path]_variants.conf_.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+A variant name prefixed by `\+` indicates that it has been enabled (on the command line), while a prefix `-` indicates that it has been disabled.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+When bracketed, a prefix `\+` means that the variant is enabled by default.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Any `[]` are derived from the [path]`Portfile`.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+While `()` are derived from the [path]`variants.conf`.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+See <<internals.configuration-files.variants-conf>> for more information on [path]`variants.conf`.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_using.port.install]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[using.port.install]]

</span> === port install

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The action [option]``install`` is used to install a port.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Once you determined the name of a port you want (possibly using <<_using.port.search,`port search`>>), you can install it using this command.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-See <<_using.variants.invoking>> on how to choose variants when installing a new port.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+The action `install` is used to install a port.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Once you determined the name of a port you want (possibly using <<using.port.search,[cmd]``port search``>>), you can install it using this command.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+See <<using.variants.invoking>> on how to choose variants when installing a new port.

</span> For example,

 [source]

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -416,18 +413,18 @@ For example,

</span> $ sudo port install apache2 -preforkmpm +workermpm

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-installs the [option]``apache2`` port without the [option]``preforkmpm``, but with the [option]``workermpm`` variant.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+installs the `apache2` port without the ``preforkmpm``, but with the `workermpm` variant.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-If the installation of a port fails, you can enable verbose or debug output by giving the [option]``-v`` or [option]``-d`` flag to port:

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+If the installation of a port fails, you can enable verbose or debug output by giving the `-v` or `-d` flag to port:

</span> 

 [source]

 ----

 $ sudo port -v install apache2

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-All debug information is also kept in [path]_main.log_ for the port you installed.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+All debug information is also kept in [path]`main.log` for the port you installed.

Its path will be printed automatically if the installation fails.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-You can manually get the path using ``port logfile portname``.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+You can manually get the path using [cmd]``port logfile portname``.

Note that logfiles will automatically be deleted on successful installation.

 If the installation of a port fails, you should always clean and try again, i.e., run

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -439,21 +436,21 @@ $ sudo port clean portname

</span> 

 and re-execute the command you ran before.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-You might also want to try enabling trace mode, which can prevent conflicts caused by files installed by other ports or in common system locations, such as [path]_/usr/local_.

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-To do that, re-run the installation with the [option]``-t`` flag, i.e.,

<span style='display:block; white-space:pre;background:#e0ffe0;'>+You might also want to try enabling trace mode, which can prevent conflicts caused by files installed by other ports or in common system locations, such as [path]`/usr/local`.

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+To do that, re-run the installation with the `-t` flag, i.e.,

</span> 

 [source]

 ----

 $ sudo port -t install portname

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-If the port still fails to install after you have followed these steps, please <<_project.tickets,file a ticket>> and attach the [path]_main.log_ of a clean attempt.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+If the port still fails to install after you have followed these steps, please <<project.tickets,file a ticket>> and attach the [path]`main.log` of a clean attempt.

</span> 

 [NOTE]

 ====

 The installation of a single port consists of multiple phases.

 These phases are fetch, extract, patch, configure, build, destroot, archive, and finally install.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-You may break up a port's installation into smaller steps for troubleshooting by using the name of one of these phases as action rather than [option]``install``.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+You may break up a port's installation into smaller steps for troubleshooting by using the name of one of these phases as action rather than ``install``.

</span> For example

 [source]

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -461,32 +458,32 @@ For example

</span> $ sudo port destroot apache2

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-will run the installation of [option]``apache2`` until the destroot phase.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-See <<_reference.phases>> for a complete list of phases and a detailed description.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+will run the installation of `apache2` until the destroot phase.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+See <<reference.phases>> for a complete list of phases and a detailed description.

</span> ====

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[option]``install`` takes the following switches:

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+`install` takes the following switches:

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[option]``--no-rev-upgrade``::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-By default, a binary sanity check called [option]``rev-upgrade`` is run automatically after each successful installation.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Pass this flag, if you want to avoid running this step, for example if you want to run it explicitly later after a number of installations using ``sudo port rev-upgrade``, or if you know it will detect problems but want to defer dealing with them.

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+`--no-rev-upgrade`::

<span style='display:block; white-space:pre;background:#e0ffe0;'>+By default, a binary sanity check called `rev-upgrade` is run automatically after each successful installation.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Pass this flag, if you want to avoid running this step, for example if you want to run it explicitly later after a number of installations using [cmd]``sudo port rev-upgrade``, or if you know it will detect problems but want to defer dealing with them.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[option]``--unrequested``::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-By default, each port you install using the [option]``install`` explicitly (contrary to ports installed as a dependency of a different port) is marked as "`requested`".

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+`--unrequested`::

<span style='display:block; white-space:pre;background:#e0ffe0;'>+By default, each port you install using the `install` explicitly (contrary to ports installed as a dependency of a different port) is marked as "`requested`".

If you want MacPorts to treat a port you installed manually as if it was automatically installed as a dependency (e.g., if a dependency failed to build and you re-tried installing the dependency only), pass this flag.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_using.port.clean]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[using.port.clean]]

</span> === port clean

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The action [option]``clean`` deletes intermediate files created by MacPorts while installing a port.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-A `port clean` is often necessary when builds fail and should be the first thing to try after a failed installation attempt.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+The action `clean` deletes intermediate files created by MacPorts while installing a port.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+A [cmd]``port clean`` is often necessary when builds fail and should be the first thing to try after a failed installation attempt.

</span> 

 [source]

 ----

 $ sudo port clean portname

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-`port clean` can also be used to remove corrupted downloads after a failed [option]``fetch`` phase, by specifying the [option]``--dist`` flag:

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[cmd]``port clean`` can also be used to remove corrupted downloads after a failed `fetch` phase, by specifying the `--dist` flag:

</span> 

 [source]

 ----

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -495,28 +492,28 @@ $ sudo port clean --dist portname

</span> 

 deletes all files that have been downloaded for the given port.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[option]``clean`` accepts the following options:

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+`clean` accepts the following options:

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[option]``--archive``::

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+`--archive`::

Remove temporary archives.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[option]``--dist``::

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+`--dist`::

Remove downloaded files.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[option]``--logs``::

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+`--logs`::

Remove log files.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[option]``--work``::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Remove the [path]_work_ directory, i.e., the directory used by MacPorts to build a software.

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+`--work`::

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Remove the [path]`work` directory, i.e., the directory used by MacPorts to build a software.

This removes all traces of an attempted build and is the default operation.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[option]``--all``::

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+`--all`::

All of the above combined.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_using.port.uninstall]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[using.port.uninstall]]

</span> === port uninstall

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The [option]``uninstall`` action will remove an installed port.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+The `uninstall` action will remove an installed port.

It is one of the actions you will use fairly often in MacPorts.

 [source]

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -542,14 +539,14 @@ Error: port uninstall failed: Please uninstall the ports that depend on libcomer

</span> ----

 You can recursively uninstall all ports that depend on the given port before uninstalling the port itself to work around this.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-To do that, use the [option]``--follow-dependents`` flag.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+To do that, use the `--follow-dependents` flag.

</span> 

 [source]

 ----

 $ sudo port uninstall --follow-dependents libcomerr

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-You can also override this safety check using the [option]``-f`` (force) flag. _Since

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+You can also override this safety check using the `-f` (force) flag. _Since

</span>                     this will obviously break the dependents you shouldn't do this unless you know what you are

                     doing._

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -559,28 +556,28 @@ $ sudo port -f uninstall libcomerr

</span> ----

 Uninstalling a port will not uninstall ports that have been automatically installed as dependencies of the uninstalled port and are otherwise unused.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-You can trigger this behavior by passing the [option]``--follow-dependencies`` flag.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+You can trigger this behavior by passing the `--follow-dependencies` flag.

Ports that were manually installed (i.e., are marked as "`requested`") or have other dependents will not be removed.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-You can manually uninstall the unneeded ports later using the [option]``leaves`` pseudo-port, e.g., using ``sudo port

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+You can manually uninstall the unneeded ports later using the `leaves` pseudo-port, e.g., using [cmd]``sudo port

uninstall leaves``.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[option]``uninstall`` supports the following switches:

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+`uninstall` supports the following switches:

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[option]``--follow-dependents``::

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+`--follow-dependents`::

Recursively uninstall ports that depend on the specified port before uninstalling the port itself.

 See also the textual description above.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[option]``--follow-dependencies``::

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+`--follow-dependencies`::

Also uninstall ports that were automatically installed as dependencies of the removed port and are no longer needed.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[option]``--no-exec``::

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+`--no-exec`::

Avoid running any uninstall hooks, such as commands that update cache files.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_using.port.contents]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[using.port.contents]]

</span> === port contents

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The [option]``contents`` action displays a list of all files that have been installed by a given port.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-You can only use [option]``contents`` for ports you installed.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+The `contents` action displays a list of all files that have been installed by a given port.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+You can only use `contents` for ports you installed.

</span> 

 [source]

 ----

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -596,7 +593,7 @@ Port xorg-renderproto contains:

</span>   /opt/local/share/doc/renderproto/renderproto.txt

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Common uses for [option]``contents`` are finding the location of a port's executable after installing it.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Common uses for `contents` are finding the location of a port's executable after installing it.

</span> The following line is usually helpful in this case:

 [source]

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -604,41 +601,41 @@ The following line is usually helpful in this case:

</span> $ port -q contents portname | grep -E '/s?bin/'

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The [option]``-q`` (quiet) flag suppresses the header line in this case, but is not strictly necessary.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+The `-q` (quiet) flag suppresses the header line in this case, but is not strictly necessary.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[option]``contents`` accepts:

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+`contents` accepts:

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[option]``--size``::

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+`--size`::

Prints a human-readable representation of the files' sizes.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[option]``--units UNIT``::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Used in conjunction with [option]``--size`` to choose the unit of the file size.

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-Valid parameters for [option]``UNIT`` are

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+`--units UNIT`::

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Used in conjunction with `--size` to choose the unit of the file size.

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+Valid parameters for `UNIT` are

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[option]``B``::

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+`B`::

List sizes in bytes.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[option]``K``, [option]``Ki``, or [option]``KiB``::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-List sizes in [option]``KiB``, i.e., 1024 bytes.

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+``K``, ``Ki``, or `KiB`::

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+List sizes in ``KiB``, i.e., 1024 bytes.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[option]``Mi``, or [option]``MiB``::

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-List sizes in [option]``MiB``, i.e., 1024 * 1024 bytes.

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+``Mi``, or `MiB`::

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+List sizes in ``MiB``, i.e., 1024 * 1024 bytes.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[option]``Gi``, or [option]``GiB``::

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-List sizes in [option]``GiB``, i.e., 1024 * 1024 * 1024 bytes.

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+``Gi``, or `GiB`::

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+List sizes in ``GiB``, i.e., 1024 * 1024 * 1024 bytes.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[option]``k``, or [option]``kB``::

<span style='display:block; white-space:pre;background:#ffe0e0;'>-List sizes in [option]``kB``, i.e., 1000 bytes.

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+``k``, or `kB`::

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+List sizes in ``kB``, i.e., 1000 bytes.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[option]``M``, or [option]``MB``::

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-List sizes in [option]``MB``, i.e., 1000 * 1000 bytes.

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+``M``, or `MB`::

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+List sizes in ``MB``, i.e., 1000 * 1000 bytes.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[option]``G``, or [option]``GB``::

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-List sizes in [option]``GB``, i.e., 1000 * 1000 * 1000 bytes.

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_using.port.installed]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+``G``, or `GB`::

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+List sizes in ``GB``, i.e., 1000 * 1000 * 1000 bytes.

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[using.port.installed]]

</span> === port installed

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The [option]``installed`` action displays the installed versions and variants of the specified ports, or if no ports are specified, all installed ports.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+The `installed` action displays the installed versions and variants of the specified ports, or if no ports are specified, all installed ports.

It also displays whether a port is "`active`", i.e., whether the files belonging to this port are currently present on disk or inactive, i.e., stashed away in a compressed tarball.

 [source]

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -667,7 +664,7 @@ The following ports are currently installed:

</span>   zlib @1.2.8_0 (active)

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Use [option]``-v`` to also display the platform and CPU architecture(s) for which the ports were built, and any variants which were explicitly negated.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Use `-v` to also display the platform and CPU architecture(s) for which the ports were built, and any variants which were explicitly negated.

</span> 

 [source]

 ----

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -680,11 +677,11 @@ The following ports are currently installed:

</span>   libsdl @1.2.15_3-x11 (active) platform='darwin 13' archs='x86_64'

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_using.port.outdated]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[using.port.outdated]]

</span> === port outdated

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The [option]``outdated`` action checks your installed ports against the current ports tree to see they have been updated since you installed them.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Note that you will only get new versions by updating your ports tree using [option]``<<_using.port.selfupdate,selfupdate>>`` (or [option]``sync``).

<span style='display:block; white-space:pre;background:#e0ffe0;'>+The `outdated` action checks your installed ports against the current ports tree to see they have been updated since you installed them.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Note that you will only get new versions by updating your ports tree using `<<using.port.selfupdate,selfupdate>>` (or ``sync``).

</span> 

 [source]

 ----

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -705,14 +702,14 @@ p5.16-gnupg-interface          0.330.0_3 < 0.500.0_1

</span> p5.16-ipc-run                  0.910.0_1 < 0.920.0_0

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-`port outdated` lists the ports for which an upgrade is available and on the second column, why MacPorts thinks the port needs an upgrade.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+[cmd]``port outdated`` lists the ports for which an upgrade is available and on the second column, why MacPorts thinks the port needs an upgrade.

In most cases, this will be an increase in the version number.

 If it isn't, more details will be given.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_using.port.upgrade]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[using.port.upgrade]]

</span> === port upgrade

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The [option]``upgrade`` action upgrades installed ports and their dependencies to the latest version available in MacPorts.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+The `upgrade` action upgrades installed ports and their dependencies to the latest version available in MacPorts.

</span> In most cases, you will run

 [source]

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -735,7 +732,7 @@ Do not attempt to prevent this, since it will very likely lead to problems later

</span> 

 [NOTE]

 ====

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[option]``upgrade`` does not uninstall the old version of a port.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+`upgrade` does not uninstall the old version of a port.

Instead, it deactivates it, i.e., it stashes the files belonging to the older version away in a tarball.

 This allows you to go back to the older version if there happens to be a problem with the updated one.

 To do that, run

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -754,7 +751,7 @@ $ sudo port activate portname @old-version

</span> 

 to go back to the old version.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-If you do not want to keep the old versions around while upgrading, you can pass [option]``-u`` when upgrading:

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+If you do not want to keep the old versions around while upgrading, you can pass `-u` when upgrading:

</span> 

 [source]

 ----

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -771,12 +768,12 @@ $ sudo port uninstall inactive

once in a while.

 ====

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[option]``upgrade`` accepts a number of switches:

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+`upgrade` accepts a number of switches:

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[option]``--force``::

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+`--force`::

Always consider the given ports outdated, regardless of whether they actually are.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[option]``--enforce-variants``::

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+`--enforce-variants`::

If the installed variants do not match those requested, upgrade (and change variants) even if the port is not outdated.

 You can use this to switch the variant selection on an installed port, e.g., using

 +

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -787,8 +784,8 @@ You can use this to switch the variant selection on an installed port, e.g., usi

</span> $ sudo port upgrade --enforce-variants apache2 -preforkmpm +workermpm

 ----

 +

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Note that [option]``--enforce-variants`` will also enforce your variant selection in all dependencies.

</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-If you know this is not necessary, you can avoid processing dependencies using the global [option]``-n`` flag:

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Note that `--enforce-variants` will also enforce your variant selection in all dependencies.

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+If you know this is not necessary, you can avoid processing dependencies using the global `-n` flag:

</span> +

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -796,13 +793,13 @@ If you know this is not necessary, you can avoid processing dependencies using t

</span> ----

 $ sudo port -n upgrade --enforce-variants apache2 -preforkmpm +workermpm

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[option]``--no-replace``::

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+`--no-replace`::

Do not automatically install replacement ports for a port that you have installed, but was replaced with a different one.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_using.port.dependents]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[using.port.dependents]]

</span> === port dependents

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The [option]``dependents`` action reports what ports depend upon a given (installed) port, if any.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+The `dependents` action reports what ports depend upon a given (installed) port, if any.

</span> 

 [source]

 ----

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -829,7 +826,7 @@ textmate2 depends on openssl

</span> wireshark depends on openssl

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Note that [option]``dependents`` does not work for ports that are not installed on your system.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Note that `dependents` does not work for ports that are not installed on your system.

</span> If you want to find out, which ports depend on a port that you have not installed, you can use

 [source]

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -839,12 +836,12 @@ $ port echo depends:portname

</span> 

 This command will, however, not cover dependencies that are only present in non-default variants.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_using.port.livecheck]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[using.port.livecheck]]

</span> === port livecheck

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The [option]``livecheck`` action checks to see if the application corresponding to a given port has been updated at the developer's download site.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+The `livecheck` action checks to see if the application corresponding to a given port has been updated at the developer's download site.

This action is mostly useful for port maintainers to determine whether their port needs to be updated, but other may also wish to see if a port packages the latest available version.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-See <<_reference.livecheck>> for more information on livecheck.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+See <<reference.livecheck>> for more information on livecheck.

</span> 

 [source]

 ----

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -857,17 +854,17 @@ rb19-sass seems to have been updated (port version: 3.3.10, new version: 3.3.14)

</span> 

 [NOTE]

 ====

<span style='display:block; white-space:pre;background:#ffe0e0;'>-If [option]``livecheck`` finds no higher version at the port's download site, it prints nothing.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The option [option]``-d`` (debug) may be used for detailed livecheck processing information.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+If `livecheck` finds no higher version at the port's download site, it prints nothing.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+The option `-d` (debug) may be used for detailed livecheck processing information.

</span> ====

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_using.port.lint]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[using.port.lint]]

</span> === port lint

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The lint action checks if the [path]_Portfile_ conforms to the MacPorts standards specified in <<_development,Portfile Development>>.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-You should use this if you modified a [path]_Portfile_ before submitting patches back to MacPorts.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+The lint action checks if the [path]`Portfile` conforms to the MacPorts standards specified in <<development,Portfile Development>>.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+You should use this if you modified a [path]`Portfile` before submitting patches back to MacPorts.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-If a [path]_Portfile_ validates fine the following message is shown.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+If a [path]`Portfile` validates fine the following message is shown.

</span> 

 [source]

 ----

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -896,12 +893,12 @@ Warning: no license set

</span> --->  0 errors and 3 warnings found.

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[option]``lint`` has the following flag:

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+`lint` has the following flag:

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[option]``--nitpick``::

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+`--nitpick`::

Enables additional checks that are mostly whitespace-related and best practices.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_using.variants]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[using.variants]]

</span> == Port Variants

 Variants are a way for port authors to provide options for a port that may be chosen at installation.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -935,12 +932,12 @@ apache2 has the variants:

</span> 

 This output lists all variants followed by their description.

 If a variant depends on or conflicts with other variants, a line with the details on that follows.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Variant lines that have a [option]``\+`` are enabled and those with [option]``-`` are disabled.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Any [option]``[]`` are derived from the [path]_Portfile_.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-While [option]``()`` are derived from the [path]_variants.conf_.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-See <<_internals.configuration_files.variants_conf>> for more information on [path]_variants.conf_.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Variant lines that have a `\+` are enabled and those with `-` are disabled.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Any `[]` are derived from the [path]`Portfile`.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+While `()` are derived from the [path]`variants.conf`.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+See <<internals.configuration-files.variants-conf>> for more information on [path]`variants.conf`.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_using.variants.invoking]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[using.variants.invoking]]

</span> === Invoking Variants

 A variant can only be selected when a port is installed.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -967,7 +964,7 @@ $ sudo port install apache2 -preforkmpm +workermpm

</span> 

 Note that you will not see any confirmation of successful variant selection and MacPorts will not warn you if you misspelled a variant's name.

 If your installation is successful, but the chosen feature still seems to be missing, check for possible typos.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-You can use `<<_using.port.installed,port installed>>` to verify that the port has been installed with the chosen variant.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+You can use [cmd]``<<using.port.installed,port installed>>`` to verify that the port has been installed with the chosen variant.

</span> 

 This happens because MacPorts will also use the specified variants for any dependencies.

 For example,

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -977,41 +974,41 @@ For example,

</span> $ sudo port install apache2 +mariadb

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-is accepted even though [option]``apache2`` does not have a [option]``\+mariadb`` variant.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-However, it depends on the [option]``apr-util`` port which does have the [option]``\+mariadb`` variant and will be installed with it.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+is accepted even though `apache2` does not have a `\+mariadb` variant.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+However, it depends on the `apr-util` port which does have the `\+mariadb` variant and will be installed with it.

</span> 

 MacPorts will remember the variants that were used when installing a port.

 If you upgrade a port later, the same variants will be used, unless you manually specify different variants.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_using.variants.negating]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[using.variants.negating]]

</span> === Negating Default Variants

<span style='display:block; white-space:pre;background:#ffe0e0;'>-A [path]_Portfile_ can specify a default set of variants that will be used when you do not manually override it.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+A [path]`Portfile` can specify a default set of variants that will be used when you do not manually override it.

Not all ports specify default variants – if there are no default variants, no variants are chosen by default.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-If you wish to disable a variant that has been enabled by default, either by the [path]_Portfile_, or by your configuration in [path]_variants.conf_, you can negate the variant in question by prefixing the variant name with a minus on the command line:

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+If you wish to disable a variant that has been enabled by default, either by the [path]`Portfile`, or by your configuration in [path]`variants.conf`, you can negate the variant in question by prefixing the variant name with a minus on the command line:

</span> 

 [source]

 ----

 $ sudo port install apache2 -preformmpm +workermpm

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_using.common_tasks]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[using.common-tasks]]

</span> == Common Tasks

 This section lists common operations you may want to perform when managing a MacPorts installation.

 These are the workflows you will need most while using MacPorts.

 We recommend you read at least this section as a primer into how to use MacPorts.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-More details about the usage can be found in <<_using.port>> and the [option]``port(1)`` manpage available by running `man 1 port` in a Terminal.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+More details about the usage can be found in <<using.port>> and the `port(1)` manpage available by running [cmd]``man 1 port`` in a Terminal.

</span> 

 Mind the "`sudo`" for some of the subsequent examples, which is necessary if you have a default MacPorts installation.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_using.common_tasks.updating]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[using.common-tasks.updating]]

</span> === Updating Your Ports Tree

 The local ports tree is a collection of files that contain information on which packages are available through MacPorts and how they can be installed.

 You should regularly update your ports tree to get access to updated versions of software and bug fixes.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-To do that, use [option]``selfupdate``:

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+To do that, use ``selfupdate``:

</span> 

 [source]

 ----

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1030,12 +1027,12 @@ The ports tree has been updated. To upgrade your installed ports, you should run

</span>   port upgrade outdated

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_using.common_tasks.showports]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[using.common-tasks.showports]]

</span> === Show Ports Which Need Updating

<span style='display:block; white-space:pre;background:#ffe0e0;'>-To see what's new after running [option]``selfupdate``, you can use `port

<span style='display:block; white-space:pre;background:#ffe0e0;'>-                    outdated` to generate a list of ports that have newer versions available.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-This can help in estimating the time required for ``sudo port upgrade outdated``, even though this depends on further factors such as binary package availability and a port's build time.

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+To see what's new after running ``selfupdate``, you can use [cmd]``port

<span style='display:block; white-space:pre;background:#e0ffe0;'>+                    outdated`` to generate a list of ports that have newer versions available.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+This can help in estimating the time required for [cmd]``sudo port upgrade outdated``, even though this depends on further factors such as binary package availability and a port's build time.

</span> 

 [source]

 ----

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1056,7 +1053,7 @@ p5.16-gnupg-interface          0.330.0_3 < 0.500.0_1

</span> p5.16-ipc-run                  0.910.0_1 < 0.920.0_0

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_using.common_tasks.upgrading]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[using.common-tasks.upgrading]]

</span> === Upgrading Outdated Ports

 To upgrade all your installed and outdated ports, run

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1094,7 +1091,7 @@ Note that MacPorts will upgrade any dependencies of a port first before updating

So even if you request the update of a single port only, other ports may be upgraded first because they are in the dependency tree.

 Do _not_ try to avoid this, as it will very likely lead to problems later on – the new version of the port you want to upgrade might require the newer dependency, or it might only have been upgraded at all to be rebuilt against the updated dependency, in which case avoiding the update of the dependency defeats the purpose of the reinstallation.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_using.common_tasks.removeinactive]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[using.common-tasks.removeinactive]]

</span> === Removing Inactive Version(s) of Upgraded Port(s)

 By default, upgrading ports in MacPorts does not remove the older versions.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1173,7 +1170,7 @@ To uninstall all inactive ports but a single one, you can use the following shor

</span> $ sudo port uninstall inactive and not portname

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_using.common_tasks.finddepending]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[using.common-tasks.finddepending]]

</span> === Finding Ports Depending on a Certain Port

 If you want to find all ports that depend on a given other port, you can use

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1183,7 +1180,7 @@ If you want to find all ports that depend on a given other port, you can use

</span> $ port echo depends:portname

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-If you are only interested in the dependent ports that you actually have installed, you can use the quicker and more accurate [option]``dependents``:

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+If you are only interested in the dependent ports that you actually have installed, you can use the quicker and more accurate ``dependents``:

</span> 

 [source]

 ----

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1195,7 +1192,7 @@ gnupg2 depends on libksba

</span> gpg-agent depends on libksba

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-MacPorts also has a recursive version of the [option]``dependents`` action called [option]``rdependents``:

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+MacPorts also has a recursive version of the `dependents` action called ``rdependents``:

</span> 

 [source]

 ----

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1226,11 +1223,11 @@ The following ports are currently installed:

</span>   gnupg2 @2.0.25_0 (active)

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_using.common_tasks.findleaves]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[using.common-tasks.findleaves]]

</span> === Finding Leaves

 After a while of using MacPorts, installing and uninstalling ports, packages that have been automatically installed as dependencies for other ports are left behind, even though they are no longer necessary.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Ports that have not been manually installed ("`requested`") and do not have any dependents are called "`leaves`" and can be identified using the [option]``leaves`` pseudo-port, for example in conjunction with the [option]``echo`` or [option]``installed`` action.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Ports that have not been manually installed ("`requested`") and do not have any dependents are called "`leaves`" and can be identified using the `leaves` pseudo-port, for example in conjunction with the `echo` or `installed` action.

</span> 

 [source]

 ----

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1251,7 +1248,7 @@ yasm                           @1.2.0_0

</span> ----

 These leaves may be wanted, but are in most cases unneeded.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-See <<_using.common_tasks.keeplean>> to find out how to mark some of the leaves as requested.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+See <<using.common-tasks.keeplean>> to find out how to mark some of the leaves as requested.

</span> You can uninstall all leaves using

 [source]

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1260,15 +1257,15 @@ $ sudo port uninstall leaves

</span> ----

 Note that the uninstallation can cause new ports to become leaves.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-To uninstall all leaves, you would have to repeat the process until `port echo leaves` comes back empty.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-To automate this, you can use [option]``--follow-dependencies`` when uninstalling.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+To uninstall all leaves, you would have to repeat the process until [cmd]``port echo leaves`` comes back empty.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+To automate this, you can use `--follow-dependencies` when uninstalling.

</span> 

 [source]

 ----

 $ sudo port uninstall --follow-dependencies leaves

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-To go through this process interactively so you can make sure you're not uninstalling anything you want to keep, you can install the [option]``port_cutleaves`` port.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+To go through this process interactively so you can make sure you're not uninstalling anything you want to keep, you can install the `port_cutleaves` port.

</span> After installation, run it with

 [source]

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1276,7 +1273,7 @@ After installation, run it with

</span> $ sudo port_cutleaves

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_using.common_tasks.keeplean]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[using.common-tasks.keeplean]]

</span> === Keep Your Installation Lean by Defining Leaves as Requested Ports

 Well, before we come to the procedure of defining your requested ports, let's have a look at a typical scenario where you want to understand what is actually installed and what is on the other hand truly necessary for your system.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1301,11 +1298,11 @@ yasm                           @1.2.0_0

</span> ----

 Now it is up to the user to decide what's needed and what is not.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-We've noticed [option]``pkgconfig`` is needed to build many ports, and while it is strictly not needed after installation, we'd like to keep it around to avoid installing it over and over again. [option]``python32``, [option]``texi2html``, and [option]``yasm`` are only needed to update [option]``mplayer2``, and since that software is rarely updated, we will re-install those ports again when they are needed.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+We've noticed `pkgconfig` is needed to build many ports, and while it is strictly not needed after installation, we'd like to keep it around to avoid installing it over and over again. ``python32``, ``texi2html``, and `yasm` are only needed to update ``mplayer2``, and since that software is rarely updated, we will re-install those ports again when they are needed.

Since they are all distributable, MacPorts will use pre-built binaries for their installation anyway, so re-installing them wouldn't take long anyway.

 We don't really know why the rest of the leaves were installed, so we're just going to remove them for now.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Since we decided to keep [option]``pkgconfig``, we are going to mark it as manually installed ("`requested`" in MacPorts lingo) using:

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+Since we decided to keep ``pkgconfig``, we are going to mark it as manually installed ("`requested`" in MacPorts lingo) using:

</span> 

 [source]

 ----

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1320,7 +1317,7 @@ $ sudo port uninstall leaves

</span> ----

 Note that uninstalling leaves may mark new ports as leaves, so you will have to repeat the process.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-You can install the [option]``port_cutleaves`` port, which is a special script for the job.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+You can install the `port_cutleaves` port, which is a special script for the job.

It allows you to interactively decide whether to keep or uninstall a port.

 Run it as

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1439,13 +1436,13 @@ $ sudo port unsetrequested portname

</span> 

 Then check for new leaves to cut down the number of installed ports and the size of your MacPorts installation.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_using.binaries]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[using.binaries]]

</span> == Port Binaries

 MacPorts can pre-compile ports into binaries so applications need not be compiled when installing on a target system.

 MacPorts supports two types of binaries: archives and packages.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_using.binaries.archives]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[using.binaries.archives]]

</span> === Binary Archives

 Binary archives can only be used on a target system running MacPorts.

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1453,7 +1450,7 @@ They allow MacPorts utilities to skip the build (which is usually the phase that

Binary archives are automatically created whenever a port is installed, and can also be downloaded from a server.

 MacPorts runs a buildbot infrastructure that creates prebuilt binary packages for all ports in MacPorts for the default installation prefix.

 Buildbots exist for systems later or equal to Snow Leopard.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-If a port builds successfully and its license and those of its dependencies allow binary redistribution, the archives are uploaded to [option]``packages.macports.org`` and will be automatically used by MacPorts during installation.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+If a port builds successfully and its license and those of its dependencies allow binary redistribution, the archives are uploaded to `packages.macports.org` and will be automatically used by MacPorts during installation.

</span> 

 You can manually create an archive (and see debug output for its creation) using

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1499,35 +1496,35 @@ a ./opt/local/etc/logrotate.d/.turd_logrotate

</span> DEBUG: Archive logrotate-3.8.6_2+gzip.darwin_13.x86_64.tbz2 packaged

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Binary archive files are placed in [path]_${prefix}/var/macports/software/_.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The archive file type is set in [path]_macports.conf_ using the [option]``portarchivetype`` key.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-The default format is [option]``tbz2``; other options are: [option]``tar``, [option]``tbz``, [option]``tbz2``, [option]``tgz``, [option]``tlz``, [option]``txz``, [option]``xar``, [option]``zip``, [option]``cpgz``, and [option]``cpio``.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Binary archive files are placed in [path]`${prefix}/var/macports/software/`.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+The archive file type is set in [path]`macports.conf` using the `portarchivetype` key.

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+The default format is ``tbz2``; other options are: ``tar``, ``tbz``, ``tbz2``, ``tgz``, ``tlz``, ``txz``, ``xar``, ``zip``, ``cpgz``, and ``cpio``.

</span> 

<span style='display:block; white-space:pre;background:#ffe0e0;'>-[[_using.binaries.binary_packages]]

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+[[using.binaries.binary-packages]]

</span> === Binary Packages

 Binary packages are standalone binary installers that are precompiled; they do not require MacPorts on the target system.

 As such, they are helpful in generating disk images or installers to be redistributed to users without relying on MacPorts for installation.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Binary installers created with MacPorts are usually [option]``$$.$$pkg`` (macOS Installer packages). MacPorts can also convert a [option]``$$.$$pkg`` package into a macOS [option]``$$.$$dmg`` disk image.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-You can create binary packages using `port` as shown in the following examples.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Binary installers created with MacPorts are usually `$$.$$pkg` (macOS Installer packages). MacPorts can also convert a `$$.$$pkg` package into a macOS `$$.$$dmg` disk image.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+You can create binary packages using [cmd]``port`` as shown in the following examples.

</span> 

 [WARNING]

 ====

<span style='display:block; white-space:pre;background:#ffe0e0;'>-If you want to create installer packages using MacPorts for redistribution, make sure you do not use a standard installation of MacPorts in [path]_/opt/local_.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+If you want to create installer packages using MacPorts for redistribution, make sure you do not use a standard installation of MacPorts in [path]`/opt/local`.

If you do that, your installer package conflicts with MacPorts on systems that _do_ have MacPorts installed.

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Instead, follow <<_installing.macports.source.multiple>> and choose a prefix specific to the software you are trying to package, e.g., [path]_/opt/logrotate_ for [option]``logrotate``.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Instead, follow <<installing.macports.source.multiple>> and choose a prefix specific to the software you are trying to package, e.g., [path]`/opt/logrotate` for ``logrotate``.

Then use this custom MacPorts installation to build your package.

 ====

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Create a macOS [option]``$$.$$pkg`` installer for the [option]``pstree`` port:

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+Create a macOS `$$.$$pkg` installer for the `pstree` port:

</span> 

 [source]

 ----

 $ sudo port pkg pstree

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-You may also create a macOS [option]``$$.$$dmg`` disk image file instead:

</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+You may also create a macOS `$$.$$dmg` disk image file instead:

</span> 

 [source]

 ----

<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -1543,7 +1540,7 @@ Create one using:

</span> $ sudo port mpkg gimp2

 ----

<span style='display:block; white-space:pre;background:#ffe0e0;'>-Just as with a single package, a metapackage can also be wrapped in a [option]``$$.$$dmg``.

<span style='display:block; white-space:pre;background:#e0ffe0;'>+Just as with a single package, a metapackage can also be wrapped in a ``$$.$$dmg``.

</span> 

 [source]

 ----

</pre><pre style='margin:0'>

</pre>