.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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 turned on, 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
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "DH_RUNIT 1"
.TH DH_RUNIT 1 "2016-09-14" "perl v5.22.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_runit \- install/enable runit runscripts
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBdh_runit\fR [\fIdebhelper\ options\fR] [\fIpath\fR \fIoptions\fR] ...
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBdh_runit\fR is a debhelper program that is responsible for
installing and enabling \fIrunit\fR runscripts. If file named
\&\fIdebian/\fIpackage\fI.runit\fR exists, then different actions
are performed, depending on its format.
.PP
For runit, every unit of supervision, simply speaking program, is
represented by directory under \fI/etc/sv\fR, containing at least \fIrun\fR
executable file. Every enabled program is represented by symbolic link
under \fI/etc/services\fR (which itself is symbolic link to
\&\fI/etc/runit/runsvdir/default\fR) pointing to some directory under
\&\fI/etc/sv\fR.
.PP
\&\fBdh_runit\fR reads it's arguments from command line and
\&\fIdebian/\fIpackage\fI.runit\fR by two, with first one being an
file/directory and second one is options. If first argument is file,
it is considered 'run' script, and it is installed under
\&\fI/etc/sv/*/run\fR, executable bit is added. If first argument is
directory, it is copied as whole under \fI/etc/sv\fR.
.PP
Options are comma-separated, like to mount. Unsupported option
is error, following are supported:
.IP "\fIdisable\fR" 4
.IX Item "disable"
.Vb 4
\&    With this option, runscript is installed, but not enabled by
\&    default. It means that corresponding service will not be started.
\&    System administrator can always do it manually or via
\&    update\-service(8).
.Ve
.IP "\fIname\fR=preferred\-name" 4
.IX Item "name=preferred-name"
.Vb 3
\&    By default, name of directory under F</etc/sv> for given runscript
\&    is basename of first argument of pair. This option allows you to
\&    be explicit about it.
.Ve
.IP "\fIlogscript\fR" 4
.IX Item "logscript"
.Vb 3
\&    Install standard F<log/run> script, which invokes svlogd(8) with
\&    rights of dedicated user. It is error, if first argument in pair
\&    is directory, which already contains F</log/run> script.
.Ve
.IP "\fIlogdir\fR=/path/to/log/directory" 4
.IX Item "logdir=/path/to/log/directory"
.Vb 2
\&    This option is meaningful only with I<logscript>. It allows
\&    overriding default log directory F</var/log/runit/I<name>>.
.Ve
.IP "\fIdefaults\fR" 4
.IX Item "defaults"
.Vb 1
\&    If you need no other options, put this one.
.Ve
.SH "EXAMPLES"
.IX Header "EXAMPLES"
This section contains several example snippets from \fI\fIpackage\fI.runit\fR
.PP
.Vb 3
\&  # In this case file is installed as \*(Aqrun\*(Aq script. Directory name under
\&  # /etc/sv is derived from file basename
\&  path/to/file/to/be/installed/as/run/script defaults
\&
\&  # Same, but install directory as whole. It is your responsibility
\&  # to ensure is contains everything required.
\&  path/to/directory defaults
\&
\&  # Same as above, but do not create symlink under /etc/service
\&  path/to/directory disable
\&
\&  # You can explicitly specify name of directory under /etc/sv.
\&  # Standard log/run script will be created.
\&  path/to/directory name=my\-preferred\-name,logscript
.Ve