Package: docbook-to-man
Version: 1:2.0.0-20
Severity: minor

The synopsis of the attached man page does not render correctly: There
is no space between the command name and the first parameter. I had to
apply this hack to fix the rendering:

--- cvschangelogbuilder.sgml.old        2006-06-29 09:48:31.000000000 +0200
+++ cvschangelogbuilder.sgml    2006-06-29 09:43:10.000000000 +0200
@@ -40,7 +40,7 @@
   </refnamediv>
   <refsynopsisdiv>
     <cmdsynopsis>
-      <command>&dhpackage;</command>
+      <command>&dhpackage; </command>
       <arg choice="req"><option>-output=outputmode</option></arg>
       <arg choice="opt"><option>-m=module -d=repository</option></arg>
       <arg choice="opt"><option>-b=branch</option></arg>


Kind regards,
Adriaan Peeters
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [

  <!ENTITY dhfirstname "<firstname>Adriaan</firstname>">
  <!ENTITY dhsurname   "<surname>Peeters</surname>">
  <!ENTITY dhdate      "<date>May 24, 2006</date>">
  <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
  <!ENTITY dhemail     "<email>[EMAIL PROTECTED]</email>">
  <!ENTITY dhusername  "Adriaan Peeters">
  <!ENTITY dhucpackage "<refentrytitle>CVSCHANGELOGBUILDER</refentrytitle>">
  <!ENTITY dhpackage   "cvschangelogbuilder">

  <!ENTITY debian      "<productname>Debian</productname>">
  <!ENTITY gnu         "<acronym>GNU</acronym>">
]>

<refentry>
  <refentryinfo>
    <address>
      &dhemail;
    </address>
    <author>
      &dhfirstname;
      &dhsurname;
    </author>
    <copyright>
      <year>2006</year>
      <holder>&dhusername;</holder>
    </copyright>
    &dhdate;
  </refentryinfo>
  <refmeta>
    &dhucpackage;

    &dhsection;
  </refmeta>
  <refnamediv>
    <refname>&dhpackage;</refname>

    <refpurpose>build cvs ChangeLogs and cvs html reports</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&dhpackage;</command>
      <arg choice="req"><option>-output=outputmode</option></arg>
      <arg choice="opt"><option>-m=module -d=repository</option></arg>
      <arg choice="opt"><option>-b=branch</option></arg>
      <arg choice="opt"><option>-tagstart=tagname</option></arg>
      <arg choice="opt"><option>-tagend=tagname</option></arg>
      <arg choice="opt"><option>-ssh</option></arg>
      <arg choice="opt"><option>-rlogfile=rlogfile</option></arg>
      <arg choice="opt"><option>-keeprlogfile</option></arg>
      <arg choice="opt"><option>-dir=dirname</option></arg>
      <arg choice="opt"><option>-viewcvsurl=viewcvsurl</option></arg>
      <arg choice="opt"><option>-ignore=file/dir</option></arg>
      <arg choice="opt"><option>-debug=x</option></arg>
    </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1>
    <title>DESCRIPTION</title>

    <para><command>&dhpackage;</command>
      generates advanced ChangeLog/Report files for CVS projects/modules.
    </para>

  </refsect1>
  <refsect1>
    <title>OPTIONS</title>

        <variablelist>
            <varlistentry><term><option>-output=outputmode</option></term>
                <listitem>
                    <para>
                        Where outputmode is:
                    </para>
                    <itemizedlist>
                        <listitem><para>listdeltabydate  To get a changelog 
between 2 versions, sorted by date</para></listitem>
                        <listitem><para>listdeltabylog   To get a changelog 
between 2 versions, sorted by log</para></listitem>
                        <listitem><para>listdeltabyfile  To get a changelog 
between 2 versions, sorted by file</para></listitem>
                        <listitem><para>listdeltaforrpm  To get a changelog 
between 2 versions for rpm spec files</para></listitem>
                        <listitem><para>buildhtmlreport  To build an html 
report</para></listitem>
                    </itemizedlist>
                    <para>Note that "between 2 versions" means (depends on 
tagstart/tagend options):</para>
                    <itemizedlist>
                        <listitem><para>from start to a tagged version (version 
changes included)</para></listitem>
                        <listitem><para>from a tagged version (excluded) to 
