Add manpage for livemedia-creator
This commit is contained in:
parent
31dd8048ab
commit
ff23dcb162
2
Makefile
2
Makefile
@ -17,6 +17,8 @@ all: src/pylorax/version.py
|
||||
|
||||
install: all
|
||||
$(PYTHON) setup.py install --root=$(DESTDIR)
|
||||
mkdir -p $(DESTDIR)/$(mandir)/man1
|
||||
install -m 644 docs/livemedia-creator.1 $(DESTDIR)/$(mandir)/man1
|
||||
|
||||
clean:
|
||||
-rm -rf build src/pylorax/version.py
|
||||
|
196
docs/livemedia-creator.1
Normal file
196
docs/livemedia-creator.1
Normal file
@ -0,0 +1,196 @@
|
||||
.TH LIVEMEDIA-CREATOR 1 2013\-07\-26
|
||||
.SH NAME
|
||||
livemedia-creator \- Create live install media
|
||||
|
||||
.SH SYNOPSIS
|
||||
livemedia-creator [-h]
|
||||
(--make-iso | --make-disk | --make-fsimage | --make-appliance | --make-ami)
|
||||
[--iso ISO] [--disk-image DISK_IMAGE]
|
||||
[--fs-image FS_IMAGE] [--ks KS]
|
||||
[--image-name IMAGE_NAME] [--image-only]
|
||||
[--keep-image] [--no-virt] [--proxy PROXY]
|
||||
[--anaconda-arg ANACONDA_ARGS]
|
||||
[--armplatform ARMPLATFORM] [--location LOCATION]
|
||||
[--logfile LOGFILE]
|
||||
[--lorax-templates LORAX_TEMPLATES] [--tmp TMP]
|
||||
[--resultdir RESULT_DIR] [--app-name APP_NAME]
|
||||
[--app-template APP_TEMPLATE] [--app-file APP_FILE]
|
||||
[--ram MEMORY] [--vcpus VCPUS] [--vnc VNC]
|
||||
[--arch ARCH] [--kernel-args KERNEL_ARGS]
|
||||
[--dracut-arg DRACUT_ARGS] [--title TITLE]
|
||||
[--project PROJECT] [--releasever RELEASEVER]
|
||||
[--volid VOLID] [--squashfs_args SQUASHFS_ARGS]
|
||||
|
||||
.SH DESCRIPTION
|
||||
livemedia-creator uses Anaconda, kickstart and Lorax to create bootable media
|
||||
that use the same install path as a normal system install. It can be used to
|
||||
make live isos, bootable (partitioned) disk images and filesystem images for
|
||||
use with virtualization.
|
||||
|
||||
The general idea is to use virt-install to install into a disk image and then
|
||||
use the disk image to create the bootable media.
|
||||
|
||||
livemedia-creator --help will describe all of the options available. At the
|
||||
minimum you need:
|
||||
|
||||
--make-iso to create a final bootable .iso
|
||||
--iso to specify the Anaconda install media to use with virt-install
|
||||
--ks is the kickstart to use to install the system
|
||||
|
||||
|
||||
.SH OPTIONAL ARGUMENTS:
|
||||
.TP
|
||||
\fB\-h, \-\-help\fR
|
||||
show this help message and exit
|
||||
|
||||
.TP
|
||||
\fB\-\-make\-iso\fR
|
||||
Build a live iso
|
||||
|
||||
.TP
|
||||
\fB\-\-make\-disk\fR
|
||||
Build a partitioned disk image
|
||||
|
||||
.TP
|
||||
\fB\-\-make\-fsimage\fR
|
||||
Build a filesystem image
|
||||
|
||||
.TP
|
||||
\fB\-\-make\-appliance\fR
|
||||
Build an appliance image and XML description
|
||||
|
||||
.TP
|
||||
\fB\-\-make\-ami\fR
|
||||
Build an ami image
|
||||
|
||||
.TP
|
||||
\fB\-\-iso ISO\fR
|
||||
Anaconda installation .iso path to use for virt-install
|
||||
|
||||
.TP
|
||||
\fB\-\-disk\-image DISK_IMAGE\fR
|
||||
Path to disk image to use for creating final image
|
||||
|
||||
.TP
|
||||
\fB\-\-fs\-image FS_IMAGE\fR
|
||||
Path to filesystem image to use for creating final image
|
||||
|
||||
.TP
|
||||
\fB\-\-ks KS\fR
|
||||
Kickstart file defining the install.
|
||||
|
||||
.TP
|
||||
\fB\-\-image\-name IMAGE_NAME\fR
|
||||
Name of fs/disk image to create. Default is a random name.
|
||||
|
||||
.TP
|
||||
\fB\-\-image\-only\fR
|
||||
Exit after creating fs/disk image.
|
||||
|
||||
.TP
|
||||
\fB\-\-keep\-image\fR
|
||||
Keep raw disk image after .iso creation
|
||||
|
||||
.TP
|
||||
\fB\-\-no\-virt\fR
|
||||
Use Anaconda's image install instead of virt-install
|
||||
|
||||
.TP
|
||||
\fB\-\-proxy PROXY\fR
|
||||
proxy URL to use for the install
|
||||
|
||||
.TP
|
||||
\fB\-\-anaconda\-arg ANACONDA_ARGS\fR
|
||||
Additional argument to pass to anaconda (no-virt mode). Pass once for eachargument
|
||||
|
||||
.TP
|
||||
\fB\-\-armplatform ARMPLATFORM\fR
|
||||
the platform to use when creating images for ARM, i.e., highbank, mvebu, omap,tegra, etc.
|
||||
|
||||
.TP
|
||||
\fB\-\-location LOCATION\fR
|
||||
location of iso directory tree with initrd.img and vmlinuz. Used to run virt-install with a newer initrd than the iso.
|
||||
|
||||
.TP
|
||||
\fB\-\-logfile LOGFILE\fR
|
||||
Path to logfile
|
||||
|
||||
.TP
|
||||
\fB\-\-lorax\-templates LORAX_TEMPLATES\fR
|
||||
Path to mako templates for lorax
|
||||
|
||||
.TP
|
||||
\fB\-\-tmp TMP\fR
|
||||
Top level temporary directory
|
||||
|
||||
.TP
|
||||
\fB\-\-resultdir RESULT_DIR\fR
|
||||
Directory to copy the resulting images and iso into. Defaults to the temporaryworking directory
|
||||
|
||||
.TP
|
||||
\fB\-\-title TITLE\fR
|
||||
Substituted for @TITLE@ in bootloader config files
|
||||
|
||||
.TP
|
||||
\fB\-\-project PROJECT\fR
|
||||
substituted for @PROJECT@ in bootloader config files
|
||||
|
||||
.TP
|
||||
\fB\-\-releasever RELEASEVER\fR
|
||||
substituted for @VERSION@ in bootloader config files
|
||||
|
||||
.TP
|
||||
\fB\-\-volid VOLID\fR
|
||||
volume id
|
||||
|
||||
.TP
|
||||
\fB\-\-squashfs_args SQUASHFS_ARGS\fR
|
||||
additional squashfs args
|
||||
|
||||
.SH APPLIANCE ARGUMENTS:
|
||||
.TP
|
||||
\fB\-\-app\-name APP_NAME\fR
|
||||
Name of appliance to pass to template
|
||||
|
||||
.TP
|
||||
\fB\-\-app\-template APP_TEMPLATE\fR
|
||||
Path to template to use for appliance data.
|
||||
|
||||
.TP
|
||||
\fB\-\-app\-file APP_FILE\fR
|
||||
Appliance template results file.
|
||||
|
||||
.SH VIRT\-INSTALL ARGUMENTS:
|
||||
.TP
|
||||
\fB\-\-ram MEMORY\fR
|
||||
Memory to allocate for installer in megabytes.
|
||||
|
||||
.TP
|
||||
\fB\-\-vcpus VCPUS\fR
|
||||
Passed to --vcpus command
|
||||
|
||||
.TP
|
||||
\fB\-\-vnc VNC\fR
|
||||
Passed to --graphics command
|
||||
|
||||
.TP
|
||||
\fB\-\-arch ARCH\fR
|
||||
Passed to --arch command
|
||||
|
||||
.TP
|
||||
\fB\-\-kernel\-args KERNEL_ARGS\fR
|
||||
Additional argument to pass to the installation kernel
|
||||
|
||||
.SH DRACUT ARGUMENTS:
|
||||
.TP
|
||||
\fB\-\-dracut\-arg DRACUT_ARGS\fR
|
||||
Argument to pass to dracut when rebuilding the initramfs. Pass this once foreach argument. NOTE: this overrides the default.
|
||||
|
||||
.SH "SEE ALSO"
|
||||
Documentation in /usr/share/docs/lorax/README.livemedia-creator
|
||||
|
||||
.SH AUTHOR
|
||||
.nf
|
||||
Brian C. Lane
|
||||
.fi
|
||||
|
@ -67,7 +67,7 @@ Anaconda's image install feature.
|
||||
|
||||
%install
|
||||
rm -rf $RPM_BUILD_ROOT
|
||||
make DESTDIR=$RPM_BUILD_ROOT install
|
||||
make DESTDIR=$RPM_BUILD_ROOT mandir=%{_mandir} install
|
||||
|
||||
%files
|
||||
%defattr(-,root,root,-)
|
||||
@ -81,7 +81,7 @@ make DESTDIR=$RPM_BUILD_ROOT install
|
||||
%config(noreplace) %{_sysconfdir}/lorax/lorax.conf
|
||||
%dir %{_datadir}/lorax
|
||||
%{_datadir}/lorax/*
|
||||
|
||||
%{_mandir}/man1/*.1*
|
||||
|
||||
%changelog
|
||||
* Thu Jun 13 2013 Brian C. Lane <bcl@redhat.com> 19.5-1
|
||||
|
Loading…
Reference in New Issue
Block a user