Makefile | 11 ++++- docs/livecd-creator.pod | 90 ++++++++++++++++++++++++++++++++++++++++++++ docs/livecd-iso-to-disk.pod | 49 +++++++++++++++++++++++ livecd-tools.spec | 2 4 files changed, 150 insertions(+), 2 deletions(-)
New commits: commit 8e52f40908797a5508c38558e26bc52780d4d117 Author: Jeremy Katz katzj@redhat.com Date: Mon Jun 9 11:51:57 2008 -0400
Add man pages contributed by Pedro Silva <pedrofsilva AT netcabo DOT pt>
Add man pages for livecd-creator and livecd-iso-to-disk as contributed by Pedro Silva and then add the necessary build gunk so that they should get built and installed
diff --git a/Makefile b/Makefile index 4ac33b5..a8d8659 100644 --- a/Makefile +++ b/Makefile @@ -15,7 +15,12 @@ PYTHONDIR := $(shell python -c "import distutils.sysconfig as d; print d.get_pyt
all:
-install: +man: + pod2man --section=8 --release="livecd-tools $(VERSION)" --center "LiveCD Tools" docs/livecd-creator.pod > docs/livecd-creator.8 + pod2man --section=8 --release="livecd-tools $(VERSION)" --center "LiveCD Tools" docs/livecd-iso-to-disk.pod > docs/livecd-iso-to-disk.8 + + +install: man $(INSTALL_PROGRAM) -D tools/livecd-creator $(DESTDIR)/usr/bin/livecd-creator $(INSTALL_PROGRAM) -D tools/image-creator $(DESTDIR)/usr/bin/image-creator $(INSTALL_PROGRAM) -D tools/livecd-iso-to-disk.sh $(DESTDIR)/usr/bin/livecd-iso-to-disk @@ -29,6 +34,8 @@ install: mkdir -p $(DESTDIR)/$(PYTHONDIR)/imgcreate $(INSTALL_PYTHON) -D imgcreate/*.py $(DESTDIR)/$(PYTHONDIR)/imgcreate/ $(call COMPILE_PYTHON,$(DESTDIR)/$(PYTHONDIR)/imgcreate) + mkdir -p $(DESTDIR)/usr/share/man/man8 + $(INSTALL_DATA) -D docs/*.8 $(DESTDIR)/usr/share/man/man8
uninstall: rm -f $(DESTDIR)/usr/bin/livecd-creator @@ -40,4 +47,4 @@ dist : all git-archive --format=tar --prefix=livecd-tools-$(VERSION)/ HEAD | bzip2 -9v > livecd-tools-$(VERSION).tar.bz2
clean: - rm -f *~ creator/*~ installer/*~ config/*~ + rm -f *~ creator/*~ installer/*~ config/*~ docs/*.8 diff --git a/docs/livecd-creator.pod b/docs/livecd-creator.pod new file mode 100644 index 0000000..dcaddc7 --- /dev/null +++ b/docs/livecd-creator.pod @@ -0,0 +1,90 @@ +=pod + +=head1 NAME + +livecd-creator, creates live cd or dvd images. + +=head1 SYNOPSIS + +B<livecd-creator> [OPTIONS] + +=head1 DESCRIPTION + +B<livecd-creator> creates live cd or dvd images from kickstart files. Kickstart files contain the information about packages and configurations that are built into the image. + +=head1 OPTIONS + +=over 4 + +=item -h, --help + +Shows a help message and exits. + +=back + +=head1 IMAGE OPTIONS + +These options define the created image. + +=over 4 + +=item -c KSCFG, --config=KSCFG + +Path to kickstart config file + +=item -b BASE_ON, --base-on=BASE_ON + +Add packages to an existing live CD iso9660 image. + +=item -f FS_LABEL, --fslabel=FS_LABEL + +File system label (default based on config name) + +=back + +=head1 SYSTEM DIRECTORY OPTIONS + +These options define directories used on your system for creating the live image + +=over 4 + +=item -t TMPDIR, --tmpdir=TMPDIR + +Temporary directory to use (default: /var/tmp) + +=item --cache=CACHEDIR + +Cache directory to use (default: private cache) + +=back + +=head1 EXAMPLES + +Barebones LiveCD + +livecd-creator \ +--config=/usr/share/livecd-tools/livecd-fedora-minimal.ks + +Fedora Desktop Live CD + +livecd-creator \ +--config=/usr/share/livecd-tools/livecd-fedora-desktop.ks \ +--fslabel=Fedora9-LiveCD-foo + +=head1 CONTRIBUTORS + +David Zeuthen, Jeremy Katz, Douglas McClendon and a team of many other contributors. See the AUTHORS file in the source distribution for the complete list of credits. + +=head1 BUGS + +Report bugs to the mailing list Chttp://www.redhat.com/mailman/listinfo/fedora-livecd-list or directly to BugZilla Chttp://bugzilla.redhat.com/bugzilla/ against the C<Fedora> product, and the C<livecd-tools> component. + +=head1 COPYRIGHT + +Copyright (C) Fedora Project 2008, and various contributors. This is free software. You may redistribute copies of it under the terms of the GNU General Public License Chttp://www.gnu.org/licenses/gpl.html. There is NO WARRANTY, to the extent permitted by law. + +=head1 SEE ALSO + +C<livecd-iso-to-disk(1)>, project website Chttp://fedoraproject.org/wiki/FedoraLiveCD + +=cut \ No newline at end of file diff --git a/docs/livecd-iso-to-disk.pod b/docs/livecd-iso-to-disk.pod new file mode 100644 index 0000000..ffe9add --- /dev/null +++ b/docs/livecd-iso-to-disk.pod @@ -0,0 +1,49 @@ +=pod + +=head1 NAME + +livecd-iso-to-disk, install livecd-creator images in usb stick + +=head1 SYNOPSIS + +B<livecd-iso-to-disk> [--reset-mbr] [--noverify] [--overlay-size-mb <size>] <isopath> <usbstick device> + +=head1 DESCRIPTION + +B<livecd-iso-to-disk> converts a live cd or dvd image into a bootable USB stick. This is not a destructive process; any data you currently have on your USB stick will be preserved. + +=head1 OPTIONS + +=over 4 + +=item --reset-mbr + +Resets Master Boot Record of usb stick by copying syslinux's mbr.bin. + +=item --noverify + +Disables image validation before installing it. + +=item --overlay-size-mb + +Overlay's size in megabytes. Note that you'll need to have space on your USB stick for the live image plus your overlay plus any other data you want on the stick. + +=back + +=head1 CONTRIBUTORS + +David Zeuthen, Jeremy Katz, Douglas McClendon and a team of many other contributors. See the AUTHORS file in the source distribution for the complete list of credits. + +=head1 BUGS + +Report bugs to the mailing list Chttp://www.redhat.com/mailman/listinfo/fedora-livecd-list or directly to BugZilla Chttp://bugzilla.redhat.com/bugzilla/ against the C<Fedora> product, and the C<lived-tools> component. + +=head1 COPYRIGHT + +Copyright (C) Fedora Project 2008, and various contributors. This is free software. You may redistribute copies of it under the terms of the GNU General Public License Chttp://www.gnu.org/licenses/gpl.html. There is NO WARRANTY, to the extent permitted by law. + +=head1 SEE ALSO + +C<livecd-creator(1)>, project website Chttp://fedoraproject.org/wiki/FedoraLiveCD + +=cut diff --git a/livecd-tools.spec b/livecd-tools.spec index f6a5ef1..ce4fea8 100644 --- a/livecd-tools.spec +++ b/livecd-tools.spec @@ -27,6 +27,7 @@ Requires: syslinux Requires: yaboot %endif BuildRequires: python +BuildRequires: /usr/bin/pod2man
%description @@ -50,6 +51,7 @@ rm -rf $RPM_BUILD_ROOT %files %defattr(-,root,root,-) %doc AUTHORS COPYING README HACKING +%{_mandir}/man*/* %{_bindir}/livecd-creator %{_bindir}/livecd-iso-to-disk %{_bindir}/livecd-iso-to-pxeboot
livecd@lists.fedoraproject.org