debian/grml-debootstrap.8

   1 .TH GRML-DEBOOTSTRAP 8
   2 .SH NAME
   3 grml-debootstrap \- wrapper around debootstrap for installing plain Debian via grml
   4 .SH SYNOPSIS
   5 .B grml-debootstrap
   6 .RI [ options ]
   7 .SH DESCRIPTION
   8 This manual page documents briefly the
   9 .B grml-debootstrap
  10 command.
  11 .PP
  12 \fBgrml-debootstrap\fP is a wrapper suite around debootstrap
  13 (and cdebootstrap if you want) for installing a plain Debian
  14 system via grml very fast and easy.
  15
  16 All you have to do is adjust a few variables in configuration file
  17 /etc/debootstrap/config (or specify some variables via commandline) and invoke
  18 grml-debootstrap without any further options then.
  19
  20 A plain and base Debian system will be installed on the given
  21 device (or directory) then. Customization of this process is
  22 possible as well.
  23 .SH OPTIONS
  24 grml-debootstrap supports the following options:
  25 .TP
  26 .B \-h, \-\-help
  27 Show summary of options and exit.
  28 .TP
  29 .B \-v, \-\-version
  30 Show version of program and exit.
  31 .TP
  32 .B \-\-grub <device>
  33 Where do you want to install grub to? Use grub syntax for specifying.
  34 Do not forget to set groot as well. Leave empty to avoid installation of grub.
  35 .TP
  36 .B \-\-groot <device>
  37 Specify root device for usage in grub (corresponds with $TARGET).
  38 Again, use grub syntax for specifying.
  39 Corresponding with configuration variable GROOT.
  40 .TP
  41 .B \-m, \-\-mirror <URL>
  42 Specify mirror which should be used for apt-get/aptitude. Notice that
  43 specifying the mirror also sets the chrootmirror to the given value.
  44 Corresponding with configuration variables MIRROR and CHROOTMIRROR.
  45 .TP
  46 .B \-p, \-\-mntpoint </mntpoint>
  47 Specify mountpoint that should be used for mounting the target system.
  48 Corresponding with configuration variable MNTPOINT.
  49 .TP
  50 .B \-r, \-\-release <releasename>
  51 Specify release of new Debian system. Supported relases: sarge, etch, lenny and sid.
  52 Corresponding with configuration variable RELEASE.
  53 .TP
  54 .B \-t, \-\-target <target>
  55 Target partition (/dev/...) or directory (anything else without /dev at the
  56 beginning).
  57 .SH USAGE EXAMPLES
  58 .TP
  59 .B grml-debootstrap --target /dev/hda1 --grub hd0 --groot hd0,0
  60 Install default Debian release (stable/etch) on /dev/hda1 and install bootmanager
  61 Grub in MBR (master boot record) of /dev/hda and use /dev/hda1 as system partition.
  62 .TP
  63 .B grml-debootstrap --target /dev/hda6 --grub hd0 --groot hd0,5 --release sid
  64 Install Debian unstable/sid on /dev/hda6, install bootmanager
  65 Grub in MBR (master boot record) of /dev/hda and use /dev/hda6 as system partition.
  66 .TP
  67 .B grml-debootstrap --target /data/chroot
  68 Install default Debian release (stable/etch) in directory /data/chroot (without
  69 any bootloader).
  70 .TP
  71 .B grml-debootstrap --target /dev/sda3 --grub hd0 --groot hd0,2 --mirror ftp://ftp.tugraz.at/mirror/debian
  72 Install default Debian release (stable/etch) on /dev/sda3 and install bootmanager
  73 Grub in MBR (master boot record) of /dev/sda and use /dev/sda3 as system partition.
  74 Use specifed mirror instead of the default (ftp://ftp.debian.de/debian) one.
  75 .SH FILES
  76 .TP
  77 .B /etc/debootstrap/config
  78 Main configuration file. You have to adjust it according to your needs
  79 before you are able to run grml-debootstrap.
  80 .TP
  81 .B /etc/debootstrap/chroot-script
  82 The script executed within the new Debian system as soon as the main system
  83 has been installed via [c]debootstrap.
  84 .TP
  85 .B /etc/debootstrap/locale.gen
  86 Defines the default locales used for generating locales via locale-gen.
  87 .TP
  88 .B /etc/debootstrap/packages
  89 Defines the software packages which should be installed in the new
  90 Debian system by default.
  91 .TP
  92 .B /etc/debootstrap/stages/
  93 The default directory for storing information about executed stages. Every
  94 single function of grml-debootstrap will write 'done' to the stages directory
  95 into a file named as the function itself if it has been executed sucessfully.
  96 You can adjust the location of the directory via configuration variable STAGES
  97 via /etc/debootstrap/config.  Please notice that you have to remove the stages
  98 directory on your own if you want to re-execute grml-deboostrap after running it
  99 successfully once. This should avoid recurrent execution by error of
 100 grml-debootstrap (which might delete present data).
 101 .SH CUSTOMIZATION
 102
 103 You can control execution of grml-debootstrap via adjusting
 104 /etc/debootstrap/config for some main stuff or via setting some selected
 105 variables via commandline.  The packages which should be installed in the new
 106 Debian system can be defined via the file /etc/debootstrap/packages.  If you
 107 want to put existing files to the new Debian system you can place them into the
 108 (by default non-existing) directories boot, etc, share, usr and var in
 109 /etc/debootstrap/. Every existing directory will be copied to the new Debian
 110 system then.
 111
 112 .SH SUPPORTED RELEASES
 113 .TP
 114 Current status:
 115
 116   +----------------+-------------+-----------------+
 117   | Release / Tool | debootstrap | cdebootstrap    |
 118   +----------------+-------------+-----------------+
 119   | Sarge          |  works [1]  |  works [1]      |
 120   +----------------+-------------+-----------------+
 121   | Etch           |  works      |  works          |
 122   +----------------+-------------+-----------------+
 123   | Lenny          |  works      |  works          |
 124   +----------------+-------------+-----------------+
 125   | Sid            |  works      |  works          |
 126   +----------------+-------------+-----------------+
 127
 128 [1] Please notice that Sarge is the current old-stable within Debian.
 129 grml-debootstrap can handle the release but you really should not
 130 use Sarge anymore unless you really know what you are doing. Choose
 131 Etch instead.
 132
 133 .SH BUGS
 134 Probably. Please send bugreports to Michael Prokop <mika@grml.org>.
 135 .SH SEE ALSO
 136 .BR debootstrap (8),
 137 .BR cdebootstrap (1).
 138 .SH AUTHOR
 139 grml-debootstrap was written by Michael Prokop <mika@grml.org>.
 140 .PP
 141 This manual page was written by Michael Prokop <mika@grml.org>
 142 for the grml project (but may be used by others).