Drop contrib + non-free from default COMPONENTS, support --contrib + -non-free cmdlin...
[grml-debootstrap.git] / config
diff --git a/config b/config
index 7b275f6..918b028 100644 (file)
--- a/config
+++ b/config
 # Authors:       grml-team (grml.org), (c) Michael Prokop <mika@grml.org>
 # Bug-Reports:   see http://grml.org/bugs/
 # License:       This file is licensed under the GPL v2.
-# Latest change: Mon Apr 09 14:42:58 CEST 2007 [mika]
 ################################################################################
 
 ################################################################################
-# Important: you definitely have to adjust the following variables!
+# Important: adjust this file if you want to execute grml-debootstrap
+#            without using the (limited) interactive frontend or
+#            command line options (see manpage and grml-debootstrap --help)
 ################################################################################
-## The most important question: target of the new Debian system
-## Where should Debian be installed to?
-#
-# Usually you want to use a partition. If you specify a string *without* /dev/
-# in the beginning, grml-debootstrap assumes you want to install Debian into a
-# directory. If so then MKFS, TUNE2FS, GRUB, GROOT and FSCK won't apply, no
-# matter of the configuration variables. Make sure the TARGET-directory is on a
-# partition with present dev and exec mount options.
-#
-# usage examples:
-# TARGET='/dev/hda1'
-# TARGET='/mnt/grml'
-TARGET=''
-
-## Do you want to install grub? Then adjust the variables GRUB and GROOT.
-## If you do not set the variables grub will not be installed.
-# Where do you want to install grub to? Use grub syntax for specifying
-# hints:  hd0,0 is the first partition on the first disk
-#         hd0   is the MBR of the first disk
-# usage example:
-# GRUB='hd0'
-GRUB=''
-
-# specify root device for usage in grub (corresponds with $TARGET)
-# notice: if you install Debian for example to /dev/hda1 use hd0,0
-#         hd0,0 is the first partition on the first disk
-#         hd0   is the MBR of the first disk
-# usage example:
-# GROOT='hd0,0'
-GROOT=''
 
-################################################################################
-# Now the variables you might want to adjust, but need not to...
-
-# set mirror where debootstrap should download packages from
-MIRROR='ftp://ftp.debian.de/debian'
-
-# specify entry which should be used for /etc/apt/sources.list,
-# if empty then any existing /etc/apt/sources.list will be taken
-CHROOTMIRROR='ftp://ftp.debian.de/debian'
-
-# add grml repository to /etc/apt/sources.list
-# if empty then the repository won't be added (notice: in testing phase)
+# Where should Debian be installed to?
+# Usually you want to use a partition.
+# If you specify a string *without* /dev/ in the beginning, grml-debootstrap
+# assumes you want to install Debian into a directory. MKFS, TUNE2FS, GRUB and
+# FSCK will be ignored.
+# Make sure the TARGET-directory points to a filesystem which has the dev, exec
+# options enabled.
+# Default: no default.
+# Usage examples:
+# TARGET='/dev/sda1' # install to partition /dev/sda1
+# TARGET='/mnt/grml' # install into directory /mnt/grml
+
+# Install the grub bootloader?
+# Specify the device where grub will be installed.
+# Note: grub can not be installed into a partition.
+# Default: no default. (Grub will not be installed.)
+# Usage example:
+# GRUB='/dev/sda' # Install into MBR of sda
+
+# Additional kernel boot options. (For grub.)
+# Default: no default.
+# Usage example:
+# BOOT_APPEND='pci=nomsi'
+
+# Set mirror where packages will be downloaded from.
+# Default: use /etc/debootstrap/etc/apt/sources.list if it exists, else
+# 'http://http.debian.net/debian'
+# Usage example:
+# MIRROR='ftp://ftp.de.debian.org/debian'
+
+# Debian Install CD path:
+# If you have a Debian CD (or mounted ISO), core packages will be
+# installed from the CD instead of from the network.
+# Default: no default.
+# ISO='file:/mnt/iso/debian/'
+
+# If /etc/apt/sources.list should NOT be build on the fly, this
+# options allows providing a separate apt sources.list file via
+# /etc/debootstrap/etc/apt/sources.list
+# KEEP_SRC_LIST='yes'
+
+# To enable the Grml repository via /etc/apt/sources.list.d/grml.list
+# set this variable to 'yes'.
+# Default: 'no'
 # GRMLREPOS='yes'
 
