[28037] trunk/doc/guide/new/xml

source_changes at macosforge.org source_changes at macosforge.org
Sat Aug 18 15:44:41 PDT 2007


Revision: 28037
          http://trac.macosforge.org/projects/macports/changeset/28037
Author:   markd at macports.org
Date:     2007-08-18 15:44:40 -0700 (Sat, 18 Aug 2007)

Log Message:
-----------
Add chapter and section ids (up to 2 levels deep) and do some cross-referencing.
Thanks simon r. for the tips.

Modified Paths:
--------------
    trunk/doc/guide/new/xml/installing.xml
    trunk/doc/guide/new/xml/internals.xml
    trunk/doc/guide/new/xml/intro.xml
    trunk/doc/guide/new/xml/portfiledev.xml
    trunk/doc/guide/new/xml/portfileref.xml
    trunk/doc/guide/new/xml/project.xml
    trunk/doc/guide/new/xml/using.xml

Modified: trunk/doc/guide/new/xml/installing.xml
===================================================================
--- trunk/doc/guide/new/xml/installing.xml	2007-08-18 21:08:50 UTC (rev 28036)
+++ trunk/doc/guide/new/xml/installing.xml	2007-08-18 22:44:40 UTC (rev 28037)
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
-<chapter>
+<chapter id="installing-macports">
   <title>Installing MacPorts</title>
 
   <para>This chapter show you how to install MacPorts and its prerequistes
@@ -9,7 +9,7 @@
   to install MacPorts on FreeBSD, first make sure you have gcc and X11
   installed, and then begin with section 5.</para>
 
-  <section>
+  <section id="installing-macports.install.xcode.tools">
     <title>Install Xcode Tools</title>
 
     <para>To install Xcode Tools and the X11 SDK, follow these steps.</para>
@@ -43,7 +43,7 @@
     </note>
   </section>
 
-  <section>
+  <section id="installing-macports.install.x11">
     <title>Install X11</title>
 
     <para>On OS X 10.4, Apple's X Window System (X11) is an optional install
@@ -116,7 +116,7 @@
     </section>
   </section>
 
-  <section>
+  <section id="installing-macports.install.macports.binary">
     <title>Install MacPorts - Binary</title>
 
     <para>If you wish to install MacPorts to a path other than
@@ -148,7 +148,7 @@
     </note>
   </section>
 
-  <section>
+  <section id="installing-macports.install.macports.source">
     <title>Install MacPorts - Source</title>
 
     <para>Installing from source on Mac OS X is only necessary If you wish to
@@ -180,7 +180,7 @@
     </note>
   </section>
 
-  <section>
+  <section id="installing-macports.set.bash.shell">
     <title>Set the Bash Shell</title>
 
     <para>The MacPorts binary installer places a <filename>.profile</filename>
@@ -241,24 +241,9 @@
     <title>MacPorts Selfupdate</title>
 
     <para>You must always do a selfupdate after a new MacPorts install, and
-    you should also do it frequently thereafter. The command updates MacPorts
-    via rsync with the latest port sources, and, if necessary, updates the
-    MacPorts application (called MacPorts base) to the latest release.</para>
-
-    <orderedlist>
-      <listitem>
-        <para>Open a terminal window.</para>
-      </listitem>
-
-      <listitem>
-        <para>Execute the MacPorts selfupdate command.</para>
-
-        <programlisting><prompt>%%</prompt> <userinput>sudo port selfupdate</userinput></programlisting>
-
-        <para>Use the debug flag for verbose output.</para>
-
-        <programlisting><prompt>%%</prompt> <userinput>sudo port -d selfupdate</userinput></programlisting>
-      </listitem>
-    </orderedlist>
+    you should also do it frequently thereafter. See <link
+    linkend="using-macports.port.command.selfupdate">selfupdate</link> —one of
+    several <link linkend="using-macports.port.command">port
+    commands</link>.</para>
   </section>
 </chapter>
\ No newline at end of file

