ulog: ulogd.conf.5 man page

ulog: ulogd.conf.5 man page

[Chris Boot]

Hi,

As part of my work in packaging ulogd 2.x for Debian, I'd like to write
a man page for the ulogd.conf configuration file. I started out writing
this a few days ago and I have progressed quite well:

https://github.com/bootc/ulogd2/blob/add-ulogd.conf.5-wip/ulogd.conf.5

I'm send this email because as I write, I realise I'm either repeating
or replacing (by augmentation) quite a bit of the content in the
ulogd.sgml file. Before I sink quite a few more hours into fleshing out
the file, I wanted to check whether I'm going in the right direction and
whether/how I need to change what I'm doing to have the work accepted
upstream.

I think a man page will be very useful to have - I often find myself
reaching for them - I just want to know if I'm going about it from
completely the wrong angle.

Thanks,
Chris

-- 
Chris Boot
bootc@bootc.net

Re: ulog: ulogd.conf.5 man page

[Eric Leblond]

[-- Attachment #1: Type: text/plain, Size: 1201 bytes --]

Hello,

Sorry for the late answer.

Le samedi 01 juin 2013 à 20:09 +0100, Chris Boot a écrit :
> Hi,
> 
> As part of my work in packaging ulogd 2.x for Debian, I'd like to write
> a man page for the ulogd.conf configuration file. I started out writing
> this a few days ago and I have progressed quite well:
> 
> https://github.com/bootc/ulogd2/blob/add-ulogd.conf.5-wip/ulogd.conf.5
> 
> I'm send this email because as I write, I realise I'm either repeating
> or replacing (by augmentation) quite a bit of the content in the
> ulogd.sgml file.

It seems this is the case indeed.

>  Before I sink quite a few more hours into fleshing out
> the file, I wanted to check whether I'm going in the right direction and
> whether/how I need to change what I'm doing to have the work accepted
> upstream.
> 
> I think a man page will be very useful to have - I often find myself
> reaching for them - I just want to know if I'm going about it from
> completely the wrong angle.

I agree that a man page for configuration can be useful but it should be
made from the ulogd.sgml file as there is tool similar to docbook2man
which should be able to do the transformation.

BR,

[-- Attachment #2: This is a digitally signed message part --]
[-- Type: application/pgp-signature, Size: 190 bytes --]