INSTALL

   1 Installation instructions
   2 -------------------------
   3
   4 Download a tar/gzip archive 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 in +/usr/local+:
  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 --help
  26 $ ./configure --prefix=/usr
  27
  28 Or you can edit the file +config.make+ after a call to `configure`, or set the
  29 Makefile variables on the command line:
  30
  31 [source,sh]
  32 $ make install prefix=$HOME/.local/stow/cdimgtools
  33
  34 Distributors may use the +DESTDIR+ Makefile variable to install the files for
  35 packaging:
  36
  37 [source,sh]
  38 $ make install DESTDIR=./packagefiles
  39
  40 RPM and DEB packages for Linux distributions
  41 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  42 You can download pre-packaged (architecture independent) +.rpm+ or +.deb+
  43 packages for your distribution's package management system.
  44
  45 Or you can create an RPM (both source and binary) (e.g. for Fedora) by typing:
  46
  47 [source,sh]
  48 $ make distclean
  49 $ make rpm
  50 $ sudo rpm -i ~/rpmbuild/RPMS/noarch/cdimgtools-<version>-<release>.noarch.rpm
  51   # and optionally install it
  52
  53 Or a source DSC and binary DEB package (e.g. for Debian and Ubuntu):
  54
  55 [source,sh]
  56 $ make debclean
  57 $ make deb
  58 $ sudo dpkg -i ../cdimgtools_<version>-<release>_all.deb
  59   # an optionally install it
  60
  61 Documentation building
  62 ~~~~~~~~~~~~~~~~~~~~~~
  63 To avoid the installation of the documentation tool chain, pre-compiled
  64 documentation files are available in distribution archives whose names end in
  65 +-doc+.
  66
  67 To force the re-building of the documentation, delete the files first:
  68
  69 [source,sh]
  70 $ make distclean doc-man doc-html
  71
  72
  73 [[dependencies]]
  74 Dependencies
  75 ------------
  76
  77 The following tools are required:
  78
  79 [cols="3<,8<",options="header"]
  80 |=============================================================================
  81 |Tool               |Description
  82 |Perl               |The scripts are written in perl.
  83 |=============================================================================
  84
  85 The following optional tools and packages are needed for (re-)creating the
  86 +configure+ script or for building the documentation:
  87
  88 [cols="3<,8<",options="header"]
  89 |=============================================================================
  90 |Tool               |Description
  91 |autoconf           |Contains autoreconf for generating configure
  92                  from configure.ac.
  93 |asciidoc (>= 8.4)  |Generates HTML and (DocBook) XML from text.
  94 |perldoc            |pod2man, pod2text, pod2html are used to extract the
  95                  documentation from the perl scripts.
  96 |=============================================================================