comparison: openpkg/license.pod
openpkg/license.pod
- changeset 468
- 695288b7c41a
equal
deleted
inserted
replaced
| -1:000000000000 | 0:e386395361a6 |
|---|---|
| 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 ## | |
| 23 | |
| 24 =pod | |
| 25 | |
| 26 =head1 NAME | |
| 27 | |
| 28 B<openpkg license> - OpenPKG License Utility | |
| 29 | |
| 30 =head1 SYNOPSIS | |
| 31 | |
| 32 B<openpkg license> B<help> | |
| 33 | |
| 34 B<openpkg license> B<install> I<id> I<file>|I<url>|C<-> | |
| 35 | |
| 36 B<openpkg license> B<update> I<id> I<file>|I<url>|C<-> | |
| 37 | |
| 38 B<openpkg license> B<uninstall> I<id> | |
| 39 | |
| 40 B<openpkg license> B<activate> I<id> | |
| 41 | |
| 42 B<openpkg license> B<view> I<id> | |
| 43 | |
| 44 B<openpkg license> B<list> | |
| 45 | |
| 46 B<openpkg license> B<active> | |
| 47 | |
| 48 B<openpkg license> B<sanity> | |
| 49 | |
| 50 =head1 DESCRIPTION | |
| 51 | |
| 52 The B<openpkg license> command is the maintenance utility for OpenPKG | |
| 53 Framework licenses. | |
| 54 | |
| 55 =head1 COMMANDS | |
| 56 | |
| 57 =over 4 | |
| 58 | |
| 59 =item B<openpkg license> B<help> | |
| 60 | |
| 61 This command just displays a short usage help information. | |
| 62 | |
| 63 =item B<openpkg license> B<install> I<id> I<file>|I<url>|C<-> | |
| 64 | |
| 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. | |
| 69 | |
| 70 =item B<openpkg license> B<update> I<id> I<file>|I<url>|C<-> | |
| 71 | |
| 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>. | |
| 75 | |
| 76 =item B<openpkg license> B<uninstall> I<id> | |
| 77 | |
| 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). | |
| 81 | |
| 82 =item B<openpkg license> B<activate> I<id> | |
| 83 | |
| 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. | |
| 87 | |
| 88 =item B<openpkg license> B<view> I<id> | |
| 89 | |
| 90 This command shows the license which is installed under I<id>. | |
| 91 | |
| 92 =item B<openpkg license> B<list> | |
| 93 | |
| 94 This command lists the identifiers of all installed licenses. | |
| 95 | |
| 96 =item B<openpkg license> B<active> | |
| 97 | |
| 98 This command outputs the identifier of the currently activated license. | |
| 99 | |
| 100 =item B<openpkg license> B<sanity> | |
| 101 | |
| 102 This command sanity checks the current license configuration. | |
| 103 | |
| 104 =back | |
| 105 | |
| 106 =head1 FILES | |
| 107 | |
| 108 =over 4 | |
| 109 | |
| 110 =item F<@l_prefix@/etc/license> | |
| 111 | |
| 112 The name of the currently activated license file under | |
| 113 F<@l_prefix@/etc/license.d/>. | |
| 114 | |
| 115 =item F<@l_prefix@/etc/license.d/*> | |
| 116 | |
| 117 The directory containing all installed license files. | |
| 118 | |
| 119 =back | |
| 120 | |
| 121 =head1 HISTORY | |
| 122 | |
| 123 The B<openpkg license> command first appeared in B<OpenPKG 4.0>. | |
| 124 | |
| 125 =cut | |
| 126 |
