Merge remote branch 'rtomayko/manpage'

Rakefile

@@ -22,6 +22,11 @@ task :standalone => [ :test, :load_hub ] do
   Hub::Standalone.save('hub')
 end
 
+desc "Build hub manual"
+task 'man' do
+  sh "ron -br5 -m --organization=DEFUNKT --manual='Git Manual' man/*.ron"
+end
+
 task :load_hub do
   $LOAD_PATH.unshift 'lib'
   require 'hub'

man/hub.1

+.\" generated with Ron/v0.3
+.\" http://github.com/rtomayko/ron/
+.
+.TH "HUB" "1" "December 2009" "DEFUNKT" "Git Manual"
+.
+.SH "NAME"
+\fBhub\fR \-\- git + hub = github
+.
+.SH "SYNOPSIS"
+\fBhub\fR \fICOMMAND\fR \fIOPTIONS\fR
+.
+.br
+\fBhub alias\fR [\fB\-s\fR] \fISHELL\fR
+.
+.P
+\fBgit init \-g\fR \fIOPTIONS\fR
+.
+.br
+\fBgit clone\fR [\fB\-p\fR] \fIOPTIONS\fR \fIUSER\fR[/\fIREPOSITORY\fR] \fIDIRECTORY\fR
+.
+.br
+\fBgit remote add\fR [\fB\-p\fR] \fIOPTIONS\fR \fIUSER\fR[/\fIREPOSITORY\fR]
+.
+.SH "DESCRIPTION"
+\fBhub\fR enhances various \fBgit\fR commands with GitHub remote expansion. The
+alias command displays information on configuring your environment:
+.
+.TP
+\fBhub alias\fR [\fB\-s\fR] \fISHELL\fR 
+Writes shell aliasing code for \fISHELL\fR (bash, sh, zsh, csh) to
+standard output. With the \fB\-s\fR option, the output of this command
+can be evaluated directly within the shell: \fBeval $(hub alias \-s bash)\fR 
+.
+.P
+After configuring the alias, the following commands have superpowers:
+.
+.TP
+\fBgit init\fR \fB\-g\fR \fIOPTIONS\fR 
+Create a git repository as with git\-init(1) and add remote \fBorigin\fR at
+"git@github.com:\fIUSER\fR/\fIREPOSITORY\fR.git"; \fIUSER\fR is your GitHub username and \fIREPOSITORY\fR is the current working directory's basename.
+.
+.TP
+\fBgit clone\fR [\fB\-p\fR] \fIOPTIONS\fR \fIUSER\fR[\fB/\fR\fIREPOSITORY\fR] \fIDIRECTORY\fR 
+Clone repository "git://github.com/\fIUSER\fR/\fIREPOSITORY\fR.git" into \fIDIRECTORY\fR as with git\-clone(1). When /\fIREPOSITORY\fR is omitted, the
+basename of the current working directory is used. With \fB\-p\fR, use private
+remote "git@github.com:\fIUSER\fR/\fIREPOSITORY\fR.git".
+.
+.TP
+\fBgit remote add\fR [\fB\-p\fR] \fIOPTIONS\fR \fIUSER\fR[\fB/\fR\fIrepository\fR]
+Add remote "git://github.com/\fIUSER\fR/\fIREPOSITORY\fR.git" as with
+git\-remote(1). When /\fIREPOSITORY\fR is omitted, the basename of the
+current working directory is used. With \fB\-p\fR, use private remote
+"git@github.com:\fIUSER\fR/\fIREPOSITORY\fR.git".
+.
+.TP
+\fBgit help\fR
+Display enhanced git\-help(1).
+.
+.SH "CONFIGURATION"
+Use git\-config(1) to display the currently configured GitHub username:
+.
+.IP "" 4
+.
+.nf
+
+$ git config \-\-global github.user 
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Or, set the GitHub username with:
+.
+.IP "" 4
+.
+.nf
+
+$ git config \-\-global github.user <username> 
+.
+.fi
+.
+.IP "" 0
+.
+.P
+See \fIhttp://github.com/guides/local\-github\-config\fR for more information.
+.
+.SH "BUGS"
+\fIhttp://github.com/defunkt/hub/issues\fR
+.
+.SH "AUTHOR"
+Chris Wanstrath :: chris@ozmm.org :: @defunkt
+.
+.SH "SEE ALSO"
+git(1), git\-clone(1), git\-remote(1), git\-init(1),\fIhttp://github.com\fR, \fIhttp://github.com/defunkt/hub\fR

man/hub.1.ron

+hub(1) -- git + hub = github
+============================
+
+## SYNOPSIS
+
+`hub` <COMMAND> <OPTIONS>  
+`hub alias` [`-s`] <SHELL>
+
+`git init -g` <OPTIONS>  
+`git clone` [`-p`] <OPTIONS> <USER>[/<REPOSITORY>] <DIRECTORY>  
+`git remote add` [`-p`] <OPTIONS> <USER>[/<REPOSITORY>]
+
+## DESCRIPTION
+
+`hub` enhances various `git` commands with GitHub remote expansion. The
+alias command displays information on configuring your environment:
+
+  * `hub alias` [`-s`] <SHELL>:
+    Writes shell aliasing code for <SHELL> (`bash`, `sh`, `zsh`,
+    `csh`) to standard output. With the `-s` option, the output of
+    this command can be evaluated directly within the shell:
+    `eval $(hub alias -s bash)`
+
+After configuring the alias, the following commands have superpowers:
+
+  * `git init` `-g` <OPTIONS>:
+    Create a git repository as with git-init(1) and add remote `origin` at
+    "git@github.com:<USER>/<REPOSITORY>.git"; <USER> is your GitHub username and
+    <REPOSITORY> is the current working directory's basename.
+
+  * `git clone` [`-p`] <OPTIONS> <USER>[`/`<REPOSITORY>] <DIRECTORY>:
+    Clone repository "git://github.com/<USER>/<REPOSITORY>.git" into
+    <DIRECTORY> as with git-clone(1). When /<REPOSITORY> is omitted, the
+    basename of the current working directory is used. With `-p`, use private
+    remote "git@github.com:<USER>/<REPOSITORY>.git".
+
+  * `git remote add` [`-p`] <OPTIONS> <USER>[`/`<REPOSITORY>]:
+    Add remote "git://github.com/<USER>/<REPOSITORY>.git" as with
+    git-remote(1). When /<REPOSITORY> is omitted, the basename of the
+    current working directory is used. With `-p`, use private remote
+    "git@github.com:<USER>/<REPOSITORY>.git".
+
+  * `git help`:
+    Display enhanced git-help(1).
+
+## CONFIGURATION
+
+Use git-config(1) to display the currently configured GitHub username:
+
+    $ git config --global github.user
+
+Or, set the GitHub username with:
+
+    $ git config --global github.user <username>
+
+See <http://github.com/guides/local-github-config> for more information.
+
+## BUGS
+
+<http://github.com/defunkt/hub/issues>
+
+## AUTHOR
+
+Chris Wanstrath :: chris@ozmm.org :: @defunkt
+
+## SEE ALSO
+
+git(1), git-clone(1), git-remote(1), git-init(1),
+<http://github.com>,
+<http://github.com/defunkt/hub>