From: Lars Wirzenius Date: Tue, 20 Dec 2011 12:28:21 +0000 (+0000) Subject: adapt manpage into a template for cliapp --genereate-manpage X-Git-Url: https://git.siccegge.de//index.cgi?p=forks%2Fvmdebootstrap.git;a=commitdiff_plain;h=d4538dd8232752804485f0b75558f0f07b74ce19 adapt manpage into a template for cliapp --genereate-manpage --- diff --git a/vmdebootstrap.8 b/vmdebootstrap.8 deleted file mode 100644 index 834e4b2..0000000 --- a/vmdebootstrap.8 +++ /dev/null @@ -1,152 +0,0 @@ -.\" Copyright 2011 Lars Wirzenius -.\" -.\" This program is free software: you can redistribute it and/or modify -.\" it under the terms of the GNU General Public License as published by -.\" the Free Software Foundation, either version 3 of the License, or -.\" (at your option) any later version. -.\" -.\" This program is distributed in the hope that it will be useful, -.\" but WITHOUT ANY WARRANTY; without even the implied warranty of -.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -.\" GNU General Public License for more details. -.\" -.\" You should have received a copy of the GNU General Public License -.\" along with this program. If not, see . -.\" -.TH VMDEBOOTSTRAP 8 -.SH NAME -vmdebootstrap \- install basic Debian system into virtual disk image -.SH SYNOPSIS -.B vmdebootstrap -.BR \-\-image =\fIFILE -.RB [ options ] -.SH DESCRIPTION -.B vmdebootstrap -installs a basic Debian system into a virtual disk image, -for use with virtual machines, -such as KVM, Qemu, or VirtualBox. -It is like -.BR debootstrap (8), -which does the same thing, but puts the system into a directory, -for use with -.BR chroot (8). -(In fact, -.B vmdebootstrap -is a wrapper around -.BR debootstrap ). -.PP -You need to run -.B vmdebootstrap -as root. -.PP -To use the image, -you probably want to create a virtual machine using your preferred -virtualization technology, such as -.BR kvm (1), -or -.BR qemu (1). -Configure the virtual machine to use the image you've created. -Then start the virtual machine, -and log into it via its console to configure it. -.PP -The image will be using -.BR extlinux (1) -as a boot loader. -It has an empty root password. -The image will not have networking configured. -Set the root password before you configure networking. -.SH OPTIONS -.TP -.BR \-\-help -Show full list of options (this manual page may be incomplete). -.TP -.BR \-\-verbose -Report what is going on. -.TP -.BR \-\-log =\fIFILE -Write log to -.IR FILE . -.TP -.BR \-\-log\-level =\fILEVEL -Write log messages of the given -.I LEVEL -or higher. -Level is one of -.IR debug , -.IR info , -.IR warning , -.IR error , -.IR critical , -.IR fatal , -and defaults to -.IR info . -.TP -.BR \-\-image =\fIFILE -Put created disk image in -.IR FILE . -.TP -.BR \-\-size =\fISIZE -Create a disk image of the given -.IR SIZE , -which can be given in bytes, -kilobytes, -gigabytes, -etc, -using the appropriate suffix. -.TP -.BR \-\-mirror =\fIURL -Use the Debian mirror at -.IR URL . -You probably want to specify a local mirror, if you have one. -Defaults to -.IR http://cdn.debian.net/debian/ , -which should work fairly well for most people without a local mirror. -.TP -.BR \-\-arch =\fIARCH -Use a given architecture. -This only works if the host system can run binaries for the architecture, -e.g., you can build an i386 image on amd64, but not arm. -.TP -.BR \-\-distribution =\fINAME -Use a given release of Debian. -.TP -.BR \-\-package =\fIPACKAGE -Install -.I PACKAGE -on the system. -Can be given multiple times. -.TP -.BR \-\-enable-dhcp -Create an -.I /etc/network/interfaces -file that sets up DHCP on the eth0 interface. -This means the system booted from the image will bring up networking -automatically in typical environments. -Without DHCP, only localhost networking is set up. -.TP -.BR \-\-root\-password =\fIPASSWORD -Set password for root. -The default is to disable root's password. -.TP -.BR \-\-customize =\fISCRIPT -Run -.I SCRIPT -(typically, but not necessarily, a shell script) -after setting up the new system image. -The script will get a single parameters: -the path to the root directory of the newly installed system. -.TP -.BR \-\-hostname =\fINAME -Set system hostname to -.IR NAME . -The default is -.IR debian . -.SH EXAMPLE -To create an image for the stable release of Debian: -.nf -.IP -sudo ./vmdebootstrap --image test.img --size 1g \\ - --log test.log --log-level debug --verbose \\ - --mirror http://mirror.lan/debian/ -.SH "SEE ALSO" -.BR debootstrap (8). diff --git a/vmdebootstrap.8.in b/vmdebootstrap.8.in new file mode 100644 index 0000000..8eceba1 --- /dev/null +++ b/vmdebootstrap.8.in @@ -0,0 +1,64 @@ +.\" Copyright 2011 Lars Wirzenius +.\" +.\" This program is free software: you can redistribute it and/or modify +.\" it under the terms of the GNU General Public License as published by +.\" the Free Software Foundation, either version 3 of the License, or +.\" (at your option) any later version. +.\" +.\" This program is distributed in the hope that it will be useful, +.\" but WITHOUT ANY WARRANTY; without even the implied warranty of +.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +.\" GNU General Public License for more details. +.\" +.\" You should have received a copy of the GNU General Public License +.\" along with this program. If not, see . +.\" +.TH VMDEBOOTSTRAP 8 +.SH NAME +vmdebootstrap \- install basic Debian system into virtual disk image +.SH SYNOPSIS +.SH DESCRIPTION +.B vmdebootstrap +installs a basic Debian system into a virtual disk image, +for use with virtual machines, +such as KVM, Qemu, or VirtualBox. +It is like +.BR debootstrap (8), +which does the same thing, but puts the system into a directory, +for use with +.BR chroot (8). +(In fact, +.B vmdebootstrap +is a wrapper around +.BR debootstrap ). +.PP +You need to run +.B vmdebootstrap +as root. +.PP +To use the image, +you probably want to create a virtual machine using your preferred +virtualization technology, such as +.BR kvm (1), +or +.BR qemu (1). +Configure the virtual machine to use the image you've created. +Then start the virtual machine, +and log into it via its console to configure it. +.PP +The image will be using +.BR extlinux (1) +as a boot loader. +It has an empty root password. +The image will not have networking configured. +Set the root password before you configure networking. +.SH OPTIONS +.SH EXAMPLE +To create an image for the stable release of Debian: +.nf +.IP +sudo ./vmdebootstrap --image test.img --size 1g \\ + --log test.log --log-level debug --verbose \\ + --mirror http://mirror.lan/debian/ +.SH "SEE ALSO" +.BR debootstrap (8).