=head1 NAME
-dh_installinit - install init scripts into package build directories
+dh_installinit - install upstart jobs or init scripts into package build directories
=cut
=head1 SYNOPSIS
-B<dh_installinit> [S<I<debhelper options>>] [B<--
init-script=>I<scriptname>] [B<-n>] [B<-r>] [B<-d>] [S<B<--> I<params>>]
+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>>]
=head1 DESCRIPTION
dh_installinit is a debhelper program that is responsible for installing
-init scripts and associated defaults files into package build directories.
+upstart job files or init scripts with associated defaults files into package
+build directories, and in the former case providing compatibility handling
+for non-upstart systems.
It also automatically generates the postinst and postrm and prerm commands
needed to set up the symlinks in /etc/rc*.d/ and to start and stop the init
scripts.
-If a file named debian/package.init exists, then it is installed into
-etc/init.d/package in the package build directory, with "package" replaced
-by the package name.
+=head1 FILES
-If a file named debian/package.default exists, then it is installed into
-etc/default/package in the package build directory, with "package" replaced
-by the package name.
+=over 4
+
+=item debian/I<package>.upstart
+
+If this exists, it is installed into etc/init/I<package>.conf in the package
+build directory.
+
+=item debian/I<package>.init
+
+Otherwise, if this exists, it is installed
+into etc/init.d/I<package> in the package build directory.
+
+=item debian/I<package>.default
+
+If this exists, it is installed into etc/default/I<package> in the package
+build directory.
+
+=back
=head1 OPTIONS
Do not modify postinst/postrm/prerm scripts.
+=item B<-o>, B<--onlyscripts>
+
+Only modify postinst/postrm/prerm scripts, do not actually install any init
+script, default files, or upstart job. May be useful if the init script or
+upstart job is shipped and/or installed by upstream in a way that doesn't
+make it easy to let dh_installinit find it.
+
+If no upstart job file is installed in the target directory when
+dh_installinit --onlyscripts is called, this program will assume that an
+init script is being installed and not provide the compatibility symlinks
+or upstart dependencies.
+
+=item B<-R>, B<--restart-after-upgrade>
+
+Do not stop the init script until after the package upgrade has been
+completed. This is different than the default behavior, which stops the
+script in the prerm, and starts it again in the postinst.
+
+This can be useful for daemons that should not have a possibly long
+downtime during upgrade. But you should make sure that the daemon will not
+get confused by the package being upgraded while it's running before using
+this option.
+
=item B<-r>, B<--no-restart-on-upgrade>
-Do not restart daemon on upgrade.
+Do not stop init script on upgrade.
+
+=item B<--no-start>
+
+Do not start the init script on install or upgrade, or stop it on removal.
+Only call update-rc.d. Useful for rcS scripts.
=item B<-d>, B<--remove-d>
Remove trailing "d" from the name of the package, and use the result for the
-filename the init script is installed as in etc/init.d/ , and the default file
+filename the upstart job file is installed as in etc/init/ , or for the
+filename the init script is installed as in etc/init.d and the default file
is installed as in etc/default/ . This may be useful for daemons with names
ending in "d". (Note: this takes precedence over the --init-script parameter
described below.)
Pass "params" to L<update-rc.d(8)>. If not specified, "defaults" will be
passed to L<update-rc.d(8)>.
+=item B<--name=>I<name>
+
+Install the upstart job file or the init script (and default file) using the
+filename I<name> instead of the default filename, which is the package name.
+When this parameter is used, dh_installinit looks for and installs files
+named debian/package.name.upstart, debian/package.name.init and
+debian/package.name.default, instead of the usual debian/package.upstart,
+debian/package.init and debian/package.default.
+
=item B<--init-script=>I<scriptname>
-Use "scriptname" as for the filename the init script is installed as in
+Use "scriptname" as the filename the init script is installed as in
etc/init.d/ (and also use it as the filename for the defaults file, if it
-is installed). This is useful if you need to have an init script with a name
-different from the package's name. Note that if you use this parameter,
-dh_installinit will look to see if a file in the debian/ directory exists
-that looks like "package.scriptname" and if so will install it as the init
-script in preference to the files it normally installs. This feature is really
-only useful if you need a single package to install more than one init script.
+is installed). If you use this parameter, dh_installinit will look to see
+if a file in the debian/ directory exists that looks like
+"package.scriptname" and if so will install it as the init script in
+preference to the files it normally installs.
+
+This parameter is deprecated, use the --name parameter instead. This
+parameter will be ignored completely for upstart jobs.
+
+=item B<--error-handler=>I<function>
+
+Call the named shell function if running the init script fails. The
+function should be provided in the prerm and postinst scripts, before the
+#DEBHELPER# token.
=back
=head1 NOTES
-Note that this command is not idempotent. "dh_clean -k" should be called
+Note that this command is not idempotent. L<dh_prep(1)> should be called
between invocations of this command. Otherwise, it may cause multiple
instances of the same text to be added to maintainer scripts.
=cut
-init();
+init(options => {
+ "r" => \$dh{R_FLAG},
+ "no-restart-on-upgrade" => \$dh{R_FLAG},
+ "no-start" => \$dh{NO_START},
+ "R|restart-after-upgrade" => \$dh{RESTART_AFTER_UPGRADE},
+ "init-script=s" => \$dh{INIT_SCRIPT},
+ "update-rcd-params=s", => \$dh{U_PARAMS},
+ "remove-d" => \$dh{D_FLAG},
+});
foreach my $package (@{$dh{DOPACKAGES}}) {
my $tmp=tmpdir($package);
# Figure out what filename to install it as.
my $script;
- if ($dh{D_FLAG}) {
+ my $jobfile=$package;
+ if (defined $dh{NAME}) {
+ $jobfile=$script=$dh{NAME};
+ }
+ elsif ($dh{D_FLAG}) {
# -d on the command line sets D_FLAG. We will
# remove a trailing 'd' from the package name and
# use that as the name.
$script=$package;
if ($script=~m/(.*)d$/) {
- $script=$1;
+ $jobfile=$script=$1;
}
else {
warning("\"$package\" has no final d' in its name, but -d was specified.");
else {
$script=$package;
}
+
+ my $job=pkgfile($package,"upstart");
+ my ($init,$default) = ('','');
+
+ if ($job ne '' || ($dh{ONLYSCRIPTS} && -e "$tmp/etc/init/$jobfile.conf")) {
+ if (! $dh{ONLYSCRIPTS}) {
+ if (! -d "$tmp/etc/init") {
+ doit("install","-d","$tmp/etc/init");
+ }
+
+ doit("install","-p","-m644",$job,"$tmp/etc/init/$jobfile.conf");
+ }
+
+ # ensures that our /etc/init.d/ symlink points to a valid
+ # implementation
+ addsubstvar($package, "misc:Depends", "upstart-job");
- my $init=pkgfile($package,$script) || pkgfile($package,"init") ||
- pkgfile($package,"init.d");
- my $default=pkgfile($package,'default');
+ if (! -d "$tmp/etc/init.d") {
+ doit("install","-d","$tmp/etc/init.d");
+ }
+ doit("ln","-sf","/lib/init/upstart-job","$tmp/etc/init.d/$jobfile");
+ }
+ else {
+ $init=pkgfile($package,$script) || pkgfile($package,"init") ||
+ pkgfile($package,"init.d");
+ $default=pkgfile($package,'default');
+ }
- if ($default ne '') {
+ if ($default ne '' && ! $dh{ONLYSCRIPTS}) {
if (! -d "$tmp/etc/default") {
doit("install","-d","$tmp/etc/default");
}
doit("install","-p","-m644",$default,"$tmp/etc/default/$script");
}
- if ($init ne '') {
+ if ($init ne '' && ! $dh{ONLYSCRIPTS}) {
if (! -d "$tmp/etc/init.d") {
doit("install","-d","$tmp/etc/init.d");
}
-
+
doit("install","-p","-m755",$init,"$tmp/etc/init.d/$script");
+ }
+
+ if ($job ne '' || $init ne '' || $dh{ONLYSCRIPTS})
+ {
+ if (-e "$tmp/etc/init/$jobfile.conf") {
+ $script=$jobfile;
+ }
# This is set by the -u "foo" command line switch, it's
# the parameters to pass to update-rc.d. If not set,
if ($params eq '') {
$params="defaults";
}
-
+
if (! $dh{NOSCRIPTS}) {
- # -r on the command line sets R_FLAG. If it's set, there
- # is no restart on upgrade.
- if ($dh{R_FLAG}) {
- autoscript($package,"postinst", "postinst-init-norestart",
- "s/#SCRIPT#/$script/;s/#INITPARMS#/$params/");
- autoscript($package,"postrm","postrm-init",
- "s/#SCRIPT#/$script/;s/#INITPARMS#/$params/");
- autoscript($package,"prerm","prerm-init-norestart",
- "s/#SCRIPT#/$script/;s/#INITPARMS#/$params/");
+ if (! $dh{NO_START}) {
+ if ($dh{RESTART_AFTER_UPGRADE}) {
+ # update-rc.d, and restart (or
+ # start if new install) script
+ autoscript($package,"postinst", "postinst-init-restart",
+ "s/#SCRIPT#/$script/;s/#INITPARMS#/$params/;s/#ERROR_HANDLER#/$dh{ERROR_HANDLER}/");
+ }
+ else {
+ # update-rc.d, and start script
+ autoscript($package,"postinst", "postinst-init",
+ "s/#SCRIPT#/$script/;s/#INITPARMS#/$params/;s/#ERROR_HANDLER#/$dh{ERROR_HANDLER}/");
+ }
+
+ if ($dh{R_FLAG} || $dh{RESTART_AFTER_UPGRADE}) {
+ # stops script only on remove
+ autoscript($package,"prerm","prerm-init-norestart",
+ "s/#SCRIPT#/$script/;s/#INITPARMS#/$params/;s/#ERROR_HANDLER#/$dh{ERROR_HANDLER}/");
+ }
+ else {
+ # always stops script
+ autoscript($package,"prerm","prerm-init",
+ "s/#SCRIPT#/$script/;s/#INITPARMS#/$params/;s/#ERROR_HANDLER#/$dh{ERROR_HANDLER}/");
+ }
}
else {
- autoscript($package,"postinst","postinst-init",
- "s/#SCRIPT#/$script/;s/#INITPARMS#/$params/");
- autoscript($package,"postrm","postrm-init",
- "s/#SCRIPT#/$script/;s/#INITPARMS#/$params/");
- autoscript($package,"prerm","prerm-init",
- "s/#SCRIPT#/$script/;s/#INITPARMS#/$params/");
+ # just update-rc.d
+ autoscript($package,"postinst", "postinst-init-nostart",
+ "s/#SCRIPT#/$script/;s/#INITPARMS#/$params/;s/#ERROR_HANDLER#/$dh{ERROR_HANDLER}/");
}
+
+ # removes rc.d links
+ autoscript($package,"postrm","postrm-init",
+ "s/#SCRIPT#/$script/;s/#INITPARMS#/$params/;s/#ERROR_HANDLER#/$dh{ERROR_HANDLER}/");
}
}
}
=head1 SEE ALSO
-L<debhelper(1)>
+L<debhelper(7)>
This program is a part of debhelper.
-=head1 AUTHOR
+=head1 AUTHORS
Joey Hess <joeyh@debian.org>
+Steve Langasek <steve.langasek@canonical.com>
+
=cut
projects / debhelper.git / blobdiff