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<-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<--no-restart-on-upgrade>
50 Do not restart init script on upgrade.
54 Do not start the init script on install or upgrade, or stop it on removal.
55 Only call update-rc.d. Useful for rcS scripts.
57 =item B<-d>, B<--remove-d>
59 Remove trailing "d" from the name of the package, and use the result for the
60 filename the init script is installed as in etc/init.d/ , and the default file
61 is installed as in etc/default/ . This may be useful for daemons with names
62 ending in "d". (Note: this takes precedence over the --init-script parameter
65 =item B<-u>I<params> B<--update-rcd-params=>I<params>
69 Pass "params" to L<update-rc.d(8)>. If not specified, "defaults" will be
70 passed to L<update-rc.d(8)>.
72 =item B<--name=>I<name>
74 Install the init script (and default file) using the filename I<name>
75 instead of the default filename, which is the package name. When this
76 parameter is used, dh_installinit looks for and installs files named
77 debian/package.name.init and debian/package.name.default, instead of the
78 usual debian/package.init and debian/package.default.
80 =item B<--init-script=>I<scriptname>
82 Use "scriptname" as the filename the init script is installed as in
83 etc/init.d/ (and also use it as the filename for the defaults file, if it
84 is installed). If you use this parameter, dh_installinit will look to see
85 if a file in the debian/ directory exists that looks like
86 "package.scriptname" and if so will install it as the init script in
87 preference to the files it normally installs.
89 This parameter is deprecated, use the --name parameter instead.
93 =item B<--error-handler=>I<function>
95 Call the named shell function if running the init script fails. The
96 function should be provided in the prerm and postinst scripts, before the
103 Note that this command is not idempotent. "dh_clean -k" should be called
104 between invocations of this command. Otherwise, it may cause multiple
105 instances of the same text to be added to maintainer scripts.
111 foreach my $package (@{$dh{DOPACKAGES}}) {
112 my $tmp=tmpdir($package);
114 # Figure out what filename to install it as.
116 if (defined $dh{NAME}) {
119 elsif ($dh{D_FLAG}) {
120 # -d on the command line sets D_FLAG. We will
121 # remove a trailing 'd' from the package name and
122 # use that as the name.
124 if ($script=~m/(.*)d$/) {
128 warning("\"$package\" has no final d' in its name, but -d was specified.");
131 elsif ($dh{INIT_SCRIPT}) {
132 $script=$dh{INIT_SCRIPT};
138 my $init=pkgfile($package,$script) || pkgfile($package,"init") ||
139 pkgfile($package,"init.d");
140 my $default=pkgfile($package,'default');
142 if ($default ne '' && ! $dh{ONLYSCRIPTS}) {
143 if (! -d "$tmp/etc/default") {
144 doit("install","-d","$tmp/etc/default");
146 doit("install","-p","-m644",$default,"$tmp/etc/default/$script");
149 if ($init ne '' || $dh{ONLYSCRIPTS}) {
150 if (! $dh{ONLYSCRIPTS}) {
151 if (! -d "$tmp/etc/init.d") {
152 doit("install","-d","$tmp/etc/init.d");
155 doit("install","-p","-m755",$init,"$tmp/etc/init.d/$script");
158 # This is set by the -u "foo" command line switch, it's
159 # the parameters to pass to update-rc.d. If not set,
160 # we have to say "defaults".
162 if (defined($dh{U_PARAMS})) {
163 $params=join(' ',@{$dh{U_PARAMS}});
169 if (! $dh{NOSCRIPTS}) {
170 if (! $dh{NO_START}) {
171 # update-rc.d, and start script
172 autoscript($package,"postinst", "postinst-init",
173 "s/#SCRIPT#/$script/;s/#INITPARMS#/$params/;s/#ERROR_HANDLER#/$dh{ERROR_HANDLER}/");
176 # stops script only on remove
177 autoscript($package,"prerm","prerm-init-norestart",
178 "s/#SCRIPT#/$script/;s/#INITPARMS#/$params/;s/#ERROR_HANDLER#/$dh{ERROR_HANDLER}/");
181 # always stops script
182 autoscript($package,"prerm","prerm-init",
183 "s/#SCRIPT#/$script/;s/#INITPARMS#/$params/;s/#ERROR_HANDLER#/$dh{ERROR_HANDLER}/");
188 autoscript($package,"postinst", "postinst-init-nostart",
189 "s/#SCRIPT#/$script/;s/#INITPARMS#/$params/;s/#ERROR_HANDLER#/$dh{ERROR_HANDLER}/");
193 autoscript($package,"postrm","postrm-init",
194 "s/#SCRIPT#/$script/;s/#INITPARMS#/$params/;s/#ERROR_HANDLER#/$dh{ERROR_HANDLER}/");
203 This program is a part of debhelper.
207 Joey Hess <joeyh@debian.org>