From 5808757a6cd091ede4a3633c0f175d2a412b0c23 Mon Sep 17 00:00:00 2001 From: Loic Guegan Date: Sat, 21 Aug 2021 17:43:32 +0200 Subject: Create repo --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..3f921c2 --- /dev/null +++ b/README.md @@ -0,0 +1,16 @@ +# 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. + +**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 ``. +- 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 ``,``,``. +- Properties can be retrieve with `./pool.sh getp ` +- Finally, all the processes output file can be retrieve with `./pool.sh ls ` + +**Finale quote:** No checks are performed on the pool.sh arguments. Be sure to use the right ones. -- cgit v1.2.3