doc/save-config.1.txt

   1 save-config(1)
   2 ==============
   3
   4 Name
   5 ----
   6 save-config - save configuration
   7
   8 Synopsis
   9 --------
  10
  11 save-config <safe-options>
  12
  13 About
  14 -----
  15
  16 This script generates a plain bzip2 compressed tar archive containing the
  17 specified files, suitable as a GCA ('grml configuration archive', see
  18 grml-autoconfig(1) for details).
  19
  20 Options
  21 -------
  22
  23 The following options are supported for specifying which parts should be saved
  24 in the configuration file:
  25
  26   *-home*::
  27
  28 Store hidden files from $HOME ($HOME/.*).
  29
  30   *-grmlhome*::
  31
  32 Store hidden files from \$HOME (\$HOME/.*) of user grml [use as user root].
  33
  34   *-etc*::
  35
  36 Sstore modified files from /etc.
  37
  38   *-configdir*::
  39
  40 Store $HOME/config.
  41
  42   *-all*::
  43
  44 Store all configuration files (:= -home, -configdir and -etc).
  45
  46 [TIP]
  47 It is also possible to use environment variables for specifying which parts
  48 should be saved.  Just set the corresponding variable: $SAVE_HOME, $SAVE_ETC,
  49 $SAVE_CONFIGDIR and $SAVE_ALL
  50
  51 The default filename of the generated configuration file is config.tbz.  The
  52 following options are supported for specifying another destination of the
  53 configuration file:
  54
  55   *-ssh user@host:/path/to/file*::
  56
  57 Copy configuration via ssh/scp to remote host.
  58
  59   *-mail <recipient>*::
  60
  61 Send configuration via mail.
  62
  63   *-file foo_bar_config.tbz*::
  64
  65 Save configuration in specified file.
  66
  67 Usage examples
  68 --------------
  69
  70   *save-config -all*::
  71
  72 Store all configuration files in config.tbz in current dir.
  73
  74   *save-config -home -mail  devnull@grml.org*::
  75
  76 Store $HOME/.* in config.tbz and send it via mail.
  77
  78   *save-config -etc  -ssh   devnull@grml.org:/path/*::
  79
  80 Store /etc in config.tbz and scp it to specified host.
  81
  82   *save-config -all  -file  foo.tbz*::
  83
  84 Store all configuration files in foo.tbz.
  85
  86   *SAVE_ALL=yes save-config -file /path/foo.tbz*::
  87
  88 Store all configuration files in /path/foo.tbz.
  89
  90 Bugs
  91 ----
  92 If you find a bug please report it. See link:http://grml.org/bugs/[] for details
  93 about how to report bugs.
  94
  95 See also
  96 --------
  97 grml-autoconfig(1), grml-autoconfig(8), restore-config(1)
  98
  99 Author
 100 ------
 101 (c) 2005++, Michael Prokop <mika@grml.org>