Subversion Repositories public

Rev

Rev 17 | Rev 35 | Go to most recent revision | Only display areas with differences | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 17 Rev 21
1
inotify C++ interface
1
inotify C++ interface
2
2
3
(c) Lukas Jelinek, 2006
3
(c) Lukas Jelinek, 2006
4
4
5
1. About
5
1. About
6
2. Requirements
6
2. Requirements
7
3. How to use
7
3. How to use
8
4. Bugs, suggestions
8
4. Bugs, suggestions
9
5. Licensing
9
5. Licensing
10
6. Documentation
10
6. Documentation
11
11
12
12
13
========================================================================
13
========================================================================
14
14
15
15
16
1. About
16
1. About
17
This program is the inotify C++ interface. It is designed for easy use
17
This program is the inotify C++ interface. It is designed for easy use
18
of Linux inotify technology in C++ applications. You need not to deal
18
of Linux inotify technology in C++ applications. You need not to deal
19
with file descriptors and such uncomfortable things. Instead you can
19
with file descriptors and such uncomfortable things. Instead you can
20
use a few simple C++ classes.
20
use a few simple C++ classes.
21
21
22
22
23
2. Requirements
23
2. Requirements
24
* Linux kernel 2.6.13 or later (with inotify compiled in)
24
* Linux kernel 2.6.13 or later (with inotify compiled in)
25
* inotify header(s) installed in <INCLUDE_DIR>/sys. The most common
25
* inotify header(s) installed in <INCLUDE_DIR>/sys. The most common
26
  place is /usr/include/sys. Some Linux distributions contain only
26
  place is /usr/include/sys. Some Linux distributions contain only
27
  inotify.h which defines everything needed. But sometimes must
27
  inotify.h which defines everything needed. But sometimes must
28
  be used inotify.h and inotify-syscalls.h as available e.g. at
28
  be used inotify.h and inotify-syscalls.h as available e.g. at
29
  the inotify-cxx homepage.
29
  the inotify-cxx homepage.
30
* GCC 4.x compiler (probably works also with GCC 3.4, possibly with
30
* GCC 4.x compiler (probably works also with GCC 3.4, possibly with
31
  older versions too)
31
  older versions too)
32
32
33
  
33
  
34
3. How to use
34
3. How to use
35
Include inotify-cxx.h into your sources and add inotify-cxx.cpp for
35
Include inotify-cxx.h into your sources and add inotify-cxx.cpp for
36
compiling (e.g. through your makefile).
36
compiling (e.g. through your makefile).
37
37
38
If you have installed it into your system-wide include dir (e.g.
38
If you have installed it into your system-wide include dir (e.g.
39
/usr/include), use #include <inotify-cxx.h> or similar.
39
/usr/include), use #include <inotify-cxx.h> or similar.
40
Otherwise use #include "inotify-cxx.h".
40
Otherwise use #include "inotify-cxx.h".
41
41
42
42
For thread-safe behavior, define the INOTIFY_THREAD_SAFE symbol
-
 
43
(eg. -DINOTIFY_THREAD_SAFE on gcc's command line). See documentation
-
 
44
for details about thread safety.
-
 
45
-
 
46
43
4. Bugs, suggestions
47
4. Bugs, suggestions
44
THIS PROGRAM IS AN ALPHA VERSION. IT PROBABLY CONTAINS BUGS AND
48
THIS PROGRAM IS AN ALPHA VERSION. IT PROBABLY CONTAINS BUGS AND
45
THEREFORE IT IS NOT INTENDED FOR PRODUCTION USE.
49
THEREFORE IT IS NOT INTENDED FOR PRODUCTION USE.
46
50
47
If you find a bug or have a suggestion how to improve the program,
51
If you find a bug or have a suggestion how to improve the program,
48
please use the bug tracking system at http://bts.aiken.cz.
52
please use the bug tracking system at http://bts.aiken.cz.
49
53
50
54
51
5. Licensing
55
5. Licensing
52
This program is free software; you can redistribute it and/or
56
This program is free software; you can redistribute it and/or
53
modify it under the terms of one of the following licenses:
57
modify it under the terms of one of the following licenses:
54
58
55
1. X11 license (see LICENSE-X11)
59
1. X11 license (see LICENSE-X11)
56
2. GNU Lesser General Public License, version 2.1 (see LICENSE-LGPL)
60
2. GNU Lesser General Public License, version 2.1 (see LICENSE-LGPL)
57
3. GNU General Public License, version 2  (see LICENSE-GPL)
61
3. GNU General Public License, version 2  (see LICENSE-GPL)
58
62
59
If you want to help with choosing the best license for you,
63
If you want to help with choosing the best license for you,
60
please visit http://www.gnu.org/licenses/license-list.html.
64
please visit http://www.gnu.org/licenses/license-list.html.
61
65
62
66
63
6. Documentation
67
6. Documentation
64
The API reference documentation is present in the HTML and man format.
68
The API reference documentation is present in the HTML and man format.
65
It was generated using the doxygen program.
69
It was generated using the doxygen program.