5 dh_installinit - install 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>] [S<B<--> I<params>>]
18 dh_installinit is a debhelper program that is responsible for installing
19 init scripts and associated defaults files into package build directories.
21 It also automatically generates the postinst and postrm and prerm commands
22 needed to set up the symlinks in /etc/rc*.d/ and to start and stop the init
25 If a file named debian/package.init exists, then it is installed into
26 etc/init.d/package in the package build directory, with "package" replaced
29 If a file named debian/package.default exists, then it is installed into
30 etc/default/package in the package build directory, with "package" replaced
37 =item B<-n>, B<--noscripts>
39 Do not modify postinst/postrm/prerm scripts.
41 =item B<-o>, B<--onlyscripts>
43 Only modify postinst/postrm/prerm scripts, do not actually install any init
44 script or default files. May be useful if the init script is shipped and/or
45 installed by upstream in a way that doesn't make it easy to let
46 dh_installinit find it.
48 =item B<-R>, B<--restart-after-upgrade>
50 Do not stop the init script until after the package upgrade has been
51 completed. This is different than the default behavior, which stops the
52 script in the prerm, and starts it again in the postinst.
54 This can be useful for daemons that should not have a possibly long
55 downtime during upgrade. But you should make sure that the daemon will not
56 get confused by the package being upgraded while it's running before using
59 =item B<-r>, B<--no-restart-on-upgrade>
61 Do not stop init script on upgrade.
65 Do not start the init script on install or upgrade, or stop it on removal.
66 Only call update-rc.d. Useful for rcS scripts.
68 =item B<-d>, B<--remove-d>
70 Remove trailing "d" from the name of the package, and use the result for the
71 filename the init script is installed as in etc/init.d/ , and the default file
72 is installed as in etc/default/ . This may be useful for daemons with names
73 ending in "d". (Note: this takes precedence over the --init-script parameter
76 =item B<-u>I<params> B<--update-rcd-params=>I<params>
80 Pass "params" to L<update-rc.d(8)>. If not specified, "defaults" will be
81 passed to L<update-rc.d(8)>.
83 =item B<--name=>I<name>
85 Install the init script (and default file) using the filename I<name>
86 instead of the default filename, which is the package name. When this
87 parameter is used, dh_installinit looks for and installs files named
88 debian/package.name.init and debian/package.name.default, instead of the
89 usual debian/package.init and debian/package.default.
91 =item B<--init-script=>I<scriptname>
93 Use "scriptname" as the filename the init script is installed as in
94 etc/init.d/ (and also use it as the filename for the defaults file, if it
95 is installed). If you use this parameter, dh_installinit will look to see
96 if a file in the debian/ directory exists that looks like
97 "package.scriptname" and if so will install it as the init script in
98 preference to the files it normally installs.
100 This parameter is deprecated, use the --name parameter instead.
102 =item B<--error-handler=>I<function>
104 Call the named shell function if running the init script fails. The
105 function should be provided in the prerm and postinst scripts, before the
112 Note that this command is not idempotent. L<dh_prep(1)> should be called
113 between invocations of this command. Otherwise, it may cause multiple
114 instances of the same text to be added to maintainer scripts.
120 "no-restart-on-upgrade" => \$dh{R_FLAG},
121 "no-start" => \$dh{NO_START},
122 "R|restart-after-upgrade" => \$dh{RESTART_AFTER_UPGRADE},
123 "init-script=s" => \$dh{INIT_SCRIPT},
124 "update-rcd-params=s", => \$dh{U_PARAMS},
125 "remove-d" => \$dh{D_FLAG},
128 foreach my $package (@{$dh{DOPACKAGES}}) {
129 my $tmp=tmpdir($package);
131 # Figure out what filename to install it as.
133 if (defined $dh{NAME}) {
136 elsif ($dh{D_FLAG}) {
137 # -d on the command line sets D_FLAG. We will
138 # remove a trailing 'd' from the package name and
139 # use that as the name.
141 if ($script=~m/(.*)d$/) {
145 warning("\"$package\" has no final d' in its name, but -d was specified.");
148 elsif ($dh{INIT_SCRIPT}) {
149 $script=$dh{INIT_SCRIPT};
155 my $init=pkgfile($package,$script) || pkgfile($package,"init") ||
156 pkgfile($package,"init.d");
157 my $default=pkgfile($package,'default');
159 if ($default ne '' && ! $dh{ONLYSCRIPTS}) {
160 if (! -d "$tmp/etc/default") {
161 doit("install","-d","$tmp/etc/default");
163 doit("install","-p","-m644",$default,"$tmp/etc/default/$script");
166 if ($init ne '' || $dh{ONLYSCRIPTS}) {
167 if (! $dh{ONLYSCRIPTS}) {
168 if (! -d "$tmp/etc/init.d") {
169 doit("install","-d","$tmp/etc/init.d");
172 doit("install","-p","-m755",$init,"$tmp/etc/init.d/$script");
175 # This is set by the -u "foo" command line switch, it's
176 # the parameters to pass to update-rc.d. If not set,
177 # we have to say "defaults".
179 if (defined($dh{U_PARAMS})) {
180 $params=join(' ',@{$dh{U_PARAMS}});
186 if (! $dh{NOSCRIPTS}) {
187 if (! $dh{NO_START}) {
188 if ($dh{RESTART_AFTER_UPGRADE}) {
189 # update-rc.d, and restart (or
190 # start if new install) script
191 autoscript($package,"postinst", "postinst-init-restart",
192 "s/#SCRIPT#/$script/;s/#INITPARMS#/$params/;s/#ERROR_HANDLER#/$dh{ERROR_HANDLER}/");
195 # update-rc.d, and start script
196 autoscript($package,"postinst", "postinst-init",
197 "s/#SCRIPT#/$script/;s/#INITPARMS#/$params/;s/#ERROR_HANDLER#/$dh{ERROR_HANDLER}/");
200 if ($dh{R_FLAG} || $dh{RESTART_AFTER_UPGRADE}) {
201 # stops script only on remove
202 autoscript($package,"prerm","prerm-init-norestart",
203 "s/#SCRIPT#/$script/;s/#INITPARMS#/$params/;s/#ERROR_HANDLER#/$dh{ERROR_HANDLER}/");
206 # always stops script
207 autoscript($package,"prerm","prerm-init",
208 "s/#SCRIPT#/$script/;s/#INITPARMS#/$params/;s/#ERROR_HANDLER#/$dh{ERROR_HANDLER}/");
213 autoscript($package,"postinst", "postinst-init-nostart",
214 "s/#SCRIPT#/$script/;s/#INITPARMS#/$params/;s/#ERROR_HANDLER#/$dh{ERROR_HANDLER}/");
218 autoscript($package,"postrm","postrm-init",
219 "s/#SCRIPT#/$script/;s/#INITPARMS#/$params/;s/#ERROR_HANDLER#/$dh{ERROR_HANDLER}/");
228 This program is a part of debhelper.
232 Joey Hess <joeyh@debian.org>