first manual's version

This commit is contained in:
Jonhnny Weslley 2010-10-29 12:45:29 -03:00
parent 81296601e9
commit eb6c2bb009
17 changed files with 638 additions and 0 deletions

49
man/git-changelog.1.ronn Normal file
View file

@ -0,0 +1,49 @@
git-changelog(1) -- Generate the changelog report
=================================================
## SYNOPSIS
`git-changelog` [--list]
## DESCRIPTION
Populates the file named matching _change|history -i_ with the commits since the previous tag or since the project began when no tags are present. Opens the changelog in **$EDITOR** when set.
## OPTIONS
--list
Show commit logs from the current version.
## EXAMPLES
* Updating changelog file:
$ git changelog
* Listing commits from the current version:
$ git changelog --list
* Docs for git-ignore. Closes #3
* Merge branch 'ignore'
* Added git-ignore
* Fixed <tag> in docs
* Install docs
* Merge branch 'release'
* Added git-release
* Passing args to git shortlog
* Added --all support to git-count
* Initial commit
## AUTHOR
Written by Tj Holowaychuk &lt;<tj@vision-media.ca>&gt;
## REPORTING BUGS
&lt;<http://github.com/visionmedia/git-extras/issues>&gt;
## SEE ALSO
&lt;<http://github.com/visionmedia/git-extras>&gt;

View file

@ -0,0 +1,30 @@
git-commits-since(1) -- Show commit logs since some date
========================================================
## SYNOPSIS
`git-commits-since` [&lt;date&gt;]
## DESCRIPTION
List of commits since the given _date_.
## OPTIONS
&lt;date&gt;
Show commits more recent than <date>. By default, the command shows the commit logs since "last week".
## EXAMPLES
## AUTHOR
Written by Tj Holowaychuk &lt;<tj@vision-media.ca>&gt;
## REPORTING BUGS
&lt;<http://github.com/visionmedia/git-extras/issues>&gt;
## SEE ALSO
&lt;<http://github.com/visionmedia/git-extras>&gt;

39
man/git-contrib.1.ronn Normal file
View file

@ -0,0 +1,39 @@
git-contrib(1) -- Show user's contributions
===========================================
## SYNOPSIS
`git-contrib` &lt;username&gt;
## DESCRIPTION
Output a user's contributions to a project, based on the author name.
## OPTIONS
&lt;username&gt;
The name of the user who owns the contributions.
## EXAMPLES
$ git contrib visionmedia
visionmedia (18):
Export STATUS_CODES
Replaced several Array.prototype.slice.call() calls with Array.prototype.unshift.call()
Moved help msg to node-repl
Added multiple arg support for sys.puts(), print(), etc.
Fix stack output on socket error
...
## AUTHOR
Written by Tj Holowaychuk &lt;<tj@vision-media.ca>&gt;
## REPORTING BUGS
&lt;<http://github.com/visionmedia/git-extras/issues>&gt;
## SEE ALSO
&lt;<http://github.com/visionmedia/git-extras>&gt;

62
man/git-count.1.ronn Normal file
View file

@ -0,0 +1,62 @@
git-count(1) -- Show commit count
=================================
## SYNOPSIS
`git-count` [--all]
## DESCRIPTION
Show commit count.
## OPTIONS
--all
Show commit count details.
## EXAMPLES
Output commit total:
$ git count
total 1844
Output verbose commit count details:
$ git count --all
visionmedia (1285)
Tj Holowaychuk (430)
Aaron Heckmann (48)
csausdev (34)
ciaranj (26)
Guillermo Rauch (6)
Brian McKinney (2)
Nick Poulden (2)
Benny Wong (2)
Justin Lilly (1)
isaacs (1)
Adam Sanderson (1)
Viktor Kelemen (1)
Gregory Ritter (1)
Greg Ritter (1)
ewoudj (1)
James Herdman (1)
Matt Colyer (1)
total 1844
## AUTHOR
Written by Tj Holowaychuk &lt;<tj@vision-media.ca>&gt;
## REPORTING BUGS
&lt;<http://github.com/visionmedia/git-extras/issues>&gt;
## SEE ALSO
&lt;<http://github.com/visionmedia/git-extras>&gt;

View file

@ -0,0 +1,32 @@
git-delete-branch(1) -- Delete branches
=======================================
## SYNOPSIS
`git-delete-branch` &lt;branchname&gt;
## DESCRIPTION
Deletes local and remote branch named &lt;branchname&gt;.
## OPTIONS
&lt;branchname&gt;
The name of the branch to delete.
## EXAMPLES
$ git delete-branch integration
## AUTHOR
Written by Tj Holowaychuk &lt;<tj@vision-media.ca>&gt;
## REPORTING BUGS
&lt;<http://github.com/visionmedia/git-extras/issues>&gt;
## SEE ALSO
&lt;<http://github.com/visionmedia/git-extras>&gt;

View file

