Add support for overriding values via autoconfig.local
[grml-autoconfig.git] / doc / grml-autoconfig.8.txt
1 grml-autoconfig(8)
2 ==================
3
4 Name
5 ----
6 grml-autoconfig - script and configuration framework for the grml system
7
8 Synopsis
9 --------
10 grml-autoconfig
11
12 Options
13 -------
14
15 The program grml-autoconfig does not support any options but needs to be run
16 with root permissions as it modifies a system wide configuration file
17 (/etc/grml/autoconfig).
18
19 About
20 -----
21
22 The program grml-autoconfig does not support any options but needs to be run
23 with root permissions as it modifies a system wide configuration file
24 (/etc/grml/autoconfig).  'grml-autoconfig' is an interface to the framework
25 named grml-autoconfig.  /etc/init.d/grml-autoconfig is the main script of the
26 grml-system where all the hardware recognition and activation of services take
27 place.
28
29 grml-autoconfig supports an adjustable configuration via the configuration file
30 named /etc/grml/autoconfig. The script named Bgrml-autoconfig is a simple
31 dialog-based interface to the configuration file. You can either use the script
32 for configuring grml-autoconfig or modify the configuration file manually on
33 your own (there is no interference).
34
35 The grml-autoconfig package creates three initscripts on installation:
36 /etc/init.d/bootlocal.first, /etc/init.d/bootlocal.middle and
37 /etc/init.d/bootlocal.last.
38
39 They are created in the maintainer scripts of the grml-autoconfig package.  This
40 means they are not part of the package itself and therefore also not marked as
41 configuration files of the package. As a result the files won't be touched
42 anymore, neither when upgrading nor when removing the package! If you want to
43 add your own bootup commands you can use these files.
44 /etc/init.d/bootlocal.first is executed at the very beginning, in runlevel 'S'.
45 /etc/init.d/bootlocal.middle is executed right before startup of grml-autoconfig
46 itself in runlevel '2' only (where grml-autoconfig is located as well).  Finally
47 /etc/init.d/bootlocal.last is executed as one of the last initscripts in
48 runlevel '2' only.
49
50 Files
51 -----
52
53   */etc/init.d/grml-autoconfig*::
54
55 Init-script which runs the commands defined in /etc/grml/autoconfig.functions
56 after checking configuration file /etc/grml/autoconfig.
57
58   */usr/sbin/grml-autoconfig*::
59
60 Dialog interface to the configuration file /etc/grml/autoconfig.
61
62   */etc/grml/autoconfig*::
63
64 Default configuration file for grml-autoconfig framework.  You can override
65 settings via /etc/grml/autoconfig.local or use the dialog interface
66 /usr/sbin/grml-autoconfig.
67
68   */etc/grml/autoconfig.local*::
69 User specific configuration file for grml-autoconfig. You can edit it directly
70 or use the dialog interface /usr/sbin/grml-autoconfig.
71
72
73   */etc/grml/autoconfig.functions*::
74
75 Main functions of the grml-autoconfig. You do not need to configure or execute
76 the file.  For debugging purposes you can source this script also from within an
77 interactive shell and run specific functions afterwards.
78
79   */etc/grml/lsb-functions*::
80
81 Based on /lib/lsb/init-functions this file provides an adjusted version of an
82 lsb-like booting sequence.
83
84 Bugs
85 ----
86 If you find a bug please report it. See link:http://grml.org/bugs/ for details
87 about how to report bugs.
88
89 See also
90 --------
91 grml-autoconfig(1), mkpersistenthome(1), restore-config(1), save-config(1)
92
93 Author
94 ------
95 grml-autoconfig was written by Michael Prokop <mika@grml.org>.