index 3f6ff92d9d2770b39b6a19e58e93c469dead4cec..3f4844dc01cdf37a0cafaf648a1f96536f7641cd 100644 (file)
--- a/INSTALL
+++ b/INSTALL
$ make
$ make install install-doc
-Optionally, you can use the `configure` script to detect library location:
+From tig's git repository it is also possible to install documentation directly
+from the release branch to avoid installing the documentation tool chain:
+
+ $ make install-release-doc
+
+Optionally, you can use the `configure` script to detect dependencies:
$ ./configure
$ make
$ make configure
+Build settings are read from the file "config.make". To manually configure tig
+to use the ncurses library with wide character support, add the line:
+
+ LDLIBS = -lncursesw
+
Release notes documenting notable changes are available in the NEWS file. When
-upgrading, you are adviced to also read them after you have completed the
+upgrading, you are advised to also read them after you have completed the
installation.
The following tools and packages are needed:
-`-------------------------------`----------------------------------------------
-Tool Description
--------------------------------------------------------------------------------
-git-core Tig is just a frontend for git.
-ncurses Be sure to also have development files \
- installed. Usually they are available in a \
- separate package ending with `-dev`.
-iconv If iconv is not provided by the c library \
- you need to change the Makefile to link it \
- into the binary.
--------------------------------------------------------------------------------
+[cols="2<,8<",options="header"]
+|=============================================================================
+|Tool |Description
+|git-core |Tig is just a frontend for git.
+|ncurses or ncursesw |Be sure to have the development files
+ installed. Usually they are available in a
+ separate package ending with `-dev`.
+ Note also that ncurses with wide character
+ support (ncursesw) is required to properly
+ handle UTF-8 encoded strings.
+|iconv |If iconv is not provided by the c library
+ you need to change the Makefile to link it
+ into the binary.
+|=============================================================================
The following optional tools and packages are needed for creating the
configure script and building documentation:
-`-------------------------------`----------------------------------------------
-autoconf Contains autoreconf for generating configure \
- from configure.ac.
-asciidoc (>= 8.0) Generates HTML and (DocBook) XML from text.
-xmlto Generates manpages and chunked HTML from XML.
-DocBook XSL (>= 1.72.0) Used by xmlto for building manpages.
-DocBook (DSSL/Jade) tools Generates PDF from XML. \
+[cols="2<,8<",options="header"]
+|=============================================================================
+|Tool |Description
+|autoconf |Contains autoreconf for generating configure
+ from configure.ac.
+|asciidoc (>= 8.4) |Generates HTML and (DocBook) XML from text.
+|xmlto |Generates manpages and chunked HTML from XML.
+|DocBook XSL (>= 1.72.0) |Used by xmlto for building manpages.
+|DocBook (DSSL/Jade) tools |Generates PDF from XML.
Also known as docbook-utils.
--------------------------------------------------------------------------------
+|=============================================================================