utils-code/tj.git-extras
1
0
Fork 0
mirror of https://github.com/tj/git-extras.git synced 2026-09-10 07:26:17 -04:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
tj.git-extras/man
History
spacewander 1b84048bfc Add --no-email to git-author 
This feature is used to generate AUTHORS in 4.2.0 release.
2016-10-12 14:37:45 +08:00
..
git-alias.1 Update all man pages. 2015-12-27 11:26:38 -06:00
git-alias.html Update all man pages. 2015-12-27 11:26:38 -06:00
git-alias.md change 'search-term' to 'search-pattern' 2015-08-09 19:33:13 +08:00
git-archive-file.1 Update all man pages. 2015-12-27 11:26:38 -06:00
git-archive-file.html Update all man pages. 2015-12-27 11:26:38 -06:00
git-archive-file.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-authors.1 Add --no-email to git-author 2016-10-12 14:37:45 +08:00
git-authors.html Add --no-email to git-author 2016-10-12 14:37:45 +08:00
git-authors.md Add --no-email to git-author 2016-10-12 14:37:45 +08:00
git-back.1 Update all man pages. 2015-12-27 11:26:38 -06:00
git-back.html Update all man pages. 2015-12-27 11:26:38 -06:00
git-back.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-bug.1 Update all man pages. 2015-12-27 11:26:38 -06:00
git-bug.html Update all man pages. 2015-12-27 11:26:38 -06:00
git-bug.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-changelog.1 Update all man pages. 2015-12-27 11:26:38 -06:00
git-changelog.html Update all man pages. 2015-12-27 11:26:38 -06:00
git-changelog.md git-changelog: option to only use merges 2015-10-18 16:11:10 +02:00
git-chore.1 Update all man pages. 2015-12-27 11:26:38 -06:00
git-chore.html Update all man pages. 2015-12-27 11:26:38 -06:00
git-chore.md adding git-chore 2015-02-04 11:52:23 -05:00
git-clear-soft.1 update the title of git-clear-soft 2016-07-21 22:57:34 +08:00
git-clear-soft.html update the title of git-clear-soft 2016-07-21 22:57:34 +08:00
git-clear-soft.md update the title of git-clear-soft 2016-07-21 22:57:34 +08:00
git-clear.1 Add git-clear-soft command 2016-05-01 19:05:21 +02:00
git-clear.html Add git-clear-soft command 2016-05-01 19:05:21 +02:00
git-clear.md Add git-clear-soft command 2016-05-01 19:05:21 +02:00
git-commits-since.1 Update all man pages. 2015-12-27 11:26:38 -06:00
git-commits-since.html Update all man pages. 2015-12-27 11:26:38 -06:00
git-commits-since.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-contrib.1 Update all man pages. 2015-12-27 11:26:38 -06:00
git-contrib.html Update all man pages. 2015-12-27 11:26:38 -06:00
git-contrib.md contrib: update docs 2015-08-04 19:19:46 +02:00
git-count.1 Update all man pages. 2015-12-27 11:26:38 -06:00
git-count.html Update all man pages. 2015-12-27 11:26:38 -06:00
git-count.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-create-branch.1 Update all man pages. 2015-12-27 11:26:38 -06:00
git-create-branch.html Update all man pages. 2015-12-27 11:26:38 -06: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 Update all man pages. 2015-12-27 11:26:38 -06:00
git-delete-branch.html Update all man pages. 2015-12-27 11:26:38 -06: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 Update all man pages. 2015-12-27 11:26:38 -06:00
git-delete-merged-branches.html Update all man pages. 2015-12-27 11:26:38 -06:00
git-delete-merged-branches.md add show-merged-branches and show-unmerged-branches 2015-03-18 09:33:02 -04:00
git-delete-submodule.1 Update all man pages. 2015-12-27 11:26:38 -06:00
git-delete-submodule.html Update all man pages. 2015-12-27 11:26:38 -06: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 Update all man pages. 2015-12-27 11:26:38 -06:00
git-delete-tag.html Update all man pages. 2015-12-27 11:26:38 -06:00
git-delete-tag.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-delta.1 Update all man pages. 2015-12-27 11:26:38 -06:00
git-delta.html Update all man pages. 2015-12-27 11:26:38 -06:00
git-delta.md git-delta 2015-02-09 21:09:11 -05:00
git-effort.1 Update all man pages. 2015-12-27 11:26:38 -06:00
git-effort.html Update all man pages. 2015-12-27 11:26:38 -06:00
git-effort.md effort: More robust argument parsing 2015-09-13 23:55:28 +02:00
git-extras.1 Update all man pages. 2015-12-27 11:26:38 -06:00
git-extras.html Update all man pages. 2015-12-27 11:26:38 -06:00
git-extras.md Add git reauthor (#548) 2016-08-02 19:41:56 +02:00
git-feature.1 Update all man pages. 2015-12-27 11:26:38 -06:00
git-feature.html Update all man pages. 2015-12-27 11:26:38 -06:00
git-feature.md update git-feature docs 2015-09-11 20:23:20 +08:00
git-fork.1 Update git-fork man page 2016-08-04 12:52:19 +01:00
git-fork.html Update git-fork man page 2016-08-04 12:52:19 +01:00
git-fork.md Update git-fork man page 2016-08-04 12:52:19 +01:00
git-fresh-branch.1 Update all man pages. 2015-12-27 11:26:38 -06:00
git-fresh-branch.html Update all man pages. 2015-12-27 11:26:38 -06: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 Update all man pages. 2015-12-27 11:26:38 -06:00
git-gh-pages.html Update all man pages. 2015-12-27 11:26:38 -06:00
git-gh-pages.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-graft.1 Update all man pages. 2015-12-27 11:26:38 -06:00
git-graft.html Update all man pages. 2015-12-27 11:26:38 -06:00
git-graft.md graft: Require destination branch. Fix #23 2015-07-25 04:16:09 +02:00
git-guilt.1 Update all man pages. 2015-12-27 11:26:38 -06:00
git-guilt.html Update all man pages. 2015-12-27 11:26:38 -06:00
git-guilt.md guilt: remove --help option 2015-08-07 08:35:32 +02:00
git-ignore-io.1 Update all man pages. 2015-12-27 11:26:38 -06:00
git-ignore-io.html Update all man pages. 2015-12-27 11:26:38 -06:00
git-ignore-io.md Update git-ignore-io mannual 2015-09-20 18:44:40 +08:00
git-ignore.1 Update all man pages. 2015-12-27 11:26:38 -06:00
git-ignore.html Update all man pages. 2015-12-27 11:26:38 -06:00
git-ignore.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-info.1 Update all man pages. 2015-12-27 11:26:38 -06:00
git-info.html Update all man pages. 2015-12-27 11:26:38 -06:00
git-info.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-line-summary.1 Update all man pages. 2015-12-27 11:26:38 -06:00
git-line-summary.html Update all man pages. 2015-12-27 11:26:38 -06:00
git-line-summary.md Document for git-line-summary 2015-05-14 22:13:37 +08:00
git-local-commits.1 Update all man pages. 2015-12-27 11:26:38 -06:00
git-local-commits.html Update all man pages. 2015-12-27 11:26:38 -06:00
git-local-commits.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-lock.1 Update all man pages. 2015-12-27 11:26:38 -06:00
git-lock.html Update all man pages. 2015-12-27 11:26:38 -06:00
git-lock.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-locked.1 Update all man pages. 2015-12-27 11:26:38 -06:00
git-locked.html Update all man pages. 2015-12-27 11:26:38 -06:00
git-locked.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-merge-into.1 Update all man pages. 2015-12-27 11:26:38 -06:00
git-merge-into.html Update all man pages. 2015-12-27 11:26:38 -06:00
git-merge-into.md merge-into: change --ff option to --ff-only. fix #421 2015-08-14 13:03:39 +02:00
git-merge-repo.1 Update all man pages. 2015-12-27 11:26:38 -06:00
git-merge-repo.html Update all man pages. 2015-12-27 11:26:38 -06:00
git-merge-repo.md git-merge-repo 2015-04-19 12:23:02 -04:00
git-missing.1 Update all man pages. 2015-12-27 11:26:38 -06:00
git-missing.html Update all man pages. 2015-12-27 11:26:38 -06:00
git-missing.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-obliterate.1 regenerate git-obliterate doc 2016-07-28 22:24:40 +08:00
git-obliterate.html regenerate git-obliterate doc 2016-07-28 22:24:40 +08:00
git-obliterate.md add missing git-obliterate documentation 2015-08-05 10:51:08 +08:00
git-pr.1 Update git PR manual to mention URLs 2016-01-22 18:01:28 +08:00
git-pr.html Regerenate git-pr.html 2016-01-22 20:51:36 +08:00
git-pr.md Update git PR manual to mention URLs 2016-01-22 18:01:28 +08:00
git-psykorebase.1 Update all man pages. 2015-12-27 11:26:38 -06:00
git-psykorebase.html Update all man pages. 2015-12-27 11:26:38 -06:00
git-psykorebase.md Improve man page presentation. 2015-08-11 11:30:36 +02:00
git-pull-request.1 pull-request: should read local config if present 2016-08-07 09:43:07 +02:00
git-pull-request.html pull-request: should read local config if present 2016-08-07 09:43:07 +02:00
git-pull-request.md pull-request: should read local config if present 2016-08-07 09:43:07 +02:00
git-reauthor.1 Add git reauthor (#548) 2016-08-02 19:41:56 +02:00
git-reauthor.html Add git reauthor (#548) 2016-08-02 19:41:56 +02:00
git-reauthor.md Add git reauthor (#548) 2016-08-02 19:41:56 +02:00
git-rebase-patch.1 Update all man pages. 2015-12-27 11:26:38 -06:00
git-rebase-patch.html Update all man pages. 2015-12-27 11:26:38 -06: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 Update all man pages. 2015-12-27 11:26:38 -06:00
git-refactor.html Update all man pages. 2015-12-27 11:26:38 -06:00
git-refactor.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-release.1 git-release: fix typo in documentation 2016-08-06 17:39:31 -07:00
git-release.html git-release: fix typo in documentation 2016-08-06 17:39:31 -07:00
git-release.md git-release: fix typo in documentation 2016-08-06 17:39:31 -07:00
git-rename-branch.1 add rename-branch command (#576) 2016-09-11 09:11:32 +05:30
git-rename-branch.html add rename-branch command (#576) 2016-09-11 09:11:32 +05:30
git-rename-branch.md add rename-branch command (#576) 2016-09-11 09:11:32 +05:30
git-rename-tag.1 Update all man pages. 2015-12-27 11:26:38 -06:00
git-rename-tag.html Update all man pages. 2015-12-27 11:26:38 -06:00
git-rename-tag.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-repl.1 git-repl: improve and clean up docs 2016-08-12 15:57:26 +02:00
git-repl.html git-repl: improve and clean up docs 2016-08-12 15:57:26 +02:00
git-repl.md git-repl: improve and clean up docs 2016-08-12 15:57:26 +02:00
git-reset-file.1 Update all man pages. 2015-12-27 11:26:38 -06:00
git-reset-file.html Update all man pages. 2015-12-27 11:26:38 -06:00
git-reset-file.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-root.1 Update all man pages. 2015-12-27 11:26:38 -06:00
git-root.html Update all man pages. 2015-12-27 11:26:38 -06: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-scp.1 Update all man pages. 2015-12-27 11:26:38 -06:00
git-scp.html Update all man pages. 2015-12-27 11:26:38 -06:00
git-scp.md path argument can not be optional in rscp; add more docs 2014-12-29 00:14:44 +11:00
git-sed.1 Update all man pages. 2015-12-27 11:26:38 -06:00
git-sed.html Update all man pages. 2015-12-27 11:26:38 -06:00
git-sed.md add simple sed command 2015-10-08 16:13:27 -04:00
git-setup.1 Update all man pages. 2015-12-27 11:26:38 -06:00
git-setup.html Update all man pages. 2015-12-27 11:26:38 -06:00
git-setup.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-show-merged-branches.1 Update all man pages. 2015-12-27 11:26:38 -06:00
git-show-merged-branches.html Update all man pages. 2015-12-27 11:26:38 -06:00
git-show-merged-branches.md add show-merged-branches and show-unmerged-branches 2015-03-18 09:33:02 -04:00
git-show-tree.1 Update all man pages. 2015-12-27 11:26:38 -06:00
git-show-tree.html Update all man pages. 2015-12-27 11:26:38 -06:00
git-show-tree.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-show-unmerged-branches.1 Update all man pages. 2015-12-27 11:26:38 -06:00
git-show-unmerged-branches.html Update all man pages. 2015-12-27 11:26:38 -06:00
git-show-unmerged-branches.md add show-merged-branches and show-unmerged-branches 2015-03-18 09:33:02 -04:00
git-squash.1 Update all man pages. 2015-12-27 11:26:38 -06:00
git-squash.html Update all man pages. 2015-12-27 11:26:38 -06:00
git-squash.md updated documentation because git-squash does no longer delete source-branch 2014-12-27 20:45:28 +01:00
git-standup.1 add docs for git standup 2016-04-15 20:34:03 +08:00
git-standup.html add docs for git standup 2016-04-15 20:34:03 +08:00
git-standup.md add docs for git standup 2016-04-15 20:34:03 +08:00
git-summary.1 Update all man pages. 2015-12-27 11:26:38 -06:00
git-summary.html Update all man pages. 2015-12-27 11:26:38 -06:00
git-summary.md summary docs: Remove --line example 2015-08-07 08:36:55 +02:00
git-sync.1 upstream is used by default 2016-01-16 01:40:10 +09:00
git-sync.html upstream is used by default 2016-01-16 01:40:10 +09:00
git-sync.md upstream is used by default 2016-01-16 01:40:10 +09:00
git-touch.1 Update all man pages. 2015-12-27 11:26:38 -06:00
git-touch.html Update all man pages. 2015-12-27 11:26:38 -06:00
git-touch.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-undo.1 Update all man pages. 2015-12-27 11:26:38 -06:00
git-undo.html Update all man pages. 2015-12-27 11:26:38 -06:00
git-undo.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
git-unlock.1 Update all man pages. 2015-12-27 11:26:38 -06:00
git-unlock.html Update all man pages. 2015-12-27 11:26:38 -06:00
git-unlock.md replace visionmedia/git-extras to tj/git-extras 2014-11-06 17:12:01 +08:00
index.txt Add git reauthor (#548) 2016-08-02 19:41:56 +02: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 add link to ronn git repo (#575) 2016-09-11 09:11:49 +05:30

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>