/etc/compctl-unlimited control file support
[compctl.git] / compctl.1
blobef83ec686dc831d43a6443e66d494e98f3a3405d
1 .\"                                      Hey, EMACS: -*- nroff -*-
2 .\" First parameter, NAME, should be all caps
3 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
4 .\" other parameters are allowed: see man(7), man(1)
5 .TH COMPCTL 1 "March 16, 2012"
6 .\" Please adjust this date whenever revising the manpage.
7 .\"
8 .\" Some roff macros, for reference:
9 .\" .nh        disable hyphenation
10 .\" .hy        enable hyphenation
11 .\" .ad l      left justify
12 .\" .ad b      justify to both left and right margins
13 .\" .nf        disable filling
14 .\" .fi        enable filling
15 .\" .br        insert line break
16 .\" .sp <n>    insert n+1 empty lines
17 .\" for manpage-specific macros, see man(7)
18 .SH NAME
19 compctl \- Computations under control
20 .SH SYNOPSIS
21 .B compctl
22 .RI --run " COMMAND... "
23 .br
24 .B compctl
25 .RI --screen " COMMAND... "
26 .PP
27 .B compctl
28 .RI --usage
29 .br
30 .B compctl
31 .RI --limitmem " MAXMEM "
32 .br
33 .B compctl
34 .RI --list
35 .br
36 .B compctl
37 .RI --kill " PGRP "
38 .br
39 .B compctl
40 .RI --killall
41 .br
42 .SH DESCRIPTION
43 \fBComputations under control\fP will run a specificed program as
44 a non-interactive computation process, allowing it to be listed
45 and regulated by the user of the computer.
46 .PP
47 Run \fBcompctl\fP without any parameters of with the \fI--help\fP
48 option to obtain description of the available options.
49 .SH SEE ALSO
50 .BR nice (1).
51 .SH EXAMPLES
52 compctl --run ./satsolver data.sat | tee results.txt
53 .br
54 compctl --screen autotest-screen 5
55 .br
56 .br
57 compctl --limitmem 4096
58 .br
59 compctl --kill 27134
60 .br
61 .SH FILES
62 If \fB/etc/compctl-unlimited\fP exists, compctl acts as a simple
63 serverless agent that allows launching computations (with priority
64 reduced as usual), but not limiting their memory usage or killing them.
65 .SH AUTHOR
66 \fBcompctl\fP was written by Petr Baudis <pasky@ucw.cz>.