From 4b14dea5ce61ec0bfbbce83059cb6c9835ee02de Mon Sep 17 00:00:00 2001 From: Chris Wanstrath Date: Thu, 10 Dec 2009 14:06:53 -0800 Subject: [PATCH] update generated manpage --- man/hub.1 | 21 ++----- man/hub.1.html | 156 +++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 162 insertions(+), 15 deletions(-) create mode 100644 man/hub.1.html diff --git a/man/hub.1 b/man/hub.1 index 08099924..b186277f 100644 --- a/man/hub.1 +++ b/man/hub.1 @@ -7,19 +7,10 @@ \fBhub\fR \-\- git + hub = github . .SH "SYNOPSIS" -\fBhub\fR \fICOMMAND\fR \fIOPTIONS\fR -. -.br -\fBhub alias\fR [\fB\-s\fR] \fISHELL\fR +\fBhub\fR \fICOMMAND\fR \fIOPTIONS\fR \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] +\fBgit init \-g\fR \fIOPTIONS\fR \fBgit clone\fR [\fB\-p\fR] \fIOPTIONS\fR [\fIUSER\fR/]\fIREPOSITORY\fR \fIDIRECTORY\fR \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 @@ -39,10 +30,10 @@ 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". +\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 \fIUSER\fR/ is omitted, assumes +your GitHub login. 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] diff --git a/man/hub.1.html b/man/hub.1.html new file mode 100644 index 00000000..ef9384fb --- /dev/null +++ b/man/hub.1.html @@ -0,0 +1,156 @@ + + + + + + hub(1) -- git + hub = github + + + +
+ +

hub(1)

+ +
    +
  1. hub(1)
    2. +
  2. Git Manual
    3. +
  3. hub(1)
    4. +
+ +

NAME

+

hub -- 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 USER/ is omitted, assumes +your GitHub login. 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

+ +
    +
  1. DEFUNKT
    2. +
  2. December 2009
    3. +
  3. hub(1)
    4. +
+ +
+ + -- GitLab