Skip to content

Commit

Permalink
Merge pull request elfmz#2560 from spnethw/far2l_help_corrections
Browse files Browse the repository at this point in the history
far2l hlf: special/os commands, ui backends, panel view modes, env. vars
  • Loading branch information
elfmz authored Dec 13, 2024
2 parents 9275551 + 1f4c667 commit 3c41070
Show file tree
Hide file tree
Showing 4 changed files with 106 additions and 264 deletions.
78 changes: 16 additions & 62 deletions far2l/bootstrap/scripts/FarEng.hlf.m4
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,7 @@ for clipboard need turn on OSC 52)

#Location of FAR2L settings and history#
- FAR2L by default works with settings located in #~~/.config/far2l/# or in #$XDG_CONFIG_HOME/far2l/#
- command line switch #-u# (or #$FARSETTINGS# environment variable) allows to specify arbitrary settings location:
- command line switch #-u# (or #$FARSETTINGS# ~environment variable~@FAREnv@) allows to specify arbitrary settings location:
#-u <path>#: in #path/.config/# (if path or $FARSETTINGS is full path)
#-u <identity>#: in #~~/.config/far2l/custom/identity/# or in #$XDG_CONFIG_HOME/far2l/custom/identity/#
- some settings files (may be missing):
Expand Down Expand Up @@ -345,7 +345,7 @@ and from the path given at the "~Path for personal plugins~@PluginsManagerSettin
Macros with the "Run after FAR2L start" option set will not be run when FAR2L is started.

