vmdebootstrap.8

   1 .\" Copyright 2011 Lars Wirzenius <liw@liw.fi>
   2 .\"
   3 .\" This program is free software: you can redistribute it and/or modify
   4 .\" it under the terms of the GNU General Public License as published by
   5 .\" the Free Software Foundation, either version 3 of the License, or
   6 .\" (at your option) any later version.
   7 .\"
   8 .\" This program is distributed in the hope that it will be useful,
   9 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11 .\" GNU General Public License for more details.
  12 .\"
  13 .\" You should have received a copy of the GNU General Public License
  14 .\" along with this program.  If not, see <http://www.gnu.org/licenses/>.
  15 .\"
  16 .TH VMDEBOOTSTRAP 8
  17 .SH NAME
  18 vmdebootstrap \- install basic Debian system into virtual disk image
  19 .SH SYNOPSIS
  20 .B vmdebootstrap
  21 .BR \-\-image =\fIFILE
  22 .RB [ options ]
  23 .SH DESCRIPTION
  24 .B vmdebootstrap
  25 installs a basic Debian system into a virtual disk image,
  26 for use with virtual machines,
  27 such as KVM, Qemu, or VirtualBox.
  28 It is like
  29 .BR debootstrap (8),
  30 which does the same thing, but puts the system into a directory,
  31 for use with
  32 .BR chroot (8).
  33 (In fact,
  34 .B vmdebootstrap
  35 is a wrapper around
  36 .BR debootstrap ).
  37 .PP
  38 You need to run
  39 .B vmdebootstrap
  40 as root.
  41 .SH OPTIONS
  42 .TP
  43 .BR \-\-help
  44 Show full list of options (this manual page may be incomplete).
  45 .TP
  46 .BR \-\-verbose
  47 Report what is going on.
  48 .TP
  49 .BR \-\-log =\fIFILE
  50 Write log to
  51 .IR FILE .
  52 .TP
  53 .BR \-\-log\-level =\fILEVEL
  54 Write log messages of the given
  55 .I LEVEL
  56 or higher.
  57 Level is one of
  58 .IR debug ,
  59 .IR info ,
  60 .IR warning ,
  61 .IR error ,
  62 .IR critical ,
  63 .IR fatal ,
  64 and defaults to
  65 .IR info .
  66 .TP
  67 .BR \-\-image =\fIFILE
  68 Put created disk image in
  69 .IR FILE .
  70 .TP
  71 .BR \-\-size =\fISIZE
  72 Create a disk image of the given
  73 .IR SIZE ,
  74 which can be given in bytes,
  75 kilobytes,
  76 gigabytes,
  77 etc,
  78 using the appropriate suffix.
  79 .TP
  80 .BR \-\-mirror =\fIURL
  81 Use the Debian mirror at
  82 .IR URL .
  83 You probably want to specify a local mirror, if you have one.
  84 Defaults to
  85 .IR http://cdn.debian.net/debian/ ,
  86 which should work fairly well for most people without a local mirror.
  87 .TP
  88 .BR \-\-arch =\fIARCH
  89 Use a given architecture.
  90 This only works if the host system can run binaries for the architecture,
  91 e.g., you can build an i386 image on amd64, but not arm.
  92 .TP
  93 .BR \-\-distribution =\fINAME
  94 Use a given release of Debian.
  95 .SH EXAMPLE
  96 To create an image for the stable release of Debian:
  97 .nf
  98 .IP
  99 sudo ./vmdebootstrap --image test.img --size 1g \\
 100     --log test.log --log-level debug --verbose \\
 101     --mirror http://mirror.lan/debian/
 102 .SH "SEE ALSO"
 103 .BR debootstrap (8).