INSTALL

   1 Installation instructions
   2 -------------------------
   3
   4 Download a tarball and extract it.
   5
   6 The quick and simple way to install CDimgtools with documentation in your home
   7 directory +~/.local+ is to run:
   8
   9 [source,sh]
  10 $ make .help
  11 $ make
  12 $ make install install-doc
  13
  14 Optionally, you can use the `configure` script to check for some dependencies
  15 and install system-wide:
  16
  17 [source,sh]
  18 $ ./configure
  19 $ make
  20 $ sudo make install
  21
  22 To configure CDimgtools you can tell `configure`.  For example:
  23
  24 [source,sh]
  25 $ ./configure --prefix=$HOME/.local/stow/cdimgtools
  26
  27 or manually modify the +config.make+ file after a call to `configure`.
  28
  29 Distributors may use the +DESTDIR+ Makefile variable to install the files for
  30 packaging:
  31
  32 [source,sh]
  33 $ make install DESTDIR=./packagefiles
  34
  35 Documentation building
  36 ~~~~~~~~~~~~~~~~~~~~~~
  37 To avoid the installation of the documentation tool chain, pre-compiled
  38 documentation files are available in distribution tarballs whose names end in
  39 +-doc+.
  40
  41 To force the re-building of the documentation, delete the files first:
  42
  43 [source,sh]
  44 $ make distclean doc-man doc-html
  45
  46
  47 [[dependencies]]
  48 Dependencies
  49 ------------
  50
  51 The following tools are required:
  52
  53 [cols="3<,8<",options="header"]
  54 |=============================================================================
  55 |Tool               |Description
  56 |Perl               |The scripts are written in perl.
  57 |=============================================================================
  58
  59 The following optional tools and packages are needed for (re-)creating the
  60 +configure+ script or for building the documentation:
  61
  62 [cols="3<,8<",options="header"]
  63 |=============================================================================
  64 |Tool               |Description
  65 |autoconf           |Contains autoreconf for generating configure
  66                  from configure.ac.
  67 |asciidoc (>= 8.4)  |Generates HTML and (DocBook) XML from text.
  68 |perldoc            |pod2man, pod2text, pod2html are used to extract the
  69                  documentation from the perl scripts.
  70 |=============================================================================