search

grisu / gricli

Grisu commandline client
7 stars 2 forks source link

man page for griclish #40

Closed sina-masoud-ansari closed 13 years ago

sina-masoud-ansari commented 13 years ago

I remember someone mentioned this at a recent meeting.

ndjones commented 13 years ago

I think markus just made this easier: https://github.com/makkus/gricli/blob/textDoc/src/main/resources/help.properties

Not sure how to link this into the commit comments or some other way of linking this all together..

makkus commented 13 years ago

Created a script to generate a man page from

https://github.com/grisu/gricli/blob/develop/man/manpage.md

and

https://github.com/grisu/gricli/blob/develop/src/main/resources/help.properties

Could also use examples.properties if we feel like it.

Script to create manpage requires pandoc (http://johnmacfarlane.net/pandoc/index.html) and can be found here: https://github.com/grisu/gricli/blob/develop/man/build-man.sh

Will add a jenkins job later on to generate it automatically as well...

Please help and improve help.properties and manpage.md.

makkus commented 13 years ago

Not quite ready yet, manpage doesn't distinguish between commands and arguments of commands, need to add support for that.

On the other hand, I added the automated creation of a Usage file in markdown mode which we can refer to online: https://github.com/grisu/gricli/blob/develop/USAGE.md

makkus commented 13 years ago

Broken now after changing the way help works. Will fix, although I don't think it's that important anymore since we've got a fairly comprehensive in-app help system in gricli now...

makkus commented 13 years ago

Moved to this milestone, needs fixing...