Changeset 28843 for trunk/doc


Ignore:
Timestamp:
Sep 10, 2007, 7:50:14 AM (12 years ago)
Author:
markd@…
Message:

Committed corrections submitted by simon@.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc/guide/new/xml/using.xml

    r28268 r28843  
    2828      <note>
    2929        <para>Selfupdate runs only on Mac OS X. If you are running MacPorts on
    30         another platform, you must use <option>sync</option> (see below) to
    31         update the ports tree, and you must update MacPorts base by manually
    32         installing newer versions.</para>
     30        another platform, you must use option <link
     31        linkend="using.port.sync">sync</link> to update the ports tree; to
     32        update MacPorts base you must manually install a newer version from
     33        source.</para>
    3334      </note>
    3435
     
    5657      <title>sync</title>
    5758
    58       <para>The sync option performs a subset of selfupdate actions. It
    59       synchronizes the ports tree, as does <option>selfupdate</option>, but it
    60       does not check for upgrades to MacPorts base. Unless you have a special
    61       reason not to, you should use <option>selfupdate</option>.</para>
     59      <para>The <option>sync</option> option performs a subset of
     60      <option>selfupdate</option> actions. It synchronizes the ports tree, as
     61      does <option>selfupdate</option>, but it does not check for upgrades to
     62      MacPorts base. On OS X, unless there is a special reason not to do so,
     63      you should run <link
     64      linkend="using.port.selfupdate">selfupdate</link>.</para>
     65
     66      <note>
     67        <para>For platforms other than OS X, <option>sync</option> is the only
     68        way to get port updates because <option>selfupdate</option> is
     69        supported only on OS X.</para>
     70      </note>
    6271    </section>
    6372
     
    6675
    6776      <para>The <option>list</option> option is used to get a list of all
    68       available ports.</para>
     77      available ports. The list of available ports is very long, so use <link
     78      linkend="using.port.search">search</link> if you know a port's name or
     79      part of it.</para>
    6980
    7081      <programlisting><prompt>%%</prompt> <userinput>port list</userinput></programlisting>
     
    147158        <para>You may break up a port's installation into smaller steps for
    148159        troubleshooting by passing <command>port</command> a prior
    149         installation phase such as fetch, configure, build, or
    150         destroot.</para>
     160        installation phase such as fetch, configure, build, or destroot. See
     161        section <link linkend="development.phases">Port Phases</link> for a
     162        complete list of phases.</para>
    151163      </note>
    152164    </section>
     
    180192        <para>If a port as installed as a dependency of another port,
    181193        uninstall will not remove it unless you remove the dependent ports
    182         first. To override this behavior, use the -f (force) switch. But some
    183         ports need to be rebuilt if dependencies change, so you should know
    184         what you are doing if you force uninstall ports.</para>
     194        first. To override this behavior, use the <option>-f</option> (force)
     195        switch. But some ports need to be rebuilt if dependencies change, so
     196        you should know what you are doing if you force uninstall
     197        ports.</para>
    185198
    186199        <programlisting><prompt>%%</prompt> <userinput>port -f uninstall vile</userinput></programlisting>
     
    192205
    193206      <para>The <option>contents</option> option displays the files that have
    194       been installed by a given port.</para>
     207      been installed by a given port. Uninstalled ports will always show no
     208      contents.</para>
    195209
    196210      <programlisting><prompt>%%</prompt> <userinput>port contents render</userinput></programlisting>
     
    251265      <programlisting><prompt>%%</prompt> <userinput>port upgrade gnome</userinput></programlisting>
    252266
    253       <para>If you wish not to upgrade a port's dependencies, use the -n
    254       switch.</para>
     267      <para>If you wish not to upgrade a port's dependencies, use the
     268      <option>-n</option> switch.</para>
    255269
    256270      <programlisting><prompt>%%</prompt> <userinput>port -n upgrade gnome</userinput></programlisting>
     
    268282        linkend="reference.phases.activate">Activate</link> phases in <link
    269283        linkend="reference.phases">Port Phases</link>. If you wish to
    270         uninstall the old version use the -u option.</para>
     284        uninstall the old version, use the <option>-u</option> option.</para>
    271285
    272286        <programlisting><prompt>%%</prompt> <userinput>port -u upgrade vile</userinput></programlisting>
     
    291305    <section id="using.port.livecheck">
    292306      <title>livecheck</title>
     307
     308      <para>The livecheck option checks to see if the application
     309      corresponding to a given port has been updated at the developer's
     310      download site. It's especially useful for port maintainers, but others
     311      may also wish to see if a port has the latest available distribution
     312      source. See section <link linkend="reference.livecheck">Livecheck</link>
     313      for more information.</para>
     314
     315      <programlisting><prompt>%%</prompt> <userinput>port livecheck rrdtool</userinput></programlisting>
     316
     317      <screen>rrdtool seems to have been updated (port version: 1.2.23, new version: 1.3beta1)</screen>
     318
     319      <note>
     320        <para>If livecheck finds no higher version at the port's download
     321        site, it prints nothing. The option <option>-d</option> (debug) may be
     322        used for detailed livecheck processing information.</para>
     323      </note>
    293324
    294325      <para></para>
     
    351382      reported in any way by the <command>port</command> command, as if they
    352383      did not exist. You will know you have successfully negated the default
    353       variant in the example above if you do NOT see this line in the verbose
    354       output.</para>
     384      variant in the example above if you do <emphasis>not</emphasis> see this
     385      line in the verbose output.</para>
    355386
    356387      <screen>DEBUG: Executing variant ssl provides ssl</screen>
     
    363394    <para>This section lists common operations you may want to perform when
    364395    managing a MacPorts installation.</para>
     396
     397    <para>TODO: Add content here.</para>
    365398  </section>
    366399
     
    460493    minimize internet delay and bandwidth when performing MacPorts selfupdate
    461494    operations. An rsync replication server pulls the latest MacPorts base,
    462     development, and ports tree from the remote MacPorts subversion server,
     495    development, and port sources from the remote MacPorts subversion server,
    463496    and then serves as the rsync source when rsync replication clients on the
    464     local network perform selfupdates.</para>
     497    local network perform selfupdates. </para>
     498
     499    <note>
     500      <para>Only advanced users should attempt to setup an rsync replication
     501      server. Before doing so, please contact <email>portmgr @
     502      macports.org</email>. If the scripts are run too often you may overload
     503      the MacPorts rsync mirrors; it must not be run any more often than each
     504      one-half hour and should be run at an offset to the clock half hour
     505      periods.</para>
     506    </note>
    465507
    466508    <section id="using.rsync-replication.server-setup">
    467509      <title>Rsync Server Setup</title>
     510
     511      <para>TODO: This section needs to be completed.</para>
    468512
    469513      <para>To setup a host as an rsync replication server, follow these
     
    502546          <note>
    503547            <para>If you wish to setup and rsync replication server, please
    504             contact portmgr@macports.org. It is important not to run the
    505             scripts too often or you may overload the MacPorts rsync mirrors.
    506             It must not be run any more often than each one-half hour and also
    507             should not be run at the half hour, but rather at an
    508             offset.</para>
     548            contact portmgr@macports.org. If the scripts are run too often you
     549            may overload the MacPorts rsync mirrors; It must not be run any
     550            more often than each one-half hour and should be run at an offset
     551            to the clock half hour periods.</para>
    509552          </note>
    510553
Note: See TracChangeset for help on using the changeset viewer.