@ -0,0 +1,30 @@
git-delete-submodule(1) -- Delete submodules
============================================
## SYNOPSIS
`git-delete-submodule` &lt;path&gt;
## DESCRIPTION
## OPTIONS
&lt;path&gt;
The path of the submodule to delete.
## EXAMPLES
$ git delete-submodule lib/foo
## AUTHOR
Written by Jonhnny Weslley &lt;<jw@jonhnnyweslley.net>&gt;
## REPORTING BUGS
&lt;<http://github.com/visionmedia/git-extras/issues>&gt;
## SEE ALSO
&lt;<http://github.com/visionmedia/git-extras>&gt;

32
man/git-delete-tag.1.ronn Normal file
View file

@ -0,0 +1,32 @@
git-delete-tag(1) -- Delete tags
================================
## SYNOPSIS
`git-delete-tag` &lt;tagname&gt;
## DESCRIPTION
Deletes local and remote tag named &lt;tagname&gt;.
## OPTIONS
&lt;tagname&gt;
The name of the branch to delete.
## EXAMPLES
$ git delete-tag 0.0.1
## AUTHOR
Written by Tj Holowaychuk &lt;<tj@vision-media.ca>&gt;
## REPORTING BUGS
&lt;<http://github.com/visionmedia/git-extras/issues>&gt;
## SEE ALSO
&lt;<http://github.com/visionmedia/git-extras>&gt;

View file

@ -0,0 +1,32 @@
git-fresh-branch(1) -- Create fresh branches
============================================
## SYNOPSIS
`git-fresh-branch` &lt;branchname&gt;
## DESCRIPTION
Creates empty local branch named &lt;branchname&gt;.
## OPTIONS
&lt;branchname&gt;
The name of the branch to delete.
## EXAMPLES
$ git fresh-branch docs
## AUTHOR
Written by Kenneth Reitz &lt;<me@kennethreitz.com>&gt;
## REPORTING BUGS
&lt;<http://github.com/visionmedia/git-extras/issues>&gt;
## SEE ALSO
&lt;<http://github.com/visionmedia/git-extras>&gt;

33
man/git-graft.1.ronn Normal file
View file

@ -0,0 +1,33 @@
git-graft(1) -- Merge commits together
======================================
## SYNOPSIS
`git-graft` &lt;src-branch&gt; [&lt;dest-branch&gt;]
## DESCRIPTION
Merge commits from &lt;src-branch&gt; into &lt;dest-branch&gt; which defaults to &lt;master&gt;.
## OPTIONS
&lt;src-branch&gt;
&lt;dest-branch&gt;
## EXAMPLES
$ git graft new_feature dev
$ git graft new_feature
## AUTHOR
Written by Kenneth Reitz &lt;<me@kennethreitz.com>&gt;
## REPORTING BUGS
&lt;<http://github.com/visionmedia/git-extras/issues>&gt;
## SEE ALSO
&lt;<http://github.com/visionmedia/git-extras>&gt;

40
man/git-ignore.1.ronn Normal file
View file

@ -0,0 +1,40 @@
git-ignore(1) -- Ignore untracked files
=======================================
## SYNOPSIS
`git-ignore` [&lt;pattern&gt;...]
## DESCRIPTION
Adds the given _pattern_s to a gitignore file.
## OPTIONS
## EXAMPLES
To lazy to open up _.gitignore_? me too! simply pass some patterns:
$ git ignore build "*.o" "*.log"
... added 'build'
... added '*.o'
... added '*.log'
Running `git-ignore` without a pattern will display the current patterns:
$ git ignore
build
*.o
*.log
## AUTHOR
Written by Tj Holowaychuk &lt;<tj@vision-media.ca>&gt;
## REPORTING BUGS
&lt;<http://github.com/visionmedia/git-extras/issues>&gt;
## SEE ALSO
&lt;<http://github.com/visionmedia/git-extras>&gt;

32
man/git-release.1.ronn Normal file
View file

@ -0,0 +1,32 @@
git-release(1) -- Commit, tag and push changes to the repository
================================================================
## SYNOPSIS
`git-release` &lt;tagname&gt;
## DESCRIPTION
Commits changes with message "Release &lt;tagname&gt;", tags with the given &lt;tagname&gt; and pushes the branch / tags.
## OPTIONS
&lt;tagname&gt;
## EXAMPLES
Release commit with the given &lt;tagname&gt;.
$ git release 0.1.0
## AUTHOR
Written by Tj Holowaychuk &lt;<tj@vision-media.ca>&gt;
## REPORTING BUGS
&lt;<http://github.com/visionmedia/git-extras/issues>&gt;
## SEE ALSO
&lt;<http://github.com/visionmedia/git-extras>&gt;

41
man/git-repl.1.ronn Normal file
View file

