[123022] trunk/base/doc

[cal at macports.org]

Revision: 123022
          https://trac.macports.org/changeset/123022
Author:   cal at macports.org
Date:     2014-08-03 15:16:08 -0700 (Sun, 03 Aug 2014)
Log Message:
-----------
base: document port selfupdate

Modified Paths:
--------------
    trunk/base/doc/Makefile.in

Added Paths:
-----------
    trunk/base/doc/port-selfupdate.1.txt

Modified: trunk/base/doc/Makefile.in
===================================================================
--- trunk/base/doc/Makefile.in	2014-08-03 21:09:46 UTC (rev 123021)
+++ trunk/base/doc/Makefile.in	2014-08-03 22:16:08 UTC (rev 123022)
@@ -30,6 +30,7 @@
 		port-install.1 \
 		port-patch.1 \
 		port-rev-upgrade.1 \
+		port-selfupdate.1 \
 		port-uninstall.1 \
 		port.1 \
 

Copied: trunk/base/doc/port-selfupdate.1.txt (from rev 123016, trunk/base/doc/port-contents.1.txt)
===================================================================
--- trunk/base/doc/port-selfupdate.1.txt	                        (rev 0)
+++ trunk/base/doc/port-selfupdate.1.txt	2014-08-03 22:16:08 UTC (rev 123022)
@@ -0,0 +1,118 @@
+// vim: set et sw=4 ts=8 ft=asciidoc tw=80:
+port-selfupdate(1)
+==================
+$Id$
+
+NAME
+----
+port-selfupdate - Upgrade MacPorts itself and update the port definition files.
+
+SYNOPSIS
+--------
+[cmdsynopsis]
+*port* [*-qvdf*] *selfupdate* [--nosync]
+
+DESCRIPTION
+-----------
+*port selfupdate* checks for new releases of MacPorts and upgrades it when
+necessary. *selfupdate* also updates the local port definitions (the so-called
+ports tree) to the latest state so you have the latest versions of ports
+available. This part of the operation corresponds to man:port-sync[1].
+
+You should regularly run *selfupdate* to update your local port definitions.
+Running *selfupdate* is required to get updated software with bug fixes and new
+features.
+
+OPTIONS
+-------
+
+--nosync::
+    Only check for updates - and install if available - for MacPorts itself. Do
+    not update the ports tree.
+
+include::global-flags.txt[]
+
+-q::
+    Supress status output, be as silent as possible.
+
+-f::
+    Do not check whether the downloaded MacPorts version is newer than the
+    currently installed one, but always rebuild and reinstall MacPorts.
+    +
+    You can use this to downgrade from a beta or development version to the
+    latest release. Note that there is no guarantee that there have not been
+    made incompatible and irreversible changes to MacPorts' internal data
+    structures, making a downgrade impossible.
+
+EXAMPLES
+--------
+When no new versions are available, *selfupdate* looks like this:
+
+[subs="verbatim,attributes"]
+----
+$ sudo port selfupdate
+---> Updating MacPorts base sources using rsync
+MacPorts base version {manversion} installed,
+MacPorts base version {manversion} downloaded.
+---> Updating the ports tree
+---> MacPorts base is already the latest version
+----
+
+If *selfupdate* detects that a newer version of MacPorts is available, it
+attempts to update your copy to this version. In that case, the output will be
+different:
+
+[subs="verbatim,attributes"]
+----
+$ sudo port selfupdate
+---> Updating MacPorts base sources using rsync
+MacPorts base version 2.3.0 installed,
+MacPorts base version {manversion} downloaded.
+---> Updating the ports tree
+---> MacPorts base is outdated, installing new version {manversion}
+Installing new MacPorts release in /opt/local as root:admin; permissions 755
+----
+
+TROUBLESHOOTING
+---------------
+If *selfupdate* fails, it usually does so in one of two places: The network
+connection, or the installation of the update.
+
+Network Problems::
+MacPorts uses the 'rsync' protocol to update its sources to the latest version.
+This will fail if you are on a network that blocks TCP connections to the rsync
+port 873. Talk to your network administrators and ask them to allow connections
+to port 873 if this happens to you. Alternatively, you can just download a new
+installer .pkg from macports.org and run that to upgrade your installation.
++
+Network connection problems might also affect you if you are in a country with
+US export restrictions. We suggest using one of our other
+wiki:Mirrors#MacPortsSource[mirrors] outside of the US in these cases.
+
+Compilation Problems::
+When a problem occurs while building and installing the new MacPorts version,
+you will see the message
++
+----
+Error installing new MacPorts base: command execution failed
+----
++
+To find out what went wrong, re-run *selfupdate* with the *-d* flag. This will
+allow you to see all output generated by the build system. Look for the first
+occurance of ``error''. If you cannot figure out what's wrong on your own, feel
+free to ask on mailto:macports-users at lists.macosforge.org[the macports-users
+mailing list] and attach the output generated by
++
+----
+$ sudo port -d selfupdate
+----
+
+
+SEE ALSO
+--------
+man:port[1], man:port-sync[1]
+
+AUTHORS
+-------
+ (C) 2014 The MacPorts Project
+ Clemens Lang <cal at macports.org>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.macosforge.org/pipermail/macports-changes/attachments/20140803/33ca85ea/attachment.html>