.\" -*- 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_NGINX 1"
.TH DH_NGINX 1 2024-05-05 "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_nginx \- register configuration snippets to the nginx web server
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\&\fBdh_nginx\fR [\fIdebhelper\ options\fR] [\fB\-n\fR|\fB\-\-noscripts\fR] [\fB\-\-in\-nginx\-tree\fR]
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\fBdh_nginx\fR is a debhelper program that is responsible for correctly installing
Nginx configuration snippets and setting postinst, prerm and dependencies in
Nginx web server modules and web applications.
.PP
It supports the following configuration types
.IP \(bu 4
Nginx modules
.SH INVOCATION
.IX Header "INVOCATION"
.Vb 2
\&  %:
\&     dh $@ \-\-with nginx
.Ve
.SH FILES
.IX Header "FILES"
.IP debian/\fIpackage\fR.nginx 4
.IX Item "debian/package.nginx"
.PD 0
.IP debian/nginx 4
.IX Item "debian/nginx"
.PD
.PP
Lists files to be registered with the Nginx HTTP server. 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.
.PP
When this file is missing but the name of the package looks like a nginx module,
the module load file and its loading priority is automatically generated inferring
from the package name. In this case, \fIpackage-name\fR\fB.install\fR or other mechanisms
should be used for copying the \fB.so\fR library into the correct place.
.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
Nginx 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_nginx\fR can not
rename files.
.PP
\fIarguments\fR
.IX Subsection "arguments"
.PP
Is inrerpreted as optional arguments if any, currently not used.
.SS MODULES
.IX Subsection "MODULES"
Modules are handled specially and are determined by the \fBmod\fR type. Modules must
have a \fI.conf\fR suffix. In that case the file is interpreted as module load
file and is installed to \fI/etc/nginx/modules\-available\fR. If the file is ending
with a \fI.so\fR suffix it is interpreted as actual module shared object and is
installed to the Nginx module directory, an optional numeric priority can be
set as the last argument to handle module dependencies.
.SH OPTIONS
.IX Header "OPTIONS"
.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 \fIpostinst\fR/\fIpostrm\fR/\fIprerm\fR maintainer scripts.
.IP \fB\-\-in\-nginx\-tree\fR 4
.IX Item "--in-nginx-tree"
Specify this option when building in-tree modules along with nginx. When
specified, nginx abi version is not required in package name.
.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 AUTHOR
.IX Header "AUTHOR"
This manual and dh_nginx was written by Christos Trochalakis.
dh_nginx is heavily influnced by dh_apache2 written by Arno Toell
<debian@toell.net>.