ndmitchell/shake

RFE: add a manpage for shake

Open

#106 创建于 2014年4月11日

在 GitHub 查看
 (2 评论) (0 反应) (0 负责人)Haskell (631 star) (108 fork)batch import
help wanted

描述

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.

贡献者指南

技术栈
无
领域
documentation
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
basic knowledge of pandocfamiliarity with markdownunderstanding of shake's build system
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
80
研究方向
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).