Updated some docs, added readme & license to packages andOperator abb…

…rev to hkemf
bjasspa · Aug 6, 2024 · d8c6ee6 · d8c6ee6
1 parent f11a48a
commit d8c6ee6
Show file tree

Hide file tree

Showing 9 changed files with 188 additions and 97 deletions.
diff --git a/.github/workflows/build-macos.yml b/.github/workflows/build-macos.yml
@@ -26,6 +26,12 @@ jobs:
          ls /opt/homebrew/opt/openssl@3/
          echo Macos OpenSSL 2
          ls /opt/homebrew/opt/openssl@3/lib
+         echo Macos OpenSSL 3
+         ls /usr/local/opt/
+         echo Macos OpenSSL 4
+         ls /usr/local/opt/openssl@3
+         echo Macos OpenSSL 5
+         ls /usr/local/opt/openssl@3/lib
       
     - name: Checkout code
       uses: actions/checkout@v4
@@ -44,9 +50,10 @@ jobs:
       run: |
         cd ./microemacs/bin
         mv macos14-apple64-* macos14-apple64
+        rm ./.gitignore
         cd ..
         export MEVER=`./bin/macos14-apple64/mec -p @contribs/ver.emf`
-        zip -r ../downloads/Jasspa_MicroEmacs_${MEVER}_macos14_apple64_binaries bin
+        zip -r ../downloads/Jasspa_MicroEmacs_${MEVER}_macos14_apple64_binaries bin license.txt readme.txt
 
     - name: Compile macos intel mec
       run: |
@@ -62,7 +69,7 @@ jobs:
         mv macos14-intel64-* macos14-intel64
         cd ..
         export MEVER=`./bin/macos14-apple64/mec -p @contribs/ver.emf`
-        zip -r ../downloads/Jasspa_MicroEmacs_${MEVER}_macos14_intel64_binaries bin/macos14-intel64
+        zip -r ../downloads/Jasspa_MicroEmacs_${MEVER}_macos14_intel64_binaries bin/macos14-intel64 license.txt readme.txt
 
     - name: Create macos apple mecs
       run: |
@@ -71,15 +78,34 @@ jobs:
         rm -rf bin
         mkdir -p bin/macos14-apple64
         ../bin/macos14-apple64/mec -p "@mesgen" -f -p ../bin/macos14-apple64/mec -t ../bin/macos14-apple64/tfs -o bin/macos14-apple64/mecs
-        zip -r ../../downloads/Jasspa_MicroEmacs_${MEVER}_macos14_apple64_mecs bin
+        cp ../license.txt ./
+        cp ../readme.txt ./
+        zip -r ../../downloads/Jasspa_MicroEmacs_${MEVER}_macos14_apple64_mecs bin license.txt readme.txt
+
     - name: Create macos apple mews
       run: |
         export MEVER=`./microemacs/bin/macos14-apple64/mec -p @microemacs/contribs/ver.emf`
         cd ./microemacs/mesingle
         rm -rf bin
         mkdir -p bin/macos14-apple64
         ../bin/macos14-apple64/mec -p "@mesgen" -f -p ../bin/macos14-apple64/mew -t ../bin/macos14-apple64/tfs -o bin/macos14-apple64/mews
