Moved metagen.1 to docs

1 files changed, 94 insertions, 0 deletions

diff --git a/docs/metagen.1 b/docs/metagen.1
new file mode 100644
index 0000000..0977087
--- /dev/null
+++ b/docs/metagen.1
@@ -0,0 +1,94 @@
+.\" Contact pythonhead@gentoo.org to correct errors or omissions. 
+.TH man 1 "22 August 2004" "1.0" "metagen man page"
+.SH NAME
+.B metagen
+\- generate metadata.xml for ebuilds
+.SH SYNOPSIS
+.B metagen
+[options]
+.SH DESCRIPTION
+.B metagen 
+will create a valid metadata.xml file in the current directory. metadata.xml requires a herd tag (-H). If you only specify a package maintainer's email address (-e) "no-herd" will be inserted in the herd tag automatically.
+
+If you need multiple elements, such as two herds, use a comma to
+separate them. See EXAMPLES.
+
+.SH OPTIONS
+.\" metagen [OPTIONS]
+  -H  herd
+      Name of herd.
+
+  -e  email-address
+      Package maintainer's email address
+
+  -n  maintainer-name
+      Package maintainer's name (used with -e option)
+
+  -m 
+      Uses ECHANGELOG_USER variable. Can be used instead of -e and -n
+
+  -d  description
+      Description of maintainership (used with -e option)
+
+  -l  long-description
+      Long description of package.
+
+  -o  output-file
+      Write to <output-file> instead of ./metadata.xml
+
+  -f
+      Force overwrite of existing metadata
+
+  -v 
+      Write to stdout as well as disk (default)
+
+  -q
+      Don't write to stdout
+
+  -Q
+      Don't write file to disk 
+
+  -h, --help  show this help message and exit
+
+.SH EXAMPLES
+.B metagen -H python
+
+Creates metadata.xml in current directory with python as the herd
+
+
+.B metagen -H python,wxwidgets \
+           -l 'This package does a little of this and some o dat.'
+
+Creates metadata in current directory with two herds and long description
+
+
+.B metagen -e pythonhead@gentoo.org \
+           -n 'Joe Blow' \
+           -d 'The voices in my head told me to maintain this package' \
+           -Q
+
+herd='no-herd', maintainer email, maintainer name, description of maintainership, to stdout only
+
+
+.B metagen -H net-p2p,python -e jo@gentoo.org,flo@gentoo.org \
+           -n 'Jo Blo','Flo Blo' \
+           -d 'I am maintaining this because foo','I am maintaining this because bar' \
+           -l 'This package is yadda yadda yadda, spam and eggs' \
+           -Q
+
+2 herds, 2 maintainers with names and maintainer descriptions for each maintainer,
+only write to stdout
+
+
+.SH FILES
+.P 
+.I /usr/bin/metagen
+.I /usr/share/man/man1/metagen.1.gz
+.SH BUGS
+No known bugs at this time. 
+.SH AUTHOR
+.nf
+Rob 'pythonhead' Cakebread (pythonhead@gentoo.org)
+.fi
+.SH HISTORY
+2004 \- Initial revision