Read Me

                 README file for ChitraguptaFS
------------------------------------------------------------
                       DESCRIPTION
ChitraguptaFS is a simple file system based on FUSE (2.7.4)
(http://fuse.sourceforge.net) written in C programming 
language for logging FS events. ChitraguptaFS comprises 
of two parts. One is the FS itself and the other is to 
retrieve FS logs. ChitraguptaFS send logs only at 
successful completion of an event (FS system call) and 
sends it via a message queue, defined over a regular file. 
The other part reads the logs from the message queue and 
displays it on the screen or into a file based on the
choice of the user.
------------------------------------------------------------
                      INSPIRATION
ChitraguptaFS is a part of a larger academic project under
development. It has taken its basic idea from the example
FS provided with FUSE source code (fusexmp_fh.c). A similar 
FS named loggedfs is also present, written in C++, which 
utilizes rLog, PCRE, and libxml. 
------------------------------------------------------------
                       EXTENSION
ChitraguptaFS can be easily extended to log more data from 
the FS based on need by simple modifications. The coding 
is in C programming language and the code has been enough
modularized to help ease of understanding. Message queues
used can be changed to any other IPC mechanism.
------------------------------------------------------------
                      COMPILATION
Use make utility to compile the FS. The executables are 
placed in BUILD directory (Logger and LogFS). A file named
MQFILE is also generated, which can be used for message
queues. 
------------------------------------------------------------
                     REQUIREMENTS
1) FUSE module.
2) gcc 4.xx
3) Kernel Headers.
4) System V message queue support.
5) Support for proc file system.
------------------------------------------------------------