Copyright (c) Youssef Hmamouche - All Rights Reserved

This is the Linux Kernel Configuration Panel (LKCP) README file
--------------------------------------------------------------

Contents
--------

	1) About
	
	2) Design
	
	3) Participation
	
	4) How To Unzip, Compile, and Run LKCP (also read lkcp-<version>/INSTALL)
	
	5) Questions or help

About
-----

LKCP allows you to change kernel system values at run-time. It uses the ncurses library to draw its Text User Interface.

NOTE: All terminals are now supported.

Design
------

I am currently writing a complete document detailing the design of LKCP. If you want to get your feet wet, please read the following 
to get started.

LKCP starts browsing the proc filesystem based on a predefined set of folders: fs,debug,kernel,net,proc,abi,vm,sunrpc, and dev. 
From then on, everything is dynamic as far as menu and screen drawings. Depending on who runs lkcp (root or user), lkcp determines 
the mode it is running in.

There are two modes: root and non-root. In non-root, all you can do is browse procfs. In root mode, you get to browse and modify the 
values.

Participation
-------------

Everyone is encouraged to participate in this project. You can submit bug reports/documentation/patches. Credit will be given 
where it is due. Read the TODO file and fix a few things to get your feet wet. They're fairly easy to do.

I am currently the only developer in this project and would love to have somebody share this burden with me(based on merit).

How To Unzip, Compile, and Run LKCP
----------------------------------

Also read the INSTALL file for a more detailed How To.


1) How to unzip lkcp

bash-2.05b$ bunzip2 lkcp-0.1.7.tar.bz2 
bash-2.05b$ tar -xvf lkcp-0.1.7.tar 
lkcp-0.1.7/
lkcp-0.1.7/src/
lkcp-0.1.7/src/Makefile
lkcp-0.1.7/src/help_map.c
lkcp-0.1.7/src/dbg.c
lkcp-0.1.7/src/dbg.h
lkcp-0.1.7/src/paged_sys.c
lkcp-0.1.7/src/scr_err_hndl.c
lkcp-0.1.7/src/scr_err_hndl.h
lkcp-0.1.7/src/help.h
lkcp-0.1.7/src/lkcp.h
lkcp-0.1.7/src/proc_sys.c
lkcp-0.1.7/src/lkcp_main.c
lkcp-0.1.7/src/paged.h
lkcp-0.1.7/src/entries.h
lkcp-0.1.7/src/entry_lookup.c
lkcp-0.1.7/src/acknowledge.c
lkcp-0.1.7/src/acknowledge.h
lkcp-0.1.7/NEWS
lkcp-0.1.7/TODO
lkcp-0.1.7/LICENCE
lkcp-0.1.7/debug/
lkcp-0.1.7/debug/splint.log
lkcp-0.1.7/debug/HOW_TO_DEBUG_LKCP.txt
lkcp-0.1.7/debug/RUN_VALGRIND.txt
lkcp-0.1.7/debug/RUN_SPLINT.txt
lkcp-0.1.7/README
lkcp-0.1.7/AUTHORS
lkcp-0.1.7/Documentation/
lkcp-0.1.7/Documentation/proc.txt
lkcp-0.1.7/Changelog
lkcp-0.1.7/COPYING
lkcp-0.1.7/CREDITS

2) How to compile lkcp

bash-2.05b$ cd lkcp-0.1.7/
bash-2.05b$ cd src/
bash-2.05b$ make
gcc -O2 -g -c lkcp_main.c
gcc -O2 -g -c proc_sys.c
gcc -O2 -g -c entry_lookup.c
gcc -O2 -g -c paged_sys.c
gcc -O2 -g -c help_map.c
gcc -O2 -g -c dbg.c
gcc -O2 -g -c acknowledge.c
gcc -O2 -g -c scr_err_hndl.c
gcc -O2 -g -lncurses -lmenu -lform -o lkcp lkcp_main.o proc_sys.o entry_lookup.o paged_sys.o help_map.o dbg.o acknowledge.o scr_err_hndl.o
bash-2.05b$ 

3) How to run lkcp

At the shell prompt (xterm), type the following command without the quotes (""): "./lkcp"

Example:

bash-2.05b$ ./lkcp 

Questions or Help
-----------------

You can get help either by reading the documentation or by emailing me at: hyoussef@gmail.com
