File: manpage.xml

package info (click to toggle)
liblicense 0.8-2.1
  • links: PTS
  • area: main
  • in suites: squeeze
  • size: 6,448 kB
  • ctags: 793
  • sloc: sh: 9,182; ansic: 8,249; makefile: 862; xml: 178; cpp: 111; ruby: 41; python: 39
file content (232 lines) | stat: -rw-r--r-- 7,202 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
<?xml version='1.0' encoding='utf-8'?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [

<!--

Process this file with an XSLT processor: `xsltproc \
-''-nonet /usr/share/sgml/docbook/stylesheet/xsl/nwalsh/\
manpages/docbook.xsl manpage.dbk'.  A manual page
<package>.<section> will be generated.  You may view the
manual page with: nroff -man <package>.<section> | less'.  A
typical entry in a Makefile or Makefile.am is:

DB2MAN=/usr/share/sgml/docbook/stylesheet/xsl/nwalsh/\
manpages/docbook.xsl
XP=xsltproc -''-nonet

manpage.1: manpage.dbk
        $(XP) $(DB2MAN) $<
    
The xsltproc binary is found in the xsltproc package.  The
XSL files are in docbook-xsl.  Please remember that if you
create the nroff version in one of the debian/rules file
targets (such as build), you will need to include xsltproc
and docbook-xsl in your Build-Depends control field.

-->

  <!-- Fill in your name for FIRSTNAME and SURNAME. -->
  <!ENTITY dhfirstname "<firstname>Asheesh</firstname>">
  <!ENTITY dhsurname   "<surname>Laroia</surname>">
  <!-- Please adjust the date whenever revising the manpage. -->
  <!ENTITY dhdate      "<date>June  4, 2008</date>">
  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
       allowed: see man(7), man(1). -->
  <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
  <!ENTITY dhemail     "<email>asheesh@asheesh.org</email>">
  <!ENTITY dhusername  "Asheesh Laroia">
  <!ENTITY dhucpackage "<refentrytitle>LIBLICENSE</refentrytitle>">
  <!ENTITY dhpackage   "license">

  <!ENTITY debian      "<productname>Debian</productname>">
  <!ENTITY gnu         "<acronym>GNU</acronym>">
  <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
]>

<refentry>
  <refentryinfo>
    <address>
      &dhemail;
    </address>
    <copyright>
      <year>2008</year>
      <holder>&dhusername;</holder>
    </copyright>
    &dhdate;
  </refentryinfo>
  <refmeta>
    &dhucpackage;

    &dhsection;
  </refmeta>
  <refnamediv>
    <refname>&dhpackage;</refname>

    <refpurpose>program to specify and modify media file licenses</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&dhpackage;</command>
      <arg><option><replaceable>filename</replaceable></option></arg>
    </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1>
    <title>DESCRIPTION</title>

    <para>The liblicense package provides a
      <command>&dhpackage;</command> command to 
      allow simple command-line examination and manipulation of license
      information embedded in media files.  The default action is to show the
      default license as configured in $HOME/.license.  This default can be
      offered by applications that use liblicense when asking you what
      license you would like to release your work under.
    </para>
    
    <para>
      In addition to showing you and allowing you to change the
      embedded license in a file, the <command>&dhpackage;</command>
      also can show and allow you to change the embedded "web
      statement URI", a link to a web page with information about the file
      that you can use to verify the embedded license.
    </para>

  </refsect1>
  <refsect1>
    <title>OPTIONS</title>

    <para>These programs follow the usual &gnu; command line syntax,
      with long options starting with two dashes (`-').  A summary of
      options is included below.  For a complete description, run the
      application with --help.</para>

    <variablelist>
      <varlistentry>
        <term><option>-h</option>
          <option>--help</option>
        </term>
        <listitem>
          <para>Show summary of options.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-v</option>
          <option>--verbose</option>
        </term>
        <listitem>
          <para>Output more information about the actions of the program.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-q</option>
          <option>--quiet</option>
        </term>
        <listitem>
          <para>Output less information about the actions of the program.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-a JURISDICTION</option>
          <option>--list=JURISDICTION</option>
        </term>
        <listitem>
          <para>List all avialbale licenses in JURISDICTION (uses the
          generic jurisdiction if JURISDICTION is not specified).</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <option>--set-license</option>
        </term>
        <listitem>
          <para>Sets the license of the file (to the license specified by "-l").</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <option>--remove-license</option>
        </term>
        <listitem>
          <para>Removes the embedded license metadata from the file.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-l URI</option>
          <option>--license=URI</option>
        </term>
        <listitem>
          <para>When setting the license of a file or the default license preference, set it to URI.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <option>--set-web-statement</option>
        </term>
        <listitem>
          <para>Sets the web statement link in the file (to the value specified by "-w").</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <option>--remove-web-statement</option>
        </term>
        <listitem>
          <para>Removes the embedded web statement metadata from the file.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term><option>-w URI</option>
          <option>--web-statement=URI</option>
        </term>
        <listitem>
          <para>When setting the web statement URI in a file, set it to URI.</para>
        </listitem>
      </varlistentry>


      <varlistentry>
        <term><option>-u MODULE</option>
          <option>--use=MODULE</option>
        </term>
        <listitem>
          <para>Use the module called MODULE to interact with a file.</para>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>
          <option>-m</option>
        </term>
        <listitem>
          <para>List the available modules and their capabilities.
          Modules are used to handle different media types.</para>
        </listitem>
      </varlistentry>

    </variablelist>
  </refsect1>
  <refsect1>
    <title>AUTHOR</title>

    <para>This manual page was written by &dhusername; &dhemail;.  Permission is
      granted to copy, distribute and/or modify this document under
      the terms of the &gnu; Lesser General Public License, Version 2.1 or any 
	  later version published by the Free Software Foundation.
    </para>
	<para>
	  On Debian systems, the complete text of the GNU Lesser General Public
	  License can be found in /usr/share/common-licenses/LGPL.
	</para>

  </refsect1>
</refentry>