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