From 534b27e18f806993d18197bc0cfbdfa610a8b9cc Mon Sep 17 00:00:00 2001
From: akruphi <92621645+akruphi@users.noreply.github.com>
Date: Sun, 28 Jul 2024 10:01:43 +0300
Subject: [PATCH 1/4] Readme & help minor
---
README.md | 12 ++++++++++--
far2l/bootstrap/scripts/FarEng.hlf.m4 | 6 +++---
far2l/bootstrap/scripts/FarRus.hlf.m4 | 4 ++--
3 files changed, 15 insertions(+), 7 deletions(-)
diff --git a/README.md b/README.md
index b61f3ef70..17dc95a59 100644
--- a/README.md
+++ b/README.md
@@ -41,12 +41,20 @@ emulators](#terminals), which provide clipboard access and has their advanced ke
| ---: | --- | --- | --- | --- |
| **Works:** | in terminal | in terminal | in terminal | in Desktop
environment
(X11
or Wayland
or macOS) |
| **Binaries:** | far2l | far2l
far2l_ttyx.broker | far2l
far2l_ttyx.broker | far2l
far2l_gui.so |
-| **Dependencies:** | minimal | + libx11 | + libx11, libxi | wxWidgets, GTK |
+| **Dependencies:** | minimal | + libx11 | + libx11, libxi | + wxWidgets, GTK |
| **Keyboard:** | _Typical terminals_:
**only essential
key combinations**
_KiTTY_ (putty fork),
_kitty_ (*nix one),
_iTerm2_,
_Windows Terminal_,
far2l’s VT: **full support** | _Typical terminals_:
**only essential
key combinations**
_KiTTY_ (putty fork),
_kitty_ (*nix one),
_iTerm2_,
_Windows Terminal_,
far2l’s VT: **full support** | _Typical terminals_:
**most of key
combinations under x11**;
**only essential key
combinations
under Wayland**
_KiTTY_ (putty fork),
_kitty_ (*nix one),
_iTerm2_,
_Windows Terminal_,
far2l’s VT: **full support** | **All key
combinations** |
| **Clipboard
access:** | _Typical terminals_:
via command line
tools like xclip
_kitty_ (*nix one),
_iTerm2_:
via **OSC52**
_Windows Terminal_:
via **OSC52**
or via **command line
tools under WSL**
_KiTTY_ (putty fork),
far2l’s VT:
via **far2l extensions** | _Typical terminals_,
_kitty_ (*nix one):
via **x11 interaction**
_iTerm2_:
via **OSC52**
_Windows Terminal_:
via **OSC52**
or via **command line
tools under WSL**
_KiTTY_ (putty fork),
far2l’s VT:
via **far2l extensions** | _Typical terminals_,
_kitty_ (*nix one):
via **x11 interaction**
_iTerm2_:
via **OSC52**
_Windows Terminal_:
via **OSC52**
or via **command line
tools under WSL**
_KiTTY_ (putty fork),
far2l’s VT:
via **far2l extensions** | via
**wxWidgets API**
via command line
tools under WSL |
-| **Typical
use case:** | **Servers**,
embedded | Run far2l in
favorite terminal
but with
**better UX** | Run far2l in
favorite terminal
but with
**even better UX** | **Desktop** |
+| **Typical
use case:** | **Servers**,
embedded | Run far2l in
favorite terminal
but with
**better UX** | Run far2l in
favorite terminal
but with
**even better UX** | **Desktop** |
| **Mandatory:** | yes | no | no | no |
+_Note about use OSC 52 in TTY/TTY|X_:
+to interact with the system clipboard you must **not forget to enable OSC 52**
+in both the **FAR2L settings** (Options->Interface settings->Use OSC52 to set clipboard data,
+which shown in the dialog only if far2l run in TTY/TTY|X mode and all other options for clipboard access are unavailable;
+you can run `far2l --tty --nodetect` to force not use others clipboard options),
+and in **terminal settings** option OSC 52 must be allowed (by default, OSC 52 is disabled in some terminals for security reasons;
+OSC 52 in many terminals is implemented only for the copy mode, and paste from the terminal goes by bracketed paste mode).
+
## Installing, Running
#### Debian/Ubuntu 23.10+ binaries (with TTY X/Xi backends only)
diff --git a/far2l/bootstrap/scripts/FarEng.hlf.m4 b/far2l/bootstrap/scripts/FarEng.hlf.m4
index 2c99659c9..0b52825e7 100644
--- a/far2l/bootstrap/scripts/FarEng.hlf.m4
+++ b/far2l/bootstrap/scripts/FarEng.hlf.m4
@@ -181,15 +181,15 @@ when it starts, far2l switches to #TTY|X# without i.
#Special options for configuring FAR2L running in terminal emulators#
- Menu(#F9#)->Options->Interface settings->#Use OSC52 to set clipboard data#
-(shown in the menu only if FAR2L run in TTY/TTY|X mode and all other options for clipboard access are unavailable).
+(shown in the dialog only if FAR2L run in TTY/TTY|X mode and all other options for clipboard access are unavailable).
You can run #far2l --tty --nodetect# to force not use others clipboard options.
- Menu(#F9#)->Options->Interface settings->#Override base colors palette#
-(shown in the menu only if FAR2L run in TTY/TTY|X mode) allows far2l to adjust terminal palette colors.
+(shown in the dialog only if FAR2L run in TTY/TTY|X mode) allows far2l to adjust terminal palette colors.
If your terminal doesn't support OSC4 sequence you may turn it off to avoid show artifacts sequence in terminal after exit from far2l.
#Full-functional work with the system clipboard in a plain terminal version FAR2L TTY#
- To interact with the system clipboard, you must not forget to enable #OSC 52# in both the #FAR2L settings#
+ To interact with the system clipboard you must not forget to enable #OSC 52# in both the #FAR2L settings#
(see details above),
and in #terminal settings# option #OSC 52 must be allowed#
(by default, OSC 52 is disabled in some terminals for security reasons; OSC 52 in many terminals is implemented only for the copy mode, and paste from the terminal goes by bracketed paste mode).
diff --git a/far2l/bootstrap/scripts/FarRus.hlf.m4 b/far2l/bootstrap/scripts/FarRus.hlf.m4
index c04144a3f..faeca9398 100644
--- a/far2l/bootstrap/scripts/FarRus.hlf.m4
+++ b/far2l/bootstrap/scripts/FarRus.hlf.m4
@@ -184,10 +184,10 @@ $ # Особенности FAR2L - начало работы#
#Специальные возможности конфигурирования FAR2L, запущенного в эмуляторах терминалов#
- Меню(#F9#)->Параметры->Настройки интерфейса->#Исп. OSC52 для записи в буфер обмена#
-(видна в меню только если FAR2L запущен в режиме TTY/TTY|X и все остальные варианты поддержки клипборда недоступны).
+(виден в диалоге только если FAR2L запущен в режиме TTY/TTY|X и все остальные варианты поддержки клипборда недоступны).
Вы можете запустить #far2l --tty --nodetect# для принудительного не использования других вариантов взаимодействия с буфером обмена.
- Меню(#F9#)->Параметры->Настройки интерфейса->#Исп. свою палитру базовых цветов#
-(видна в в меню только если FAR2L запущен в режиме TTY/TTY|X) позволяет far2l настраивать цвета палитры терминала.
+(виден в диалоге только если FAR2L запущен в режиме TTY/TTY|X) позволяет far2l настраивать цвета палитры терминала.
Если Ваш терминал не поддерживает последовательности OSC4 выключение данной опции позволяет избежать появления в терминале артефактов после выхода из far2l.
From 1e03bb5b99a0a53f9f5e5fad65fa7708324470b3 Mon Sep 17 00:00:00 2001
From: akruphi <92621645+akruphi@users.noreply.github.com>
Date: Sun, 28 Jul 2024 10:34:58 +0300
Subject: [PATCH 2/4] readme minor
---
README.md | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/README.md b/README.md
index 17dc95a59..8f80a4c3e 100644
--- a/README.md
+++ b/README.md
@@ -306,6 +306,10 @@ Supporting extended far2l keyboard shortcuts and clipboard access
* **cyd01's KiTTY** (Windows ssh-client): https://github.com/cyd01/KiTTY & https://www.9bis.net/kitty (TTY|F backend: keys and clipboard by FAR2L TTY extensions support)
* **putty-nd** (Windows ssh-client): https://sourceforge.net/projects/putty-nd & https://github.com/noodle1983/putty-nd (TTY|F backend: keys and clipboard by FAR2L TTY extensions support)
+_Note_: to full transfer extended keyboard shortcuts and the clipboard to the **remote far2l**
+one of the best way to initiate the connection **inside local far2l-GUI**
+(see details in build-in help section **UI backends**).
+
### Useful 3rd-party extras
* A collection of macros for far2l: https://github.com/corporateshark/far2l-macros
From 7aced497059feb5abd8bd6eeaee5e5caea6009a7 Mon Sep 17 00:00:00 2001
From: akruphi <92621645+akruphi@users.noreply.github.com>
Date: Sun, 28 Jul 2024 10:36:27 +0300
Subject: [PATCH 3/4] readme cosmetic
---
README.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index 8f80a4c3e..daafe6c61 100644
--- a/README.md
+++ b/README.md
@@ -306,9 +306,9 @@ Supporting extended far2l keyboard shortcuts and clipboard access
* **cyd01's KiTTY** (Windows ssh-client): https://github.com/cyd01/KiTTY & https://www.9bis.net/kitty (TTY|F backend: keys and clipboard by FAR2L TTY extensions support)
* **putty-nd** (Windows ssh-client): https://sourceforge.net/projects/putty-nd & https://github.com/noodle1983/putty-nd (TTY|F backend: keys and clipboard by FAR2L TTY extensions support)
-_Note_: to full transfer extended keyboard shortcuts and the clipboard to the **remote far2l**
+_Note_: to full transfer extended keyboard shortcuts and the clipboard to the **remote far2l**
one of the best way to initiate the connection **inside local far2l-GUI**
-(see details in build-in help section **UI backends**).
+(see details in build-in help section **UI backends**).
### Useful 3rd-party extras
From 34312598c76b753c807c16088e164a5a49309f84 Mon Sep 17 00:00:00 2001
From: akruphi <92621645+akruphi@users.noreply.github.com>
Date: Sun, 28 Jul 2024 15:09:28 +0300
Subject: [PATCH 4/4] readme cosmetic
---
README.md | 42 +++++++++++++++++++++---------------------
1 file changed, 21 insertions(+), 21 deletions(-)
diff --git a/README.md b/README.md
index daafe6c61..39bbc2767 100644
--- a/README.md
+++ b/README.md
@@ -41,15 +41,15 @@ emulators](#terminals), which provide clipboard access and has their advanced ke
| ---: | --- | --- | --- | --- |
| **Works:** | in terminal | in terminal | in terminal | in Desktop
environment
(X11
or Wayland
or macOS) |
| **Binaries:** | far2l | far2l
far2l_ttyx.broker | far2l
far2l_ttyx.broker | far2l
far2l_gui.so |
-| **Dependencies:** | minimal | + libx11 | + libx11, libxi | + wxWidgets, GTK |
+| **[Dependencies](#required-dependencies):** | minimal | + libx11 | + libx11, libxi | + wxWidgets, GTK |
| **Keyboard:** | _Typical terminals_:
**only essential
key combinations**
_KiTTY_ (putty fork),
_kitty_ (*nix one),
_iTerm2_,
_Windows Terminal_,
far2l’s VT: **full support** | _Typical terminals_:
**only essential
key combinations**
_KiTTY_ (putty fork),
_kitty_ (*nix one),
_iTerm2_,
_Windows Terminal_,
far2l’s VT: **full support** | _Typical terminals_:
**most of key
combinations under x11**;
**only essential key
combinations
under Wayland**
_KiTTY_ (putty fork),
_kitty_ (*nix one),
_iTerm2_,
_Windows Terminal_,
far2l’s VT: **full support** | **All key
combinations** |
| **Clipboard
access:** | _Typical terminals_:
via command line
tools like xclip
_kitty_ (*nix one),
_iTerm2_:
via **OSC52**
_Windows Terminal_:
via **OSC52**
or via **command line
tools under WSL**
_KiTTY_ (putty fork),
far2l’s VT:
via **far2l extensions** | _Typical terminals_,
_kitty_ (*nix one):
via **x11 interaction**
_iTerm2_:
via **OSC52**
_Windows Terminal_:
via **OSC52**
or via **command line
tools under WSL**
_KiTTY_ (putty fork),
far2l’s VT:
via **far2l extensions** | _Typical terminals_,
_kitty_ (*nix one):
via **x11 interaction**
_iTerm2_:
via **OSC52**
_Windows Terminal_:
via **OSC52**
or via **command line
tools under WSL**
_KiTTY_ (putty fork),
far2l’s VT:
via **far2l extensions** | via
**wxWidgets API**
via command line
tools under WSL |
-| **Typical
use case:** | **Servers**,
embedded | Run far2l in
favorite terminal
but with
**better UX** | Run far2l in
favorite terminal
but with
**even better UX** | **Desktop** |
+| **Typical
use case:** | **Servers**,
embedded | Run far2l in
favorite terminal
but with
**better UX** | Run far2l in
favorite terminal
but with
**best UX** | **Desktop** |
| **Mandatory:** | yes | no | no | no |
_Note about use OSC 52 in TTY/TTY|X_:
to interact with the system clipboard you must **not forget to enable OSC 52**
-in both the **FAR2L settings** (Options->Interface settings->Use OSC52 to set clipboard data,
+in both the **FAR2L settings** (`Options`->`Interface settings`->`Use OSC52 to set clipboard data`,
which shown in the dialog only if far2l run in TTY/TTY|X mode and all other options for clipboard access are unavailable;
you can run `far2l --tty --nodetect` to force not use others clipboard options),
and in **terminal settings** option OSC 52 must be allowed (by default, OSC 52 is disabled in some terminals for security reasons;
@@ -100,23 +100,23 @@ See also [Community packages & binaries](#community_bins)
## Building, Contributing, Hacking
#### Required dependencies
-* libwxgtk3.0-gtk3-dev (or libwxgtk3.2-dev in newer distributions, or libwxgtk3.0-dev in older ones, optional - needed for GUI backend, not needed with -DUSEWX=no)
-* libx11-dev (optional - needed for X11 extension that provides better UX for TTY backend wherever X11 is available)
-* libxi-dev (optional - needed for X11/Xi extension that provides best UX for TTY backend wherever X11 Xi extension is available)
-* libxerces-c-dev (optional - needed for Colorer plugin, not needed with -DCOLORER=no)
-* libuchardet-dev (optional - needed for auto charset detection, not needed with -DUSEUCD=no)
-* libssh-dev (optional - needed for NetRocks/SFTP)
-* libssl-dev (optional - needed for NetRocks/FTPS)
-* libsmbclient-dev (optional - needed for NetRocks/SMB)
-* libnfs-dev (optional - needed for NetRocks/NFS)
-* libneon27-dev (or later, optional - needed for NetRocks/WebDAV)
-* libarchive-dev (optional - needed for better archives support in multiarc)
-* libunrar-dev (optional - needed for RAR archives support in multiarc, see UNRAR command line option)
-* libpcre3-dev (or libpcre2-dev in older distributions, optional - needed for advanced custom archive formats support in multiarc)
-* cmake ( >= 3.2.2 )
-* pkg-config
-* g++
-* git (needed for downloading source code)
+* `libwxgtk3.0-gtk3-dev` (or `libwxgtk3.2-dev` in newer distributions, or `libwxgtk3.0-dev` in older ones, _optional_ - needed for **GUI backend**, not needed with `-DUSEWX=no`)
+* `libx11-dev` (_optional_ - needed for **X11 extension** that provides better UX for TTY backend wherever X11 is available)
+* `libxi-dev` (_optional_ - needed for **X11/Xi extension** that provides best UX for TTY backend wherever X11 Xi extension is available)
+* `libxerces-c-dev` (_optional_ - needed for **Colorer plugin**, not needed with `-DCOLORER=no`)
+* `libuchardet-dev` (_optional_ - needed for **auto charset detection**, not needed with `-DUSEUCD=no`)
+* `libssh-dev` (_optional_ - needed for **NetRocks/SFTP**)
+* `libssl-dev` (_optional_ - needed for **NetRocks/FTPS**)
+* `libsmbclient-dev` (_optional_ - needed for **NetRocks/SMB**)
+* `libnfs-dev` (_optional_ - needed for **NetRocks/NFS**)
+* `libneon27-dev` (or later, _optional_ - needed for **NetRocks/WebDAV**)
+* `libarchive-dev` (_optional_ - needed for better archives support in **multiarc**)
+* `libunrar-dev` (_optional_ - needed for RAR archives support in **multiarc**, see UNRAR command line option)
+* `libpcre3-dev` (or `libpcre2-dev` in older distributions, _optional_ - needed for advanced custom archive formats support in **multiarc**)
+* `cmake` ( >= 3.2.2 )
+* `pkg-config`
+* `g++`
+* `git` (needed for downloading source code)
#### Or simply on Debian/Ubuntu:
``` sh
@@ -306,7 +306,7 @@ Supporting extended far2l keyboard shortcuts and clipboard access
* **cyd01's KiTTY** (Windows ssh-client): https://github.com/cyd01/KiTTY & https://www.9bis.net/kitty (TTY|F backend: keys and clipboard by FAR2L TTY extensions support)
* **putty-nd** (Windows ssh-client): https://sourceforge.net/projects/putty-nd & https://github.com/noodle1983/putty-nd (TTY|F backend: keys and clipboard by FAR2L TTY extensions support)
-_Note_: to full transfer extended keyboard shortcuts and the clipboard to the **remote far2l**
+_Note_: to full transfer extended keyboard shortcuts and the clipboard to/from the **remote far2l**
one of the best way to initiate the connection **inside local far2l-GUI**
(see details in build-in help section **UI backends**).