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
Julio Napurí 732ec9638f git-lock Lock files in git repository
2014-07-10 11:27:57 -05:00
..
git-alias.1 Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-alias.html Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-alias.md Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-archive-file.1 added man pages for git-archive-file 2013-02-15 05:46:21 +01:00
git-archive-file.html added man pages for git-archive-file 2013-02-15 05:46:21 +01:00
git-archive-file.md added man pages for git-archive-file 2013-02-15 05:46:21 +01:00
git-back.1 Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-back.html Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-back.md Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-bug.1 Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-bug.html Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-bug.md Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-changelog.1 Update git-changelog docs for --no-merges option 2013-12-01 18:18:03 -05:00
git-changelog.html Update git-changelog docs for --no-merges option 2013-12-01 18:18:03 -05:00
git-changelog.md Update git-changelog docs for --no-merges option 2013-12-01 18:18:03 -05:00
git-commits-since.1 Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-commits-since.html Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-commits-since.md Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-contrib.1 Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-contrib.html Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-contrib.md Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-count.1 Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-count.html Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-count.md Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-create-branch.1 Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-create-branch.html Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-create-branch.md Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-delete-branch.1 Added multi-delete for git-delete-branch and git-delete-tag 2013-09-15 14:40:35 -07:00
git-delete-branch.html Added multi-delete for git-delete-branch and git-delete-tag 2013-09-15 14:40:35 -07:00
git-delete-branch.md Added multi-delete for git-delete-branch and git-delete-tag 2013-09-15 14:40:35 -07:00
git-delete-merged-branches.1 docs updates for get-delete-merged-branches 2012-11-04 08:22:00 -07:00
git-delete-merged-branches.html docs updates for get-delete-merged-branches 2012-11-04 08:22:00 -07:00
git-delete-merged-branches.md docs updates for get-delete-merged-branches 2012-11-04 08:22:00 -07:00
git-delete-submodule.1 Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-delete-submodule.html Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-delete-submodule.md Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-delete-tag.1 Added multi-delete for git-delete-branch and git-delete-tag 2013-09-15 14:40:35 -07:00
git-delete-tag.html Added multi-delete for git-delete-branch and git-delete-tag 2013-09-15 14:40:35 -07:00
git-delete-tag.md Added multi-delete for git-delete-branch and git-delete-tag 2013-09-15 14:40:35 -07:00
git-effort.1 Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-effort.html Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-effort.md Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-extras.1 Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-extras.html Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-extras.md Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-feature.1 Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-feature.html Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-feature.md Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-fresh-branch.1 Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-fresh-branch.html Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-fresh-branch.md Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-gh-pages.1 Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-gh-pages.html Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-gh-pages.md Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-graft.1 Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-graft.html Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-graft.md Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-ignore.1 Small typo correction 2013-08-15 12:31:22 +02:00
git-ignore.html Small typo correction 2013-08-15 12:31:22 +02:00
git-ignore.md Small typo correction 2013-08-15 12:31:22 +02:00
git-info.1 Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-info.html Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-info.md Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-local-commits.1 Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-local-commits.html Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-local-commits.md Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-lock.1 git-lock Lock files in git repository 2014-07-10 11:27:57 -05:00
git-lock.html git-lock Lock files in git repository 2014-07-10 11:27:57 -05:00
git-lock.md git-lock Lock files in git repository 2014-07-10 11:27:57 -05:00
git-missing.1 allow options to be passed through to git log 2013-07-05 15:31:46 -07:00
git-missing.html allow options to be passed through to git log 2013-07-05 15:31:46 -07:00
git-missing.md allow options to be passed through to git log 2013-07-05 15:31:46 -07:00
git-rebase-patch.1 Add git-rebase-patch 2014-07-10 09:54:17 +02:00
git-rebase-patch.html Add git-rebase-patch 2014-07-10 09:54:17 +02:00
git-rebase-patch.md Add git-rebase-patch 2014-07-10 09:54:17 +02:00
git-refactor.1 Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-refactor.html Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-refactor.md Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-release.1 Add remote parameter to git-release 2012-10-25 18:19:04 -06:00
git-release.html Add remote parameter to git-release 2012-10-25 18:19:04 -06:00
git-release.md Add remote parameter to git-release 2012-10-25 18:19:04 -06:00
git-rename-tag.1 Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-rename-tag.html Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-rename-tag.md Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-repl.1 Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-repl.html Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-repl.md Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-setup.1 Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-setup.html Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-setup.md Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-show-tree.1 Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-show-tree.html Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-show-tree.md Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-squash.1 Fix git-squash typo 2013-10-04 09:31:44 +01:00
git-squash.html Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-squash.md Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-summary.1 Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-summary.html Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-summary.md Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-touch.1 Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-touch.html Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-touch.md Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-undo.1 Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-undo.html Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
git-undo.md Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
index.txt The complete index of all available documents. 2012-07-22 22:27:37 +02:00
man-template.md Replace http with https for man Github urls 2012-09-25 14:13:53 +08:00
manning-up.sh Generate only a single manual. 2012-07-22 22:27:38 +02:00
Readme.md Update Readme.md 2013-10-04 10:33:29 +01: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/visionmedia/git-extras/issues>

SEE ALSO

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