tigmanual(7): provide the manual as a man page

diff --git a/.gitignore b/.gitignore
index fdd321057bfe8a11a6e58e58e2659d79a219d7ea..bd0c3a9d41063499663728b0174a960868def51a 100644 (file)
--- 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 8688eb5bba268aec524cc0fc54e5efc4a63e0e98..163e240de557e636bf107ec1412c158cb4a33c1b 100644 (file)
--- 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 200b6cc05468ee782d8c2e8f4ca5dc549a56421c..1a1717797b093e0d395b5ea116fa82942dc5c7b4 100644 (file)
--- 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 559c34524881cee0d259b3d0d6cccc1c1af5dbe1..cc8cb795aca192f3808f8f7d4944bb7babb4fe26 100644 (file)
--- a/manual.txt
+++ b/manual.txt
@@ -1,6 +1,8 @@
+ifndef::doctype-manpage[]
 The tig Manual
 ==============
 Jonas Fonseca <fonseca@diku.dk>
+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 db8a4d7a45dc750ebf542be377e3d1b9d8a0814d..96c7c9c6b1eeaeae643cc3ac6c5eb3cf28fa8a65 100644 (file)
--- 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 (file)
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 711c6a48e91632bf4294c1ab830e8173675e8571..be9bf8dbf8f008428a04338d23b1bb6e42ac9f2f 100644 (file)
--- 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].