openpkg/license.pod@a2c6460cfb16 (annotated)
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.
| michael@428 | 1 | ## |
| michael@428 | 2 | ## OpenPKG License Utility |
| michael@428 | 3 | ## Copyright (c) 2000-2012 OpenPKG GmbH <http://openpkg.com/> |
| michael@428 | 4 | ## |
| michael@428 | 5 | ## This software is property of the OpenPKG GmbH, DE MUC HRB 160208. |
| michael@428 | 6 | ## All rights reserved. Licenses which grant limited permission to use, |
| michael@428 | 7 | ## copy, modify and distribute this software are available from the |
| michael@428 | 8 | ## OpenPKG GmbH. |
| michael@428 | 9 | ## |
| michael@428 | 10 | ## THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED |
| michael@428 | 11 | ## WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF |
| michael@428 | 12 | ## MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. |
| michael@428 | 13 | ## IN NO EVENT SHALL THE AUTHORS AND COPYRIGHT HOLDERS AND THEIR |
| michael@428 | 14 | ## CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| michael@428 | 15 | ## SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| michael@428 | 16 | ## LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF |
| michael@428 | 17 | ## USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND |
| michael@428 | 18 | ## ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, |
| michael@428 | 19 | ## OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT |
| michael@428 | 20 | ## OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
| michael@428 | 21 | ## SUCH DAMAGE. |
| michael@428 | 22 | ## |
| michael@428 | 23 | |
| michael@428 | 24 | =pod |
| michael@428 | 25 | |
| michael@428 | 26 | =head1 NAME |
| michael@428 | 27 | |
| michael@428 | 28 | B<openpkg license> - OpenPKG License Utility |
| michael@428 | 29 | |
| michael@428 | 30 | =head1 SYNOPSIS |
| michael@428 | 31 | |
| michael@428 | 32 | B<openpkg license> B<help> |
| michael@428 | 33 | |
| michael@428 | 34 | B<openpkg license> B<install> I<id> I<file>|I<url>|C<-> |
| michael@428 | 35 | |
| michael@428 | 36 | B<openpkg license> B<update> I<id> I<file>|I<url>|C<-> |
| michael@428 | 37 | |
| michael@428 | 38 | B<openpkg license> B<uninstall> I<id> |
| michael@428 | 39 | |
| michael@428 | 40 | B<openpkg license> B<activate> I<id> |
| michael@428 | 41 | |
| michael@428 | 42 | B<openpkg license> B<view> I<id> |
| michael@428 | 43 | |
| michael@428 | 44 | B<openpkg license> B<list> |
| michael@428 | 45 | |
| michael@428 | 46 | B<openpkg license> B<active> |
| michael@428 | 47 | |
| michael@428 | 48 | B<openpkg license> B<sanity> |
| michael@428 | 49 | |
| michael@428 | 50 | =head1 DESCRIPTION |
| michael@428 | 51 | |
| michael@428 | 52 | The B<openpkg license> command is the maintenance utility for OpenPKG |
| michael@428 | 53 | Framework licenses. |
| michael@428 | 54 | |
| michael@428 | 55 | =head1 COMMANDS |
| michael@428 | 56 | |
| michael@428 | 57 | =over 4 |
| michael@428 | 58 | |
| michael@428 | 59 | =item B<openpkg license> B<help> |
| michael@428 | 60 | |
| michael@428 | 61 | This command just displays a short usage help information. |
| michael@428 | 62 | |
| michael@428 | 63 | =item B<openpkg license> B<install> I<id> I<file>|I<url>|C<-> |
| michael@428 | 64 | |
| michael@428 | 65 | This command installs the license contained in I<file> or at I<url> or |
| michael@428 | 66 | provided on F<stdin> under the identifier I<id>. The I<id> can be an |
| michael@428 | 67 | arbitrary string, but the convention is that I<id> is a short upper-case |
| michael@428 | 68 | identifier. |
| michael@428 | 69 | |
| michael@428 | 70 | =item B<openpkg license> B<update> I<id> I<file>|I<url>|C<-> |
| michael@428 | 71 | |
| michael@428 | 72 | This command updates an already installed license with the license |
| michael@428 | 73 | contained in I<file> or at I<url> or provided on F<stdin> under the |
| michael@428 | 74 | identifier I<id>. |
| michael@428 | 75 | |
| michael@428 | 76 | =item B<openpkg license> B<uninstall> I<id> |
| michael@428 | 77 | |
| michael@428 | 78 | This command uninstalls the license which is installed under I<id>. |
| michael@428 | 79 | A license can be uninstalled only if it is not currently activated (see |
| michael@428 | 80 | B<openpkg license activate> command). |
| michael@428 | 81 | |
| michael@428 | 82 | =item B<openpkg license> B<activate> I<id> |
| michael@428 | 83 | |
| michael@428 | 84 | This command activates the license which is installed under I<id>. |
| michael@428 | 85 | Only one installed license can be active at any time, so this command |
| michael@428 | 86 | implicitly deactivates the currently activate license. |
| michael@428 | 87 | |
| michael@428 | 88 | =item B<openpkg license> B<view> I<id> |
| michael@428 | 89 | |
| michael@428 | 90 | This command shows the license which is installed under I<id>. |
| michael@428 | 91 | |
| michael@428 | 92 | =item B<openpkg license> B<list> |
| michael@428 | 93 | |
| michael@428 | 94 | This command lists the identifiers of all installed licenses. |
| michael@428 | 95 | |
| michael@428 | 96 | =item B<openpkg license> B<active> |
| michael@428 | 97 | |
| michael@428 | 98 | This command outputs the identifier of the currently activated license. |
| michael@428 | 99 | |
| michael@428 | 100 | =item B<openpkg license> B<sanity> |
| michael@428 | 101 | |
| michael@428 | 102 | This command sanity checks the current license configuration. |
| michael@428 | 103 | |
| michael@428 | 104 | =back |
| michael@428 | 105 | |
| michael@428 | 106 | =head1 FILES |
| michael@428 | 107 | |
| michael@428 | 108 | =over 4 |
| michael@428 | 109 | |
| michael@428 | 110 | =item F<@l_prefix@/etc/license> |
| michael@428 | 111 | |
| michael@428 | 112 | The name of the currently activated license file under |
| michael@428 | 113 | F<@l_prefix@/etc/license.d/>. |
| michael@428 | 114 | |
| michael@428 | 115 | =item F<@l_prefix@/etc/license.d/*> |
| michael@428 | 116 | |
| michael@428 | 117 | The directory containing all installed license files. |
| michael@428 | 118 | |
| michael@428 | 119 | =back |
| michael@428 | 120 | |
| michael@428 | 121 | =head1 HISTORY |
| michael@428 | 122 | |
| michael@428 | 123 | The B<openpkg license> command first appeared in B<OpenPKG 4.0>. |
| michael@428 | 124 | |
| michael@428 | 125 | =cut |
| michael@428 | 126 |
