Rev 3 | Rev 21 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed
| Rev | Author | Line No. | Line |
|---|---|---|---|
| 3 | luk | 1 | |
| 2 | |||
| 3 | |||
| 4 | |||
| 5 | |||
| 6 | 2. Requirements |
||
| 7 | 3. How to use |
||
| 8 | 4. Bugs, suggestions |
||
| 9 | 5. Licensing |
||
| 10 | 6. Documentation |
||
| 11 | |||
| 12 | |||
| 13 | |||
| 14 | |||
| 15 | |||
| 16 | |||
| 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 |
||
| 19 | with file descriptors and such uncomfortable things. Instead you can |
||
| 20 | use a few simple C++ classes. |
||
| 21 | |||
| 22 | |||
| 23 | |||
| 24 | * Linux kernel 2.6.13 or later (with inotify compiled in) |
||
| 25 | * inotify header(s) installed in <INCLUDE_DIR>/sys. The most common |
||
| 17 | luk | 26 | place is /usr/include/sys. Some Linux distributions contain only |
| 27 | inotify.h which defines everything needed. But sometimes must |
||
| 28 | be used inotify.h and inotify-syscalls.h as available e.g. at |
||
| 29 | the inotify-cxx homepage. |
||
| 30 | * GCC 4.x compiler (probably works also with GCC 3.4, possibly with |
||
| 3 | luk | 31 | older versions too) |
| 32 | |||
| 33 | |||
| 34 | |||
| 35 | Include inotify-cxx.h into your sources and add inotify-cxx.cpp for |
||
| 36 | compiling (e.g. through your makefile). |
||
| 37 | |||
| 38 | |||
| 39 | /usr/include), use #include <inotify-cxx.h> or similar. |
||
| 40 | Otherwise use #include "inotify-cxx.h". |
||
| 41 | |||
| 42 | |||
| 43 | |||
| 44 | THIS PROGRAM IS AN ALPHA VERSION. IT PROBABLY CONTAINS BUGS AND |
||
| 45 | THEREFORE IT IS NOT INTENDED FOR PRODUCTION USE. |
||
| 46 | |||
| 47 | |||
| 48 | please use the bug tracking system at http://bts.aiken.cz. |
||
| 49 | |||
| 50 | |||
| 51 | |||
| 52 | This program is free software; you can redistribute it and/or |
||
| 53 | modify it under the terms of one of the following licenses: |
||
| 54 | |||
| 55 | |||
| 56 | 2. GNU Lesser General Public License, version 2.1 (see LICENSE-LGPL) |
||
| 57 | 3. GNU General Public License, version 2 (see LICENSE-GPL) |
||
| 58 | |||
| 59 | |||
| 60 | please visit http://www.gnu.org/licenses/license-list.html. |
||
| 61 | |||
| 62 | |||
| 63 | |||
| 64 | The API reference documentation is present in the HTML and man format. |
||
| 65 | It was generated using the doxygen program. |
||
| 66 |