Skip to content

Commit

Permalink
Merge pull request #2185 from akruphi/help
Browse files Browse the repository at this point in the history
Help & man
  • Loading branch information
elfmz authored Apr 28, 2024
2 parents 47a5092 + c08261f commit f8c9416
Show file tree
Hide file tree
Showing 7 changed files with 110 additions and 51 deletions.
13 changes: 7 additions & 6 deletions far2l/bootstrap/scripts/FarEng.hlf.m4
Original file line number Diff line number Diff line change
Expand Up @@ -236,7 +236,7 @@ for clipboard need turn on OSC 52)
- #settings/config.ini# - general config
- #settings/colors.ini# - ~files highlighting and sort groups~@Highlight@
- #settings/key_macros.ini# - ~keyboard macro commands~@KeyMacro@
- #settings/user_menu.ini# - ~user menu~@UserMenu@ (the format is different from windows versions FarMenu.ini)
- #settings/user_menu.ini# - main ~user menu~@UserMenu@ (the format is different from local user FarMenu.ini)
- #settings/associations.ini# - ~file associations~@FileAssoc@
- #settings/bookmarks.ini# - ~bookmarks~@Bookmarks@ to fast access to frequently used directories by RCtrl-0...9 or Ctrl-Alt-0...9
- #favorites# - additional items in ~location menu~@DriveDlg@ by Alt-F1/F2
Expand Down Expand Up @@ -2223,7 +2223,7 @@ the main menu and the user menu by pressing #Shift-F2#. Also you may call the
user menu of the parent folder by pressing #BS#.

You may add command separators to the user menu. To do this, you should add
a new menu command and define "#--#" as "hot key". To delete a menu separator,you
a new menu command and define "#--#" as "hot key". To delete a menu separator, you
must switch to file mode with #Ctrl-F4# key.

To execute a user menu command, select it with cursor keys and press #Enter#.
Expand All @@ -2244,10 +2244,11 @@ sequence to execute when this item will be selected.
When you edit or create a submenu, you should enter the hot key and the
item title only.

Local user menus are stored in the text files #FarMenu.Ini#. The main menu,
by default, is stored in the registry, but it is possible to store it in a
file. If you create a local menu in the FAR2L folder, it will be used instead of
the main menu saved in the registry.
Local user menus are stored in the text files #FarMenu.Ini#.
The main menu is stored in profile in #~~/.config/far2l/settings/user_menu.ini#
(the format is different from FarMenu.ini).
If you create a local menu in the FAR2L folder, it will be used instead of
the main menu saved in the profile.

To close the menu even if submenus are open use #Shift-F10#.

Expand Down
8 changes: 5 additions & 3 deletions far2l/bootstrap/scripts/FarHun.hlf.m4
Original file line number Diff line number Diff line change
Expand Up @@ -1917,9 +1917,11 @@ a nevét (ami majd a menüben jelenik meg) és a végrehajtandó parancs sorát.
Almenü szerkesztésénél csak a gyorsbillentyűt és a nevet kell megadni.

A helyi felhasználói menü az adott mappában egy #FarMenu.Ini# nevű fájlba
mentődik. A főmenüt a FAR alaphelyzetben a regisztrációs adatbázisba menti, de
fájlba is menthető. Ha helyi menüt készítettünk a FAR mappájában, a FAR ezt
fogja használni a registrybe mentett főmenü helyett.
mentődik.
A FAR a főmenüt a profilkönyvtárba menti az #~~/.config/far2l/settings/user_menu.ini# fájlba
(a formátum eltér a FarMenu.ini-től).
Ha helyi menüt készítettünk a FAR mappájában, a FAR ezt
fogja használni a profil főmenü helyett.

