|
|
|
|
@ -1506,9 +1506,8 @@ stderr will be piped to null. So it's non-interactive.</p>
|
|
|
|
|
<p><strong>Lua Example:</strong> <code>{ BashExecSilently = "tput bell" }</code></p>
|
|
|
|
|
<h3 id="-calllua--string-"><a class="header" href="#-calllua--string-">{ CallLua = "string" }</a></h3>
|
|
|
|
|
<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.
|
|
|
|
|
<p>Call a Lua function.</p>
|
|
|
|
|
<p>A <a href="message.html#lua-context">Lua Context</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></p>
|
|
|
|
|
@ -1521,8 +1520,8 @@ stderr will be piped to null. So it's non-interactive.</p>
|
|
|
|
|
<p><strong>Lua Example:</strong> <code>{ CallLuaSilently = "custom.some_custom_function" }</code></p>
|
|
|
|
|
<h3 id="-luaeval--string-"><a class="header" href="#-luaeval--string-">{ LuaEval = "string" }</a></h3>
|
|
|
|
|
<p><strong>YAML:</strong> <code>LuaEval: string</code></p>
|
|
|
|
|
<p>Execute Lua code without needing to define a function.
|
|
|
|
|
However, <code>CallLuaArg</code> won't be available.</p>
|
|
|
|
|
<p>Execute Lua code without needing to define a function. However,
|
|
|
|
|
<a href="message.html#lua-context">Lua Context</a> won't be available.</p>
|
|
|
|
|
<p><strong>YAML Example:</strong> <code>LuaEval: "return { { LogInfo = io.read() } }"</code></p>
|
|
|
|
|
<p><strong>Lua Example:</strong> <code>{ LuaEval = [[return { { LogInfo = io.read() } }]] }</code></p>
|
|
|
|
|
<h3 id="-luaevalsilently--string-"><a class="header" href="#-luaevalsilently--string-">{ LuaEvalSilently = "string" }</a></h3>
|
|
|
|
|
@ -1722,16 +1721,15 @@ the default configuration file.</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>
|
|
|
|
|
<p>These functions can be called using messages like <code>CallLua</code>, <code>CallLuaSilently</code>.</p>
|
|
|
|
|
<p>When called the function receives a <a href="message.html#calllua-argument">special argument</a> that
|
|
|
|
|
<p>When called the function receives a <a href="message.html#lua-context">special argument</a> that
|
|
|
|
|
contains some useful information. The function can optionally return a list of
|
|
|
|
|
messages which will be handled by xplr.</p>
|
|
|
|
|
<h3 id="calllua-argument"><a class="header" href="#calllua-argument">CallLua Argument</a></h3>
|
|
|
|
|
<h3 id="lua-context"><a class="header" href="#lua-context">Lua Context</a></h3>
|
|
|
|
|
<p>This is a special argument passed to the lua functions when called using the
|
|
|
|
|
<code>CallLua</code>, <code>CallLuaSilently</code> messages.</p>
|
|
|
|
|
<p>It contains the following information:</p>
|
|
|
|
|
<ul>
|
|
|
|
|
<li><a href="message.html#version">version</a></li>
|
|
|
|
|
<li><a href="message.html#config">config</a></li>
|
|
|
|
|
<li><a href="message.html#pwd">pwd</a></li>
|
|
|
|
|
<li><a href="message.html#focused_node">focused_node</a></li>
|
|
|
|
|
<li><a href="message.html#directory_buffer">directory_buffer</a></li>
|
|
|
|
|
@ -1748,9 +1746,6 @@ messages which will be handled by xplr.</p>
|
|
|
|
|
<h3 id="version"><a class="header" href="#version">version</a></h3>
|
|
|
|
|
<p>Type: string</p>
|
|
|
|
|
<p>xplr version. Can be used to test compatibility.</p>
|
|
|
|
|
<h3 id="config-1"><a class="header" href="#config-1">config</a></h3>
|
|
|
|
|
<p>Type: <a href="configuration.html#config">Config</a></p>
|
|
|
|
|
<p>The loaded configuration.</p>
|
|
|
|
|
<h3 id="pwd"><a class="header" href="#pwd">pwd</a></h3>
|
|
|
|
|
<p>Type: string</p>
|
|
|
|
|
<p>The present working directory/</p>
|
|
|
|
|
@ -1758,7 +1753,7 @@ messages which will be handled by xplr.</p>
|
|
|
|
|
<p>Type: nullable <a href="message.html#node">Node</a></p>
|
|
|
|
|
<p>The node under focus.</p>
|
|
|
|
|
<h3 id="directory_buffer"><a class="header" href="#directory_buffer">directory_buffer</a></h3>
|
|
|
|
|
<p>Type: nullable <a href="message.html#directorybuffer">DirectoryBuffer</a></p>
|
|
|
|
|
<p>Type: nullable <a href="message.html#directory-buffer">Directory Buffer</a></p>
|
|
|
|
|
<p>The directory buffer being rendered.</p>
|
|
|
|
|
<h3 id="selection"><a class="header" href="#selection">selection</a></h3>
|
|
|
|
|
<p>Type: list of selected <a href="message.html#node">Node</a>s</p>
|
|
|
|
|
@ -1854,7 +1849,7 @@ node. It will instead be null.</p>
|
|
|
|
|
<li><a href="message.html#canonical">canonical</a></li>
|
|
|
|
|
<li><a href="message.html#symlink">symlink</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
<h3 id="directorybuffer"><a class="header" href="#directorybuffer">DirectoryBuffer</a></h3>
|
|
|
|
|
<h3 id="directory-buffer"><a class="header" href="#directory-buffer">Directory Buffer</a></h3>
|
|
|
|
|
<p>Directory buffer contains the following fields:</p>
|
|
|
|
|
<ul>
|
|
|
|
|
<li><a href="message.html#parent">parent</a></li>
|
|
|
|
|
@ -2310,9 +2305,9 @@ content body for the custom dynamic layouts.</p>
|
|
|
|
|
<ul>
|
|
|
|
|
<li><a href="layouts.html#size">layout_size</a></li>
|
|
|
|
|
<li><a href="layouts.html#size">screen_size</a></li>
|
|
|
|
|
<li><a href="message.html#calllua-argument">app</a></li>
|
|
|
|
|
<li><a href="layouts.html#app">app</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
<h2 id="size-1"><a class="header" href="#size-1">Size</a></h2>
|
|
|
|
|
<h3 id="size-1"><a class="header" href="#size-1">Size</a></h3>
|
|
|
|
|
<p>It contains the following information:</p>
|
|
|
|
|
<ul>
|
|
|
|
|
<li>x</li>
|
|
|
|
|
@ -2321,6 +2316,23 @@ content body for the custom dynamic layouts.</p>
|
|
|
|
|
<li>width</li>
|
|
|
|
|
</ul>
|
|
|
|
|
<p>Every field is of integer type.</p>
|
|
|
|
|
<h3 id="app"><a class="header" href="#app">app</a></h3>
|
|
|
|
|
<p>This is a lightweight version of the <a href="message.html#lua-context">Lua Context</a>. In this context, the
|
|
|
|
|
heavyweight fields like <a href="message.html#directory_buffer">directory_buffer</a> are omitted for performance
|
|
|
|
|
reasons.</p>
|
|
|
|
|
<p>Hence, only the following fields are avilable.</p>
|
|
|
|
|
<ul>
|
|
|
|
|
<li><a href="message.html#version">version</a></li>
|
|
|
|
|
<li><a href="message.html#pwd">pwd</a></li>
|
|
|
|
|
<li><a href="message.html#focused_node">focused_node</a></li>
|
|
|
|
|
<li><a href="message.html#selection">selection</a></li>
|
|
|
|
|
<li><a href="message.html#mode">mode</a></li>
|
|
|
|
|
<li><a href="message.html#layout">layout</a></li>
|
|
|
|
|
<li><a href="message.html#input_buffer">input_buffer</a></li>
|
|
|
|
|
<li><a href="message.html#pid">pid</a></li>
|
|
|
|
|
<li><a href="message.html#session_path">session_path</a></li>
|
|
|
|
|
<li><a href="message.html#explorer_config">explorer_config</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
<div style="break-before: page; page-break-before: always;"></div><h1 id="node-types"><a class="header" href="#node-types">Node Types</a></h1>
|
|
|
|
|
<p>This configuration defines how to deal with different kinds of nodes (files,
|
|
|
|
|
directories, symlinks etc.) in a directory.</p>
|
|
|
|
|
|
sayanarijit
3 years ago