rootstock.1

.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.38.2.
.TH ROOTSTOCK "1" "January 2011" "rootstock 0.1.99.4" "User Commands"
.SH NAME
rootstock \- manual page for rootstock 0.1.99.4
.SH SYNOPSIS
.B rootstock
\fI-f <hostname> \fR[\fIOPTION\fR]...
.SH DESCRIPTION
Generates Ubuntu armel rootfs tarballs and/or qemu image, to be
uncompressed onto a root device.
.PP
Note that it does not set up a kernel, modules or bootloader for you.
Kernel and bootloader need to be set up in a device specific manner,
modules should be copied to the filesystem after it was uncompressed
on the target device.
.PP
It also uses a virtual machine and can take long to build your
filesystem, please be patient and make sure to have enough CPU power
on the host machine.
.SH OPTIONS

Required:
.PP
\fB\-f\fR \fB\-\-fqdn\fR <hostname>
.IP
Hostname to be used for the target system
.PP
Additional:
.PP
\fB\-l\fR \fB\-\-login\fR <login name>
.IP
Login ID of the admin user created during setup
.PP
\fB\-p\fR \fB\-\-password\fR <password>
.IP
Password of the admin user created during setup
.PP
\fB\-h\fR \fB\-\-help\fR
.IP
Display this help
.PP
\fB\-n\fR \fB\-\-fullname\fR <quoted string>
.IP
Full Name of the admin user created during setup
(default: "Ubuntu System User")
.PP
\fB\-s\fR \fB\-\-seed\fR <csv list>
.IP
List of packages to install (i.e. ubuntu\-desktop)
.PP
\fB\-i\fR \fB\-\-imagesize\fR <size>M/G
.IP
Size of the target filesystem to be created (i.e. 500M)
(default: 1G)
.PP
\fB\-g\fR \fB\-\-manifest\fR <path to file>
.IP
Manifest file with list of packages to install (one per line)
.PP
\fB\-m\fR \fB\-\-mirror\fR <url>
.IP
apt mirror to use (i.e. http://ports.ubuntu.com/ubuntu\-ports)
(default: http://ports.ubuntu.com/ubuntu\-ports)
.PP
\fB\-c\fR \fB\-\-components\fR <csv list>
.IP
Archive components
(default: main,universe)
.PP
\fB\-d\fR \fB\-\-dist\fR (jaunty, karmic, lucid or maverick)
.IP
Specify Release to build
(default: maverick)
.PP
\fB\-t\fR \fB\-\-timezone\fR <timezone>
.IP
Timezone for the system (i.e. Europe/Berlin)
(default: buildsystem timezone)
.PP
\fB\-x\fR \fB\-\-locale\fR <locale.encoding>
.IP
Language used in the installed system (i.e. en_US.UTF\-8)
(default: buildsystem locale)
.PP
\fB\-\-script\fR <filename>
.IP
Run this script at the end of the installation process
.PP
\fB\-\-serial\fR <devicename>
.IP
Create a serial tty of <devicename> inside the rootfs for login (i.e. ttyS0)
.PP
\fB\-\-doswap\fR
.IP
Do create a swapfile in tmpfs for the virtual machine
.PP
\fB\-\-swapsize\fR <size in megabyte>
.IP
Use a different size for the swapfile used by the virtual machine
(default: 256M)
.PP
\fB\-\-version\fR
.IP
Print version number
.PP
Keyboard:
.PP
\fB\-\-kblayout\fR <layout>
.IP
Keyboard layout (i.e. us)
(default: buildsystem kblayout)
.PP
\fB\-\-kbmodel\fR <model>
.IP
Keyboard model (i.e. pc105)
(default: buildsystem kbmodel)
.PP
\fB\-\-kbvariant\fR <variant>
.IP
Keyboard variant (i.e. nodeadkeys)
(default: buildsystem kbvariant)
.PP
\fB\-\-kboptions\fR <options>
.IP
Additional keyboard options
(default: buildsystem kboptions)
.PP
Output:
.PP
\fB\-\-keepimage\fR
.IP
Keep the qemu image instead of deleting it (disabled for native)
.PP
\fB\-\-notarball\fR
.IP
Do not roll a tarball of the rootfs (autosets \fB\-\-keepimage\fR)
.PP
Extra parameters:
.PP
\fB\-q\fR \fB\-\-quiet\fR
.IP
Quiet operation, only write to log
.PP
Advanced:
.PP
\fB\-\-kernel\-image\fR <http url to kernel .deb>
.IP
install board specfic kernel package from http accessible deb package inside rootfs
.PP
\fB\-\-copy\-package\-cache\fR
.IP
save a snapshot of all packages used for a build locally to re\-use them
in a subsequent offline build with the \fB\-\-restore\-package\-cache\fR option
.PP
\fB\-\-restore\-package\-cache\fR
.IP
use precached packages from a former build run with \fB\-\-copy\-package\-cache\fR
.PP
\fB\-\-clean\-package\-cache\fR
.IP
empty the package cache of a former \fB\-\-copy\-package\-cache\fR run
.PP
\fB\-\-extra\-mirror\fR
.IP
additional mirror to use
.PP
\fB\-\-no\-root\fR
.IP
run rootstock without requiring root access (slower as uses a full vm)
.PP
\fB\-\-sources\fR <filename>
.IP
Use <filename> as target apt sources.list file
.PP
\fB\-\-apt\-upgrade\fR
.IP
run apt\-upgrade after bootstrapping. Useful if multple apt sources are provided
with \fB\-\-sources\fR or \fB\-\-extra\-mirror\fR
.SH EXAMPLES

Xubuntu\-Desktop (as root): rootstock \fB\-f\fR host \fB\-l\fR user \fB\-p\fR temppwd \fB\-i\fR 2G \fB\-s\fR xubuntu\-desktop
.PP
Minimal Ubuntu (as user): rootstock \fB\-f\fR host \fB\-l\fR user \fB\-p\fR temppwd \fB\-i\fR 512M \fB\-\-no\-root\fR \fB\-s\fR ubuntu\-minimal
.SH AUTHOR
Written by Oliver Grawert <ogra@canonical.com> and Ricardo Salveti <ricardo.salveti@canonical.com>.
.SH "REPORTING BUGS"
Report bugs at https://launchpad.net/project\-rootstock/+filebug
.PP
.br
For Known Issues, please read https://wiki.ubuntu.com/ARM/RootStock/KnownIssues.
.SH COPYRIGHT
Copyright \(co 2009, 2010 Canonical
License: GNU GPL version 2 or later <http://gnu.org/licenses/gpl.html>.
.PP
.br
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.
.SH "SEE ALSO"
The full documentation for
.B rootstock
is maintained as a Texinfo manual.  If the
.B info
and
.B rootstock
programs are properly installed at your site, the command
.IP
.B info rootstock
.PP
should give you access to the complete manual.