From 151d56afe0d7d9eb527fb0a194f383435b2c0f65 Mon Sep 17 00:00:00 2001 From: "Madhusudan.C.S" Date: Mon, 18 Aug 2008 19:45:00 +0200 Subject: 2008-08-18 Madhusudan.C.S * README: Initial Documentation. --- ChangeLog | 3 +++ README | 77 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 80 insertions(+) diff --git a/ChangeLog b/ChangeLog index 2e027f58..e5bb2414 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,6 @@ +2008-08-18 Madhusudan.C.S + * README: Initial Documentation. + 2008-08-18 Madhusudan.C.S * procfs_nonpid_files.c: (get_uptime): Changed the parameter type from double to diff --git a/README b/README index e69de29b..28b4aa3e 100644 --- a/README +++ b/README @@ -0,0 +1,77 @@ +~~~~~~~~~~~~~~~ +1. Introduction +~~~~~~~~~~~~~~~ + + This program is called procfs, the /proc translator. This +program provides a GNU/Linux compatible /proc pseudo file- +system on GNU Hurd. This is called a translator since it +translates the process related information stored in the +MACH Microkernel which is made available through the proc +server and the libps library into a virtual filesystem. + +~~~~~~~ +2. Goal +~~~~~~~ + + The major goal of writing this translator was to make the +process related tools like pgrep, pkill, kill which are +packaged in procps, killall, pstree which are packaged in +psmisc and various other process related tools that rely +on GNU/Linux's /proc filesystem to run out of the box on +Hurd. + +~~~~~~~~~~ +3. Install +~~~~~~~~~~ + + To install this translator you can simply do the following. +Just cd to the top level directory of the hurd main source +tree. Run the configure script with the following command. +(In BASH) + +$ ./configure + +(If your shell is something else run the equivalent command). + +Now you can run make with procfs as a parameter if you want +to build only procfs. + +$ make procfs + +(This first builds all the dependencies of procfs and then +builds procfs as a part of Hurd main source tree.) + +After building the translator, you get a binary named procfs. +You need to set it as a translator. To do so you can type the +following command from the top level directory of Hurd main +source tree directory from where you ran make. + +$ settrans -fgap /proc procfs/procfs + +Viola! You are done setting up the translator. + +~~~~~~~~~~ +4. Testing +~~~~~~~~~~ + + Now in case you want to use the debian hurd binaries to work +with tools like pgrep, pkill, kill, htop etc, you can just +download the binaries which I have uploaded here: + +http://madhusudancs.info/procfs-testing-how-to-mini + +The patches to the source packages will be made available soon. + +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +5. Reporting Bugs and contacts +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + I request all of you to help me in identifying the bugs in +procfs or in the procps or htop packages, so that I can fix +them. You are also free to submit patches if you feel so. The +patches can be sent either to bug-hurd mailing list or to my +e-mail adress. The e-mail IDs are as follows: + +bug-hurd@gnu.org +madhusudancs@gmail.com +madhusudan@madhusudancs.info -- cgit v1.2.3