another tagged version (included)</para></listitem>
                        <listitem><para>or from a tagged version until now 
(version changes excluded)</para></listitem>
                    </itemizedlist>
                    <para>You can also add extra parameters when 
output=buildhtmlreport by adding them
                          after a colon and separated by a comma, like this:
                           -output=buildhtmlreport:param1,param2
                          This is extra paremeters available for 
-output=buildhtmlreport mode:
                    </para>
                    <itemizedlist>
                        <listitem><para>nosummary         To remove summary 
part</para></listitem>
                        <listitem><para>nolinesofcode     To remove lines of 
code part</para></listitem>
                        <listitem><para>nodevelopers      To remove developers 
part</para></listitem>
                        <listitem><para>nodaysofweek      To remove days of 
week part</para></listitem>
                        <listitem><para>nohours           To remove hours 
part</para></listitem>
                        <listitem><para>notags            To remove tags 
part</para></listitem>
                        <listitem><para>nolastlogs        To remove last logs 
part</para></listitem>
                        <listitem><para>nolimit           To not limit last 
logs to last 200</para></listitem>
                        <listitem><para>sortbyrevision    To sort last logs by 
revision</para></listitem>
                        <listitem><para>loosecommits      To separate commits 
for same log by spaces</para></listitem>
                    </itemizedlist>
                </listitem>
            </varlistentry>
            <varlistentry><term><option>-m=module</option> 
<option>-d=repository</option></term>
                <listitem>
                    <para>The 'module' and 'repository' are the CVS module name 
and the CVS repository.
                          If current directory is the root of a CVS project 
built from a cvs checkout,
                          cvschangelogbuilder will retreive module and 
repository value automatically.
                          If no local copy of repository are available or to 
force other value, use:
                    </para>
                    <itemizedlist>
                        <listitem><para>-m=module           To force value of 
module name</para></listitem>
                        <listitem><para>  -d=repository       To force value of 
CVSROOT</para></listitem>
                    </itemizedlist>
                </listitem>
            </varlistentry>
            <varlistentry><term><option>-branch=branchname</option></term>
                <listitem>
                    <para>
                        To work on another branch than the default branch.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry><term><option>-tagstart=tagname</option></term>
                <listitem>
                    <para>
                        To specify start tag version.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry><term><option>-tagend=tagend</option></term>
                <listitem>
                    <para>
                        To specify end tag version.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry><term><option>-ssh</option></term>
                <listitem>
                    <para>
                        To run CVS through ssh (this set env var CVS_RSH="ssh").
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry><term><option>-rlogfile=rlogfile</option></term>
                <listitem>
                    <para>
                        If an up-to-date log file already exists localy, you can
                        use this option to avoid log download, for a faster 
result.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry><term><option>-keeprlogfile</option></term>
                <listitem>
                    <para>
                        Once process is finished, you can ask to not remove the
                        downloaded log file.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry><term><option>-dir=dirname</option></term>
                <listitem>
                    <para>
                        Output is built in directory dirname.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry><term><option>-viewcvsurl=viewcvsurl</option></term>
                <listitem>
                    <para>
                        File's revisions in reports built by buildhtmlreport
                        output are links to "viewcvs". String '__MODULE__'
                        will be replaced by name of CVS module.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry><term><option>-ignore=file/dir</option></term>
                <listitem>
                    <para>
                        To exclude a file/dir off report.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry><term><option>-debug=x</option></term>
                <listitem>
                    <para>
                        To output on stderr some debug info with level x.
                    </para>
                </listitem>
            </varlistentry>
        </variablelist>

  </refsect1>

  <refsect1>
    <title>SEE ALSO</title>

    <para>cvs (1).</para>

  </refsect1>

  <refsect1>
    <title>AUTHOR</title>

    <para>This manual page was written by &dhusername; &dhemail; for
      the &debian; system (but may be used by others). It is based on
      the help output of &dhpackage;. Permission is
      granted to copy, distribute and/or modify this document under
      the terms of the <acronym>GNU</acronym> General Public
      License, Version 2 or any later version published by the Free
      Software Foundation; with no Invariant Sections, no Front-Cover
      Texts and no Back-Cover Texts.</para>

  </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:2
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->


Attachment: signature.asc
Description: This is a digitally signed message part

Reply via email to