1README.linux
2************
3
4Introduction
5============
6
7This file describes the steps required to build fswatch on a supported GNU/Linux
8system.
9
10The supported monitors on GNU/Linux systems are:
11
12  * The inotify monitor (on Linux kernels > 2.6.13).
13  * The poll monitor.
14
15The availability of the inotify API is checked by configure and it will be built
16into fswatch when found.  When available, the inotify monitor is the default
17choice on GNU/Linux systems.
18
19The list of monitors built into libfswatch can be read in the help message of
20fswatch:
21
22    $ fswatch --help
23
24Installation
25============
26
27See the INSTALL file for detailed information about how to configure and install
28fswatch.
29
30fswatch is a C++ program and a C++ compiler compliant with the C++11 standard is
31required to compile it.  Reasonably recent GNU/Linux distributions usually ship
32at least two such compilers:
33
34  * GCC.
35  * Clang.
36
37Please, check your distribution documentation to find an appropriate C++
38compiler and how to install it.
39
40The configure script enforces an ordered compiler search list and clang++ will
41be used first if available.  If you do not like this choice and wish to use
42another compiler set the value of the CXX environment variable to the name of
43your compiler binary.  If, for example, you wish to use the g++ compiler, then
44use this command to configure the build:
45
46    $ ./configure CXX=g++
47
48-----
49
50Copyright (c) 2014-2015 Enrico M. Crisostomo
51
52This program is free software; you can redistribute it and/or modify it under
53the terms of the GNU General Public License as published by the Free Software
54Foundation; either version 3, or (at your option) any later version.
55
56This program is distributed in the hope that it will be useful, but WITHOUT ANY
57WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
58PARTICULAR PURPOSE.  See the GNU General Public License for more details.
59
60You should have received a copy of the GNU General Public License along with
61this program.  If not, see <http://www.gnu.org/licenses/>.
62