A #Shift-F10# azonnal bezárja a felhasználói menü ablakát, akár főmenü,
akár almenü volt megnyitva benne.
Expand Down
15 changes: 8 additions & 7 deletions far2l/bootstrap/scripts/FarRus.hlf.m4
Original file line number Diff line number Diff line change
Expand Up @@ -239,7 +239,7 @@ $ # Особенности FAR2L - начало работы#
- #settings/config.ini# - основной конфиг
- #settings/colors.ini# - ~раскраска файлов и групп сортировки~@Highlight@ (настраиваются через F9->Команды->Раскраска файлов и группы сортировки)
- #settings/key_macros.ini# - ~клавиатурные макрокоманды~@KeyMacro@
- #settings/user_menu.ini# - ~меню пользователя~@UserMenu@ (настраиваются через F9->Команды->Меню пользователя; формат отличается от FarMenu.ini из windows-версий)
- #settings/user_menu.ini# - главное ~меню пользователя~@UserMenu@ (настраиваются через F9->Команды->Меню пользователя; формат отличается от FarMenu.ini местных меню)
- #settings/associations.ini# - ~ассоциации файлов~@FileAssoc@ (настраиваются через F9->Команды->Ассоциации файлов)
- #settings/bookmarks.ini# - ~закладки~@Bookmarks@ на каталоги для быстрого перехода по RCtrl-0...9 или Ctrl-Alt-0...9 (настраиваются через F9->Команды->Закладки на папки)
- #favorites# - закладки в ~меню перехода~@DriveDlg@, которое по Alt-F1/F2
Expand Down Expand Up @@ -275,7 +275,7 @@ $ # FAR2L: параметры командной строки#
Вы можете задавать следующие аргументы в командной строке.


#Параметры режимой интерфейса FAR2L (backend-specific options)#
#Параметры режимов интерфейса FAR2L (backend-specific options)#
#--tty#
Запускает far2l сразу в ~режиме TTY~@UIBackends@ вместо автоматического определения возможности
работы в режиме GUI. Хотя GUI режим предпочтителен с точки зрения пользовательского
Expand Down Expand Up @@ -303,7 +303,7 @@ far2l. В этом случае far2l автоматически использ
Использовать PRIMARY selection вместо CLIPBOARD X11 selection. Этот аргумент применим только для
far2l, который работает в режиме WX.

