Opened 6 years ago

Last modified 3 years ago

#3769 new feature request

Add manpages for programs installed alongside ghc

Reported by: Minimiscience Owned by:
Priority: normal Milestone:
Component: Documentation Version: 6.12.1
Keywords: manpage documentation manpages Cc: mail@…
Operating System: Unknown/Multiple Architecture: Unknown/Multiple
Type of failure: Documentation bug Test Case:
Blocked By: Blocking:
Related Tickets: Differential Revisions:

Description (last modified by igloo)

The following programs installed with GHC (specifically, using the Mac OS X installer, though I suspect this applies to all platforms) do not have manpages:

  • ghc-pkg
  • ghci (Technically, its manpage is the same as ghc's, but there's no ghci.1 symlink to ghc.1, so man ghci fails to find anything.)
  • haddock
  • hp2ps
  • hpc
  • hsc2hs
  • runghc
  • runhaskell

I think that's all of them.

I realize that not all of these programs (e.g., haddock) are truly part of GHC, but the ones that are still need manpages. If the problem is that writing *roff is hard, and you don't mind mooching off other languages, might I refer you to POD/pod2man?

Change History (3)

comment:1 Changed 6 years ago by igloo

  • Description modified (diff)

comment:2 follow-up: Changed 6 years ago by igloo

  • Milestone set to _|_

The real problem is adding the man pages in a way that doesn't significantly increase the maintenance burden.

comment:3 in reply to: ↑ 2 Changed 3 years ago by nomeata

  • Cc mail@… added

Replying to igloo:

The real problem is adding the man pages in a way that doesn't significantly increase the maintenance burden.

How about including it in the docbook documentation and extracting them from there? This is what I do with arbtt, http://darcs.nomeata.de/arbtt/doc/users_guide/arbtt-stats.html is both part of the users guide and extracted to a proper manpage.

Note: See TracTickets for help on using tickets.