From 691650a4887b569601680fb98089db862d303cad Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mislav=20Marohnic=CC=81?= Date: Thu, 24 Nov 2011 01:51:31 +0100 Subject: [PATCH] update man page to separate custom hub commands from git --- man/hub.1 | 122 +++++++++++++++++++++++------------------------ man/hub.1.html | 126 +++++++++++++++++++++++-------------------------- man/hub.1.ronn | 62 +++++++++++++----------- 3 files changed, 153 insertions(+), 157 deletions(-) diff --git a/man/hub.1 b/man/hub.1 index 91fa106d..26a662fd 100644 --- a/man/hub.1 +++ b/man/hub.1 @@ -12,13 +12,10 @@ .br \fBhub alias\fR [\fB\-s\fR] \fISHELL\fR . -.P +.SS "Expanded git commands:" \fBgit init \-g\fR \fIOPTIONS\fR . .br -\fBgit create\fR [\fINAME\fR] [\fB\-p\fR] [\fB\-d\fR \fIDESCRIPTION\fR] [\fB\-h\fR \fIHOMEPAGE\fR] -. -.br \fBgit clone\fR [\fB\-p\fR] \fIOPTIONS\fR [\fIUSER\fR/]\fIREPOSITORY\fR \fIDIRECTORY\fR . .br @@ -46,13 +43,16 @@ \fBgit push\fR \fIREMOTE\-1\fR,\fIREMOTE\-2\fR,\.\.\.,\fIREMOTE\-N\fR [\fIREF\fR] . .br -\fBgit browse\fR [\fB\-u\fR] [[\fIUSER\fR\fB/\fR]\fIREPOSITORY\fR] [SUBPAGE] +\fBgit submodule add\fR [\fB\-p\fR] \fIOPTIONS\fR [\fIUSER\fR/]\fIREPOSITORY\fR \fIDIRECTORY\fR +. +.SS "Custom git commands:" +\fBgit create\fR [\fINAME\fR] [\fB\-p\fR] [\fB\-d\fR \fIDESCRIPTION\fR] [\fB\-h\fR \fIHOMEPAGE\fR] . .br -\fBgit compare\fR [\fB\-u\fR] [\fIUSER\fR] [\fISTART\fR\.\.\.]\fIEND\fR +\fBgit browse\fR [\fB\-u\fR] [[\fIUSER\fR\fB/\fR]\fIREPOSITORY\fR] [SUBPAGE] . .br -\fBgit submodule add\fR [\fB\-p\fR] \fIOPTIONS\fR [\fIUSER\fR/]\fIREPOSITORY\fR \fIDIRECTORY\fR +\fBgit compare\fR [\fB\-u\fR] [\fIUSER\fR] [\fISTART\fR\.\.\.]\fIEND\fR . .br \fBgit fork\fR [\fB\-\-no\-remote\fR] @@ -61,82 +61,85 @@ \fBgit pull\-request\fR [\fB\-f\fR] [\fITITLE\fR|\fB\-i\fR \fIISSUE\fR] [\fB\-b\fR \fIBASE\fR] [\fB\-h\fR \fIHEAD\fR]: . .SH "DESCRIPTION" -\fBhub\fR enhances various \fBgit\fR commands with GitHub remote expansion\. The alias command displays information on configuring your environment: +hub enhances various git commands to ease most common workflows with GitHub\. . -.IP "\(bu" 4 -\fBhub \-\-noop\fR \fICOMMAND\fR: Shows which command(s) would be run as a result of the current command\. Doesn\'t perform anything\. +.TP +\fBhub \-\-noop\fR \fICOMMAND\fR +Shows which command(s) would be run as a result of the current command\. Doesn\'t perform anything\. . -.IP "\(bu" 4 -\fBhub alias\fR [\fB\-s\fR] \fISHELL\fR: 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 this command can be evaluated directly within the shell: +.TP +\fBhub alias\fR [\fB\-s\fR] \fISHELL\fR +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 this command can be evaluated directly within the shell: . .br \fBeval $(hub alias \-s bash)\fR . -.IP "\(bu" 4 -\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\. -. -.IP "\(bu" 4 -\fBgit create\fR [\fINAME\fR] [\fB\-p\fR] [\fB\-d\fR \fIDESCRIPTION\fR] [\fB\-h\fR \fIHOMEPAGE\fR]: -. -.br -Create a new public GitHub repository from the current git repository 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 name\. To explicitly name the new repository, pass in \fINAME\fR, optionally in \fIORGANIZATION\fR/\fINAME\fR form to create under an organization you\'re a member of\. With \fB\-p\fR, create a private repository, and with \fB\-d\fR and \fB\-h\fR set the repository\'s description and homepage URL, respectively\. +.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\. . -.IP "\(bu" 4 -\fBgit clone\fR [\fB\-p\fR] \fIOPTIONS\fR [\fIUSER\fR\fB/\fR]\fIREPOSITORY\fR \fIDIRECTORY\fR: -. -.br +.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 \fIUSER\fR/ is omitted, assumes your GitHub login\. With \fB\-p\fR, clone private repositories over SSH\. For repositories under your GitHub login, \fB\-p\fR is implicit\. . -.IP "\(bu" 4 -\fBgit remote add\fR [\fB\-p\fR] \fIOPTIONS\fR \fIUSER\fR[\fB/\fR\fIREPOSITORY\fR]: -. -.br +.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"\. If \fIUSER\fR is "origin" then uses your GitHub login\. . -.IP "\(bu" 4 +.TP \fBgit remote set\-url\fR [\fB\-p\fR] \fIOPTIONS\fR \fIREMOTE\-NAME\fR \fIUSER\fR[/\fIREPOSITORY\fR] -. -.br Sets the url of remote \fIREMOTE\-NAME\fR using the same rules as \fBgit remote add\fR\. . -.IP "\(bu" 4 -\fBgit fetch\fR \fIUSER\-1\fR,[\fIUSER\-2\fR,\.\.\.]: Adds missing remote(s) with \fBgit remote add\fR prior to fetching\. New remotes are only added if they correspond to valid forks on GitHub\. +.TP +\fBgit fetch\fR \fIUSER\-1\fR,[\fIUSER\-2\fR,\.\.\.] +Adds missing remote(s) with \fBgit remote add\fR prior to fetching\. New remotes are only added if they correspond to valid forks on GitHub\. . -.IP "\(bu" 4 -\fBgit checkout\fR \fIPULLREQ\-URL\fR [\fIBRANCH\fR]: Checks out the head of the pull request as a local branch, to allow for reviewing, rebasing and otherwise cleaning up the commits in the pull request before merging\. The name of the local branch can explicitly be set with \fIBRANCH\fR\. +.TP +\fBgit checkout\fR \fIPULLREQ\-URL\fR [\fIBRANCH\fR] +Checks out the head of the pull request as a local branch, to allow for reviewing, rebasing and otherwise cleaning up the commits in the pull request before merging\. The name of the local branch can explicitly be set with \fIBRANCH\fR\. . -.IP "\(bu" 4 -\fBgit cherry\-pick\fR \fIGITHUB\-REF\fR: Cherry\-pick a commit from a fork using either full URL to the commit or GitHub\-flavored Markdown notation, which is \fBuser@sha\fR\. If the remote doesn\'t yet exist, it will be added\. A \fBgit fetch \fR is issued prior to the cherry\-pick attempt\. +.TP +\fBgit cherry\-pick\fR \fIGITHUB\-REF\fR +Cherry\-pick a commit from a fork using either full URL to the commit or GitHub\-flavored Markdown notation, which is \fBuser@sha\fR\. If the remote doesn\'t yet exist, it will be added\. A \fBgit fetch \fR is issued prior to the cherry\-pick attempt\. . -.IP "\(bu" 4 -\fBgit [am|apply]\fR \fIGITHUB\-URL\fR: Downloads the patch file for the pull request or commit at the URL and applies that patch from disk with \fBgit am\fR or \fBgit apply\fR\. Similar to \fBcherry\-pick\fR, but doesn\'t add new remotes\. \fBgit am\fR creates commits while preserving authorship info while \fBapply\fR only applies the patch to the working copy\. +.TP +\fBgit [am|apply]\fR \fIGITHUB\-URL\fR +Downloads the patch file for the pull request or commit at the URL and applies that patch from disk with \fBgit am\fR or \fBgit apply\fR\. Similar to \fBcherry\-pick\fR, but doesn\'t add new remotes\. \fBgit am\fR creates commits while preserving authorship info while \fBapply\fR only applies the patch to the working copy\. . -.IP "\(bu" 4 -\fBgit push\fR \fIREMOTE\-1\fR,\fIREMOTE\-2\fR,\.\.\.,\fIREMOTE\-N\fR [\fIREF\fR]: Push \fIREF\fR to each of \fIREMOTE\-1\fR through \fIREMOTE\-N\fR by executing multiple \fBgit push\fR commands\. +.TP +\fBgit push\fR \fIREMOTE\-1\fR,\fIREMOTE\-2\fR,\.\.\.,\fIREMOTE\-N\fR [\fIREF\fR] +Push \fIREF\fR to each of \fIREMOTE\-1\fR through \fIREMOTE\-N\fR by executing multiple \fBgit push\fR commands\. . -.IP "\(bu" 4 -\fBgit browse\fR [\fB\-u\fR] [[\fIUSER\fR\fB/\fR]\fIREPOSITORY\fR] [SUBPAGE]: Open repository\'s GitHub page in the system\'s default web browser using \fBopen(1)\fR or the \fBBROWSER\fR env variable\. If the repository isn\'t specified, \fBbrowse\fR opens the page of the repository found in the current directory\. If SUBPAGE is specified, the browser will open on the specified subpage: one of "wiki", "commits", "issues" or other (the default is "tree")\. +.TP +\fBgit submodule add\fR [\fB\-p\fR] \fIOPTIONS\fR [\fIUSER\fR/]\fIREPOSITORY\fR \fIDIRECTORY\fR +Submodule repository "git://github\.com/\fIUSER\fR/\fIREPOSITORY\fR\.git" into \fIDIRECTORY\fR as with git\-submodule(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"\. . -.IP "\(bu" 4 -\fBgit compare\fR [\fB\-u\fR] [\fIUSER\fR] [\fISTART\fR\.\.\.]\fIEND\fR: 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 the range of history to compare\. If a range with two dots (\fBa\.\.b\fR) is given, it will be transformed into one with three dots\. If \fISTART\fR is omitted, GitHub will compare against the base branch (the default is "master")\. +.TP +\fBgit help\fR +Display enhanced git\-help(1)\. . -.IP "\(bu" 4 -\fBgit submodule add\fR [\fB\-p\fR] \fIOPTIONS\fR [\fIUSER\fR/]\fIREPOSITORY\fR \fIDIRECTORY\fR: +.P +hub also adds some custom commands that are otherwise not present in git: . -.br -Submodule repository "git://github\.com/\fIUSER\fR/\fIREPOSITORY\fR\.git" into \fIDIRECTORY\fR as with git\-submodule(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 create\fR [\fINAME\fR] [\fB\-p\fR] [\fB\-d\fR \fIDESCRIPTION\fR] [\fB\-h\fR \fIHOMEPAGE\fR] +Create a new public GitHub repository from the current git repository 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 name\. To explicitly name the new repository, pass in \fINAME\fR, optionally in \fIORGANIZATION\fR/\fINAME\fR form to create under an organization you\'re a member of\. With \fB\-p\fR, create a private repository, and with \fB\-d\fR and \fB\-h\fR set the repository\'s description and homepage URL, respectively\. . -.IP "\(bu" 4 -\fBgit fork\fR [\fB\-\-no\-remote\fR]: Forks the original project (referenced by "origin" remote) on GitHub and adds a new remote for it under your username\. Requires \fBgithub\.token\fR to be set (see CONFIGURATION)\. +.TP +\fBgit browse\fR [\fB\-u\fR] [[\fIUSER\fR\fB/\fR]\fIREPOSITORY\fR] [SUBPAGE] +Open repository\'s GitHub page in the system\'s default web browser using \fBopen(1)\fR or the \fBBROWSER\fR env variable\. If the repository isn\'t specified, \fBbrowse\fR opens the page of the repository found in the current directory\. If SUBPAGE is specified, the browser will open on the specified subpage: one of "wiki", "commits", "issues" or other (the default is "tree")\. . -.IP "\(bu" 4 -\fBgit pull\-request\fR [\fB\-f\fR] [\fITITLE\fR|\fB\-i\fR \fIISSUE\fR] [\fB\-b\fR \fIBASE\fR] [\fB\-h\fR \fIHEAD\fR]: +.TP +\fBgit compare\fR [\fB\-u\fR] [\fIUSER\fR] [\fISTART\fR\.\.\.]\fIEND\fR +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 the range of history to compare\. If a range with two dots (\fBa\.\.b\fR) is given, it will be transformed into one with three dots\. If \fISTART\fR is omitted, GitHub will compare against the base branch (the default is "master")\. . -.br -\fBgit pull\-request\fR [\fB\-f\fR] \fIISSUE\-URL\fR [\fB\-h\fR \fIHEAD\fR]: +.TP +\fBgit fork\fR [\fB\-\-no\-remote\fR] +Forks the original project (referenced by "origin" remote) on GitHub and adds a new remote for it under your username\. Requires \fBgithub\.token\fR to be set (see CONFIGURATION)\. . -.br -Opens a pull request on GitHub for the project that the "origin" remote points to\. The default head of the pull request is the current branch\. Both base and head of the pull request can be explicitly given in one of the following formats: "branch", "owner:branch", "owner/repo:branch"\. This command will abort operation if it detects that the current topic branch has local commits that are not yet pushed to its upstream branch on the remote\. To skip this check, use \fB\-f\fR\. +.TP +\fBgit pull\-request\fR [\fB\-f\fR] [\fITITLE\fR|\fB\-i\fR \fIISSUE\fR] [\fB\-b\fR \fIBASE\fR] [\fB\-h\fR \fIHEAD\fR] +\fBgit pull\-request\fR [\fB\-f\fR] \fIISSUE\-URL\fR [\fB\-h\fR \fIHEAD\fR] Opens a pull request on GitHub for the project that the "origin" remote points to\. The default head of the pull request is the current branch\. Both base and head of the pull request can be explicitly given in one of the following formats: "branch", "owner:branch", "owner/repo:branch"\. This command will abort operation if it detects that the current topic branch has local commits that are not yet pushed to its upstream branch on the remote\. To skip this check, use \fB\-f\fR\. . .IP If \fITITLE\fR is omitted, a text editor will open in which title and body of the pull request can be entered in the same manner as git commit message\. @@ -144,11 +147,6 @@ If \fITITLE\fR is omitted, a text editor will open in which title and body of th .IP If instead of normal \fITITLE\fR an issue number is given with \fB\-i\fR, the pull request will be attached to an existing GitHub issue\. Alternatively, instead of title you can paste a full URL to an issue on GitHub\. . -.IP "\(bu" 4 -\fBgit help\fR: Display enhanced git\-help(1)\. -. -.IP "" 0 -. .SH "CONFIGURATION" Use git\-config(1) to display the currently configured GitHub username: . diff --git a/man/hub.1.html b/man/hub.1.html index a97d1873..fe81c0d4 100644 --- a/man/hub.1.html +++ b/man/hub.1.html @@ -79,8 +79,9 @@

