annotate man/scid.8 @ 35:084dee2bef50

man: updates
author David Demelier <markand@malikania.fr>
date Thu, 04 Aug 2022 18:01:29 +0200
parents man/scid.8.in@081e1c258e64
children 85c59fbf1407
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 .\"
32
081e1c258e64 misc: update copyright years
David Demelier <markand@malikania.fr>
parents: 22
diff changeset
2 .\" Copyright (c) 2021-2022 David Demelier <markand@malikania.fr>
13
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 .\"
35
084dee2bef50 man: updates
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
16 .Dd August 04, 2022
13
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 .Dt SCID 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 scid
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 .Nd main sci controller 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
22
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents: 13
diff changeset
26 .Op Fl f
13
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 .Op Fl d Ar database-file
35
084dee2bef50 man: updates
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
28 .Op Fl t Ar theme-directory
13
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
22
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents: 13
diff changeset
33 program is the main controller daemon responsible of the database access and
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents: 13
diff changeset
34 web content. It opens it, creates if does not exist and then update its
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents: 13
diff changeset
35 content.
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents: 13
diff changeset
36 .Pp
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents: 13
diff changeset
37 After that, it opens a CGI/FastCGI service to get HTTP requests either from a
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents: 13
diff changeset
38 web browser or through the dedicated
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents: 13
diff changeset
39 .Xr scictl 1
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents: 13
diff changeset
40 utility.
13
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
41 .Pp
35
084dee2bef50 man: updates
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
42 Usually, you want to setup
084dee2bef50 man: updates
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
43 .Nm
084dee2bef50 man: updates
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
44 to run with the associated too
084dee2bef50 man: updates
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
45 .Xr kfcgi 8
084dee2bef50 man: updates
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
46 or any other FastCGI spawner.
084dee2bef50 man: updates
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
47 .Pp
13
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
48 It is part of the
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
49 .Xr sci 7
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
50 continuous integration framework.
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
51 .Pp
22
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents: 13
diff changeset
52 Available options:
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents: 13
diff changeset
53 .Bl -tag
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents: 13
diff changeset
54 .It Fl f
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents: 13
diff changeset
55 Runs as FastCGI process.
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents: 13
diff changeset
56 .It Fl d Ar database-file
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents: 13
diff changeset
57 Use path specified
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents: 13
diff changeset
58 .Pa database-file
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents: 13
diff changeset
59 as alternative database location.
35
084dee2bef50 man: updates
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
60 .It Fl t Ar theme-directory
084dee2bef50 man: updates
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
61 Use
084dee2bef50 man: updates
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
62 .Ar theme-directory
084dee2bef50 man: updates
David Demelier <markand@malikania.fr>
parents: 32
diff changeset
63 as theme to use.
22
dd078aea5d02 misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents: 13
diff changeset
64 .El
13
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
65 .\" SEE ALSO
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
66 .Sh SEE ALSO
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
67 .Xr sci 7 ,
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
68 .Xr scictl 8 ,
67348ec46425 man: add manual pages
David Demelier <markand@malikania.fr>
parents:
diff changeset
69 .Xr sciworkerd 8