annotate man/sciworkerd.8.in @ 13:67348ec46425

man: add manual pages
author David Demelier <markand@malikania.fr>
date Wed, 30 Jun 2021 11:33:54 +0200
parents
children 081e1c258e64
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
13
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 .\"
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 .\" Copyright (c) 2021 David Demelier <markand@malikania.fr>
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 .\"
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 .\" Permission to use, copy, modify, and/or distribute this software for any
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 .\" purpose with or without fee is hereby granted, provided that the above
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 .\" copyright notice and this permission notice appear in all copies.
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 .\"
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 .\"
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 .Dd June 30, 2021
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 .Dt SCIWORKERD 8
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
18 .Os
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 .\" NAME
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 .Sh NAME
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
21 .Nm sciworkerd
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 .Nd sci worker daemon
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
23 .\" SYNOPSIS
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 .Sh SYNOPSIS
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
25 .Nm
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 .Op Fl m Ar maxbuilds
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 .Op Fl u Ar url
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
28 .Op Fl w Ar workername
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 .\" DESCRIPTION
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 .Sh DESCRIPTION
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
31 The
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 .Nm
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 daemon waits indefinitely for jobs to execute and send back their result. It
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 requires an access to
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 .Xr sciwebd 8
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
36 running and transitively a
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
37 .Xr scid 8
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
38 daemon running as well.
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
39 .Pp
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
40 It is part of the
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
41 .Xr sci 7
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
42 continuous integration framework.
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
43 .Pp
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
44 The following options are available:
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
45 .Bl -tag
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
46 .It Fl m
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
47 Set the maximum number of parallel builds allowed to
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
48 .Ar maxbuilds .
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
49 Defaults: 4.
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
50 .It Fl u
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
51 Set the
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
52 .Ar url
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
53 for connecting to
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
54 .Xr sciwebd 8 .
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
55 You can specify a scheme using
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
56 .Dq http://
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
57 or
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
58 .Dq https:// .
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
59 Default:
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
60 .Dq localhost .
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
61 .It Fl w
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
62 Specify which worker this daemon should refer to using
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
63 .Ar worker
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
64 as worker name. Default:
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
65 .Dq default
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
66 .El
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
67 .\" SEE ALSO
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
68 .Sh SEE ALSO
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
69 .Xr sci 7 ,
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
70 .Xr scictl 8 ,
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
71 .Xr scid 8 ,
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
72 .Xr sciwebd 8 ,