INSTALL

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