Ticket #160 (new enhancement)

Opened 6 years ago

Last modified 7 months ago

[RFE] man pages to go along with fine command line utilities

Reported by: pbaker@where2getit.com Assigned to: sdlime
Priority: high Milestone:
Component: MapServer Documentation Version: 4.1
Severity: minor Keywords:
Cc: dmorissette, tomkralidis, warmerdam

Description (Last modified by sdlime) 

I'm working on packaging MapServer for Debian. Debian Policy requires that all
packaged binaries installed in /usr/bin (where I'm installing the command line
utilities in my mapserver-utils package) must have an accompanying manpage of
some kind. Is anyone in upstream willing to write these for me, or will I have
to make something up on my own?

See http://www.debian.org/doc/debian-policy/ch-docs.html#s13.1

Change History

06/30/03 23:48:54 changed by dmorissette

  • version changed from 3.6 to 4.1.
  • component changed from Command Line Utilties to MapServer Documentation.
Paul, perhaps you should raise this issue on the mapserver-docs list (not sure 
how much response you would get though).

Let's keep this as a wishlist item for 4.1.

06/30/03 23:52:50 changed by dmorissette

  • cc set to morissette@dmsolutions.ca.

01/24/08 11:52:33 changed by tomkralidis

  • cc set to dmorissette, tomkralidis.

We would have to create man pages, as well as a make target to install these and the command line tools, etc. into /usr/local or --prefix sort of thing. Is this still desirable?

01/28/08 17:09:26 changed by sdlime

  • description changed.

Looks like GDAL uses Doxygen for its command-line programs. Perhaps we could emulate that approach?

Steve

01/28/08 19:10:21 changed by tomkralidis

  • cc changed from dmorissette, tomkralidis to dmorissette, tomkralidis, warmerdam.

cc'ing Frank, as his doxygen adventures in gdal may be of help

03/20/08 14:00:38 changed by jmckenna

Can this be automated at all? Or are you all looking for someone like me to make these man pages? Need feedback.

03/24/08 16:46:10 changed by tomkralidis

I spoke to Frank about this over irc awhile a couple of months ago, and seem to remember us discussing just creating the man pages manually, and have them included in a build target somehow.

Having said this, we would need to:

  • figure out what utils we want to document for man
  • come up with a way of syncing these with any other places (website?) they are documented.

Comments?