Le Mon, Mar 30, 2009 at 09:47:37PM +0200, Laurent Guignard a écrit :
> How to document these scripts if they are located in /usr/share (man or
> /usr/share/doc) ?

Hi Laurent,

since it is Perl script, the embedded POD (“plain old documentation”) format is
probably the best way to document their function.

You can find examples in many perl programs. Try for instance “less
/usr/bin/prename”, and look at the second half of the page.

POD is documented on line (http://perldoc.perl.org/perlpod.html), and of course
on your computer if you have the `perl-doc` package installed: “perldoc
perpod”.

This said, documentation is really the job of Upstream, so the most
time-efficient for you is to convince them to write it ;)

Have a nice day,

-- 
Charles Plessy
Tsurumi, Kanagawa, Japan


-- 
To UNSUBSCRIBE, email to debian-mentors-requ...@lists.debian.org
with a subject of "unsubscribe". Trouble? Contact listmas...@lists.debian.org

Reply via email to