added new bootparameter netscript
[grml-autoconfig.git] / doc / restore-config.1.txt
1 restore-config(1)
2 =================
3
4 Name
5 ----
6 restore-config - restore configuration
7
8 Synopsis
9 --------
10
11 restore-config <restore-options>
12
13 About
14 -----
15
16 You can either restore a GCA ('grml configuration archive', see
17 grml-autoconfig(1) for details) using the boot parameters or by a script file named
18 'restore-config'. Specify the filename of the configuration archive which
19 should be used as a parameter.
20
21 Options
22 -------
23
24 The following options are available to specify which parts of the archive should
25 be extracted.
26
27   *-home*::
28
29 Extract hidden files from $HOME ($HOME/.*).
30
31   *-grmlhome*::
32
33 Store hidden files from \$HOME (\$HOME/.*) of user grml [use as user root].
34
35   *-etc*::
36
37 Extract modified files from /etc.
38
39   *-configdir*::
40
41 Extract $HOME/config.
42
43 Note: The default is to extract (restore) all files found in the archive.
44
45 [TIP]
46 It is also possible to use environment variables for specifying which part
47 should be restored. Just set the corresponding variable: $RESTORE_HOME,
48 $RESTORE_ETC, $RESTORE_CONFIGDIR and $RESTORE_ALL
49
50 Usage examples
51 --------------
52
53   *restore-config -home foo_bar_config.tbz*::
54
55 Restore configuration from file foo_bar_config.tbz.
56
57   *restore-config config.tbz*::
58
59 Restore configuration from file config.tbz.
60
61 Bugs
62 ----
63 If you find a bug please report it. See link:http://grml.org/bugs/ for details
64 about how to report bugs.
65
66 See also
67 --------
68 grml-autoconfig(1), grml-autoconfig(8), mkpersistenthome(1), save-config(1)
69
70 Author
71 ------
72 (c) 2005++, Michael Prokop <mika@grml.org>