hub [--noop] COMMAND OPTIONS
hub alias [-s] SHELL

+

Expanded git commands:

+

git init -g OPTIONS
-git create [NAME] [-p] [-d DESCRIPTION] [-h HOMEPAGE]
git clone [-p] OPTIONS [USER/]REPOSITORY DIRECTORY
git remote add [-p] OPTIONS USER[/REPOSITORY]
git remote set-url [-p] OPTIONS REMOTE-NAME USER[/REPOSITORY]
@@ -90,99 +91,92 @@ git am GITHUB-URL
git apply GITHUB-URL
git push REMOTE-1,REMOTE-2,...,REMOTE-N [REF]
+git submodule add [-p] OPTIONS [USER/]REPOSITORY DIRECTORY

+ +

Custom git commands:

+ +

git create [NAME] [-p] [-d DESCRIPTION] [-h HOMEPAGE]
git browse [-u] [[USER/]REPOSITORY] [SUBPAGE]
git compare [-u] [USER] [START...]END
-git submodule add [-p] OPTIONS [USER/]REPOSITORY DIRECTORY
git fork [--no-remote]
git pull-request [-f] [TITLE|-i ISSUE] [-b BASE] [-h HEAD]:

DESCRIPTION

-

hub enhances various git commands with GitHub remote expansion. The -alias command displays information on configuring your environment:

