Rework config_swspeak, add config_hwspeak
[grml-autoconfig.git] / man / grml-autoconfig.8
1 .TH GRML-AUTOCONFIG 8 "June 4, 2006"
2 .SH NAME
3 grml-autoconfig \- script and configuration framework for the grml system
4 .SH SYNOPSIS
5 .B grml-autoconfig
6 .SH DESCRIPTION
7 This manual page documents briefly the
8 .B grml-autoconfig
9 command and the identically named framework.
10 .PP
11 \fBgrml-autoconfig\fP is an interface to the framework named grml-autoconfig.
12 /etc/init.d/grml-autoconfig is the main script of the grml-system where
13 all the hardware recognition and activation of services take place.
14
15 grml-autoconfig supports an adjustable configuration via the configuration
16 file named /etc/grml/autoconfig. The script named \fBgrml-autoconfig\fP is
17 a simple dialog-based interface to the configuration file. You can either
18 use the script for configuring grml-autoconfig or modify the configuration
19 file manually on your own (there is no interference).
20
21 The grml-autoconfig package creates three initscripts on installation:
22 /etc/init.d/bootlocal.first, /etc/init.d/bootlocal.middle and
23 /etc/init.d/bootlocal.last.
24
25 They are created in the maintainer scripts of the grml-autoconfig package.
26 This means they are not part of the package itself and therefore also not
27 marked as configuration files of the package. As a result the files won't be
28 touched anymore, neither when upgrading nor when removing the package! If you
29 want to add your own bootup commands you can use these files.
30 /etc/init.d/bootlocal.first is executed at the very beginning, in runlevel 'S'.
31 /etc/init.d/bootlocal.middle is executed right before startup of
32 grml-autoconfig itself in runlevel '2' only (where grml-autoconfig is located
33 as well).  Finally /etc/init.d/bootlocal.last is executed as one of the last
34 initscripts in runlevel '2' only.
35
36 .SH OPTIONS
37 The program grml-autoconfig does not support any options but needs to be run
38 with root permissions as it modifies a system wide configuration file (/etc/grml/autoconfig).
39 .SH FILES
40 .I /etc/init.d/grml-autoconfig
41 .RS
42 Init-script which runs the commands defined in /etc/grml/autoconfig.functions
43 after checking configuration file /etc/grml/autoconfig.
44 .PP
45 .RE
46 .I /usr/sbin/grml-autoconfig
47 .RS
48 Dialog interface to the configuration file /etc/grml/autoconfig.
49 .PP
50 .RE
51 .I /etc/grml/autoconfig{.small}
52 .RS
53 Configuration file for grml-autoconfig framework. On grml-small the configuration
54 file is named /etc/grml/autoconfig.small. You can either edit this configuration
55 file manually of use the dialog interface /usr/sbin/grml-autoconfig.
56 .PP
57 .RE
58 .I /etc/grml/autoconfig.functions
59 .RS
60 Main functions of the grml-autoconfig. You do not need to configure or execute the file.
61 For debugging purposes you can source this script also from within an interactive
62 shell and run specific functions afterwards.
63 .PP
64 .RE
65 .I /etc/grml/lsb-functions
66 .RS
67 Based on /lib/lsb/init-functions this file provides an adjusted
68 version of an lsb-like booting sequence.
69 .SH BUGS
70 If you find a bug please report it. See http://grml.org/bugs/
71 for details about bug reporting.
72 .SH AUTHOR
73 grml-autoconfig was written by Michael Prokop <mika@grml.org>
74 .PP
75 This manual page was written by Michael Prokop <mika@grml.org>,
76 for the grml project (but may be used by others).