From: <bms...@us...> - 2007-04-12 22:03:47
|
Revision: 2487 http://svn.sourceforge.net/morphix/?rev=2487&view=rev Author: bmsleight Date: 2007-04-12 15:03:44 -0700 (Thu, 12 Apr 2007) Log Message: ----------- Updating Man pages Modified Paths: -------------- trunk/mmaker/debian/isomaker.1 trunk/mmaker/debian/make-mini.1 trunk/mmaker/debian/mmaker.1 Modified: trunk/mmaker/debian/isomaker.1 =================================================================== --- trunk/mmaker/debian/isomaker.1 2007-04-12 22:02:55 UTC (rev 2486) +++ trunk/mmaker/debian/isomaker.1 2007-04-12 22:03:44 UTC (rev 2487) @@ -1,131 +1,115 @@ -.\"Generated by db2man.xsl. Don't modify this, modify the source. -.de Sh \" Subsection -.br -.if t .Sp -.ne 5 -.PP -\fB\\$1\fR -.PP -.. -.de Sp \" Vertical space (when we can't use .PP) -.if t .sp .5v -.if n .sp -.. -.de Ip \" List item -.br -.ie \\n(.$>=3 .ne \\$3 -.el .ne 3 -.IP "\\$1" \\$2 -.. -.TH "ISOMAKER" 1 "" "" "" -.SH NAME +.\" Title: isomaker +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.72.0 <http://docbook.sf.net/> +.\" Date: 04/12/2007 +.\" Manual: +.\" Source: +.\" +.TH "ISOMAKER" "1" "04/12/2007" "" "" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" isomaker \- Creates a morphix base or morphix main module, using template files .SH "SYNOPSIS" - - -\fIisomaker\fR \-b basemod\&.xml [\-c] [\-m mainmod\&.xml] [\-m mainmod2\&.xml] [[\-r repository [\-p package1] [\-p package2]] [\-t tarball] output\&.iso - +\fIisomaker\fR \-b basemod.xml [\-c] [\-m mainmod.xml] [\-m mainmod2.xml] [[\-r repository [\-p package1] [\-p package2]] [\-t tarball] output.iso +.sp .SH "DESCRIPTION" - - This tool uses mmaker to generate a Morphix iso from scratch, using one basemodule template, and arbitrary number of mainmodule templates and optionally extra dpkg\-deb\-extracted deb/udeb packages - +.sp .SH "OPTIONS" - -.TP -\fI\-b basemod\&.xml\fR -Base module template used to build output\&.iso - -.TP +.PP +\fI\-b basemod.xml\fR +.RS 4 +Base module template used to build output.iso +.RE +.PP \fI\-c\fR -Clean temporary directories\&. - -.TP -\fI\-m mainmod\&.xml\fR -Main module template to include in output\&.iso - -.TP +.RS 4 +Clean temporary directories. +.RE +.PP +\fI\-m mainmod.xml\fR +.RS 4 +Main module template to include in output.iso +.RE +.PP \fI\-r repository\fR +.RS 4 Specify repository for deb/udeb packages to include on iso - -.RS - -.TP +.PP \-p package1 +.RS 4 Packages to be included on iso - .RE -.IP - -.TP +.RE +.PP \fI\-t tarball\fR -tarball to be included on iso\&. - -.TP -\fI\-g tarball\&.tar\&.gz\fR -Use a local debian bootstrap, rather than download from repository\&. - +.RS 4 +tarball to be included on iso. +.RE +.PP +\fI\-g tarball.tar.gz\fR +.RS 4 +Use a local debian bootstrap, rather than download from repository. +.RE .SH "USAGE" - - -In order for the live CD to actually be bootable, add the following packages, using the morphix udeb archive (\-r http://www\&.morphix\&.org/debian) - -.TP 3 -\(bu -grub\-gfxboot\-iso\-udeb -.TP -\(bu -morphix\-grub\-menulist\-udeb -.TP -\(bu -morphix\-iso\-grubtheme -.LP - - +In order for the live CD to actually be bootable, add the following packages, using the morphix udeb archive (\-r http://www.morphix.org/debian) +.sp +.sp +.RS 4 +\h'-04'\(bu\h'+03'grub\-gfxboot\-iso\-udeb +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'morphix\-grub\-menulist\-udeb +.RE +.sp +.RS 4 +\h'-04'\(bu\h'+03'morphix\-iso\-grubtheme +.RE Additional udebs (you probably want them) - -.TP 3 -\(bu -morphix\-cdrom\-misc\-udeb -.LP - - -isomaker currently doesn't remove the working directories automatically, unless \-c is used\&. do a rm \-rf /tmp/libmorphix* afterwards to clean up... ($TEMP/libmorphix* if TEMP set) - - +.sp +.sp +.RS 4 +\h'-04'\(bu\h'+03'morphix\-cdrom\-misc\-udeb +.RE +isomaker currently doesn't remove the working directories automatically, unless \-c is used. do a rm \-rf /tmp/libmorphix* afterwards to clean up\&... ($TEMP/libmorphix* if TEMP set) +.sp Your kernel needs to be able to loop\-mount filesystems modprobe loop before building to enable this, if loop is compiled as a module - +.sp .SH "EXAMPLES" - -.TP +.PP Build a Morphix LiveCD with a single command -isomaker \-b \&.\&./templates/basemod\-2\&.6\&.12\-morphest\&.xml \-r http://www\&.morphix\&.org/debian \-p grub\-gfxboot\-iso\-udeb \-p morphix\-cdrom\-misc\-udeb \-p morphix\-grub\-menulist\-udeb \-p morphix\-iso\-grubtheme \-g /home/ftp/autobuilds/debootstrap\&.tar\&.gz /home/ftp/autobuilds/$BUILDNAME\-$BUILDTIME\&.iso - +.RS 4 +isomaker \-b ../templates/basemod\-2.6.12\-morphest.xml \-r http://www.morphix.org/debian \-p grub\-gfxboot\-iso\-udeb \-p morphix\-cdrom\-misc\-udeb \-p morphix\-grub\-menulist\-udeb \-p morphix\-iso\-grubtheme \-g /home/ftp/autobuilds/debootstrap.tar.gz /home/ftp/autobuilds/$BUILDNAME\-$BUILDTIME.iso +.RE .SH "SECURITY" - - -Needs to be run as root or via sudo\&. So has security implications\&. - +Needs to be run as root or via sudo. So has security implications. +.sp .SH "NOTES" - - -Morphix is a modular\-based liveCD, designed to be easy to modify\&. The package morphing\-tools and morphix\-mmaker contains tools to help modify and build morphix\-based LiveCDs\&. - +Morphix is a modular\-based liveCD, designed to be easy to modify. The package morphing\-tools and morphix\-mmaker contains tools to help modify and build morphix\-based LiveCDs. +.sp .SH "BUGS" - - -Dont panic\&. If you find one, report it to us, but please make sure you have read all of the documentation first\&. We have assumed that you have cloop device and have installed the packages morphing\-tools and morphix\-mmaker\&. - +Dont panic. If you find one, report it to us, but please make sure you have read all of the documentation first. We have assumed that you have cloop device and have installed the packages morphing\-tools and morphix\-mmaker. +.sp .SH "AUTHORS" - - -Written by Alex de Landgraaf and other Morphix developers\&. Morphix web site: \fIhttp://www.morphix.org/\fR\&. Browse cvs repository[http://sourceforge\&.net/projects/morphix] and cvs mailing lists for full list of developers and patches submitted\&. - - -This man page was written by Brendan Sleight using asciidoc: \fIhttp://www.methods.co.nz/asciidoc/\fR - +Written by Alex de Landgraaf and other Morphix developers. Morphix web site. Browse cvs repository[http://sourceforge.net/projects/morphix] and cvs mailing lists for full list of developers and patches submitted. +.sp +This man page was written by Brendan Sleight using asciidoc +.sp .SH "SEE ALSO" - - -\fIaddtoiso, install2mainmod, isomaker, isomorph, make\-iso, make\-mini, minimod\-gen, mmaker, module\-builder, module\-extractor, morphmini\fR - +\fBaddtoiso, install2mainmod, isomaker, isomorph, make\-iso, make\-mini, minimod\-gen, mmaker, module\-builder, module\-extractor, morphmini\fR +.sp +.SH "REFERENCES" +.IP " 1." 4 +Morphix web site +.RS 4 +\%http://www.morphix.org/ +.RE +.IP " 2." 4 +asciidoc +.RS 4 +\%http://www.methods.co.nz/asciidoc/ +.RE Modified: trunk/mmaker/debian/make-mini.1 =================================================================== --- trunk/mmaker/debian/make-mini.1 2007-04-12 22:02:55 UTC (rev 2486) +++ trunk/mmaker/debian/make-mini.1 2007-04-12 22:03:44 UTC (rev 2487) @@ -1,88 +1,80 @@ -.\"Generated by db2man.xsl. Don't modify this, modify the source. -.de Sh \" Subsection -.br -.if t .Sp -.ne 5 -.PP -\fB\\$1\fR -.PP -.. -.de Sp \" Vertical space (when we can't use .PP) -.if t .sp .5v -.if n .sp -.. -.de Ip \" List item -.br -.ie \\n(.$>=3 .ne \\$3 -.el .ne 3 -.IP "\\$1" \\$2 -.. -.TH "MAKE-MINI" 1 "" "" "" -.SH NAME -make-mini \- Creates a morphix mini module +.\" Title: make-mini +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.72.0 <http://docbook.sf.net/> +.\" Date: 04/12/2007 +.\" Manual: +.\" Source: +.\" +.TH "MAKE\-MINI" "1" "04/12/2007" "" "" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" +make\-mini \- Creates a morphix mini module .SH "SYNOPSIS" - - -make\-mini [[\-\-lang LANG]] | [[\-\-overlay ] [\-\-hidden] [\-\-homedir]] output\&.mod - +make\-mini [[\-\-lang LANG]] | [[\-\-overlay ] [\-\-hidden] [\-\-homedir]] output.mod +.sp .SH "DESCRIPTION" - - -Commandline tool for building a minimodule containing homedir and language files\&. - +Commandline tool for building a minimodule containing homedir and language files. +.sp .SH "OPTIONS" - -.TP +.PP \fI\-\-lang LANG\fR +.RS 4 use LANG as the default language (overridden by bootoptions) - -.TP +.RE +.PP \fI\-\-overlay\fR +.RS 4 use files from /tmp/overlay - -.TP +.RE +.PP \fI\-\-hidden\fR +.RS 4 use hidden users files - -.TP +.RE +.PP \fI\-\-homedir\fR +.RS 4 use normal users files - +.RE .SH "EXAMPLES" - -.TP +.PP Build a Morphix minimodule containing all the files, including hidden file in the home directory -make\-mini \-\-homedir \-\-hidden \&./minimodule\&.mod - -.TP +.RS 4 +make\-mini \-\-homedir \-\-hidden ./minimodule.mod +.RE +.PP Language example +.RS 4 make\-mini \-\-lang nl_NL@euro - +.RE .SH "SECURITY" - - -Needs to be run as root or via sudo\&. So has security implications\&. - +Needs to be run as root or via sudo. So has security implications. +.sp .SH "NOTES" - - -Morphix is a modular\-based liveCD, designed to be easy to modify\&. The package morphing\-tools and morphix\-mmaker contains tools to help modify and build morphix\-based LiveCDs\&. - +Morphix is a modular\-based liveCD, designed to be easy to modify. The package morphing\-tools and morphix\-mmaker contains tools to help modify and build morphix\-based LiveCDs. +.sp .SH "BUGS" - - -Dont panic\&. If you find one, report it to us, but please make sure you have read all of the documentation first\&. We have assumed that you have cloop device and have installed the packages morphing\-tools and morphix\-mmaker\&. - +Dont panic. If you find one, report it to us, but please make sure you have read all of the documentation first. We have assumed that you have cloop device and have installed the packages morphing\-tools and morphix\-mmaker. +.sp .SH "AUTHORS" - - -Written by Alex de Landgraaf and other Morphix developers\&. Morphix web site: \fIhttp://www.morphix.org/\fR\&. Browse cvs repository[http://sourceforge\&.net/projects/morphix] and cvs mailing lists for full list of developers and patches submitted\&. - - -This man page was written by Brendan Sleight using asciidoc: \fIhttp://www.methods.co.nz/asciidoc/\fR - +Written by Alex de Landgraaf and other Morphix developers. Morphix web site. Browse cvs repository[http://sourceforge.net/projects/morphix] and cvs mailing lists for full list of developers and patches submitted. +.sp +This man page was written by Brendan Sleight using asciidoc +.sp .SH "SEE ALSO" - - -\fIaddtoiso, install2mainmod, isomaker, isomorph, make\-iso, make\-mini, minimod\-gen, mmaker, module\-builder, module\-extractor, morphmini\fR - +\fBaddtoiso, install2mainmod, isomaker, isomorph, make\-iso, make\-mini, minimod\-gen, mmaker, module\-builder, module\-extractor, morphmini\fR +.sp +.SH "REFERENCES" +.IP " 1." 4 +Morphix web site +.RS 4 +\%http://www.morphix.org/ +.RE +.IP " 2." 4 +asciidoc +.RS 4 +\%http://www.methods.co.nz/asciidoc/ +.RE Modified: trunk/mmaker/debian/mmaker.1 =================================================================== --- trunk/mmaker/debian/mmaker.1 2007-04-12 22:02:55 UTC (rev 2486) +++ trunk/mmaker/debian/mmaker.1 2007-04-12 22:03:44 UTC (rev 2487) @@ -1,96 +1,102 @@ -.\"Generated by db2man.xsl. Don't modify this, modify the source. -.de Sh \" Subsection -.br -.if t .Sp -.ne 5 -.PP -\fB\\$1\fR -.PP -.. -.de Sp \" Vertical space (when we can't use .PP) -.if t .sp .5v -.if n .sp -.. -.de Ip \" List item -.br -.ie \\n(.$>=3 .ne \\$3 -.el .ne 3 -.IP "\\$1" \\$2 -.. -.TH "MMAKER" 1 "" "" "" -.SH NAME +.\" Title: mmaker +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.72.0 <http://docbook.sf.net/> +.\" Date: 04/12/2007 +.\" Manual: +.\" Source: +.\" +.TH "MMAKER" "1" "04/12/2007" "" "" +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.SH "NAME" mmaker \- Creates a morphix base or morphix main module, using template files .SH "SYNOPSIS" - - -\fImmaker\fR [\-g debootstrap\&.tar\&.gz] [\-b debootstrap\&.tar\&.bz] [\-m miniroot\&.gz] [\-k vmlinuz\-mykernel] [\-t /tempdir] [\-c] [\-d /debootstrapped] [\-p http://proxy\&.mydomain\&.com:8080] [\-v] [\-i] input\&.xml output\&.mod - +\fImmaker\fR [\-g debootstrap.tar.gz] [\-b debootstrap.tar.bz] [\-a /path/to/package1.deb [\-a /path/to/package2.deb]] [\-m miniroot.gz] [\-k vmlinuz\-mykernel] [\-t /tempdir] [\-c] [\-d /debootstrapped] [\-p http://proxy.mydomain.com:8080] [\-v] [\-i] input.xml output.mod +.sp .SH "DESCRIPTION" - - -Mmaker creates a Morphix base or main module \fIoutput\&.mod\fR, using a xml template file \fIinput\&.xml\fR\&. A really lazy way to build parts of a LiveCD\&. - +Mmaker creates a Morphix base or main module \fIoutput.mod\fR, using a xml template file \fIinput.xml\fR. A really lazy way to build parts of a LiveCD. +.sp .SH "OPTIONS" - -.TP -\fI\-g debootstrap\&.tar\&.gz\fR -Use a local debian bootstrap, rather than download from repository\&. - -.TP -\fI\-b debootstrap\&.tar\&.bz\fR -Use a local debian bootstrap, rather than download from repository\&. - -.TP +.PP +\fI\-g debootstrap.tar.gz\fR +.RS 4 +Use a local debian bootstrap, rather than download from repository. +.RE +.PP +\fI\-b debootstrap.tar.bz\fR +.RS 4 +Use a local debian bootstrap, rather than download from repository. +.RE +.PP +\fI\-a /path/to/package\fR +.RS 4 +add this package to the module. +.RE +.PP \fI\-d /debootstrapped\fR -Use a local debian bootstrap, rather than download from repository\&. - -.TP -\fI\-m miniroot\&.gz\fR -Use a local miniroot, rather than download from repository\&. - -.TP +.RS 4 +Use a local debian bootstrap, rather than download from repository. +.RE +.PP +\fI\-m miniroot.gz\fR +.RS 4 +Use a local miniroot, rather than download from repository. +.RE +.PP \fI\-k vmlinuz\-mykernel\fR -Use a local kernal, rather than download from repository\&. - -.TP +.RS 4 +Use a local kernal, rather than download from repository. +.RE +.PP \fI\-t /tempdir\fR -use this temp directory instead of making a new one\&. - -.TP +.RS 4 +use this temp directory instead of making a new one. +.RE +.PP \fI\-c\fR -Clean temporary directories\&. - -.TP -\fI\-p http://proxy\&.mydomain\&.com:8080\fR +.RS 4 +Clean temporary directories. +.RE +.PP +\fI\-p http://proxy.mydomain.com:8080\fR +.RS 4 Use a proxy for downloading packages - -.TP +.RE +.PP \fI\-v\fR -Verbose mode \- hepful for debugging\&. - -.TP +.RS 4 +Verbose mode \- hepful for debugging. +.RE +.PP \fI\-i\fR -Interactive mode \- may not work\&. - +.RS 4 +Interactive mode \- may not work. +.RE .SH "EXAMPLES" - -.TP +.PP Build a Morphix base module -mmaker \-m /my/livecd/boot/miniroot\&.gz \-k /my/livecd/boot/vmlinuz basemod\&.xml /my/livecd/base/morphix - -.TP +.RS 4 +mmaker \-m /my/livecd/boot/miniroot.gz \-k /my/livecd/boot/vmlinuz basemod.xml /my/livecd/base/morphix +.RE +.PP Build a Morphix main module -mmaker firefox\&.xml firefox\&.mod +.RS 4 +mmaker firefox.xml firefox.mod +.RE +.SH "EXAMPLES \-TEMPLATES" +.sp +.RS 4 +.nf +Quick overview on the layout of a template. For examples, see the +template/ directory. -.SH "EXAMPLES -TEMPLATES" +\-\-\- - -Below is a quick overview on the layout of a template\&. - -.IP The syntax is derived from Progeny's CL scheme, which was derived from -Redhat's\&. This one has a list of available options in your template, with -comments to help you out\&. +Redhat's. This one has a list of available options in your template, with +comments to help you out. <comps> <group> @@ -102,7 +108,7 @@ <description>possibly multiline description of module</description> - <type>[mainmod|basemod|minimod]</type> ( + <type>[mainmod|basemod|minimod]</type> <!\-\- currently only main/basemod are useful \-\-> <suite>[sid|sarge|woody|unstable|testing|stable]</suite> @@ -121,64 +127,79 @@ <to>/place/in/module</to> </retrieve> - <retrieve type="[tar\&.gz|tar\&.bz2]"> <!\-\- only implemented for local from\-to \-\-> - \&.\&.\&. + <retrieve type="[tar.gz|tar.bz2]"> <!\-\- only implemented for local from\-to \-\-> + ... </retrieve> <repositorylist> <repository type="[debian|plain]" [nonfree="true"] [suite="woody|sarge|sid|stable|testing|unstable]>URL</repository> - <!\-\- either a normal repository or a debian one\&. + <!\-\- either a normal repository or a debian one. Need one debian repository for main/base modules use nonfree if you want to add contrib/non\-free to your apt line adding the suite tag here overrides the default suite \-\-> - \&.\&.\&. + ... </repositorylist> <packagelist> <packagereq [target="sid|sarge|woody|unstable|testing|stable"]>packagename</packagereq> <!\-\- package to apt\-get install, optionally set target to define the \-t/\-\-target\-release of the package \-\-> - \&.\&.\&. + ... <packagedel>packagename</packagereq> <!\-\- package to apt\-get purge \-\-> - \&.\&.\&. + ... </packagelist> + + <localdeblist> + + <localdeb>/path/to/package.deb</localdeb> + <!\-\- this package from the host system is copied into the build directory and installed using dpkg \-i. It is removed afterwards \-\-> + </localdeblist> + <patchlist> - <patch>path/to/shellscript\&.sh</patch> - <!\-\- shell script on HOST system, gets the build directory as $1 \-\-> + <patch>path/to/shellscript.sh</patch> + <!\-\- shell script on host system, gets copied into the root of the build directory and is executed. It is removed afterwards \-\-> </patchlist> + + <commandlist> + + <command>echo "Real Morphers idle on #morphix"</command> + <!\-\- shell command run in the build chroot, just before compressing \-\-> + </commandlist> + </group> </comps> - +.fi +.RE .SH "SECURITY" - - -Needs to be run as root or via sudo\&. So has security implications\&. - +Needs to be run as root or via sudo. So has security implications. +.sp .SH "NOTES" - - -Morphix is a modular\-based liveCD, designed to be easy to modify\&. The package morphing\-tools and morphix\-mmaker contains tools to help modify and build morphix\-based LiveCDs\&. - +Morphix is a modular\-based liveCD, designed to be easy to modify. The package morphing\-tools and morphix\-mmaker contains tools to help modify and build morphix\-based LiveCDs. +.sp .SH "BUGS" - - -Dont panic\&. If you find one, report it to us, but please make sure you have read all of the documentation first\&. We have assumed that you have cloop device and have installed the packages morphing\-tools and morphix\-mmaker\&. - +Dont panic. If you find one, report it to us, but please make sure you have read all of the documentation first. We have assumed that you have cloop device and have installed the packages morphing\-tools and morphix\-mmaker. +.sp .SH "AUTHORS" - - -Written by Alex de Landgraaf and other Morphix developers\&. Morphix web site: \fIhttp://www.morphix.org/\fR\&. Browse cvs repository[http://sourceforge\&.net/projects/morphix] and cvs mailing lists for full list of developers and patches submitted\&. - - -This man page was written by Brendan Sleight using asciidoc: \fIhttp://www.methods.co.nz/asciidoc/\fR - +Written by Alex de Landgraaf and other Morphix developers. Morphix web site. Browse cvs repository[http://sourceforge.net/projects/morphix] and cvs mailing lists for full list of developers and patches submitted. +.sp +This man page was written by Brendan Sleight using asciidoc +.sp .SH "SEE ALSO" - - -\fIaddtoiso, install2mainmod, isomaker, isomorph, make\-iso, make\-mini, minimod\-gen, mmaker, module\-builder, module\-extractor, morphmini\fR - +\fBaddtoiso, install2mainmod, isomaker, isomorph, make\-iso, make\-mini, minimod\-gen, mmaker, module\-builder, module\-extractor, morphmini\fR +.sp +.SH "REFERENCES" +.IP " 1." 4 +Morphix web site +.RS 4 +\%http://www.morphix.org/ +.RE +.IP " 2." 4 +asciidoc +.RS 4 +\%http://www.methods.co.nz/asciidoc/ +.RE This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site. |