← Back to branch summary

~ubuntu-branches/ubuntu/utopic/dh-make-php/utopic

« back to all changes in this revision

Viewing changes to man/dh-make-pecl.xml

  • Committer: Bazaar Package Importer
  • Author(s): Uwe Steinmann
  • Date: 2005-11-25 11:04:57 UTC
  • Revision ID: james.westby@ubuntu.com-20051125110457-hp4c6t4r7s42nd65
Tags: upstream-0.0.12
Import upstream version 0.0.12

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/dh-make-pecl.xml
 
1
<?xml version='1.0' encoding='ISO-8859-1'?>
 
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
 
3
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
 
4
 
 
5
<!--
 
6
 
 
7
Process this file with an XSLT processor: `xsltproc \
 
8
-''-nonet /usr/share/sgml/docbook/stylesheet/xsl/nwalsh/\
 
9
manpages/docbook.xsl manpage.dbk'.  A manual page
 
10
<package>.<section> will be generated.  You may view the
 
11
manual page with: nroff -man <package>.<section> | less'.  A
 
12
typical entry in a Makefile or Makefile.am is:
 
13
 
 
14
DB2MAN=/usr/share/sgml/docbook/stylesheet/xsl/nwalsh/\
 
15
manpages/docbook.xsl
 
16
XP=xsltproc -''-nonet
 
17
 
 
18
manpage.1: manpage.dbk
 
19
        $(XP) $(DB2MAN) $<
 
20
    
 
21
The xsltproc binary is found in the xsltproc package.  The
 
22
XSL files are in docbook-xsl.  Please remember that if you
 
23
create the nroff version in one of the debian/rules file
 
24
targets (such as build), you will need to include xsltproc
 
25
and docbook-xsl in your Build-Depends control field.
 
26
 
 
27
-->
 
28
 
 
29
  <!-- Fill in your name for FIRSTNAME and SURNAME. -->
 
30
  <!ENTITY dhfirstname "<firstname>UWE</firstname>">
 
31
  <!ENTITY dhsurname   "<surname>STEINMANN</surname>">
 
32
  <!-- Please adjust the date whenever revising the manpage. -->
 
33
  <!ENTITY dhdate      "<date>August 05, 2005</date>">
 
34
  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
 
35
       allowed: see man(7), man(1). -->
 
36
  <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
 
37
  <!ENTITY dhemail     "<email>steinm@debian.org</email>">
 
38
  <!ENTITY dhusername  "Uwe Steinmann">
 
39
  <!ENTITY dhucpackage "<refentrytitle>DH-MAKE-PECL</refentrytitle>">
 
40
  <!ENTITY dhpackage   "dh-make-pecl">
 
41
 
 
42
  <!ENTITY debian      "<productname>Debian</productname>">
 
43
  <!ENTITY gnu         "<acronym>GNU</acronym>">
 
44
  <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
 
45
]>
 
46
 
 
47
<refentry>
 
48
  <refentryinfo>
 
49
    <address>
 
50
      &dhemail;
 
51
    </address>
 
52
    <author>
 
53
      &dhfirstname;
 
54
      &dhsurname;
 
55
    </author>
 
56
    <copyright>
 
57
      <year>2004, 2005</year>
 
58
      <holder>&dhusername;</holder>
 
59
    </copyright>
 
60
    &dhdate;
 
61
  </refentryinfo>
 
62
  <refmeta>
 
63
    &dhucpackage;
 
64
 
 
65
    &dhsection;
 
66
  </refmeta>
 
67
  <refnamediv>
 
68
    <refname>&dhpackage;</refname>
 
69
 
 
70
    <refpurpose>Create debian source packages from pecl extensions</refpurpose>
 
71
  </refnamediv>
 
72
  <refsynopsisdiv>
 
73
    <cmdsynopsis>
 
74
      <command>&dhpackage;</command>
 
75
 
 
76
      <arg><option>--help </option></arg>
 
77
 
 
78
      <arg><option>--version </option></arg>
 
79
 
 
80
      <arg><option>--arch <replaceable>any | all</replaceable></option></arg>
 
81
 
 
82
      <arg><option>--depends <replaceable>DEPENDS</replaceable></option></arg>
 
83
      <arg><option>--build-depends <replaceable>DEPENDS</replaceable></option></arg>
 
84
 
 
85
 
 
86
      <arg><option>--maintainer <replaceable>MAINTAINER</replaceable></option></arg>
 
87
 
 
88
      <arg><option>--prefix <replaceable>PREFIX</replaceable></option></arg>
 
89
 
 
90
      <arg><option>--package-name <replaceable>NAME</replaceable></option></arg>
 
91
 
 
92
      <arg><option>--templatedir <replaceable>TEMPLATEDIR</replaceable></option></arg>
 
93
      <arg>PACKAGE</arg>
 
94
    </cmdsynopsis>
 
95
  </refsynopsisdiv>
 
96
  <refsect1>
 
97
    <title>DESCRIPTION</title>
 
98
 
 
99
    <para>This manual page documents briefly the
 
100
      <command>&dhpackage;</command>
 
101
      command.</para>
 
102
 
 
103
    <para><command>&dhpackage;</command> creates the files required to
 
104
      build a debian source package from a PHP extension as it is
 
105
      distributed through PECL.</para>
 
106
 
 
107
    <para>The last parameter passed to <command>&dhpackage;</command> can
 
108
      be either the .tgz archive containing the php extension or the
 
109
      name of the extension. In the second case <command>&dhpackage;</command>
 
110
      will first download the archive from http://pecl.php.net.
 
111
      If <command>&dhpackage;</command>
 
112
      downloads the archive itself, it will always take the most recent
 
113
      version.</para>
 
114
 
 
115
    <para><command>&dhpackage;</command> will by default create a directory
 
116
      named php-&lt;pecl-package-name&gt;-&lt;pecl-package-version&gt; which will contain the debian
 
117
      files and the unpacked files from the extension. It will also create a
 
118
      symlink php-&lt;pecl-package-name&gt;_&lt;version&gt;.orig.tar.gz
 
119
      pointing towards the original source. After creating the files
 
120
      you can go into then new directory and build the debian package
 
121
      with <command>dpkg-buildpackage -rfakeroot</command>.  This will (by default)
 
122
          create php4-&lt;pecl-package-name&gt; and php5-&lt;pecl-package-name&gt;
 
123
          binary packages.</para>
 
124
 
 
125
    <para><command>&dhpackage;</command> tries to extract as much information
 
126
      about the package from the file <filename>package.xml</filename> which
 
127
      is part of the pecl extension.</para>
 
128
 
 
129
    <para>Debian source packages created by <command>&dhpackage;</command>
 
130
      can later easily be updated with <command>uscan</command>.</para>
 
131
 
 
132
  </refsect1>
 
133
  <refsect1>
 
134
    <title>OPTIONS</title>
 
135
 
 
136
    <para>These programs follow the usual &gnu; command line syntax,
 
137
      with long options starting with two dashes (`-').  A summary of
 
