Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

README.md: Fix Headlines and internal links in TOC. #39

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

README.md: Fix Headlines and internal links in TOC. #39

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 28 additions & 25 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,18 @@ inotify cron system

Content
=======
1. About
2. Install a binary version
3. Obtain the source code
4. Requirements
5. How to build
6. How to use
7. Bugs, suggestions
8. Licensing

1. About
========
1. [About](#about)
2. [Install a binary version](#install-a-binary-version)
3. [Obtain the source code](#obtain-the-source-code)
4. [Requirements](#requirments)
5. [How to build](#how-to-build)
6. [How to use](#how-to-use)
7. [Bugs, suggestions](#bugs-suggestions)
8. [Licensing](#licensing)


About
=====
This program is the "inotify cron" system. It consist of a daemon and
a table manipulator. You can use it a similar way as the regular cron.
The difference is that the inotify cron handles filesystem events
Expand All @@ -29,8 +30,8 @@ unfortunatally abandoned in 2012. Upstream development and
bug-tracking/fixing continued in 2014 on GitHub:
https://github.com/ar-/incron .

2. Install a binary version
===========================
Install a binary version
========================
On Debian and Ubuntu based systems you can install this software
(the version maintained by Debian) with
sudo apt-get install incron
Expand All @@ -55,25 +56,25 @@ If you would like to add a build script for other linux flavors
(Gentoo, Suse, Ret Hat, ...) please send me a pull request. I will
be happy to include it.

3. Obtain the source code
=========================
Obtain the source code
======================
You can download the latest stable version from
https://github.com/ar-/incron/archive/master.tar.gz

You can download older versions from
https://github.com/ar-/incron/releases

4. Requirements
===============
Requirements
============
* Linux kernel 2.6.13 or later (with inotify compiled in)
* inotify headers (inotify.h, sometimes inotify-syscalls.h) installed in
<INCLUDE_DIR>/sys. The most common place is /usr/include/sys.
* GCC 4.x compiler (probably works also with GCC 3.4, possibly with
older versions too)


5. How to build
===============
How to build
============
Short:
------

Expand Down Expand Up @@ -106,8 +107,8 @@ The doxygen program must be installed and its control file 'Doxygen'
created for generating the API documentation.


6. How to use
=============
How to use
==========
The incron daemon (incrond) must be run under root (typically from
runlevel script etc.). It loads the current user tables and hooks
them for later changes.
Expand Down Expand Up @@ -197,17 +198,19 @@ One of the solutions follows:
/home/user1 IN_CLOSE_WRITE,dotdirs=true echo $@/$# | logger
`

7. Bugs, suggestions
====================
Bugs, suggestions
=================

incrond is currently not resistent against looping.

If you find a bug or have a suggestion how to improve the program,
please use the bug tracking system at
https://github.com/ar-/incron/issues.


8. Licensing
============
Licensing
=========

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License,
version 2 (see LICENSE-GPL).
Expand Down