Mercurial > sci
annotate man/scid.8 @ 66:5076be758687 0.1.0
misc: update before 0.1.0 release
| author | David Demelier <markand@malikania.fr> |
|---|---|
| date | Sat, 20 Aug 2022 10:36:55 +0200 |
| parents | 85c59fbf1407 |
| children | 71cd8447e3a4 |
| rev | line source |
|---|---|
| 13 | 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 | 3 .\" |
| 4 .\" Permission to use, copy, modify, and/or distribute this software for any | |
| 5 .\" purpose with or without fee is hereby granted, provided that the above | |
| 6 .\" copyright notice and this permission notice appear in all copies. | |
| 7 .\" | |
| 8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES | |
| 9 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF | |
| 10 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR | |
| 11 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES | |
| 12 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN | |
| 13 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF | |
| 14 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. | |
| 15 .\" | |
| 35 | 16 .Dd August 04, 2022 |
| 13 | 17 .Dt SCID 8 |
| 18 .Os | |
| 19 .\" NAME | |
| 20 .Sh NAME | |
| 21 .Nm scid | |
| 22 .Nd main sci controller daemon | |
| 23 .\" SYNOPSIS | |
| 24 .Sh SYNOPSIS | |
| 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 | 27 .Op Fl d Ar database-file |
| 35 | 28 .Op Fl t Ar theme-directory |
|
54
85c59fbf1407
scid: add commands to retrieve API key
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
29 .Nm |
|
85c59fbf1407
scid: add commands to retrieve API key
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
30 .Cm api-get |
|
85c59fbf1407
scid: add commands to retrieve API key
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
31 .Nm |
|
85c59fbf1407
scid: add commands to retrieve API key
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
32 .Cm api-reset |
| 13 | 33 .\" DESCRIPTION |
| 34 .Sh DESCRIPTION | |
| 35 The | |
| 36 .Nm | |
|
22
dd078aea5d02
misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents:
13
diff
changeset
|
37 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
|
38 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
|
39 content. |
|
dd078aea5d02
misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents:
13
diff
changeset
|
40 .Pp |
|
dd078aea5d02
misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents:
13
diff
changeset
|
41 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
|
42 web browser or through the dedicated |
|
dd078aea5d02
misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents:
13
diff
changeset
|
43 .Xr scictl 1 |
|
dd078aea5d02
misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents:
13
diff
changeset
|
44 utility. |
| 13 | 45 .Pp |
| 35 | 46 Usually, you want to setup |
| 47 .Nm | |
|
66
5076be758687
misc: update before 0.1.0 release
David Demelier <markand@malikania.fr>
parents:
54
diff
changeset
|
48 to run with the associated tool |
| 35 | 49 .Xr kfcgi 8 |
| 50 or any other FastCGI spawner. | |
| 51 .Pp | |
| 13 | 52 It is part of the |
| 53 .Xr sci 7 | |
| 54 continuous integration framework. | |
| 55 .Pp | |
|
22
dd078aea5d02
misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents:
13
diff
changeset
|
56 Available options: |
|
dd078aea5d02
misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents:
13
diff
changeset
|
57 .Bl -tag |
|
dd078aea5d02
misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents:
13
diff
changeset
|
58 .It Fl f |
|
54
85c59fbf1407
scid: add commands to retrieve API key
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
59 Runs as FastCGI process (recommended). |
|
22
dd078aea5d02
misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents:
13
diff
changeset
|
60 .It Fl d Ar database-file |
|
dd078aea5d02
misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents:
13
diff
changeset
|
61 Use path specified |
|
dd078aea5d02
misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents:
13
diff
changeset
|
62 .Pa database-file |
|
dd078aea5d02
misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents:
13
diff
changeset
|
63 as alternative database location. |
| 35 | 64 .It Fl t Ar theme-directory |
| 65 Use | |
| 66 .Ar theme-directory | |
| 67 as theme to use. | |
|
22
dd078aea5d02
misc: use project/worker name as primary key
David Demelier <markand@malikania.fr>
parents:
13
diff
changeset
|
68 .El |
|
54
85c59fbf1407
scid: add commands to retrieve API key
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
69 .Pp |
|
85c59fbf1407
scid: add commands to retrieve API key
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
70 Available commands: |
|
85c59fbf1407
scid: add commands to retrieve API key
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
71 .Bl -tag |
|
85c59fbf1407
scid: add commands to retrieve API key
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
72 .It Cm api-get |
|
85c59fbf1407
scid: add commands to retrieve API key
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
73 Print the configured API key required for |
|
85c59fbf1407
scid: add commands to retrieve API key
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
74 .Xr scictl 8 |
|
85c59fbf1407
scid: add commands to retrieve API key
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
75 and |
|
85c59fbf1407
scid: add commands to retrieve API key
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
76 .Xr sciworkerd 8 . |
|
85c59fbf1407
scid: add commands to retrieve API key
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
77 .It Cm api-reset |
|
85c59fbf1407
scid: add commands to retrieve API key
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
78 Reset or create the API key if not already existing in database and print it. |
|
85c59fbf1407
scid: add commands to retrieve API key
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
79 .El |
|
85c59fbf1407
scid: add commands to retrieve API key
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
80 .Pp |
|
85c59fbf1407
scid: add commands to retrieve API key
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
81 Otherwise, if no command is specified run either as CGI or FastCGI service. |
| 13 | 82 .\" SEE ALSO |
| 83 .Sh SEE ALSO | |
| 84 .Xr sci 7 , | |
| 85 .Xr scictl 8 , | |
| 86 .Xr sciworkerd 8 |