diff 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
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/man/sciworkerd.8.in	Wed Jun 30 11:33:54 2021 +0200
@@ -0,0 +1,72 @@
+.\"
+.\" Copyright (c) 2021 David Demelier <markand@malikania.fr>
+.\"
+.\" Permission to use, copy, modify, and/or distribute this software for any
+.\" purpose with or without fee is hereby granted, provided that the above
+.\" copyright notice and this permission notice appear in all copies.
+.\"
+.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+.\"
+.Dd June 30, 2021
+.Dt SCIWORKERD 8
+.Os
+.\" NAME
+.Sh NAME
+.Nm sciworkerd
+.Nd sci worker daemon
+.\" SYNOPSIS
+.Sh SYNOPSIS
+.Nm
+.Op Fl m Ar maxbuilds
+.Op Fl u Ar url
+.Op Fl w Ar workername
+.\" DESCRIPTION
+.Sh DESCRIPTION
+The
+.Nm
+daemon waits indefinitely for jobs to execute and send back their result. It
+requires an access to
+.Xr sciwebd 8
+running and transitively a
+.Xr scid 8
+daemon running as well.
+.Pp
+It is part of the
+.Xr sci 7
+continuous integration framework.
+.Pp
+The following options are available:
+.Bl -tag
+.It Fl m
+Set the maximum number of parallel builds allowed to
+.Ar maxbuilds .
+Defaults: 4.
+.It Fl u
+Set the
+.Ar url
+for connecting to
+.Xr sciwebd 8 .
+You can specify a scheme using
+.Dq http://
+or
+.Dq https:// .
+Default:
+.Dq localhost .
+.It Fl w
+Specify which worker this daemon should refer to using
+.Ar worker
+as worker name. Default:
+.Dq default
+.El
+.\" SEE ALSO
+.Sh SEE ALSO
+.Xr sci 7 ,
+.Xr scictl 8 ,
+.Xr scid 8 ,
+.Xr sciwebd 8 ,