summaryrefslogtreecommitdiff
blob: 6364ece76148e7a06007ff343613fb958fa29ede (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
.\" Contact neurogeek@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.

If you need multiple elements, such as two herds, use a comma to
separate them. See EXAMPLES.

.SH OPTIONS
.\" metagen [OPTIONS]
.B --herd
|
.B
-H
herd
    Name of herd.

.B --email
|
.B
-e
email-address
    Package maintainer's email address

.B --name
|
.B
-n
maintainer-name
    Package maintainer's name (used with -e option)

.B --echangelog
|
.B
-m
    Uses ECHANGELOG_USER variable. Can be used instead of -e and -n

.B --type
|
.B
-t
type
    Maintainer type as of GLEP 67; valid types are: "person", "project", "unknown"
    (required with --email|-e and --echangelog|-m options)

.B --desc
|
.B
-d
description
    Description of maintainership (used with -e option)

.B --long
|
.B
-l
long-description
    Long description of package.

.B --output
|
.B
-o
output-file
    Write to <output-file> instead of ./metadata.xml

.B --force
|
.B
-f
    Force overwrite of existing metadata

.B --verbose
|
.B
-v
    Write to stdout as well as disk (default)

.B --quiet
|
.B
-q
    Don't write to stdout

.B -Q
    Don't write file to disk

.B --help
|
.B -h
    show usage help and exit

.B --version
    show version 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

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)
Jesus Rivero (neurogeek@gentoo.org)
.fi
.SH HISTORY
2004 \- Initial revision