4b95a8b5d3
* Update docker file build to use new deb linux installers; move Dockefile to .github/workflows since its really only useable from the buildDocker.yml workflow * Fix typo in dockerfile location * remove extraneous " in >>GITHUB_ENV statements * Fix handling of TARGETPLATFORM in Dockerfile * Trying with just one platform * Fix issues with missing man-db in docker build workflow; added man-db to depends in deb builds for linux * Sicthed docker from tightvnc to tigervnc to match oio. This getting the apt package name right. * Going back to single platform to debug this thing * Trying with just arm64 * Removing arm/v7 from docker images. Takes too long to build and just wastes our github actions minutes. This is assuming its a never used feature since docker is not big on raspberry pis and their ilk. * Fix typo in control-linux; update build_deb so that files in /usr/local installed by deb are owned by root; add ubuntu user and nano in docker file for dbebugging; when in draft only create for x86_64 platform * Fix typo in buildDocker.yml * Add sudo to docker image; in docker image ensure that all /usr/local/interlisp files are owned by root * Add securityTypes none to docker entrypoint * Updated docker base to Ubuntu 22.10 to get fixed xrdp; add xrdp to the docker image; updated user permission in docker image; * In Dockerfile make xrdp install noninteractive * Update medley.sh scripts to handle docker case * Fix a couple of typos * BuildDcoker: added pulling latest draft release (if any) when this is a draft docker build; removed checkout of medley code cause its not used * BuildDocker: added medley checkout backin - turns pout its needed by a bunch of actions even though I dont really think they use it * BuildDocker: moved download assets to use gh instaed of a marketplace action becauase that action could not handle draft releases. * Tweaking medley.sh and associated tweaks to work Windows via wsl medley and docker * adding first pass at powershell script for windows docker and wsl * Tuning how Xvnc, medley, and vncviewer handle the various ways of exiting - eg logout vs closing viewer window. * Tuning vncviewer launch to make sure that tty works as expected when medley.sh runs in background * Minor typo fixes and added extra check to use of /run/shm in medley_vnc.sh * Added SSH_KEY secret to buildReleaseIncDocker workflow * Gertting the add SSH_KEY secret into orkflows right this time, hopefully * Adding TERM env variable and setting USER to medley in docker image * Debugging medley.ps1 and adding a couple of arguments * Typo in Dockerfile medley * Synchronizing flag processing and usage for medley.ps1 and medley.sh; refactored medley_args.sh and medley_usage.sh code. * Adding first pass at windows installer * Adding first pass an inno setup script for Windows installation * Update buildLoadup workflow and downloads page for windows installer * Fix typo in buildLoadup * BuildLoadup make sure windows runner uses powershell * Another typo in buildLoadup * Another typo in buildLoadup; damn those double quotes * Updating handling of windows installer in buildLoadup, added vncviewer to medley.iss install * Unknown syntax error in buildLoadup * Another damn typo from double quotes * buildLoadup: fixed loadup job outputs * buidLoadup: fixed bug with COMBINED_RELEASE_TAG; fixed Upload script in windows job to be compatible with actions.script v6. * buidLoadup: upload win installer adapted to find draft releases as well as full releases * BuildLoadup: fixing up javascript in actions in windows job to use / instead of \ in pathname * BuildLoadup: changing win installer update to same action used for other release assets * Fix windows installer file name; in BuildLoadup move update downl;oad page to the Windows runner because uploading the window-installer changes the release download url, so updating the downloads page must be done after the windows installer upload.; General buildLoadup cleanup * Run md2html to update downloads page * Fix typo in build_deb.sh * Removing some leftover crud in medley_usage.sh * Fixing up windows installer a bit, mostly cosmetic * Adding support for WSL1; mostly forcing --vnc and changing how to find open ports and displays since WSL1 networking is different tha WSL2 * Update manual page for new Windows Medley script * First pass done for man page that incorporates new Windows medley script. Add Xvnc wait before calling run-medley in case of docker to prevent occasonal missing X windows server error. * Change buildLoadup to update man page to a draft if this is a draft run.
221 lines
8.8 KiB
Groff
221 lines
8.8 KiB
Groff
.\" Automatically generated by Pandoc 2.5
|
|
.\"
|
|
.ad l
|
|
.TH "MEDLEY" "1" "" "" "Start Medley Interlisp"
|
|
.nh \" Turn off hyphenation by default.
|
|
.SH NAME
|
|
.PP
|
|
\f[B]medley\f[R] \[em] starts up Medley Interlisp
|
|
.SH SYNOPSIS
|
|
.PP
|
|
\f[B]medley\f[R] [ flags \&... ] [ \f[I]SYSOUT_FILE\f[R] ] [ \-\-
|
|
\f[I]PASS_ON_ARGS\f[R] ]
|
|
.SH DESCRIPTION
|
|
.PP
|
|
Starts Medley Interlisp in a window.
|
|
.SH OPTIONS
|
|
.PP
|
|
\f[B]MEDLEYDIR\f[R] is an environment variable set by Medley and used by
|
|
many of the options described below.
|
|
MEDLEYDIR is the top level directory of the Medley installation that
|
|
contains the specific medley script that is invoked after all symbolic
|
|
links are resolved.
|
|
In the standard global installation this will be
|
|
/usr/local/interlisp/medley.
|
|
But Medley can be installed in multiple places on any given machine and
|
|
hence MEDLEYDIR is computed on each invocation of medley.
|
|
.SS Flags
|
|
.PP
|
|
\
|
|
.TP
|
|
.B \-h, \-\-help
|
|
Prints out a brief summary of the flags and arguments to medley.
|
|
.TP
|
|
.B \-z, \-\-man
|
|
Show the man page for medley
|
|
.TP
|
|
.B \-f, \-\-full
|
|
Start Medley from the standard \[lq]full\[rq] sysout.
|
|
full.sysout includes a complete Interlisp and CommonLisp environment
|
|
with a standard set of development tools.
|
|
It does not include any of the applications built using Medley.
|
|
(See \f[I]SYSOUT_FILE\f[R] below for more information on starting
|
|
sysouts.)
|
|
.TP
|
|
.B \-l, \-\-lisp
|
|
Start Medley from the standard \[lq]lisp\[rq] sysout.
|
|
lisp.sysout only includes the basic Interlisp and CommonLisp
|
|
environment.
|
|
(See \f[I]SYSOUT_FILE\f[R] below for more information on starting
|
|
sysouts.)
|
|
.TP
|
|
.B \-a, \-\-apps
|
|
Start Medley from the standard \[lq]apps\[rq] sysout.
|
|
apps.sysout includes everything in full.sysout plus Medley applications
|
|
including Notecards, Rooms and CLOS.
|
|
It also includes pre\-installed links to key Medley documentation.
|
|
(See \f[I]SYSOUT_FILE\f[R] below for more information on starting
|
|
sysouts.)
|
|
.TP
|
|
.B \-e, \-\-interlisp (relevent only when \-\-apps is specified)
|
|
Make the initial Exec window within Medley be an Interlisp Exec.
|
|
Default is to start in an XCL Exec.
|
|
.TP
|
|
.B \-n, \-\-noscroll
|
|
Ordinarily Medley displays scroll bars to enable the user to pan the
|
|
Medley virtual display within the Medley window.
|
|
This is true even when the entire virtual display fits within the
|
|
window.
|
|
Specifying \-\-noscroll turns off the scroll bars.
|
|
Note: If \-\-noscroll is specified and the virtual screen is larger than
|
|
the window, there will be no way to pan to the non\-visible parts of the
|
|
virtual display.
|
|
.TP
|
|
.B \-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
|
|
supported).
|
|
If \-\-geometry is not specified but \-\-screensize is, then the window
|
|
size will be determined based on the \-\-screensize values and the
|
|
\-\-noscroll flag.
|
|
If neither \-\-geometry nor \-\-screensize is provided, then the window
|
|
size is set to 1440x900 if \-\-noscroll is set and 1462x922 if
|
|
\-\-noscroll is not set.
|
|
.TP
|
|
.B \-s \f[I]WxH\f[R], \-\-screensize \f[I]WxH\f[R]
|
|
Sets the size of the virtual display as seen from Medley\[cq]s point of
|
|
view.
|
|
The Medley window is an unscaled viewport onto this virtual display.
|
|
If \-\-screensize is not specified but \-\-geometry is, then the virtual
|
|
display size will be set so that the entire virtual display fits into
|
|
the given window geometry.
|
|
If neither \-\-screensize nor \-\-geometry is provided, then the screen
|
|
size is set to 1440x900.
|
|
.TP
|
|
.B \-t \f[I]STRING\f[R], \-\-title \f[I]STRING\f[R]
|
|
Use STRING as title of Medley window.
|
|
Ignored when when the \-\-vnc flag is set or when running on Windows
|
|
(Docker) installations.
|
|
.TP
|
|
.B \-d \f[I]:N\f[R], \-\-display \f[I]:N\f[R]\ \ \ \ ** \f[B]Not applicable to Windows (Docker) installations\f[R] **
|
|
Use X display :N.
|
|
Defaults to the value of $DISPLAY.
|
|
This flag is ignored when the \-\-vnc flag is set as well as on Windows
|
|
(Docker) installations.
|
|
.TP
|
|
.B \-v, \-\-vnc\ \ \ \ ** \f[B]Applicable only to WSL installations\f[R] **
|
|
Use a VNC window running on the Windows side instead of an X window.
|
|
The VNC window will folllow the Windows desktop scaling setting allowing
|
|
for much more usable Medley on high resolution displays.
|
|
On WSL, X windows do not scale well.
|
|
This flag is always set for WSL1 installations.
|
|
.TP
|
|
.B \-i [\f[I]ID_STRING\f[R] | \- | \-\-], \-\-id [\f[I]ID_STRING\f[R] | \- | \-\-]
|
|
Use ID_STRING as the id for this run of Medley, iunless ID_STRING is
|
|
\[lq]\-\[rq] or \[lq]\-\-\[rq].
|
|
If ID_STRING is \[lq]\-\[rq], then use the basename of $MEDLEYDIR as the
|
|
id.
|
|
If ID_STRING is \[lq]\-\-\[rq], then use the basename of the parent
|
|
directory of $MEDLEYDIR as the id.
|
|
Only one instance of Medley with a given id can run at a time.
|
|
The id is used to distinguish the virtual memory stores so that multiple
|
|
instances of Medley can run simultaneously.
|
|
Default id is \[lq]default\[rq].
|
|
.TP
|
|
.B \-m \f[I]N\f[R], \-\-mem \f[I]N\f[R]
|
|
Set Medley to run in \f[I]N\f[R] MB of virtual memory.
|
|
Defaults to 256MB.
|
|
.TP
|
|
.B \-p \f[I]FILE\f[R], \-\-vmem \f[I]FILE\f[R]
|
|
Use FILE as the Medley virtual memory (vmem) store.
|
|
FILE must be writeable by the current user.
|
|
Care must be taken not to use the same vmem FILE for two instances of
|
|
Medley running simultaneously.
|
|
The \-\-id flag will not protect against vmem collisions when the
|
|
\-\-vmem flag is used.
|
|
Default is to store the vmem in LOGINDIR/vmem/lisp_XXX.virtualmem, where
|
|
XXX is the id of this Medley run (see \-\-id flag above).
|
|
See \-\-logindir below for setting of LOGINDIR.
|
|
On Windows (Docker) installations, \f[I]FILE\f[R] is specified in the
|
|
Medley file system, not the host Windows file system.
|
|
.TP
|
|
.B \-r [\f[I]FILE\f[R] | \-], \-\-greet [\f[I]FILE\f[R] | \-]
|
|
Use FILE as the Medley greetfile, unless FILE is \[lq]\-\[rq] in which
|
|
case Medley will start up without using a greetfile.
|
|
The default Medley greetfile is $MEDLEYDIR/greetfiles/MEDLEYDIR\-INIT,
|
|
except when the \-\-apps flag is used in which case it is
|
|
$MEDLEYDIR/greetfiles/APPS\-INIT.
|
|
On Windows (Docker) installations, \f[I]FILE\f[R] is specified in the
|
|
Medley file system, not the host Windows file system.
|
|
.TP
|
|
.B \-x [\f[I]DIR\f[R] | \-], \-\-logindir [\f[I]DIR\f[R] | \-]\ \ \ \ ** \f[B]On Linux and WSL installations\f[R] **
|
|
Use DIR as LOGINDIR in Medley, unless DIR is \[lq]\-\[rq], in which case
|
|
use $MEDLEYDIR/logindir.
|
|
DIR (or $MEDLEYDIR/logindir) must be writeable by the current user.
|
|
LOGINDIR defaults to $HOME/il.
|
|
LOGINDIR is used by Medley as the working directory on start\-up and
|
|
where it loads any \[lq]personal\[rq] initialization file from.
|
|
.TP
|
|
.B \-x [\f[I]DIR\f[R] | \-], \-\-logindir [\f[I]DIR\f[R] | \-]\ \ \ \ ** \f[B]On Windows (Docker) installations\f[R] **
|
|
Map DIR in the Windows host file system to /home/medley/il in the Medley
|
|
file system (in the Docker container).
|
|
LOGINDIR is always /home/medley/il from Medley\[cq]s standpoint.
|
|
The \[lq]\-\[rq] value is not valid in this case.
|
|
.TP
|
|
.B \-u, \-\-update\ \ \ \ ** \f[B]Windows (Docker) installations only\f[R] **
|
|
Before running Medley, do a pull to retrieve the latest interlisp/medley
|
|
docker image from Docker Hub.
|
|
.TP
|
|
.B \-b, \-\-background\ \ \ \ ** \f[B]Windows (Docker) installations only\f[R] **
|
|
Run Medley in background rather than foreground.
|
|
.TP
|
|
.B \-p \f[I]PORT\f[R], \-\-port \f[I]PORT\f[R]\ \ \ \ ** \f[B]Windows (Docker) installations only\f[R] **
|
|
Use \f[I]PORT\f[R] as the port that VNC viewer uses to contact the VNC
|
|
server within the Docker container.
|
|
Default is 5900.
|
|
.TP
|
|
.B \-w [\f[I]DISTRO\f[R] | \-], \-\-wsl [\f[I]DISTRO\f[R] | \-]\ \ \ \ ** \f[B]Windows (Docker) installations only\f[R] **
|
|
Run Medley in the context of the named WSL \f[I]DISTRO\f[R] instead of
|
|
within Docker.
|
|
If \f[I]DISTRO\f[R] is \[lq]\-\[rq], used the default WSL distro.
|
|
Equivalent to typing \[lq]wsl \-d \f[I]DISTRO\f[R] medley \&...\[rq]
|
|
into a Command or Powershell window.
|
|
.SS Other Options
|
|
.PP
|
|
\
|
|
.TP
|
|
.B \f[I]SYSOUT_FILE\f[R]
|
|
The pathname of the file to use as a sysout for Medley to start from.
|
|
If SYSOUT_FILE is not provided and none of the flags (\-\-apps,
|
|
\-\-full, \-\-lisp) is used, then Medley will start from the saved
|
|
virtual memory file from the previous session with the same ID_STRING as
|
|
this run.
|
|
If no such virtual memory file exists, then Medley will start from the
|
|
standard full.sysout (equivalent to specifying the \-\-full flag).
|
|
On Windows (Docker) installations, \f[I]SYSOUT_FILE\f[R] is specified in
|
|
the Medley file system, not the host Windows file system.
|
|
.TP
|
|
.B \f[I]PASS_ON_ARGS\f[R]
|
|
All arguments after the \[lq]\-\-\[rq] flag, are passed unaltered to lde
|
|
via run\-medley.
|
|
.SH FILES
|
|
.TP
|
|
.B $HOME/il
|
|
Default Medley LOGINDIR
|
|
.TP
|
|
.B $HOME/il/vmem/lisp.virtualmem
|
|
Default virtual memory file
|
|
.TP
|
|
.B $HOME/il/INIT(.LCOM)
|
|
Default personal init file
|
|
.TP
|
|
.B $MEDLEYDIR/greetfiles/MEDLEYDIR\-INIT(.LCOM)
|
|
Default Medley greetfile
|
|
.SH BUGS
|
|
.PP
|
|
See GitHub Issues: <https://github.com/Interlisp/medley/issues>
|
|
.SH COPYRIGHT
|
|
.PP
|
|
Copyright(c) 2023 by Interlisp.org
|