utils-code/tj.git-extras
1
0
Fork 0
mirror of https://github.com/tj/git-extras.git synced 2026-09-10 15:36:21 -04:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
tj.git-extras/man
History
spacewander 92c34e8e00 add new command 'git root' to show the path to root of repo
2014-11-13 16:12:50 +08:00
..
git-alias.1 replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-alias.html correct the format of git-rebase-patch.md. Now we can handle it with script 2014-11-06 21:35:17 +08:00
git-alias.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-archive-file.1 replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-archive-file.html correct the format of git-rebase-patch.md. Now we can handle it with script 2014-11-06 21:35:17 +08:00
git-archive-file.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-back.1 replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-back.html correct the format of git-rebase-patch.md. Now we can handle it with script 2014-11-06 21:35:17 +08:00
git-back.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-bug.1 replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-bug.html correct the format of git-rebase-patch.md. Now we can handle it with script 2014-11-06 21:35:17 +08:00
git-bug.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-changelog.1 replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-changelog.html correct the format of git-rebase-patch.md. Now we can handle it with script 2014-11-06 21:35:17 +08:00
git-changelog.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-commits-since.1 replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-commits-since.html correct the format of git-rebase-patch.md. Now we can handle it with script 2014-11-06 21:35:17 +08:00
git-commits-since.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-contrib.1 replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-contrib.html correct the format of git-rebase-patch.md. Now we can handle it with script 2014-11-06 21:35:17 +08:00
git-contrib.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-count.1 replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-count.html correct the format of git-rebase-patch.md. Now we can handle it with script 2014-11-06 21:35:17 +08:00
git-count.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-create-branch.1 replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-create-branch.html correct the format of git-rebase-patch.md. Now we can handle it with script 2014-11-06 21:35:17 +08:00
git-create-branch.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-delete-branch.1 replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-delete-branch.html correct the format of git-rebase-patch.md. Now we can handle it with script 2014-11-06 21:35:17 +08:00
git-delete-branch.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-delete-merged-branches.1 replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-delete-merged-branches.html correct the format of git-rebase-patch.md. Now we can handle it with script 2014-11-06 21:35:17 +08:00
git-delete-merged-branches.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-delete-submodule.1 replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-delete-submodule.html correct the format of git-rebase-patch.md. Now we can handle it with script 2014-11-06 21:35:17 +08:00
git-delete-submodule.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-delete-tag.1 replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-delete-tag.html correct the format of git-rebase-patch.md. Now we can handle it with script 2014-11-06 21:35:17 +08:00
git-delete-tag.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-effort.1 replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-effort.html correct the format of git-rebase-patch.md. Now we can handle it with script 2014-11-06 21:35:17 +08:00
git-effort.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-extras.1 correct the '-m' argument for grep. Then regenralize git-extra 2014-11-06 21:33:14 +08:00
git-extras.html correct the '-m' argument for grep. Then regenralize git-extra 2014-11-06 21:33:14 +08:00
git-extras.md correct the '-m' argument for grep. Then regenralize git-extra 2014-11-06 21:33:14 +08:00
git-feature.1 replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-feature.html correct the format of git-rebase-patch.md. Now we can handle it with script 2014-11-06 21:35:17 +08:00
git-feature.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-fork.1 replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-fork.html correct the format of git-rebase-patch.md. Now we can handle it with script 2014-11-06 21:35:17 +08:00
git-fork.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-fresh-branch.1 replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-fresh-branch.html correct the format of git-rebase-patch.md. Now we can handle it with script 2014-11-06 21:35:17 +08:00
git-fresh-branch.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-gh-pages.1 replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-gh-pages.html correct the format of git-rebase-patch.md. Now we can handle it with script 2014-11-06 21:35:17 +08:00
git-gh-pages.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-graft.1 replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-graft.html correct the format of git-rebase-patch.md. Now we can handle it with script 2014-11-06 21:35:17 +08:00
git-graft.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-ignore.1 replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-ignore.html correct the format of git-rebase-patch.md. Now we can handle it with script 2014-11-06 21:35:17 +08:00
git-ignore.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-info.1 replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-info.html correct the format of git-rebase-patch.md. Now we can handle it with script 2014-11-06 21:35:17 +08:00
git-info.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-local-commits.1 replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-local-commits.html correct the format of git-rebase-patch.md. Now we can handle it with script 2014-11-06 21:35:17 +08:00
git-local-commits.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-lock.1 replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-lock.html correct the format of git-rebase-patch.md. Now we can handle it with script 2014-11-06 21:35:17 +08:00
git-lock.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-locked.1 replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-locked.html correct the format of git-rebase-patch.md. Now we can handle it with script 2014-11-06 21:35:17 +08:00
git-locked.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-missing.1 replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-missing.html correct the format of git-rebase-patch.md. Now we can handle it with script 2014-11-06 21:35:17 +08:00
git-missing.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-pr.1 replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-pr.html replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-pr.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-rebase-patch.1 correct the format of git-rebase-patch.md. Now we can handle it with script 2014-11-06 21:35:17 +08:00
git-rebase-patch.html correct the format of git-rebase-patch.md. Now we can handle it with script 2014-11-06 21:35:17 +08:00
git-rebase-patch.md correct the format of git-rebase-patch.md. Now we can handle it with script 2014-11-06 21:35:17 +08:00
git-refactor.1 replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-refactor.html correct the format of git-rebase-patch.md. Now we can handle it with script 2014-11-06 21:35:17 +08:00
git-refactor.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-release.1 replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-release.html correct the format of git-rebase-patch.md. Now we can handle it with script 2014-11-06 21:35:17 +08:00
git-release.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-rename-tag.1 replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-rename-tag.html correct the format of git-rebase-patch.md. Now we can handle it with script 2014-11-06 21:35:17 +08:00
git-rename-tag.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-repl.1 replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-repl.html correct the format of git-rebase-patch.md. Now we can handle it with script 2014-11-06 21:35:17 +08:00
git-repl.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-reset-file.1 replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-reset-file.html correct the format of git-rebase-patch.md. Now we can handle it with script 2014-11-06 21:35:17 +08:00
git-reset-file.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-root.1 add new command 'git root' to show the path to root of repo 2014-11-13 16:12:50 +08:00
git-root.html add new command 'git root' to show the path to root of repo 2014-11-13 16:12:50 +08:00
git-root.md add new command 'git root' to show the path to root of repo 2014-11-13 16:12:50 +08:00
git-setup.1 replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-setup.html correct the format of git-rebase-patch.md. Now we can handle it with script 2014-11-06 21:35:17 +08:00
git-setup.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-show-tree.1 replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-show-tree.html correct the format of git-rebase-patch.md. Now we can handle it with script 2014-11-06 21:35:17 +08:00
git-show-tree.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-squash.1 replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-squash.html correct the format of git-rebase-patch.md. Now we can handle it with script 2014-11-06 21:35:17 +08:00
git-squash.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-summary.1 replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-summary.html correct the format of git-rebase-patch.md. Now we can handle it with script 2014-11-06 21:35:17 +08:00
git-summary.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-touch.1 replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-touch.html correct the format of git-rebase-patch.md. Now we can handle it with script 2014-11-06 21:35:17 +08:00
git-touch.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-undo.1 replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-undo.html correct the format of git-rebase-patch.md. Now we can handle it with script 2014-11-06 21:35:17 +08:00
git-undo.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-unlock.1 replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-unlock.html correct the format of git-rebase-patch.md. Now we can handle it with script 2014-11-06 21:35:17 +08:00
git-unlock.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
index.txt replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
man-template.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
manning-up.sh correct the '-m' argument for grep. Then regenralize git-extra 2014-11-06 21:33:14 +08:00
Readme.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00

Readme.md

How to generate documentation:

DESCRIPTION

To generate documentation:

  1. Start by filling out the 'man-template.md'

  2. Then use a program ronn. Get ronn from github.

  3. Run ronn:

$ ronn <filename>.md
  1. Remember, we use the following naming convention for files:
git-<command>.html
git-<command>.1
git-<command>.md

You'll need to rename the html file, as ronn probably inserted a 1 into the filename.

EXAMPLE

$ ronn git-effort.md

roff: ./git-effort.1
html: ./git-effort.1.html                +man

$ mv git-effort.1.html git-effort.html

SHELL SCRIPT

Alternatively you can run the manning-up.sh automated shell script included in the man folder. The script will recreate the git-extras index based on the list of .md files available before it runs ronn against each one to generate the documents as well as renaming the generated .html files to their desired form.

$ ./manning-up.sh

To only (re)generate a specific .md manual template and have .1.html renamed to .html yau may also use manning-up.sh.

$ ./manning-up.sh git-info.md

AUTHOR

Written by Leila Muhtasib <muhtasib@gmail.com> Shell Script by Nick Lombard <github@jigsoft.co.za>

REPORTING BUGS

<https://github.com/tj/git-extras/issues>

SEE ALSO

<https://github.com/tj/git-extras>