From 4caa10cb06041299bd9ecd43c6e21f44c5d98f5e Mon Sep 17 00:00:00 2001 From: Loic Guegan Date: Sun, 22 Aug 2021 09:25:41 +0200 Subject: [PATCH] Update readme --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 21e1454..ff6b2cb 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,19 @@ # pool.sh a simple processes pool management -**What is pool.sh ?** pool.sh allows you to create simple pools of processes. This is usefull to run several process in parallel such as simulations. It is design to be used in bash scripts. +**What is pool.sh ?** pool.sh allows you to create simple pools of processes. This is usefull to run several process in parallel such as simulations or computations. It is designed to be used in bash scripts. **How it works ?** - Create a pool with `./pool.sh create ` -- Launch a process in a pool with `./pool.sh run ` which return the process id `` If the pool `` is full (number of processes equals to ``) pool.sh will wait until room has been made in the pool to run ``. +- Launch a process in a pool with `./pool.sh run ` which return the process id ``. If the pool `` is full (number of processes equals to ``) pool.sh will wait until room has been made in the pool to run ``. - Get the output of a process with `./pool.sh cat ` - Wait until all the processes are completed with `./pool.sh wait ` -- Remove a pool with `./pool.sh remove ` if there is still processes running this call will fail. -- Force the removal of a pool with `./pool.sh remove-force ` all running processes will be killed and the pool will be deleted -- Additional properties can be attach to processes with `./pool.sh setp ` Defaults properties are ``,``,``. +- Remove a pool with `./pool.sh remove `. If processes are still running in the `` this call will fail. +- Force the removal of a pool with `./pool.sh remove-force `. All running processes will be killed and the pool will be deleted +- Additional properties can be attached to processes with `./pool.sh setp `. Default properties are ``,``,``. - Properties can be retrieve with `./pool.sh getp ` - Processes in a pool can be paused with `./pool.sh pause ` - Processes in a pool can be resumed with `./pool.sh resume ` - Available pools can be retrieve with `./pool.sh ls` - All the processes output file can be retrieve with `./pool.sh ls-output ` -**Finale quote:** No checks are performed on the pool.sh arguments. Be sure to use the right ones. Defaults configuration requires access to the `/tmp` directory. +**Final quote:** No checks are performed the arguments. THus, be sure to use the right ones. Defaults configuration requires access to the `/tmp` directory and use name conventions which may clash with the existing content of `/tmp` if you are very unlucky. If in this the case, you can edit `pool.sh` to avoid those clashes.