CANVAS(1)

NAME
canvas - task automation

SYNOPSIS
canvas [-d] [-C path] [-c comment] [-s step] [-t tag]
canvas [-d] -r path

DESCRIPTION
The canvas utility exposes the generic parts of the robsd(8) tooling. Providing an empty canvas for task automation, capable of handling both synchronous and asynchronous tasks. The steps to execute are defined using canvas.conf(5).

Each invocation is identified by a directory created by canvas rooted in canvas-dir and is named after the current date. The directory contains the entries as follows. In addition, each executed step has a corresponding log file in the same directory.

comment
    File used to annotate the invocation which is included in report.

report
    A summary delivered as a mail to the invoking user while running in the background once canvas exits.

robsd.log
    Standard output and error from canvas while running in the background.

stat.csv
    Collected statistics, see robsd-stat(8).

step.csv
    Internal representation of the executed steps, see robsd-step(8).

tags
    Tags included in report.

canvas is configured using canvas.conf(5) and the default configuration file is expected to reside in canvas.conf in the current working directory. By default, canvas runs in the background and must be killed using robsd-kill(8) to ensure a clean exit.

The options are as follows:

-d  Do not detach canvas into the background.

-C path
    Path to configuration, see canvas.conf(5).

-c comment
    Path to comment included in report.

-r path
    Resume an invocation located at path. If the last executed step failed or aborted, it will be executed again. Otherwise, the next step will be executed.

-s step
    Skip step, see enumerated steps above. May be given multiple times.

-t tag
    Arbitrary tag used to annotate the invocation which is included in report. May be given multiple times.

DIAGNOSTICS

SEE ALSO
canvas.conf(5)

AUTHORS
Anton Lindqvist <anton@basename.se>