| 1 |
.\" -*- mode: troff; coding: utf-8 -*- |
| 2 |
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) |
| 3 |
.\" |
| 4 |
.\" Standard preamble: |
| 5 |
.\" ======================================================================== |
| 6 |
.de Sp \" Vertical space (when we can't use .PP) |
| 7 |
.if t .sp .5v |
| 8 |
.if n .sp |
| 9 |
.. |
| 10 |
.de Vb \" Begin verbatim text |
| 11 |
.ft CW |
| 12 |
.nf |
| 13 |
.ne \\$1 |
| 14 |
.. |
| 15 |
.de Ve \" End verbatim text |
| 16 |
.ft R |
| 17 |
.fi |
| 18 |
.. |
| 19 |
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. |
| 20 |
.ie n \{\ |
| 21 |
. ds C` "" |
| 22 |
. ds C' "" |
| 23 |
'br\} |
| 24 |
.el\{\ |
| 25 |
. ds C` |
| 26 |
. ds C' |
| 27 |
'br\} |
| 28 |
.\" |
| 29 |
.\" Escape single quotes in literal strings from groff's Unicode transform. |
| 30 |
.ie \n(.g .ds Aq \(aq |
| 31 |
.el .ds Aq ' |
| 32 |
.\" |
| 33 |
.\" If the F register is >0, we'll generate index entries on stderr for |
| 34 |
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index |
| 35 |
.\" entries marked with X<> in POD. Of course, you'll have to process the |
| 36 |
.\" output yourself in some meaningful fashion. |
| 37 |
.\" |
| 38 |
.\" Avoid warning from groff about undefined register 'F'. |
| 39 |
.de IX |
| 40 |
.. |
| 41 |
.nr rF 0 |
| 42 |
.if \n(.g .if rF .nr rF 1 |
| 43 |
.if (\n(rF:(\n(.g==0)) \{\ |
| 44 |
. if \nF \{\ |
| 45 |
. de IX |
| 46 |
. tm Index:\\$1\t\\n%\t"\\$2" |
| 47 |
.. |
| 48 |
. if !\nF==2 \{\ |
| 49 |
. nr % 0 |
| 50 |
. nr F 2 |
| 51 |
. \} |
| 52 |
. \} |
| 53 |
.\} |
| 54 |
.rr rF |
| 55 |
.\" ======================================================================== |
| 56 |
.\" |
| 57 |
.IX Title "DEB-SYSTEMD-HELPER 1p" |
| 58 |
.TH DEB-SYSTEMD-HELPER 1p 2025-08-15 1.69 init-system-helpers |
| 59 |
.\" For nroff, turn off justification. Always turn off hyphenation; it makes |
| 60 |
.\" way too many mistakes in technical documents. |
| 61 |
.if n .ad l |
| 62 |
.nh |
| 63 |
.SH NAME |
| 64 |
deb\-systemd\-helper \- subset of systemctl for machines not running systemd |
| 65 |
.SH SYNOPSIS |
| 66 |
.IX Header "SYNOPSIS" |
| 67 |
\&\fBdeb-systemd-helper\fR enable | disable | purge | mask | unmask | is-enabled | was-enabled | debian-installed | update-state | reenable \fIunit\ file\fR\ ... |
| 68 |
.SH DESCRIPTION |
| 69 |
.IX Header "DESCRIPTION" |
| 70 |
\&\fBdeb-systemd-helper\fR is a Debian-specific helper script which re-implements |
| 71 |
the enable, disable, is-enabled and reenable commands from systemctl. |
| 72 |
.PP |
| 73 |
The "enable" action will only be performed once (when first installing the |
| 74 |
package). On the first "enable", a state file is created which will be deleted |
| 75 |
upon "purge". |
| 76 |
.PP |
| 77 |
The "mask" action will keep state on whether the service was enabled/disabled |
| 78 |
before and will properly return to that state on "unmask". |
| 79 |
.PP |
| 80 |
The "was-enabled" action is not present in systemctl, but is required in Debian |
| 81 |
so that we can figure out whether a service was enabled before we installed an |
| 82 |
updated service file. See http://bugs.debian.org/717603 for details. |
| 83 |
.PP |
| 84 |
The "debian-installed" action is also not present in systemctl. It returns 0 if |
| 85 |
the state file of at least one of the given units is present. |
| 86 |
.PP |
| 87 |
The "update-state" action is also not present in systemctl. It updates |
| 88 |
\&\fBdeb-systemd-helper\fR's state file, removing obsolete entries (e.g. service |
| 89 |
files that are no longer shipped by the package) and adding new entries (e.g. |
| 90 |
new service files shipped by the package) without enabling them. |
| 91 |
.PP |
| 92 |
\&\fBdeb-systemd-helper\fR is intended to be used from maintscripts to enable |
| 93 |
systemd unit files. It is specifically NOT intended to be used interactively by |
| 94 |
users. Instead, users should run systemd and use systemctl, or not bother about |
| 95 |
the systemd enabled state in case they are not running systemd. |
| 96 |
.SH ENVIRONMENT |
| 97 |
.IX Header "ENVIRONMENT" |
| 98 |
.IP \fB_DEB_SYSTEMD_HELPER_DEBUG\fR 4 |
| 99 |
.IX Item "_DEB_SYSTEMD_HELPER_DEBUG" |
| 100 |
If you export _DEB_SYSTEMD_HELPER_DEBUG=1, deb-systemd-helper will print debug |
| 101 |
messages to stderr (thus visible in dpkg runs). Please include these when |
| 102 |
filing a bugreport. |
| 103 |
.IP \fBDPKG_ROOT\fR 4 |
| 104 |
.IX Item "DPKG_ROOT" |
| 105 |
Instead of working on the filesystem root /, perform all operations on a chroot |
| 106 |
system in the directory given by DPKG_ROOT. |
| 107 |
.SH AUTHOR |
| 108 |
.IX Header "AUTHOR" |
| 109 |
Michael Stapelberg <[email protected]> |