-# install packages from grml-pool? requires activated $GRMLREPOS from above
-# if empty nothing will be added (notice: in testing phase)
+# Install packages from grml-repository?
+# Requires activated $GRMLREPOS from above. If empty nothing will be added.
+# Default: no default.
 # GRMLPACKAGES='grml-etc-core'
 
-# release (which Debian version should be installed)
-# supported values: sarge etch sid
-RELEASE='etch'
-
-# architecture
-# if unset the default of the running system (see 'dpkg --print-architecture') will be taken
-# notice: installing an amd64 system requires a 64bit kernel
-#         do not forget to adjust $KERNEL for selected architecture as well
-# ARCH='amd64'
-
-# hostname of new system
-HOSTNAME='grml'
-
-# kernel version which should be installed
-# do not forget to adjust according to architecture, for example
-# use 2.6-686 for i386 and 2.6-amd64 for amd64
-KERNEL='2.6-686'
+# To enable Debian's backports repository via
+# /etc/apt/sources.list.d/backports.list set this variable to 'yes'.
+# Default: 'no'
+# BACKPORTREPOS='yes'
 
-# name of debootstrap executable
-# supported values: debootstrap cdebootstrap
-DEBOOTSTRAP='debootstrap'
+# Debian release that should be installed.
+# Supported values: lenny, squeeze, wheezy, jessie, stretch, sid
+# Default: 'jessie'
+# RELEASE='jessie'
 
-# install packages defined in /etc/debootstrap/packages?
-PACKAGES='yes'
+# Define components that should be used within sources.list.
+# Default: 'main'
+# COMPONENTS='main contrib non-free'
 
-# place of config files for debootstrap
-CONFFILES='/etc/debootstrap/'
-
-# mount point where chroot actions should take place
-MNTPOINT='/mnt/test'
-
-# executable which should be run on $TARGET
-# unset it if you do not want to use it
-MKFS='mkfs.ext3'
-
-# deactivate automatic filesystem check on $TARGET?
-# unset it if you do not want to use it
-TUNE2FS='tune2fs -c0 -i0'
-
-# check filesystem when chroot stuff finished?
-FSCK='yes'
+# Set target architecture.
+# Only useful when installing i386 while running an amd64 kernel.
+# Default: current architecture. (From 'dpkg —print-architecture'.)
+# ARCH='amd64'
 