@ -0,0 +1,41 @@
git-repl(1) -- git read-eval-print-loop
=======================================
## SYNOPSIS
`git-repl`
## DESCRIPTION
## OPTIONS
GIT read-eval-print-loop:
$ git repl
git> ls-files
History.md
Makefile
Readme.md
bin/git-changelog
bin/git-count
bin/git-delete-branch
bin/git-delete-tag
bin/git-ignore
bin/git-release
git> quit
## EXAMPLES
## AUTHOR
Written by Tj Holowaychuk &lt;<tj@vision-media.ca>&gt;
## REPORTING BUGS
&lt;<http://github.com/visionmedia/git-extras/issues>&gt;
## SEE ALSO
&lt;<http://github.com/visionmedia/git-extras>&gt;

32
man/git-setup.1.ronn Normal file
View file

@ -0,0 +1,32 @@
git-setup(1) -- Set up a git repository
=======================================
## SYNOPSIS
`git-setup` [&lt;directory&gt;]
## DESCRIPTION
Set up a git repository if one doesn't exist, add all files and make an initial commit.
## OPTIONS
&lt;directory&gt;
The name of a new directory to setup. By default, the current working directory.
## EXAMPLES
$ git setup path/to/repository
## AUTHOR
Written by Aggelos Orfanakos &lt;<agorf@agorf.gr>&gt;
## REPORTING BUGS
&lt;<http://github.com/visionmedia/git-extras/issues>&gt;
## SEE ALSO
&lt;<http://github.com/visionmedia/git-extras>&gt;

62
man/git-summary.1.ronn Normal file
View file

@ -0,0 +1,62 @@
git-summary(1) -- Show repository summary
=========================================
## SYNOPSIS
`git-summary` [&lt;commitish&gt;]
## DESCRIPTION
Shows a summary of the repository.
## OPTIONS
&lt;commitish&gt;
Summarize only the range of commits included in the &lt;commitish&gt;.
## EXAMPLES
Outputs a repo summary:
$ git summary
project: express
commits: 1893
files : 111
authors:
1285 visionmedia
478 Tj Holowaychuk
48 Aaron Heckmann
34 csausdev
26 ciaranj
6 Guillermo Rauch
3 Nick Poulden
2 Brian McKinney
2 Benny Wong
1 Justin Lilly
1 James Herdman
1 Adam Sanderson
1 Viktor Kelemen
1 Gregory Ritter
1 Greg Ritter
1 ewoudj
1 isaacs
1 Matt Colyer
This command can also take a commitish, and will print a summary for the range
of commits included in the commitish:
$ git summary v42..
## AUTHOR
Written by Tj Holowaychuk &lt;<tj@vision-media.ca>&gt;
## REPORTING BUGS
&lt;<http://github.com/visionmedia/git-extras/issues>&gt;
## SEE ALSO
&lt;<http://github.com/visionmedia/git-extras>&gt;

32
man/git-touch.1.ronn Normal file
View file

@ -0,0 +1,32 @@
git-touch(1) -- Touch and add file to the index
===============================================
## SYNOPSIS
`git-touch` &lt;filename&gt;
## DESCRIPTION
Call `touch` on the given file and add it to the current index. Used one-step creating new files.
## OPTIONS
&lt;filename&gt;
File to be touched.
## EXAMPLES
$ git touch Makefile
## AUTHOR
Written by Alex McHale &lt;<alexmchale@gmail.com>&gt;
## REPORTING BUGS
&lt;<http://github.com/visionmedia/git-extras/issues>&gt;
## SEE ALSO
&lt;<http://github.com/visionmedia/git-extras>&gt;

38
man/git-undo.1.ronn Normal file
View file

@ -0,0 +1,38 @@
git-undo(1) -- Remove latest commits
====================================
## SYNOPSIS
`git-undo` [&lt;commitcount&gt;]
## DESCRIPTION
Removes the latest commits.
## OPTIONS
&lt;commitcount&gt;
Number of commits to remove. Defaults to *1*, thus remove the latest commit.
## EXAMPLES
Removes the latest commit.
$ git undo
Remove the latest 3 commits:
$ git undo 3
## AUTHOR
Written by Kenneth Reitz &lt;<me@kennethreitz.com>&gt;
## REPORTING BUGS
&lt;<http://github.com/visionmedia/git-extras/issues>&gt;
## SEE ALSO
&lt;<http://github.com/visionmedia/git-extras>&gt;

View file

@ -0,0 +1,22 @@
git-update-extras(1) -- Updates git extras
==========================================
## SYNOPSIS
`git-update-extras`
## DESCRIPTION
Updates git extras. Clones the repo to _/tmp/git-extras_, make installs, then cds back to the origin directory.
## AUTHOR
Written by Tj Holowaychuk &lt;<tj@vision-media.ca>&gt;
## REPORTING BUGS
&lt;<http://github.com/visionmedia/git-extras/issues>&gt;
## SEE ALSO
&lt;<http://github.com/visionmedia/git-extras>&gt;