138
      options is included below.  For a complete description, see the
 
139
      <application>Info</application> files.</para>
 
140
 
 
141
    <variablelist>
 
142
      <varlistentry>
 
143
        <term><option>-h</option>
 
144
          <option>--help</option>
 
145
        </term>
 
146
        <listitem>
 
147
          <para>Show summary of options.</para>
 
148
        </listitem>
 
149
      </varlistentry>
 
150
      <varlistentry>
 
151
        <term><option>-v</option>
 
152
          <option>--version</option>
 
153
        </term>
 
154
        <listitem>
 
155
          <para>Show version of program.</para>
 
156
        </listitem>
 
157
      </varlistentry>
 
158
      <varlistentry>
 
159
        <term><option>--arch</option>
 
160
        </term>
 
161
        <listitem>
 
162
          <para>Set architecture of created debian source package to 'any'
 
163
            or 'all'. Defaults to 'any'.</para>
 
164
        </listitem>
 
165
      </varlistentry>
 
166
      <varlistentry>
 
167
        <term><option>--depends</option>
 
168
        </term>
 
169
        <listitem>
 
170
          <para>Adds more packages to Depends: beside php4|php5.</para>
 
171
        </listitem>
 
172
      </varlistentry>
 
173
      <varlistentry>
 
174
        <term><option>--build-depends</option>
 
175
        </term>
 
176
        <listitem>
 
177
          <para>Adds more packages to Build-Depends: beside php4-dev,
 
178
          php5-dev, debhelper and dh-make-php.</para>
 
179
        </listitem>
 
180
      </varlistentry>
 
181
      <varlistentry>
 
182
        <term><option>--prefix</option>
 
183
        </term>
 
184
        <listitem>
 
185
          <para>Sets prefix of debian source package name. Each name ends
 
186
            in '-&lt;pecl-package-name&gt;'. Defaults to 'php'.</para>
 
187
        </listitem>
 
188
      </varlistentry>
 
189
      <varlistentry>
 
190
        <term><option>--maintainer</option>
 
191
        </term>
 
192
        <listitem>
 
193
          <para>Explicitly sets the maintainer. In most cases it will be
 
194
            propperly guessed by reading some of the environment
 
195
            variables.</para>
 
196
        </listitem>
 
197
      </varlistentry>
 
198
      <varlistentry>
 
199
        <term><option>--package-name</option>
 
200
        </term>
 
201
        <listitem>
 
202
          <para>Overwrite package name in package.xml. This name will be
 
203
            prefixed with `php-'. Do not use this function unless you know
 
204
            what you are doing.</para>
 
205
        </listitem>
 
206
      </varlistentry>
 
207
      <varlistentry>
 
208
        <term><option>--templatedir</option>
 
209
        </term>
 
210
        <listitem>
 
211
          <para>Use a different directory with templates for the debian
 
212
            files. Defaults to /usr/share/dh-make-php/pecl.template.</para>
 
213
        </listitem>
 
214
      </varlistentry>
 
215
    </variablelist>
 
216
  </refsect1>
 
217
  <refsect1>
 
218
    <title>ENVIRONMENT</title>
 
219
 
 
220
    <para><command>&dhpackage;</command> evaluates the following environment
 
221
      variables:</para>
 
222
      
 
223
    <para>DEBFULLNAME - the real name of the maintainer</para>
 
224
    <para>LOGNAME or USER - the username</para>
 
225
    <para>DEBEMAIL or EMAIL - the email address of the user</para>
 
226
  </refsect1>
 
227
  <refsect1>
 
228
    <title>SEE ALSO</title>
 
229
 
 
230
    <para>dh-make-pear (1).</para>
 
231
 
 
232
  </refsect1>
 
233
  <refsect1>
 
234
    <title>AUTHOR</title>
 
235
 
 
236
    <para>This manual page was written by &dhusername; &dhemail; for
 
237
      the &debian; system (but may be used by others).  Permission is
 
238
      granted to copy, distribute and/or modify this document under
 
239
      the terms of the &gnu; General Public License, Version 2 any 
 
240
          later version published by the Free Software Foundation.
 
241
    </para>
 
242
        <para>
 
243
             On Debian systems, the complete text of the GNU General Public
 
244
             License can be found in /usr/share/common-licenses/GPL.
 
245
        </para>
 
246
 
 
247
  </refsect1>
 
248
</refentry>
 
249