Merge remote-tracking branch 'origin/github/pr/45'
[grml.org.git] / docs / config-framework-5.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
2 <HTML>
3 <HEAD>
4  <META NAME="GENERATOR" CONTENT="LinuxDoc-Tools 0.9.21">
5  <TITLE>grml - config-framework: Boot-Options </TITLE>
6  <LINK HREF="config-framework-6.html" REL=next>
7  <LINK HREF="config-framework-4.html" REL=previous>
8  <LINK HREF="config-framework.html#toc5" REL=contents>
9 </HEAD>
10 <BODY>
11 <A HREF="config-framework-6.html">Next</A>
12 <A HREF="config-framework-4.html">Previous</A>
13 <A HREF="config-framework.html#toc5">Contents</A>
14 <HR>
15 <H2><A NAME="bootoptions"></A> <A NAME="s5">5.</A> <A HREF="config-framework.html#toc5">Boot-Options </A></H2>
16
17 <P>The following bootoptions are supported. Use them at the bootprompt as
18 documented here.</P>
19 <P>
20 <DL>
21
22 <DT><B>myconfig</B><DD><P>This option is for restoring configuration from a local file.</P>
23 <P>
24 <BLOCKQUOTE><CODE>
25 <HR>
26 <PRE>
27  myconfig=/dev/sda1                        => use file config.tbz from usb-device
28  myconfig=/dev/fd0                         => use file config.tbz from floppy-disk
29  myconfig=/dev/sda1 file=config_foobar.tbz => use file config_foobar.tbz from usb-device
30 </PRE>
31 <HR>
32 </CODE></BLOCKQUOTE>
33 </P>
34
35
36 <DT><B>file</B><DD><P>Specify filename of archive which should be restored. If no bootparam
37 file=... is provided the default 'config.tbz' is assumed. Notice: use this bootparam
38 in combination with bootparam myconfig.</P>
39 <P>
40 <BLOCKQUOTE><CODE>
41 <HR>
42 <PRE>
43   file=foobar.tbz             => use foobar.tbz as configuration archive
44   file=/path/to/config.tbz    => use /path/to/config.tbz as configuration archive
45 </PRE>
46 <HR>
47 </CODE></BLOCKQUOTE>
48 </P>
49
50 <DT><B>noautoconfig</B><DD><P>Deactivate automounting. By default the command 'mount'
51 tries to mount a device with label 'GRMLCFG'. If you specify the
52 noautoconfig bootparam this automounting will be deactivated.</P>
53 <P>
54 <BLOCKQUOTE><CODE>
55 <HR>
56 <PRE>
57   noautoconfig            => disables auto mounting of label 'GRMLCFG'
58 </PRE>
59 <HR>
60 </CODE></BLOCKQUOTE>
61 </P>
62 <P>TODO: documentation how to use labeling</P>
63
64 <DT><B>extract</B><DD><P>Extract specific directories from configuration archive.
65 Notice: This bootparam is useful only with bootparams which are able
66 to extract configuration archives.</P>
67 <P>
68 <BLOCKQUOTE><CODE>
69 <HR>
70 <PRE>
71   extract=home       => extract only /home from archive
72   extract=etc        => extract only /etc from archive
73   extract=configdir  => extract only $HOME/config from archive
74 </PRE>
75 <HR>
76 </CODE></BLOCKQUOTE>
77 </P>
78
79
80 <DT><B>partconf</B><DD><P>Use files from specific partition of local system. This option
81 reads filelist from /etc/grml/partconf and tries to copy all existing files
82 from given partition over the grml system. This provides the possibility to
83 use for example a predefined network setup via /etc/network/interfaces.</P>
84 <P>
85 <BLOCKQUOTE><CODE>
86 <HR>
87 <PRE>
88   partconf=/dev/hda2   => copy files specified in /etc/grml/partconf from /dev/hda2 to running grml-system
89 </PRE>
90 <HR>
91 </CODE></BLOCKQUOTE>
92 </P>
93
94 <DT><B>home</B><DD><P>This option is for setting a specific partition as home directory.</P>
95 <P>
96 <BLOCKQUOTE><CODE>
97 <HR>
98 <PRE>
99  home=/dev/hda3    =>   use /dev/hda3 as the homepartition
100  home=scan         =>   scan through the available partitions and search
101                         for file .grml_homedirectory
102 </PRE>
103 <HR>
104 </CODE></BLOCKQUOTE>
105 </P>
106
107 <DT><B>scripts</B><DD><P>This option supports running a script located in
108 /cdrom/scripts/.</P>
109 <P>
110 <BLOCKQUOTE><CODE>
111 <HR>
112 <PRE>
113  scripts               =>   run script /cdrom/scripts/grml.sh
114  scripts=foobar.sh     =>   run script foobar.sh in /cdrom/scripts/
115 </PRE>
116 <HR>
117 </CODE></BLOCKQUOTE>
118 </P>
119
120 <DT><B>config</B><DD><P>Use this option to restore configuration via using
121 directory /cdrom/config (located in root-directory on a usb-device).</P>
122 <P>
123 <BLOCKQUOTE><CODE>
124 <HR>
125 <PRE>
126  config                    =>   restore configuration using file config.tbz from directory /cdrom/config/
127  config=config_foobar.tbz  =>   restore configuration using file config_foobar.tbz from directory /cdrom/config/
128 </PRE>
129 <HR>
130 </CODE></BLOCKQUOTE>
131 </P>
132
133 <DT><B>netconfig</B><DD><P>Use this option to restore configuration via using
134 wget to download a configuration file from specified destination.</P>
135 <P>
136 <BLOCKQUOTE><CODE>
137 <HR>
138 <PRE>
139  netconfig=protocol://1.2.3.4/path/to/config.tbz  =>   restore configuration using wget to download file config.tbz
140 </PRE>
141 <HR>
142 </CODE></BLOCKQUOTE>
143 </P>
144
145 <DT><B>debs</B><DD><P>This options allows automatic installation of deb packages
146 while booting.</P>
147 <P>
148 <BLOCKQUOTE><CODE>
149 <HR>
150 <PRE>
151  debs              =>   install all debian packages (suffix .deb) from directory /cdrom/debs/
152  debs=01           =>   install all debian packages (suffix .deb) starting with 01 in the filename from directory /cdrom/debs/
153 </PRE>
154 <HR>
155 </CODE></BLOCKQUOTE>
156 </P>
157
158 </DL>
159 </P>
160
161 <HR>
162 <A HREF="config-framework-6.html">Next</A>
163 <A HREF="config-framework-4.html">Previous</A>
164 <A HREF="config-framework.html#toc5">Contents</A>
165 </BODY>
166 </HTML>