mirror of
https://github.com/ohwgiles/laminar.git
synced 2026-03-02 03:40:21 +00:00
edit manpages and cmakeize them
so that they will be installed in the correct place as part of a normal build or packaging process.
This commit is contained in:
71
etc/laminarc.1
Normal file
71
etc/laminarc.1
Normal file
@@ -0,0 +1,71 @@
|
||||
.Dd Apr 04, 2019
|
||||
.Dt LAMINARC 1
|
||||
.Sh NAME
|
||||
.Nm laminarc
|
||||
\-
|
||||
Laminar CI client application
|
||||
.Sh SYNOPSIS
|
||||
.Nm laminarc Li queue \fIJOB\fR [\fIPARAM=VALUE...\fR] ...
|
||||
.Nm laminarc Li queue \fIJOB\fR [\fIPARAM=VALUE...\fR] ...
|
||||
.Nm laminarc Li queue \fIJOB\fR [\fIPARAM=VALUE...\fR] ...
|
||||
.Nm laminarc Li set \fIPARAM=VALUE...\fR
|
||||
.Nm laminarc Li show-jobs
|
||||
.Nm laminarc Li show-running
|
||||
.Nm laminarc Li show-queued
|
||||
.Nm laminarc Li abort \fIJOB\fR \fINUMBER\fR
|
||||
.Sh DESCRIPTION
|
||||
The
|
||||
.Nm laminarc
|
||||
program connects to a Laminar server and perform one of following operations:
|
||||
.Bl -tag
|
||||
.It Sy queue
|
||||
adds job(s) (with optional parameters) to the queue and returns immediately.
|
||||
.It Sy start
|
||||
adds job(s) (with optional parameters) to the queue and returns when the jobs
|
||||
begin execution.
|
||||
.It Sy run
|
||||
adds job(s) (with optional parameters) to the queue and returns when the jobs
|
||||
complete execution. The exit code will be non-zero if any of the runs does
|
||||
not complete successfully.
|
||||
.It Sy set
|
||||
sets one or more parameters to be exported as environment variables in subsequent
|
||||
scripts for the run identified by the $JOB and $RUN environment variables.
|
||||
This is primarily intended for use from within a job execution, where those
|
||||
variables are already set by the server.
|
||||
.It Sy show-jobs
|
||||
list jobs known to the server.
|
||||
.It Sy show-running
|
||||
list the currently running jobs with their numbers.
|
||||
.It Sy show-queued
|
||||
list the names and numbers of the jobs waiting in the queue.
|
||||
.It Sy abort
|
||||
manually abort a currently running job by name and number.
|
||||
.El
|
||||
.Pp
|
||||
The laminar server to connect to is read from the
|
||||
.Ev LAMINAR_HOST
|
||||
environment variable. If empty, it falls back to
|
||||
.Ev LAMINAR_BIND_RPC
|
||||
and finally defaults to
|
||||
.Ad
|
||||
unix-abstract:laminar.
|
||||
.Sh ENVIRONMENT
|
||||
.Bl -tag
|
||||
.It Ev LAMINAR_HOST
|
||||
address of server to connect. May be of the form
|
||||
.Ad IP:PORT,
|
||||
.Ad unix:PATH/TO/SOCKET or
|
||||
.Ad unix-abstract:NAME
|
||||
.It Ev LAMINAR_BIND_RPC
|
||||
fallback server address variable. It is set by
|
||||
.Nm laminard
|
||||
during execution of scripts.
|
||||
.El
|
||||
.Sh SEE ALSO
|
||||
.Xr laminard 8
|
||||
.Sh AUTHORS
|
||||
.An Oliver Giles
|
||||
created Laminar CI.
|
||||
.An Dmitry Bogatov
|
||||
created this manual page for the Debian project (but it can be used
|
||||
by others).
|
||||
56
etc/laminard.8
Normal file
56
etc/laminard.8
Normal file
@@ -0,0 +1,56 @@
|
||||
.Dd Apr 03, 2019
|
||||
.Dt LAMINARD 1
|
||||
.Sh NAME
|
||||
.Nm laminard
|
||||
\-
|
||||
Laminar CI server
|
||||
.Sh SYNOPSIS
|
||||
.Nm laminard Op Fl v
|
||||
.Sh DESCRIPTION
|
||||
Start Laminar CI server in the foreground. If option
|
||||
.Fl v
|
||||
is specified, verbose logging is enabled. Other aspects of
|
||||
operation are controlled by environment variables.
|
||||
.Sh ENVIRONMENT
|
||||
.Bl -tag
|
||||
.It Ev LAMINAR_HOME
|
||||
Root location containing laminar configuration, database, build
|
||||
workspaces and archive.
|
||||
.Pp
|
||||
Default: /var/lib/laminar
|
||||
.It Ev LAMINAR_BIND_HTTP
|
||||
Interface on which laminard will bind to serve the Web UI.
|
||||
May be of the form IP:PORT, unix:PATH/TO/SOCKET or unix-abstract:NAME
|
||||
.Pp
|
||||
Default: *:8080
|
||||
.It Ev LAMINAR_BIND_HRPC
|
||||
Interface on which laminard will bind to accept RPC from laminarc.
|
||||
May be of the form IP:PORT, unix:PATH/TO/SOCKET or unix-abstract:NAME
|
||||
.Pp
|
||||
Default: unix-abstract:laminar
|
||||
.It Ev LAMINAR_TITLE
|
||||
Page title to show in web frontend
|
||||
.It Ev LAMINAR_KEEP_RUNDIRS
|
||||
Setting this prevents the immediate deletion of job rundirs
|
||||
$LAMINAR_HOME/run/$JOB/$RUN. Value should be an integer represeting
|
||||
the number of rundirs to keep.
|
||||
.Pp
|
||||
Default: 0
|
||||
.It Ev LAMINAR_ARCHIVE_URL
|
||||
Base url used to request artifacts. Laminar can serve build artifacts
|
||||
(and it will if you leave this unset), but it uses a very naive and
|
||||
inefficient method. Best to let a real webserver handle serving those
|
||||
requests.
|
||||
.El
|
||||
.Sh FILES
|
||||
.Bl -tag
|
||||
.It Pa /etc/laminar.conf
|
||||
Variable assignments in this file are exported by systemd or other
|
||||
init system before launching the system-wide installation of Laminar.
|
||||
.El
|
||||
.Sh AUTHORS
|
||||
.An Oliver Giles
|
||||
created Laminar CI.
|
||||
.An Dmitry Bogatov
|
||||
created this manual page for Debian project (but it can be used
|
||||
by others).
|
||||
Reference in New Issue
Block a user