Git-Url: http://git.frugalware.org/gitweb/gitweb.cgi?p=pacman-tools.git;a=commitdiff;h=e39112e27e8ee8e5e23d15746e148dd4186b1da2
commit e39112e27e8ee8e5e23d15746e148dd4186b1da2 Author: VMiklos <[EMAIL PROTECTED]> Date: Mon Oct 1 19:18:06 2007 +0200 mkiso: converted manpage to asciidoc diff --git a/Makefile b/Makefile index 47cdc6f..147efe1 100644 --- a/Makefile +++ b/Makefile @@ -34,7 +34,7 @@ sysconfdir = /etc docdir = /usr/share/doc/pacman-tools-$(VERSION) FINCDIR = $(shell source /usr/lib/frugalware/fwmakepkg; echo $$Fincdir) XML_PATH = /usr/share/sgml/docbook/dtd/xml-dtd-4.2 -DOCS = $(wildcard *.txt) $(wildcard syncpkgd/*.txt) +DOCS = $(wildcard *.txt) $(wildcard syncpkgd/*.txt) $(wildcard mkiso/*.txt) MANS = $(subst .txt,.1,$(DOCS)) PROGRAMS = bumppkg chkdep chkworld emulgen fblint fpmdiff fwcpan fwmirror \ @@ -69,7 +69,6 @@ install: compile $(INSTALL) lib/fwmakepkg $(DESTDIR)$(libdir) $(INSTALL) etcconfig.py $(DESTDIR)$(sbindir)/etcconfig $(INSTALL) mkiso/mkiso $(DESTDIR)$(bindir)/mkiso - $(INSTALL) -m644 mkiso/mkiso.8 $(DESTDIR)$(man8dir) $(INSTALL) -m644 mkiso/volumes.xml $(DESTDIR)$(docdir)/volumes.xml $(INSTALL) -m644 apidocs/*.3 $(DESTDIR)$(man3dir) make -C syncpkgd DESTDIR=$(DESTDIR) install diff --git a/mkiso/mkiso.8 b/mkiso/mkiso.8 deleted file mode 100644 index 5325e1f..0000000 --- a/mkiso/mkiso.8 +++ /dev/null @@ -1,96 +0,0 @@ -.TH "MKISO" "1" "Jun 2006" "Frugalware 0.5" "pacman-tools" -.SH NAME -mkiso \- Frugalware's program to generate ISO9660 images -.SH SYNOPSIS -\fBmkiso\fR [\f -h | --help \fR] [\f -s | --stable \fR] [[\f -f | --file \fR]\f volumes.xml\fR] -.SH DESCRIPTION -.BR mkiso -is meant for anyone who wants to generate (custom) iso images -from the Frugalware Source Tree. -.SH USAGE -A typical iso generation should be done as follows: -.TP -Create a working directory: - -$ mkdir -p ~/iso - -$ cd ~/iso - -.TP -Copy the descriptor xml template to there: - -$ cp /usr/share/doc/pacman-tools-*/volumes.xml ./ - -.TP -Change the fst_root to something like: - -<fst_root>/home/vmiklos/iso</fst_root> - -.TP -In this example we create a netinstall iso, so leave only the following entry: - -.nf -<volume> - <arch>i686</arch> - <media>net</media> -</volume> -.fi - -.TP -Now we need to create a minimal mirror. we can exclude the source (.git/_darcs and source dir) and we can ignore the fpms for the netinstall: - -NOTE: feel free to choose a different rsync mirror from /etc/repoman.conf! - -.nf -$ fwmirror -s rsync://ftp5.frugalware.org/packages/frugalware/pub/frugalware/ \\ - -v current -a i686,source -d . -- -vP --delete --exclude /_darcs/ \\ - --exclude /.git/ --exclude /source/ --exclude '*fpm' -.fi - -.TP -Ok, we have the necessary files, let's make the iso! - -$ mkiso - -.SH THE XML FILE - -In the xml file primarily you should define the required volumes. The media -type of the volume is required at least. The media can be "net", "cd", or "dvd". The -"net" will not contain any fpm packages. The only difference between "cd" and "dvd" -is the default size. You can define the arch, which defaults to the machine -hardware name. For a cd or dvd a serial tag is required, 1 or the 1st cd and -so on. You can define a custom cd/dvd size with the size tag. - -After defining the volumes, you must supply the root of the Frugalware -Source Tree with the fst_root tag. Other optional tags include out_dir -[defaults to fst_root], version [timestamp] and codename [-current]. - -.SH HACKING - -Probably the most changing part is the initrd and the kernel. You can generate -them from the 'setup' repo. - -.SH OPTIONS -.TP -.B -h|--help -Show the help screen. -.TP -.B -c|--count -Do not generate the isos, just print out the number of required isos for the -given size. -.TP -.B -s|--stable -Assume that the given repo is a -stable one, so that there will be a -frugalware.fdb under the frugalware-<arch> directory, not a -frugalware-current.fdb. -.TP -.B -f|--file <volumes.xml> -By default, mkiso searches for the file named "volumes.xml". If you want a -different one, then just specify it. -.SH AUTHORS -Written by Miklos Vajna. -.SH "REPORTING BUGS" -Please report bugs to http://bugs.frugalware.org/. -.SH "SEE ALSO" -.BR setup (1), -.BR pacman (8) diff --git a/mkiso/mkiso.txt b/mkiso/mkiso.txt new file mode 100644 index 0000000..e9ac701 --- /dev/null +++ b/mkiso/mkiso.txt @@ -0,0 +1,106 @@ += mkiso(1) + +== NAME + +mkiso - Frugalware's program to generate ISO9660 images + +== SYNOPSIS + +mkiso [options] + +== DESCRIPTION + +'mkiso' is meant for anyone who wants to generate (custom) iso images from the +Frugalware Source Tree. + +== USAGE + +A typical iso generation should be done as follows: + +Create a working directory: + +---- +$ mkdir -p ~/iso +$ cd ~/iso +---- + +Copy the descriptor xml template to there: + +---- +$ cp /usr/share/doc/pacman-tools-*/volumes.xml ./ +---- + +Change the fst_root to something like: + +---- +<fst_root>/home/john/iso</fst_root> +---- + +In this example we create a netinstall iso, so leave only the following entry: + +---- +<volume> + <arch>i686</arch> + <media>net</media> +</volume> +---- + +Now we need to create a minimal mirror. we can exclude the source (.git/_darcs +and source dir) and we can ignore the fpms for the netinstall: + +---- +$ fwmirror -s rsync://ftp5.frugalware.org/packages/frugalware/pub/frugalware/ \ + -v current -a i686,source -d . -- -vP --delete --exclude /_darcs/ \ + --exclude /.git/ --exclude /source/ --exclude '*fpm' +---- + +NOTE: feel free to choose a different rsync mirror from `/etc/repoman.conf`! + +Ok, we have the necessary files, let's make the iso! + +---- +$ mkiso +---- + +== THE XML FILE + +In the xml file primarily you should define the required volumes. The media +type of the volume is required at least. The media can be "net", "cd", or +"dvd". The "net" will not contain any fpm packages. The only difference between +"cd" and "dvd" is the default size. You can define the arch, which defaults to +the machine hardware name. For a cd or dvd a serial tag is required, 1 or the +1st cd and so on. You can define a custom cd/dvd size with the size tag. + +After defining the volumes, you must supply the root of the Frugalware Source +Tree with the fst_root tag. Other optional tags include out_dir [defaults to +fst_root], version [timestamp] and codename [-current]. + +== HACKING + +Probably the most changing part is the initrd and the kernel. You can generate them from the 'setup' repo. + +== OPTIONS + +-h, --help:: + Show the help screen. + +-c, --count:: + Do not generate the isos, just print out the number of required isos + for the given size. + +-s, --stable:: + Assume that the given repo is a -stable one, so that there will be a + 'frugalware.fdb' under the 'frugalware-<arch>' directory, not a + 'frugalware-current.fdb'. + +-f, --file <volumes.xml>:: + By default, 'mkiso' searches for the file named 'volumes.xml'. If you + want a different one, then just specify it. + +== REPORTING BUGS + +Please report bugs to http://bugs.frugalware.org/. + +== SEE ALSO + +*setup*(1), *pacman-g2*(8) _______________________________________________ Frugalware-git mailing list [email protected] http://frugalware.org/mailman/listinfo/frugalware-git