-        zip -r ../../downloads/Jasspa_MicroEmacs_${MEVER}_macos14_apple64_mews bin
+        zip -r ../../downloads/Jasspa_MicroEmacs_${MEVER}_macos14_apple64_mews bin license.txt readme.txt
+
+    - name: Create macos apple OpenSSL download
+      run: |
+        cd ./microemacs/
+        export MEVER=`./bin/macos14-apple64/mec -p @contribs/ver.emf`
+        rm -rf tfs
+        mkdir -p tfs/bin/macos14-apple64
+        cd tfs
+        cp /opt/homebrew/opt/openssl@3/lib/libcrypto.3.dylib bin/macos14-apple64
+        cp /opt/homebrew/opt/openssl@3/lib/libssl.3.dylib bin/macos14-apple64
+        cp /opt/homebrew/opt/openssl@3/LICENSE.txt bin/macos14-apple64
+        cp /opt/homebrew/opt/openssl@3/README.md bin/macos14-apple64
+        zip -r ../../downloads/Jasspa_MicroEmacs_${MEVER}_apple_openssl bin
+        cd ..
+        ./bin/macos14-apple64/tfs -o ../packages/Jasspa_MicroEmacs_${MEVER}_macos_apple64_openssl.tfs -a ./mesingle/tfs_hd tfs
+
 
     - name: Create macos intel mecs
       run: |

diff --git a/.github/workflows/build-windows.yml b/.github/workflows/build-windows.yml
@@ -59,7 +59,7 @@ jobs:
         Rename-Item -Path windows100-intel32-msvc17 -NewName windows100-intel32
         cd ..
         $env:MEVER=$(.\bin\windows100-intel32\mec -p @contribs/ver.emf)
-        Compress-Archive -Path bin -DestinationPath ..\downloads\Jasspa_MicroEmacs_${env:MEVER}_windows100_binaries
+        Compress-Archive -Path bin,license.txt,readme.txt -DestinationPath ..\downloads\Jasspa_MicroEmacs_${env:MEVER}_windows100_binaries
 
     - name: Create windows100 openssl download
       shell: pwsh
@@ -70,12 +70,35 @@ jobs:
         mkdir -Path tfs\bin\windows100-intel32
         Copy-Item -Path libssl-3.dll -Destination tfs\bin\windows100-intel32
         Copy-Item -Path libcrypto-3.dll -Destination tfs\bin\windows100-intel32
+        Copy-Item -Path ..\..\version.txt -Destination tfs\bin\windows100-intel32
+        Copy-Item -Path ..\..\LICENSE.txt -Destination tfs\bin\windows100-intel32
         cd tfs
         Compress-Archive -Path bin -DestinationPath ..\..\..\..\..\..\downloads\Jasspa_MicroEmacs_${env:MEVER}_windows100_openssl.zip
         cd ..
         ..\..\..\..\bin\windows100-intel32\tfs -o ../../../../../packages/Jasspa_MicroEmacs_${env:MEVER}_openssl_windows100_intel32.tfs -a ../../../../mesingle/tfs_hd tfs
 
-    - name: Compile windows100 static mew
+    - name: Compile windows100 static mec
+      shell: pwsh
+      run: |
+        & "${Env:COMSPEC}" /s /c "`"${Env:VSDEVCMD}`" -arch=x86 -host_arch=x64 -no_logo && set" `
+          | % { , ($_ -Split '=', 2) } `
+          | % { [System.Environment]::SetEnvironmentVariable($_[0], $_[1]) }
+        nmake -f winmsvc.mak BTYP=c LSTT=1
+      working-directory: ./microemacs/src
+
+    - name: Create windows100 mecs
+      shell: pwsh
+      run: |
+        cd .\microemacs
+        $env:MEVER=$(.\bin\windows100-intel32\mec -p @contribs/ver.emf)
+        cd .\mesingle
+        mkdir -Path bin\windows100-intel32
+        ..\bin\windows100-intel32\mec.exe -p "@mesgen" -f -p ..\bin\windows100-intel32-msvc17s\mec.exe -t ..\bin\windows100-intel32\tfs.exe -o bin\windows100-intel32\mecs.exe
+        Copy-Item -Path ..\license.txt -Destination .
+        Copy-Item -Path ..\readme.txt -Destination .
+        Compress-Archive -Path bin,license.txt,readme.txt -DestinationPath ..\..\downloads\Jasspa_MicroEmacs_${env:MEVER}_windows100_mecs
+
+    - name: Compile windows100 static mecw
       shell: pwsh
       run: |
         & "${Env:COMSPEC}" /s /c "`"${Env:VSDEVCMD}`" -arch=x86 -host_arch=x64 -no_logo && set" `
