ndmitchell/shake

RFE: add a manpage for shake

Open

#106 opened on Apr 11, 2014

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Haskell (631 stars) (108 forks)batch import
help wanted

Description

I know there is documention including a manual and --help output, but distros like Debian and Fedora like to have manpage for installed programs.

Is it possible to add a manpage shake (1) to the distribution? I think pandoc is able to generate them from markdown.

If the manpage could be generated from "shake --help" somehow perhaps it would be less work to keep in sync.

Contributor guide

Tech stack
None
Domain
documentation
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic knowledge of pandocfamiliarity with markdownunderstanding of shake's build system
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
First, check if there is already a manpage directory or a build rule for documentation in the repository (e.g., in Shakefile.hs or Makefile). The issue suggests using pandoc to generate a manpage from markdown or from help output. Investigate the existing help output and check if there is a markdown version of the manual. Then, propose adding a new target in the build system that runs pandoc to convert either the markdown manual or the help output into a manpage format. Consider adding the manpage as part of the installation process (e.g., via cabal or stack).