Modified: trunk/doc/guide/new/xml/internals.xml
===================================================================
--- trunk/doc/guide/new/xml/internals.xml	2007-08-18 21:08:50 UTC (rev 28036)
+++ trunk/doc/guide/new/xml/internals.xml	2007-08-18 22:44:40 UTC (rev 28037)
@@ -1,13 +1,13 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
-<chapter>
+<chapter id="macports-internals">
   <title>MacPorts Internals</title>
 
   <para>This chapter contains information to help gain a better understanding
   of MacPorts or learn how to configure it for non-default operation.</para>
 
-  <section>
+  <section id="macports-internals.macports.file.hierarchy">
     <title>MacPorts File Hierarchy</title>
 
     <para>MacPorts port authors install files according to guidelines that
@@ -240,7 +240,7 @@
     </variablelist>
   </section>
 
-  <section>
+  <section id="macports-internals.configuration.files">
     <title>Configuration Files</title>
 
     <para>The MacPorts configuration files do not need to be modified for the
@@ -248,21 +248,21 @@
     users and port developers. All the MacPorts configuration files are
     located in <filename>/opt/local/etc/macports</filename>.</para>
 
-    <section>
+    <section id="macports-internals.configuration.files.sources.conf">
       <title>sources.conf</title>
 
       <para><filename>sources.conf</filename> is where the location(s) to
       retrieve the MacPorts <filename>Portfile</filename>s is set.</para>
     </section>
 
-    <section>
+    <section id="macports-internals.configuration.files.macports.conf">
       <title>macports.conf</title>
 
       <para><filename>macports.conf</filename> contains advanced MacPorts
       configuration options. See the file comments for instructions.</para>
     </section>
 
-    <section>
+    <section id="macports-internals.configuration.files.variants.conf">
       <title>variants.conf</title>
 
       <para><filename>variants.conf</filename> is used to specify variants to
@@ -270,7 +270,7 @@
     </section>
   </section>
 
-  <section>
+  <section id="macports-internals.port.images">
     <title>Port Images</title>
 
     <para>MacPorts has a unique ability to allow for multiple versions,
@@ -296,7 +296,7 @@
     </note>
   </section>
 
-  <section>
+  <section id="macports-internals.macports.apis">
     <title>MacPorts APIs</title>
 
     <para>MacPorts contains two application programming interfaces (APIs),
@@ -305,7 +305,7 @@
     latter is a high-level API used by client applications such as the
     MacPorts port utility.</para>
 
-    <section>
+    <section id="macports-internals.macports.apis.ports">
       <title>Ports API</title>
 
       <para>The code for the Port API is located in
@@ -349,7 +349,7 @@
       </itemizedlist>
     </section>
 
-    <section>
+    <section id="macports-internals.macports.apis.macports">
       <title>MacPorts API</title>
 
       <para>The code for the MacPorts API is located in
@@ -492,7 +492,7 @@
     </section>
   </section>
 
-  <section>
+  <section id="macports-internals.macports.registry">
     <title>The MacPorts Registry</title>
 
     <para>This chapter provides a detailed overview of the MacPorts registry
@@ -521,7 +521,7 @@
       </listitem>
     </itemizedlist>
 
-    <section>
+    <section id="macports-internals.macports.registry.registry.api">
       <title>The Registry API</title>
 
       <para>The MacPorts Registry provides a public API in the registry1.0 Tcl

Modified: trunk/doc/guide/new/xml/intro.xml
===================================================================
--- trunk/doc/guide/new/xml/intro.xml	2007-08-18 21:08:50 UTC (rev 28036)
+++ trunk/doc/guide/new/xml/intro.xml	2007-08-18 22:44:40 UTC (rev 28037)
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
-<chapter>
+<chapter id="introduction">
   <title>Introduction</title>
 
   <para>MacPorts is a system for compiling, installing, and managing free and

Modified: trunk/doc/guide/new/xml/portfiledev.xml
===================================================================
--- trunk/doc/guide/new/xml/portfiledev.xml	2007-08-18 21:08:50 UTC (rev 28036)
+++ trunk/doc/guide/new/xml/portfiledev.xml	2007-08-18 22:44:40 UTC (rev 28037)
@@ -1,14 +1,14 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
-<chapter>
+<chapter id="portfile-development">
   <title>Portfile Development</title>
 
   <para>This chapter covers a brief introduction to Portfiles, how to create a
   local <filename>Portfile</filename> repository for development, and creating
   Portfiles.</para>
 
