diff man/scictl.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 562372396019
children 71cd8447e3a4
line wrap: on
line diff
--- a/man/scictl.8	Thu Aug 18 20:21:33 2022 +0200
+++ b/man/scictl.8	Sat Aug 20 10:36:55 2022 +0200
@@ -107,16 +107,16 @@
 .\" job-todo
 .It Cm job-todo
 List jobs that must be performed by the given
-.Ar worker .
-Jobs that were created earlier than the worker will not be listed to avoid
-evaluating a possible high number of jobs.
+.Ar worker
+name. Jobs that were created earlier than the worker will not be listed to
+avoid evaluating a possible high number of jobs.
 .\" project-add
 .It Cm project-add
 Create a new project with
 .Ar name ,
-an user description set with
+a user description set with
 .Ar desc ,
-a website arbitrary
+an arbitrary website
 .Ar url ,
 and a script code to execute specified by file
 .Ar script .
@@ -149,12 +149,6 @@
 .Ar name
 argument and a new description as
 .Ar key .
-.Pp
-Examples:
-.Bd -literal -offset indent
-scictl project-update example desc "New description"
-scictl project-update example script "/path/to/script.sh"
-.Ed
 .\" worker-add
 .It Cm worker-add
 Create a new worker with
@@ -182,6 +176,29 @@
 .It Ev SCI_API_KEY
 Secret API key to perform requests.
 .El
+.\" EXAMPLES
+.Sh EXAMPLES
+Add a new worker named OpenBSD with identifier openbsd
+.Bd -literal -offset indent
+$ scictl worker-add openbsd OpenBSD
+.Ed
+.Pp
+Add a project hello that executes a script shell.
+.Bd -literal -offset indent
+$ scictl project add hello "Hello World" http://hello.org hello.sh
+.Ed
+.Pp
+Add a new job for the project hello with as argument
+.Dq world
+.Bd -literal -offset indent
+$ scictl job-add hello world
+.Ed
+.Pp
+Update the project hello with new description and new code
+.Bd -literal -offset indent
+scictl project-update example desc "Hello World v2""
+scictl project-update example script hello2.sh
+.Ed
 .\" SEE ALSO
 .Sh SEE ALSO
 .Xr sci 7 ,