hledger should have a man page #282

Closed
simonmichael opened this Issue Aug 27, 2015 · 1 comment

Projects

None yet

1 participant

@simonmichael
Owner

Unix users expect to be able to find out what they need by doing "man hledger" or "man hledger-CMD", without having to go to online.

It would save work if some or all of the existing user manual can be crammed into man format, though it's not organized like a typical man page.

@simonmichael simonmichael modified the milestone: 1.0, 0.27 Sep 2, 2015
@simonmichael simonmichael modified the milestone: 0.27, 1.0 Sep 27, 2015
@simonmichael simonmichael added a commit that referenced this issue Oct 20, 2015
@simonmichael doc: generate man pages for each package (#282)
There are now six man pages, one for each main executable and file
format, generated from markdown by the mighty pandoc. They are basically
the content of the user manual, split up and moved into the appropriate
package directory.  I've also committed the generated man files.

The man pages' markdown source (hledger/hledger.1.md,
hledger-lib/hledger_journal.5.md etc.) are now the master documentation
files. The plan is to concatenate them (with a little munging) to form
the all-in-one user manual for the website, at release time.  This also
separates the hledger.org user manual from the latest doc commits, which
should simplify website management.
191c2e5
@simonmichael
Owner

Resolved. We must be getting close to 1.0!

Follow-on task: #292.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment