/etc/compctl-unlimited control file support
[compctl.git] / README.client
blobf9236c318361879b369fe4536e07721f4c692fde
1 compctl - Computations under control
4 Usage
5 =====
7     compctl --run COMMAND...
8     compctl --screen COMMAND...
10     compctl --usage
11     compctl --limitmem MAXMEM
12     compctl --list
13     compctl --kill PGRP
14     compctl --killall
16 Arguments for running computations:
17     --run COMMAND     run a new computation on foreground
18     --screen COMMAND  run a new computation within a screen instance; all
19                       windows within this screen will share resource limits
21 Arguments for controlling computations:
22     --usage           show resource usage of all running computations
23     --limitmem MAXMEM set the maximum memory consumed by all computations [MiB]
24     --list            list all running computations
25     --kill PGRP       kill a given computation (number as listed in --list)
26     --killall         kill all running computations
28 Other options:
29     --help            help message
32 Description
33 ===========
35 **Computations under control** will run a specificed program as
36 a non-interactive computation process, allowing it to be listed
37 and regulated by the user of the computer.
40 Examples
41 ========
43     compctl --run ./satsolver data.sat | tee results.txt
44     compctl --screen autotest-screen 5
46     compctl --limitmem 4096
47     compctl --kill 27134
50 Files
51 =====
53 If /etc/compctl-unlimited exists, compctl acts as a simple serverless agent
54 that allows launching computations (with priority reduced as usual), but
55 not limiting their memory usage or killing them.