-  <section>
+  <section id="portfile-development.portfile.introduction">
     <title>Portfile Introduction</title>
 
     <para>A MacPorts <filename>Portfile</filename> is a TCL script that
@@ -76,7 +76,7 @@
     </note>
   </section>
 
-  <section>
+  <section id="portfile-development.local.portfile.repositories">
     <title>Local Portfile Repositories</title>
 
     <para>To create and test <filename>Portfile</filename>s that are not yet
@@ -148,7 +148,7 @@
     <screen>bestevergame   games/bestevergame 1.1   The Best Ever Game</screen>
   </section>
 
-  <section>
+  <section id="portfile-development.creating.a.portfile">
     <title>Creating a Portfile</title>
 
     <para>Here we list the individual <filename>Portfile</filename> components
@@ -205,7 +205,8 @@
         responsibility for keeping the port up-to-date, and the maintainer
         keyword lists maintainer email addresses(s). To hide these addresses
         from spambots, see the more full explanation of the maintainer keyword
-        in the Portfile Reference section.</para>
+        in the <link linkend="portfile-reference.keywords.global">Global
+        Keywords</link> section of the Portfile Reference.</para>
 
         <programlisting>maintainers       julesverne at somedomain.org</programlisting>
 
@@ -276,14 +277,14 @@
     </orderedlist>
   </section>
 
-  <section>
+  <section id="portfile-development.example.portfiles">
     <title>Example Portfiles</title>
 
     <para>In this section we take a look at a complete simple Portfile, and
     then pre- and post- phase definitions to augment and override the MacPorts
     default phases.</para>
 
-    <section>
+    <section id="portfile-development.example.portfiles.basic.portfile">
       <title>A Basic Portfile</title>
 
       <programlisting># Id$
@@ -311,7 +312,7 @@
                         --mandir=${prefix}/share/man</programlisting>
     </section>
 
-    <section>
+    <section id="portfile-development.example.portfiles.pre.post">
       <title>Portfile Using Pre- / Post- Phases</title>
 
       <para>To augment a port's installation phase, and not override it, you
@@ -326,7 +327,7 @@
 }</programlisting>
     </section>
 
-    <section>
+    <section id="portfile-development.example.portfiles.override">
       <title>Portfile that Overrides Default Phases</title>
 
       <para>To override the automatic MacPorts installation phase processing,
@@ -338,7 +339,7 @@
 }</programlisting>
     </section>
 
-    <section>
+    <section id="portfile-development.example.portfiles.startupitem">
       <title>Portfile Using a StartupItem</title>
 
       <para>Startupitems may be placed in the global section of a
@@ -359,7 +360,7 @@
     </section>
   </section>
 
-  <section>
+  <section id="portfile-development.port.variants">
     <title>Port Variants</title>
 
     <para>Variants are a way for port authors to provide options that may be
@@ -367,7 +368,7 @@
     <filename>Portfile</filename> using the "variant" keyword and may provide
     a description.</para>
 
-    <section>
+    <section id="portfile-development.port.variants.modify.options">
       <title>Variants to Modify Options</title>
 
       <para>The most common use for a variant is to add or remove
@@ -404,7 +405,7 @@
 }</programlisting>
     </section>
 
-    <section>
+    <section id="portfile-development.port.variants.actions.phase">
       <title>Variant Actions in a Phase</title>
 
       <para>If a variant requires options in addition to those provided by
@@ -426,7 +427,7 @@
 }</programlisting>
     </section>
 
-    <section>
+    <section id="portfile-development.port.variants.default.variants">
       <title>Default Variants</title>
 
       <para>Variants are used to specify actions that lie outside the core
@@ -443,7 +444,7 @@
     </section>
   </section>
 
-  <section>
+  <section id="portfile-development.patch.files">
     <title>Patch Files</title>
 
     <para>Patch files are files created with the Unix command
