From 157ebf5433e98ddca88fcec4319bcaf510cfc4ad Mon Sep 17 00:00:00 2001 From: Jonas Fonseca Date: Tue, 17 Nov 2009 22:25:49 -0500 Subject: [PATCH] tigmanual(7): provide the manual as a man page --- .gitignore | 1 + Makefile | 11 +++++++++-- NEWS | 1 + manual.txt | 2 ++ tig.1.txt | 2 +- tigmanual.7.txt | 20 ++++++++++++++++++++ tigrc.5.txt | 2 +- 7 files changed, 35 insertions(+), 4 deletions(-) create mode 100644 tigmanual.7.txt diff --git a/.gitignore b/.gitignore index fdd3210..bd0c3a9 100644 --- a/.gitignore +++ b/.gitignore @@ -15,6 +15,7 @@ tig-*.tar.gz.md5 tig.1 tig.spec tigrc.5 +tigmanual.7 *.html *.o *.xml diff --git a/Makefile b/Makefile index 8688eb5..163e240 100644 --- a/Makefile +++ b/Makefile @@ -37,7 +37,7 @@ CFLAGS ?= -Wall -O2 DFLAGS = -g -DDEBUG -Werror -O0 PROGS = tig TXTDOC = tig.1.txt tigrc.5.txt manual.txt NEWS README INSTALL BUGS TODO -MANDOC = tig.1 tigrc.5 +MANDOC = tig.1 tigrc.5 manual.7 HTMLDOC = tig.1.html tigrc.5.html manual.html README.html NEWS.html ALLDOC = $(MANDOC) $(HTMLDOC) manual.html-chunked manual.pdf @@ -73,12 +73,14 @@ install: all install-doc-man: doc-man mkdir -p $(DESTDIR)$(mandir)/man1 \ - $(DESTDIR)$(mandir)/man5 + $(DESTDIR)$(mandir)/man5 \ + $(DESTDIR)$(mandir)/man7 for doc in $(MANDOC); do \ sed 's#++SYSCONFDIR++#$(sysconfdir)#' < "$$doc" > "$$doc+"; \ case "$$doc" in \ *.1) install -p -m 0644 "$$doc+" "$(DESTDIR)$(mandir)/man1/$$doc" ;; \ *.5) install -p -m 0644 "$$doc+" "$(DESTDIR)$(mandir)/man5/$$doc" ;; \ + *.7) install -p -m 0644 "$$doc+" "$(DESTDIR)$(mandir)/man7/$$doc" ;; \ esac; \ $(RM) "$$doc+"; \ done @@ -156,6 +158,8 @@ README.html: README SITES INSTALL asciidoc.conf NEWS.html: NEWS asciidoc.conf $(ASCIIDOC) $(ASCIIDOC_FLAGS) -b xhtml11 -d article $< +tigmanual.7: manual.txt + %.1.html : %.1.txt asciidoc.conf $(ASCIIDOC) $(ASCIIDOC_FLAGS) -b xhtml11 -d manpage $< @@ -168,6 +172,9 @@ NEWS.html: NEWS asciidoc.conf %.5.xml : %.5.txt asciidoc.conf $(ASCIIDOC) $(ASCIIDOC_FLAGS) -b docbook -d manpage $< +%.7.xml : %.7.txt asciidoc.conf + $(ASCIIDOC) $(ASCIIDOC_FLAGS) -b docbook -d manpage $< + %.html : %.txt asciidoc.conf $(ASCIIDOC) $(ASCIIDOC_FLAGS) -b xhtml11 -d article -n $< diff --git a/NEWS b/NEWS index 200b6cc..1a17177 100644 --- a/NEWS +++ b/NEWS @@ -11,6 +11,7 @@ Incompatibilities: Improvements: + - Provide the manual as a man page named tigmanual(7). - Add ability to toggle between showing shorter dates (without time info) and relative dates. Use 'D' to toggle between date formats. - Show the active (instead of the default) keybindings in the help diff --git a/manual.txt b/manual.txt index 559c345..cc8cb79 100644 --- a/manual.txt +++ b/manual.txt @@ -1,6 +1,8 @@ +ifndef::doctype-manpage[] The tig Manual ============== Jonas Fonseca +endif::doctype-manpage[] This is the manual for tig, the ncurses-based text-mode interface for git. Tig allows you to browse changes in a git repository and can additionally act diff --git a/tig.1.txt b/tig.1.txt index db8a4d7..96c7c9c 100644 --- a/tig.1.txt +++ b/tig.1.txt @@ -161,7 +161,7 @@ the Free Software Foundation; either version 2 of the License, or SEE ALSO -------- -manpage:tigrc[5], git(7), gitk(1) +manpage:tigrc[5], manpage:tigmanual[7], git(7), gitk(1) Online resources: diff --git a/tigmanual.7.txt b/tigmanual.7.txt new file mode 100644 index 0000000..635c866 --- /dev/null +++ b/tigmanual.7.txt @@ -0,0 +1,20 @@ +tigmanual(7) +============ + +NAME +---- +tigmanual - text-mode interface for git + +SYNOPSIS +-------- +[verse] +tig [options] [revisions] [--] [paths] +tig show [options] [revisions] [--] [paths] +tig blame [rev] path +tig status +tig < [git command output] + +DESCRIPTION +----------- + +include::manual.txt[] diff --git a/tigrc.5.txt b/tigrc.5.txt index 711c6a4..be9bf8d 100644 --- a/tigrc.5.txt +++ b/tigrc.5.txt @@ -503,5 +503,5 @@ Licensed under the terms of the GNU General Public License. SEE ALSO -------- -manpage:tig[1], git-config(1), +manpage:tig[1], manpage:tigmanual[7], git-config(1), and the http://jonas.nitro.dk/tig/manual.html[tig manual]. -- 2.30.2