Skip to content

Add man page#77

Open
mattmahn wants to merge 3 commits intokamranahmedse:masterfrom
mattmahn:manpage
Open

Add man page#77
mattmahn wants to merge 3 commits intokamranahmedse:masterfrom
mattmahn:manpage

Conversation

@mattmahn
Copy link

@mattmahn mattmahn commented Jun 4, 2017

I've written a man page for git-standup in AsciiDoc, just like all the other Git man pages. This completes #68; all of the following open the man page:

  • man -l ./git-standup.1.gz
  • git help standup
  • git standup --help
    man git standup
  • man git-standup

I've also done my best to abide by the style guide in man-pages(7).

Note: you'll need the asciidoc package for the a2x command to convert the file.

All commands should really have a manula page to describe all their
functionality.

http://asciidoc.org
@z0rc
Copy link
Contributor

z0rc commented Jan 15, 2018

That's nice, but probably a2x dependency is too heavy just for generating man page, while rest of the project is bash script. I recommend maintaining regular man page. It isn't that easy formatted like asciidoc, but still doable. Check out git-extras pages.

Requiring a2x as a dependency is too heavy, considering the rest of the project
is just shell script.  The AsciiDoc documented has  been replaced with
a hand-written groff manual page.
@mattmahn
Copy link
Author

I thought a2x might be a bit much.

I've hand-wrote it now, but I seem to have written such that it doesn't disaply right on macOS/BSD. So I guess I'll be fixing that later...

@kamranahmedse kamranahmedse force-pushed the master branch 2 times, most recently from 4f77abe to fcc0cb3 Compare February 27, 2018 23:07
@guillemglez
Copy link

How come this was never merged? Would it be worth trying to rebase these changes and resubmit?

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants