X-Git-Url: https://git.tokkee.org/?a=blobdiff_plain;f=INSTALL;h=3f4844dc01cdf37a0cafaf648a1f96536f7641cd;hb=389378ae4f62653a77d6b1679989734715a0fc22;hp=7759326a5d1dfc4b1da564ca43a306169842e5e8;hpb=16bda3aa4443fe29a3310bc682cfe9aad9ae54b5;p=tig.git diff --git a/INSTALL b/INSTALL index 7759326..3f4844d 100644 --- a/INSTALL +++ b/INSTALL @@ -10,7 +10,12 @@ The quick and simple way to install tig with documentation is to run: $ 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 @@ -23,33 +28,43 @@ need to first make the configure script: $ 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 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. -------------------------------------------------------------------------------- +|=============================================================================