#-u <identity># or #-u <path>#
Allows to specify separate settings identity or FS location (it override #FARSETTINGS# environment variable value).
Allows to specify separate settings identity or FS location (it override #FARSETTINGS# ~environment variable~@FAREnv@ value).
#-u <path>#: in path/.config/ (if path is full path)
#-u <identity>#: in ~~/.config/far2l/custom/identity/ or in $XDG_CONFIG_HOME/far2l/custom/identity/

Expand Down Expand Up @@ -1600,8 +1600,7 @@ like NetRocks SFTP/SCP protocols to execute remote commands.
Hard kill everything in shell #Ctrl+Alt+C#
(not recommended, it may cause corruption or lost of unsaved data)

Put far2l instance to background #Ctrl+Alt+Z#
(only if far2l works in TTY backend)
Send currently running command to the background #Ctrl+Alt+Z#

See also: ~pseudo-commands~@SpecCmd@

Expand Down Expand Up @@ -4378,69 +4377,22 @@ or directory.
$ #Operating system commands#
FAR2L by itself processes the following operating system commands:

#CLS#
#reset#

Clears the screen.

#disk:#

!! Windows legacy (not relevant on Linux/*BSD/Mac) !!

To change the current disk on the active panel to the specified disk.

!! Windows legacy end !!

#CD path# or #CHDIR path#

To change the current path on the active panel to the specified path.
If the active panel shows a ~plugin~@Plugins@ emulated file system, the command
"CD" in the command line may be used to change the folder in the plugin file
system. Unlike "CD", "CHDIR" command always treats the specified parameter
as a real folder name, regardless of the file panel type.

#CHCP [nnn]#

Displays or sets the active code page number. "nnn" - specifies a code
page number. Type CHCP without a parameter to display the active code
page number.

#SET variable=[string]#

Set environment variable "variable" to the value "string". If "string" is
not specified, the environment variable "variable" will be removed. On startup,
FAR2L sets several ~environment variables~@FAREnv@ by itself.

#IF [NOT] EXIST filename command#

Execute a command "command" if "filename" exists. Prefix "NOT" - execute
the command only if the condition is false.

#IF [NOT] DEFINED variable command#

The "DEFINED" conditional works just like "EXISTS" except it takes an
environment variable name and returns true if the environment variable is
defined.


"IF" commands can be nested, for instance, command "command"

#if exist file1 if not exist file2 if defined variable command#

will be executed if the file "file1" exists, the file "file2" does not
exist and the environment variable "variable" is defined.
Clears the screen of the built-in ~Terminal~@Terminal@.

#pushd path#

Команда PUSHD сохраняет текущий каталог во внутреннем стеке и делает
текущим каталог path.
Stores the current path on the internal stack and sets the current
directory on the active panel to specified path.

#popd#

Переходит в каталог, сохраненный командой PUSHD.
Changes the current path on the active panel to that stored by the “pushd” command.

#clrd#
#exit#

Очищает стек каталогов, сохраненных командой PUSHD.
Сloses the background shell of the built-in ~Terminal~@Terminal@.

Notes:

Expand All @@ -4459,15 +4411,17 @@ $ #Environment variables#
On startup, FAR2L sets the following environment variables available
to child processes:

#FARHOME# path to the folder from which FAR2L was started.
#FARHOME# directory containing far2l resources (e.g. /usr/share/far2l)

#FARLANG# the name of the current interface language.

#FARUSER# ^<wrap>the name of the current user given by the -u ~command line~@CmdLine@ option.
#FARSETTINGS# ^<wrap>the name of user given by the -u ~command line~@CmdLine@ option.

#FARADMINMODE# ^<wrap>equals "1" if FAR2L was run by an administrator (i.e., if its effective user ID is 0)

#FARDIRSTACK# ^<wrap>the contents of directories stack top (the stack is managed with #pushd# and #popd# commands)
#FARPID# FAR2L process id

#FARADMINMODE# ^<wrap>equals "1" if FAR2L was run by an administrator
See also ~FAR2L: command line switches~@CmdLine@ for the #FAR2L_ARGS# environment variable.


@RegExp
Expand Down
62 changes: 17 additions & 45 deletions far2l/bootstrap/scripts/FarHun.hlf.m4
Original file line number Diff line number Diff line change
Expand Up @@ -3988,56 +3988,22 @@ $ #Operációs rendszer parancsok#
A FAR Manager önmaga is képes az operációs rendszer bizonyos parancsait
értelmezni. Ezek a következők:

#CLS#
#reset#

A képernyő törlése.
Clears the screen of the built-in ~Terminal~@Terminal@.

#MEGHAJTÓ BETŰJELE:#
#pushd path#

Az aktív panelt az aktuális meghajtóról a megadott betűjelű meghajtóra
váltja át.
Stores the current path on the internal stack and sets the current
directory on the active panel to specified path.

#CD [meghajtó:]elérési út# vagy #CHDIR [meghajtó:]elérési út#
#popd#

Az aktív panelt a megadott elérési útvonalra váltja. Ha a meghajtó
betűjelét is megadtuk, az aktuális meghajtó is megváltozik. Ha az
aktív panel ~pluginnel~@Plugins@ emulált fájlrendszert mutat, a "CD" paranccsal a
plugin fájlrendszerének mappái között mozoghatunk. A "CD" parancstól eltérően
a "CHDIR" mindig valódi mappaként kezeli az utána álló paramétert, a fájlpanel
jellegétől függetlenül.
Changes the current path on the active panel to that stored by the “pushd” command.

#CHCP [nnn]#
#exit#

Megjeleníti vagy beállítja az aktív kódlap számát (értéke "nnn"). A
paraméter nélküli CHCP parancs megjeleníti az aktív kódlap számát.

#SET változó=[sztring]#

A "változó" nevű környezeti változónak a "sztring" értéket adja. Ha az
egyenlőségjel után a "sztring" helyére nem írunk semmit, a "változó" nevű
környezeti változó törlődik. A FAR Manager indulásakor több
~környezeti változót~@FAREnv@ definiál.

#IF [NOT] EXIST fájlnév parancs#

Akkor hajtja végre a "parancs" nevű parancsot, ha a "fájlnév" létezik. A
"NOT" előtag hatására a parancs csak akkor hajtódik végre, ha a feltétel
hamis.

#IF [NOT] DEFINED változó parancs#

A DEFINED az EXIST-hez hasonlóan feltételesen működik, de nem
fájlnévtől függ a "parancs" végrehajtása, hanem attól, hogy a "változó" nevű
környezeti változó igaz vagy hamis értéket ad-e vissza, azaz létezik-e vagy
sem.

Egész sor "IF" feltételt alkalmazhatunk, például a következő sor "parancs"
nevű parancsa

#if exist fájl1 if not exist fájl2 if defined változó parancs#

csak akkor hajtódik végre, ha "fájl1" fájl létezik, "fájl2" fájl nem
létezik és a "változó" nevű környezeti változó létezik.
Сloses the background shell of the built-in ~Terminal~@Terminal@.

Megjegyzések:

Expand All @@ -4056,13 +4022,19 @@ $ #Környezeti változók#
A FAR Manager indításakor a következő környezeti változókat definiálja
az utódfolyamatok részére:

#FARHOME# A mappa elérési útja, ahonnan a FAR indult.
#FARHOME# directory containing far2l resources (e.g. /usr/share/far2l).

#FARLANG# A kezelőfelület aktuális nyelve.

#FARUSER# ^<wrap>A ~parancssorban~@CmdLine@ a -u kapcsolóval
#FARSETTINGS# ^<wrap>A ~parancssorban~@CmdLine@ a -u kapcsolóval
megadott felhasználói név.

#FARADMINMODE# ^<wrap>equals "1" if FAR2L was run by an administrator (i.e., if its effective user ID is 0)

#FARPID# FAR2L process id

See also ~FAR2L: command line switches~@CmdLine@ for the #FAR2L_ARGS# environment variable.


@RegExp
$ #Regular expressions#
Expand Down
Loading

0 comments on commit 3c41070

Please sign in to comment.