+

hub enhances various git commands to ease most common workflows with GitHub.

-
    -

  • hub --noop COMMAND: -Shows which command(s) would be run as a result of the current command. -Doesn't perform anything.

    • -

  • hub alias [-s] SHELL: -Writes shell aliasing code for SHELL (bash, sh, zsh, +

    +
    hub --noop COMMAND

    Shows which command(s) would be run as a result of the current command. +Doesn't perform anything.

    +
    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)

    • -

  • git init -g OPTIONS: -Create a git repository as with git-init(1) and add remote origin at +eval $(hub alias -s bash)

    +
    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 create [NAME] [-p] [-d DESCRIPTION] [-h HOMEPAGE]:
    -Create a new public GitHub repository from the current git -repository and add remote origin at -"git@github.com:USER/REPOSITORY.git"; USER is your GitHub -username and REPOSITORY is the current working directory name. -To explicitly name the new repository, pass in NAME, optionally in -ORGANIZATION/NAME form to create under an organization you're a -member of. With -p, create a private repository, and with -d and -h -set the repository's description and homepage URL, respectively.

    • -

  • git clone [-p] OPTIONS [USER/]REPOSITORY DIRECTORY:
    -Clone repository "git://github.com/USER/REPOSITORY.git" into +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, clone private repositories over SSH. -For repositories under your GitHub login, -p is implicit.

    • -

  • git remote add [-p] OPTIONS USER[/REPOSITORY]:
    -Add remote "git://github.com/USER/REPOSITORY.git" as with +For repositories under your GitHub login, -p is implicit.

    +
    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". If USER is "origin" -then uses your GitHub login.

    • -

  • git remote set-url [-p] OPTIONS REMOTE-NAME USER[/REPOSITORY]
    -Sets the url of remote REMOTE-NAME using the same rules as -git remote add.

    • -

  • git fetch USER-1,[USER-2,...]: -Adds missing remote(s) with git remote add prior to fetching. New -remotes are only added if they correspond to valid forks on GitHub.

    • -

  • git checkout PULLREQ-URL [BRANCH]: -Checks out the head of the pull request as a local branch, to allow for +then uses your GitHub login.

    +
    git remote set-url [-p] OPTIONS REMOTE-NAME USER[/REPOSITORY]

    Sets the url of remote REMOTE-NAME using the same rules as +git remote add.

    +
    git fetch USER-1,[USER-2,...]

    Adds missing remote(s) with git remote add prior to fetching. New +remotes are only added if they correspond to valid forks on GitHub.

    +
    git checkout PULLREQ-URL [BRANCH]

    Checks out the head of the pull request as a local branch, to allow for reviewing, rebasing and otherwise cleaning up the commits in the pull request before merging. The name of the local branch can explicitly be -set with BRANCH.

    • -

  • git cherry-pick GITHUB-REF: -Cherry-pick a commit from a fork using either full URL to the commit +set with BRANCH.

    +
    git cherry-pick GITHUB-REF

    Cherry-pick a commit from a fork using either full URL to the commit or GitHub-flavored Markdown notation, which is user@sha. If the remote doesn't yet exist, it will be added. A git fetch <user> is issued -prior to the cherry-pick attempt.

    • -

  • git [am|apply] GITHUB-URL: -Downloads the patch file for the pull request or commit at the URL and +prior to the cherry-pick attempt.

    +
    git [am|apply] GITHUB-URL

    Downloads the patch file for the pull request or commit at the URL and applies that patch from disk with git am or git apply. Similar to cherry-pick, but doesn't add new remotes. git am creates commits while preserving authorship info while apply only applies the patch to the -working copy.

    • -

  • git push REMOTE-1,REMOTE-2,...,REMOTE-N [REF]: -Push REF to each of REMOTE-1 through REMOTE-N by executing -multiple git push commands.

    • -

  • git browse [-u] [[USER/]REPOSITORY] [SUBPAGE]: -Open repository's GitHub page in the system's default web browser using +working copy.

    +
    git push REMOTE-1,REMOTE-2,...,REMOTE-N [REF]

    Push REF to each of REMOTE-1 through REMOTE-N by executing +multiple git push commands.

    +
    git submodule add [-p] OPTIONS [USER/]REPOSITORY DIRECTORY

    Submodule repository "git://github.com/USER/REPOSITORY.git" into +DIRECTORY as with git-submodule(1). When USER/ is omitted, assumes +your GitHub login. With -p, use private remote +"git@github.com:USER/REPOSITORY.git".

    +
    git help

    Display enhanced git-help(1).

    + + + +

    hub also adds some custom commands that are otherwise not present in git:

    + +
    +
    git create [NAME] [-p] [-d DESCRIPTION] [-h HOMEPAGE]

    Create a new public GitHub repository from the current git +repository and add remote origin at +"git@github.com:USER/REPOSITORY.git"; USER is your GitHub +username and REPOSITORY is the current working directory name. +To explicitly name the new repository, pass in NAME, optionally in +ORGANIZATION/NAME form to create under an organization you're a +member of. With -p, create a private repository, and with -d and -h +set the repository's description and homepage URL, respectively.

    +
    git browse [-u] [[USER/]REPOSITORY] [SUBPAGE]

    Open repository's GitHub page in the system's default web browser using open(1) or the BROWSER env variable. If the repository isn't specified, browse opens the page of the repository found in the current directory. If SUBPAGE is specified, the browser will open on the specified subpage: one of "wiki", "commits", "issues" or other (the default is -"tree").

    • -

  • git compare [-u] [USER] [START...]END: -Open a GitHub compare view page in the system's default web browser. +"tree").

    +
    git compare [-u] [USER] [START...]END

    Open a GitHub compare view page in the system's default web browser. START to END are branch names, tag names, or commit SHA1s specifying the range of history to compare. If a range with two dots (a..b) is given, it will be transformed into one with three dots. If START is omitted, -GitHub will compare against the base branch (the default is "master").

    • -

  • git submodule add [-p] OPTIONS [USER/]REPOSITORY DIRECTORY:
    -Submodule repository "git://github.com/USER/REPOSITORY.git" into -DIRECTORY as with git-submodule(1). When USER/ is omitted, assumes -your GitHub login. With -p, use private remote -"git@github.com:USER/REPOSITORY.git".

    • -

  • git fork [--no-remote]: -Forks the original project (referenced by "origin" remote) on GitHub and +GitHub will compare against the base branch (the default is "master").

    +
    git fork [--no-remote]

    Forks the original project (referenced by "origin" remote) on GitHub and adds a new remote for it under your username. Requires github.token to -be set (see CONFIGURATION).

    • -

  • git pull-request [-f] [TITLE|-i ISSUE] [-b BASE] [-h HEAD]:
    -git pull-request [-f] ISSUE-URL [-h HEAD]:
    +be set (see CONFIGURATION).

    +
    git pull-request [-f] [TITLE|-i ISSUE] [-b BASE] [-h HEAD]

    git pull-request [-f] ISSUE-URL [-h HEAD] Opens a pull request on GitHub for the project that the "origin" remote points to. The default head of the pull request is the current branch. Both base and head of the pull request can be explicitly given in one of @@ -196,10 +190,8 @@ the pull request can be entered in the same manner as git commit message.

    If instead of normal TITLE an issue number is given with -i, the pull request will be attached to an existing GitHub issue. Alternatively, instead -of title you can paste a full URL to an issue on GitHub.

    • -

  • git help: -Display enhanced git-help(1).

    • -
