Pileus Git - ~andy/fetchmail/blob - dist-tools/shipper/rpm2lsm.xml

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
   3                    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
   4 <refentry id='rpm2lsm.1'>
   5 <refmeta>
   6 <refentrytitle>rpm2lsm</refentrytitle>
   7 <manvolnum>1</manvolnum>
   8 </refmeta>
   9 <refnamediv id='name'>
  10 <refname>rpm2lsm</refname>
  11 <refpurpose>generate Linux Software Map entries from RPMs</refpurpose>
  12 </refnamediv>
  13 <refsynopsisdiv id='synopsis'>
  14
  15 <cmdsynopsis>
  16   <command>rpm2lsm</command>
  17   <arg choice='opt'>-a <replaceable>author</replaceable></arg>
  18   <arg choice='opt'>-k <replaceable>keywords</replaceable></arg>
  19   <arg choice='opt'>-p <replaceable>platforms</replaceable></arg>
  20   <arg choice='opt'>-m <replaceable>maintainer</replaceable></arg>
  21   <arg choice='plain'><replaceable>rpmfile</replaceable></arg>
  22 </cmdsynopsis>
  23
  24 </refsynopsisdiv>
  25
  26 <refsect1 id='description'><title>DESCRIPTION</title>
  27 <para>This tool extracts tag information from an RPM file to generate a
  28 Linux Software Map (version 3) entry on standard output.  Command-line
  29 switches support adding LSM fields that have no equivalents in RPMs.
  30 Here are the field-generation rules:</para>
  31 <variablelist remap='TP'>
  32 <varlistentry>
  33 <term>Title:</term>
  34 <listitem>
  35 <para>Taken straight from the RPM Name field.</para>
  36 </listitem>
  37 </varlistentry>
  38 <varlistentry>
  39 <term>Version:</term>
  40 <listitem>
  41 <para>Taken straight from the RPM Version field.</para>
  42 </listitem>
  43 </varlistentry>
  44 <varlistentry>
  45 <term>Entered-Date:</term>
  46 <listitem>
  47 <para>LSM-generation time in YYYY-MM-DD format.</para>
  48 </listitem>
  49 </varlistentry>
  50 <varlistentry>
  51 <term>Description:</term>
  52 <listitem>
  53 <para>Taken straight from the RPM Description field.</para>
  54 </listitem>
  55 </varlistentry>
  56 <varlistentry>
  57 <term>Keywords:</term>
  58 <listitem>
  59 <para>Taken from the value of the <option>-k</option> command-line option.
  60 If no such option is given, it is omitted.</para>
  61 </listitem>
  62 </varlistentry>
  63 <varlistentry>
  64 <term>Author:</term>
  65 <listitem>
  66 <para>Taken from the value of the <option>-a</option> command-line
  67 option.  If no such option is given, it looks for an AUTHORS file in
  68 the current directory (GNU convention) and uses that.  If no AUTHORS
  69 file is present, your email addess and full name from the password
  70 file</para>
  71 </listitem>
  72 </varlistentry>
  73 <varlistentry>
  74 <term>Maintained-By:</term>
  75 <listitem>
  76 <para>Taken from the value of the <option>-m</option> command-line
  77 option.  If that was not given, taken from the RPM Packager field.
  78 If that was not given, fill in the Author name.</para>
  79 </listitem>
  80 </varlistentry>
  81 <varlistentry>
  82 <term>Primary-Site:</term>
  83 <listitem>
  84 <para>The first (site) line is taken from the RPM URL field.  Second
  85 and subsequent lines list tarballs and RPMs that match on name, version
  86 number, and release number with the RPM algument.  For each file,
  87 size in 1K blocks is filled in.
  88 </para>
  89 </listitem>
  90 </varlistentry>
  91 <varlistentry>
  92 <term>Alternate-Site:</term>
  93 <listitem>
  94 <para>This field is not generated.</para>
  95 </listitem>
  96 </varlistentry>
  97 <varlistentry>
  98 <term>Original-Site:</term>
  99 <listitem>
 100 <para>This field is not generated.</para>
 101 </listitem>
 102 </varlistentry>
 103 <varlistentry>
 104 <term>Platforms:</term>
 105 <listitem>
 106 <para>Taken from the value of the <option>-p</option> command-line option.
 107 If no such option is given, 'All' is filled in.</para>
 108 </listitem>
 109 </varlistentry>
 110 <varlistentry>
 111 <term>Copying-Policy:</term>
 112 <listitem>
 113 <para>Taken straight from the RPM License field.</para>
 114 </listitem>
 115 </varlistentry>
 116 </variablelist>
 117
 118 <para>These are all the fields supported in LSM version 3.  You can see the
 119 <ulink url='http://ibiblio.org/pub/Linux/LSM-TEMPLATE'>
 120 LSM template
 121 </ulink>
 122 for full details.</para>
 123 </refsect1>
 124
 125 <refsect1 id='author'><title>AUTHOR</title>
 126 <para>Eric S. Raymond <email>esr@thyrsus.com</email>.
 127 For updates, see <ulink url="http://www.catb.org/~esr/software.html">
 128 http://www.catb.org/~esr/software.html</ulink>.</para>
 129 </refsect1>
 130
 131 <refsect1 id='see_also'><title>SEE ALSO</title>
 132 <para><citerefentry><refentrytitle>rpm</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
 133 </refsect1>
 134 </refentry>
 135