Skip to content

Commit 9305f1d

Browse files
unxedunxed
authored
Merge pull request #66 from akruphi/readme_help
readme & help + arrange keys in menu
2 parents f80ddf8 + d2a88b6 commit 9305f1d

File tree

4 files changed

+83
-67
lines changed

4 files changed

+83
-67
lines changed

‎README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -341,9 +341,13 @@ You can import the project into your favourite IDE like QtCreator, CodeLite, or
341341
## Terminals and SSH clients
342342
Supporting extended far2l keyboard shortcuts and clipboard access
343343
344-
* **kovidgoyal's kitty** (Linux, macOS, \*BSD): https://github.com/kovidgoyal/kitty & https://sw.kovidgoyal.net/kitty (TTY|k backend: keys by kovidgoyal's kitty keyboard protocol; turn on OSC 52 in far2l and kitty for clipboard support)
345-
* **Wez's Terminal Emulator** (Linux, FreeBSD, Windows): https://github.com/wez/wezterm & https://wezfurlong.org/wezterm (TTY|k backend: keys in Linux, FreeBSD by kovidgoyal's kitty keyboard protocol; TTY|w backend: keys in Windows by win32-input-mode, enabled by default; turn on OSC 52 for clipboard support) [kitty keyboard protocol not supported in macOS & Windows]
344+
* **kovidgoyal's kitty** (Linux/BSD, macOS): https://github.com/kovidgoyal/kitty & https://sw.kovidgoyal.net/kitty (TTY|k backend: keys by kovidgoyal's kitty keyboard protocol; turn on OSC 52 in far2l and kitty for clipboard support)
345+
* **Alacritty** (Linux/BSD, macOS, Windows): https://github.com/alacritty/alacritty & https://alacritty.org/ (TTY|k backend: keys by kovidgoyal's kitty keyboard protocol; turn on OSC 52 in far2l for clipboard support) [in Windows in system must be conpty.dll: https://github.com/alacritty/alacritty/issues/8360]
346+
* **Rio Terminal** (Linux/BSD, macOS, Windows): https://github.com/raphamorim/rio & https://raphamorim.io/rio/ (TTY|k backend: keys by kovidgoyal's kitty keyboard protocol; turn on OSC 52 in far2l for clipboard support)
347+
* **Ghostty** (Linux, macOS): https://github.com/ghostty-org/ghostty & https://ghostty.org/ (TTY|k backend: keys by kovidgoyal's kitty keyboard protocol; turn on OSC 52 in far2l for clipboard support)
348+
* **Wez's Terminal Emulator** (Linux/BSD, Windows): https://github.com/wez/wezterm & https://wezfurlong.org/wezterm (TTY|k backend: keys in Linux/BSD by kovidgoyal's kitty keyboard protocol; TTY|w backend: keys in Windows by win32-input-mode, enabled by default; turn on OSC 52 for clipboard support) [kitty keyboard protocol not supported in macOS & Windows]
346349
* **iTerm2** (macOS): https://gitlab.com/gnachman/iterm2 & https://iterm2.com (TTY|a backend: keys by iTerm2 "raw keyboard" protocol; turn on OSC 52 for clipboard support)
350+
* **foot** (Linux Wayland only): https://codeberg.org/dnkl/foot (TTY|k backend: keys by kovidgoyal's kitty keyboard protocol; turn on OSC 52 in far2l for clipboard support)
347351
* **Windows Terminal** (TTY|w backend: keys by win32-input-mode; turn on OSC 52 for clipboard support; has mouse bug: https://github.com/microsoft/terminal/issues/15083 )
348352
349353
* _Original Putty_ does _not correctly send some keyboard shortcuts_. Please use putty forks with _special far2l TTY extensions support (fluent keypresses, clipboard sharing etc)_:
@@ -368,6 +372,7 @@ one of the best way to initiate the connection **inside local far2l-GUI**
368372
+ **netcfg** (far2l net interfaces configuration plugin): https://github.com/VPROFi/netcfgplugin
369373
+ **sqlplugin** (far2l sql db (sqlite, etc..) plugin): https://github.com/VPROFi/sqlplugin
370374
+ **processplugin** (far2l processes plugin): https://github.com/VPROFi/processes
375+
+ **far-gvfs (gvfspanel)** (far2l plugin to work with Gnome VFS): https://github.com/cycleg/far-gvfs
371376
372377
* **far2m** is fork with FAR3 macro system (Lua) and extended plugins: https://github.com/shmuz/far2m
373378

‎far2l/bootstrap/scripts/FarEng.hlf.m4

Lines changed: 23 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ $ # FAR2L features - Getting Started#
131131
(currently in Russian only).
132132

133133
#UI Backends#
134-
FAR2L has 3 base UI Backends (see details in ~UI backends~@UIBackends@):
134+
FAR2L has base UI Backends (see details in ~UI backends~@UIBackends@):
135135
- #GUI#: uses wxWidgets, works in graphics mode, #ideal UX#
136136
(might add dependencies to your desktop environment, e.g. wxWidgets toolkit and related packages);
137137
- #TTY|Xi#: works in terminal mode, requires a dependency on pair X11 libraries
@@ -169,7 +169,7 @@ when it starts, far2l switches to #TTY|X# without i.
169169

170170

171171
#Pasting feature in terminals#
172-
The keyboard shortcut of the #terminal pasting# (terminal simulates keyboard input) and #FAR2L pasting# (FAR2L itself does paste) are different. Note that pasting keyboard shortcut in different terminals is various (and may overlap the standard FAR2L's pasting #Shift-Ins# or #Ctrl-V#).
172+
The keyboard shortcut of the #terminal pasting# (terminal simulates keyboard input via bracketed paste) and #FAR2L pasting# (FAR2L itself does paste) are different. Note that pasting keyboard shortcut in different terminals is various (and may overlap the standard FAR2L's pasting #Shift-Ins# or #Ctrl-V#).
173173
In FAR2L without TTY|X (and without enabled OSC 52 both in FAR2L and in terminal) FAR2L's pasting uses its #internal clipboard# (because FAR2L does not access the system clipboard), terminal pasting uses #system clipboard#.
174174

175175

@@ -202,34 +202,39 @@ and in #terminal settings# option #OSC 52 must be allowed#
202202

203203

204204
#Terminals and ssh-clients supporting extended FAR2L keyboard shortcuts for plain terminal version FAR2L TTY#
205-
- Internal terminal in FAR2L-GUI (Linux, macOS, *BSD),
205+
- Internal terminal in #FAR2L-GUI# (Linux/BSD, macOS),
206206
see ~UI backends~@UIBackends@ and in help of #NetRocks plugin# section #Command line and remote FAR2L#
207207
(~TTY|F backend~@UIBackends@: keys and clipboard by FAR2L TTY extensions support)
208-
209-
- kovidgoyal's kitty (Linux, macOS, *BSD): ~https://github.com/kovidgoyal/kitty~@https://github.com/kovidgoyal/kitty@ & ~https://sw.kovidgoyal.net/kitty~@https://sw.kovidgoyal.net/kitty@
208+
- kovidgoyal's #kitty# (Linux/BSD, macOS): ~https://github.com/kovidgoyal/kitty~@https://github.com/kovidgoyal/kitty@ & ~https://sw.kovidgoyal.net/kitty~@https://sw.kovidgoyal.net/kitty@
210209
(~TTY|k backend~@UIBackends@: keys by kovidgoyal's kitty keyboard protocol;
211-
for clipboard need turn on OSC 52)
212-
213-
- Wez's Terminal Emulator (Linux, FreeBSD, Windows): ~https://github.com/wez/wezterm~@https://github.com/wez/wezterm@ & ~https://wezfurlong.org/wezterm~@https://wezfurlong.org/wezterm@
214-
(~TTY|k backend~@UIBackends@: keys in Linux, FreeBSD by kovidgoyal's kitty keyboard protocol;
210+
for clipboard need turn on OSC 52 in kitty and in far2l)
211+
- #Alacritty# (Linux/BSD, macOS, Windows): ~https://github.com/alacritty/alacritty~@https://github.com/alacritty/alacritty@ & ~https://alacritty.org/~@https://alacritty.org/@
212+
(~TTY|k backend~@UIBackends@: keys by kovidgoyal's kitty keyboard protocol;
213+
for clipboard need turn on OSC 52 only in far2l)
214+
[in Windows in system must be conpty.dll]
215+
- #Rio Terminal# (Linux/BSD, macOS, Windows): ~https://github.com/raphamorim/rio~@https://github.com/raphamorim/rio@ & ~https://raphamorim.io/rio/~@https://raphamorim.io/rio/@
216+
(~TTY|k backend~@UIBackends@: keys by kovidgoyal's kitty keyboard protocol;
217+
for clipboard need turn on OSC 52 only in far2l)
218+
- #Ghostty# (Linux, macOS): ~https://github.com/ghostty-org/ghostty~@https://github.com/ghostty-org/ghostty@ & ~https://ghostty.org/~@https://ghostty.org/@
219+
(~TTY|k backend~@UIBackends@: keys by kovidgoyal's kitty keyboard protocol;
220+
for clipboard need turn on OSC 52 only in far2l)
221+
- #Wez's Terminal Emulator# (Linux/BSD, Windows): ~https://github.com/wez/wezterm~@https://github.com/wez/wezterm@ & ~https://wezfurlong.org/wezterm~@https://wezfurlong.org/wezterm@
222+
(~TTY|k backend~@UIBackends@: keys in Linux/BSD by kovidgoyal's kitty keyboard protocol;
215223
~TTY|w backend~@UIBackends@: keys in Windows by win32-input-mode which enable by default;
216224
for clipboard need turn on OSC 52)
217225
[in macOS & in Windows in wezterm the kitty keyboard protocol support not working]
218-
219-
- iTerm2 (macOS): ~https://gitlab.com/gnachman/iterm2~@https://gitlab.com/gnachman/iterm2@ & ~https://iterm2.com~@https://iterm2.com@
226+
- #iTerm2# (macOS): ~https://gitlab.com/gnachman/iterm2~@https://gitlab.com/gnachman/iterm2@ & ~https://iterm2.com~@https://iterm2.com@
220227
(~TTY|a backend~@UIBackends@: keys by iTerm2 "raw keyboard" protocol;
221228
for clipboard need turn on OSC 52)
222-
223-
- Windows Terminal
229+
- #Windows Terminal#
224230
(~TTY|w backend~@UIBackends@: keys by win32-input-mode; for clipboard need turn on OSC 52; has mouse bug: ~https://github.com/microsoft/terminal/issues/15083~@https://github.com/microsoft/terminal/issues/15083@)
225231

226-
- putty4far2l (Windows ssh-client): ~https://github.com/ivanshatsky/putty4far2l/releases~@https://github.com/ivanshatsky/putty4far2l/releases@ & ~https://github.com/unxed/putty4far2l~@https://github.com/unxed/putty4far2l@
232+
Original Putty does not correctly send some keyboard shortcuts. Please use putty forks with special far2l TTY extensions support (fluent keypresses, clipboard sharing etc):
233+
- #putty4far2l# (Windows ssh-client): ~https://github.com/ivanshatsky/putty4far2l/releases~@https://github.com/ivanshatsky/putty4far2l/releases@ & ~https://github.com/unxed/putty4far2l~@https://github.com/unxed/putty4far2l@
227234
(~TTY|F backend~@UIBackends@: keys and clipboard by FAR2L TTY extensions support)
228-
229-
- cyd01's KiTTY (Windows ssh-client): ~https://github.com/cyd01/KiTTY~@https://github.com/cyd01/KiTTY@ & ~https://www.9bis.net/kitty~@https://www.9bis.net/kitty@
235+
- cyd01's #KiTTY# (Windows ssh-client): ~https://github.com/cyd01/KiTTY~@https://github.com/cyd01/KiTTY@ & ~https://www.9bis.net/kitty~@https://www.9bis.net/kitty@
230236
(~TTY|F backend~@UIBackends@: keys and clipboard by FAR2L TTY extensions support)
231-
232-
- putty-nd (Windows ssh-client): ~https://sourceforge.net/projects/putty-nd~@https://sourceforge.net/projects/putty-nd@ & ~https://github.com/noodle1983/putty-nd~@https://github.com/noodle1983/putty-nd@
237+
- #putty-nd# (Windows ssh-client): ~https://sourceforge.net/projects/putty-nd~@https://sourceforge.net/projects/putty-nd@ & ~https://github.com/noodle1983/putty-nd~@https://github.com/noodle1983/putty-nd@
233238
(~TTY|F backend~@UIBackends@: keys and clipboard by FAR2L TTY extensions support)
234239

235240

‎far2l/bootstrap/scripts/FarRus.hlf.m4

Lines changed: 24 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ $ # Особенности FAR2L - начало работы#
134134
~https://github.com/akruphi/far2l/wiki~@https://github.com/akruphi/far2l/wiki@
135135

136136
#Режимы интерфейса#
137-
У FAR2L три основных бекенда отрисовки (подробности в ~Режимы интерфейса~@UIBackends@):
137+
У FAR2L основные бекенды отрисовки (подробности в ~Режимы интерфейса~@UIBackends@):
138138
- #GUI# - на базе wxWidgets, работает в графическом режиме, #идеальный UX#
139139
(возможны дополнительные зависимости к вашей desktop environment: wxWidgets toolkit и соответствующие пакеты);
140140
- #TTY|Xi# - работает в терминальном режиме, зависимости буквально от пары иксовых либ
@@ -171,7 +171,7 @@ $ # Особенности FAR2L - начало работы#
171171

172172

173173
#Особенность вставки в терминалах#
174-
Есть комбинация #вставки терминала# (терминал имитирует ввод с клавиатуры) и есть #вставка самого фара# (сам FAR2L делает paste). При этом комбинация вставки терминала в разных терминалах разная (и может перекрывать стандартные клавиши вставки FAR2L #Shift-Ins# или #Ctrl-V#).
174+
Есть комбинация #вставки терминала# (терминал имитирует ввод с клавиатуры через bracketed paste) и есть #вставка самого фара# (сам FAR2L делает paste). При этом комбинация вставки терминала в разных терминалах разная (и может перекрывать стандартные клавиши вставки FAR2L #Shift-Ins# или #Ctrl-V#).
175175
В версии без TTY|X (и без включенной поддержки OSC 52 как в FAR2L, так и в терминале) вставка самого фара использует его #внутренний буфер# (т.к. FAR2L не получает доступ к системному буферу обмена), а вставка терминала - #системный буфер обмена#.
176176

177177

@@ -204,34 +204,40 @@ $ # Особенности FAR2L - начало работы#
204204

205205

206206
#Терминалы и ssh-клиенты, поддерживающие расширенные сочетания клавиш FAR2L для чистой терминальной версии FAR2L TTY#
207-
- Встроенный терминал FAR2L-GUI (Linux, macOS, *BSD),
207+
- Встроенный терминал #FAR2L-GUI# (Linux/BSD, macOS),
208208
см. ~Режимы интерфейса~@UIBackends@ и в помощи #NetRocks plugin# раздел #Command line and remote FAR2L#
209209
(~TTY|F режим~@UIBackends@: клавиши и буфер обмена через FAR2L TTY extensions support)
210-
211-
- kovidgoyal's kitty (Linux, macOS, *BSD): ~https://github.com/kovidgoyal/kitty~@https://github.com/kovidgoyal/kitty@ & ~https://sw.kovidgoyal.net/kitty~@https://sw.kovidgoyal.net/kitty@
210+
- kovidgoyal's #kitty# (Linux/BSD, macOS): ~https://github.com/kovidgoyal/kitty~@https://github.com/kovidgoyal/kitty@ & ~https://sw.kovidgoyal.net/kitty~@https://sw.kovidgoyal.net/kitty@
212211
(~TTY|k режим~@UIBackends@: клавиши через kovidgoyal's kitty keyboard protocol;
213-
для взаимодействия с клипбордом включить OSC 52)
214-
215-
- Wez's Terminal Emulator (Linux, FreeBSD, Windows): ~https://github.com/wez/wezterm~@https://github.com/wez/wezterm@ & ~https://wezfurlong.org/wezterm~@https://wezfurlong.org/wezterm@
216-
(~TTY|k режим~@UIBackends@: клавиши в Linux, FreeBSD через kovidgoyal's kitty keyboard protocol;
212+
для взаимодействия с клипбордом включить OSC 52 и в kitty и в far2l)
213+
- #Alacritty# (Linux/BSD, macOS, Windows): ~https://github.com/alacritty/alacritty~@https://github.com/alacritty/alacritty@ & ~https://alacritty.org/~@https://alacritty.org/@
214+
(~TTY|k режим~@UIBackends@: клавиши через kovidgoyal's kitty keyboard protocol;
215+
для взаимодействия с клипбордом включить OSC 52 только в far2l)
216+
[под Windows в системе должен быть conpty.dll]
217+
- #Rio Terminal# (Linux/BSD, macOS, Windows): ~https://github.com/raphamorim/rio~@https://github.com/raphamorim/rio@ & ~https://raphamorim.io/rio/~@https://raphamorim.io/rio/@
218+
(~TTY|k режим~@UIBackends@: клавиши через kovidgoyal's kitty keyboard protocol;
219+
для взаимодействия с клипбордом включить OSC 52 только в far2l)
220+
- #Ghostty# (Linux, macOS): ~https://github.com/ghostty-org/ghostty~@https://github.com/ghostty-org/ghostty@ & ~https://ghostty.org/~@https://ghostty.org/@
221+
(~TTY|k режим~@UIBackends@: клавиши через kovidgoyal's kitty keyboard protocol;
222+
для взаимодействия с клипбордом включить OSC 52 только в far2l)
223+
- #Wez's Terminal Emulator# (Linux/BSD, Windows): ~https://github.com/wez/wezterm~@https://github.com/wez/wezterm@ & ~https://wezfurlong.org/wezterm~@https://wezfurlong.org/wezterm@
224+
(~TTY|k режим~@UIBackends@: клавиши в Linux/BSD через kovidgoyal's kitty keyboard protocol;
217225
~TTY|w режим~@UIBackends@: клавиши в Windows через win32-input-mode, который включен по умолчанию;
218226
для взаимодействия с клипбордом включить OSC 52)
219227
[в macOS и в Windows в wezterm поддержка режима kitty не работает]
220-
221-
- iTerm2 (macOS): ~https://gitlab.com/gnachman/iterm2~@https://gitlab.com/gnachman/iterm2@ & ~https://iterm2.com~@https://iterm2.com@
228+
- #iTerm2# (macOS): ~https://gitlab.com/gnachman/iterm2~@https://gitlab.com/gnachman/iterm2@ & ~https://iterm2.com~@https://iterm2.com@
222229
(~TTY|a режим~@UIBackends@: клавиши через iTerm2 "raw keyboard" protocol; для взаимодействия с клипбордом включить OSC 52)
223-
224-
- Windows Terminal [в win11 стоит из коробки, в win10 надо ставить]
230+
- #Windows Terminal# [в win11 стоит из коробки, в win10 надо ставить]
225231
(~TTY|w режим~@UIBackends@: клавиши через win32-input-mode; для взаимодействия с клипбордом включить OSC 52;
226232
присутствует баг с мышью: ~https://github.com/microsoft/terminal/issues/15083~@https://github.com/microsoft/terminal/issues/15083@)
227233

228-
- putty4far2l (Windows ssh-клиент): ~https://github.com/ivanshatsky/putty4far2l/releases~@https://github.com/ivanshatsky/putty4far2l/releases@ & ~https://github.com/unxed/putty4far2l~@https://github.com/unxed/putty4far2l@
234+
Оригинальный Putty не корректно пересылает в far2l некоторые клавиатурные комбинации.
235+
Под Windows используйте специальные форки putty с поддержкой far2l TTY extensions support:
236+
- #putty4far2l# (Windows ssh-клиент): ~https://github.com/ivanshatsky/putty4far2l/releases~@https://github.com/ivanshatsky/putty4far2l/releases@ & ~https://github.com/unxed/putty4far2l~@https://github.com/unxed/putty4far2l@
229237
(~TTY|F режим~@UIBackends@: клавиши и буфер обмена через FAR2L TTY extensions support)
230-
231-
- cyd01's KiTTY (Windows ssh-клиент): ~https://github.com/cyd01/KiTTY~@https://github.com/cyd01/KiTTY@ & ~https://www.9bis.net/kitty~@https://www.9bis.net/kitty@
238+
- cyd01's #KiTTY# (Windows ssh-клиент): ~https://github.com/cyd01/KiTTY~@https://github.com/cyd01/KiTTY@ & ~https://www.9bis.net/kitty~@https://www.9bis.net/kitty@
232239
(~TTY|F режим~@UIBackends@: клавиши и буфер обмена через FAR2L TTY extensions support)
233-
234-
- putty-nd (Windows ssh-клиент): ~https://sourceforge.net/projects/putty-nd~@https://sourceforge.net/projects/putty-nd@ & ~https://github.com/noodle1983/putty-nd~@https://github.com/noodle1983/putty-nd@
240+
- #putty-nd# (Windows ssh-клиент): ~https://sourceforge.net/projects/putty-nd~@https://sourceforge.net/projects/putty-nd@ & ~https://github.com/noodle1983/putty-nd~@https://github.com/noodle1983/putty-nd@
235241
(~TTY|F режим~@UIBackends@: клавиши и буфер обмена через FAR2L TTY extensions support)
236242

237243

0 commit comments

Comments
 (0)