openpkg/license.pod@a2c6460cfb16
openpkg/license.pod
Mon, 28 Jan 2013 17:37:18 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Mon, 28 Jan 2013 17:37:18 +0100
- changeset 758
- a2c6460cfb16
- permissions
- -rw-r--r--
Correct socket error reporting improvement with IPv6 portable code,
after helpful recommendation by Saúl Ibarra Corretgé on OSips devlist.
1 ##
2 ## OpenPKG License Utility
3 ## Copyright (c) 2000-2012 OpenPKG GmbH <http://openpkg.com/>
4 ##
5 ## This software is property of the OpenPKG GmbH, DE MUC HRB 160208.
6 ## All rights reserved. Licenses which grant limited permission to use,
7 ## copy, modify and distribute this software are available from the
8 ## OpenPKG GmbH.
9 ##
10 ## THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED
11 ## WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
12 ## MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
13 ## IN NO EVENT SHALL THE AUTHORS AND COPYRIGHT HOLDERS AND THEIR
14 ## CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
15 ## SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
16 ## LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
17 ## USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
18 ## ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
19 ## OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
20 ## OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
21 ## SUCH DAMAGE.
22 ##
24 =pod
26 =head1 NAME
28 B<openpkg license> - OpenPKG License Utility
30 =head1 SYNOPSIS
32 B<openpkg license> B<help>
34 B<openpkg license> B<install> I<id> I<file>|I<url>|C<->
36 B<openpkg license> B<update> I<id> I<file>|I<url>|C<->
38 B<openpkg license> B<uninstall> I<id>
40 B<openpkg license> B<activate> I<id>
42 B<openpkg license> B<view> I<id>
44 B<openpkg license> B<list>
46 B<openpkg license> B<active>
48 B<openpkg license> B<sanity>
50 =head1 DESCRIPTION
52 The B<openpkg license> command is the maintenance utility for OpenPKG
53 Framework licenses.
55 =head1 COMMANDS
57 =over 4
59 =item B<openpkg license> B<help>
61 This command just displays a short usage help information.
63 =item B<openpkg license> B<install> I<id> I<file>|I<url>|C<->
65 This command installs the license contained in I<file> or at I<url> or
66 provided on F<stdin> under the identifier I<id>. The I<id> can be an
67 arbitrary string, but the convention is that I<id> is a short upper-case
68 identifier.
70 =item B<openpkg license> B<update> I<id> I<file>|I<url>|C<->
72 This command updates an already installed license with the license
73 contained in I<file> or at I<url> or provided on F<stdin> under the
74 identifier I<id>.
76 =item B<openpkg license> B<uninstall> I<id>
78 This command uninstalls the license which is installed under I<id>.
79 A license can be uninstalled only if it is not currently activated (see
80 B<openpkg license activate> command).
82 =item B<openpkg license> B<activate> I<id>
84 This command activates the license which is installed under I<id>.
85 Only one installed license can be active at any time, so this command
86 implicitly deactivates the currently activate license.
88 =item B<openpkg license> B<view> I<id>
90 This command shows the license which is installed under I<id>.
92 =item B<openpkg license> B<list>
94 This command lists the identifiers of all installed licenses.
96 =item B<openpkg license> B<active>
98 This command outputs the identifier of the currently activated license.
100 =item B<openpkg license> B<sanity>
102 This command sanity checks the current license configuration.
104 =back
106 =head1 FILES
108 =over 4
110 =item F<@l_prefix@/etc/license>
112 The name of the currently activated license file under
113 F<@l_prefix@/etc/license.d/>.
115 =item F<@l_prefix@/etc/license.d/*>
117 The directory containing all installed license files.
119 =back
121 =head1 HISTORY
123 The B<openpkg license> command first appeared in B<OpenPKG 4.0>.
125 =cut
