[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Re: How to write a good manpage ?



Hi, Marco,

Marco Bertorello написа:
> I always used help2man to generate a manpage for those packages that
> hasn't one.
> 
> But now, I'm working on a package that has a non useful help output:
> 
> $ gcstar --help
> Usage: /usr/bin/gcstar [[-u|--update [-a|--all] [-c|--collection]
> [-w|--website] [-i|--import] [-e|--export] [-l|--lang]] | [FILE]]
> 
> How can I write a manpage good for debian?

/usr/share/doc/man-db/examples/manpage.example
/usr/share/debhelper/dh_make/debian/manpage.xml.ex
/usr/share/debhelper/dh_make/debian/manpage.sgml.ex
/usr/share/debhelper/dh_make/debian/manpage.1.ex

(last three from dh-make package)

Except for the synopsis above, you should describe each option's
meaning and what the program does. Write in the manpage whatever you'd
expect to read if you face the program for the first time :)


HTH,
dam
-- 
Damyan Ivanov                           Modular Software Systems
dam@modsoftsys.com
phone +359(2)928-2611, 929-3993              fax +359(2)920-0994
mobile +359(88)856-6067             dam@jabber.minus273.org/Gaim

Attachment: signature.asc
Description: OpenPGP digital signature


Reply to: