Skip to content

Commit c0a972b

Browse files
[manual] Re-generate manuals.
1 parent f5cec6b commit c0a972b

File tree

7 files changed

+144
-116
lines changed

7 files changed

+144
-116
lines changed

documentation/manual/z-run.1.html

+20-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

documentation/manual/z-run.1.man

+6-8
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.\" generated with Ronn/v0.7.3
22
.\" http://github.com/rtomayko/ronn/tree/0.7.3
33
.
4-
.TH "Z\-RUN" "1" "January 2021" "" ""
4+
.TH "Z\-RUN" "1" "2021-10-03" "volution.ro" "z-run"
55
.
66
.SH "NAME"
77
\fBz\-run\fR \- lightweight scripts library tool
@@ -224,7 +224,7 @@ expects a single \fB<rpc\-target>\fR, but no other arguments or scriptlet; liste
224224
\fBz\-run\fR [ \fB<flag>\fR \.\.\. ] \fBexport\-library\-url\fR
225225
.
226226
.P
227-
expects no arguments or scriptlet; writes to \fB/dev/stdout\fR a line suitable for using it as value for the \fB\-\-library\-cache\fR flag; currently it is either a CDB database file \fB<path>\fR or \fB<rpc\-target>\fR; \fBhowever it should always be treated as an opaque value\fR, containing any ASCII character, except control characters, as it might change in future versions;
227+
expects no arguments or scriptlet; writes to \fB/dev/stdout\fR a line suitable for using it as value for the \fB\-\-library\-url\fR flag; currently it is either a CDB database file \fB<path>\fR or \fB<rpc\-target>\fR; \fBhowever it should always be treated as an opaque value\fR, containing any ASCII character, except control characters, as it might change in future versions;
228228
.
229229
.P
230230
\fBexport\-library\-fingerprint\fR
@@ -317,16 +317,16 @@ these trigger the input execution modes described in the sections above; \fBmust
317317
specifies a library \fB<source\-path>\fR, that overrides the default library source detection mecanism;
318318
.
319319
.P
320-
\fB\-\-library\-cache=<cache\-url>\fR
320+
\fB\-\-library\-url=<cache\-url>\fR
321321
.
322322
.P
323-
specifies a library \fB<cache\-url>\fR, either a \fB<cdb\-path>\fR or a \fB<rpc\-target>\fR; specifying both \fB\-\-library\-source=\.\.\.\fR and \fB\-\-library\-cache=\.\.\.\fR is not allowed;
323+
specifies a library \fB<cache\-url>\fR, either a \fB<cdb\-path>\fR or a \fB<rpc\-target>\fR; specifying both \fB\-\-library\-source=\.\.\.\fR and \fB\-\-library\-url=\.\.\.\fR is not allowed;
324324
.
325325
.P
326326
\fB\-\-workspace=<path>\fR
327327
.
328328
.P
329-
specifies a folder that \fBz\-run\fR switches to before executing; (if no \fB\-\-library\-source=\.\.\.\fR or \fB\-\-library\-cache=\.\.\.\fR is specified, the default library source detection mecanism uses this folder as the root;)
329+
specifies a folder that \fBz\-run\fR switches to before executing; (if no \fB\-\-library\-source=\.\.\.\fR or \fB\-\-library\-url=\.\.\.\fR is specified, the default library source detection mecanism uses this folder as the root;)
330330
.
331331
.P
332332
\fB\-\-ssh\-target=<ssh\-target>\fR
@@ -368,7 +368,7 @@ an alternative to the \fB\-\-library\-source=\.\.\.\fR flag; never exported insi
368368
\fBZRUN_LIBRARY_URL\fR
369369
.
370370
.P
371-
an alternative to the \fB\-\-library\-cache=\.\.\.\fR flag; always exported inside the scriptlet execution environment; (never unset it explicitly;)
371+
an alternative to the \fB\-\-library\-url=\.\.\.\fR flag; always exported inside the scriptlet execution environment; (never unset it explicitly;)
372372
.
373373
.P
374374
\fBZRUN_WORKSPACE\fR
@@ -394,8 +394,6 @@ always exported inside the scriptlet execution environment; (never unset it expl
394394
.P
395395
an alternative folder to the default \fB$HOME/\.cache/z\-run\fR, where various files (and pipes, sockets, etc\.) are created; (if explicitly specified, it is exported in the scriptlet execution environment;)
396396
.
397-
.P
398-
.
399397
.SH "LIBRARY"
400398
.
401399
.SS "Library source resolution"
File renamed without changes.

documentation/manual/z-run.1.txt

+46-47
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Z-RUN(1) Z-RUN(1)
1+
Z-RUN(1) z-run Z-RUN(1)
22

33

44

@@ -197,11 +197,10 @@ COMMANDS
197197
z-run [ <flag> ... ] export-library-url
198198

199199
expects no arguments or scriptlet; writes to /dev/stdout a line
200-
suitable for using it as value for the --library-url flag; currently
201-
it is either a CDB database file <path> or <rpc-target>; however it
202-
should always be treated as an opaque value, containing any ASCII
203-
character, except control characters, as it might change in future
204-
versions;
200+
suitable for using it as value for the --library-url flag; currently it
201+
is either a CDB database file <path> or <rpc-target>; however it should
202+
always be treated as an opaque value, containing any ASCII character,
203+
except control characters, as it might change in future versions;
205204

206205
export-library-fingerprint
207206
z-run [ <flag> ... ] export-library-fingerprint
@@ -402,24 +401,24 @@ NOTES
402401
What sets z-run aside from a "classical" scripts is:
403402

404403
• first it allows one to easily mix multiple languages; for example
405-
one can easily write a Bash script that chains together a Python,
406-
Ruby and another Bash script, all within the same file; (with
407-
classical scripts one would have had to create multiple files, one
408-
for each language, and explicitly invoke them via the interpreter;)
404+
one can easily write a Bash script that chains together a Python,
405+
Ruby and another Bash script, all within the same file; (with
406+
classical scripts one would have had to create multiple files, one
407+
for each language, and explicitly invoke them via the interpreter;)
409408

410409
• it allows one to easily bundle together unrelated scripts; for
411-
example say one uses z-run to aid in the development process, then
412-
one could bundle together scripts related to compiling, testing,
413-
deploying, and other single-shot shortcuts in the same file;
414-
(again, with classical scripts, one would have usually put each of
415-
these in separate files, or by using case or function try to manage
416-
them inside a reduced set of files;)
410+
example say one uses z-run to aid in the development process, then
411+
one could bundle together scripts related to compiling, testing,
412+
deploying, and other single-shot shortcuts in the same file;
413+
(again, with classical scripts, one would have usually put each of
414+
these in separate files, or by using case or function try to manage
415+
them inside a reduced set of files;)
417416

418417
• it allows one to easily invoke scriptlets from within the same
419-
library, without caring what language they are written in, or where
420-
their source code is stored; (with classical scripts one has to
421-
take care of getting the paths to other scripts right, especially
422-
when running from a different folder than the original one;)
418+
library, without caring what language they are written in, or where
419+
their source code is stored; (with classical scripts one has to
420+
take care of getting the paths to other scripts right, especially
421+
when running from a different folder than the original one;)
423422

424423

425424

@@ -428,40 +427,40 @@ NOTES
428427
functionalities:
429428

430429
• environment variables management -- by allowing certain environment
431-
variables to be overriden, removed or appended (like in the case of
432-
$PATH); (with classical scripts one has to manage these by
433-
themselves, resort to various "envdir" tools, or interact with
434-
shell magic;)
430+
variables to be overriden, removed or appended (like in the case of
431+
$PATH); (with classical scripts one has to manage these by
432+
themselves, resort to various "envdir" tools, or interact with
433+
shell magic;)
435434

436435
• hierarchical menus -- by simply calling z-run without any
437-
arguments, it presents one with a selectable menu of all the
438-
scriptlets in the library, and after one selects a scriptlet it
439-
executes it; moreover one can group various scriptlets under other
440-
sub-menus, thus allowing arbitrary nesting and navigation; (when
441-
used from a terminal, z-run uses and embedded fzf-based UI; when
442-
used from outside a terminal, z-run tries to use z-run--select (any
443-
system), rofi or dmenu (under Linux and BSD´s) or choose (under
444-
OSX);)
436+
arguments, it presents one with a selectable menu of all the
437+
scriptlets in the library, and after one selects a scriptlet it
438+
executes it; moreover one can group various scriptlets under other
439+
sub-menus, thus allowing arbitrary nesting and navigation; (when
440+
used from a terminal, z-run uses and embedded fzf-based UI; when
441+
used from outside a terminal, z-run tries to use z-run--select (any
442+
system), rofi or dmenu (under Linux and BSD´s) or choose (under
443+
OSX);)
445444

446445
• SSH-based remote execution -- one can easily execute a given
447-
scriptlet on a remote server without having to previously copy
448-
anything there; moreover once the scriptlet is executing on the
449-
remote server, it can invoke other scriptlets from the library that
450-
are also to be executed remotely; (the only requirement is having
451-
z-run installed on the remote machine;)
446+
scriptlet on a remote server without having to previously copy
447+
anything there; moreover once the scriptlet is executing on the
448+
remote server, it can invoke other scriptlets from the library that
449+
are also to be executed remotely; (the only requirement is having
450+
z-run installed on the remote machine;)
452451

453452
• scriptlets generation -- one can easily write a scriptlet that
454-
generates z-run compliant source, thus generating other scriptlets
455-
based on arbitrary criteria; (for example one could write a
456-
scriptlet, that generates other scriptlets specific for each file
457-
in a given folder;)
453+
generates z-run compliant source, thus generating other scriptlets
454+
based on arbitrary criteria; (for example one could write a
455+
scriptlet, that generates other scriptlets specific for each file
456+
in a given folder;)
458457

459458
• library compiling -- one can easily create a single file that
460-
contains the entire library, which can then be moved and used in
461-
another place;
459+
contains the entire library, which can then be moved and used in
460+
another place;
462461

463462
• Go-based templates -- that are useful especially in generating
464-
other scriptlets;
463+
other scriptlets;
465464

466465

467466

@@ -475,12 +474,12 @@ NOTES
475474
conditions are met:
476475

477476
• any of the files that comprise the source code of the library are
478-
changed; (based both on file timestamps and contents hashing;)
477+
changed; (based both on file timestamps and contents hashing;)
479478

480479
• any of the environment variables change;
481480

482481
• a different version of z-run is installed; (this covers both
483-
upgrading and downgrading;)
482+
upgrading and downgrading;)
484483

