aboutsummaryrefslogtreecommitdiffstats
path: root/shipper/rpm2lsm.xml
blob: 6856cbabc34e9b8695b9dd66e0a29ae3da0562a1 (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
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
                   "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id='rpm2lsm.1'>
<refmeta>
<refentrytitle>rpm2lsm</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv id='name'>
<refname>rpm2lsm</refname>
<refpurpose>generate Linux Software Map entries from RPMs</refpurpose>
</refnamediv>
<refsynopsisdiv id='synopsis'>

<cmdsynopsis>
  <command>rpm2lsm</command>
  <arg choice='opt'>-a <replaceable>author</replaceable></arg>
  <arg choice='opt'>-k <replaceable>keywords</replaceable></arg>
  <arg choice='opt'>-p <replaceable>platforms</replaceable></arg>
  <arg choice='opt'>-m <replaceable>maintainer</replaceable></arg>
  <arg choice='plain'><replaceable>rpmfile</replaceable></arg>
</cmdsynopsis>

</refsynopsisdiv>

<refsect1 id='description'><title>DESCRIPTION</title>
<para>This tool extracts tag information from an RPM file to generate a
Linux Software Map (version 3) entry on standard output.  Command-line
switches support adding LSM fields that have no equivalents in RPMs.
Here are the field-generation rules:</para>
<variablelist remap='TP'>
<varlistentry>
<term>Title:</term>
<listitem>
<para>Taken straight from the RPM Name field.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Version:</term>
<listitem>
<para>Taken straight from the RPM Version field.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Entered-Date:</term>
<listitem>
<para>LSM-generation time in YYYY-MM-DD format.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Description:</term>
<listitem>
<para>Taken straight from the RPM Description field.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Keywords:</term>
<listitem>
<para>Taken from the value of the <option>-k</option> command-line option.
If no such option is given, it is omitted.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Author:</term>
<listitem>
<para>Taken from the value of the <option>-a</option> command-line
option.  If no such option is given, it looks for an AUTHORS file in
the current directory (GNU convention) and uses that.  If no AUTHORS
file is present, your email addess and full name from the password
file</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Maintained-By:</term>
<listitem>
<para>Taken from the value of the <option>-m</option> command-line
option.  If that was not given, taken from the RPM Packager field.  
If that was not given, fill in the Author name.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Primary-Site:</term>
<listitem>
<para>The first (site) line is taken from the RPM URL field.  Second
and subsequent lines list tarballs and RPMs that match on name, version
number, and release number with the RPM algument.  For each file,
size in 1K blocks is filled in.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Alternate-Site:</term>
<listitem>
<para>This field is not generated.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Original-Site:</term>
<listitem>
<para>This field is not generated.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Platforms:</term>
<listitem>
<para>Taken from the value of the <option>-p</option> command-line option.
If no such option is given, 'All' is filled in.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Copying-Policy:</term>
<listitem>
<para>Taken straight from the RPM License field.</para>
</listitem>
</varlistentry>
</variablelist>

<para>These are all the fields supported in LSM version 3.  You can see the 
<ulink url='http://ibiblio.org/pub/Linux/LSM-TEMPLATE'>
LSM template
</ulink>
for full details.</para>
</refsect1>

<refsect1 id='author'><title>AUTHOR</title>
<para>Eric S. Raymond <email>esr@thyrsus.com</email>.
For updates, see <ulink url="http://www.catb.org/~esr/software.html">
http://www.catb.org/~esr/software.html</ulink>.</para>
</refsect1>

<refsect1 id='see_also'><title>SEE ALSO</title>
<para><citerefentry><refentrytitle>rpm</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
</refsect1>
</refentry>