fix for 435148
[darcs-mirror-metainit.git] / update-metainit.pod
1 =head1 NAME
2
3 update-metainit - Generates init scripts
4
5 =head1 SYNOPSIS
6
7 B<update-metainit> [B<--remove> I<initname> [B<--purge>] ]
8
9 =head1 DESCRIPTION
10
11 I<Metainit> solves the problem of writing good init scripts. Instead
12 of manually creating these important files, they are derived from a declaritive description in the metainit files in I</etc/metainit>. These files can be shipped with packages or created by the local administrator.  
13
14 If B<update-metainit> called without argument, it will regenerate init scripts for all the files in I</etc/metainit>. The generated files contain a large warning
15 in form of a comment that they will be overridden. Modifications are
16 preferably done in the files in I</etc/metainit> and made effective by
17 running B<update-metainit>. If needed, the administrator can prevent
18 modified init files by removing the warning comment.
19
20 =head1 OPTIONS
21
22 =over 4
23
24 =item B<--remove> I<initname>
25
26 This command will remove any generated and non-modified scripts that
27 were created by the metainit file with the name I<initname>.
28
29 =item B<--purge>
30
31 Only usable with B<--remove>. Will remove the generated files even if
32 modified.
33
34 =back 
35
36 =head1 SEE ALSO
37
38 dh_metainit(1)
39
40 =head1 AUTHOR
41
42 Joachim Breitner <nomeata@debian.org>
43
44 =cut