Opened 22 years ago
Closed 14 years ago
#160 closed enhancement (wontfix)
[RFE] man pages to go along with fine command line utilities
Reported by: | Owned by: | sdlime | |
---|---|---|---|
Priority: | high | Milestone: | |
Component: | Documentation - MapServer | Version: | 4.1 |
Severity: | minor | Keywords: | |
Cc: | dmorissette, tomkralidis, warmerdam |
Description (last modified by )
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 (8)
comment:1 by , 21 years ago
Component: | Command Line Utilties → MapServer Documentation |
---|---|
Version: | 3.6 → 4.1 |
comment:2 by , 21 years ago
Cc: | added |
---|
comment:3 by , 16 years ago
Cc: | added |
---|
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?
comment:4 by , 16 years ago
Description: | modified (diff) |
---|
Looks like GDAL uses Doxygen for its command-line programs. Perhaps we could emulate that approach?
Steve
comment:5 by , 16 years ago
Cc: | added |
---|
cc'ing Frank, as his doxygen adventures in gdal may be of help
comment:6 by , 16 years ago
Can this be automated at all? Or are you all looking for someone like me to make these man pages? Need feedback.
comment:7 by , 16 years ago
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?