summaryrefslogtreecommitdiff
path: root/doc/overview.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/overview.rst')
-rw-r--r--doc/overview.rst21
1 files changed, 21 insertions, 0 deletions
diff --git a/doc/overview.rst b/doc/overview.rst
index 09356c5..8194666 100644
--- a/doc/overview.rst
+++ b/doc/overview.rst
@@ -1,8 +1,13 @@
VMDebootstrap
#############
+.. index:: purpose
+
+.. _purpose:
+
Purpose
*******
+
vmdebootstrap is a helper to install basic Debian system into virtual
disk image. It wraps **debootstrap**. You need to run :file:`vmdebootstrap`
as root. If the ``--verbose`` option is not used, no output will be
@@ -17,6 +22,10 @@ to configure it. The image has an empty root password and will not have
networking configured by default. Set the root password before you
configure networking.
+.. index:: networking
+
+.. _networking
+
Networking
**********
@@ -35,6 +44,10 @@ into :file:`/etc/network/interfaces.d/setup`::
auto eth0
iface eth0 inet dhcp
+.. index:: bootloaders
+
+.. _bootloaders:
+
Bootloaders
***********
@@ -42,6 +55,8 @@ Unless the ``--no-extlinux`` or ``--grub`` options are specified, the
image will use ``extlinux`` as a boot loader. ``bootsize`` is not
recommended when using ``extlinux`` - use ``grub`` instead.
+.. _wheezy_grub:
+
Versions of grub2 in wheezy
===========================
@@ -63,6 +78,10 @@ not supported as it would need to be done after boot. If the system you
are creating is for more than just a VM or live image, you will likely
need a larger ESP, up to 500Mb.
+.. index: uboot
+
+.. _uboot:
+
UBoot
=====
@@ -71,6 +90,8 @@ typically support requires adding ``u-boot`` using ``--package`` and then
copying or manipulating the relevant ``u-boot`` files in the customisation
script. Examples are included for beaglebone-black.
+.. _installation_images:
+
Installation images and virtual machines
****************************************