@@ -451,7 +452,7 @@
     <command>patch</command> to modify text files to fix bugs or extend
     functionality.</para>
 
-    <section>
+    <section id="portfile-development.patch.files.portfile.patches">
       <title>Creating Portfile Patches</title>
 
       <para>If you wish to contribute modifications or fixes to a
@@ -513,7 +514,7 @@
       MacPorts Trac ticket for the port author to evaluate.</para>
     </section>
 
-    <section>
+    <section id="portfile-development.patch.files.source.patches">
       <title>Creating Source Code Patches</title>
 
       <para>Necessary or useful patches to application source code should be
@@ -581,7 +582,7 @@
       </orderedlist>
     </section>
 
-    <section>
+    <section id="portfile-development.patch.files.manually.applying">
       <title>Manually Applying Patches</title>
 
       <para>Though MacPorts applies patch files automatically, you may want to
@@ -609,7 +610,7 @@
     </section>
   </section>
 
-  <section>
+  <section id="portfile-development.portfile.best.practices">
     <title>Portfile Best Practices</title>
 
     <para>This section contains practical guidelines for creating Portfiles

Modified: trunk/doc/guide/new/xml/portfileref.xml
===================================================================
--- trunk/doc/guide/new/xml/portfileref.xml	2007-08-18 21:08:50 UTC (rev 28036)
+++ trunk/doc/guide/new/xml/portfileref.xml	2007-08-18 22:44:40 UTC (rev 28037)
@@ -1,14 +1,14 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
-<chapter>
+<chapter id="portfile-reference">
   <title>Portfile Reference</title>
 
   <para>This chapter serves as a reference for the major elements of a
   <filename>Portfile</filename>: port phases, variants, StartupItems,
   variables, keywords, and Tcl extensions.</para>
 
-  <section>
+  <section id="portfile-reference.port.phases">
     <title>Port Phases</title>
 
     <para>A MacPorts port has ten distinct phases. The MacPorts base is set to
@@ -19,7 +19,7 @@
     eliminate the default behavior, or augment it using pre- and/or post-
     phases as shown in the section "Portfile Development".</para>
 
-    <section>
+    <section id="portfile-reference.port.phases.fetch">
       <title>Fetch</title>
 
       <para>Overview: Fetch the <varname>${distfiles}</varname> from
@@ -27,7 +27,7 @@
       <filename>${prefix}/var/macports/distfiles</filename>.</para>
     </section>
 
-    <section>
+    <section id="portfile-reference.port.phases.checksum">
       <title>Checksum</title>
 
       <para>Overview: Compare <varname>${checksums}</varname> specified in a
@@ -35,14 +35,14 @@
       ${distfiles}.</para>
     </section>
 
-    <section>
+    <section id="portfile-reference.port.phases.extract">
       <title>Extract</title>
 
       <para>Overview: Unzip and untar the <varname>${distfiles}</varname> into
       the path ${prefix}/var/macports/build/..../work</para>
     </section>
 
-    <section>
+    <section id="portfile-reference.port.phases.patch">
       <title>Patch</title>
 
       <para>Overview: Apply optional <ulink
@@ -57,21 +57,21 @@
       diffs</ulink>.</para>
     </section>
 
-    <section>
+    <section id="portfile-reference.port.phases.configure">
       <title>Configure</title>
 
       <para>Overview: Execute the command "configure" in
       <varname>${workpath}</varname>.</para>
     </section>
 
-    <section>
+    <section id="portfile-reference.port.phases.build">
       <title>Build</title>
 
       <para>Overview: Execute the command "make" in
       <varname>${workpath}</varname>.</para>
     </section>
 
-    <section>
+    <section id="portfile-reference.port.phases.destroot">
       <title>Destroot</title>
 
       <para>Overview: Execute the command <command>make install
@@ -111,7 +111,7 @@
       keyword.</para>
     </section>
 
-    <section>
+    <section id="portfile-reference.port.phases.archive">
       <title>Archive</title>
 
       <para>Overview: Use tar to create a tarball of a port's destrooted files
@@ -119,7 +119,7 @@
       <filename>${prefix}/var/macports/packages/</filename>.</para>
     </section>
 