Параметры режимой интерфейса также могут быть установлены через переменную окружения #FAR2L_ARGS# environment variable
Параметры режимов интерфейса также могут быть установлены через переменную окружения #FAR2L_ARGS#
(например: #export FAR2L_ARGS="--tty --nodetect --ee"# и затем просто #far2l# для принудительного запуска только режима TTY).


Expand Down Expand Up @@ -2285,10 +2285,11 @@ $ #Меню пользователя#
При редактировании или создании вложенного меню достаточно ввести заголовок
вложенного меню и, при необходимости, горячую клавишу.

Местные меню хранятся в текстовых файлах #FarMenu.Ini#. Главное меню по
умолчанию хранится в Реестре, но его также можно держать в файле. Если создать
местное меню в папке FAR2L, то оно будет использовано вместо хранящегося в
Реестре главного меню.
Местные меню хранятся в текстовых файлах #FarMenu.Ini#.
Главное меню хранится в профиле в #~~/.config/far2l/settings/user_menu.ini#
(формат отличается от FarMenu.ini).
Если создать местное меню в папке FAR2L,
то оно будет использовано вместо хранящегося в профиле главного меню.

Вы можете закрыть меню на любом уровне вложенности нажав #Shift-F10#.

Expand Down
11 changes: 6 additions & 5 deletions far2l/bootstrap/scripts/FarUkr.hlf.m4
Original file line number Diff line number Diff line change
Expand Up @@ -2137,14 +2137,15 @@ $ #Меню користувача#
У разі редагування або створення вкладеного меню достатньо ввести заголовок
вкладеного меню та, при необхідності, гарячу клавішу.

Місцеві меню зберігаються у текстових файлах #FarMenu.Ini#. Головне меню з
за замовчуванням зберігається в Реєстрі, але його також можна тримати у файлі. Якщо створити
місцеве меню в папці FAR2L, то воно буде використане замість того, що зберігається в
Реєстр головного меню.
Місцеві меню зберігаються у текстових файлах #FarMenu.Ini#.
Головне меню зберігаються у профілі у #~~/.config/far2l/settings/user_menu.ini#
(формат відрізняється від FarMenu.ini).
Якщо створити місцеве меню в папці FAR2L,
то воно буде використане замість того, що зберігається у профілі головного меню.

Ви можете закрити меню на будь-якому рівні вкладеності, натиснувши #Shift-F10#.

також
Також
~Special commands~@SpecCmd@.
список ~макроклавіш~@KeyMacroUserMenuList@, доступних у меню користувача.
Common ~menu~@MenuCmd@ keyboard commands.
Expand Down
32 changes: 16 additions & 16 deletions far2l/bootstrap/scripts/farlang.templ.m4
Original file line number Diff line number Diff line change
Expand Up @@ -14026,15 +14026,15 @@ MenuInterface
"Налады знешняга в&ыгляду"

MenuLanguages
"&Языки"
"&Языки (Languages)"
"Lan&guages"
"Nastavení &Jazyka"
"Sprac&hen"
"Nastavení &Jazyka (Languages)"
"Sprac&hen (Languages)"
"N&yelvek (Languages)"
"&Język"
"&Idiomas"
"&Мови"
"&Мовы"
"&Język (Languages)"
"&Idiomas (Languages)"
"&Мови (Languages)"
"&Мовы (Languages)"

MenuInput
"Параметры &ввода"
Expand Down Expand Up @@ -18165,15 +18165,15 @@ MainMenuFAR
MainMenuREG
l:
l:// <...menu (Registry)>
"Реестр"
"Registry"
"Registry"
"Reg."
"Registry"
"Rejestr"
"Registro"
"Реєстр"
"Рэестр"
"Профиль"
"Profile"
"Profil"
"Profil"
"Profil"
"Profil"
"Perfil"
"Профіль"
"Профіль"

LocalMenuTitle
"Местное меню"
Expand Down
38 changes: 32 additions & 6 deletions man/far2l.1
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
.\" -*- mode: troff; coding: UTF-8 -*-
.\"TOPICS "Topics:"
.TH FAR2L 1 "25-12-22" "FAR2L Version 2.4.1" "Linux fork of FAR Manager v2"
.TH FAR2L 1 "28-04-24" "FAR2L Version 2.6.1" "Linux fork of FAR Manager v2"
.\"SKIP_SECTION"
.SH "NAME"
far2l \- Oldschool file manager, with built\-in terminal and other usefulness\'es.
.\"SKIP_SECTION"
.SH "SYNOPSIS"
.B far2l
[\fI\,OPTION\/\fR] [\fB\-cd \fI\,APATH\/\fR \fB \-cd \fI\,PPATH\/\fR]]
[\fI\,OPTION\/\fR] [\fB\-cd \fI\,APATH\/\fR \fB\-cd \fI\,PPATH\/\fR]]
.\"NODE "DESCRIPTION"
.SH "DESCRIPTION"
.B far2l
Expand Down Expand Up @@ -46,19 +46,25 @@ Do not load macros.
Do not execute auto run macros.
.TP
\fB\-u\fR \fI\,IDENTITY\/\fR OR \fI\,/PATH/NAME\/\fR
Allows to specify separate settings \fI\,IDENTITY\/\fR or FS location.
Allows to specify separate settings \fI\,IDENTITY\/\fR or FS location.
.TP
\fB\-v\fR \fI\,FILENAME\/\fR
View the specified file.
.TP
\fB\-v\fR \- \fI\,COMMAND LINE\/\fR
Executes given \fI\,COMMAND LINE\/\fR and opens viewer with its output.
.TP
\fB\-e\fR[\fI\,LINE\/\fR[:\fI\,POS\/\fR]] \fI\,FILENAME\/\fR
Edit the specified file with optional cursor position specification.
\fB\-e\fR[\fI\,LINE\/\fR[:\fI\,POS\/\fR]] [\fI\,FILENAME\/\fR]
Edit the specified file with optional cursor position specification or empty new file.
.TP
\fB\-e\fR[\fI\,LINE\/\fR[:\fI\,POS\/\fR]] \fI\,COMMAND LINE\/\fR
\fB\-e\fR[\fI\,LINE\/\fR[:\fI\,POS\/\fR]] \- \fI\,COMMAND LINE\/\fR
Executes given command line and opens editor with its output.
.TP
\fB\-set:\fI\,PARAMETER\/\fR=\fI\,VALUE\/\fR
Override the configuration parameter, see far:config for details.
.EX
Example: far2l -set:Language.Main=English -set:Screen.Clock=0 -set:XLat.Flags=0xff -set:System.FindFolders=false
.EE
.\"NODE "BACKEND OPTIONS"
.\"DONT_SPLIT"
.SH "BACKEND-SPECIFIC OPTIONS"
Expand All @@ -81,11 +87,31 @@ terminate instead of going to background on getting SIGHUP (default if in Linux
\fB\-\-immortal\fP
go to background instead of terminating on getting SIGHUP (default if not in Linux TTY)
.TP
\fB\-\-x11\fP
force GUI backend to run on X11
.TP
\fB\-\-wayland\fP
force GUI backend to run on Wayland
.TP
\fB\-\-ee\fP, \fB\-\-ee\fP=\fI\,N\/\fR
ESC expiration in \fI\,N\/\fR msec (100 if unspecified) to avoid need for double ESC presses (valid only in TTY mode without FAR2L extensions)
.TP
\fB\-\-primary-selection\fP
use PRIMARY selection instead of CLIPBOARD X11 selection (only for GUI backend)
.TP
\fB\-\-maximize\fP
force maximize window upon launch (only for GUI backend)
.TP
\fB\-\-nomaximize\fP
dont maximize window upon launch even if its has saved maximized state (only for GUI backend)
.TP
\fB\-\-clipboard=\fI\,SCRIPT\/\fR\fP
use external clipboard handler script that implements get/set text clipboard data via its stdin/stdout
.P
Backend-specific options also can be set via the \fB\,FAR2L_ARGS\/\fR environment variable
.EX
(for example: export FAR2L_ARGS="--tty --nodetect --ee" and then simple far2l to force start only TTY backend).
.EE
.\"NODE "FULL HELP"
.SH "FULL HELP"
far2l historically has its own contextual help system that can be found via pressing F1 key wherever in its TUI.
Expand Down
44 changes: 36 additions & 8 deletions man/ru/far2l.1
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
.\" -*- mode: troff; coding: UTF-8 -*-
.\"TOPICS "Topics:"
.TH FAR2L 1 "25-12-22" "FAR2L Version 2.4.1" "Linux fork of FAR Manager v2"
.TH FAR2L 1 "28-04-24" "FAR2L Version 2.6.1" "Linux fork of FAR Manager v2"
.\"SKIP_SECTION"
.SH "НАИМЕНОВАНИЕ"
far2l \- Файловый менеджер, работающая в текстовом режиме программа, со встроенным терминалом и другими полезными функциями.
.\"SKIP_SECTION"
.SH "СИНТАКСИС"
.B far2l
[\fI\,ОПЦИИ\/\fR] [\fB\-cd \fI\,АПУТЬ\/\fR \fB \-cd \fI\,ППУТЬ\/\fR]]
[\fI\,ОПЦИИ\/\fR] [\fB\-cd \fI\,АПУТЬ\/\fR \fB\-cd \fI\,ППУТЬ\/\fR]]
.\"NODE "DESCRIPTION"
.SH "ОПИСАНИЕ"
.B far2l
Expand Down Expand Up @@ -51,20 +51,28 @@
\fB\-v\fR \- \fI\,КОМАНДА\/\fR
Выполнить указанную \fI\,КОМАНДУ\/\fR и открыть просмотрщик для её вывода.
.TP
\fB\-e\fR[\fI\,СТРОКА\/\fR[:\fI\,ПОЗИЦИЯ\/\fR]] \fI\,ФАЙЛ\/\fR
Указанный \fI\,ФАЙЛ\/\fR открыть в редакторе. Дополнительно можно указать \fI\,СТРОКУ\/\fR и \fI\,ПОЗИЦИЮ\/\fR в строке, устанавливаемые после запуска редактора.
\fB\-e\fR[\fI\,СТРОКА\/\fR[:\fI\,ПОЗИЦИЯ\/\fR]] [\fI\,ФАЙЛ\/\fR]
Указанный \fI\,ФАЙЛ\/\fR (или новый пустой файл) открыть в редакторе.
Дополнительно можно указать \fI\,СТРОКУ\/\fR и \fI\,ПОЗИЦИЮ\/\fR в строке, устанавливаемые после запуска редактора.
.TP
\fB\-e\fR[\fI\,СТРОКА\/\fR[:\fI\,ПОЗИЦИЯ\/\fR]] \fI\,КОМАНДА\/\fR
Выполнить указанную \fI\,КОМАНДУ\/\fR и открыть просмотрщик для её вывода. Дополнительно можно указать \fI\,СТРОКУ\/\fR и \fI\,ПОЗИЦИЮ\/\fR в строке, устанавливаемые после запуска редактора.
\fB\-e\fR[\fI\,СТРОКА\/\fR[:\fI\,ПОЗИЦИЯ\/\fR]] \- \fI\,КОМАНДА\/\fR
Выполнить указанную \fI\,КОМАНДУ\/\fR и открыть просмотрщик для её вывода.
Дополнительно можно указать \fI\,СТРОКУ\/\fR и \fI\,ПОЗИЦИЮ\/\fR в строке, устанавливаемые после запуска редактора.
.TP
\fB\-set:\fI\,PARAMETER\/\fR=\fI\,VALUE\/\fR
Изменение значения конфигурационного параметра. См. far:config
.EX
Пример: far2l -set:Language.Main=English -set:Screen.Clock=0 -set:XLat.Flags=0xff -set:System.FindFolders=false
.EE
.\"NODE "BACKEND OPTIONS"
.\"DONT_SPLIT"
.SH "СПЕЦИФИЧНЫЕ ПАРАМЕТРЫ ТЕРМИНАЛА"
.SH "ПАРАМЕТРЫ РЕЖИМОВ ИНТЕРФЕЙСА (BACKEND-SPECIFIC OPTIONS)"
.TP
\fB\-\-tty\fP
Запускать far2l сразу в режиме TTY вместо автоматического определения возможности работы в режиме GUI.
.TP
\fB\-\-notty\fP
Не использовать терминальный режиме при невозможности использовать GUI режим.
Не использовать терминальный режим при невозможности использовать GUI режим.
.TP
\fB\-\-norgb\fP
Не использовать полноцветную (24-битную) палитру цветов
Expand All @@ -79,11 +87,31 @@
\fB\-\-immortal\fP
Перейти в фоновый режим при получении сигнала SIGHUP (по умолчанию, если не в Linux TTY).
.TP
\fB\-\-x11\fP
force GUI backend to run on X11
.TP
\fB\-\-wayland\fP
force GUI backend to run on Wayland
.TP
\fB\-\-ee\fP, \fB\-\-ee\fP=\fI\,N\/\fR
Срок действия ESC \fI\,N\/\fR мсек (100 по умолчанию), чтобы избежать необходимости двойного нажатия ESC (действительно только в режиме TTY без расширений FAR2L).
.TP
\fB\-\-primary-selection\fP
Использовать PRIMARY selection вместо CLIPBOARD X11 selection. Этот аргумент применим только для far2l, который работает в режиме WX.
.TP
\fB\-\-maximize\fP
force maximize window upon launch (only for GUI backend)
.TP
\fB\-\-nomaximize\fP
dont maximize window upon launch even if its has saved maximized state (only for GUI backend)
.TP
\fB\-\-clipboard=\fI\,SCRIPT\/\fR\fP
use external clipboard handler script that implements get/set text clipboard data via its stdin/stdout
.P
Параметры режимой интерфейса также могут быть установлены через переменную окружения \fB\,FAR2L_ARGS\/\fR
.EX
(например: #export FAR2L_ARGS="--tty --nodetect --ee"# и затем просто far2l для принудительного запуска только режима TTY).
.EE
.\"NODE "FULL HELP"
.SH "ПОЛНАЯ СПРАВКА"
Исторически сложилось, что far2l имеет собственную контекстную справочную систему, доступ к которой можно получить по нажатию клавиши F1 в соответствующем разделе интерфейса.
Expand Down

0 comments on commit f8c9416

Please sign in to comment.