-# which tool should be used for fsck? if unset the tool will be guesst based on $MKFS
+# Hostname of new system.
+# Default: $HOSTNAME or if unset 'grml'
+# HOSTNAME='grml'
+
+# Kernel version to install.
+# Default: according to current architecture.
+# KERNEL='2.6-686'
+
+# Set initial password for the root user.
+# Please change this password after installation for security reasons.
+# Default: no default.
+# ROOTPASSWORD=''
+
+# Name of debootstrap executable.
+# Supported values: 'debootstrap', 'cdebootstrap'
+# Default: 'debootstrap'
+# DEBOOTSTRAP='debootstrap'
+
+# Pass extra options to debootstrap.
+# Default: no default.
+# Usage example:
+# DEBOOTSTRAP_OPT='--include=debconf-utils,locales,pciutils --exclude=nano,tasksel,tasksel-data,iptables'
+
+# debconf-frontend that should be used.
+# Default: 'noninteractive'
+# DEBIAN_FRONTEND='noninteractive'
+
+# Pass extra options to aptitude/apt-get.
+# Default: no default.
+# DPKG_OPTIONS='-o APT::Get::AllowUnauthenticated=true -o aptitude::Cmdline::ignore-trust-violations=yes'
+
+# Use custom grml-debootstrap stages.
+# Specify path to your custom grml-debootstrap stages.
+# Default: '/var/cache/grml-debootstrap'
+# STAGES='/var/cache/grml-debootstrap'
+
+# Install packages defined in /etc/debootstrap/packages.
+# Default: 'yes'
+# PACKAGES='no'
+
+# Pre-seed DebConf questions from /etc/debootstrap/debconf-selections.
+# Default: 'yes' (if file exists)
+# DEBCONF='no'
+
+# Run scripts from /etc/debootstrap/pre-scripts/ before creating the chroot.
+# Default: 'yes'
+# PRE_SCRIPTS='no'
+
+# Run scripts from /etc/debootstrap/chroot-scripts/ inside chroot.
+# Default: 'yes'
+# CHROOT_SCRIPTS='no'
+
+# Run scripts from /etc/debootstrap/scripts/ after setting up chroot.
+# Default: 'yes'
+# SCRIPTS='no'
+
+# Install *.deb packages from /etc/debootstrap/extrapackages/
+# Default: 'yes'
+# EXTRAPACKAGES='no'
+
+# Location of config files for debootstrap.
+# Default: '/etc/debootstrap'
+# CONFFILES='/etc/debootstrap'
+
+# Mount point to use during installation.
+# Default: no default.
+# MNTPOINT='/mnt/debootstrap'
+
+# File system creation tool to apply on $TARGET.
+# If empty, no file system will be created.
+# Default: 'mkfs.ext4'
+# MKFS=''
+
+# Command line options for file system creation tool.
+# Default: no default.
+# MKFS_OPTS=''
+
+# Filesystem tuning tool to apply on $TARGET.
+# If empty, the created file system will not be tuned.
+# Default: 'tune2fs -c0 -i0' if ext* filesystem is used, no default otherwise.
+# TUNE2FS='tune2fs -c0 -i0'
+
+# Check file system after installation is finished.
+# Default: 'no'
+# FSCK='yes'
+
+# File system checking tool to apply on $TARGET.
+# Default: guessed.
 # FSCKTOOL=''
 
-# which packages do you want do dpkg-reconfigure?
-RECONFIGURE='locales console-data'
-
-# use /etc/debootstrap/locale.gen for configuration of locales?
-LOCALES='yes'
-
-# use /usr/share/zoneinfo/$TIMEZONE for /etc/localtime
-TIMEZONE='Europe/Vienna'
-
-# generate initrd via update-initramfs?
-# notice: won't do anything when release is sarge as update-initramfs does not exist there
-INITRD='yes'
+# Packages that should be 'dpkg-reconfigure'-ed while installation.
+# Default: 'console-data'.
+# RECONFIGURE='console-data'
+
+# Generate locales using /etc/debootstrap/locale.gen configuration file.
+# Default: 'yes'
+# LOCALES='no'
+
+# locales (LANG) that should be used as default.
+# Default: 'en_US.UTF-8'
+# DEFAULT_LOCALES='en_US.UTF-8'
+
+# locales (LANGUAGE) that should be used as default.
+# Default: 'en_US:en'
+# DEFAULT_LANGUAGE='en_US:en'
+
+# Use /usr/share/zoneinfo/$TIMEZONE for /etc/localtime.
+# Default: 'Europe/Vienna'
+# TIMEZONE='Europe/Vienna'
+
+# Clean APT cache after installation is finished.
+# Default: 'yes'
+# RM_APTCACHE='no'
+
+# Upgrade system via apt-get/aptitude update + [safe-]upgrade.
+# Default: 'yes'
+# UPGRADE_SYSTEM='no'
+
+# Explicit generation of initrd via update-initramfs.
+# Default: 'yes'
+# INITRD='no'
+
+# If the specified file exists its content will be displayed at the end of the
+# installation process.
+# Useful for checking for errors and display warning message.
+# Default: '/etc/debootstrap/install_notes' (empty file).
+# INSTALL_NOTES='/etc/debootstrap/install_notes'
+
+# Use fixed disk identifiers for Virtual Machine builds.
+# Useful for reproducible builds.
+# Default: 'no'
+# FIXED_DISK_IDENTIFIERS='yes'
+
+# Disk identifier when using FIXED_DISK_IDENTIFIERS='yes'.
+# Use uuid-runtime's uuidgen tool to generate random UUIDs on demand.
+# Default: '26ada0c0-1165-4098-884d-aafd2220c2c6'
+# DISK_IDENTIFIER="$(uuidgen)"
 
 ## END OF FILE #################################################################