@@ -90,9 +113,9 @@ jobs:
         cd .\microemacs
         $env:MEVER=$(.\bin\windows100-intel32\mec -p @contribs/ver.emf)
         cd .\mesingle
-        mkdir -Path bin\windows100-intel32
+        Remove-Item bin\windows100-intel32\mecs.exe
         ..\bin\windows100-intel32\mec.exe -p "@mesgen" -f -p ..\bin\windows100-intel32-msvc17s\mew.exe -t ..\bin\windows100-intel32\tfs.exe -o bin\windows100-intel32\mews.exe
-        Compress-Archive -Path bin -DestinationPath ..\..\downloads\Jasspa_MicroEmacs_${env:MEVER}_windows100_mews
+        Compress-Archive -Path bin,license.txt,readme.txt -DestinationPath ..\..\downloads\Jasspa_MicroEmacs_${env:MEVER}_windows100_mews
 
     - name: Upload Packages
       uses: actions/upload-artifact@v4

diff --git a/microemacs/doc/m2cmd203.2 b/microemacs/doc/m2cmd203.2
@@ -9,27 +9,22 @@
 .TH keyNames 2
 .XI keyNames - "Key Binding Names"
 .SH "KEY BINDING NAMES"
-Every  key  which can be  generated  in \*(mE has a  character  string or name
-representation  which can be used to bind and unbind the key to a command. The
-name of simple keys like "\fCa\fR" or "\fC$\fR" is simply the character,  i.e.
+Every key which can be generated in \*(mE has a character string or name representation which can be used to bind and
+unbind the key to a command. The name of simple keys like "\fCa\fR" or "\fC$\fR" is simply the character, i.e.
 "\fCa\fR" and "\fC$\fR". Following is a list of other parts to a key name.
 .SS "Modify Keys"
-There are 3 modifying  keys, Shift, Control and Alt, these are  represented as
-"\fCS-\fR",   "\fCC-\fR",   "\fCA-\fR"   respectively.  For  example  the  key
-"\fCA-C-S-up\fR"  is  generated  when the up cursor key is pressed when Shift,
-Control and Alt keys where also pressed.
+There are 3 modifying keys, Shift, Control and Alt, these are represented as "\fCS-\fR", "\fCC-\fR", "\fCA-\fR"
+respectively. For example the key "\fCA-C-S-up\fR" is generated when the up cursor key is pressed when Shift, Control
+and Alt keys where also pressed.
 .PP
-The Control and Alt  modifiers are case  insensitive so \fCC-a\fR is the same as
-\fCC-A\fR and \fCC-S-a\fR.
+The Control and Alt modifiers are case insensitive so \fCC-a\fR is the same as \fCC-A\fR and \fCC-S-a\fR.
 .SS "Prefix Keys"
-Many  binding  are  single   stroke  key   sequences   (e.g.   "\fCC-a\fR"  =>
-beginning-of-line). However \*(mE has a
+Many binding are single stroke key sequences (e.g. "\fCC-a\fR" => beginning-of-line). However \*(mE has a
 .Ht prefix 2
-command  which can be used to bind up to 8 single  stroke keys,  turning  them
-into two stroke keys; this greatly increasing the number of available bindable
-key  sequences.  For example  \fBprefix 1\fR is bound to the escape  character
-(\fC\*(eS\fR),  this  allows  key  sequences  like  "\fCesc  a\fR" to be used.
-Following is a list of prefixes and their default bindings
+command which can be used to bind up to 8 single stroke keys, turning them into two stroke keys; this greatly
+increasing the number of available bindable key sequences. For example \fBprefix 1\fR is bound to the escape character
+(\fC\*(eS\fR), this allows key sequences like "\fCesc a\fR" to be used. Following is a list of prefixes and their
+default bindings
 .RS
 .sp
 .Hl "prefix 1" prefix 2
@@ -45,22 +40,18 @@ Following is a list of prefixes and their default bindings
 => \fC\*cc\fP
 .RE
 .SS "Special Keys"
-Following  is a complete  list of  recognized  keyboard key names, not all are
-able to be generated on every platform:-
+Following is a complete list of recognized keyboard key names, not all are able to be generated on every platform:-
 .na
 .RS
 .PP
-\fCbackspace\fR,  \fCdelete\fR,  \fCdown\fR,  \fCend\fR,  \fCesc\fR, \fCf1\fR,
-\fCf2\fR,   \fCf3\fR,   \fCf4\fR,   \fCf5\fR,  \fCf6\fR,  \fCf7\fR,  \fCf8\fR,
-\fCf9\fR, \fCf10\fR,  \fCf11\fR,  \fCf12\fR,  \fCf13\fR, \fCf14\fR, \fCf15\fR,
-\fCf16\fR,    \fCf17\fR,   \fCf18\fR,   \fCf19\fR,   \fCf20\fR,    \fChome\fR,
-\fCinsert\fR,  \fCkp-0\fR,  \fCkp-1\fR,  \fCkp-2\fR,  \fCkp-3\fR,  \fCkp-4\fR,
-\fCkp-5\fR,  \fCkp-6\fR,  \fCkp-7\fR,  \fCkp-8\fR,  \fCkp-9\fR,  \fCkp-add\fR,
-\fCkp-begin\fR,     \fCkp-decimal\fR,     \fCkp-delete\fR,    \fCkp-divide\fR,
-\fCkp-down\fR, \fCkp-end\fR, \fCkp-enter\fR,  \fCkp-home\fR,  \fCkp-insert\fR,
-\fCkp-left\fR,   \fCkp-multiply\fR,    \fCkp-page-down\fR,   \fCkp-page-up\fR,
-\fCkp-right\fR,  \fCkp-subtract\fR,  \fCkp-up\fR, \fCleft\fR, \fCpage-down\fR,
-\fCpage-up\fR, \fCreturn\fR, \fCright\fR, \fCspace\fR, \fCtab\fR, \fCup\fR
+\fCbackspace\fR, \fCdelete\fR, \fCdown\fR, \fCend\fR, \fCesc\fR, \fCf1\fR, \fCf2\fR, \fCf3\fR, \fCf4\fR, \fCf5\fR,
+\fCf6\fR, \fCf7\fR, \fCf8\fR, \fCf9\fR, \fCf10\fR, \fCf11\fR, \fCf12\fR, \fCf13\fR, \fCf14\fR, \fCf15\fR, \fCf16\fR,
+\fCf17\fR, \fCf18\fR, \fCf19\fR, \fCf20\fR, \fChome\fR, \fCinsert\fR, \fCkp-0\fR, \fCkp-1\fR, \fCkp-2\fR, \fCkp-3\fR,
+\fCkp-4\fR, \fCkp-5\fR, \fCkp-6\fR, \fCkp-7\fR, \fCkp-8\fR, \fCkp-9\fR, \fCkp-add\fR, \fCkp-begin\fR,
+\fCkp-decimal\fR, \fCkp-delete\fR, \fCkp-divide\fR, \fCkp-down\fR, \fCkp-end\fR, \fCkp-enter\fR, \fCkp-home\fR,
+\fCkp-insert\fR, \fCkp-left\fR, \fCkp-multiply\fR, \fCkp-page-down\fR, \fCkp-page-up\fR, \fCkp-right\fR,
+\fCkp-subtract\fR, \fCkp-up\fR, \fCleft\fR, \fCpage-down\fR, \fCpage-up\fR, \fCreturn\fR, \fCright\fR, \fCspace\fR,
+\fCtab\fR, \fCup\fR
 .RE
 .PP
 .ad
@@ -69,84 +60,82 @@ The name of any key can be obtained by using
 .SS "Mouse Keys"
 Following is a list of mouse related keys:-
 .IP "\fBmouse-pick-1\fR, \fBmouse-pick-2\fR, \fBmouse-pick-3\fR, \fBmouse-pick-4\fR, \fBmouse-pick-5\fR"
-These  keys are  generated  when the user  presses a mouse  button,  these key
-events are always  created. On most systems button 1 is the left, 2 the middle
-and 3 the right mouse  button. If the system only has a 2 button  mouse then a
-\fCmouse-pick-2\fR  cannot  be  generated.  The  order of the  buttons  can be
-revered (i.e. 1 becomes right) and the number of buttons can be set using the
+These keys are generated when the user presses a mouse button, these key events are always created. On most systems
+button 1 is the left, 2 the middle and 3 the right mouse button. If the system only has a 2 button mouse then a
+\fCmouse-pick-2\fR cannot be generated. The order of the buttons can be revered (i.e. 1 becomes right) and the number
+of buttons can be set using the
 .Ht $system 5 
-variable.  Note that  X-servers  support up to 5 buttons  and with the growing
-popularity  of pilot  'wheel'  mice, the 4th and 5th  button are often used to
-report wheel spin up and down events. The
+variable. Note that X-servers support up to 5 buttons and with the growing popularity of pilot 'wheel' mice, the 4th
+and 5th button are often used to report wheel spin up and down events. The
 .Ht translate-key 2
 command can be used to translate these buttons to the mouse wheel keys.
 .IP "\fBmouse-drop-1\fR, \fBmouse-drop-2\fR, \fBmouse-drop-3\fR, \fBmouse-drop-4\fR, \fBmouse-drop-5\fR"
-These  keys are  generated  when the user  release a mouse  button,  these key
-events are always created.
+These keys are generated when the user release a mouse button, these key events are always created.
 .IP "\fBmouse-move-1\fR, \fBmouse-move-2\fR, \fBmouse-move-3\fR, \fBmouse-move-4\fR, \fBmouse-move-5\fR, \fBmouse-move\fR"
-These key events are  generated  when the user moves the mouse and are only if
-they are bound to a command. The key generated  depends on whether a button is
-being  held  down  by the  user,  if the  user  is  pressing  button  1 then a
+These key events are generated when the user moves the mouse and are only if they are bound to a command. The key
+generated depends on whether a button is being held down by the user, if the user is pressing button 1 then a
 \fCmouse-move-1\fR key is created etc.
 .IP "\fBmouse-time-1\fR, \fBmouse-time-2\fR, \fBmouse-time-3\fR, \fBmouse-time-5\fR, \fBmouse-time-5\fR, \fBmouse-time\fR"
-These key events are generated only when they are bound to a command. They are
-pseudo keys created when the user hold the mouse  buttons done for a period of
-time, see \fBPseudo Keys\fR below for more information.
+These key events are generated only when they are bound to a command. They are pseudo keys created when the user hold
+the mouse buttons done for a period of time, see \fBPseudo Keys\fR below for more information.
 .IP "\fBmouse-wheel-up\fR, \fBmouse-wheel-down\fR"
-Pilot  mouse  wheel  events,  generated  when  the  wheel  is  spun up or down
-respectively.
+Pilot mouse wheel events, generated when the wheel is spun up or down respectively.
 .SS "Modifier Keys"
-The Shift, Control and Alt modifier keys will also generate key input whenever
-pressed or released. The keys are however only  generated if they are bound to
-a command. The key names are as follows:
+The Shift, Control and Alt modifier keys will also generate key input whenever pressed or released. The keys are
+however only generated if they are bound to a command. The key names are as follows:
 .IP "\fBS-pick\fR, \fBS-drop\fR"
 Shift modifier.
 .IP "\fBC-pick\fR, \fBC-drop\fR"
 Control modifier.
 .IP "\fBA-pick\fR, \fBA-drop\fR"
 Alt modifier.
 .PP
-Note that the keys are only generated when another key is pressed, i.e. if the
-user  presses  and holds  only the shift  key, no  "\fCS-pick\fR"  key will be
-generated until another key, such as \fCdown\fR, is also pressed. If the shift
-key is released before another key is pressed the event will not be reported.
+Note that the keys are only generated when another key is pressed, i.e. if the user presses and holds only the shift
+key, no "\fCS-pick\fR" key will be generated until another key, such as \fCdown\fR, is also pressed. If the shift key
+is released before another key is pressed the event will not be reported.
 .SS "Pseudo Keys"
-Pseudo  keys events  cannot be directly  created by the user, they are created
-internally  by \*(mS. They are  treated  like normal keys to allow the user to
-handle the events  properly  themselves.  Following is a complete  list of the
-system generated pseudo keys:- 
+Pseudo keys events cannot be directly created by the user, they are created internally by \*(mS. They are treated like
+normal keys to allow the user to handle the events properly themselves. Following is a complete list of the system
+generated pseudo keys:- 
 .IP \fBbell\fR
 The pseudo key is generated when the bell is rung.
 .IP \fBcallback\fR
 The pseudo key when a
 .Ht create-callback 2
-macro is executed, this allows the executed  macro to know it was executed via
-a create-callback as
+macro is executed, this allows the executed macro to know it was executed via a create-callback as
 .Ht @cck 4
 will be set to this. 
+.IP \fBfind-file\fR
+The command bound to this pseudo key is execute whenever \*(mS cannot locate a required file, such as the main help 
+file \fCme.ehf\fR or an
+.Hr OpenSSL 1
+dynamic libraries. The command can get the name of the missing file from the
+.Ht $result 5
+variable and either
+.Ht !abort 4
+if the file cannot be located or return the full path to the file in \fB$result\fR. Care must be taken to avoid a 
+loop, for instance if to attempt to locate a file the macro triggers an similar request to locate the same file \*(mS 
+will spin. 
 .IP "\fBidle-pick\fR, \fBidle-drop\fR, \fBidle-time\fR"
-The commands  bound to these keys are  executed  when the system  becomes idle
-for a period of time. See help on
+The commands bound to these keys are executed when the system becomes idle for a period of time. See help on
 .Ht $idle-time 5
 for more information.
 .IP "\fBmouse-time-1\fR, \fBmouse-time-2\fR, \fBmouse-time-3\fR, \fBmouse-time-4\fR, \fBmouse-time-5\fR, \fBmouse-time\fR"
-The command  bound to these keys are executed  when mouse button 1, 2, 3, 4, 5
-or a combination are held bound for a period of time. See help on
+The command bound to these keys are executed when mouse button 1, 2, 3, 4, 5 or a combination are held bound for a
+period of time. See help on
 .Ht $delay-time 5
 for more information.
 .br
 .IP \fBredraw\fR
-The command  bound to this pseudo key is executed  whenever  the screen needs
-redrawing, by default it is bound to
+The command bound to this pseudo key is executed whenever the screen needs redrawing, by default it is bound to
 .Ht screen-update 2 .
-If the user unbinds this key then  \fBscreen-update\fR is still called, but if
-the user binds it to a function which does not redraw the screen, such as
+If the user unbinds this key then \fBscreen-update\fR is still called, but if the user binds it to a function which
+does not redraw the screen, such as
 .Ht void 2 ,
 then the screen will not be up-dated.
 .PP
-The  command  executed  is  always  given an  argument,  a  non-zero  argument
-indicates a forced complete redraw, an argument of zero indicates that just an
-up-date is required.
+The command executed is always given an argument, a non-zero argument indicates a forced complete redraw, an argument
+of zero indicates that just an up-date is required.
 .SS "Alt Key"
 The
 .B "Alt Key"