[Openswan dev] [PATCH] programs/eroute/eroute.8.xml: fix refname

[Jari Aalto]

Tuomo Soini <tis at foobar.fi> writes:

> Jari Aalto wrote:
>
>> Signed-off-by: Jari Aalto <jari.aalto at cante.net>
>> ---
>>  programs/eroute/eroute.8.xml |    4 ++--
>>  1 files changed, 2 insertions(+), 2 deletions(-)
>> 
>> diff --git a/programs/eroute/eroute.8.xml b/programs/eroute/eroute.8.xml
>> index 4a30a12..72d5fa5 100644
>> --- a/programs/eroute/eroute.8.xml
>> +++ b/programs/eroute/eroute.8.xml
>> @@ -16,7 +16,7 @@
>>    </refmeta>
>>  
>>    <refnamediv id="name">
>> -    <refname>ipsec eroute</refname>
>> +    <refname>ipsec_eroute</refname>
>> 
>>      <refpurpose>manipulate IPSEC extended routing tables</refpurpose>
>>    </refnamediv>
>> @@ -424,4 +424,4 @@
>>  
>>      <!--  patch shell fixes. -->
>>    </refsect1>
>> -</refentry>
>> \ No newline at end of file
>> +</refentry>
>
> This patch is wrong. even when man page is ipsec_eroute command is
> "ipsec eroute"

The manual page is created wrong from this XML source. It reads:

    .\"     Title: IPSEC_EROUTE
    .\"    Author: 
    .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
    .\"      Date: 03 April 2007
    .\"    Manual: 21 Jun 2000
    .\"    Source: 21 Jun 2000
    .\"
    .TH "IPSEC_EROUTE" "8" "03 April 2007" "21 Jun 2000" "21 Jun 2000"
    .\" disable hyphenation
    .nh
    root at jondo /srv/deb/vc/openswan.svn.b head -20 programs/eroute/eroute.8
    .\"     Title: IPSEC_EROUTE
    .\"    Author: 
    .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
    .\"      Date: 03 April 2007
    .\"    Manual: 21 Jun 2000
    .\"    Source: 21 Jun 2000
    .\"
    .TH "IPSEC_EROUTE" "8" "03 April 2007" "21 Jun 2000" "21 Jun 2000"
    .\" disable hyphenation
    .nh
    .\" disable justification (adjust text to left margin only)
    .ad l
    .SH "NAME"
    ipsec eroute - manipulate IPSEC extended routing tables

    $ lexgrog programs/eroute/eroute.8
    programs/eroute/eroute.8: parse failed

Which basicly means:

    Error: bad whatis. Check section NAME and ensure: 'program \- description'

Which measn that the TH and NAME must be same ONE_WORD in order to be correct, thus:

!   .TH "IPSEC_EROUTE" "8" "03 April 2007" "21 Jun 2000" "21 Jun 2000"

    .SH "NAME"
!   ipsec_eroute - manipulate IPSEC extended routing tables

The NAME is not the SYNOPSIS to day how command is run.

Please elaborate,
Jari