.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "DH_PHPPEAR 1"
.TH DH_PHPPEAR 1 2024-03-03 1.45 Debhelper
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
dh_phppear \- calculates PHP PEAR substvars
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\&\fBdh_phppear\fR [\fIdebhelper\ options\fR] [\fIoptions\fR]
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\fBdh_phppear\fR is a debhelper program that is responsible for generating
the \fB${phppear:*}\fR substitutions and adding them to substvars files.
.PP
The program will look at \fIpackage.xml\fR (or \fIpackage2.xml\fR) in the package,
and will use this information to generate:
.IP \(bu 2
\&\fB${phppear:summary}\fR, \fB${phppear:description}\fR and \fB${phppear:channel}\fR
.IP \(bu 2
\&\fB${phppear:Debian\-Depends}\fR, \fB${phppear:Debian\-Recommends}\fR,
\&\fB${phppear:Debian\-Suggests}\fR and \fB${phppear:Debian\-Breaks}\fR
.PP
\&\fBDeprecated:\fR the <pear\-channels> package should be used (and updated)
instead of introducing a new standalone channel package.
.PP
The program will look at \fIchannel.xml\fR in the package,
and will use this information to generate:
.IP \(bu 2
\&\fB${phppear:channel\-name}\fR, \fB${phppear:channel\-summary}\fR and \fB${phppear:channel\-alias}\fR
.IP \(bu 2
\&\fB${phppear:channel\-common\-description}\fR
.PP
Those variables will be substituted into the package's \fIcontrol\fR
file wherever the token \fB${phppear:*}\fR are placed.
.SH OPTIONS
.IX Header "OPTIONS"
.IP \fB\-\-sourcedirectory=\fR\fIdirectory\fR 4
.IX Item "--sourcedirectory=directory"
Assume that the original package source tree is at the specified directory
rather than the top level directory of the Debian source package tree.
.Sp
This feature requires pkg-php-tools (>= 1.14~).
.SH FILES
.IX Header "FILES"
.IP \fIdebian/pkg\-php\-tools\-overrides\fR 4
.IX Item "debian/pkg-php-tools-overrides"
Package that don't want to follow automatic PEAR package name to Debian package
name conversion can override the conversion by creating this file.
.Sp
It can be installed in \fB/usr/share/pkg\-php\-tools/overrides/\fR\fIpackage\fR.
.Sp
This feature requires pkg-php-tools (>= 1~).
.Sp
The format is a set of lines, with each line having the following fields:
.RS 4
.IP \fIchannel_url\fR 6
.IX Item "channel_url"
The channel URL as found in \fIpackage.xml\fR (example: \fIpear.phpunit.de\fR).
.IP \fIpear_package_name\fR 6
.IX Item "pear_package_name"
The PEAR package name (example: \fIphpunit\fR).
.IP \fIdebian_package_name\fR 6
.IX Item "debian_package_name"
The resulting Debian package name (example: \fIphpunit\fR).
.Sp
Use \fIbuiltin\fR if the package is compiled from the php source package.
.Sp
Use \fInone\fR if the PEAR package can't be simply translated to Debian name.
.IP \fIversion_override\fR 6
.IX Item "version_override"
Optional, for composer packages only, can be \fInone\fR if the version constraint
from the original package should not be used for the replacement. Useful when
a package is being replaced by a PHP extension that doesn't follow the same
versioning scheme.
.RE
.RS 4
.RE
.SH "ADVANCED USAGE"
.IX Header "ADVANCED USAGE"
.SS "Building a PECL package"
.IX Subsection "Building a PECL package"
A PECL package is a PEAR package which is compiled. Extra steps are needed:
.IP \(bu 2
Adding \fBphp-dev\fR, \fBpkg-php-tools\fR (>= 1.6~) and \fBdh-php\fR to Build-Depends.
.IP \(bu 2
Adding \fB${shlibs:Depends}\fR and \fB${misc:Depends}\fR to Depends.
.IP \(bu 2
Adding \fB\-\-with php\fR to \fBdh\fR line in \fIdebian/rules\fR.
.SS Patching
.IX Subsection "Patching"
\&\fBdh_phppear\fR will remove md5sums and sha1sums to ease patching. You can patch
as usual.
.SS "Removing some files from the upstream tarball"
.IX Subsection "Removing some files from the upstream tarball"
If some files are removed from the upstream tarball, the package will be
incomplete unless they are stripped from the \fIpackage.xml\fR file in the PEAR
package subdir. This can be done after the \fIdh_auto_configure\fR step. Example:
.PP
.Vb 4
\&  override_dh_auto_configure:
\&        dh_auto_configure \-O\-\-buildsystem=phppear
\&        # Remove references of JsMin
\&        sed \-i \*(Aq/JsMin\e.php/d\*(Aq */package.xml
.Ve
.PP
This feature requires pkg-php-tools (>= 1.1~).
.SS "Building a channel package (DEPRECATED)"
.IX Subsection "Building a channel package (DEPRECATED)"
\&\fBDeprecated:\fR the \fBpear-channels\fR package should be used (and updated)
instead of introducing a new standalone channel package.
.PP
Simply put the \fIchannel.xml\fR file downloaded from the PEAR channel in the root of
the package source and use a \fIdebian/rules\fR similar to a PEAR package.
.PP
This feature requires pkg-php-tools (>= 1.3~).
.SH "CONFORMING TO"
.IX Header "CONFORMING TO"
Debian policy, version 3.9.6.
.PP
PHP PEAR policy, version yet-to-be-written.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBdebhelper\fR\|(7),
\&\fBpkg\-php\-tools\fR\|(7),
\&\fI/usr/share/doc/pkg\-php\-tools/README.PEAR\fR
.SH AUTHOR
.IX Header "AUTHOR"
Mathieu Parent <sathieu@debian.org>