5 dh_installinit - install upstart jobs or init scripts into package build directories
10 use Debian::Debhelper::Dh_Lib;
14 B<dh_installinit> [S<I<debhelper options>>] [B<--name=>I<name>] [B<-n>] [B<-R>] [B<-r>] [B<-d>] [B<-O>] [S<B<--> I<params>>]
18 dh_installinit is a debhelper program that is responsible for installing
19 upstart job files or init scripts with associated defaults files into package
20 build directories, and in the former case providing compatibility handling
21 for non-upstart systems.
23 It also automatically generates the postinst and postrm and prerm commands
24 needed to set up the symlinks in /etc/rc*.d/ and to start and stop the init
27 If a file named debian/package.upstart exists, then it is installed into
28 etc/init/package.conf in the package build directory, with "package" replaced
31 Otherwise, if a file named debian/package.init exists, then it is installed
32 into etc/init.d/package in the package build directory, with "package"
33 replaced by the package name.
35 If a file named debian/package.default exists, then it is installed into
36 etc/default/package in the package build directory, with "package" replaced
43 =item B<-n>, B<--noscripts>
45 Do not modify postinst/postrm/prerm scripts.
47 =item B<-o>, B<--onlyscripts>
49 Only modify postinst/postrm/prerm scripts, do not actually install any init
50 script, default files, or upstart job. May be useful if the init script or
51 upstart job is shipped and/or installed by upstream in a way that doesn't
52 make it easy to let dh_installinit find it.
54 If no upstart job file is installed in the target directory when
55 dh_installinit --onlyscripts is called, this program will assume that an
56 init script is being installed and not provide the compatibility symlinks
57 or upstart dependencies.
59 =item B<-R>, B<--restart-after-upgrade>
61 Do not stop the init script until after the package upgrade has been
62 completed. This is different than the default behavior, which stops the
63 script in the prerm, and starts it again in the postinst.
65 This can be useful for daemons that should not have a possibly long
66 downtime during upgrade. But you should make sure that the daemon will not
67 get confused by the package being upgraded while it's running before using
70 =item B<-r>, B<--no-restart-on-upgrade>
72 Do not stop init script on upgrade.
76 Do not start the init script on install or upgrade, or stop it on removal.
77 Only call update-rc.d. Useful for rcS scripts.
79 =item B<-d>, B<--remove-d>
81 Remove trailing "d" from the name of the package, and use the result for the
82 filename the upstart job file is installed as in etc/init/ , or for the
83 filename the init script is installed as in etc/init.d and the default file
84 is installed as in etc/default/ . This may be useful for daemons with names
85 ending in "d". (Note: this takes precedence over the --init-script parameter
88 =item B<-u>I<params> B<--update-rcd-params=>I<params>
92 Pass "params" to L<update-rc.d(8)>. If not specified, "defaults" will be
93 passed to L<update-rc.d(8)>.
95 =item B<--name=>I<name>
97 Install the upstart job file or the init script (and default file) using the
98 filename I<name> instead of the default filename, which is the package name.
99 When this parameter is used, dh_installinit looks for and installs files
100 named debian/package.name.upstart, debian/package.name.init and
101 debian/package.name.default, instead of the usual debian/package.upstart,
102 debian/package.init and debian/package.default.
104 =item B<--init-script=>I<scriptname>
106 Use "scriptname" as the filename the init script is installed as in
107 etc/init.d/ (and also use it as the filename for the defaults file, if it
108 is installed). If you use this parameter, dh_installinit will look to see
109 if a file in the debian/ directory exists that looks like
110 "package.scriptname" and if so will install it as the init script in
111 preference to the files it normally installs.
113 This parameter is deprecated, use the --name parameter instead. This
114 parameter will be ignored completely for upstart jobs.
116 =item B<--error-handler=>I<function>
118 Call the named shell function if running the init script fails. The
119 function should be provided in the prerm and postinst scripts, before the
126 Note that this command is not idempotent. L<dh_prep(1)> should be called
127 between invocations of this command. Otherwise, it may cause multiple
128 instances of the same text to be added to maintainer scripts.
134 "no-restart-on-upgrade" => \$dh{R_FLAG},
135 "no-start" => \$dh{NO_START},
136 "R|restart-after-upgrade" => \$dh{RESTART_AFTER_UPGRADE},
137 "init-script=s" => \$dh{INIT_SCRIPT},
138 "update-rcd-params=s", => \$dh{U_PARAMS},
139 "remove-d" => \$dh{D_FLAG},
142 foreach my $package (@{$dh{DOPACKAGES}}) {
143 my $tmp=tmpdir($package);
145 # Figure out what filename to install it as.
147 my $jobfile=$package;
148 if (defined $dh{NAME}) {
149 $jobfile=$script=$dh{NAME};
151 elsif ($dh{D_FLAG}) {
152 # -d on the command line sets D_FLAG. We will
153 # remove a trailing 'd' from the package name and
154 # use that as the name.
156 if ($script=~m/(.*)d$/) {
160 warning("\"$package\" has no final d' in its name, but -d was specified.");
163 elsif ($dh{INIT_SCRIPT}) {
164 $script=$dh{INIT_SCRIPT};
170 my $job=pkgfile($package,"upstart");
171 my ($init,$default) = ('','');
173 if ($job ne '' || ($dh{ONLYSCRIPTS} && -e "$tmp/etc/init/$jobfile.conf")) {
174 if (! $dh{ONLYSCRIPTS}) {
175 if (! -d "$tmp/etc/init") {
176 doit("install","-d","$tmp/etc/init");
179 doit("install","-p","-m644",$job,"$tmp/etc/init/$jobfile.conf");
182 # ensures that our /etc/init.d/ symlink points to a valid
184 addsubstvar($package, "misc:Depends", "upstart-job");
186 if (! -d "$tmp/etc/init.d") {
187 doit("install","-d","$tmp/etc/init.d");
189 doit("ln","-sf","/lib/init/upstart-job","$tmp/etc/init.d/$jobfile");
192 $init=pkgfile($package,$script) || pkgfile($package,"init") ||
193 pkgfile($package,"init.d");
194 $default=pkgfile($package,'default');
197 if ($default ne '' && ! $dh{ONLYSCRIPTS}) {
198 if (! -d "$tmp/etc/default") {
199 doit("install","-d","$tmp/etc/default");
201 doit("install","-p","-m644",$default,"$tmp/etc/default/$script");
204 if ($init ne '' && ! $dh{ONLYSCRIPTS}) {
205 if (! -d "$tmp/etc/init.d") {
206 doit("install","-d","$tmp/etc/init.d");
209 doit("install","-p","-m755",$init,"$tmp/etc/init.d/$script");
212 if ($job ne '' || $init ne '' || $dh{ONLYSCRIPTS})
214 if (-e "$tmp/etc/init/$jobfile.conf") {
218 # This is set by the -u "foo" command line switch, it's
219 # the parameters to pass to update-rc.d. If not set,
220 # we have to say "defaults".
222 if (defined($dh{U_PARAMS})) {
223 $params=join(' ',@{$dh{U_PARAMS}});
229 if (! $dh{NOSCRIPTS}) {
230 if (! $dh{NO_START}) {
231 if ($dh{RESTART_AFTER_UPGRADE}) {
232 # update-rc.d, and restart (or
233 # start if new install) script
234 autoscript($package,"postinst", "postinst-init-restart",
235 "s/#SCRIPT#/$script/;s/#INITPARMS#/$params/;s/#ERROR_HANDLER#/$dh{ERROR_HANDLER}/");
238 # update-rc.d, and start script
239 autoscript($package,"postinst", "postinst-init",
240 "s/#SCRIPT#/$script/;s/#INITPARMS#/$params/;s/#ERROR_HANDLER#/$dh{ERROR_HANDLER}/");
243 if ($dh{R_FLAG} || $dh{RESTART_AFTER_UPGRADE}) {
244 # stops script only on remove
245 autoscript($package,"prerm","prerm-init-norestart",
246 "s/#SCRIPT#/$script/;s/#INITPARMS#/$params/;s/#ERROR_HANDLER#/$dh{ERROR_HANDLER}/");
249 # always stops script
250 autoscript($package,"prerm","prerm-init",
251 "s/#SCRIPT#/$script/;s/#INITPARMS#/$params/;s/#ERROR_HANDLER#/$dh{ERROR_HANDLER}/");
256 autoscript($package,"postinst", "postinst-init-nostart",
257 "s/#SCRIPT#/$script/;s/#INITPARMS#/$params/;s/#ERROR_HANDLER#/$dh{ERROR_HANDLER}/");
261 autoscript($package,"postrm","postrm-init",
262 "s/#SCRIPT#/$script/;s/#INITPARMS#/$params/;s/#ERROR_HANDLER#/$dh{ERROR_HANDLER}/");
271 This program is a part of debhelper.
275 Joey Hess <joeyh@debian.org>
277 Steve Langasek <steve.langasek@canonical.com>