INSTALL

   1 Installation instructions
   2 -------------------------
   3
   4 Download a tarball from http://jonas.nitro.dk/tig/releases[] or clone the tig
   5 repository http://jonas.nitro.dk/tig/tig.git[]. Documentation files are
   6 available in the tarballs and in the 'release' branch of the tig repository.
   7
   8 The quick and simple way to install tig with documentation is to run:
   9
  10         $ make
  11         $ make install install-doc
  12
  13 From tig's git repository it is also possible to install documentation directly
  14 from the release branch to avoid installing the documentation tool chain:
  15
  16         $ make install-release-doc
  17
  18 Optionally, you can use the `configure` script to detect dependencies:
  19
  20         $ ./configure
  21         $ make
  22         $ make install
  23
  24 If your iconv library is not in the default library and include path, you'll
  25 probably want to pass the "--with-libiconv" option to the "configure" script to
  26 tell it where to look. Note, if you are building from the tig repository, you
  27 need to first make the configure script:
  28
  29         $ make configure
  30
  31 Release notes documenting notable changes are available in the NEWS file. When
  32 upgrading, you are advised to also read them after you have completed the
  33 installation.
  34
  35 The following tools and packages are needed:
  36
  37 [cols="2<,8<",options="header"]
  38 |=============================================================================
  39 |Tool                           |Description
  40 |git-core                       |Tig is just a frontend for git.
  41 |ncurses                        |Be sure to also have development files
  42                                  installed. Usually they are available in a
  43                                  separate package ending with `-dev`.
  44 |iconv                          |If iconv is not provided by the c library
  45                                  you need to change the Makefile to link it
  46                                  into the binary.
  47 |=============================================================================
  48
  49 The following optional tools and packages are needed for creating the
  50 configure script and building documentation:
  51
  52 [cols="2<,8<",options="header"]
  53 |=============================================================================
  54 |Tool                           |Description
  55 |autoconf                       |Contains autoreconf for generating configure
  56                                  from configure.ac.
  57 |asciidoc (>= 8.4)              |Generates HTML and (DocBook) XML from text.
  58 |xmlto                          |Generates manpages and chunked HTML from XML.
  59 |DocBook XSL (>= 1.72.0)        |Used by xmlto for building manpages.
  60 |DocBook (DSSL/Jade) tools      |Generates PDF from XML.
  61                                 Also known as docbook-utils.
  62 |=============================================================================