git-hub 1.4.0 → 1.4.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/lib/hub/version.rb +1 -1
- data/man/hub.1 +56 -26
- data/man/hub.1.html +57 -26
- metadata +2 -2
data/lib/hub/version.rb
CHANGED
data/man/hub.1
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
.\" generated with Ronn/v0.5
|
|
2
2
|
.\" http://github.com/rtomayko/ronn/
|
|
3
3
|
.
|
|
4
|
-
.TH "HUB" "1" "
|
|
4
|
+
.TH "HUB" "1" "August 2010" "DEFUNKT" "Git Manual"
|
|
5
5
|
.
|
|
6
6
|
.SH "NAME"
|
|
7
7
|
\fBhub\fR \- git + hub = github
|
|
@@ -16,12 +16,15 @@
|
|
|
16
16
|
\fBgit init \-g\fR \fIOPTIONS\fR
|
|
17
17
|
.
|
|
18
18
|
.br
|
|
19
|
-
\fBgit clone\fR [\fB\-p\fR] \fIOPTIONS\fR [\fIUSER\fR/]\fIREPOSITORY\fR \fIDIRECTORY\fR
|
|
19
|
+
\fBgit create\fR [\fB\-p\fR] [\fB\-d <DESCRIPTION>\fR] [\fB\-h <HOMEPAGE>\fR]: \fBgit clone\fR [\fB\-p\fR] \fIOPTIONS\fR [\fIUSER\fR/]\fIREPOSITORY\fR \fIDIRECTORY\fR
|
|
20
20
|
.
|
|
21
21
|
.br
|
|
22
22
|
\fBgit remote add\fR [\fB\-p\fR] \fIOPTIONS\fR \fIUSER\fR[/\fIREPOSITORY\fR]
|
|
23
23
|
.
|
|
24
24
|
.br
|
|
25
|
+
\fBgit remote set\-url\fR [\fB\-p\fR] \fIOPTIONS\fR \fIREMOTE\-NAME\fR \fIUSER\fR[/\fIREPOSITORY\fR]
|
|
26
|
+
.
|
|
27
|
+
.br
|
|
25
28
|
\fBgit fetch\fR \fIUSER\-1\fR,[\fIUSER\-2\fR,...]
|
|
26
29
|
.
|
|
27
30
|
.br
|
|
@@ -46,52 +49,67 @@
|
|
|
46
49
|
\fBhub\fR enhances various \fBgit\fR commands with GitHub remote expansion. The
|
|
47
50
|
alias command displays information on configuring your environment:
|
|
48
51
|
.
|
|
49
|
-
.
|
|
50
|
-
\fBhub alias\fR [\fB\-s\fR] \fISHELL\fR
|
|
52
|
+
.IP "\(bu" 4
|
|
53
|
+
\fBhub alias\fR [\fB\-s\fR] \fISHELL\fR:
|
|
51
54
|
Writes shell aliasing code for \fISHELL\fR (\fBbash\fR, \fBsh\fR, \fBzsh\fR, \fBcsh\fR) to standard output. With the \fB\-s\fR option, the output of
|
|
52
55
|
this command can be evaluated directly within the shell:
|
|
53
56
|
.
|
|
54
57
|
.br
|
|
55
58
|
\fBeval $(hub alias \-s bash)\fR
|
|
56
59
|
.
|
|
57
|
-
.
|
|
58
|
-
\fBgit init\fR \fB\-g\fR \fIOPTIONS\fR
|
|
60
|
+
.IP "\(bu" 4
|
|
61
|
+
\fBgit init\fR \fB\-g\fR \fIOPTIONS\fR:
|
|
59
62
|
Create a git repository as with git\-init(1) and add remote \fBorigin\fR at
|
|
60
63
|
"git@github.com:\fIUSER\fR/\fIREPOSITORY\fR.git"; \fIUSER\fR is your GitHub username and \fIREPOSITORY\fR is the current working directory's basename.
|
|
61
64
|
.
|
|
62
|
-
.
|
|
63
|
-
\fBgit
|
|
65
|
+
.IP "\(bu" 4
|
|
66
|
+
\fBgit create\fR [\fB\-p\fR] [\fB\-d <DESCRIPTION>\fR] [\fB\-h <HOMEPAGE>\fR]:
|
|
67
|
+
Create a new public github repository from the current git
|
|
68
|
+
repository and add remote \fBorigin\fR at
|
|
69
|
+
"git@github.com:\fIUSER\fR/\fIREPOSITORY\fR.git"; \fIUSER\fR is your GitHub
|
|
70
|
+
username and \fIREPOSITORY\fR is the current working directory's
|
|
71
|
+
basename. With \fB\-p\fR, create a private repository. \fB\-d\fR and \fB\-h\fR
|
|
72
|
+
set the repository's description and homepage, respectively.
|
|
73
|
+
.
|
|
74
|
+
.IP "\(bu" 4
|
|
75
|
+
\fBgit clone\fR [\fB\-p\fR] \fIOPTIONS\fR [\fIUSER\fR\fB/\fR]\fIREPOSITORY\fR \fIDIRECTORY\fR:
|
|
64
76
|
Clone repository "git://github.com/\fIUSER\fR/\fIREPOSITORY\fR.git" into \fIDIRECTORY\fR as with git\-clone(1). When \fIUSER\fR/ is omitted, assumes
|
|
65
77
|
your GitHub login. With \fB\-p\fR, use private remote
|
|
66
78
|
"git@github.com:\fIUSER\fR/\fIREPOSITORY\fR.git".
|
|
67
79
|
.
|
|
68
|
-
.
|
|
69
|
-
\fBgit remote add\fR [\fB\-p\fR] \fIOPTIONS\fR \fIUSER\fR[\fB/\fR\fIREPOSITORY\fR]
|
|
80
|
+
.IP "\(bu" 4
|
|
81
|
+
\fBgit remote add\fR [\fB\-p\fR] \fIOPTIONS\fR \fIUSER\fR[\fB/\fR\fIREPOSITORY\fR]:
|
|
70
82
|
Add remote "git://github.com/\fIUSER\fR/\fIREPOSITORY\fR.git" as with
|
|
71
83
|
git\-remote(1). When /\fIREPOSITORY\fR is omitted, the basename of the
|
|
72
84
|
current working directory is used. With \fB\-p\fR, use private remote
|
|
73
85
|
"git@github.com:\fIUSER\fR/\fIREPOSITORY\fR.git". If \fIUSER\fR is "origin"
|
|
74
86
|
then uses your GitHub login.
|
|
75
87
|
.
|
|
76
|
-
.
|
|
77
|
-
\fBgit
|
|
88
|
+
.IP "\(bu" 4
|
|
89
|
+
\fBgit remote set\-url\fR [\fB\-p\fR] \fIOPTIONS\fR \fIREMOTE\-NAME\fR \fIUSER\fR[/\fIREPOSITORY\fR]
|
|
90
|
+
.
|
|
91
|
+
.br
|
|
92
|
+
Sets the url of remote \fIREMOTE\-NAME\fR using the same rules as \fBgit remote add\fR.
|
|
93
|
+
.
|
|
94
|
+
.IP "\(bu" 4
|
|
95
|
+
\fBgit fetch\fR \fIUSER\-1\fR,[\fIUSER\-2\fR,...]:
|
|
78
96
|
Adds missing remote(s) with \fBgit remote add\fR prior to fetching. New
|
|
79
97
|
remotes are only added if they correspond to valid forks on GitHub.
|
|
80
98
|
.
|
|
81
|
-
.
|
|
82
|
-
\fBgit cherry\-pick\fR \fIGITHUB\-REF\fR
|
|
99
|
+
.IP "\(bu" 4
|
|
100
|
+
\fBgit cherry\-pick\fR \fIGITHUB\-REF\fR:
|
|
83
101
|
Cherry\-pick a commit from a fork using either full URL to the commit
|
|
84
102
|
or GitHub\-flavored Markdown notation, which is \fBuser@sha\fR. If the remote
|
|
85
103
|
doesn't yet exist, it will be added. A \fBgit fetch <user>\fR is issued
|
|
86
104
|
prior to the cherry\-pick attempt.
|
|
87
105
|
.
|
|
88
|
-
.
|
|
89
|
-
\fBgit push\fR \fIREMOTE\-1\fR,\fIREMOTE\-2\fR,...,\fIREMOTE\-N\fR \fIREF\fR
|
|
106
|
+
.IP "\(bu" 4
|
|
107
|
+
\fBgit push\fR \fIREMOTE\-1\fR,\fIREMOTE\-2\fR,...,\fIREMOTE\-N\fR \fIREF\fR:
|
|
90
108
|
Push \fIREF\fR to each of \fIREMOTE\-1\fR through \fIREMOTE\-N\fR by executing
|
|
91
109
|
multiple \fBgit push\fR commands.
|
|
92
110
|
.
|
|
93
|
-
.
|
|
94
|
-
\fBgit browse\fR [\fB\-p\fR] [\fB\-u\fR] [[\fIUSER\fR\fB/\fR]\fIREPOSITORY\fR] [SUBPAGE]
|
|
111
|
+
.IP "\(bu" 4
|
|
112
|
+
\fBgit browse\fR [\fB\-p\fR] [\fB\-u\fR] [[\fIUSER\fR\fB/\fR]\fIREPOSITORY\fR] [SUBPAGE]:
|
|
95
113
|
Open repository's GitHub page in the system's default web browser
|
|
96
114
|
using \fBopen(1)\fR or the \fBBROWSER\fR env variable. Use \fB\-p\fR to open a
|
|
97
115
|
page with https. If the repository isn't specified, \fBbrowse\fR opens
|
|
@@ -99,28 +117,30 @@ the page of the repository found in the current directory. If SUBPAGE
|
|
|
99
117
|
is specified, the browser will open on the specified subpage: one of
|
|
100
118
|
"wiki", "commits", "issues" or other (the default is "tree").
|
|
101
119
|
.
|
|
102
|
-
.
|
|
103
|
-
\fBgit compare\fR [\fB\-p\fR] [\fB\-u\fR] [\fIUSER\fR] [\fISTART\fR...]\fIEND\fR
|
|
120
|
+
.IP "\(bu" 4
|
|
121
|
+
\fBgit compare\fR [\fB\-p\fR] [\fB\-u\fR] [\fIUSER\fR] [\fISTART\fR...]\fIEND\fR:
|
|
104
122
|
Open a GitHub compare view page in the system's default web browser. \fISTART\fR to \fIEND\fR are branch names, tag names, or commit SHA1s specifying
|
|
105
123
|
the range of history to compare. If \fISTART\fR is omitted, GitHub will
|
|
106
124
|
compare against the base branch (the default is "master").
|
|
107
125
|
.
|
|
108
|
-
.
|
|
109
|
-
\fBgit submodule add\fR [\fB\-p\fR] \fIOPTIONS\fR [\fIUSER\fR/]\fIREPOSITORY\fR \fIDIRECTORY\fR
|
|
126
|
+
.IP "\(bu" 4
|
|
127
|
+
\fBgit submodule add\fR [\fB\-p\fR] \fIOPTIONS\fR [\fIUSER\fR/]\fIREPOSITORY\fR \fIDIRECTORY\fR:
|
|
110
128
|
Submodule repository "git://github.com/\fIUSER\fR/\fIREPOSITORY\fR.git" into \fIDIRECTORY\fR as with git\-submodule(1). When \fIUSER\fR/ is omitted, assumes
|
|
111
129
|
your GitHub login. With \fB\-p\fR, use private remote
|
|
112
130
|
"git@github.com:\fIUSER\fR/\fIREPOSITORY\fR.git".
|
|
113
131
|
.
|
|
114
|
-
.
|
|
115
|
-
\fBgit fork\fR [\fB\-\-no\-remote\fR]
|
|
132
|
+
.IP "\(bu" 4
|
|
133
|
+
\fBgit fork\fR [\fB\-\-no\-remote\fR]:
|
|
116
134
|
Forks the original project (referenced by "origin" remote) on GitHub and
|
|
117
135
|
adds a new remote for it under your username. Requires \fBgithub.token\fR to
|
|
118
136
|
be set (see CONFIGURATION).
|
|
119
137
|
.
|
|
120
|
-
.
|
|
121
|
-
\fBgit help\fR
|
|
138
|
+
.IP "\(bu" 4
|
|
139
|
+
\fBgit help\fR:
|
|
122
140
|
Display enhanced git\-help(1).
|
|
123
141
|
.
|
|
142
|
+
.IP "" 0
|
|
143
|
+
.
|
|
124
144
|
.SH "CONFIGURATION"
|
|
125
145
|
Use git\-config(1) to display the currently configured GitHub username:
|
|
126
146
|
.
|
|
@@ -254,6 +274,16 @@ $ git init \-g
|
|
|
254
274
|
.
|
|
255
275
|
.fi
|
|
256
276
|
.
|
|
277
|
+
.SS "git create"
|
|
278
|
+
.
|
|
279
|
+
.nf
|
|
280
|
+
|
|
281
|
+
$ git create
|
|
282
|
+
... hardcore creating action ...
|
|
283
|
+
> git remote add origin git@github.com:YOUR_USER/CURRENT_REPO.git
|
|
284
|
+
.
|
|
285
|
+
.fi
|
|
286
|
+
.
|
|
257
287
|
.SS "git push"
|
|
258
288
|
.
|
|
259
289
|
.nf
|
data/man/hub.1.html
CHANGED
|
@@ -150,8 +150,10 @@
|
|
|
150
150
|
<code>hub alias</code> [<code>-s</code>] <var>SHELL</var></p>
|
|
151
151
|
|
|
152
152
|
<p><code>git init -g</code> <var>OPTIONS</var><br />
|
|
153
|
+
<code>git create</code> [<code>-p</code>] [<code>-d <DESCRIPTION></code>] [<code>-h <HOMEPAGE></code>]:
|
|
153
154
|
<code>git clone</code> [<code>-p</code>] <var>OPTIONS</var> [<var>USER</var>/]<var>REPOSITORY</var> <var>DIRECTORY</var><br />
|
|
154
155
|
<code>git remote add</code> [<code>-p</code>] <var>OPTIONS</var> <var>USER</var>[/<var>REPOSITORY</var>]<br />
|
|
156
|
+
<code>git remote set-url</code> [<code>-p</code>] <var>OPTIONS</var> <var>REMOTE-NAME</var> <var>USER</var>[/<var>REPOSITORY</var>]<br />
|
|
155
157
|
<code>git fetch</code> <var>USER-1</var>,[<var>USER-2</var>,...]<br />
|
|
156
158
|
<code>git cherry-pick</code> <var>GITHUB-REF</var><br />
|
|
157
159
|
<code>git push</code> <var>REMOTE-1</var>,<var>REMOTE-2</var>,...,<var>REMOTE-N</var> <var>REF</var><br />
|
|
@@ -165,50 +167,72 @@
|
|
|
165
167
|
<p><code>hub</code> enhances various <code>git</code> commands with GitHub remote expansion. The
|
|
166
168
|
alias command displays information on configuring your environment:</p>
|
|
167
169
|
|
|
168
|
-
<
|
|
169
|
-
<
|
|
170
|
+
<ul>
|
|
171
|
+
<li><p><code>hub alias</code> [<code>-s</code>] <var>SHELL</var>:
|
|
172
|
+
Writes shell aliasing code for <var>SHELL</var> (<code>bash</code>, <code>sh</code>, <code>zsh</code>,
|
|
170
173
|
<code>csh</code>) to standard output. With the <code>-s</code> option, the output of
|
|
171
174
|
this command can be evaluated directly within the shell:<br />
|
|
172
|
-
<code>eval $(hub alias -s bash)</code></p></
|
|
173
|
-
<
|
|
175
|
+
<code>eval $(hub alias -s bash)</code></p></li>
|
|
176
|
+
<li><p><code>git init</code> <code>-g</code> <var>OPTIONS</var>:
|
|
177
|
+
Create a git repository as with git-init(1) and add remote <code>origin</code> at
|
|
174
178
|
"git@github.com:<var>USER</var>/<var>REPOSITORY</var>.git"; <var>USER</var> is your GitHub username and
|
|
175
|
-
<var>REPOSITORY</var> is the current working directory's basename.</p></
|
|
176
|
-
<
|
|
179
|
+
<var>REPOSITORY</var> is the current working directory's basename.</p></li>
|
|
180
|
+
<li><p><code>git create</code> [<code>-p</code>] [<code>-d <DESCRIPTION></code>] [<code>-h <HOMEPAGE></code>]:
|
|
181
|
+
Create a new public github repository from the current git
|
|
182
|
+
repository and add remote <code>origin</code> at
|
|
183
|
+
"git@github.com:<var>USER</var>/<var>REPOSITORY</var>.git"; <var>USER</var> is your GitHub
|
|
184
|
+
username and <var>REPOSITORY</var> is the current working directory's
|
|
185
|
+
basename. With <code>-p</code>, create a private repository. <code>-d</code> and <code>-h</code>
|
|
186
|
+
set the repository's description and homepage, respectively.</p></li>
|
|
187
|
+
<li><p><code>git clone</code> [<code>-p</code>] <var>OPTIONS</var> [<var>USER</var><code>/</code>]<var>REPOSITORY</var> <var>DIRECTORY</var>:
|
|
188
|
+
Clone repository "git://github.com/<var>USER</var>/<var>REPOSITORY</var>.git" into
|
|
177
189
|
<var>DIRECTORY</var> as with git-clone(1). When <var>USER</var>/ is omitted, assumes
|
|
178
190
|
your GitHub login. With <code>-p</code>, use private remote
|
|
179
|
-
"git@github.com:<var>USER</var>/<var>REPOSITORY</var>.git".</p></
|
|
180
|
-
<
|
|
191
|
+
"git@github.com:<var>USER</var>/<var>REPOSITORY</var>.git".</p></li>
|
|
192
|
+
<li><p><code>git remote add</code> [<code>-p</code>] <var>OPTIONS</var> <var>USER</var>[<code>/</code><var>REPOSITORY</var>]:
|
|
193
|
+
Add remote "git://github.com/<var>USER</var>/<var>REPOSITORY</var>.git" as with
|
|
181
194
|
git-remote(1). When /<var>REPOSITORY</var> is omitted, the basename of the
|
|
182
195
|
current working directory is used. With <code>-p</code>, use private remote
|
|
183
196
|
"git@github.com:<var>USER</var>/<var>REPOSITORY</var>.git". If <var>USER</var> is "origin"
|
|
184
|
-
then uses your GitHub login.</p></
|
|
185
|
-
<
|
|
186
|
-
|
|
187
|
-
<
|
|
197
|
+
then uses your GitHub login.</p></li>
|
|
198
|
+
<li><p><code>git remote set-url</code> [<code>-p</code>] <var>OPTIONS</var> <var>REMOTE-NAME</var> <var>USER</var>[/<var>REPOSITORY</var>]<br />
|
|
199
|
+
Sets the url of remote <var>REMOTE-NAME</var> using the same rules as
|
|
200
|
+
<code>git remote add</code>.</p></li>
|
|
201
|
+
<li><p><code>git fetch</code> <var>USER-1</var>,[<var>USER-2</var>,...]:
|
|
202
|
+
Adds missing remote(s) with <code>git remote add</code> prior to fetching. New
|
|
203
|
+
remotes are only added if they correspond to valid forks on GitHub.</p></li>
|
|
204
|
+
<li><p><code>git cherry-pick</code> <var>GITHUB-REF</var>:
|
|
205
|
+
Cherry-pick a commit from a fork using either full URL to the commit
|
|
188
206
|
or GitHub-flavored Markdown notation, which is <code>user@sha</code>. If the remote
|
|
189
207
|
doesn't yet exist, it will be added. A <code>git fetch <user></code> is issued
|
|
190
|
-
prior to the cherry-pick attempt.</p></
|
|
191
|
-
<
|
|
192
|
-
|
|
193
|
-
<
|
|
208
|
+
prior to the cherry-pick attempt.</p></li>
|
|
209
|
+
<li><p><code>git push</code> <var>REMOTE-1</var>,<var>REMOTE-2</var>,...,<var>REMOTE-N</var> <var>REF</var>:
|
|
210
|
+
Push <var>REF</var> to each of <var>REMOTE-1</var> through <var>REMOTE-N</var> by executing
|
|
211
|
+
multiple <code>git push</code> commands.</p></li>
|
|
212
|
+
<li><p><code>git browse</code> [<code>-p</code>] [<code>-u</code>] [[<var>USER</var><code>/</code>]<var>REPOSITORY</var>] [SUBPAGE]:
|
|
213
|
+
Open repository's GitHub page in the system's default web browser
|
|
194
214
|
using <code>open(1)</code> or the <code>BROWSER</code> env variable. Use <code>-p</code> to open a
|
|
195
215
|
page with https. If the repository isn't specified, <code>browse</code> opens
|
|
196
216
|
the page of the repository found in the current directory. If SUBPAGE
|
|
197
217
|
is specified, the browser will open on the specified subpage: one of
|
|
198
|
-
"wiki", "commits", "issues" or other (the default is "tree").</p></
|
|
199
|
-
<
|
|
218
|
+
"wiki", "commits", "issues" or other (the default is "tree").</p></li>
|
|
219
|
+
<li><p><code>git compare</code> [<code>-p</code>] [<code>-u</code>] [<var>USER</var>] [<var>START</var>...]<var>END</var>:
|
|
220
|
+
Open a GitHub compare view page in the system's default web browser.
|
|
200
221
|
<var>START</var> to <var>END</var> are branch names, tag names, or commit SHA1s specifying
|
|
201
222
|
the range of history to compare. If <var>START</var> is omitted, GitHub will
|
|
202
|
-
compare against the base branch (the default is "master").</p></
|
|
203
|
-
<
|
|
223
|
+
compare against the base branch (the default is "master").</p></li>
|
|
224
|
+
<li><p><code>git submodule add</code> [<code>-p</code>] <var>OPTIONS</var> [<var>USER</var>/]<var>REPOSITORY</var> <var>DIRECTORY</var>:
|
|
225
|
+
Submodule repository "git://github.com/<var>USER</var>/<var>REPOSITORY</var>.git" into
|
|
204
226
|
<var>DIRECTORY</var> as with git-submodule(1). When <var>USER</var>/ is omitted, assumes
|
|
205
227
|
your GitHub login. With <code>-p</code>, use private remote
|
|
206
|
-
"git@github.com:<var>USER</var>/<var>REPOSITORY</var>.git".</p></
|
|
207
|
-
<
|
|
228
|
+
"git@github.com:<var>USER</var>/<var>REPOSITORY</var>.git".</p></li>
|
|
229
|
+
<li><p><code>git fork</code> [<code>--no-remote</code>]:
|
|
230
|
+
Forks the original project (referenced by "origin" remote) on GitHub and
|
|
208
231
|
adds a new remote for it under your username. Requires <code>github.token</code> to
|
|
209
|
-
be set (see CONFIGURATION).</p></
|
|
210
|
-
<
|
|
211
|
-
|
|
232
|
+
be set (see CONFIGURATION).</p></li>
|
|
233
|
+
<li><p><code>git help</code>:
|
|
234
|
+
Display enhanced git-help(1).</p></li>
|
|
235
|
+
</ul>
|
|
212
236
|
|
|
213
237
|
|
|
214
238
|
<h2 id="CONFIGURATION">CONFIGURATION</h2>
|
|
@@ -303,6 +327,13 @@ $ git cherry-pick mislav@SHA
|
|
|
303
327
|
> git remote add origin git@github.com:YOUR_USER/REPO.git
|
|
304
328
|
</code></pre>
|
|
305
329
|
|
|
330
|
+
<h3 id="git-create">git create</h3>
|
|
331
|
+
|
|
332
|
+
<pre><code>$ git create
|
|
333
|
+
... hardcore creating action ...
|
|
334
|
+
> git remote add origin git@github.com:YOUR_USER/CURRENT_REPO.git
|
|
335
|
+
</code></pre>
|
|
336
|
+
|
|
306
337
|
<h3 id="git-push">git push</h3>
|
|
307
338
|
|
|
308
339
|
<pre><code>$ git push origin,staging,qa bert_timeout
|
|
@@ -375,7 +406,7 @@ $ git help hub
|
|
|
375
406
|
|
|
376
407
|
<ol class='man foot'>
|
|
377
408
|
<li class='tl'>DEFUNKT</li>
|
|
378
|
-
<li class='tc'>
|
|
409
|
+
<li class='tc'>August 2010</li>
|
|
379
410
|
<li class='tr'>hub(1)</li>
|
|
380
411
|
</ol>
|
|
381
412
|
|