INSTALL

   1 ng-jackspa has been written under a GNU/Linux OS but should work under other
   2 UNIX flavours.
   3
   4
   5 Installation instructions
   6 -------------------------
   7
   8 The official source for release downloads is at
   9 <http://download.gna.org/ngjackspa/>.  The dependencies to build the package
  10 have to be installed first (see <<dependencies, Dependencies>> below).
  11
  12 To install directly from the sources' tree, download a release archive and
  13 extract it.  The quick and simple way to install ng-jackspa with documentation
  14 in your home directory +~/.local+ is to run:
  15
  16 [source,sh]
  17 $ make .help
  18 $ make
  19 $ make install install-doc
  20
  21 To adjust the installation process (as well as the build process) set Makefile
  22 variables on the command line:
  23
  24 [source,sh]
  25 $ make CFLAGS='-g -O2 -fstack-protector'
  26 $ make install prefix=$HOME/.local/stow/ngjackspa
  27
  28 Distributors might use the +DESTDIR+ Makefile variable to install the files for
  29 packaging:
  30
  31 [source,sh]
  32 $ make install DESTDIR=./packagefiles
  33
  34 Documentation building
  35 ~~~~~~~~~~~~~~~~~~~~~~
  36 To avoid the installation of the documentation tool chain, pre-compiled
  37 documentation files are available in the release archives.  To force the
  38 re-building of the documentation, delete the files first:
  39
  40 [source,sh]
  41 $ make distclean doc
  42
  43 Verifying the signatures
  44 ~~~~~~~~~~~~~~~~~~~~~~~~
  45 You need to have the
  46 link:https://gna.org/project/memberlist-gpgkeys.php?group=ngjackspa[GnuPG key]
  47 of the packager.
  48
  49 [source,sh]
  50 $ gpg --keyring ngjackspa-keyring.gpg -v ngjackspa-${version}.tar.gz.sig
  51
  52
  53 [[dependencies]]
  54 Dependencies
  55 ------------
  56
  57 The following tools are required:
  58
  59 [cols="3<,8<",options="header"]
  60 |=============================================================================
  61 |Tool               |Description
  62 |C/C++ compiler
  63         |link:http://gcc.gnu.org[GCC] and link:http://clang.llvm.org/[Clang] have
  64         been tested.
  65 |link:http://www.ladspa.org/[LADSPA SDK]
  66         |The include file 'ladspa.h' of the LADSPA sound plugin interface is
  67          required during the compilation.
  68 |link:http://jackaudio.org/download[JACK Audio Connection Kit]
  69         |The sound system.
  70 |link:http://www.gnu.org/software/ncurses/[ncurses]
  71         |Smart terminal API for the visual interface njackspa.
  72 |link:http://www.gtkmm.org/[gtkmm-2.4] and a compatible link:http://www.gtk.org/[GTK+]
  73         |Widgets for the graphical interface gjackspa.
  74 |link:http://qt-project.org/[Qt 4]
  75         |Widgets for the graphical interface qjackspa.
  76 |POSIX-like terminal interface and signals
  77         |For the command line interface jackspa-cli.
  78 |link:https://developer.gnome.org/glib/[Glib 2.0]
  79         |For the command line option parser of all the programs; also required by GTK+.
  80 |link:http://www.gnu.org/software/make/[GNU Make]
  81         |Used for building and installing.  Other make programs will not work.
  82 |=============================================================================
  83
  84 The following optional tools and packages are needed for (re-)building the
  85 documentation:
  86
  87 [cols="3<,8<",options="header"]
  88 |=============================================================================
  89 |Tool               |Description
  90 |link:http://www.methods.co.nz/asciidoc/[AsciiDoc]
  91         |Generates HTML and (DocBook) XML from text.
  92 |link:http://www.gnu.org/software/src-highlite/[GNU Source-highlight]
  93         |Used by asciidoc to highlight sh code.
  94 |link:http://cyberelk.net/tim/software/xmlto/[xmlto]
  95         |Generates UNIX manual pages from XML.
  96 |link:http://xmlsoft.org/XSLT/[xsltproc],
  97   link:http://docbook.sourceforge.net[DocBook XSL]
  98         |Used by xmlto for building the manual pages.
  99 |=============================================================================
 100
 101 Furthermore, you will require some LADSPA plugins at runtime.