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
Riceball LEE 48eb195ee0 + custom commit message options supports
2015-02-12 17:55:31 +08:00
..
git-alias.1 Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-alias.html Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-alias.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-archive-file.1 Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-archive-file.html Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-archive-file.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-authors.1 Add git-authors 2015-02-07 17:24:21 +01:00
git-authors.html Add git-authors 2015-02-07 17:24:21 +01:00
git-authors.md Add git-authors 2015-02-07 17:24:21 +01:00
git-back.1 Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-back.html Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-back.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-bug.1 Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-bug.html Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-bug.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-changelog.1 Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-changelog.html Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-changelog.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-chore.1 adding git-chore 2015-02-04 11:52:23 -05:00
git-chore.html adding git-chore 2015-02-04 11:52:23 -05:00
git-chore.md adding git-chore 2015-02-04 11:52:23 -05:00
git-commits-since.1 Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-commits-since.html Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-commits-since.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-contrib.1 Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-contrib.html Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-contrib.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-count.1 Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-count.html Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-count.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-create-branch.1 Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-create-branch.html Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-create-branch.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-delete-branch.1 Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-delete-branch.html Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
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 Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-delete-merged-branches.html Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
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 Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-delete-submodule.html Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-delete-submodule.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-delete-tag.1 Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-delete-tag.html Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-delete-tag.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-delta.1 git-delta 2015-02-09 21:09:11 -05:00
git-delta.html git-delta 2015-02-09 21:09:11 -05:00
git-delta.md git-delta 2015-02-09 21:09:11 -05:00
git-effort.1 Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-effort.html Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-effort.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-extras.1 Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-extras.html Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-extras.md correct the '-m' argument for grep. Then regenralize git-extra 2014-11-06 21:33:14 +08:00
git-feature.1 Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-feature.html Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-feature.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-fork.1 Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-fork.html Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-fork.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-fresh-branch.1 Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-fresh-branch.html Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-fresh-branch.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-gh-pages.1 Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-gh-pages.html Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-gh-pages.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-graft.1 Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-graft.html Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-graft.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-ignore.1 Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-ignore.html Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-ignore.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-info.1 Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-info.html Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-info.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-local-commits.1 Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-local-commits.html Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-local-commits.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-lock.1 Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-lock.html Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-lock.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-locked.1 Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-locked.html Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-locked.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-missing.1 Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-missing.html Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-missing.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-pr.1 Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-pr.html Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-pr.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-rebase-patch.1 Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-rebase-patch.html Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
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 Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-refactor.html Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-refactor.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-release.1 Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-release.html Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-release.md + custom commit message options supports 2015-02-12 17:55:31 +08:00
git-rename-tag.1 Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-rename-tag.html Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-rename-tag.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-repl.1 Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-repl.html Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-repl.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-reset-file.1 Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-reset-file.html Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-reset-file.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-root.1 Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-root.html Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
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-scp.1 path argument can not be optional in rscp; add more docs 2014-12-29 00:14:44 +11:00
git-scp.html path argument can not be optional in rscp; add more docs 2014-12-29 00:14:44 +11:00
git-scp.md path argument can not be optional in rscp; add more docs 2014-12-29 00:14:44 +11:00
git-setup.1 Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-setup.html Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-setup.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-show-tree.1 Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-show-tree.html Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-show-tree.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-squash.1 updated documentation because git-squash does no longer delete source-branch 2014-12-27 20:45:28 +01:00
git-squash.html updated documentation because git-squash does no longer delete source-branch 2014-12-27 20:45:28 +01:00
git-squash.md updated documentation because git-squash does no longer delete source-branch 2014-12-27 20:45:28 +01:00
git-summary.1 Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-summary.html Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-summary.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-touch.1 Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-touch.html Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-touch.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-undo.1 Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-undo.html Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-undo.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-unlock.1 Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
git-unlock.html Revert "Ignore *.html and *.1 auto-generated files in man/" 2014-12-12 17:34:41 +05:30
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>