aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAngelo Marletta <angelo.marletta@gmail.com>2012-06-30 13:57:49 +0100
committerAngelo Marletta <angelo.marletta@gmail.com>2012-06-30 13:57:49 +0100
commit95bcebd20c124701a4eb2233213938d0f2441c37 (patch)
tree85aa84e789d158b263f7cbe9d9e8ef99972288b6
parent1d7438185d0ac55a49e9adb6f719ef28e5501e0d (diff)
downloadcpulimit-95bcebd20c124701a4eb2233213938d0f2441c37.tar.gz
README updated
-rw-r--r--README45
1 files changed, 23 insertions, 22 deletions
diff --git a/README b/README
index 15f0691..2ad5570 100644
--- a/README
+++ b/README
@@ -4,29 +4,13 @@ CPULIMIT
About
=======
-Cpulimit is a tool which attempts to limit the CPU usage of a process (expressed in percentage, not in CPU time). It is useful to control batch jobs, when you don't want them to eat too many CPU cycles. The goal is prevent a process from running for more than a specified time ratio. It does not change the nice value or other scheduling priority settings, but the real CPU usage. Also, it is able to adapt itself to the overall system load, dynamically and quickly.
+Cpulimit is a tool which limits the CPU usage of a process (expressed in percentage, not in CPU time). It is useful to control batch jobs, when you don't want them to eat too many CPU cycles. The goal is prevent a process from running for more than a specified time ratio. It does not change the nice value or other scheduling priority settings, but the real CPU usage. Also, it is able to adapt itself to the overall system load, dynamically and quickly.
The control of the used cpu amount is done sending SIGSTOP and SIGCONT POSIX signals to processes.
All the children processes and threads of the specified process will share the same percent of CPU.
Developed by Angelo Marletta.
Please send your feedback, bug reports, feature requests or just thanks.
-===========
- Changelog
-===========
-
-- added support for FreeBSD
-- reorganization of the code, splitted in more source files
-- cpu count detection, i.e. if you have 4 cpu, it is possible to limit up to 400%
-- in order to avoid deadlocks, cpulimit now prevents to limit itself
-- option --path eliminated, use --exe instead both for absolute path and file name
-- call setpriority() just once
-- no more segmentation fault when processes exit
-- no more memory corruption when processes exit
-- cpulimit exits if --lazy option is specified and the process terminates
-- target process can be created on-fly given command line
-- light and scalable algorithm for subprocesses detection and limitation
-- minor enhancements and bugfixes
============================
Get the latest source code
@@ -37,10 +21,27 @@ The latest available code is here:
https://github.com/opsengine/cpulimit
-==============
- Installation
-==============
+======================
+ Install instructions
+======================
-Run 'make' and place the executable file 'cpulimit' wherever you want.
+On Linux:
-Type 'cpulimit --help' to print the usage.
+$ make
+# cp src/cpulimit /usr/bin
+
+On FreeBSD:
+
+$ gmake
+# cp src/cpulimit /usr/bin
+
+Run unit tests:
+$ ./tests/process_iterator_test
+
+
+===============
+ Contributions
+===============
+
+You are welcome to contribute to cpulimit with bugfixes, new features, or support for a new OS.
+If you want to submit a pull request, please do it on the branch develop and make sure all tests pass.
Un proyecto texto-plano.xyz