Man pages sections > man1 > dh_runit

dh_runit - install/enable runit runscripts

DH_RUNIT(1) User Contributed Perl Documentation DH_RUNIT(1)

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 file named debian/package.runit exists, then different actions are performed, depending on its format.
For runit, every unit of supervision, simply speaking program, is represented by directory under /etc/sv, containing at least run executable file. Every enabled program is represented by symbolic link under /etc/services (which itself is symbolic link to /etc/runit/runsvdir/default) pointing to some directory under /etc/sv.
dh_runit reads it's arguments from command line and debian/package .runit 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 /etc/sv/*/run, executable bit is added. If first argument is directory, it is copied as whole under /etc/sv.
Options are comma-separated, like to mount. Unsupported option is error, following are supported:
disable
    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).
    
name=preferred-name
    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.
    
logscript
    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.
    
logdir=/path/to/log/directory
    This option is meaningful only with I<logscript>. It allows
    overriding default log directory F</var/log/runit/I<name>>.
    
defaults
    If you need no other options, put this one.
    

EXAMPLES

This section contains several example snippets from package.runit
  # In this case file is installed as 'run' 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
2016-09-14 perl v5.22.2