Debian Codegraph @

INSTALL

raw
1
2 Installation
3 ============
4
5 Windows
6 -------
7
8 On Windows, using the official Windows installation program is recommended.
9 If you want to build your own installer, see :ref:`win32_installer`.
10
11 Install on OSX
12 --------------
13
14 We are not currently distributing an installer for OSX. Instead, you must
15 install Exaile via Homebrew. For more details, see the
16 `homebrew-exaile <https://github.com/exaile/homebrew-exaile>` repo.
17
18 Linux/\*nix
19 -----------
20
21 .. note:: First you should install dependencies that are listed in the
22 :ref:`DEPS file <deps>`.
23
24 On \*nix-based systems (but not OSX), run the following command from the
25 source code directory to install:
26
27 .. code-block:: sh
28
29 $ make
30 # make install
31
32 The "make" step is optional and only compiles the modules and translations.
33
34 There is also an install_no_locale target if you wish to install without
35 translations.
36
37 To uninstall exaile please run:
38
39 .. code-block:: sh
40
41 # make uninstall
42
43 from the same directory.
44
45 Environment Variables
46 ^^^^^^^^^^^^^^^^^^^^^
47
48 Note: normally it should be enough to set ``PREFIX``, and potentially
49 ``LIBINSTALLDIR`` on a 64-bit system. The additional variables can provide
50 further installation customization.
51
52 Environment variables that affect "make install":
53
54 LIBINSTALLDIR
55 The full path to the lib directory.
56 Default: ``EPREFIX/lib``
57 DATADIR
58 The full path to non-architecture dependent data files.
59 Default: ``PREFIX/share``
60 MANPREFIX
61 The full path to the parent of the man page installation directory (same
62 as system DATADIR)
63 Default: ``PREFIX/share``
64 EPREFIX
65 The executable installation prefix.
66 Default: ``PREFIX``
67 PREFIX
68 The main installation prefix.
69 Default: ``/usr/local``
70 **Note**: If this default is changed, you may need to set the LIBINSTALLDIR or
71 XDG_DATA_DIRS environment variables to include the changed path. See [1].
72 XDGCONFDIR
73 The directory to install system-wide config files in, following xdg spec.
74 Default: ``/etc/xdg``
75 **Note**: If this default is changed, you may need to set the XDG_CONFIG_DIRS
76 environment variable to include the changed path. See [1].
77 DESTDIR
78 Destination directory to put the file structure under. Mainly of use for
79 packagers.
80 Default: not set (``/``)
81 DEFAULTARGS
82 Default arguments that the 'exaile' launcher script (installed to
83 ``$PREFIX/bin/exaile``) will pass to exaile on startup
84
85 Additional Resources:
86 1. `XDG Base Directory Specification <https://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html>`_