Changeset 134965 for trunk/base/doc


Ignore:
Timestamp:
Apr 12, 2015, 7:05:22 PM (4 years ago)
Author:
cal@…
Message:

base: document port sync, #44530

File:
1 copied

Legend:

Unmodified
Added
Removed
  • trunk/base/doc/port-sync.1.txt

    r133158 r134965  
    11// vim: set et sw=4 ts=8 ft=asciidoc tw=80:
    2 port-selfupdate(1)
    3 ==================
     2port-sync(1)
     3============
    44$Id$
    55
    66NAME
    77----
    8 port-selfupdate - Upgrade MacPorts itself and update the port definition files.
     8port-sync - Update the port definition files
    99
    1010SYNOPSIS
    1111--------
    1212[cmdsynopsis]
    13 *port* [*-qvdf*] *selfupdate* [--nosync]
     13*port* [*-qvd*] *sync*
    1414
    1515DESCRIPTION
    1616-----------
    17 *port selfupdate* checks for new releases of MacPorts and upgrades it when
    18 necessary. *selfupdate* also updates the local port definitions (the so-called
    19 ports tree) to the latest state so you have the latest versions of ports
    20 available. This part of the operation corresponds to man:port-sync[1].
     17*port sync* updates the local port definitions (the so-called ports tree) to the
     18latest state so you have the latest versions of ports available. You should
     19normally not run *port sync* directly, but use *port selfupdate*, which updates
     20MacPorts itself and then proceeds to do the same operation as *sync* does. You
     21can, however, use *port sync* if you know that *selfupdate* does not work on
     22your system or in your network environment, for example because your network
     23administrator blocks outbound rsync connections and you have changed your
     24man:sources.conf[5] to use a different method of obtaining the ports tree.
    2125
    22 You should regularly run *selfupdate* to update your local port definitions.
    23 Running *selfupdate* is required to get updated software with bug fixes and new
     26Running *sync* is required to get updated software with bug fixes and new
    2427features.
    2528
    26 OPTIONS
    27 -------
    28 
    29 *--nosync*::
    30     Only check for updates - and install if available - for MacPorts itself. Do
    31     not update the ports tree.
     29[WARNING]
     30====
     31When you use *port sync*, it is your responsibility to check whether new updates
     32are available for MacPorts itself, and update them, when necessary. The MacPorts
     33project will start to use new features in port definitions one week after the
     34release of the new version, and you may run into problems when your MacPorts
     35version has not been updated.
     36====
    3237
    3338include::global-flags.txt[]
     
    3641    Supress status output, be as silent as possible.
    3742
    38 *-f*::
    39     Do not check whether the downloaded MacPorts version is newer than the
    40     currently installed one, but always rebuild and reinstall MacPorts.
    41     +
    42     You can use this to downgrade from a beta or development version to the
    43     latest release. Note that there is no guarantee that there have not been
    44     made incompatible and irreversible changes to MacPorts' internal data
    45     structures, making a downgrade impossible.
    46 
    47 EXAMPLES
    48 --------
    49 When no new versions are available, *selfupdate* looks like this:
    50 
    51 [subs="verbatim,attributes"]
    52 ----
    53 $ sudo port selfupdate
    54 ---> Updating MacPorts base sources using rsync
    55 MacPorts base version {manversion} installed,
    56 MacPorts base version {manversion} downloaded.
    57 ---> Updating the ports tree
    58 ---> MacPorts base is already the latest version
    59 ----
    60 
    61 If *selfupdate* detects that a newer version of MacPorts is available, it
    62 attempts to update your copy to this version. In that case, the output will be
    63 different:
    64 
    65 [subs="verbatim,attributes"]
    66 ----
    67 $ sudo port selfupdate
    68 ---> Updating MacPorts base sources using rsync
    69 MacPorts base version 2.3.0 installed,
    70 MacPorts base version {manversion} downloaded.
    71 ---> Updating the ports tree
    72 ---> MacPorts base is outdated, installing new version {manversion}
    73 Installing new MacPorts release in /opt/local as root:admin; permissions 755
    74 ----
    75 
    76 TROUBLESHOOTING
    77 ---------------
    78 If *selfupdate* fails, it usually does so in one of two places: The network
    79 connection, or the installation of the update.
    80 
    81 Network Problems::
    82 MacPorts uses the 'rsync' protocol to update its sources to the latest version.
    83 This will fail if you are on a network that blocks TCP connections to the rsync
    84 port 873. Talk to your network administrators and ask them to allow connections
    85 to port 873 if this happens to you. Alternatively, you can just download a new
    86 installer .pkg from macports.org and run that to upgrade your installation.
    87 +
    88 Network connection problems might also affect you if you are in a country with
    89 US export restrictions. We suggest using one of our other
    90 wiki:Mirrors#MacPortsSource[mirrors] outside of the US in these cases.
    91 
    92 Compilation Problems::
    93 When a problem occurs while building and installing the new MacPorts version,
    94 you will see the message
    95 +
    96 ----
    97 Error installing new MacPorts base: command execution failed
    98 ----
    99 +
    100 To find out what went wrong, re-run *selfupdate* with the *-d* flag. This will
    101 allow you to see all output generated by the build system. Look for the first
    102 occurance of ``error''. If you cannot figure out what's wrong on your own, feel
    103 free to ask on mailto:macports-users@lists.macosforge.org[the macports-users
    104 mailing list] and attach the output generated by
    105 +
    106 ----
    107 $ sudo port -d selfupdate
    108 ----
    109 
    110 
    11143SEE ALSO
    11244--------
    113 man:port[1], man:port-sync[1]
     45man:port[1], man:port-selfupdate[1]
    11446
    11547AUTHORS
    11648-------
    117  (C) 2014 The MacPorts Project
     49 (C) 2015 The MacPorts Project
    11850 Clemens Lang <cal@macports.org>
Note: See TracChangeset for help on using the changeset viewer.