NAME

dh_runit - install/enable runit runscripts

SYNOPSIS

dh_runit [debhelper options] [path options] ...

DESCRIPTION

dh_runit is a debhelper program that is responsible for installing and enabling runit runscripts. If a file named debian/package.runit exists, then it ensures appropriate actions are performed based on its content.

For runit, each unit of supervision (or, simply speaking, program) is represented by a directory under /etc/sv, containing at least a run executable file. Each enabled unit of supervision is represented by a symbolic link under /etc/services (which itself is a symbolic link to /etc/runit/runsvdir/default) pointing to some directory under /etc/sv.

dh_runit reads arguments from the command line and debian/package.runit in pairs, with the first item being the path to a file or directory and the second being a set of options. If the first argument names a file, it is treated as a 'run' script to be installed at /etc/sv/*/run as an executable file. If the first argument names a directory, that directory is copied as a whole to /etc/sv.

Options are comma separated, like mount options. Unrecognized options are errors. The following options are recognized:

disable

Install the runscript but do not enable it by default. This means that the corresponding service will not be started. The service can be enabled manually by the system administrator or automatically using update-service(8).

name=preferred-name

By default, the name of the directory under /etc/sv for a given runscript is the basename of the path argument naming it. This option allows overriding that default with an explicitly chosen directory name.

logscript

Install a standard log/run script that invokes svlogd(8) with the rights of the dedicated user. Specifying this option produces an error if the path argument names a directory that already contains a /log/run script.

defaults

If you don't need other options, specify this one.

SUBSTITUTION VARIABLES

Packages using dh_runit do not depend on runit but should include the runit:Breaks variable in their Breaks field in debian/control to ensure that no breakages are caused by a too-old version of runit package.

EXAMPLES

This section contains several example package.runit snippets.

  # In this case, a file is installed as a 'run' script. The directory
  # name under /etc/sv is derived from the file's basename (/etc/sv/script).
  path/to/file/to/be/installed/as/run/script defaults
  # Similar, but installs a directory as a whole. It is the package's
  # responsibility to ensure this directory contains everything required.
  path/to/directory defaults
  # Similar, but without creating a symlink under /etc/service.
  path/to/directory disable
  # Explicitly specifying a name to use for the directory under /etc/sv.
  # A standard log/run script will be created.
  path/to/directory name=my-preferred-name,logscript