]> git.donarmstrong.com Git - debhelper.git/blobdiff - dh_installinit
Fix typo in French translation, about debian/package.README.Debian files.
[debhelper.git] / dh_installinit
index cd3fca487c3671a6eda115b390a4df411b0e7c91..7dde36316574e2754f335309655fda6ef469a697 100755 (executable)
 #!/usr/bin/perl -w
-#
-# Install debian/init[.d], and set up the postinst and postrm for init
-# scripts.
 
+=head1 NAME
+
+dh_installinit - install init scripts into package build directories
+
+=cut
+
+use strict;
 use Debian::Debhelper::Dh_Lib;
+
+=head1 SYNOPSIS
+
+B<dh_installinit> [S<I<debhelper options>>] [B<--name=>I<name>] [B<-n>] [B<-R>] [B<-r>] [B<-d>] [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.
+
+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.
+
+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.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-n>, B<--noscripts>
+
+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 or default files. May be useful if the init script is shipped and/or
+installed by upstream in a way that doesn't make it easy to let
+dh_installinit find it.
+
+=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 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
+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.)
+
+=item B<-u>I<params> B<--update-rcd-params=>I<params>
+
+=item B<--> I<params>
+
+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 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.init and debian/package.name.default, instead of the
+usual debian/package.init and debian/package.default.
+
+=item B<--init-script=>I<scriptname>
+
+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). 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.
+
+=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. 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();
 
-foreach $PACKAGE (@{$dh{DOPACKAGES}}) {
-       $TMP=tmpdir($PACKAGE);
+foreach my $package (@{$dh{DOPACKAGES}}) {
+       my $tmp=tmpdir($package);
 
        # Figure out what filename to install it as.
        my $script;
-       if ($dh{D_FLAG}) {
+       if (defined $dh{NAME}) {
+               $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;
+               $script=$package;
                if ($script=~m/(.*)d$/) {
                        $script=$1;
                }
                else {
-                       warning("\"$PACKAGE\" has no final d' in its name, but -d was specified.");
+                       warning("\"$package\" has no final d' in its name, but -d was specified.");
                }
        }       
        elsif ($dh{INIT_SCRIPT}) {
                $script=$dh{INIT_SCRIPT};
        }
        else {
-               $script=$PACKAGE;
+               $script=$package;
        }       
+       
+       my $init=pkgfile($package,$script) || pkgfile($package,"init") ||
+             pkgfile($package,"init.d");
+       my $default=pkgfile($package,'default');
 
-       $init=pkgfile($PACKAGE,$script) || pkgfile($PACKAGE,"init") ||
-             pkgfile($PACKAGE,"init.d");
-
-       if ($init ne '') {
-               if (! -d "$TMP/etc/init.d") {
-                       doit("install","-d","$TMP/etc/init.d");
+       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");
+       }
 
-               doit("install","-p","-m755",$init,"$TMP/etc/init.d/$script");
-
+       if ($init ne '' || $dh{ONLYSCRIPTS}) {
+               if (! $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");
+               }
+               
                # This is set by the -u "foo" command line switch, it's
                # the parameters to pass to update-rc.d. If not set,
                # we have to say "defaults".
@@ -50,26 +174,53 @@ foreach $PACKAGE (@{$dh{DOPACKAGES}}) {
                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(7)>
+
+This program is a part of debhelper.
+
+=head1 AUTHOR
+
+Joey Hess <joeyh@debian.org>
+
+=cut