![[tokkee]](http://tokkee.org/images/avatar.png){kind=avatar}
index 088f6742c41683e63daa04417a66048d5bd340e4..3f4844dc01cdf37a0cafaf648a1f96536f7641cd 100644 (file)
--- a/INSTALL
+++ b/INSTALL
Download a tarball from http://jonas.nitro.dk/tig/releases[] or clone the tig
repository http://jonas.nitro.dk/tig/tig.git[]. Documentation files are
-available either in the tarballs or in the above repository in the branch named
-'release'.
+available in the tarballs and in the 'release' branch of the tig repository.
-To install tig simply run:
+The quick and simple way to install tig with documentation is to run:
+ $ make
+ $ make install install-doc
+
+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 install
-To install documentation run:
+If your iconv library is not in the default library and include path, you'll
+probably want to pass the "--with-libiconv" option to the "configure" script to
+tell it where to look. Note, if you are building from the tig repository, you
+need to first make the configure script:
- $ make install-docs
+ $ make configure
-Edit the Makefile if you need to configure specific compiler or linker flags.
-On FreeBSD for example the c library does not support the iconv interface and
-to compile tig you need to append `-L/usr/local/lib -liconv` to `LDLIBS` and
-`-I/usr/local/include` to the `CFLAGS` variable.
+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 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.
-asciidoc (>= 7.0), xmlto For building documentation. (Optional)
--------------------------------------------------------------------------------
+[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:
+
+[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.
+|=============================================================================