Changeset 124481


Ignore:
Timestamp:
Aug 24, 2014, 9:27:18 PM (5 years ago)
Author:
cal@…
Message:

base: document port {load,unload,reload}

Location:
trunk/base/doc
Files:
2 added
1 copied

Legend:

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

    r124479 r124481  
    11// vim: set et sw=4 ts=8 ft=asciidoc tw=80:
    2 port-activate(1)
    3 ================
     2port-load(1)
     3============
    44$Id$
    55
    66NAME
    77----
    8 port-activate, port-deactivate - Change active version of an installed port
     8port-load, port-unload, port-reload - Control daemons installed by a port
    99
    1010SYNOPSIS
    1111--------
    1212[cmdsynopsis]
    13 *port* [*-vdf*] [*-D* 'portdir'] *activate*
    14      [--no-exec]
    15      [['portname' | 'pseudo-portname' | 'port-expressions' | 'port-url']]
    16      ['@version']
    17 
    18 [cmdsynopsis]
    19 *port* [*-vdf*] [*-D* 'portdir'] *deactivate*
    20      [--no-exec]
     13*port* [*-d*] [*-D* 'portdir'] [*load* | *unload* | *reload*]
    2114     [['portname' | 'pseudo-portname' | 'port-expressions' | 'port-url']]
    2215
    2316DESCRIPTION
    2417-----------
    25 *port activate* will set the status of an previously installed version of a port
    26 to active. The passed ports have to reference already installed versions.
     18These commands control the daemons that are installed by some of the ports. If
     19a port provides daemon functionality, a note will be printed during installation
     20advising you how to use it.
    2721
    28 *port deactivate* will set the status of a port to inactive. The passed ports
    29 have to be active at the moment. You will be warned if this port has active
    30 dependents.
     22The daemon functionality is provided by installing a man:launchd[8]
     23configuration file (see man:launchd.conf[5]) and calling man:launchctl[1] on
     24your behalf. *port load* advises launchd to start the daemon defined by a port's
     25configuration file, also called a ``startup item''. Once loaded, launchd will
     26preserve this state - even across reboots - until the daemon is unloaded using
     27*port unload*. If you want to restart a daemon, you can use *port reload*, which
     28is a convenience wrapper around *port unload* followed by a short delay and
     29*port load*.
    3130
    32 // [NOTE]
    33 If any version is active at the time of using *port activate*, it will be
    34 deactivated first. This can be used to switch from one version to another.
    35 
    36 include::archives.txt[]
    37 
    38 OPTIONS
    39 -------
    40 
    41 *--no-exec*::
    42     Do not execute any stored pre- or post-uninstall procedures.
    43 
     31In theory, MacPorts supports generating startup items for older releases of OS
     32X. In practice, these commands can not deal with pre-launchd interfaces and will
     33fail on these systems.
    4434
    4535include::global-flags.txt[]
    4636
    47 
    4837SEE ALSO
    4938--------
    50 man:port[1], man:port-install[1], man:port-installed[1],
    51 man:port-deactivate[1]
     39man:port[1], man:launchd[8], man:launchd.conf[5], man:launchctl[1]
    5240
    5341AUTHORS
    5442-------
    55  (C) 2009 The MacPorts Project
    56  Rainer Mueller <raimue@macports.org>
     43 (C) 2014 The MacPorts Project
     44 Clemens Lang <cal@macports.org>
Note: See TracChangeset for help on using the changeset viewer.