зеркало из https://github.com/mislav/hub.git
update manpage & readme tweaks. don't suggest to uninstall the "git-hub" gem
If users keep the gem installed, they have a chance to be notified of updates and they can refresh their standalone script. Also, executables in ~/bin should have precedence over gem executables, so no need to uninstall.
This commit is contained in:
Родитель
231366d1b9
Коммит
21225f8663
22
README.md
22
README.md
|
@ -36,12 +36,16 @@ Install
|
||||||
Assuming `~/bin/` is in your `$PATH`, you're ready to roll:
|
Assuming `~/bin/` is in your `$PATH`, you're ready to roll:
|
||||||
|
|
||||||
$ hub version
|
$ hub version
|
||||||
git version 1.6.4.2
|
git version 1.7.0.4
|
||||||
hub version 0.3.2
|
hub version 1.1.0
|
||||||
|
|
||||||
### Homebrew
|
### Homebrew
|
||||||
|
|
||||||
brew install hub
|
$ brew install hub
|
||||||
|
$ which hub
|
||||||
|
/usr/local/bin/hub
|
||||||
|
$ hub version
|
||||||
|
...
|
||||||
|
|
||||||
### RubyGems
|
### RubyGems
|
||||||
|
|
||||||
|
@ -49,18 +53,20 @@ Though not recommended, `hub` can also be installed as a RubyGem:
|
||||||
|
|
||||||
$ gem install git-hub
|
$ gem install git-hub
|
||||||
|
|
||||||
(Yes, the gem name is `git-hub`.)
|
Yes, the gem name is "git-hub".
|
||||||
|
|
||||||
(It's not recommended because of the RubyGems startup time. See [this
|
(It's not recommended for casual use because of the RubyGems startup
|
||||||
gist][speed] for information.)
|
time. See [this gist][speed] for information.)
|
||||||
|
|
||||||
### Standalone via RubyGems
|
### Standalone via RubyGems
|
||||||
|
|
||||||
Yes, the gem name is still `git-hub`:
|
Yes, the gem name is still "git-hub":
|
||||||
|
|
||||||
$ gem install git-hub
|
$ gem install git-hub
|
||||||
$ hub hub standalone > ~/bin/hub && chmod 755 ~/bin/hub
|
$ hub hub standalone > ~/bin/hub && chmod 755 ~/bin/hub
|
||||||
$ gem uninstall git-hub
|
|
||||||
|
This installs a standalone version which doesn't require RubyGems to
|
||||||
|
run.
|
||||||
|
|
||||||
### Source
|
### Source
|
||||||
|
|
||||||
|
|
19
man/hub.1
19
man/hub.1
|
@ -25,14 +25,17 @@
|
||||||
\fBgit push\fR \fIREMOTE\-1\fR,\fIREMOTE\-2\fR,...,\fIREMOTE\-N\fR \fIREF\fR
|
\fBgit push\fR \fIREMOTE\-1\fR,\fIREMOTE\-2\fR,...,\fIREMOTE\-N\fR \fIREF\fR
|
||||||
.
|
.
|
||||||
.br
|
.br
|
||||||
\fBgit fork\fR
|
\fBgit browse\fR [\fB\-p\fR] [\fB\-u\fR] [[\fIUSER\fR\fB/\fR]\fIREPOSITORY\fR] [SUBPAGE]
|
||||||
.
|
.
|
||||||
.br
|
.br
|
||||||
\fBgit browse\fR [\fB\-p\fR] [\fIUSER\fR/]\fIREPOSITORY\fR
|
\fBgit compare\fR [\fB\-p\fR] [\fB\-u\fR] [\fIUSER\fR] [\fISTART\fR...]\fIEND\fR
|
||||||
.
|
.
|
||||||
.br
|
.br
|
||||||
\fBgit submodule add\fR [\fB\-p\fR] \fIOPTIONS\fR [\fIUSER\fR/]\fIREPOSITORY\fR \fIDIRECTORY\fR
|
\fBgit submodule add\fR [\fB\-p\fR] \fIOPTIONS\fR [\fIUSER\fR/]\fIREPOSITORY\fR \fIDIRECTORY\fR
|
||||||
.
|
.
|
||||||
|
.br
|
||||||
|
\fBgit fork\fR [\fB\-\-no\-remote\fR]
|
||||||
|
.
|
||||||
.SH "DESCRIPTION"
|
.SH "DESCRIPTION"
|
||||||
\fBhub\fR enhances various \fBgit\fR commands with GitHub remote expansion. The
|
\fBhub\fR enhances various \fBgit\fR commands with GitHub remote expansion. The
|
||||||
alias command displays information on configuring your environment:
|
alias command displays information on configuring your environment:
|
||||||
|
@ -70,12 +73,6 @@ Push \fIREF\fR to each of \fIREMOTE\-1\fR through \fIREMOTE\-N\fR by executing
|
||||||
multiple \fBgit push\fR commands.
|
multiple \fBgit push\fR commands.
|
||||||
.
|
.
|
||||||
.TP
|
.TP
|
||||||
\fBgit fork\fR
|
|
||||||
Forks the original repo on GitHub and adds the new remote under your
|
|
||||||
username. It requires your GitHub login and token to be present. See
|
|
||||||
CONFIGURATION below.
|
|
||||||
.
|
|
||||||
.TP
|
|
||||||
\fBgit browse\fR [\fB\-p\fR] [\fB\-u\fR] [[\fIUSER\fR\fB/\fR]\fIREPOSITORY\fR] [SUBPAGE]
|
\fBgit browse\fR [\fB\-p\fR] [\fB\-u\fR] [[\fIUSER\fR\fB/\fR]\fIREPOSITORY\fR] [SUBPAGE]
|
||||||
Open repository's GitHub page in the system's default web browser
|
Open repository's GitHub page in the system's default web browser
|
||||||
using \fBopen(1)\fR or the \fBBROWSER\fR env variable. Use \fB\-p\fR to open a
|
using \fBopen(1)\fR or the \fBBROWSER\fR env variable. Use \fB\-p\fR to open a
|
||||||
|
@ -98,9 +95,9 @@ your GitHub login. With \fB\-p\fR, use private remote
|
||||||
.
|
.
|
||||||
.TP
|
.TP
|
||||||
\fBgit fork\fR [\fB\-\-no\-remote\fR]
|
\fBgit fork\fR [\fB\-\-no\-remote\fR]
|
||||||
Forks the original project (as specified in "origin" remote) on GitHub
|
Forks the original project (referenced by "origin" remote) on GitHub and
|
||||||
and adds a new remote named \fIUSER\fR referencing the newly created repo.
|
adds a new remote for it under your username. Requires \fBgithub.token\fR to
|
||||||
Requires \fBgithub.token\fR to be set (see CONFIGURATION).
|
be set (see CONFIGURATION).
|
||||||
.
|
.
|
||||||
.TP
|
.TP
|
||||||
\fBgit help\fR
|
\fBgit help\fR
|
||||||
|
|
|
@ -74,9 +74,10 @@
|
||||||
<code>git clone</code> [<code>-p</code>] <var>OPTIONS</var> [<var>USER</var>/]<var>REPOSITORY</var> <var>DIRECTORY</var><br />
|
<code>git clone</code> [<code>-p</code>] <var>OPTIONS</var> [<var>USER</var>/]<var>REPOSITORY</var> <var>DIRECTORY</var><br />
|
||||||
<code>git remote add</code> [<code>-p</code>] <var>OPTIONS</var> <var>USER</var>[/<var>REPOSITORY</var>]<br />
|
<code>git remote add</code> [<code>-p</code>] <var>OPTIONS</var> <var>USER</var>[/<var>REPOSITORY</var>]<br />
|
||||||
<code>git push</code> <var>REMOTE-1</var>,<var>REMOTE-2</var>,...,<var>REMOTE-N</var> <var>REF</var><br />
|
<code>git push</code> <var>REMOTE-1</var>,<var>REMOTE-2</var>,...,<var>REMOTE-N</var> <var>REF</var><br />
|
||||||
<code>git fork</code><br />
|
<code>git browse</code> [<code>-p</code>] [<code>-u</code>] [[<var>USER</var><code>/</code>]<var>REPOSITORY</var>] [SUBPAGE]<br />
|
||||||
<code>git browse</code> [<code>-p</code>] [<var>USER</var>/]<var>REPOSITORY</var><br />
|
<code>git compare</code> [<code>-p</code>] [<code>-u</code>] [<var>USER</var>] [<var>START</var>...]<var>END</var><br />
|
||||||
<code>git submodule add</code> [<code>-p</code>] <var>OPTIONS</var> [<var>USER</var>/]<var>REPOSITORY</var> <var>DIRECTORY</var></p>
|
<code>git submodule add</code> [<code>-p</code>] <var>OPTIONS</var> [<var>USER</var>/]<var>REPOSITORY</var> <var>DIRECTORY</var><br />
|
||||||
|
<code>git fork</code> [<code>--no-remote</code>]</p>
|
||||||
|
|
||||||
<h2>DESCRIPTION</h2>
|
<h2>DESCRIPTION</h2>
|
||||||
|
|
||||||
|
@ -102,9 +103,6 @@ current working directory is used. With <code>-p</code>, use private remote
|
||||||
then uses your GitHub login.</p></dd>
|
then uses your GitHub login.</p></dd>
|
||||||
<dt><code>git push</code> <var>REMOTE-1</var>,<var>REMOTE-2</var>,...,<var>REMOTE-N</var> <var>REF</var></dt><dd><p>Push <var>REF</var> to each of <var>REMOTE-1</var> through <var>REMOTE-N</var> by executing
|
<dt><code>git push</code> <var>REMOTE-1</var>,<var>REMOTE-2</var>,...,<var>REMOTE-N</var> <var>REF</var></dt><dd><p>Push <var>REF</var> to each of <var>REMOTE-1</var> through <var>REMOTE-N</var> by executing
|
||||||
multiple <code>git push</code> commands.</p></dd>
|
multiple <code>git push</code> commands.</p></dd>
|
||||||
<dt><code>git fork</code></dt><dd><p>Forks the original repo on GitHub and adds the new remote under your
|
|
||||||
username. It requires your GitHub login and token to be present. See
|
|
||||||
CONFIGURATION below.</p></dd>
|
|
||||||
<dt><code>git browse</code> [<code>-p</code>] [<code>-u</code>] [[<var>USER</var><code>/</code>]<var>REPOSITORY</var>] [SUBPAGE]</dt><dd><p>Open repository's GitHub page in the system's default web browser
|
<dt><code>git browse</code> [<code>-p</code>] [<code>-u</code>] [[<var>USER</var><code>/</code>]<var>REPOSITORY</var>] [SUBPAGE]</dt><dd><p>Open repository's GitHub page in the system's default web browser
|
||||||
using <code>open(1)</code> or the <code>BROWSER</code> env variable. Use <code>-p</code> to open a
|
using <code>open(1)</code> or the <code>BROWSER</code> env variable. Use <code>-p</code> to open a
|
||||||
page with https. If the repository isn't specified, <code>browse</code> opens
|
page with https. If the repository isn't specified, <code>browse</code> opens
|
||||||
|
@ -119,9 +117,9 @@ compare against the base branch (the default is "master").</p></dd>
|
||||||
<var>DIRECTORY</var> as with git-submodule(1). When <var>USER</var>/ is omitted, assumes
|
<var>DIRECTORY</var> as with git-submodule(1). When <var>USER</var>/ is omitted, assumes
|
||||||
your GitHub login. With <code>-p</code>, use private remote
|
your GitHub login. With <code>-p</code>, use private remote
|
||||||
"git@github.com:<var>USER</var>/<var>REPOSITORY</var>.git".</p></dd>
|
"git@github.com:<var>USER</var>/<var>REPOSITORY</var>.git".</p></dd>
|
||||||
<dt><code>git fork</code> [<code>--no-remote</code>]</dt><dd><p>Forks the original project (as specified in "origin" remote) on GitHub
|
<dt><code>git fork</code> [<code>--no-remote</code>]</dt><dd><p>Forks the original project (referenced by "origin" remote) on GitHub and
|
||||||
and adds a new remote named <var>USER</var> referencing the newly created repo.
|
adds a new remote for it under your username. Requires <code>github.token</code> to
|
||||||
Requires <code>github.token</code> to be set (see CONFIGURATION).</p></dd>
|
be set (see CONFIGURATION).</p></dd>
|
||||||
<dt><code>git help</code></dt><dd><p>Display enhanced git-help(1).</p></dd>
|
<dt><code>git help</code></dt><dd><p>Display enhanced git-help(1).</p></dd>
|
||||||
</dl>
|
</dl>
|
||||||
|
|
||||||
|
|
|
@ -10,9 +10,10 @@ hub(1) -- git + hub = github
|
||||||
`git clone` [`-p`] <OPTIONS> [<USER>/]<REPOSITORY> <DIRECTORY>
|
`git clone` [`-p`] <OPTIONS> [<USER>/]<REPOSITORY> <DIRECTORY>
|
||||||
`git remote add` [`-p`] <OPTIONS> <USER>[/<REPOSITORY>]
|
`git remote add` [`-p`] <OPTIONS> <USER>[/<REPOSITORY>]
|
||||||
`git push` <REMOTE-1>,<REMOTE-2>,...,<REMOTE-N> <REF>
|
`git push` <REMOTE-1>,<REMOTE-2>,...,<REMOTE-N> <REF>
|
||||||
`git fork`
|
`git browse` [`-p`] [`-u`] [[<USER>`/`]<REPOSITORY>] [SUBPAGE]
|
||||||
`git browse` [`-p`] [<USER>/]<REPOSITORY>
|
`git compare` [`-p`] [`-u`] [<USER>] [<START>...]<END>
|
||||||
`git submodule add` [`-p`] <OPTIONS> [<USER>/]<REPOSITORY> <DIRECTORY>
|
`git submodule add` [`-p`] <OPTIONS> [<USER>/]<REPOSITORY> <DIRECTORY>
|
||||||
|
`git fork` [`--no-remote`]
|
||||||
|
|
||||||
## DESCRIPTION
|
## DESCRIPTION
|
||||||
|
|
||||||
|
@ -47,11 +48,6 @@ alias command displays information on configuring your environment:
|
||||||
Push <REF> to each of <REMOTE-1> through <REMOTE-N> by executing
|
Push <REF> to each of <REMOTE-1> through <REMOTE-N> by executing
|
||||||
multiple `git push` commands.
|
multiple `git push` commands.
|
||||||
|
|
||||||
* `git fork`:
|
|
||||||
Forks the original repo on GitHub and adds the new remote under your
|
|
||||||
username. It requires your GitHub login and token to be present. See
|
|
||||||
CONFIGURATION below.
|
|
||||||
|
|
||||||
* `git browse` [`-p`] [`-u`] [[<USER>`/`]<REPOSITORY>] [SUBPAGE]:
|
* `git browse` [`-p`] [`-u`] [[<USER>`/`]<REPOSITORY>] [SUBPAGE]:
|
||||||
Open repository's GitHub page in the system's default web browser
|
Open repository's GitHub page in the system's default web browser
|
||||||
using `open(1)` or the `BROWSER` env variable. Use `-p` to open a
|
using `open(1)` or the `BROWSER` env variable. Use `-p` to open a
|
||||||
|
@ -73,9 +69,9 @@ alias command displays information on configuring your environment:
|
||||||
"git@github.com:<USER>/<REPOSITORY>.git".
|
"git@github.com:<USER>/<REPOSITORY>.git".
|
||||||
|
|
||||||
* `git fork` [`--no-remote`]:
|
* `git fork` [`--no-remote`]:
|
||||||
Forks the original project (as specified in "origin" remote) on GitHub
|
Forks the original project (referenced by "origin" remote) on GitHub and
|
||||||
and adds a new remote named <USER> referencing the newly created repo.
|
adds a new remote for it under your username. Requires `github.token` to
|
||||||
Requires `github.token` to be set (see CONFIGURATION).
|
be set (see CONFIGURATION).
|
||||||
|
|
||||||
* `git help`:
|
* `git help`:
|
||||||
Display enhanced git-help(1).
|
Display enhanced git-help(1).
|
||||||
|
|
Загрузка…
Ссылка в новой задаче