-    <section>
+    <section id="portfile-reference.port.phases.install">
       <title>Install</title>
 
       <para>Overview: Copy a port's destrooted files into
@@ -127,7 +127,7 @@
       in section "MacPorts Internals" for details.</para>
     </section>
 
-    <section>
+    <section id="portfile-reference.port.phases.activate">
       <title>Activate</title>
 
       <para>Overview: Set <ulink
@@ -136,7 +136,7 @@
     </section>
   </section>
 
-  <section>
+  <section id="portfile-reference.dependencies">
     <title>Dependencies</title>
 
     <para>Free and open source software is highly modular, and MacPorts ports
@@ -153,7 +153,7 @@
     with a build dependency; likewise, upgrading a port will upgrade its
     library and build dependencies also, but not its run dependencies.</para>
 
-    <section>
+    <section id="portfile-reference.dependencies.dependslib">
       <title>depends_lib</title>
 
       <para>Library dependencies are needed both at build time (for headers
@@ -162,7 +162,7 @@
       <programlisting>depends_lib         port:rrdtool</programlisting>
     </section>
 
-    <section>
+    <section id="portfile-reference.dependencies.dependsbuild">
       <title>depends_build</title>
 
       <para>Build dependencies are needed when software is compiled, but not
@@ -171,7 +171,7 @@
       <programlisting>depends_build       port:gcc42</programlisting>
     </section>
 
-    <section>
+    <section id="portfile-reference.dependencies.dependsrun">
       <title>depends_run</title>
 
       <para>Run dependencies are needed when the software is run, but not to
@@ -180,7 +180,7 @@
       <programlisting>depends_run         port:apache2</programlisting>
     </section>
 
-    <section>
+    <section id="portfile-reference.dependencies.nonport">
       <title>Non-Port Dependencies</title>
 
       <para>Port dependencies should refer to other MacPorts ports whenever
@@ -210,7 +210,7 @@
     </section>
   </section>
 
-  <section>
+  <section id="portfile-reference.startupitems">
     <title>StartupItems</title>
 
     <para>StartupItems are keywords that create Mac OS X LaunchDaemon startup
@@ -323,13 +323,13 @@
       </variablelist></para>
   </section>
 
-  <section>
+  <section id="portfile-reference.variables">
     <title>Variables</title>
 
     <para>This section describes the MacPorts preset variables that may be
     used within Portfiles.</para>
 
-    <section>
+    <section id="portfile-reference.variables.general">
       <title>General</title>
 
       <para>These are the variables available to any
@@ -456,7 +456,7 @@
         </variablelist></para>
     </section>
 
-    <section>
+    <section id="portfile-reference.variables.portgroup">
       <title>PortGroup Variables</title>
 
       <para>In addition to the general <filename>Portfile</filename> type for
@@ -669,7 +669,7 @@
     </section>
   </section>
 
-  <section>
+  <section id="portfile-reference.keywords">
     <title>Keywords</title>
 
     <para>MacPorts keywords are used to specify required or optional items
@@ -687,7 +687,7 @@
     specify information to be used during a particular installation
     phase.</para>
 
-    <section>
+    <section id="portfile-reference.keywords.append.delete">
       <title>Using -append and -delete Keywords</title>
 
       <para>It is often necessary to add to a list of keyword values
@@ -762,7 +762,7 @@
       </itemizedlist>
     </section>
 
-    <section>
+    <section id="portfile-reference.keywords.global">
       <title>Global Keywords</title>
 
       <para>The list of global keywords.</para>
@@ -956,7 +956,7 @@
       </variablelist>
     </section>
 
-    <section>
+    <section id="portfile-reference.keywords.fetch">
       <title>Fetch</title>
 
       <para>Thelist of keywords related to the fetch phase.</para>
@@ -1097,7 +1097,7 @@
       </variablelist>
     </section>
 
-    <section>
+    <section id="portfile-reference.keywords.checksum">
       <title>Checksum</title>
 
       <para>The list of keywords related to the checksum phase.</para>
@@ -1121,7 +1121,7 @@
       </variablelist>
     </section>
 
-    <section>
+    <section id="portfile-reference.keywords.extract">
       <title>Extract</title>
 
       <para>The list of keywords related to the extract phase.</para>
@@ -1209,7 +1209,7 @@
       </variablelist>
     </section>
 
-    <section>
+    <section id="portfile-reference.keywords.patch">
       <title>Patch</title>
 
       <para>The list of keywords related to the patch phase.</para>
@@ -1233,7 +1233,7 @@
       </variablelist>
     </section>
 
-    <section>
+    <section id="portfile-reference.keywords.configure">
       <title>Configure</title>
 
       <para>The list of keywords related to the configure phase.</para>
@@ -1441,7 +1441,7 @@
       </section>
     </section>
 
-    <section>
+    <section id="portfile-reference.keywords.build">
       <title>Build</title>
 
       <para>The list of keywords related to the build phase.</para>
@@ -1510,7 +1510,7 @@
       </variablelist>
     </section>
 
-    <section>
+    <section id="portfile-reference.keywords.destroot">
       <title>Destroot</title>
 
       <para>The list of keywords related to the destroot phase.</para>
@@ -1624,7 +1624,7 @@
     </section>
   </section>
 
-  <section>
+  <section id="portfile-reference.tcl.extensions">
     <title>Tcl Extensions</title>
 
     <para>A MacPorts Portfile is a Tcl script, so it may contain any arbitrary

Modified: trunk/doc/guide/new/xml/project.xml
===================================================================
--- trunk/doc/guide/new/xml/project.xml	2007-08-18 21:08:50 UTC (rev 28036)
+++ trunk/doc/guide/new/xml/project.xml	2007-08-18 22:44:40 UTC (rev 28037)
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
-<chapter>
+<chapter id="macports-project">
   <title>MacPorts Project</title>
 
   <para>The MacPorts Project uses a system called <ulink
@@ -13,7 +13,7 @@
   url="http://www.macports.org/wp-register.php">register</ulink> for a Trac
   account to create tickets.</para>
 
-  <section>
+  <section id="macports-project.creating.trac.tickets">
     <title>Creating Trac Tickets</title>
 
     <para>Once you are logged into Trac, you may click <emphasis>View Tickets
@@ -31,7 +31,7 @@
       </mediaobject>
     </screenshot>
 
-    <section>
+    <section id="macports-project.creating.trac.tickets.guidelines">
       <title>Trac Ticket Guidelines</title>
 
       <para>There are certain conventions used to ensure that Trac tickets
@@ -234,7 +234,7 @@
     </section>
   </section>
 
-  <section>
+  <section id="macports-project.contributing">
     <title>Contributing to MacPorts</title>
 
     <para>You may contribute new ports and port updates to current ports using
@@ -305,7 +305,7 @@
     </section>
   </section>
 
-  <section>
+  <section id="macports-project.port.update.policies">
     <title>Port Update Policies</title>
 
     <para>Port maintainers normally are given commit privileges to the
@@ -315,7 +315,7 @@
     port it is a good practice to inform a port's maintainer. See details
     below.</para>
 
-    <section>
+    <section id="macports-project.port.update.policies.nonmaintainer">
       <title>Non-Maintainer Port Updates</title>
 
       <para>If you have a port update or bugfix for a port you do not
@@ -374,7 +374,7 @@
       </itemizedlist>
     </section>
 
-    <section>
+    <section id="macports-project.port.update.policies.abandonment">
       <title>Port Abandonment</title>
 
       <para>A port may be considered abandoned if a bug has not been
@@ -403,7 +403,7 @@
     </section>
   </section>
 
-  <section>
+  <section id="macports-project.macports.membership">
     <title>MacPorts Membership</title>
 
     <para>A requirement for a person to become a MacPorts committer is to

Modified: trunk/doc/guide/new/xml/using.xml
===================================================================
--- trunk/doc/guide/new/xml/using.xml	2007-08-18 21:08:50 UTC (rev 28036)
+++ trunk/doc/guide/new/xml/using.xml	2007-08-18 22:44:40 UTC (rev 28037)
@@ -1,14 +1,14 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
-<chapter>
+<chapter id="using-macports">
   <title>Using MacPorts</title>
 
   <para>This chapter describes the MacPorts file hierarchy, using the
   <command>port</command> command, creating port binaries, and setting up an
   rsync replication server.</para>
 
-  <section>
+  <section id="using-macports.port.command">
     <title>The port Command</title>
 
     <para>The MacPorts <command>port</command> command is the main utility
@@ -16,7 +16,7 @@
     <filename>Portfile</filename>s and the MacPorts infrastructure, and
     install and manage ports.</para>
 
-    <section>
+    <section id="using-macports.port.command.selfupdate">
       <title>selfupdate</title>
 
       <para>The <option>selfupdate</option> option should be used regularly to
@@ -34,6 +34,10 @@
 
       <programlisting><prompt>%%</prompt> <userinput>sudo port selfupdate</userinput></programlisting>
 
+      <para>Use the debug flag for verbose output.</para>
+
+      <programlisting><prompt>%%</prompt> <userinput>sudo port -d selfupdate</userinput></programlisting>
+
       <screen>DEBUG: Rebuilding the MacPorts base system if needed.
 DEBUG: Synchronizing ports tree(s)
 Synchronizing from rsync://rsync.macports.org/release/ports/
@@ -48,7 +52,7 @@
 selfupdate done!</screen>
     </section>
 
-    <section>
+    <section id="using-macports.port.command.sync">
       <title>sync</title>
 
       <para>The sync option performs a subset of selfupdate actions. It
@@ -57,7 +61,7 @@
       reason not to, you should use <option>selfupdate</option>.</para>
     </section>
 
-    <section>
+    <section id="using-macports.port.command.list">
       <title>list</title>
 
       <para>The <option>list</option> option is used to get a list of all
@@ -66,7 +70,7 @@
       <programlisting><prompt>%%</prompt> <userinput>port list</userinput></programlisting>
     </section>
 
-    <section>
+    <section id="using-macports.port.command.search">
       <title>search</title>
 
       <para>The <option>search</option> option is very useful to find port
@@ -78,7 +82,7 @@
 php5-rrdtool     www/php5-rrdtool  1.0       PHP 5 glue for RRDtool</screen>
     </section>
 
-    <section>
+    <section id="using-macports.port.command.info">
       <title>info</title>
 
       <para>The <option>info</option> option is used to get information about
@@ -95,7 +99,7 @@
 Maintainers: nomaintainer at macports.org</screen>
     </section>
 
-    <section>
+    <section id="using-macports.port.command.deps">
       <title>deps</title>
 
       <para>The <option>deps</option> option shows you the dependencies of a
@@ -112,7 +116,7 @@
         pcre</screen>
     </section>
 
-    <section>
+    <section id="using-macports.port.command.variants">
       <title>variants</title>
 
       <para>The <option>variants</option> option allows you to check what
@@ -130,7 +134,7 @@
         no_pcre</screen>
     </section>
 
-    <section>
+    <section id="using-macports.port.command.install">
       <title>install</title>
 
       <para>The option <option>install</option> is used to install a
@@ -148,7 +152,7 @@
       <programlisting><prompt>%%</prompt> <userinput>sudo port install nmap +no_ssl</userinput></programlisting>
     </section>
 
-    <section>
+    <section id="using-macports.port.command.clean">
       <title>clean</title>
 
       <para>The option <option>clean</option> deletes all intermediate files
@@ -165,7 +169,7 @@
       </note>
     </section>
 
-    <section>
+    <section id="using-macports.port.command.uninstall">
       <title>uninstall</title>
 
       <para>The <option>uninstall</option> option will uninstall an installed
@@ -184,7 +188,7 @@
       </note>
     </section>
 
-    <section>
+    <section id="using-macports.port.command.contents">
       <title>contents</title>
 
       <para>The <option>contents</option> option displays the files that have
@@ -200,7 +204,7 @@
   /opt/local/share/doc/render/protocol</screen>
     </section>
 
-    <section>
+    <section id="using-macports.port.command.installed">
       <title>installed</title>
 
       <para>The <option>installed</option> option displays all installed
@@ -222,7 +226,7 @@
   zlib @1.2.3_1 (active)</screen>
     </section>
 
-    <section>
+    <section id="using-macports.port.command.outdated">
       <title>outdated</title>
 
       <para>The <option>outdated</option> option checks your installed ports
@@ -238,7 +242,7 @@
 pkgconfig                      0.21_0 &lt; 0.22_0</screen>
     </section>
 
-    <section>
+    <section id="using-macports.port.command.upgrade">
       <title>upgrade</title>
 
       <para>The <option>upgrade</option> option upgrades installed ports and
@@ -267,7 +271,7 @@
       </note>
     </section>
 
-    <section>
+    <section id="using-macports.port.command.dependents">
       <title>dependents</title>
 
       <para>The <option>dependents</option> option reports what ports depend
@@ -282,14 +286,14 @@
 libdap depends on openssl</screen>
     </section>
 
-    <section>
+    <section id="using-macports.port.command.livecheck">
       <title>livecheck</title>
 
       <para></para>
     </section>
   </section>
 
-  <section>
+  <section id="using-macports.port.variants">
     <title>Port Variants</title>
 
     <para>Variants are a way for port authors to provide options for a port
@@ -309,7 +313,7 @@
       for all variants.</para>
     </note>
 
-    <section>
+    <section id="using-macports.port.variants.invoking.variants">
       <title>Invoking Variants</title>
 
       <para>A variant can only be invoked when a port is installed. After you
@@ -329,7 +333,7 @@
       <screen>DEBUG: Executing variant ssl provides ssl</screen>
     </section>
 
-    <section>
+    <section id="using-macports.port.variants.negating.default.variants">
       <title>Negating Default Variants</title>
 
       <para>For an explanation of default variants, see the "Port Development"
@@ -350,21 +354,21 @@
     </section>
   </section>
 
-  <section>
+  <section id="using-macports.common.tasks">
     <title>Common Tasks</title>
 
     <para>This section lists common operations you may want to perform when
     managing a MacPorts installation.</para>
   </section>
 
-  <section>
+  <section id="using-macports.port.binaries">
     <title>Port Binaries</title>
 
     <para>MacPorts can pre-compile ports into binaries so applications need
     not be compiled when intalling on a target system. MacPorts may create two
     types of binaries: archives and packages.</para>
 
-    <section>
+    <section id="using-macports.port.binaries.binary.archives">
       <title>Binary Archives</title>
 
       <para>Binary archives can only be used on a target system running
@@ -408,7 +412,7 @@
       cpio.</para>
     </section>
 
-    <section>
+    <section id="using-macports.port.binaries.binary.packages">
       <title>Binary Packages</title>
 
       <para>Binary packages are standalone binary installers that are
@@ -434,7 +438,7 @@
       <para>All packages are placed in a port's work directory.</para>
     </section>
 
-    <section>
+    <section id="using-macports.port.binaries.port.source.packages">
       <title>Port Source Packages</title>
 
       <para>Source packages are bundles consisting of a
@@ -446,7 +450,7 @@
     </section>
   </section>
 
-  <section>
+  <section id="using-macports.rsync.replication.servers">
     <title>Rsync Replication Servers</title>
 
     <para>You may setup an rsync replication server on your local network to
@@ -456,7 +460,7 @@
     and then serves as the rsync source when rsync replication clients on the
     local network perform selfupdates.</para>
 
-    <section>
+    <section id="using-macports.rsync.replication.servers.rsync.server.setup">
       <title>Rsync Server Setup</title>
 
       <para>To setup a host as an rsync replication server, follow these
@@ -509,7 +513,7 @@
       </orderedlist>
     </section>
 
-    <section>
+    <section id="using-macports.rsync.replication.servers.rsync.client.setup">
       <title>Rsync Client Setup</title>
 
       <para>To setup a host as an rsync replication client, follow these

-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.macosforge.org/pipermail/macports-changes/attachments/20070818/0b2655a3/attachment.html


More information about the macports-changes mailing list