diff -r 71503088f51b -r f880f219c566 openpkg/license.pod --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/openpkg/license.pod Tue Jul 31 12:23:42 2012 +0200 @@ -0,0 +1,126 @@ +## +## OpenPKG License Utility +## Copyright (c) 2000-2012 OpenPKG GmbH +## +## This software is property of the OpenPKG GmbH, DE MUC HRB 160208. +## All rights reserved. Licenses which grant limited permission to use, +## copy, modify and distribute this software are available from the +## OpenPKG GmbH. +## +## THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED +## WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +## MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +## IN NO EVENT SHALL THE AUTHORS AND COPYRIGHT HOLDERS AND THEIR +## CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +## SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +## LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF +## USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND +## ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +## OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT +## OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +## SUCH DAMAGE. +## + +=pod + +=head1 NAME + +B - OpenPKG License Utility + +=head1 SYNOPSIS + +B B + +B B I I|I|C<-> + +B B I I|I|C<-> + +B B I + +B B I + +B B I + +B B + +B B + +B B + +=head1 DESCRIPTION + +The B command is the maintenance utility for OpenPKG +Framework licenses. + +=head1 COMMANDS + +=over 4 + +=item B B + +This command just displays a short usage help information. + +=item B B I I|I|C<-> + +This command installs the license contained in I or at I or +provided on F under the identifier I. The I can be an +arbitrary string, but the convention is that I is a short upper-case +identifier. + +=item B B I I|I|C<-> + +This command updates an already installed license with the license +contained in I or at I or provided on F under the +identifier I. + +=item B B I + +This command uninstalls the license which is installed under I. +A license can be uninstalled only if it is not currently activated (see +B command). + +=item B B I + +This command activates the license which is installed under I. +Only one installed license can be active at any time, so this command +implicitly deactivates the currently activate license. + +=item B B I + +This command shows the license which is installed under I. + +=item B B + +This command lists the identifiers of all installed licenses. + +=item B B + +This command outputs the identifier of the currently activated license. + +=item B B + +This command sanity checks the current license configuration. + +=back + +=head1 FILES + +=over 4 + +=item F<@l_prefix@/etc/license> + +The name of the currently activated license file under +F<@l_prefix@/etc/license.d/>. + +=item F<@l_prefix@/etc/license.d/*> + +The directory containing all installed license files. + +=back + +=head1 HISTORY + +The B command first appeared in B. + +=cut +