+of title you can paste a full URL to an issue on GitHub.

+

CONFIGURATION

diff --git a/man/hub.1.ronn b/man/hub.1.ronn index b234d0a6..3e32fc12 100644 --- a/man/hub.1.ronn +++ b/man/hub.1.ronn @@ -6,8 +6,9 @@ hub(1) -- git + hub = github `hub` [`--noop`] `hub alias` [`-s`] +### Expanded git commands: + `git init -g` -`git create` [] [`-p`] [`-d` ] [`-h` ] `git clone` [`-p`] [/] `git remote add` [`-p`] [/] `git remote set-url` [`-p`] [/] @@ -17,16 +18,19 @@ hub(1) -- git + hub = github `git am` `git apply` `git push` ,,..., [] +`git submodule add` [`-p`] [/] + +### Custom git commands: + +`git create` [] [`-p`] [`-d` ] [`-h` ] `git browse` [`-u`] [[`/`]] [SUBPAGE] `git compare` [`-u`] [] [...] -`git submodule add` [`-p`] [/] `git fork` [`--no-remote`] `git pull-request` [`-f`] [|`-i` <ISSUE>] [`-b` <BASE>] [`-h` <HEAD>]: ## DESCRIPTION -`hub` enhances various `git` commands with GitHub remote expansion. The -alias command displays information on configuring your environment: +hub enhances various git commands to ease most common workflows with GitHub. * `hub --noop` <COMMAND>: Shows which command(s) would be run as a result of the current command. @@ -43,30 +47,20 @@ alias command displays information on configuring your environment: "git@github.com:<USER>/<REPOSITORY>.git"; <USER> is your GitHub username and <REPOSITORY> is the current working directory's basename. - * `git create` [<NAME>] [`-p`] [`-d` <DESCRIPTION>] [`-h` <HOMEPAGE>]: - Create a new public GitHub repository from the current git - repository and add remote `origin` at - "git@github.com:<USER>/<REPOSITORY>.git"; <USER> is your GitHub - username and <REPOSITORY> is the current working directory name. - To explicitly name the new repository, pass in <NAME>, optionally in - <ORGANIZATION>/<NAME> form to create under an organization you're a - member of. With `-p`, create a private repository, and with `-d` and `-h` - set the repository's description and homepage URL, respectively. - - * `git clone` [`-p`] <OPTIONS> [<USER>`/`]<REPOSITORY> <DIRECTORY>: + * `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`, clone private repositories over SSH. For repositories under your GitHub login, `-p` is implicit. - * `git remote add` [`-p`] <OPTIONS> <USER>[`/`<REPOSITORY>]: + * `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". If <USER> is "origin" then uses your GitHub login. - * `git remote set-url` [`-p`] <OPTIONS> <REMOTE-NAME> <USER>[/<REPOSITORY>] + * `git remote set-url` [`-p`] <OPTIONS> <REMOTE-NAME> <USER>[/<REPOSITORY>]: Sets the url of remote <REMOTE-NAME> using the same rules as `git remote add`. @@ -97,6 +91,27 @@ alias command displays information on configuring your environment: Push <REF> to each of <REMOTE-1> through <REMOTE-N> by executing multiple `git push` commands. + * `git submodule add` [`-p`] <OPTIONS> [<USER>/]<REPOSITORY> <DIRECTORY>: + Submodule repository "git://github.com/<USER>/<REPOSITORY>.git" into + <DIRECTORY> as with git-submodule(1). When <USER>/ is omitted, assumes + your GitHub login. With `-p`, use private remote + "git@github.com:<USER>/<REPOSITORY>.git". + + * `git help`: + Display enhanced git-help(1). + +hub also adds some custom commands that are otherwise not present in git: + + * `git create` [<NAME>] [`-p`] [`-d` <DESCRIPTION>] [`-h` <HOMEPAGE>]: + Create a new public GitHub repository from the current git + repository and add remote `origin` at + "git@github.com:<USER>/<REPOSITORY>.git"; <USER> is your GitHub + username and <REPOSITORY> is the current working directory name. + To explicitly name the new repository, pass in <NAME>, optionally in + <ORGANIZATION>/<NAME> form to create under an organization you're a + member of. With `-p`, create a private repository, and with `-d` and `-h` + set the repository's description and homepage URL, respectively. + * `git browse` [`-u`] [[<USER>`/`]<REPOSITORY>] [SUBPAGE]: Open repository's GitHub page in the system's default web browser using `open(1)` or the `BROWSER` env variable. If the repository isn't @@ -112,19 +127,13 @@ alias command displays information on configuring your environment: it will be transformed into one with three dots. If <START> is omitted, GitHub will compare against the base branch (the default is "master"). - * `git submodule add` [`-p`] <OPTIONS> [<USER>/]<REPOSITORY> <DIRECTORY>: - Submodule repository "git://github.com/<USER>/<REPOSITORY>.git" into - <DIRECTORY> as with git-submodule(1). When <USER>/ is omitted, assumes - your GitHub login. With `-p`, use private remote - "git@github.com:<USER>/<REPOSITORY>.git". - * `git fork` [`--no-remote`]: Forks the original project (referenced by "origin" remote) on GitHub and adds a new remote for it under your username. Requires `github.token` to be set (see CONFIGURATION). - * `git pull-request` [`-f`] [<TITLE>|`-i` <ISSUE>] [`-b` <BASE>] [`-h` <HEAD>]: - `git pull-request` [`-f`] <ISSUE-URL> [`-h` <HEAD>]: + * `git pull-request` [`-f`] [<TITLE>|`-i` <ISSUE>] [`-b` <BASE>] [`-h` <HEAD>]: + `git pull-request` [`-f`] <ISSUE-URL> [`-h` <HEAD>] Opens a pull request on GitHub for the project that the "origin" remote points to. The default head of the pull request is the current branch. Both base and head of the pull request can be explicitly given in one of @@ -140,9 +149,6 @@ alias command displays information on configuring your environment: request will be attached to an existing GitHub issue. Alternatively, instead of title you can paste a full URL to an issue on GitHub. - * `git help`: - Display enhanced git-help(1). - ## CONFIGURATION Use git-config(1) to display the currently configured GitHub username: -- GitLab