mirror of
https://github.com/sayanarijit/xplr
synced 2024-11-18 09:26:05 +00:00
Automated deployment: Fri Jul 2 15:30:32 UTC 2021 f42285f459
This commit is contained in:
sayanarijit
parent
6ea2130605
commit
a15799cc3f
330
en/message.html
330
en/message.html
@ -177,380 +177,380 @@ represented using
|
||||
</ul>
|
||||
<h2 id="full-list-of-messages"><a class="header" href="#full-list-of-messages">Full List of Messages</a></h2>
|
||||
<h3 id="explorepwd"><a class="header" href="#explorepwd">"ExplorePwd"</a></h3>
|
||||
<p>YAML: <code>ExplorePwd</code></p>
|
||||
<p><strong>YAML:</strong> <code>ExplorePwd</code></p>
|
||||
<p>Explore the present working directory and register the filtered nodes.
|
||||
This operation is expensive. So, try to avoid using it too often.</p>
|
||||
<h3 id="explorepwdasync"><a class="header" href="#explorepwdasync">"ExplorePwdAsync"</a></h3>
|
||||
<p>YAML: <code>ExplorePwdAsync</code></p>
|
||||
<p><strong>YAML:</strong> <code>ExplorePwdAsync</code></p>
|
||||
<p>Explore the present working directory and register the filtered nodes asynchronously.
|
||||
This operation happens asynchronously. That means, the xplr directory buffers won't be updated
|
||||
immediately. Hence, it needs to be used with care and probably with special checks in place.
|
||||
To explore <code>$PWD</code> synchronously, use <code>ExplorePwd</code> instead.</p>
|
||||
<h3 id="exploreparentsasync"><a class="header" href="#exploreparentsasync">"ExploreParentsAsync"</a></h3>
|
||||
<p>YAML: <code>ExploreParentsAsync</code></p>
|
||||
<p><strong>YAML:</strong> <code>ExploreParentsAsync</code></p>
|
||||
<p>Explore the present working directory along with its parents and register the filtered nodes.
|
||||
This operation happens asynchronously. That means, the xplr directory buffers won't be updated
|
||||
immediately. Hence, it needs to be used with care and probably with special checks in place.
|
||||
To explore just the <code>$PWD</code> synchronously, use <code>ExplorePwd</code> instead.</p>
|
||||
<h3 id="refresh"><a class="header" href="#refresh">"Refresh"</a></h3>
|
||||
<p>YAML: <code>Refresh</code></p>
|
||||
<p><strong>YAML:</strong> <code>Refresh</code></p>
|
||||
<p>Refresh the UI.
|
||||
But it will not re-explore the directory if the working directory is the same.
|
||||
If there is some change in the working directory and you want to re-explore it,
|
||||
use the <code>Explore</code> message instead.
|
||||
Also, it will not clear the screen. Use <code>ClearScreen</code> for that.</p>
|
||||
<h3 id="clearscreen"><a class="header" href="#clearscreen">"ClearScreen"</a></h3>
|
||||
<p>YAML: <code>ClearScreen</code></p>
|
||||
<p><strong>YAML:</strong> <code>ClearScreen</code></p>
|
||||
<p>Clears the screen.</p>
|
||||
<h3 id="focusnext"><a class="header" href="#focusnext">"FocusNext"</a></h3>
|
||||
<p>YAML: <code>FocusNext</code></p>
|
||||
<p><strong>YAML:</strong> <code>FocusNext</code></p>
|
||||
<p>Focus next node.</p>
|
||||
<h3 id="--focusnextbyrelativeindex--int-"><a class="header" href="#--focusnextbyrelativeindex--int-">: { FocusNextByRelativeIndex = int }</a></h3>
|
||||
<p>YAML: <code>FocusNextByRelativeIndex: int</code></p>
|
||||
<p><strong>YAML:</strong> <code>FocusNextByRelativeIndex: int</code></p>
|
||||
<p>Focus on the <code>n</code>th node relative to the current focus where <code>n</code> is a given value.</p>
|
||||
<p><strong>YAML Example:</strong> <code>FocusNextByRelativeIndex: 2</code>
|
||||
<strong>Lua Example:</strong> <code>{ FocusNextByRelativeIndex = 2 }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>FocusNextByRelativeIndex: 2</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ FocusNextByRelativeIndex = 2 }</code></p>
|
||||
<h3 id="focusnextbyrelativeindexfrominput"><a class="header" href="#focusnextbyrelativeindexfrominput">"FocusNextByRelativeIndexFromInput"</a></h3>
|
||||
<p>YAML: <code>FocusNextByRelativeIndexFromInput</code></p>
|
||||
<p><strong>YAML:</strong> <code>FocusNextByRelativeIndexFromInput</code></p>
|
||||
<p>Focus on the <code>n</code>th node relative to the current focus where <code>n</code> is read from
|
||||
the input buffer.</p>
|
||||
<h3 id="focusprevious"><a class="header" href="#focusprevious">"FocusPrevious"</a></h3>
|
||||
<p>YAML: <code>FocusPrevious</code></p>
|
||||
<p><strong>YAML:</strong> <code>FocusPrevious</code></p>
|
||||
<p>Focus on the previous item.</p>
|
||||
<h3 id="-focuspreviousbyrelativeindex--int-"><a class="header" href="#-focuspreviousbyrelativeindex--int-">{ FocusPreviousByRelativeIndex = int }</a></h3>
|
||||
<p>YAML: <code>FocusPreviousByRelativeIndex: int</code></p>
|
||||
<p><strong>YAML:</strong> <code>FocusPreviousByRelativeIndex: int</code></p>
|
||||
<p>Focus on the <code>-n</code>th node relative to the current focus where <code>n</code> is a given value.</p>
|
||||
<p><strong>YAML Example:</strong> <code>FocusPreviousByRelativeIndex: 2</code>
|
||||
<strong>Lua Example:</strong> <code>{ FocusPreviousByRelativeIndex = 2 }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>FocusPreviousByRelativeIndex: 2</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ FocusPreviousByRelativeIndex = 2 }</code></p>
|
||||
<h3 id="focuspreviousbyrelativeindexfrominput"><a class="header" href="#focuspreviousbyrelativeindexfrominput">"FocusPreviousByRelativeIndexFromInput"</a></h3>
|
||||
<p>YAML: <code>FocusPreviousByRelativeIndexFromInput</code></p>
|
||||
<p><strong>YAML:</strong> <code>FocusPreviousByRelativeIndexFromInput</code></p>
|
||||
<p>Focus on the <code>-n</code>th node relative to the current focus where <code>n</code> is read from
|
||||
the input buffer.</p>
|
||||
<h3 id="focusfirst"><a class="header" href="#focusfirst">"FocusFirst"</a></h3>
|
||||
<p>YAML: <code>FocusFirst</code></p>
|
||||
<p><strong>YAML:</strong> <code>FocusFirst</code></p>
|
||||
<p>Focus on the first node.</p>
|
||||
<h3 id="focuslast"><a class="header" href="#focuslast">"FocusLast"</a></h3>
|
||||
<p>YAML: <code>FocusLast</code></p>
|
||||
<p><strong>YAML:</strong> <code>FocusLast</code></p>
|
||||
<p>Focus on the last node.</p>
|
||||
<h3 id="-focuspath--string-"><a class="header" href="#-focuspath--string-">{ FocusPath = "string" }</a></h3>
|
||||
<p>YAML: <code>FocusPath: string</code></p>
|
||||
<p><strong>YAML:</strong> <code>FocusPath: string</code></p>
|
||||
<p>Focus on the given path.</p>
|
||||
<p><strong>YAML Example:</strong> <code>FocusPath: /path/to/file</code>
|
||||
<strong>Lua Example:</strong> <code>{ FocusPath = "/path/to/file" }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>FocusPath: /path/to/file</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ FocusPath = "/path/to/file" }</code></p>
|
||||
<h3 id="focuspathfrominput"><a class="header" href="#focuspathfrominput">"FocusPathFromInput"</a></h3>
|
||||
<p>YAML: <code>FocusPathFromInput</code></p>
|
||||
<p><strong>YAML:</strong> <code>FocusPathFromInput</code></p>
|
||||
<p>Focus on the path read from input buffer.</p>
|
||||
<h3 id="-focusbyindex--int-"><a class="header" href="#-focusbyindex--int-">{ FocusByIndex = int }</a></h3>
|
||||
<p>YAML: <code>FocusByIndex: int</code></p>
|
||||
<p><strong>YAML:</strong> <code>FocusByIndex: int</code></p>
|
||||
<p>Focus on the absolute <code>n</code>th node where <code>n</code> is a given value.</p>
|
||||
<p><strong>YAML Example:</strong> <code>FocusByIndex: 2</code>
|
||||
<strong>Lua Example:</strong> <code>{ FocusByIndex = 2 }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>FocusByIndex: 2</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ FocusByIndex = 2 }</code></p>
|
||||
<h3 id="focusbyindexfrominput"><a class="header" href="#focusbyindexfrominput">"FocusByIndexFromInput"</a></h3>
|
||||
<p>YAML: <code>FocusByIndexFromInput</code></p>
|
||||
<p><strong>YAML:</strong> <code>FocusByIndexFromInput</code></p>
|
||||
<p>Focus on the absolute <code>n</code>th node where <code>n</code> is read from the input buffer.</p>
|
||||
<h3 id="-focusbyfilename--string-"><a class="header" href="#-focusbyfilename--string-">{ FocusByFileName = "string" }</a></h3>
|
||||
<p>YAML: <code>FocusByFileName: string</code></p>
|
||||
<p><strong>YAML:</strong> <code>FocusByFileName: string</code></p>
|
||||
<p>Focus on the file by name from the present working directory.</p>
|
||||
<p><strong>YAML Example:</strong> <code>FocusByFileName: filename.ext</code>
|
||||
<strong>Lua Example:</strong> <code>{ FocusByFileName = "filename.ext" }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>FocusByFileName: filename.ext</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ FocusByFileName = "filename.ext" }</code></p>
|
||||
<h3 id="-changedirectory--string-"><a class="header" href="#-changedirectory--string-">{ ChangeDirectory = "string" }</a></h3>
|
||||
<p>YAML: <code>ChangeDirectory: string</code></p>
|
||||
<p><strong>YAML:</strong> <code>ChangeDirectory: string</code></p>
|
||||
<p>Change the present working directory ($PWD)</p>
|
||||
<p><strong>YAML Example:</strong> <code>ChangeDirectory: /path/to/directory</code>
|
||||
<strong>Lua Example:</strong> <code>{ ChangeDirectory = "/path/to/directory" }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>ChangeDirectory: /path/to/directory</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ ChangeDirectory = "/path/to/directory" }</code></p>
|
||||
<h3 id="enter"><a class="header" href="#enter">"Enter"</a></h3>
|
||||
<p>YAML: <code>Enter</code></p>
|
||||
<p><strong>YAML:</strong> <code>Enter</code></p>
|
||||
<p>Enter into the currently focused path if it's a directory.</p>
|
||||
<h3 id="back"><a class="header" href="#back">"Back"</a></h3>
|
||||
<p>YAML: <code>Back</code></p>
|
||||
<p><strong>YAML:</strong> <code>Back</code></p>
|
||||
<p>Go back to the parent directory.</p>
|
||||
<h3 id="lastvisitedpath"><a class="header" href="#lastvisitedpath">"LastVisitedPath"</a></h3>
|
||||
<p>YAML: <code>LastVisitedPath</code></p>
|
||||
<p><strong>YAML:</strong> <code>LastVisitedPath</code></p>
|
||||
<p>Go to the last path visited.</p>
|
||||
<h3 id="nextvisitedpath"><a class="header" href="#nextvisitedpath">"NextVisitedPath"</a></h3>
|
||||
<p>YAML: <code>NextVisitedPath</code></p>
|
||||
<p><strong>YAML:</strong> <code>NextVisitedPath</code></p>
|
||||
<p>Go to the next path visited.</p>
|
||||
<h3 id="followsymlink"><a class="header" href="#followsymlink">"FollowSymlink"</a></h3>
|
||||
<p>YAML: <code>FollowSymlink</code></p>
|
||||
<p><strong>YAML:</strong> <code>FollowSymlink</code></p>
|
||||
<p>Follow the symlink under focus to its actual location.</p>
|
||||
<h3 id="-bufferinput--string-"><a class="header" href="#-bufferinput--string-">{ BufferInput = "string" }</a></h3>
|
||||
<p>YAML: <code>BufferInput(String)</code></p>
|
||||
<p><strong>YAML:</strong> <code>BufferInput(String)</code></p>
|
||||
<p>Append/buffer the given string into the input buffer.</p>
|
||||
<p><strong>YAML Example:</strong> <code>BufferInput: foo</code>
|
||||
<strong>Lua Example:</strong> <code>{ BufferInput = "foo" }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>BufferInput: foo</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ BufferInput = "foo" }</code></p>
|
||||
<h3 id="bufferinputfromkey"><a class="header" href="#bufferinputfromkey">"BufferInputFromKey"</a></h3>
|
||||
<p>YAML: <code>BufferInputFromKey</code></p>
|
||||
<p><strong>YAML:</strong> <code>BufferInputFromKey</code></p>
|
||||
<p>Append/buffer the characted read from a keyboard input into the
|
||||
input buffer.</p>
|
||||
<h3 id="-setinputbuffer--string-"><a class="header" href="#-setinputbuffer--string-">{ SetInputBuffer = "string" }</a></h3>
|
||||
<p>YAML: <code>SetInputBuffer: string</code></p>
|
||||
<p><strong>YAML:</strong> <code>SetInputBuffer: string</code></p>
|
||||
<p>Set/rewrite the input buffer with the given string.
|
||||
When the input buffer is not-null (even if empty string)
|
||||
it will show in the UI.</p>
|
||||
<p><strong>YAML Example:</strong> <code>SetInputBuffer: foo</code>
|
||||
<strong>Lua Example:</strong> <code>{ SetInputBuffer = "foo" }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>SetInputBuffer: foo</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ SetInputBuffer = "foo" }</code></p>
|
||||
<h3 id="removeinputbufferlastcharacter"><a class="header" href="#removeinputbufferlastcharacter">"RemoveInputBufferLastCharacter"</a></h3>
|
||||
<p>YAML: <code>RemoveInputBufferLastCharacter</code></p>
|
||||
<p><strong>YAML:</strong> <code>RemoveInputBufferLastCharacter</code></p>
|
||||
<p>Remove input buffer's last character.</p>
|
||||
<h3 id="removeinputbufferlastword"><a class="header" href="#removeinputbufferlastword">"RemoveInputBufferLastWord"</a></h3>
|
||||
<p>YAML: <code>RemoveInputBufferLastWord</code></p>
|
||||
<p><strong>YAML:</strong> <code>RemoveInputBufferLastWord</code></p>
|
||||
<p>Remove input buffer's last word.</p>
|
||||
<h3 id="resetinputbuffer"><a class="header" href="#resetinputbuffer">"ResetInputBuffer"</a></h3>
|
||||
<p>YAML: <code>ResetInputBuffer</code></p>
|
||||
<p><strong>YAML:</strong> <code>ResetInputBuffer</code></p>
|
||||
<p>Reset the input buffer back to null. It will not show in the UI.</p>
|
||||
<h3 id="-switchmode--string-"><a class="header" href="#-switchmode--string-">{ SwitchMode = "string" }</a></h3>
|
||||
<p>YAML: <code>SwitchMode: string</code></p>
|
||||
<p><strong>YAML:</strong> <code>SwitchMode: string</code></p>
|
||||
<p>Switch input <a href="modes.html">mode</a>.</p>
|
||||
<blockquote>
|
||||
<p><strong>NOTE:</strong> To be specific about which mode to switch to, use <code>SwitchModeBuiltin</code> or
|
||||
<code>SwitchModeCustom</code> instead.</p>
|
||||
</blockquote>
|
||||
<p><strong>YAML Example:</strong> <code>SwitchMode: default</code>
|
||||
<strong>Lua Example:</strong> <code>{ SwitchMode = "default" }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>SwitchMode: default</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ SwitchMode = "default" }</code></p>
|
||||
<h3 id="-switchmodebuiltin--string-"><a class="header" href="#-switchmodebuiltin--string-">{ SwitchModeBuiltin = "string" }</a></h3>
|
||||
<p>YAML: <code>SwitchModeBuiltin: string</code></p>
|
||||
<p><strong>YAML:</strong> <code>SwitchModeBuiltin: string</code></p>
|
||||
<p>Switch to a <a href="modes.html#builtin">builtin mode</a>.</p>
|
||||
<p><strong>YAML Example:</strong> <code>SwitchModeBuiltin: default</code>
|
||||
<strong>Lua Example:</strong> <code>{ SwitchModeBuiltin = "default" }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>SwitchModeBuiltin: default</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ SwitchModeBuiltin = "default" }</code></p>
|
||||
<h3 id="-switchmodecustom--string-"><a class="header" href="#-switchmodecustom--string-">{ SwitchModeCustom = "string" }</a></h3>
|
||||
<p>YAML: <code>SwitchModeCustom: string</code></p>
|
||||
<p><strong>YAML:</strong> <code>SwitchModeCustom: string</code></p>
|
||||
<p>Switch to a <a href="modes.html#custom">custom mode</a>.</p>
|
||||
<p><strong>YAML Example:</strong> <code>SwitchModeCustom: my_custom_mode</code>
|
||||
<strong>Lua Example:</strong> <code>{ SwitchModeCustom = "my_custom_mode" }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>SwitchModeCustom: my_custom_mode</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ SwitchModeCustom = "my_custom_mode" }</code></p>
|
||||
<h3 id="popmode"><a class="header" href="#popmode">"PopMode"</a></h3>
|
||||
<p>YAML: <code>PopMode</code></p>
|
||||
<p><strong>YAML:</strong> <code>PopMode</code></p>
|
||||
<p>Pop the last mode from the history and switch to it.</p>
|
||||
<h3 id="-switchlayout--string-"><a class="header" href="#-switchlayout--string-">{ SwitchLayout = "string" }</a></h3>
|
||||
<p>YAML: <code>SwitchLayout: string</code></p>
|
||||
<p><strong>YAML:</strong> <code>SwitchLayout: string</code></p>
|
||||
<p>Switch <a href="layouts.html">layout</a>.</p>
|
||||
<blockquote>
|
||||
<p><strong>NOTE:</strong> To be specific about which layout to switch to, use <code>SwitchLayoutBuiltin</code> or
|
||||
<code>SwitchLayoutCustom</code> instead.</p>
|
||||
</blockquote>
|
||||
<p><strong>YAML Example:</strong> <code>SwitchLayout: default</code>
|
||||
<strong>Lua Example:</strong> <code>{ SwitchLayout = "default" }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>SwitchLayout: default</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ SwitchLayout = "default" }</code></p>
|
||||
<h3 id="-switchlayoutbuiltin--string-"><a class="header" href="#-switchlayoutbuiltin--string-">{ SwitchLayoutBuiltin = "string" }</a></h3>
|
||||
<p>YAML: <code>SwitchLayoutBuiltin: string</code></p>
|
||||
<p><strong>YAML:</strong> <code>SwitchLayoutBuiltin: string</code></p>
|
||||
<p>Switch to a <a href="layouts.html#builtin">builtin layout</a>.</p>
|
||||
<p><strong>YAML Example:</strong> <code>SwitchLayoutBuiltin: default</code>
|
||||
<strong>Lua Example:</strong> <code>{ SwitchLayoutBuiltin = "default" }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>SwitchLayoutBuiltin: default</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ SwitchLayoutBuiltin = "default" }</code></p>
|
||||
<h3 id="-switchlayoutcustom--string-"><a class="header" href="#-switchlayoutcustom--string-">{ SwitchLayoutCustom = "string" }</a></h3>
|
||||
<p>YAML: <code>SwitchLayoutCustom: string</code></p>
|
||||
<p><strong>YAML:</strong> <code>SwitchLayoutCustom: string</code></p>
|
||||
<p>Switch to a <a href="layouts.html#custom">custom layout</a>.</p>
|
||||
<p><strong>YAML Example:</strong> <code>SwitchLayoutCustom: my_custom_layout</code>
|
||||
<strong>Lua Example:</strong> <code>{ SwitchLayoutCustom = "my_custom_layout" }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>SwitchLayoutCustom: my_custom_layout</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ SwitchLayoutCustom = "my_custom_layout" }</code></p>
|
||||
<h3 id="-call--string-"><a class="header" href="#-call--string-">{ Call = "string" }</a></h3>
|
||||
<p>YAML: <code>Call: string</code></p>
|
||||
<p><strong>YAML:</strong> <code>Call: string</code></p>
|
||||
<p>Call a shell command with the given arguments.
|
||||
Note that the arguments will be shell-escaped.
|
||||
So to read the variables, the <code>-c</code> option of the shell
|
||||
can be used.
|
||||
You may need to pass <code>ExplorePwd</code> depening on the expectation.</p>
|
||||
<p><strong>YAML Example:</strong> <code>Call: { command: bash, args: ["-c", "read -p test"] }</code>
|
||||
<strong>Lua Example:</strong> <code>{ Call = { command = "bash", args = { "-c", "read -p test" } } }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>Call: { command: bash, args: ["-c", "read -p test"] }</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ Call = { command = "bash", args = { "-c", "read -p test" } } }</code></p>
|
||||
<h3 id="-callsilently--string-"><a class="header" href="#-callsilently--string-">{ CallSilently = "string" }</a></h3>
|
||||
<p>YAML: <code>CallSilently: string</code></p>
|
||||
<p><strong>YAML:</strong> <code>CallSilently: string</code></p>
|
||||
<p>Like <code>Call</code> but without the flicker. The stdin, stdout
|
||||
stderr will be piped to null. So it's non-interactive.</p>
|
||||
<p><strong>YAML Example:</strong> <code>CallSilently: { command: tput, args: ["bell"] }</code>
|
||||
<strong>Lua Example:</strong> <code>{ CallSilently = { command = "tput", args = { "bell" } } }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>CallSilently: { command: tput, args: ["bell"] }</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ CallSilently = { command = "tput", args = { "bell" } } }</code></p>
|
||||
<h3 id="-calllua--string-"><a class="header" href="#-calllua--string-">{ CallLua = "string" }</a></h3>
|
||||
<p>YAML: <code>CallLua: string</code></p>
|
||||
<p><strong>YAML:</strong> <code>CallLua: string</code></p>
|
||||
<p>Call a Lua function.
|
||||
A <a href="#calllua-argument"><code>CallLuaArg</code></a> object will be passed to the
|
||||
<a href="#lua-function-calls">function</a> as argument.
|
||||
The function can optionally return a list of messages for xplr to handle
|
||||
after the executing the function.</p>
|
||||
<p><strong>YAML Example:</strong> <code>CallLua: custom.some_custom_funtion</code>
|
||||
<strong>Lua Example:</strong> <code>{ CallLua = "custom.some_custom_funtion" }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>CallLua: custom.some_custom_funtion</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ CallLua = "custom.some_custom_funtion" }</code></p>
|
||||
<h3 id="-callluasilently--string-"><a class="header" href="#-callluasilently--string-">{ CallLuaSilently = "string" }</a></h3>
|
||||
<p>YAML: <code>CallLuaSilently: string</code></p>
|
||||
<p><strong>YAML:</strong> <code>CallLuaSilently: string</code></p>
|
||||
<p>Like <code>CallLua</code> but without the flicker. The stdin, stdout
|
||||
stderr will be piped to null. So it's non-interactive.</p>
|
||||
<p><strong>YAML Example:</strong> <code>CallLuaSilently: custom.some_custom_function</code>
|
||||
<strong>Lua Example:</strong> <code>{ CallLuaSilently = "custom.some_custom_function" }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>CallLuaSilently: custom.some_custom_function</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ CallLuaSilently = "custom.some_custom_function" }</code></p>
|
||||
<h3 id="-bashexec--string-"><a class="header" href="#-bashexec--string-">{ BashExec = "string" }</a></h3>
|
||||
<p>YAML: <code>BashExec: string</code></p>
|
||||
<p><strong>YAML:</strong> <code>BashExec: string</code></p>
|
||||
<p>An alias to <code>Call: {command: bash, args: ["-c", "{string}"], silent: false}</code>
|
||||
where <code>{string}</code> is the given value.</p>
|
||||
<p><strong>YAML Example:</strong> <code>BashExec: "read -p test"</code>
|
||||
<strong>Lua Example:</strong> <code>{ BashExec = "read -p test" }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>BashExec: "read -p test"</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ BashExec = "read -p test" }</code></p>
|
||||
<h3 id="-bashexecsilently--string-"><a class="header" href="#-bashexecsilently--string-">{ BashExecSilently = "string" }</a></h3>
|
||||
<p>YAML: <code>BashExecSilently(String)</code></p>
|
||||
<p><strong>YAML:</strong> <code>BashExecSilently(String)</code></p>
|
||||
<p>Like <code>BashExec</code> but without the flicker. The stdin, stdout
|
||||
stderr will be piped to null. So it's non-interactive.</p>
|
||||
<p><strong>YAML Example:</strong> <code>BashExecSilently: "tput bell"</code>
|
||||
<strong>Lua Example:</strong> <code>{ BashExecSilently = "tput bell" }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>BashExecSilently: "tput bell"</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ BashExecSilently = "tput bell" }</code></p>
|
||||
<h3 id="select"><a class="header" href="#select">"Select"</a></h3>
|
||||
<p>YAML: <code>Select</code></p>
|
||||
<p><strong>YAML:</strong> <code>Select</code></p>
|
||||
<p>Select the focused node.</p>
|
||||
<h3 id="selectall"><a class="header" href="#selectall">"SelectAll"</a></h3>
|
||||
<p>YAML: <code>SelectAll</code></p>
|
||||
<p><strong>YAML:</strong> <code>SelectAll</code></p>
|
||||
<p>Select all the visible nodes.</p>
|
||||
<h3 id="-selectpath--string-"><a class="header" href="#-selectpath--string-">{ SelectPath = "string" }</a></h3>
|
||||
<p>YAML: <code>SelectPath: string</code></p>
|
||||
<p><strong>YAML:</strong> <code>SelectPath: string</code></p>
|
||||
<p>Select the given path.</p>
|
||||
<p><strong>YAML Example:</strong> <code>SelectPath: /path/to/file</code>
|
||||
<strong>Lua Example:</strong> <code>{ SelectPath = "/path/to/file" }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>SelectPath: /path/to/file</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ SelectPath = "/path/to/file" }</code></p>
|
||||
<h3 id="unselect"><a class="header" href="#unselect">"UnSelect"</a></h3>
|
||||
<p>YAML: <code>UnSelect</code></p>
|
||||
<p><strong>YAML:</strong> <code>UnSelect</code></p>
|
||||
<p>Unselect the focused node.</p>
|
||||
<h3 id="unselectall"><a class="header" href="#unselectall">"UnSelectAll"</a></h3>
|
||||
<p>YAML: <code>UnSelectAll</code></p>
|
||||
<p><strong>YAML:</strong> <code>UnSelectAll</code></p>
|
||||
<p>Unselect all the visible nodes.</p>
|
||||
<h3 id="-unselectpath--string-"><a class="header" href="#-unselectpath--string-">{ UnSelectPath = "string)" }</a></h3>
|
||||
<p>YAML: <code>UnSelectPath: string</code></p>
|
||||
<p><strong>YAML:</strong> <code>UnSelectPath: string</code></p>
|
||||
<p>UnSelect the given path.</p>
|
||||
<p><strong>YAML Example:</strong> <code>UnSelectPath: /path/to/file</code>
|
||||
<strong>Lua Example:</strong> <code>{ UnSelectPath = "/path/to/file" }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>UnSelectPath: /path/to/file</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ UnSelectPath = "/path/to/file" }</code></p>
|
||||
<h3 id="toggleselection"><a class="header" href="#toggleselection">"ToggleSelection"</a></h3>
|
||||
<p>YAML: <code>ToggleSelection</code></p>
|
||||
<p><strong>YAML:</strong> <code>ToggleSelection</code></p>
|
||||
<p>Toggle selection on the focused node.</p>
|
||||
<h3 id="toggleselectall"><a class="header" href="#toggleselectall">"ToggleSelectAll"</a></h3>
|
||||
<p>YAML: <code>ToggleSelectAll</code></p>
|
||||
<p><strong>YAML:</strong> <code>ToggleSelectAll</code></p>
|
||||
<p>Toggle between select all and unselect all.</p>
|
||||
<h3 id="-toggleselectionbypath--string-"><a class="header" href="#-toggleselectionbypath--string-">{ ToggleSelectionByPath = "string" }</a></h3>
|
||||
<p>YAML: <code>ToggleSelectionByPath: string</code></p>
|
||||
<p><strong>YAML:</strong> <code>ToggleSelectionByPath: string</code></p>
|
||||
<p>Toggle selection by file path.</p>
|
||||
<p><strong>YAML Example:</strong> <code>ToggleSelectionByPath: /path/to/file</code>
|
||||
<strong>Lua Example:</strong> <code>{ ToggleSelectionByPath = "/path/to/file" }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>ToggleSelectionByPath: /path/to/file</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ ToggleSelectionByPath = "/path/to/file" }</code></p>
|
||||
<h3 id="clearselection"><a class="header" href="#clearselection">"ClearSelection"</a></h3>
|
||||
<p>YAML: <code>ClearSelection</code></p>
|
||||
<p><strong>YAML:</strong> <code>ClearSelection</code></p>
|
||||
<p>Clear the selection.</p>
|
||||
<h3 id="-addnodefilter---filter--a-hreffilteringhtmlfilternodefiltera-input--string-"><a class="header" href="#-addnodefilter---filter--a-hreffilteringhtmlfilternodefiltera-input--string-">{ AddNodeFilter = { filter = "<a href="filtering.html#filter">NodeFilter</a>", input = "string" }</a></h3>
|
||||
<p>YAML: <code>AddNodeFilter: { filter = [NodeFilter](filtering.md#filter), input = string</code></p>
|
||||
<p><strong>YAML:</strong> <code>AddNodeFilter: { filter = [NodeFilter](filtering.md#filter), input = string</code></p>
|
||||
<p>Add a <a href="filtering.html">filter</a> to exclude nodes while exploring directories.</p>
|
||||
<p><strong>YAML Example:</strong> <code>AddNodeFilter: { filter: RelativePathDoesStartWith, input: foo }</code>
|
||||
<strong>Lua Example:</strong> <code>{ AddNodeFilter = { filter = "RelativePathDoesStartWith", input = "foo" }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>AddNodeFilter: { filter: RelativePathDoesStartWith, input: foo }</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ AddNodeFilter = { filter = "RelativePathDoesStartWith", input = "foo" }</code></p>
|
||||
<h3 id="-removenodefilter---filter--a-hreffilteringhtmlfilternodefiltera-input--string-"><a class="header" href="#-removenodefilter---filter--a-hreffilteringhtmlfilternodefiltera-input--string-">{ RemoveNodeFilter = { filter = "<a href="filtering.html#filter">NodeFilter</a>", input = "string" }</a></h3>
|
||||
<p>YAML: <code>RemoveNodeFilter: { filter = [NodeFilter](filtering.md#filter), input = string</code></p>
|
||||
<p><strong>YAML:</strong> <code>RemoveNodeFilter: { filter = [NodeFilter](filtering.md#filter), input = string</code></p>
|
||||
<p>Remove an existing <a href="filtering.html">filter</a>.</p>
|
||||
<p><strong>YAML Example:</strong> <code>RemoveNodeFilter: { filter: RelativePathDoesStartWith, input: foo }</code>
|
||||
<strong>Lua Example:</strong> <code>{ RemoveNodeFilter: { filter: "RelativePathDoesStartWith", input: "foo" } }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>RemoveNodeFilter: { filter: RelativePathDoesStartWith, input: foo }</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ RemoveNodeFilter: { filter: "RelativePathDoesStartWith", input: "foo" } }</code></p>
|
||||
<h3 id="-togglenodefilter---filter--a-hreffilteringhtmlfilternodefiltera-input--string-"><a class="header" href="#-togglenodefilter---filter--a-hreffilteringhtmlfilternodefiltera-input--string-">{ ToggleNodeFilter = { filter = "<a href="filtering.html#filter">NodeFilter</a>", input = "string" }</a></h3>
|
||||
<p>YAML: <code>ToggleNodeFilter: { filter = [NodeFilter](filtering.md#filter), input = string</code></p>
|
||||
<p><strong>YAML:</strong> <code>ToggleNodeFilter: { filter = [NodeFilter](filtering.md#filter), input = string</code></p>
|
||||
<p>Remove a <a href="filter.html">filter</a> if it exists, else, add a it.</p>
|
||||
<p><strong>YAML Example:</strong> <code>ToggleNodeFilter: { filter: RelativePathDoesStartWith, input: foo }</code>
|
||||
<strong>Lua Example:</strong> <code>{ ToggleNodeFilter = { filter = "RelativePathDoesStartWith", input = "foo" } }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>ToggleNodeFilter: { filter: RelativePathDoesStartWith, input: foo }</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ ToggleNodeFilter = { filter = "RelativePathDoesStartWith", input = "foo" } }</code></p>
|
||||
<h3 id="-addnodefilterfrominput--a-hreffilteringhtmlfilternodefiltera-"><a class="header" href="#-addnodefilterfrominput--a-hreffilteringhtmlfilternodefiltera-">{ AddNodeFilterFromInput = "<a href="filtering.html#filter">NodeFilter</a>" }</a></h3>
|
||||
<p>YAML: <code>AddNodeFilterFromInput: [NodeFilter](filtering.md#filter)</code></p>
|
||||
<p><strong>YAML:</strong> <code>AddNodeFilterFromInput: [NodeFilter](filtering.md#filter)</code></p>
|
||||
<p>Add a node <a href="filtering.html">filter</a> reading the input from the buffer.</p>
|
||||
<p><strong>YAML Example:</strong> <code>AddNodeFilterFromInput: RelativePathDoesStartWith</code>
|
||||
<strong>Lua Example:</strong> <code>{ AddNodeFilterFromInput = "RelativePathDoesStartWith" }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>AddNodeFilterFromInput: RelativePathDoesStartWith</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ AddNodeFilterFromInput = "RelativePathDoesStartWith" }</code></p>
|
||||
<h3 id="-removenodefilterfrominput--a-hreffilteringhtmlfilternodefiltera-"><a class="header" href="#-removenodefilterfrominput--a-hreffilteringhtmlfilternodefiltera-">{ RemoveNodeFilterFromInput = "<a href="filtering.html#filter">NodeFilter</a>" }</a></h3>
|
||||
<p>YAML: <code>RemoveNodeFilterFromInput: [NodeFilter](filtering.md#filter)</code></p>
|
||||
<p><strong>YAML:</strong> <code>RemoveNodeFilterFromInput: [NodeFilter](filtering.md#filter)</code></p>
|
||||
<p>Remove a node <a href="filtering.html">filter</a> reading the input from the buffer.</p>
|
||||
<p><strong>YAML Example:</strong> <code>RemoveNodeFilterFromInput: RelativePathDoesStartWith</code>
|
||||
<strong>Lua Example:</strong> <code>{ RemoveNodeFilterFromInput = "RelativePathDoesStartWith" }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>RemoveNodeFilterFromInput: RelativePathDoesStartWith</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ RemoveNodeFilterFromInput = "RelativePathDoesStartWith" }</code></p>
|
||||
<h3 id="removelastnodefilter"><a class="header" href="#removelastnodefilter">"RemoveLastNodeFilter"</a></h3>
|
||||
<p>YAML: <code>RemoveLastNodeFilter</code></p>
|
||||
<p><strong>YAML:</strong> <code>RemoveLastNodeFilter</code></p>
|
||||
<p>Remove the last node <a href="filtering.html">filter</a>.</p>
|
||||
<h3 id="resetnodefilters"><a class="header" href="#resetnodefilters">"ResetNodeFilters"</a></h3>
|
||||
<p>YAML: <code>ResetNodeFilters</code></p>
|
||||
<p><strong>YAML:</strong> <code>ResetNodeFilters</code></p>
|
||||
<p>Reset the node <a href="filtering.html">filters</a> back to the default configuration.</p>
|
||||
<h3 id="clearnodefilters"><a class="header" href="#clearnodefilters">"ClearNodeFilters"</a></h3>
|
||||
<p>YAML: <code>ClearNodeFilters</code></p>
|
||||
<p><strong>YAML:</strong> <code>ClearNodeFilters</code></p>
|
||||
<p>Clear all the node <a href="filtering.html">filters</a>.</p>
|
||||
<h3 id="-addnodesorter---sorter--a-hrefsortinghtmlsorternodesortera-reverse--bool--"><a class="header" href="#-addnodesorter---sorter--a-hrefsortinghtmlsorternodesortera-reverse--bool--">{ AddNodeSorter = { sorter = "<a href="sorting.html#sorter">NodeSorter</a>", reverse = bool } }</a></h3>
|
||||
<p>YAML: <code>AddNodeSorter: { sorter: [NodeSorter](sorting.md#sorter), reverse = bool }</code></p>
|
||||
<p><strong>YAML:</strong> <code>AddNodeSorter: { sorter: [NodeSorter](sorting.md#sorter), reverse = bool }</code></p>
|
||||
<p>Add a <a href="sorting.html#sorter">sorter</a> to sort nodes while exploring directories.</p>
|
||||
<p><strong>YAML Example:</strong> <code>AddNodeSorter: { sorter: ByRelativePath, reverse: false }</code>
|
||||
<strong>YAML Example:</strong> <code>{ AddNodeSorter = { sorter = "ByRelativePath", reverse = false } }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>AddNodeSorter: { sorter: ByRelativePath, reverse: false }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>{ AddNodeSorter = { sorter = "ByRelativePath", reverse = false } }</code></p>
|
||||
<h3 id="-removenodesorter--a-hrefsortinghtmlsorternodesortera-"><a class="header" href="#-removenodesorter--a-hrefsortinghtmlsorternodesortera-">{ RemoveNodeSorter = "<a href="sorting.html#sorter">NodeSorter</a>" }</a></h3>
|
||||
<p>YAML: <code>RemoveNodeSorter: [NodeSorter](sorting.md#sorter)</code></p>
|
||||
<p><strong>YAML:</strong> <code>RemoveNodeSorter: [NodeSorter](sorting.md#sorter)</code></p>
|
||||
<p>Remove an existing <a href="sorting.html#sorter">sorter</a>.</p>
|
||||
<p><strong>YAML Example:</strong> <code>RemoveNodeSorter: ByRelativePath</code>
|
||||
<strong>Lua Example:</strong> <code>{ RemoveNodeSorter = "ByRelativePath" }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>RemoveNodeSorter: ByRelativePath</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ RemoveNodeSorter = "ByRelativePath" }</code></p>
|
||||
<h3 id="-reversenodesorter--a-hrefsortinghtmlsorternodesortera-"><a class="header" href="#-reversenodesorter--a-hrefsortinghtmlsorternodesortera-">{ ReverseNodeSorter = "<a href="sorting.html#sorter">NodeSorter</a>" }</a></h3>
|
||||
<p>YAML: <code>ReverseNodeSorter: [NodeSorter](sorting.md#sorter)</code></p>
|
||||
<p><strong>YAML:</strong> <code>ReverseNodeSorter: [NodeSorter](sorting.md#sorter)</code></p>
|
||||
<p>Reverse a node <a href="sorting.html#sorter">sorter</a>.</p>
|
||||
<p><strong>YAML Example:</strong> <code>ReverseNodeSorter: ByRelativePath</code>
|
||||
<strong>Lua Example:</strong> <code>{ ReverseNodeSorter = "ByRelativePath" }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>ReverseNodeSorter: ByRelativePath</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ ReverseNodeSorter = "ByRelativePath" }</code></p>
|
||||
<h3 id="-togglenodesorter---sorter--a-hrefsortinghtmlsorternodesortera-reverse--bool--"><a class="header" href="#-togglenodesorter---sorter--a-hrefsortinghtmlsorternodesortera-reverse--bool--">{ ToggleNodeSorter = { sorter = "<a href="sorting.html#sorter">NodeSorter</a>", reverse = bool } }</a></h3>
|
||||
<p>YAML: <code>ToggleNodeSorter: { sorter: [NodeSorter](sorting.md#sorter), reverse = bool }</code></p>
|
||||
<p><strong>YAML:</strong> <code>ToggleNodeSorter: { sorter: [NodeSorter](sorting.md#sorter), reverse = bool }</code></p>
|
||||
<p>Remove a <a href="#sorting.md#sorter">sorter</a> if it exists, else, add a it.</p>
|
||||
<p><strong>YAML Example:</strong> <code>ToggleSorterSorter: {sorter: ByRelativePath, reverse: false }</code>
|
||||
<strong>Lua Example:</strong> <code>{ ToggleSorterSorter: { sorter = "ByRelativePath", reverse = false } }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>ToggleSorterSorter: {sorter: ByRelativePath, reverse: false }</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ ToggleSorterSorter: { sorter = "ByRelativePath", reverse = false } }</code></p>
|
||||
<h3 id="reversenodesorters"><a class="header" href="#reversenodesorters">"ReverseNodeSorters"</a></h3>
|
||||
<p>YAML: <code>ReverseNodeSorters</code></p>
|
||||
<p><strong>YAML:</strong> <code>ReverseNodeSorters</code></p>
|
||||
<p>Reverse the node <a href="sorting.html#sorter">sorters</a>.</p>
|
||||
<h3 id="removelastnodesorter"><a class="header" href="#removelastnodesorter">"RemoveLastNodeSorter"</a></h3>
|
||||
<p>YAML: <code>RemoveLastNodeSorter</code></p>
|
||||
<p><strong>YAML:</strong> <code>RemoveLastNodeSorter</code></p>
|
||||
<p>Remove the last node <a href="sorting.html#sorter">sorter</a>.</p>
|
||||
<h3 id="resetnodesorters"><a class="header" href="#resetnodesorters">"ResetNodeSorters"</a></h3>
|
||||
<p>YAML: <code>ResetNodeSorters</code></p>
|
||||
<p><strong>YAML:</strong> <code>ResetNodeSorters</code></p>
|
||||
<p>Reset the node <a href="sorting.html#sorter">sorters</a> back to the default configuration.</p>
|
||||
<h3 id="clearnodesorters"><a class="header" href="#clearnodesorters">"ClearNodeSorters"</a></h3>
|
||||
<p>YAML: <code>ClearNodeSorters</code></p>
|
||||
<p><strong>YAML:</strong> <code>ClearNodeSorters</code></p>
|
||||
<p>Clear all the node <a href="sorting.html#sorter">sorters</a>.</p>
|
||||
<h3 id="enablemouse"><a class="header" href="#enablemouse">"EnableMouse"</a></h3>
|
||||
<p>YAML: <code>EnableMouse</code></p>
|
||||
<p><strong>YAML:</strong> <code>EnableMouse</code></p>
|
||||
<p>Enable mouse</p>
|
||||
<h3 id="disablemouse"><a class="header" href="#disablemouse">"DisableMouse"</a></h3>
|
||||
<p>YAML: <code>DisableMouse</code></p>
|
||||
<p><strong>YAML:</strong> <code>DisableMouse</code></p>
|
||||
<p>Disable mouse</p>
|
||||
<h3 id="togglemouse"><a class="header" href="#togglemouse">"ToggleMouse"</a></h3>
|
||||
<p>YAML: <code>ToggleMouse</code></p>
|
||||
<p><strong>YAML:</strong> <code>ToggleMouse</code></p>
|
||||
<p>Toggle mouse</p>
|
||||
<h3 id="-startfifo--string-"><a class="header" href="#-startfifo--string-">{ StartFifo = "string" }</a></h3>
|
||||
<p>YAML: <code>StartFifo: string</code></p>
|
||||
<p><strong>YAML:</strong> <code>StartFifo: string</code></p>
|
||||
<p>Start piping the focused path to the given fifo path</p>
|
||||
<p><strong>YAML Example:</strong> <code>StartFifo: /tmp/xplr.fifo</code>
|
||||
<strong>Lua Example:</strong> <code>{ StartFifo = "/tmp/xplr.fifo }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>StartFifo: /tmp/xplr.fifo</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ StartFifo = "/tmp/xplr.fifo }</code></p>
|
||||
<h3 id="stopfifo"><a class="header" href="#stopfifo">"StopFifo"</a></h3>
|
||||
<p>YAML: <code>StopFifo</code></p>
|
||||
<p><strong>YAML:</strong> <code>StopFifo</code></p>
|
||||
<p>Close the active fifo and stop piping.</p>
|
||||
<h3 id="-togglefifo--string-"><a class="header" href="#-togglefifo--string-">{ ToggleFifo = "string" }</a></h3>
|
||||
<p>YAML: <code>ToggleFifo: string</code></p>
|
||||
<p><strong>YAML:</strong> <code>ToggleFifo: string</code></p>
|
||||
<p>Toggle betwen {Start|Stop}Fifo</p>
|
||||
<p><strong>YAML Example:</strong> <code>ToggleFifo: /path/to/fifo</code>
|
||||
<strong>Lua Example:</strong> <code>{ ToggleFifo = "/path/to/fifo" }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>ToggleFifo: /path/to/fifo</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ ToggleFifo = "/path/to/fifo" }</code></p>
|
||||
<h3 id="-loginfo--string-"><a class="header" href="#-loginfo--string-">{ LogInfo = "string" }</a></h3>
|
||||
<p>YAML: <code>LogInfo: string</code></p>
|
||||
<p><strong>YAML:</strong> <code>LogInfo: string</code></p>
|
||||
<p>Log information message.</p>
|
||||
<p><strong>YAML Example:</strong> <code>LogInfo: launching satellite</code>
|
||||
<strong>Lua Example:</strong> <code>{ LogInfo = "launching satellite" }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>LogInfo: launching satellite</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ LogInfo = "launching satellite" }</code></p>
|
||||
<h3 id="-logsuccess--string-"><a class="header" href="#-logsuccess--string-">{ LogSuccess = "String" }</a></h3>
|
||||
<p>YAML: <code>LogSuccess: string</code></p>
|
||||
<p><strong>YAML:</strong> <code>LogSuccess: string</code></p>
|
||||
<p>Log a success message.</p>
|
||||
<p><strong>YAML Example:</strong> <code>LogSuccess: satellite reached destination</code>.
|
||||
<strong>Lua Example:</strong> <code>{ LogSuccess = "satellite reached destination" }</code>.</p>
|
||||
<p><strong>YAML Example:</strong> <code>LogSuccess: satellite reached destination</code>.</p>
|
||||
<p><strong>Lua Example:</strong> <code>{ LogSuccess = "satellite reached destination" }</code>.</p>
|
||||
<h3 id="-logwarning--string-"><a class="header" href="#-logwarning--string-">{ LogWarning = "string" }</a></h3>
|
||||
<p>YAML: <code>LogWarning: string</code></p>
|
||||
<p><strong>YAML:</strong> <code>LogWarning: string</code></p>
|
||||
<p>Log an warning message.</p>
|
||||
<p><strong>YAML Example:</strong> <code>LogWarning: satellite is heating</code>
|
||||
<strong>Lua Example:</strong> <code>{ LogWarning = "satellite is heating" }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>LogWarning: satellite is heating</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ LogWarning = "satellite is heating" }</code></p>
|
||||
<h3 id="-logerror--string-"><a class="header" href="#-logerror--string-">{ LogError = "string" }</a></h3>
|
||||
<p>YAML: <code>LogError: string</code></p>
|
||||
<p><strong>YAML:</strong> <code>LogError: string</code></p>
|
||||
<p>Log an error message.</p>
|
||||
<p><strong>YAML Example:</strong> <code>LogError: satellite crashed</code>
|
||||
<strong>Lua Example:</strong> <code>{ LogError = "satellite crashed" }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>LogError: satellite crashed</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ LogError = "satellite crashed" }</code></p>
|
||||
<h3 id="quit"><a class="header" href="#quit">"Quit"</a></h3>
|
||||
<p>YAML: <code>Quit</code></p>
|
||||
<p><strong>YAML:</strong> <code>Quit</code></p>
|
||||
<p>Quit with returncode zero (success).</p>
|
||||
<h3 id="printpwdandquit"><a class="header" href="#printpwdandquit">"PrintPwdAndQuit"</a></h3>
|
||||
<p>YAML: <code>PrintPwdAndQuit</code></p>
|
||||
<p><strong>YAML:</strong> <code>PrintPwdAndQuit</code></p>
|
||||
<p>Print $PWD and quit.</p>
|
||||
<h3 id="printfocuspathandquit"><a class="header" href="#printfocuspathandquit">"PrintFocusPathAndQuit"</a></h3>
|
||||
<p>YAML: <code>PrintFocusPathAndQuit</code></p>
|
||||
<p><strong>YAML:</strong> <code>PrintFocusPathAndQuit</code></p>
|
||||
<p>Print the path under focus and quit. It can be empty string if there's nothing to focus.</p>
|
||||
<h3 id="printselectionandquit"><a class="header" href="#printselectionandquit">"PrintSelectionAndQuit"</a></h3>
|
||||
<p>YAML: <code>PrintSelectionAndQuit</code></p>
|
||||
<p><strong>YAML:</strong> <code>PrintSelectionAndQuit</code></p>
|
||||
<p>Print the selected paths and quit. It can be empty is no path is selected.</p>
|
||||
<h3 id="printresultandquit"><a class="header" href="#printresultandquit">"PrintResultAndQuit"</a></h3>
|
||||
<p>YAML: <code>PrintResultAndQuit</code></p>
|
||||
<p><strong>YAML:</strong> <code>PrintResultAndQuit</code></p>
|
||||
<p>Print the selected paths if it's not empty, else, print the focused node's path.</p>
|
||||
<h3 id="printappstateandquit"><a class="header" href="#printappstateandquit">"PrintAppStateAndQuit"</a></h3>
|
||||
<p>YAML: <code>PrintAppStateAndQuit</code></p>
|
||||
<p><strong>YAML:</strong> <code>PrintAppStateAndQuit</code></p>
|
||||
<p>Print the state of application in YAML format. Helpful for debugging or generating
|
||||
the default configuration file.</p>
|
||||
<h3 id="-debug--string-"><a class="header" href="#-debug--string-">{ Debug = "string" }</a></h3>
|
||||
<p>YAML: <code>Debug: string</code></p>
|
||||
<p><strong>YAML:</strong> <code>Debug: string</code></p>
|
||||
<p>Write the application state to a file, without quitting. Also helpful for debugging.</p>
|
||||
<p><strong>YAML Example:</strong> <code>Debug: /path/to/file</code>
|
||||
<strong>Lua Example:</strong> <code>{ Debug = "/path/to/file" }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>Debug: /path/to/file</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ Debug = "/path/to/file" }</code></p>
|
||||
<h3 id="terminate"><a class="header" href="#terminate">"Terminate"</a></h3>
|
||||
<p>YAML: <code>Terminate</code></p>
|
||||
<p><strong>YAML:</strong> <code>Terminate</code></p>
|
||||
<p>Terminate the application with a non-zero return code.</p>
|
||||
<h2 id="lua-function-calls"><a class="header" href="#lua-function-calls">Lua Function Calls</a></h2>
|
||||
<p>xplr allows users to define lua functions using the <code>xplr.fn.custom</code> Lua API.</p>
|
||||
|
||||
330
en/print.html
330
en/print.html
@ -768,380 +768,380 @@ represented using
|
||||
</ul>
|
||||
<h2 id="full-list-of-messages"><a class="header" href="#full-list-of-messages">Full List of Messages</a></h2>
|
||||
<h3 id="explorepwd"><a class="header" href="#explorepwd">"ExplorePwd"</a></h3>
|
||||
<p>YAML: <code>ExplorePwd</code></p>
|
||||
<p><strong>YAML:</strong> <code>ExplorePwd</code></p>
|
||||
<p>Explore the present working directory and register the filtered nodes.
|
||||
This operation is expensive. So, try to avoid using it too often.</p>
|
||||
<h3 id="explorepwdasync"><a class="header" href="#explorepwdasync">"ExplorePwdAsync"</a></h3>
|
||||
<p>YAML: <code>ExplorePwdAsync</code></p>
|
||||
<p><strong>YAML:</strong> <code>ExplorePwdAsync</code></p>
|
||||
<p>Explore the present working directory and register the filtered nodes asynchronously.
|
||||
This operation happens asynchronously. That means, the xplr directory buffers won't be updated
|
||||
immediately. Hence, it needs to be used with care and probably with special checks in place.
|
||||
To explore <code>$PWD</code> synchronously, use <code>ExplorePwd</code> instead.</p>
|
||||
<h3 id="exploreparentsasync"><a class="header" href="#exploreparentsasync">"ExploreParentsAsync"</a></h3>
|
||||
<p>YAML: <code>ExploreParentsAsync</code></p>
|
||||
<p><strong>YAML:</strong> <code>ExploreParentsAsync</code></p>
|
||||
<p>Explore the present working directory along with its parents and register the filtered nodes.
|
||||
This operation happens asynchronously. That means, the xplr directory buffers won't be updated
|
||||
immediately. Hence, it needs to be used with care and probably with special checks in place.
|
||||
To explore just the <code>$PWD</code> synchronously, use <code>ExplorePwd</code> instead.</p>
|
||||
<h3 id="refresh"><a class="header" href="#refresh">"Refresh"</a></h3>
|
||||
<p>YAML: <code>Refresh</code></p>
|
||||
<p><strong>YAML:</strong> <code>Refresh</code></p>
|
||||
<p>Refresh the UI.
|
||||
But it will not re-explore the directory if the working directory is the same.
|
||||
If there is some change in the working directory and you want to re-explore it,
|
||||
use the <code>Explore</code> message instead.
|
||||
Also, it will not clear the screen. Use <code>ClearScreen</code> for that.</p>
|
||||
<h3 id="clearscreen"><a class="header" href="#clearscreen">"ClearScreen"</a></h3>
|
||||
<p>YAML: <code>ClearScreen</code></p>
|
||||
<p><strong>YAML:</strong> <code>ClearScreen</code></p>
|
||||
<p>Clears the screen.</p>
|
||||
<h3 id="focusnext"><a class="header" href="#focusnext">"FocusNext"</a></h3>
|
||||
<p>YAML: <code>FocusNext</code></p>
|
||||
<p><strong>YAML:</strong> <code>FocusNext</code></p>
|
||||
<p>Focus next node.</p>
|
||||
<h3 id="--focusnextbyrelativeindex--int-"><a class="header" href="#--focusnextbyrelativeindex--int-">: { FocusNextByRelativeIndex = int }</a></h3>
|
||||
<p>YAML: <code>FocusNextByRelativeIndex: int</code></p>
|
||||
<p><strong>YAML:</strong> <code>FocusNextByRelativeIndex: int</code></p>
|
||||
<p>Focus on the <code>n</code>th node relative to the current focus where <code>n</code> is a given value.</p>
|
||||
<p><strong>YAML Example:</strong> <code>FocusNextByRelativeIndex: 2</code>
|
||||
<strong>Lua Example:</strong> <code>{ FocusNextByRelativeIndex = 2 }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>FocusNextByRelativeIndex: 2</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ FocusNextByRelativeIndex = 2 }</code></p>
|
||||
<h3 id="focusnextbyrelativeindexfrominput"><a class="header" href="#focusnextbyrelativeindexfrominput">"FocusNextByRelativeIndexFromInput"</a></h3>
|
||||
<p>YAML: <code>FocusNextByRelativeIndexFromInput</code></p>
|
||||
<p><strong>YAML:</strong> <code>FocusNextByRelativeIndexFromInput</code></p>
|
||||
<p>Focus on the <code>n</code>th node relative to the current focus where <code>n</code> is read from
|
||||
the input buffer.</p>
|
||||
<h3 id="focusprevious"><a class="header" href="#focusprevious">"FocusPrevious"</a></h3>
|
||||
<p>YAML: <code>FocusPrevious</code></p>
|
||||
<p><strong>YAML:</strong> <code>FocusPrevious</code></p>
|
||||
<p>Focus on the previous item.</p>
|
||||
<h3 id="-focuspreviousbyrelativeindex--int-"><a class="header" href="#-focuspreviousbyrelativeindex--int-">{ FocusPreviousByRelativeIndex = int }</a></h3>
|
||||
<p>YAML: <code>FocusPreviousByRelativeIndex: int</code></p>
|
||||
<p><strong>YAML:</strong> <code>FocusPreviousByRelativeIndex: int</code></p>
|
||||
<p>Focus on the <code>-n</code>th node relative to the current focus where <code>n</code> is a given value.</p>
|
||||
<p><strong>YAML Example:</strong> <code>FocusPreviousByRelativeIndex: 2</code>
|
||||
<strong>Lua Example:</strong> <code>{ FocusPreviousByRelativeIndex = 2 }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>FocusPreviousByRelativeIndex: 2</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ FocusPreviousByRelativeIndex = 2 }</code></p>
|
||||
<h3 id="focuspreviousbyrelativeindexfrominput"><a class="header" href="#focuspreviousbyrelativeindexfrominput">"FocusPreviousByRelativeIndexFromInput"</a></h3>
|
||||
<p>YAML: <code>FocusPreviousByRelativeIndexFromInput</code></p>
|
||||
<p><strong>YAML:</strong> <code>FocusPreviousByRelativeIndexFromInput</code></p>
|
||||
<p>Focus on the <code>-n</code>th node relative to the current focus where <code>n</code> is read from
|
||||
the input buffer.</p>
|
||||
<h3 id="focusfirst"><a class="header" href="#focusfirst">"FocusFirst"</a></h3>
|
||||
<p>YAML: <code>FocusFirst</code></p>
|
||||
<p><strong>YAML:</strong> <code>FocusFirst</code></p>
|
||||
<p>Focus on the first node.</p>
|
||||
<h3 id="focuslast"><a class="header" href="#focuslast">"FocusLast"</a></h3>
|
||||
<p>YAML: <code>FocusLast</code></p>
|
||||
<p><strong>YAML:</strong> <code>FocusLast</code></p>
|
||||
<p>Focus on the last node.</p>
|
||||
<h3 id="-focuspath--string-"><a class="header" href="#-focuspath--string-">{ FocusPath = "string" }</a></h3>
|
||||
<p>YAML: <code>FocusPath: string</code></p>
|
||||
<p><strong>YAML:</strong> <code>FocusPath: string</code></p>
|
||||
<p>Focus on the given path.</p>
|
||||
<p><strong>YAML Example:</strong> <code>FocusPath: /path/to/file</code>
|
||||
<strong>Lua Example:</strong> <code>{ FocusPath = "/path/to/file" }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>FocusPath: /path/to/file</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ FocusPath = "/path/to/file" }</code></p>
|
||||
<h3 id="focuspathfrominput"><a class="header" href="#focuspathfrominput">"FocusPathFromInput"</a></h3>
|
||||
<p>YAML: <code>FocusPathFromInput</code></p>
|
||||
<p><strong>YAML:</strong> <code>FocusPathFromInput</code></p>
|
||||
<p>Focus on the path read from input buffer.</p>
|
||||
<h3 id="-focusbyindex--int-"><a class="header" href="#-focusbyindex--int-">{ FocusByIndex = int }</a></h3>
|
||||
<p>YAML: <code>FocusByIndex: int</code></p>
|
||||
<p><strong>YAML:</strong> <code>FocusByIndex: int</code></p>
|
||||
<p>Focus on the absolute <code>n</code>th node where <code>n</code> is a given value.</p>
|
||||
<p><strong>YAML Example:</strong> <code>FocusByIndex: 2</code>
|
||||
<strong>Lua Example:</strong> <code>{ FocusByIndex = 2 }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>FocusByIndex: 2</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ FocusByIndex = 2 }</code></p>
|
||||
<h3 id="focusbyindexfrominput"><a class="header" href="#focusbyindexfrominput">"FocusByIndexFromInput"</a></h3>
|
||||
<p>YAML: <code>FocusByIndexFromInput</code></p>
|
||||
<p><strong>YAML:</strong> <code>FocusByIndexFromInput</code></p>
|
||||
<p>Focus on the absolute <code>n</code>th node where <code>n</code> is read from the input buffer.</p>
|
||||
<h3 id="-focusbyfilename--string-"><a class="header" href="#-focusbyfilename--string-">{ FocusByFileName = "string" }</a></h3>
|
||||
<p>YAML: <code>FocusByFileName: string</code></p>
|
||||
<p><strong>YAML:</strong> <code>FocusByFileName: string</code></p>
|
||||
<p>Focus on the file by name from the present working directory.</p>
|
||||
<p><strong>YAML Example:</strong> <code>FocusByFileName: filename.ext</code>
|
||||
<strong>Lua Example:</strong> <code>{ FocusByFileName = "filename.ext" }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>FocusByFileName: filename.ext</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ FocusByFileName = "filename.ext" }</code></p>
|
||||
<h3 id="-changedirectory--string-"><a class="header" href="#-changedirectory--string-">{ ChangeDirectory = "string" }</a></h3>
|
||||
<p>YAML: <code>ChangeDirectory: string</code></p>
|
||||
<p><strong>YAML:</strong> <code>ChangeDirectory: string</code></p>
|
||||
<p>Change the present working directory ($PWD)</p>
|
||||
<p><strong>YAML Example:</strong> <code>ChangeDirectory: /path/to/directory</code>
|
||||
<strong>Lua Example:</strong> <code>{ ChangeDirectory = "/path/to/directory" }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>ChangeDirectory: /path/to/directory</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ ChangeDirectory = "/path/to/directory" }</code></p>
|
||||
<h3 id="enter"><a class="header" href="#enter">"Enter"</a></h3>
|
||||
<p>YAML: <code>Enter</code></p>
|
||||
<p><strong>YAML:</strong> <code>Enter</code></p>
|
||||
<p>Enter into the currently focused path if it's a directory.</p>
|
||||
<h3 id="back"><a class="header" href="#back">"Back"</a></h3>
|
||||
<p>YAML: <code>Back</code></p>
|
||||
<p><strong>YAML:</strong> <code>Back</code></p>
|
||||
<p>Go back to the parent directory.</p>
|
||||
<h3 id="lastvisitedpath"><a class="header" href="#lastvisitedpath">"LastVisitedPath"</a></h3>
|
||||
<p>YAML: <code>LastVisitedPath</code></p>
|
||||
<p><strong>YAML:</strong> <code>LastVisitedPath</code></p>
|
||||
<p>Go to the last path visited.</p>
|
||||
<h3 id="nextvisitedpath"><a class="header" href="#nextvisitedpath">"NextVisitedPath"</a></h3>
|
||||
<p>YAML: <code>NextVisitedPath</code></p>
|
||||
<p><strong>YAML:</strong> <code>NextVisitedPath</code></p>
|
||||
<p>Go to the next path visited.</p>
|
||||
<h3 id="followsymlink"><a class="header" href="#followsymlink">"FollowSymlink"</a></h3>
|
||||
<p>YAML: <code>FollowSymlink</code></p>
|
||||
<p><strong>YAML:</strong> <code>FollowSymlink</code></p>
|
||||
<p>Follow the symlink under focus to its actual location.</p>
|
||||
<h3 id="-bufferinput--string-"><a class="header" href="#-bufferinput--string-">{ BufferInput = "string" }</a></h3>
|
||||
<p>YAML: <code>BufferInput(String)</code></p>
|
||||
<p><strong>YAML:</strong> <code>BufferInput(String)</code></p>
|
||||
<p>Append/buffer the given string into the input buffer.</p>
|
||||
<p><strong>YAML Example:</strong> <code>BufferInput: foo</code>
|
||||
<strong>Lua Example:</strong> <code>{ BufferInput = "foo" }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>BufferInput: foo</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ BufferInput = "foo" }</code></p>
|
||||
<h3 id="bufferinputfromkey"><a class="header" href="#bufferinputfromkey">"BufferInputFromKey"</a></h3>
|
||||
<p>YAML: <code>BufferInputFromKey</code></p>
|
||||
<p><strong>YAML:</strong> <code>BufferInputFromKey</code></p>
|
||||
<p>Append/buffer the characted read from a keyboard input into the
|
||||
input buffer.</p>
|
||||
<h3 id="-setinputbuffer--string-"><a class="header" href="#-setinputbuffer--string-">{ SetInputBuffer = "string" }</a></h3>
|
||||
<p>YAML: <code>SetInputBuffer: string</code></p>
|
||||
<p><strong>YAML:</strong> <code>SetInputBuffer: string</code></p>
|
||||
<p>Set/rewrite the input buffer with the given string.
|
||||
When the input buffer is not-null (even if empty string)
|
||||
it will show in the UI.</p>
|
||||
<p><strong>YAML Example:</strong> <code>SetInputBuffer: foo</code>
|
||||
<strong>Lua Example:</strong> <code>{ SetInputBuffer = "foo" }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>SetInputBuffer: foo</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ SetInputBuffer = "foo" }</code></p>
|
||||
<h3 id="removeinputbufferlastcharacter"><a class="header" href="#removeinputbufferlastcharacter">"RemoveInputBufferLastCharacter"</a></h3>
|
||||
<p>YAML: <code>RemoveInputBufferLastCharacter</code></p>
|
||||
<p><strong>YAML:</strong> <code>RemoveInputBufferLastCharacter</code></p>
|
||||
<p>Remove input buffer's last character.</p>
|
||||
<h3 id="removeinputbufferlastword"><a class="header" href="#removeinputbufferlastword">"RemoveInputBufferLastWord"</a></h3>
|
||||
<p>YAML: <code>RemoveInputBufferLastWord</code></p>
|
||||
<p><strong>YAML:</strong> <code>RemoveInputBufferLastWord</code></p>
|
||||
<p>Remove input buffer's last word.</p>
|
||||
<h3 id="resetinputbuffer"><a class="header" href="#resetinputbuffer">"ResetInputBuffer"</a></h3>
|
||||
<p>YAML: <code>ResetInputBuffer</code></p>
|
||||
<p><strong>YAML:</strong> <code>ResetInputBuffer</code></p>
|
||||
<p>Reset the input buffer back to null. It will not show in the UI.</p>
|
||||
<h3 id="-switchmode--string-"><a class="header" href="#-switchmode--string-">{ SwitchMode = "string" }</a></h3>
|
||||
<p>YAML: <code>SwitchMode: string</code></p>
|
||||
<p><strong>YAML:</strong> <code>SwitchMode: string</code></p>
|
||||
<p>Switch input <a href="modes.html">mode</a>.</p>
|
||||
<blockquote>
|
||||
<p><strong>NOTE:</strong> To be specific about which mode to switch to, use <code>SwitchModeBuiltin</code> or
|
||||
<code>SwitchModeCustom</code> instead.</p>
|
||||
</blockquote>
|
||||
<p><strong>YAML Example:</strong> <code>SwitchMode: default</code>
|
||||
<strong>Lua Example:</strong> <code>{ SwitchMode = "default" }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>SwitchMode: default</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ SwitchMode = "default" }</code></p>
|
||||
<h3 id="-switchmodebuiltin--string-"><a class="header" href="#-switchmodebuiltin--string-">{ SwitchModeBuiltin = "string" }</a></h3>
|
||||
<p>YAML: <code>SwitchModeBuiltin: string</code></p>
|
||||
<p><strong>YAML:</strong> <code>SwitchModeBuiltin: string</code></p>
|
||||
<p>Switch to a <a href="modes.html#builtin">builtin mode</a>.</p>
|
||||
<p><strong>YAML Example:</strong> <code>SwitchModeBuiltin: default</code>
|
||||
<strong>Lua Example:</strong> <code>{ SwitchModeBuiltin = "default" }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>SwitchModeBuiltin: default</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ SwitchModeBuiltin = "default" }</code></p>
|
||||
<h3 id="-switchmodecustom--string-"><a class="header" href="#-switchmodecustom--string-">{ SwitchModeCustom = "string" }</a></h3>
|
||||
<p>YAML: <code>SwitchModeCustom: string</code></p>
|
||||
<p><strong>YAML:</strong> <code>SwitchModeCustom: string</code></p>
|
||||
<p>Switch to a <a href="modes.html#custom">custom mode</a>.</p>
|
||||
<p><strong>YAML Example:</strong> <code>SwitchModeCustom: my_custom_mode</code>
|
||||
<strong>Lua Example:</strong> <code>{ SwitchModeCustom = "my_custom_mode" }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>SwitchModeCustom: my_custom_mode</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ SwitchModeCustom = "my_custom_mode" }</code></p>
|
||||
<h3 id="popmode"><a class="header" href="#popmode">"PopMode"</a></h3>
|
||||
<p>YAML: <code>PopMode</code></p>
|
||||
<p><strong>YAML:</strong> <code>PopMode</code></p>
|
||||
<p>Pop the last mode from the history and switch to it.</p>
|
||||
<h3 id="-switchlayout--string-"><a class="header" href="#-switchlayout--string-">{ SwitchLayout = "string" }</a></h3>
|
||||
<p>YAML: <code>SwitchLayout: string</code></p>
|
||||
<p><strong>YAML:</strong> <code>SwitchLayout: string</code></p>
|
||||
<p>Switch <a href="layouts.html">layout</a>.</p>
|
||||
<blockquote>
|
||||
<p><strong>NOTE:</strong> To be specific about which layout to switch to, use <code>SwitchLayoutBuiltin</code> or
|
||||
<code>SwitchLayoutCustom</code> instead.</p>
|
||||
</blockquote>
|
||||
<p><strong>YAML Example:</strong> <code>SwitchLayout: default</code>
|
||||
<strong>Lua Example:</strong> <code>{ SwitchLayout = "default" }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>SwitchLayout: default</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ SwitchLayout = "default" }</code></p>
|
||||
<h3 id="-switchlayoutbuiltin--string-"><a class="header" href="#-switchlayoutbuiltin--string-">{ SwitchLayoutBuiltin = "string" }</a></h3>
|
||||
<p>YAML: <code>SwitchLayoutBuiltin: string</code></p>
|
||||
<p><strong>YAML:</strong> <code>SwitchLayoutBuiltin: string</code></p>
|
||||
<p>Switch to a <a href="layouts.html#builtin">builtin layout</a>.</p>
|
||||
<p><strong>YAML Example:</strong> <code>SwitchLayoutBuiltin: default</code>
|
||||
<strong>Lua Example:</strong> <code>{ SwitchLayoutBuiltin = "default" }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>SwitchLayoutBuiltin: default</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ SwitchLayoutBuiltin = "default" }</code></p>
|
||||
<h3 id="-switchlayoutcustom--string-"><a class="header" href="#-switchlayoutcustom--string-">{ SwitchLayoutCustom = "string" }</a></h3>
|
||||
<p>YAML: <code>SwitchLayoutCustom: string</code></p>
|
||||
<p><strong>YAML:</strong> <code>SwitchLayoutCustom: string</code></p>
|
||||
<p>Switch to a <a href="layouts.html#custom">custom layout</a>.</p>
|
||||
<p><strong>YAML Example:</strong> <code>SwitchLayoutCustom: my_custom_layout</code>
|
||||
<strong>Lua Example:</strong> <code>{ SwitchLayoutCustom = "my_custom_layout" }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>SwitchLayoutCustom: my_custom_layout</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ SwitchLayoutCustom = "my_custom_layout" }</code></p>
|
||||
<h3 id="-call--string-"><a class="header" href="#-call--string-">{ Call = "string" }</a></h3>
|
||||
<p>YAML: <code>Call: string</code></p>
|
||||
<p><strong>YAML:</strong> <code>Call: string</code></p>
|
||||
<p>Call a shell command with the given arguments.
|
||||
Note that the arguments will be shell-escaped.
|
||||
So to read the variables, the <code>-c</code> option of the shell
|
||||
can be used.
|
||||
You may need to pass <code>ExplorePwd</code> depening on the expectation.</p>
|
||||
<p><strong>YAML Example:</strong> <code>Call: { command: bash, args: ["-c", "read -p test"] }</code>
|
||||
<strong>Lua Example:</strong> <code>{ Call = { command = "bash", args = { "-c", "read -p test" } } }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>Call: { command: bash, args: ["-c", "read -p test"] }</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ Call = { command = "bash", args = { "-c", "read -p test" } } }</code></p>
|
||||
<h3 id="-callsilently--string-"><a class="header" href="#-callsilently--string-">{ CallSilently = "string" }</a></h3>
|
||||
<p>YAML: <code>CallSilently: string</code></p>
|
||||
<p><strong>YAML:</strong> <code>CallSilently: string</code></p>
|
||||
<p>Like <code>Call</code> but without the flicker. The stdin, stdout
|
||||
stderr will be piped to null. So it's non-interactive.</p>
|
||||
<p><strong>YAML Example:</strong> <code>CallSilently: { command: tput, args: ["bell"] }</code>
|
||||
<strong>Lua Example:</strong> <code>{ CallSilently = { command = "tput", args = { "bell" } } }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>CallSilently: { command: tput, args: ["bell"] }</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ CallSilently = { command = "tput", args = { "bell" } } }</code></p>
|
||||
<h3 id="-calllua--string-"><a class="header" href="#-calllua--string-">{ CallLua = "string" }</a></h3>
|
||||
<p>YAML: <code>CallLua: string</code></p>
|
||||
<p><strong>YAML:</strong> <code>CallLua: string</code></p>
|
||||
<p>Call a Lua function.
|
||||
A <a href="message.html#calllua-argument"><code>CallLuaArg</code></a> object will be passed to the
|
||||
<a href="message.html#lua-function-calls">function</a> as argument.
|
||||
The function can optionally return a list of messages for xplr to handle
|
||||
after the executing the function.</p>
|
||||
<p><strong>YAML Example:</strong> <code>CallLua: custom.some_custom_funtion</code>
|
||||
<strong>Lua Example:</strong> <code>{ CallLua = "custom.some_custom_funtion" }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>CallLua: custom.some_custom_funtion</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ CallLua = "custom.some_custom_funtion" }</code></p>
|
||||
<h3 id="-callluasilently--string-"><a class="header" href="#-callluasilently--string-">{ CallLuaSilently = "string" }</a></h3>
|
||||
<p>YAML: <code>CallLuaSilently: string</code></p>
|
||||
<p><strong>YAML:</strong> <code>CallLuaSilently: string</code></p>
|
||||
<p>Like <code>CallLua</code> but without the flicker. The stdin, stdout
|
||||
stderr will be piped to null. So it's non-interactive.</p>
|
||||
<p><strong>YAML Example:</strong> <code>CallLuaSilently: custom.some_custom_function</code>
|
||||
<strong>Lua Example:</strong> <code>{ CallLuaSilently = "custom.some_custom_function" }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>CallLuaSilently: custom.some_custom_function</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ CallLuaSilently = "custom.some_custom_function" }</code></p>
|
||||
<h3 id="-bashexec--string-"><a class="header" href="#-bashexec--string-">{ BashExec = "string" }</a></h3>
|
||||
<p>YAML: <code>BashExec: string</code></p>
|
||||
<p><strong>YAML:</strong> <code>BashExec: string</code></p>
|
||||
<p>An alias to <code>Call: {command: bash, args: ["-c", "{string}"], silent: false}</code>
|
||||
where <code>{string}</code> is the given value.</p>
|
||||
<p><strong>YAML Example:</strong> <code>BashExec: "read -p test"</code>
|
||||
<strong>Lua Example:</strong> <code>{ BashExec = "read -p test" }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>BashExec: "read -p test"</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ BashExec = "read -p test" }</code></p>
|
||||
<h3 id="-bashexecsilently--string-"><a class="header" href="#-bashexecsilently--string-">{ BashExecSilently = "string" }</a></h3>
|
||||
<p>YAML: <code>BashExecSilently(String)</code></p>
|
||||
<p><strong>YAML:</strong> <code>BashExecSilently(String)</code></p>
|
||||
<p>Like <code>BashExec</code> but without the flicker. The stdin, stdout
|
||||
stderr will be piped to null. So it's non-interactive.</p>
|
||||
<p><strong>YAML Example:</strong> <code>BashExecSilently: "tput bell"</code>
|
||||
<strong>Lua Example:</strong> <code>{ BashExecSilently = "tput bell" }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>BashExecSilently: "tput bell"</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ BashExecSilently = "tput bell" }</code></p>
|
||||
<h3 id="select"><a class="header" href="#select">"Select"</a></h3>
|
||||
<p>YAML: <code>Select</code></p>
|
||||
<p><strong>YAML:</strong> <code>Select</code></p>
|
||||
<p>Select the focused node.</p>
|
||||
<h3 id="selectall"><a class="header" href="#selectall">"SelectAll"</a></h3>
|
||||
<p>YAML: <code>SelectAll</code></p>
|
||||
<p><strong>YAML:</strong> <code>SelectAll</code></p>
|
||||
<p>Select all the visible nodes.</p>
|
||||
<h3 id="-selectpath--string-"><a class="header" href="#-selectpath--string-">{ SelectPath = "string" }</a></h3>
|
||||
<p>YAML: <code>SelectPath: string</code></p>
|
||||
<p><strong>YAML:</strong> <code>SelectPath: string</code></p>
|
||||
<p>Select the given path.</p>
|
||||
<p><strong>YAML Example:</strong> <code>SelectPath: /path/to/file</code>
|
||||
<strong>Lua Example:</strong> <code>{ SelectPath = "/path/to/file" }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>SelectPath: /path/to/file</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ SelectPath = "/path/to/file" }</code></p>
|
||||
<h3 id="unselect"><a class="header" href="#unselect">"UnSelect"</a></h3>
|
||||
<p>YAML: <code>UnSelect</code></p>
|
||||
<p><strong>YAML:</strong> <code>UnSelect</code></p>
|
||||
<p>Unselect the focused node.</p>
|
||||
<h3 id="unselectall"><a class="header" href="#unselectall">"UnSelectAll"</a></h3>
|
||||
<p>YAML: <code>UnSelectAll</code></p>
|
||||
<p><strong>YAML:</strong> <code>UnSelectAll</code></p>
|
||||
<p>Unselect all the visible nodes.</p>
|
||||
<h3 id="-unselectpath--string-"><a class="header" href="#-unselectpath--string-">{ UnSelectPath = "string)" }</a></h3>
|
||||
<p>YAML: <code>UnSelectPath: string</code></p>
|
||||
<p><strong>YAML:</strong> <code>UnSelectPath: string</code></p>
|
||||
<p>UnSelect the given path.</p>
|
||||
<p><strong>YAML Example:</strong> <code>UnSelectPath: /path/to/file</code>
|
||||
<strong>Lua Example:</strong> <code>{ UnSelectPath = "/path/to/file" }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>UnSelectPath: /path/to/file</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ UnSelectPath = "/path/to/file" }</code></p>
|
||||
<h3 id="toggleselection"><a class="header" href="#toggleselection">"ToggleSelection"</a></h3>
|
||||
<p>YAML: <code>ToggleSelection</code></p>
|
||||
<p><strong>YAML:</strong> <code>ToggleSelection</code></p>
|
||||
<p>Toggle selection on the focused node.</p>
|
||||
<h3 id="toggleselectall"><a class="header" href="#toggleselectall">"ToggleSelectAll"</a></h3>
|
||||
<p>YAML: <code>ToggleSelectAll</code></p>
|
||||
<p><strong>YAML:</strong> <code>ToggleSelectAll</code></p>
|
||||
<p>Toggle between select all and unselect all.</p>
|
||||
<h3 id="-toggleselectionbypath--string-"><a class="header" href="#-toggleselectionbypath--string-">{ ToggleSelectionByPath = "string" }</a></h3>
|
||||
<p>YAML: <code>ToggleSelectionByPath: string</code></p>
|
||||
<p><strong>YAML:</strong> <code>ToggleSelectionByPath: string</code></p>
|
||||
<p>Toggle selection by file path.</p>
|
||||
<p><strong>YAML Example:</strong> <code>ToggleSelectionByPath: /path/to/file</code>
|
||||
<strong>Lua Example:</strong> <code>{ ToggleSelectionByPath = "/path/to/file" }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>ToggleSelectionByPath: /path/to/file</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ ToggleSelectionByPath = "/path/to/file" }</code></p>
|
||||
<h3 id="clearselection"><a class="header" href="#clearselection">"ClearSelection"</a></h3>
|
||||
<p>YAML: <code>ClearSelection</code></p>
|
||||
<p><strong>YAML:</strong> <code>ClearSelection</code></p>
|
||||
<p>Clear the selection.</p>
|
||||
<h3 id="-addnodefilter---filter--a-hreffilteringhtmlfilternodefiltera-input--string-"><a class="header" href="#-addnodefilter---filter--a-hreffilteringhtmlfilternodefiltera-input--string-">{ AddNodeFilter = { filter = "<a href="filtering.html#filter">NodeFilter</a>", input = "string" }</a></h3>
|
||||
<p>YAML: <code>AddNodeFilter: { filter = [NodeFilter](filtering.md#filter), input = string</code></p>
|
||||
<p><strong>YAML:</strong> <code>AddNodeFilter: { filter = [NodeFilter](filtering.md#filter), input = string</code></p>
|
||||
<p>Add a <a href="filtering.html">filter</a> to exclude nodes while exploring directories.</p>
|
||||
<p><strong>YAML Example:</strong> <code>AddNodeFilter: { filter: RelativePathDoesStartWith, input: foo }</code>
|
||||
<strong>Lua Example:</strong> <code>{ AddNodeFilter = { filter = "RelativePathDoesStartWith", input = "foo" }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>AddNodeFilter: { filter: RelativePathDoesStartWith, input: foo }</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ AddNodeFilter = { filter = "RelativePathDoesStartWith", input = "foo" }</code></p>
|
||||
<h3 id="-removenodefilter---filter--a-hreffilteringhtmlfilternodefiltera-input--string-"><a class="header" href="#-removenodefilter---filter--a-hreffilteringhtmlfilternodefiltera-input--string-">{ RemoveNodeFilter = { filter = "<a href="filtering.html#filter">NodeFilter</a>", input = "string" }</a></h3>
|
||||
<p>YAML: <code>RemoveNodeFilter: { filter = [NodeFilter](filtering.md#filter), input = string</code></p>
|
||||
<p><strong>YAML:</strong> <code>RemoveNodeFilter: { filter = [NodeFilter](filtering.md#filter), input = string</code></p>
|
||||
<p>Remove an existing <a href="filtering.html">filter</a>.</p>
|
||||
<p><strong>YAML Example:</strong> <code>RemoveNodeFilter: { filter: RelativePathDoesStartWith, input: foo }</code>
|
||||
<strong>Lua Example:</strong> <code>{ RemoveNodeFilter: { filter: "RelativePathDoesStartWith", input: "foo" } }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>RemoveNodeFilter: { filter: RelativePathDoesStartWith, input: foo }</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ RemoveNodeFilter: { filter: "RelativePathDoesStartWith", input: "foo" } }</code></p>
|
||||
<h3 id="-togglenodefilter---filter--a-hreffilteringhtmlfilternodefiltera-input--string-"><a class="header" href="#-togglenodefilter---filter--a-hreffilteringhtmlfilternodefiltera-input--string-">{ ToggleNodeFilter = { filter = "<a href="filtering.html#filter">NodeFilter</a>", input = "string" }</a></h3>
|
||||
<p>YAML: <code>ToggleNodeFilter: { filter = [NodeFilter](filtering.md#filter), input = string</code></p>
|
||||
<p><strong>YAML:</strong> <code>ToggleNodeFilter: { filter = [NodeFilter](filtering.md#filter), input = string</code></p>
|
||||
<p>Remove a <a href="filter.html">filter</a> if it exists, else, add a it.</p>
|
||||
<p><strong>YAML Example:</strong> <code>ToggleNodeFilter: { filter: RelativePathDoesStartWith, input: foo }</code>
|
||||
<strong>Lua Example:</strong> <code>{ ToggleNodeFilter = { filter = "RelativePathDoesStartWith", input = "foo" } }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>ToggleNodeFilter: { filter: RelativePathDoesStartWith, input: foo }</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ ToggleNodeFilter = { filter = "RelativePathDoesStartWith", input = "foo" } }</code></p>
|
||||
<h3 id="-addnodefilterfrominput--a-hreffilteringhtmlfilternodefiltera-"><a class="header" href="#-addnodefilterfrominput--a-hreffilteringhtmlfilternodefiltera-">{ AddNodeFilterFromInput = "<a href="filtering.html#filter">NodeFilter</a>" }</a></h3>
|
||||
<p>YAML: <code>AddNodeFilterFromInput: [NodeFilter](filtering.md#filter)</code></p>
|
||||
<p><strong>YAML:</strong> <code>AddNodeFilterFromInput: [NodeFilter](filtering.md#filter)</code></p>
|
||||
<p>Add a node <a href="filtering.html">filter</a> reading the input from the buffer.</p>
|
||||
<p><strong>YAML Example:</strong> <code>AddNodeFilterFromInput: RelativePathDoesStartWith</code>
|
||||
<strong>Lua Example:</strong> <code>{ AddNodeFilterFromInput = "RelativePathDoesStartWith" }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>AddNodeFilterFromInput: RelativePathDoesStartWith</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ AddNodeFilterFromInput = "RelativePathDoesStartWith" }</code></p>
|
||||
<h3 id="-removenodefilterfrominput--a-hreffilteringhtmlfilternodefiltera-"><a class="header" href="#-removenodefilterfrominput--a-hreffilteringhtmlfilternodefiltera-">{ RemoveNodeFilterFromInput = "<a href="filtering.html#filter">NodeFilter</a>" }</a></h3>
|
||||
<p>YAML: <code>RemoveNodeFilterFromInput: [NodeFilter](filtering.md#filter)</code></p>
|
||||
<p><strong>YAML:</strong> <code>RemoveNodeFilterFromInput: [NodeFilter](filtering.md#filter)</code></p>
|
||||
<p>Remove a node <a href="filtering.html">filter</a> reading the input from the buffer.</p>
|
||||
<p><strong>YAML Example:</strong> <code>RemoveNodeFilterFromInput: RelativePathDoesStartWith</code>
|
||||
<strong>Lua Example:</strong> <code>{ RemoveNodeFilterFromInput = "RelativePathDoesStartWith" }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>RemoveNodeFilterFromInput: RelativePathDoesStartWith</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ RemoveNodeFilterFromInput = "RelativePathDoesStartWith" }</code></p>
|
||||
<h3 id="removelastnodefilter"><a class="header" href="#removelastnodefilter">"RemoveLastNodeFilter"</a></h3>
|
||||
<p>YAML: <code>RemoveLastNodeFilter</code></p>
|
||||
<p><strong>YAML:</strong> <code>RemoveLastNodeFilter</code></p>
|
||||
<p>Remove the last node <a href="filtering.html">filter</a>.</p>
|
||||
<h3 id="resetnodefilters"><a class="header" href="#resetnodefilters">"ResetNodeFilters"</a></h3>
|
||||
<p>YAML: <code>ResetNodeFilters</code></p>
|
||||
<p><strong>YAML:</strong> <code>ResetNodeFilters</code></p>
|
||||
<p>Reset the node <a href="filtering.html">filters</a> back to the default configuration.</p>
|
||||
<h3 id="clearnodefilters"><a class="header" href="#clearnodefilters">"ClearNodeFilters"</a></h3>
|
||||
<p>YAML: <code>ClearNodeFilters</code></p>
|
||||
<p><strong>YAML:</strong> <code>ClearNodeFilters</code></p>
|
||||
<p>Clear all the node <a href="filtering.html">filters</a>.</p>
|
||||
<h3 id="-addnodesorter---sorter--a-hrefsortinghtmlsorternodesortera-reverse--bool--"><a class="header" href="#-addnodesorter---sorter--a-hrefsortinghtmlsorternodesortera-reverse--bool--">{ AddNodeSorter = { sorter = "<a href="sorting.html#sorter">NodeSorter</a>", reverse = bool } }</a></h3>
|
||||
<p>YAML: <code>AddNodeSorter: { sorter: [NodeSorter](sorting.md#sorter), reverse = bool }</code></p>
|
||||
<p><strong>YAML:</strong> <code>AddNodeSorter: { sorter: [NodeSorter](sorting.md#sorter), reverse = bool }</code></p>
|
||||
<p>Add a <a href="sorting.html#sorter">sorter</a> to sort nodes while exploring directories.</p>
|
||||
<p><strong>YAML Example:</strong> <code>AddNodeSorter: { sorter: ByRelativePath, reverse: false }</code>
|
||||
<strong>YAML Example:</strong> <code>{ AddNodeSorter = { sorter = "ByRelativePath", reverse = false } }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>AddNodeSorter: { sorter: ByRelativePath, reverse: false }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>{ AddNodeSorter = { sorter = "ByRelativePath", reverse = false } }</code></p>
|
||||
<h3 id="-removenodesorter--a-hrefsortinghtmlsorternodesortera-"><a class="header" href="#-removenodesorter--a-hrefsortinghtmlsorternodesortera-">{ RemoveNodeSorter = "<a href="sorting.html#sorter">NodeSorter</a>" }</a></h3>
|
||||
<p>YAML: <code>RemoveNodeSorter: [NodeSorter](sorting.md#sorter)</code></p>
|
||||
<p><strong>YAML:</strong> <code>RemoveNodeSorter: [NodeSorter](sorting.md#sorter)</code></p>
|
||||
<p>Remove an existing <a href="sorting.html#sorter">sorter</a>.</p>
|
||||
<p><strong>YAML Example:</strong> <code>RemoveNodeSorter: ByRelativePath</code>
|
||||
<strong>Lua Example:</strong> <code>{ RemoveNodeSorter = "ByRelativePath" }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>RemoveNodeSorter: ByRelativePath</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ RemoveNodeSorter = "ByRelativePath" }</code></p>
|
||||
<h3 id="-reversenodesorter--a-hrefsortinghtmlsorternodesortera-"><a class="header" href="#-reversenodesorter--a-hrefsortinghtmlsorternodesortera-">{ ReverseNodeSorter = "<a href="sorting.html#sorter">NodeSorter</a>" }</a></h3>
|
||||
<p>YAML: <code>ReverseNodeSorter: [NodeSorter](sorting.md#sorter)</code></p>
|
||||
<p><strong>YAML:</strong> <code>ReverseNodeSorter: [NodeSorter](sorting.md#sorter)</code></p>
|
||||
<p>Reverse a node <a href="sorting.html#sorter">sorter</a>.</p>
|
||||
<p><strong>YAML Example:</strong> <code>ReverseNodeSorter: ByRelativePath</code>
|
||||
<strong>Lua Example:</strong> <code>{ ReverseNodeSorter = "ByRelativePath" }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>ReverseNodeSorter: ByRelativePath</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ ReverseNodeSorter = "ByRelativePath" }</code></p>
|
||||
<h3 id="-togglenodesorter---sorter--a-hrefsortinghtmlsorternodesortera-reverse--bool--"><a class="header" href="#-togglenodesorter---sorter--a-hrefsortinghtmlsorternodesortera-reverse--bool--">{ ToggleNodeSorter = { sorter = "<a href="sorting.html#sorter">NodeSorter</a>", reverse = bool } }</a></h3>
|
||||
<p>YAML: <code>ToggleNodeSorter: { sorter: [NodeSorter](sorting.md#sorter), reverse = bool }</code></p>
|
||||
<p><strong>YAML:</strong> <code>ToggleNodeSorter: { sorter: [NodeSorter](sorting.md#sorter), reverse = bool }</code></p>
|
||||
<p>Remove a <a href="message.html#sorting.md#sorter">sorter</a> if it exists, else, add a it.</p>
|
||||
<p><strong>YAML Example:</strong> <code>ToggleSorterSorter: {sorter: ByRelativePath, reverse: false }</code>
|
||||
<strong>Lua Example:</strong> <code>{ ToggleSorterSorter: { sorter = "ByRelativePath", reverse = false } }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>ToggleSorterSorter: {sorter: ByRelativePath, reverse: false }</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ ToggleSorterSorter: { sorter = "ByRelativePath", reverse = false } }</code></p>
|
||||
<h3 id="reversenodesorters"><a class="header" href="#reversenodesorters">"ReverseNodeSorters"</a></h3>
|
||||
<p>YAML: <code>ReverseNodeSorters</code></p>
|
||||
<p><strong>YAML:</strong> <code>ReverseNodeSorters</code></p>
|
||||
<p>Reverse the node <a href="sorting.html#sorter">sorters</a>.</p>
|
||||
<h3 id="removelastnodesorter"><a class="header" href="#removelastnodesorter">"RemoveLastNodeSorter"</a></h3>
|
||||
<p>YAML: <code>RemoveLastNodeSorter</code></p>
|
||||
<p><strong>YAML:</strong> <code>RemoveLastNodeSorter</code></p>
|
||||
<p>Remove the last node <a href="sorting.html#sorter">sorter</a>.</p>
|
||||
<h3 id="resetnodesorters"><a class="header" href="#resetnodesorters">"ResetNodeSorters"</a></h3>
|
||||
<p>YAML: <code>ResetNodeSorters</code></p>
|
||||
<p><strong>YAML:</strong> <code>ResetNodeSorters</code></p>
|
||||
<p>Reset the node <a href="sorting.html#sorter">sorters</a> back to the default configuration.</p>
|
||||
<h3 id="clearnodesorters"><a class="header" href="#clearnodesorters">"ClearNodeSorters"</a></h3>
|
||||
<p>YAML: <code>ClearNodeSorters</code></p>
|
||||
<p><strong>YAML:</strong> <code>ClearNodeSorters</code></p>
|
||||
<p>Clear all the node <a href="sorting.html#sorter">sorters</a>.</p>
|
||||
<h3 id="enablemouse"><a class="header" href="#enablemouse">"EnableMouse"</a></h3>
|
||||
<p>YAML: <code>EnableMouse</code></p>
|
||||
<p><strong>YAML:</strong> <code>EnableMouse</code></p>
|
||||
<p>Enable mouse</p>
|
||||
<h3 id="disablemouse"><a class="header" href="#disablemouse">"DisableMouse"</a></h3>
|
||||
<p>YAML: <code>DisableMouse</code></p>
|
||||
<p><strong>YAML:</strong> <code>DisableMouse</code></p>
|
||||
<p>Disable mouse</p>
|
||||
<h3 id="togglemouse"><a class="header" href="#togglemouse">"ToggleMouse"</a></h3>
|
||||
<p>YAML: <code>ToggleMouse</code></p>
|
||||
<p><strong>YAML:</strong> <code>ToggleMouse</code></p>
|
||||
<p>Toggle mouse</p>
|
||||
<h3 id="-startfifo--string-"><a class="header" href="#-startfifo--string-">{ StartFifo = "string" }</a></h3>
|
||||
<p>YAML: <code>StartFifo: string</code></p>
|
||||
<p><strong>YAML:</strong> <code>StartFifo: string</code></p>
|
||||
<p>Start piping the focused path to the given fifo path</p>
|
||||
<p><strong>YAML Example:</strong> <code>StartFifo: /tmp/xplr.fifo</code>
|
||||
<strong>Lua Example:</strong> <code>{ StartFifo = "/tmp/xplr.fifo }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>StartFifo: /tmp/xplr.fifo</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ StartFifo = "/tmp/xplr.fifo }</code></p>
|
||||
<h3 id="stopfifo"><a class="header" href="#stopfifo">"StopFifo"</a></h3>
|
||||
<p>YAML: <code>StopFifo</code></p>
|
||||
<p><strong>YAML:</strong> <code>StopFifo</code></p>
|
||||
<p>Close the active fifo and stop piping.</p>
|
||||
<h3 id="-togglefifo--string-"><a class="header" href="#-togglefifo--string-">{ ToggleFifo = "string" }</a></h3>
|
||||
<p>YAML: <code>ToggleFifo: string</code></p>
|
||||
<p><strong>YAML:</strong> <code>ToggleFifo: string</code></p>
|
||||
<p>Toggle betwen {Start|Stop}Fifo</p>
|
||||
<p><strong>YAML Example:</strong> <code>ToggleFifo: /path/to/fifo</code>
|
||||
<strong>Lua Example:</strong> <code>{ ToggleFifo = "/path/to/fifo" }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>ToggleFifo: /path/to/fifo</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ ToggleFifo = "/path/to/fifo" }</code></p>
|
||||
<h3 id="-loginfo--string-"><a class="header" href="#-loginfo--string-">{ LogInfo = "string" }</a></h3>
|
||||
<p>YAML: <code>LogInfo: string</code></p>
|
||||
<p><strong>YAML:</strong> <code>LogInfo: string</code></p>
|
||||
<p>Log information message.</p>
|
||||
<p><strong>YAML Example:</strong> <code>LogInfo: launching satellite</code>
|
||||
<strong>Lua Example:</strong> <code>{ LogInfo = "launching satellite" }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>LogInfo: launching satellite</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ LogInfo = "launching satellite" }</code></p>
|
||||
<h3 id="-logsuccess--string-"><a class="header" href="#-logsuccess--string-">{ LogSuccess = "String" }</a></h3>
|
||||
<p>YAML: <code>LogSuccess: string</code></p>
|
||||
<p><strong>YAML:</strong> <code>LogSuccess: string</code></p>
|
||||
<p>Log a success message.</p>
|
||||
<p><strong>YAML Example:</strong> <code>LogSuccess: satellite reached destination</code>.
|
||||
<strong>Lua Example:</strong> <code>{ LogSuccess = "satellite reached destination" }</code>.</p>
|
||||
<p><strong>YAML Example:</strong> <code>LogSuccess: satellite reached destination</code>.</p>
|
||||
<p><strong>Lua Example:</strong> <code>{ LogSuccess = "satellite reached destination" }</code>.</p>
|
||||
<h3 id="-logwarning--string-"><a class="header" href="#-logwarning--string-">{ LogWarning = "string" }</a></h3>
|
||||
<p>YAML: <code>LogWarning: string</code></p>
|
||||
<p><strong>YAML:</strong> <code>LogWarning: string</code></p>
|
||||
<p>Log an warning message.</p>
|
||||
<p><strong>YAML Example:</strong> <code>LogWarning: satellite is heating</code>
|
||||
<strong>Lua Example:</strong> <code>{ LogWarning = "satellite is heating" }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>LogWarning: satellite is heating</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ LogWarning = "satellite is heating" }</code></p>
|
||||
<h3 id="-logerror--string-"><a class="header" href="#-logerror--string-">{ LogError = "string" }</a></h3>
|
||||
<p>YAML: <code>LogError: string</code></p>
|
||||
<p><strong>YAML:</strong> <code>LogError: string</code></p>
|
||||
<p>Log an error message.</p>
|
||||
<p><strong>YAML Example:</strong> <code>LogError: satellite crashed</code>
|
||||
<strong>Lua Example:</strong> <code>{ LogError = "satellite crashed" }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>LogError: satellite crashed</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ LogError = "satellite crashed" }</code></p>
|
||||
<h3 id="quit"><a class="header" href="#quit">"Quit"</a></h3>
|
||||
<p>YAML: <code>Quit</code></p>
|
||||
<p><strong>YAML:</strong> <code>Quit</code></p>
|
||||
<p>Quit with returncode zero (success).</p>
|
||||
<h3 id="printpwdandquit"><a class="header" href="#printpwdandquit">"PrintPwdAndQuit"</a></h3>
|
||||
<p>YAML: <code>PrintPwdAndQuit</code></p>
|
||||
<p><strong>YAML:</strong> <code>PrintPwdAndQuit</code></p>
|
||||
<p>Print $PWD and quit.</p>
|
||||
<h3 id="printfocuspathandquit"><a class="header" href="#printfocuspathandquit">"PrintFocusPathAndQuit"</a></h3>
|
||||
<p>YAML: <code>PrintFocusPathAndQuit</code></p>
|
||||
<p><strong>YAML:</strong> <code>PrintFocusPathAndQuit</code></p>
|
||||
<p>Print the path under focus and quit. It can be empty string if there's nothing to focus.</p>
|
||||
<h3 id="printselectionandquit"><a class="header" href="#printselectionandquit">"PrintSelectionAndQuit"</a></h3>
|
||||
<p>YAML: <code>PrintSelectionAndQuit</code></p>
|
||||
<p><strong>YAML:</strong> <code>PrintSelectionAndQuit</code></p>
|
||||
<p>Print the selected paths and quit. It can be empty is no path is selected.</p>
|
||||
<h3 id="printresultandquit"><a class="header" href="#printresultandquit">"PrintResultAndQuit"</a></h3>
|
||||
<p>YAML: <code>PrintResultAndQuit</code></p>
|
||||
<p><strong>YAML:</strong> <code>PrintResultAndQuit</code></p>
|
||||
<p>Print the selected paths if it's not empty, else, print the focused node's path.</p>
|
||||
<h3 id="printappstateandquit"><a class="header" href="#printappstateandquit">"PrintAppStateAndQuit"</a></h3>
|
||||
<p>YAML: <code>PrintAppStateAndQuit</code></p>
|
||||
<p><strong>YAML:</strong> <code>PrintAppStateAndQuit</code></p>
|
||||
<p>Print the state of application in YAML format. Helpful for debugging or generating
|
||||
the default configuration file.</p>
|
||||
<h3 id="-debug--string-"><a class="header" href="#-debug--string-">{ Debug = "string" }</a></h3>
|
||||
<p>YAML: <code>Debug: string</code></p>
|
||||
<p><strong>YAML:</strong> <code>Debug: string</code></p>
|
||||
<p>Write the application state to a file, without quitting. Also helpful for debugging.</p>
|
||||
<p><strong>YAML Example:</strong> <code>Debug: /path/to/file</code>
|
||||
<strong>Lua Example:</strong> <code>{ Debug = "/path/to/file" }</code></p>
|
||||
<p><strong>YAML Example:</strong> <code>Debug: /path/to/file</code></p>
|
||||
<p><strong>Lua Example:</strong> <code>{ Debug = "/path/to/file" }</code></p>
|
||||
<h3 id="terminate"><a class="header" href="#terminate">"Terminate"</a></h3>
|
||||
<p>YAML: <code>Terminate</code></p>
|
||||
<p><strong>YAML:</strong> <code>Terminate</code></p>
|
||||
<p>Terminate the application with a non-zero return code.</p>
|
||||
<h2 id="lua-function-calls"><a class="header" href="#lua-function-calls">Lua Function Calls</a></h2>
|
||||
<p>xplr allows users to define lua functions using the <code>xplr.fn.custom</code> Lua API.</p>
|
||||
|
||||
Loading…
Reference in New Issue
Block a user