485484

486485

@@ -495,4 +494,4 @@ EXAMPLES
495494

496495

497496

498-
January 2021 Z-RUN(1)
497+
volution.ro 2021-10-03 Z-RUN(1)

sources/embedded/manual/z-run.html

+20-3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

sources/embedded/manual/z-run.man

+6-8
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.\" generated with Ronn/v0.7.3
22
.\" http://github.com/rtomayko/ronn/tree/0.7.3
33
.
4-
.TH "Z\-RUN" "1" "January 2021" "" ""
4+
.TH "Z\-RUN" "1" "2021-10-03" "volution.ro" "z-run"
55
.
66
.SH "NAME"
77
\fBz\-run\fR \- lightweight scripts library tool
@@ -224,7 +224,7 @@ expects a single \fB<rpc\-target>\fR, but no other arguments or scriptlet; liste
224224
\fBz\-run\fR [ \fB<flag>\fR \.\.\. ] \fBexport\-library\-url\fR
225225
.
226226
.P
227-
expects no arguments or scriptlet; writes to \fB/dev/stdout\fR a line suitable for using it as value for the \fB\-\-library\-cache\fR flag; currently it is either a CDB database file \fB<path>\fR or \fB<rpc\-target>\fR; \fBhowever it should always be treated as an opaque value\fR, containing any ASCII character, except control characters, as it might change in future versions;
227+
expects no arguments or scriptlet; writes to \fB/dev/stdout\fR a line suitable for using it as value for the \fB\-\-library\-url\fR flag; currently it is either a CDB database file \fB<path>\fR or \fB<rpc\-target>\fR; \fBhowever it should always be treated as an opaque value\fR, containing any ASCII character, except control characters, as it might change in future versions;
228228
.
229229
.P
230230
\fBexport\-library\-fingerprint\fR
@@ -317,16 +317,16 @@ these trigger the input execution modes described in the sections above; \fBmust
317317
specifies a library \fB<source\-path>\fR, that overrides the default library source detection mecanism;
318318
.
319319
.P
320-
\fB\-\-library\-cache=<cache\-url>\fR
320+
\fB\-\-library\-url=<cache\-url>\fR
321321
.
322322
.P
323-
specifies a library \fB<cache\-url>\fR, either a \fB<cdb\-path>\fR or a \fB<rpc\-target>\fR; specifying both \fB\-\-library\-source=\.\.\.\fR and \fB\-\-library\-cache=\.\.\.\fR is not allowed;
323+
specifies a library \fB<cache\-url>\fR, either a \fB<cdb\-path>\fR or a \fB<rpc\-target>\fR; specifying both \fB\-\-library\-source=\.\.\.\fR and \fB\-\-library\-url=\.\.\.\fR is not allowed;
324324
.
325325
.P
326326
\fB\-\-workspace=<path>\fR
327327
.
328328
.P
329-
specifies a folder that \fBz\-run\fR switches to before executing; (if no \fB\-\-library\-source=\.\.\.\fR or \fB\-\-library\-cache=\.\.\.\fR is specified, the default library source detection mecanism uses this folder as the root;)
329+
specifies a folder that \fBz\-run\fR switches to before executing; (if no \fB\-\-library\-source=\.\.\.\fR or \fB\-\-library\-url=\.\.\.\fR is specified, the default library source detection mecanism uses this folder as the root;)
330330
.
331331
.P
332332
\fB\-\-ssh\-target=<ssh\-target>\fR
@@ -368,7 +368,7 @@ an alternative to the \fB\-\-library\-source=\.\.\.\fR flag; never exported insi
368368
\fBZRUN_LIBRARY_URL\fR
369369
.
370370
.P
371-
an alternative to the \fB\-\-library\-cache=\.\.\.\fR flag; always exported inside the scriptlet execution environment; (never unset it explicitly;)
371+
an alternative to the \fB\-\-library\-url=\.\.\.\fR flag; always exported inside the scriptlet execution environment; (never unset it explicitly;)
372372
.
373373
.P
374374
\fBZRUN_WORKSPACE\fR
@@ -394,8 +394,6 @@ always exported inside the scriptlet execution environment; (never unset it expl
394394
.P
395395
an alternative folder to the default \fB$HOME/\.cache/z\-run\fR, where various files (and pipes, sockets, etc\.) are created; (if explicitly specified, it is exported in the scriptlet execution environment;)
396396
.
397-
.P
398-
.
399397
.SH "LIBRARY"
400398
.
401399
.SS "Library source resolution"

0 commit comments

Comments
 (0)