1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/openpkg/license.pod Tue Jul 31 12:23:42 2012 +0200
1.3 @@ -0,0 +1,126 @@
1.4 +##
1.5 +## OpenPKG License Utility
1.6 +## Copyright (c) 2000-2012 OpenPKG GmbH <http://openpkg.com/>
1.7 +##
1.8 +## This software is property of the OpenPKG GmbH, DE MUC HRB 160208.
1.9 +## All rights reserved. Licenses which grant limited permission to use,
1.10 +## copy, modify and distribute this software are available from the
1.11 +## OpenPKG GmbH.
1.12 +##
1.13 +## THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED
1.14 +## WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
1.15 +## MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
1.16 +## IN NO EVENT SHALL THE AUTHORS AND COPYRIGHT HOLDERS AND THEIR
1.17 +## CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
1.18 +## SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
1.19 +## LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
1.20 +## USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
1.21 +## ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
1.22 +## OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
1.23 +## OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
1.24 +## SUCH DAMAGE.
1.25 +##
1.26 +
1.27 +=pod
1.28 +
1.29 +=head1 NAME
1.30 +
1.31 +B<openpkg license> - OpenPKG License Utility
1.32 +
1.33 +=head1 SYNOPSIS
1.34 +
1.35 +B<openpkg license> B<help>
1.36 +
1.37 +B<openpkg license> B<install> I<id> I<file>|I<url>|C<->
1.38 +
1.39 +B<openpkg license> B<update> I<id> I<file>|I<url>|C<->
1.40 +
1.41 +B<openpkg license> B<uninstall> I<id>
1.42 +
1.43 +B<openpkg license> B<activate> I<id>
1.44 +
1.45 +B<openpkg license> B<view> I<id>
1.46 +
1.47 +B<openpkg license> B<list>
1.48 +
1.49 +B<openpkg license> B<active>
1.50 +
1.51 +B<openpkg license> B<sanity>
1.52 +
1.53 +=head1 DESCRIPTION
1.54 +
1.55 +The B<openpkg license> command is the maintenance utility for OpenPKG
1.56 +Framework licenses.
1.57 +
1.58 +=head1 COMMANDS
1.59 +
1.60 +=over 4
1.61 +
1.62 +=item B<openpkg license> B<help>
1.63 +
1.64 +This command just displays a short usage help information.
1.65 +
1.66 +=item B<openpkg license> B<install> I<id> I<file>|I<url>|C<->
1.67 +
1.68 +This command installs the license contained in I<file> or at I<url> or
1.69 +provided on F<stdin> under the identifier I<id>. The I<id> can be an
1.70 +arbitrary string, but the convention is that I<id> is a short upper-case
1.71 +identifier.
1.72 +
1.73 +=item B<openpkg license> B<update> I<id> I<file>|I<url>|C<->
1.74 +
1.75 +This command updates an already installed license with the license
1.76 +contained in I<file> or at I<url> or provided on F<stdin> under the
1.77 +identifier I<id>.
1.78 +
1.79 +=item B<openpkg license> B<uninstall> I<id>
1.80 +
1.81 +This command uninstalls the license which is installed under I<id>.
1.82 +A license can be uninstalled only if it is not currently activated (see
1.83 +B<openpkg license activate> command).
1.84 +
1.85 +=item B<openpkg license> B<activate> I<id>
1.86 +
1.87 +This command activates the license which is installed under I<id>.
1.88 +Only one installed license can be active at any time, so this command
1.89 +implicitly deactivates the currently activate license.
1.90 +
1.91 +=item B<openpkg license> B<view> I<id>
1.92 +
1.93 +This command shows the license which is installed under I<id>.
1.94 +
1.95 +=item B<openpkg license> B<list>
1.96 +
1.97 +This command lists the identifiers of all installed licenses.
1.98 +
1.99 +=item B<openpkg license> B<active>
1.100 +
1.101 +This command outputs the identifier of the currently activated license.
1.102 +
1.103 +=item B<openpkg license> B<sanity>
1.104 +
1.105 +This command sanity checks the current license configuration.
1.106 +
1.107 +=back
1.108 +
1.109 +=head1 FILES
1.110 +
1.111 +=over 4
1.112 +
1.113 +=item F<@l_prefix@/etc/license>
1.114 +
1.115 +The name of the currently activated license file under
1.116 +F<@l_prefix@/etc/license.d/>.
1.117 +
1.118 +=item F<@l_prefix@/etc/license.d/*>
1.119 +
1.120 +The directory containing all installed license files.
1.121 +
1.122 +=back
1.123 +
1.124 +=head1 HISTORY
1.125 +
1.126 +The B<openpkg license> command first appeared in B<OpenPKG 4.0>.
1.127 +
1.128 +=cut
1.129 +
