[liblouis-liblouisxml] Re: Support for man pages through help2man

  • From: "John J. Boyer" <johnjboyer@xxxxxxxxxxxxx>
  • To: liblouis-liblouisxml@xxxxxxxxxxxxx
  • Date: Mon, 29 Jun 2009 07:37:32 -0500

Christian,

This sounds good, but there are some caveats. You are right. I had
trouble with help2man. I can't remember why, but I couldn't install it
on my system. Since Michel is using MingW and msys to make the
Windows binary, we also need to be sure that they suport the getopt_long
function. 

Thanks,
John

On Mon, Jun 29, 2009 at 02:15:40PM +0200, Christian Egli wrote:
> Hi all
> 
> For a long time I wanted to have man pages for all the liblouis tools.
> The fact that liblouis is now packaged in Debian and Ubuntu has given me
> motivation to take up that task again. 
> 
> The easiest way to have man pages is to generate them with help2man.
> This requires that all the tools support the --help and --version
> option. As a test I have done this for the simplest tool lou_checktable
> where I added these options and enhanced the build system to
> automatically generate the man page for lou_checktable. I made the use
> of help2man optional as I think John doesn't have it. But presumably the
> packagers will have help2man so the man pages will end up in the Linux
> distributions. In order to support long options I use the function
> getopt_long from getopt.h.
> 
> Now the question is:
>      1. Is it ok to add these options to all the liblouis tools
>         (lou_debug, lou_checkhyphens, etc)
>      2. Is the use of getopt_long portable? GNU/Linux obviuosly has it
>         and so does cygwin as far as I know.
> 
> Thanks
> Christian
> -- 
> Christian Egli
> Swiss Library for the Blind and Visually Impaired
> Grubenstrasse 12, CH-8045 Zürich, Switzerland
> 
> For a description of the software and to download it go to
> http://www.jjb-software.com

-- 
My websites:
GodTouches Digital Ministry, Inc. http://www.abilitiessoft.com/godtouches
Abilitiessoft, Inc. http://www.abilitiessoft.com
Location: Madison, WI, USA

For a description of the software and to download it go to
http://www.jjb-software.com

Other related posts: