.\" -*- 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_PHP 1" .TH DH_PHP 1 2024-01-21 "perl v5.38.2" "User Contributed Perl Documentation" .\" 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_php \- register configuration snippets to the PHP .SH SYNOPSIS .IX Header "SYNOPSIS" \&\fBdh_php\fR [\fIdebhelper\ options\fR] [\fB\-\-conditional\fR=\fIexpression\fR] [\fB\-\-error\-handler=\fR\fIfunction\fR] [\fB\-n\fR|\fB\-\-noscripts\fR] [\fB\-\-php\-version=\fR\fIphp_version\fR] .SH DESCRIPTION .IX Header "DESCRIPTION" \&\fBdh_php\fR is a debhelper program that is responsible for correctly installing PHP configuration snippets and setting postinst, prerm and dependencies in PHP web server modules and web applications. .PP It supports the following configuration types .IP \(bu 4 PHP modules .PP \&\fBdh_php\fR supports only a configuration file driven approach. If a file named debian/\fIpackage\fR.php exists, actual actions are determined by that file. .SH "OPERATION MODES" .IX Header "OPERATION MODES" \&\fBdh_php\fR can only be used in a configuration file driven approach. The configuration driven mode is fully documented in the \fBFILES\fR section below. This mode is activated by supplying a \fBdebhelper\fR\|(7) configuration file (e.g. debian/\fIpackage\fR.php). .SH INVOCATION .IX Header "INVOCATION" \&\fBdh_php\fR is not part of debhelper and might require information available in the php-all-dev package. Packages making use of \&\fBdh_php\fR should declare a build-dependency against the virtual \&\fBdh-php\fR package. .PP \&\fBdh_php\fR supports both, called directly from a debian/rules file or as \fBdh\fR\|(1) addon. In the former case the helper should run after \&\fBdh_install\fR\|(1) or their respective counter parts in local implementations at earliest. Alternatively it can be used as dh addon by invoking it with .PP .Vb 2 \& %: \& dh $@ \-\-with php .Ve .SH FILES .IX Header "FILES" .IP debian/\fIpackage\fR.php 4 .IX Item "debian/package.php" .PD 0 .IP debian/php 4 .IX Item "debian/php" .PD .PP Lists files to be registered with the PHP. The file is interpreted as line separated list of installation stanzas, where each entry consists of whitespace separated values conforming to the file semantics below. .SS "FILE SEMANTICS" .IX Subsection "FILE SEMANTICS" Each line consists of a triple .PP \&\fItype\fR \fIfile\fR [\fIarguments\fR] .PP where the values are interpreted as follows: .PP \fItype\fR .IX Subsection "type" .PP Denotes the type of file to be installed. Recognized values are \fBmod\fR for PHP modules. .PP \fIfile\fR .IX Subsection "file" .PP Is interpreted as existing file name within the source package. No path expansion is effectuated. Just like \fBdh_install\fR\|(1), \fBdh_php\fR can not rename files. .SS MODULES .IX Subsection "MODULES" Modules are handled specially and are determined by the \fBmod\fR type. Modules can have a \fI.ini\fR suffix. In that case the file is interpreted as a module configuration file respectively and is installed to \fI/etc/php/. If the file is ending with a \fI.so\fR suffix it is interpreted as actual module shared object and is installed to the PHP module directory. Moreover, if a \&\fI.ini\fR file is installed the configuration is activated in the maintainer script at installation time. .PP A typical module configuration has two lines, one for the \fI.ini\fR file, and one for the \fI.so\fR file, albeit the latter could be installed by upstream's makefile, too. .PP \&\fBdh_php\fR will set dependencies in \fB${php:Depends}\fR accordingly when this type of configuration is found. .SH OPTIONS .IX Header "OPTIONS" .IP \fB\-\-php\-version=\fR\fIphp_version\fR 4 .IX Item "--php-version=php_version" Make all calls to PHP versioned with , e.g. php-config becomes php\-config. .IP \fB\-\-error\-handler=\fR\fIfunction\fR 4 .IX Item "--error-handler=function" Call the named shell \fIfunction\fR if running the maintainer script fails. The function should be provided in the \fIprerm\fR and \fIpostinst\fR scripts, before the \&\fB#DEBHELPER#\fR token. .IP "\fB\-e\fR, \fB\-\-noenable\fR" 4 .IX Item "-e, --noenable" Install maintainer scripts accordingly, but do not enable the scripts or configuration by default. .IP "\fB\-n\fR, \fB\-\-noscripts\fR" 4 .IX Item "-n, --noscripts" Do not modify \fIpreinst\fR/\fIpostinst\fR/\fIpostrm\fR/\fIprerm\fR maintainer scripts. .SH NOTES .IX Header "NOTES" Note that this command is not idempotent. \fBdh_prep\fR\|(1) should be called between invocations of this command. Otherwise, it may cause multiple instances of the same text to be added to maintainer scripts. .SH EXAMPLES .IX Header "EXAMPLES" The examples below lists valid entries for a debian/\fIpackage\fR.php file. For example, the two lines below install a fictional \fIfoo\fR PHP module along a Debian specific \fI.ini\fR file: .PP .Vb 2 \& mod src/foo/foo.so \& mod debian/foo.ini .Ve .SH "SEE ALSO" .IX Header "SEE ALSO" phpquery(8), debhelper(7), dh(1) .SH AUTHOR .IX Header "AUTHOR" This manual and dh_php was written by Arno Toell for Apache 2 and modified for PHP by Ondrej Sury .