Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 11 additions & 10 deletions docs/man-page/man_medley.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,10 @@ <h2>Flags</h2>
<dd>
<p>Prints out a brief summary of the flags and arguments to medley.</p>
</dd>
<dt>-z, --man</dt>
<dt>-z [+], --man [+]</dt>
<dd>
<p>Show the man page for medley</p>
<p>Show the man page for medley. If the <strong>+</strong> parameter is
specified, then no pager is used when displaying the man page.</p>
</dd>
<dt>-c [<em>FILE</em> | -], --config [<em>FILE</em> | -]</dt>
<dd>
Expand Down Expand Up @@ -101,7 +102,7 @@ <h2>Flags</h2>
<dt>-g [<em>WxH</em> | -], --geometry [<em>WxH</em> | -]</dt>
<dd>
<p>Sets the size of the X Window (or VNC window) that Medley runs in to
be Width x Height. (Full X Windows geomtery specification with +X+Y is
be Width x Height. (Full X Windows geometry specification with +X+Y is
not currently supported).</p>
<p>If a value of “-” is given, geometry is set to the default value.</p>
<p>If --geometry is not specified but --screensize is, then the window
Expand Down Expand Up @@ -293,15 +294,15 @@ <h2>Flags</h2>
that very short Medley sessions are possible and the Xvnc error
detection needs to be adjusted accordingly.</p>
</dd>
<dt>-br [<em>BRANCH</em> | -], --branch [<em>BRANCH</em> | -]</dt>
<dt>-tg [<em>TAG</em> | -], --tag [<em>TAG</em> | -]</dt>
<dd>
<p>By default, sysout files are loaded from the MEDLEYDIR/loadups
directory. If “--branch <em>BRANCH</em>” is specified, then by default
sysout files are loaded from the MEDLEYDIR/loadups/branches/BRANCH
directory. The sysouts in these directories are created using a loadups
script with the --branch flag set. See the loadup man page. If
<em>BRANCH</em> is “-”, then the name of the active git branch for
MEDLEYDIR (if any) is used as <em>BRANCH</em>.</p>
directory. If “--tag <em>TAG</em>” is specified, then by default sysout
files are loaded from the MEDLEYDIR/loadups/tagged/TAG directory. The
sysouts in these directories are created using a loadups script with the
--tag flag set. See the loadup man page. If <em>TAG</em> is “-”, then
the name of the active git branch for MEDLEYDIR (if any) is used as
<em>TAG</em>.</p>
</dd>
</dl>
<h2>Other Options</h2>
Expand Down
21 changes: 11 additions & 10 deletions docs/man-page/medley.1
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,10 @@ hence MEDLEYDIR is computed on each invocation of medley.
-h, --help
Prints out a brief summary of the flags and arguments to medley.
.TP
-z, --man
Show the man page for medley
-z [+], --man [+]
Show the man page for medley.
If the \f[B]+\f[R] parameter is specified, then no pager is used when
displaying the man page.
.TP
-c [\f[I]FILE\f[R] | -], --config [\f[I]FILE\f[R] | -]
Use \f[I]FILE\f[R] as the config file for this run of Medley.
Expand Down Expand Up @@ -151,7 +153,7 @@ virtual display.
-g [\f[I]WxH\f[R] | -], --geometry [\f[I]WxH\f[R] | -]
Sets the size of the X Window (or VNC window) that Medley runs in to be
Width x Height.
(Full X Windows geomtery specification with +X+Y is not currently
(Full X Windows geometry specification with +X+Y is not currently
supported).
.RS
.PP
Expand Down Expand Up @@ -396,17 +398,16 @@ failures.
Setting this flag notifies Medley that very short Medley sessions are
possible and the Xvnc error detection needs to be adjusted accordingly.
.TP
-br [\f[I]BRANCH\f[R] | -], --branch [\f[I]BRANCH\f[R] | -]
-tg [\f[I]TAG\f[R] | -], --tag [\f[I]TAG\f[R] | -]
By default, sysout files are loaded from the MEDLEYDIR/loadups
directory.
If \[lq]--branch \f[I]BRANCH\f[R]\[rq] is specified, then by default
sysout files are loaded from the MEDLEYDIR/loadups/branches/BRANCH
directory.
If \[lq]--tag \f[I]TAG\f[R]\[rq] is specified, then by default sysout
files are loaded from the MEDLEYDIR/loadups/tagged/TAG directory.
The sysouts in these directories are created using a loadups script with
the --branch flag set.
the --tag flag set.
See the loadup man page.
If \f[I]BRANCH\f[R] is \[lq]-\[rq], then the name of the active git
branch for MEDLEYDIR (if any) is used as \f[I]BRANCH\f[R].
If \f[I]TAG\f[R] is \[lq]-\[rq], then the name of the active git branch
for MEDLEYDIR (if any) is used as \f[I]TAG\f[R].
.SS Other Options
.PP
\
Expand Down
Binary file modified docs/man-page/medley.1.gz
Binary file not shown.
20 changes: 10 additions & 10 deletions docs/man-page/medley.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,9 @@ Flags
-h, \-\-help
: Prints out a brief summary of the flags and arguments to medley.

-z, \-\-man
: Show the man page for medley
-z [+], \-\-man [+]
: Show the man page for medley. If the **+** parameter is specified, then no pager is used when
displaying the man page.

-c [*FILE* | -], \-\-config [*FILE* | -]
: Use *FILE* as the config file for this run of Medley. See information on *CONFIG FILE* below.
Expand Down Expand Up @@ -106,7 +107,7 @@ than the window, there will be no way to pan to the non-visible parts of the vir

-g [*WxH* | -], \-\-geometry [*WxH* | -]
: Sets the size of the X Window (or VNC window) that Medley runs in to be Width x Height. (Full X Windows
geomtery specification with +X+Y is not currently supported).
geometry specification with +X+Y is not currently supported).

If a value of "-" is given, geometry is set to the default value.

Expand Down Expand Up @@ -263,14 +264,13 @@ specified in the Medley file system, not the host Windows file system.
will run for a very short time (< a couple of seconds). This can cause issues with medley code that detects Xvnc server failures.
Setting this flag notifies Medley that very short Medley sessions are possible and the Xvnc error detection needs to be adjusted accordingly.

-br [*BRANCH* | -], \-\-branch [*BRANCH* | -]
-tg [*TAG* | -], \-\-tag [*TAG* | -]
: By default, sysout files are loaded from the MEDLEYDIR/loadups directory.
If "\-\-branch *BRANCH*" is specified, then by default sysout files are loaded from the
MEDLEYDIR/loadups/branches/BRANCH directory. The sysouts in these directories are created using
a loadups script with the \-\-branch flag set. See the loadup man page.
If *BRANCH* is "-", then the name of the active git branch for MEDLEYDIR (if any) is used as
*BRANCH*.

If "\-\-tag *TAG*" is specified, then by default sysout files are loaded from the
MEDLEYDIR/loadups/tagged/TAG directory. The sysouts in these directories are created using
a loadups script with the \-\-tag flag set. See the loadup man page.
If *TAG* is "-", then the name of the active git branch for MEDLEYDIR (if any) is used as
*TAG*.


Other Options
Expand Down
42 changes: 30 additions & 12 deletions internal/loadups/man-page/loadup.1
Original file line number Diff line number Diff line change
Expand Up @@ -130,8 +130,10 @@ But Medley can be installed in multiple places on any given machine and
hence MEDLEYDIR is computed on each invocation of loadup.
.SH OPTIONS
.TP
\f[B]-z, --man, -man\f[R]
\f[B]-z [+], --man [+], -man [+], -h [+], \[en]help [+]\f[R]
Print this manual page on the screen.
If the \f[B]+\f[R] parameter is specified, then no pager is used when
displaying the man page.
.TP
\f[B]-t STAGE, --target STAGE, -target STAGE\f[R]
Run the sequential loadup procedure until the STAGE is complete,
Expand Down Expand Up @@ -266,31 +268,47 @@ simultaneously.
If this flag is not set and an active lock is encountered, the user will
be asked to choose whether to override or exit.
.TP
\f[B]-br [ BRANCH | -], --branch [ BRANCH | - ]\f[R]
\f[B]-tg [ TAG | -], --tag [ TAG | - ]\f[R]
By default the sysouts and other files produced by loadup are placed at
the top level of the <MEDLEYDIR>/loadups directory.
If this flag is specified, then the sysout and other output files are
placed in the directory <MEDLEYDIR>/loadups/branches/BRANCH.
If BRANCH is \[lq]-\[rq] or not specified at all, then BRANCH is the
name of the currently active git branch of <MEDLEYDIR>, except if git is
not installled on the current system or if <MEDLEYDIR> is not a git
placed in the directory <MEDLEYDIR>/loadups/tagged/TAG.
If TAG is \[lq]-\[rq] or not specified at all, then TAG is the name of
the currently active git branch of <MEDLEYDIR>, except if git is not
installled on the current system or if <MEDLEYDIR> is not a git
directory, in which case then this flag is ignored.
BRANCH can contain alphanumerics, dashes, underscores,and periods.
TAG can contain alphanumerics, dashes, underscores,and periods.
Any other character is replaced by an underscore.
The medley script has a corresponding --branch argument to load these
The medley script has a corresponding --tag (-tg) argument to load these
sysout files.
.TP
\f[B]-nc, --nocopy, -nocopy\f[R]
Run the specified loadups, but do not copy results into loadups
directory.
.TP
\f[B]-tw, --thinw, -thinw\f[R]
\f[B]-tw [+], --thinw [+], -thinw [+]\f[R]
Before running loadups (if any), thin the working directory by deleting
all versioned (\f[I].\[ti][0-9]\f[R]\[ti]) files.
all versioned (\f[I].\[ti][0-9]\f[R]\[ti]) files therein.
If the \f[B]+\f[R] parameter is used, then instead of deleting just the
versioned files, the working directory (and all files and subdirectories
it contains) is deleted.
.TP
\f[B]-tl, --thinl, -thinl\f[R]
\f[B]-tl [+], --thinl [+], -thinl [+]\f[R]
Before running loadups (if any), thin the loadups directory by deleting
all versioned (\f[I].\[ti][0-9]\f[R]\[ti]) files.
all versioned (\f[I].\[ti][0-9]\f[R]\[ti]) files except for those
contained in the working directory.
If the \f[B]+\f[R] parameter is used, then instead of deleting just the
versioned files, all files and subdirectories are deleted except for
those contained in the working directory.
If \f[B]+\f[R] is used and there is no working directory and
\f[I]\[en]tag TAG\f[R] is also specified, then the tagged loadups
directory (<MEDLEYDIR>/loadups/tagged/TAG) is also deleted.
.TP
\f[B]-th [+], --thin [+], -thin [+]\f[R]
Equivalent to specifying both -tw [+] and -tl [+].
If \f[I]\[en]tag TAG\f[R] is also specified and the \f[B]+\f[R]
parameter is used here, then the tagged loadups directory
(<MEDLEYDIR>/loadups/tagged/TAG) is removed.
.TP
\f[B]-d DIR, --maikodir DIR, -maikodir DIR\f[R]
Use DIR as the directory from which to execute lde (Miko) when running
Expand Down
Binary file modified internal/loadups/man-page/loadup.1.gz
Binary file not shown.
37 changes: 25 additions & 12 deletions internal/loadups/man-page/loadup.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,9 @@ hence MEDLEYDIR is computed on each invocation of loadup.

OPTIONS
=======
**-z, \-\-man, \-man**
: Print this manual page on the screen.
**-z [+], \-\-man [+], \-man [+], -h [+], --help [+]**
: Print this manual page on the screen. If the **+** parameter is specified, then no pager is used when
displaying the man page.

**-t STAGE, \-\-target STAGE, -target STAGE**
: Run the sequential loadup procedure until the STAGE is complete, starting from the files created by the previously run STAGE specified in the --start option.
Expand Down Expand Up @@ -124,25 +125,37 @@ OPTIONS
**-ov, \-\-override, -override**
: Automatically override the lock that prevents two loadups from running simultaneously. If this flag is not set and an active lock is encountered, the user will be asked to choose whether to override or exit.

**-br [ BRANCH | -], \-\-branch [ BRANCH | - ]**
**-tg [ TAG | -], \-\-tag [ TAG | - ]**
: By default the sysouts and other files produced by loadup are placed at the top level of
the \<MEDLEYDIR>/loadups directory. If this flag is specified, then the sysout and other
output files are placed in the directory \<MEDLEYDIR>/loadups/branches/BRANCH.
If BRANCH is "-" or not specified at all, then BRANCH is the name of the currently active
output files are placed in the directory \<MEDLEYDIR>/loadups/tagged/TAG.
If TAG is "-" or not specified at all, then TAG is the name of the currently active
git branch of \<MEDLEYDIR>, except if git is not installled on the current system
or if \<MEDLEYDIR> is not a git directory, in which case then this flag is ignored.
BRANCH can contain alphanumerics, dashes, underscores,and periods.
TAG can contain alphanumerics, dashes, underscores,and periods.
Any other character is replaced by an underscore.
The medley script has a corresponding \-\-branch argument to load these sysout files.
The medley script has a corresponding \-\-tag (-tg) argument to load these sysout files.

**-nc, \-\-nocopy, -nocopy**
: Run the specified loadups, but do not copy results into loadups directory.

**-tw, \-\-thinw, -thinw**
: Before running loadups (if any), thin the working directory by deleting all versioned (*.~[0-9]*~) files.

**-tl, \-\-thinl, -thinl**
: Before running loadups (if any), thin the loadups directory by deleting all versioned (*.~[0-9]*~) files.
**-tw [+], \-\-thinw [+], -thinw [+]**
: Before running loadups (if any), thin the working directory by deleting all versioned (*.~[0-9]*~)
files therein. If the **+** parameter is used, then instead of deleting just the versioned files, the
working directory (and all files and subdirectories it contains) is deleted.

**-tl [+], \-\-thinl [+], -thinl [+]**
: Before running loadups (if any), thin the loadups directory by deleting all versioned (*.~[0-9]*~)
files except for those contained in the working directory.
If the **+** parameter is used, then instead of deleting just the versioned files, all files and
subdirectories are deleted except for those contained in the working directory. If **+** is used and
there is no working directory and *--tag TAG* is also specified,
then the tagged loadups directory (\<MEDLEYDIR>/loadups/tagged/TAG) is also deleted.

**-th [+], \-\-thin [+], -thin [+]**
: Equivalent to specifying both -tw [+] and -tl [+]. If *--tag TAG* is also specified and
the **+** parameter is used here, then the tagged loadups directory (\<MEDLEYDIR>/loadups/tagged/TAG)
is removed.

**-d DIR, \-\-maikodir DIR, -maikodir DIR**
: Use DIR as the directory from which to execute lde (Miko) when running Medley in the loadup process. If this flag is not present, the value of the environment variable MAIKODIR will be used instead. And if MAIKODIR does not exist, then the default Maiko directory search within Medley will be used.
Expand Down
49 changes: 34 additions & 15 deletions internal/loadups/man-page/man_loadup.html
Original file line number Diff line number Diff line change
Expand Up @@ -99,9 +99,11 @@ <h1>DESCRIPTION</h1>
computed on each invocation of loadup.</p>
<h1>OPTIONS</h1>
<dl>
<dt><strong>-z, --man, -man</strong></dt>
<dt><strong>-z [+], --man [+], -man [+], -h [+], –help [+]</strong></dt>
<dd>
<p>Print this manual page on the screen.</p>
<p>Print this manual page on the screen. If the <strong>+</strong>
parameter is specified, then no pager is used when displaying the man
page.</p>
</dd>
<dt><strong>-t STAGE, --target STAGE, -target STAGE</strong></dt>
<dd>
Expand Down Expand Up @@ -208,34 +210,51 @@ <h1>OPTIONS</h1>
encountered, the user will be asked to choose whether to override or
exit.</p>
</dd>
<dt><strong>-br [ BRANCH | -], --branch [ BRANCH | - ]</strong></dt>
<dt><strong>-tg [ TAG | -], --tag [ TAG | - ]</strong></dt>
<dd>
<p>By default the sysouts and other files produced by loadup are placed
at the top level of the &lt;MEDLEYDIR&gt;/loadups directory. If this
flag is specified, then the sysout and other output files are placed in
the directory &lt;MEDLEYDIR&gt;/loadups/branches/BRANCH. If BRANCH is
“-” or not specified at all, then BRANCH is the name of the currently
active git branch of &lt;MEDLEYDIR&gt;, except if git is not installled
on the current system or if &lt;MEDLEYDIR&gt; is not a git directory, in
which case then this flag is ignored. BRANCH can contain alphanumerics,
dashes, underscores,and periods. Any other character is replaced by an
underscore. The medley script has a corresponding --branch argument to
load these sysout files.</p>
the directory &lt;MEDLEYDIR&gt;/loadups/tagged/TAG. If TAG is “-” or not
specified at all, then TAG is the name of the currently active git
branch of &lt;MEDLEYDIR&gt;, except if git is not installled on the
current system or if &lt;MEDLEYDIR&gt; is not a git directory, in which
case then this flag is ignored. TAG can contain alphanumerics, dashes,
underscores,and periods. Any other character is replaced by an
underscore. The medley script has a corresponding --tag (-tg) argument
to load these sysout files.</p>
</dd>
<dt><strong>-nc, --nocopy, -nocopy</strong></dt>
<dd>
<p>Run the specified loadups, but do not copy results into loadups
directory.</p>
</dd>
<dt><strong>-tw, --thinw, -thinw</strong></dt>
<dt><strong>-tw [+], --thinw [+], -thinw [+]</strong></dt>
<dd>
<p>Before running loadups (if any), thin the working directory by
deleting all versioned (<em>.~[0-9]</em>~) files.</p>
deleting all versioned (<em>.~[0-9]</em>~) files therein. If the
<strong>+</strong> parameter is used, then instead of deleting just the
versioned files, the working directory (and all files and subdirectories
it contains) is deleted.</p>
</dd>
<dt><strong>-tl, --thinl, -thinl</strong></dt>
<dt><strong>-tl [+], --thinl [+], -thinl [+]</strong></dt>
<dd>
<p>Before running loadups (if any), thin the loadups directory by
deleting all versioned (<em>.~[0-9]</em>~) files.</p>
deleting all versioned (<em>.~[0-9]</em>~) files except for those
contained in the working directory. If the <strong>+</strong> parameter
is used, then instead of deleting just the versioned files, all files
and subdirectories are deleted except for those contained in the working
directory. If <strong>+</strong> is used and there is no working
directory and <em>–tag TAG</em> is also specified, then the tagged
loadups directory (&lt;MEDLEYDIR&gt;/loadups/tagged/TAG) is also
deleted.</p>
</dd>
<dt><strong>-th [+], --thin [+], -thin [+]</strong></dt>
<dd>
<p>Equivalent to specifying both -tw [+] and -tl [+]. If <em>–tag
TAG</em> is also specified and the <strong>+</strong> parameter is used
here, then the tagged loadups directory
(&lt;MEDLEYDIR&gt;/loadups/tagged/TAG) is removed.</p>
</dd>
<dt><strong>-d DIR, --maikodir DIR, -maikodir DIR</strong></dt>
<dd>
Expand Down
Loading