Archives
/
xplr
mirror of https://github.com/sayanarijit/xplr
2
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Improve docs

Browse Source
pull/474/head
Arijit Basu 2 years ago
parent 0d12762c1d
commit 3cfed5aa6f
No known key found for this signature in database
GPG Key ID: 0F8EF5258DC38077
7 changed files with 244 additions and 221 deletions
Show Stats Download Patch File Download Diff File

3
docs/en/src/environment-variables-and-pipes.md
Unescape Escape View File

@ -42,6 +42,7 @@ The environment variables starting with `XPLR_PIPE_` are the temporary files
called ["pipe"s][18]. called ["pipe"s][18].
The other variables are single-line variables containing simple information: The other variables are single-line variables containing simple information:
- [XPLR_APP_VERSION][30] - [XPLR_APP_VERSION][30]
- [XPLR_FOCUS_INDEX][31] - [XPLR_FOCUS_INDEX][31]
- [XPLR_FOCUS_PATH][32] - [XPLR_FOCUS_PATH][32]
@ -91,7 +92,7 @@ Currently there is only one input pipe.
#### Output pipes #### Output pipes
`XPLR_PIPE_*_OUT` are the output pipes that contain data which cannot be `XPLR_PIPE_*_OUT` are the output pipes that contain data which cannot be
exposed directly via environment variables, like multi-line strings. exposed directly via environment variables, like multi-line strings.
These pipes can be accessed as plaintext files located in $XPLR_SESSION_PATH. These pipes can be accessed as plaintext files located in $XPLR_SESSION_PATH.
- [XPLR_PIPE_SELECTION_OUT][21] - [XPLR_PIPE_SELECTION_OUT][21]

3
docs/en/src/installing-plugins.md
Unescape Escape View File

@ -48,7 +48,8 @@ Setup luarocks with the following steps:
package.path = os.getenv("LUA_PATH") .. ";" .. package.path package.path = os.getenv("LUA_PATH") .. ";" .. package.path
package.cpath = os.getenv("LUA_CPATH") .. ";" .. package.cpath package.cpath = os.getenv("LUA_CPATH") .. ";" .. package.cpath
``` ```
Now you can install packages using luarocks. Be sure to append `--lua-version`.
Now you can install packages using luarocks. Be sure to append `--lua-version`.
Example: Example:

66
docs/en/src/layout.md
Unescape Escape View File

@ -26,20 +26,22 @@ xplr.config.layouts.builtin.default = {
A layout can be one of the following: A layout can be one of the following:
- ["Nothing"][8] - [Nothing][8]
- ["Table"][9] - [Table][9]
- ["InputAndLogs"][10] - [InputAndLogs][10]
- ["Selection"][11] - [Selection][11]
- ["HelpMenu"][12] - [HelpMenu][12]
- ["SortAndFilter"][13] - [SortAndFilter][13]
- { [CustomContent][25] = { [title][33], [body][34] } - [CustomContent][25]
- { [Horizontal][14] = { [config][15], [splits][17] } - [Horizontal][14]
- { [Vertical][16] = { [config][15], [splits][17] } - [Vertical][16]
### Nothing ### Nothing
This layout contains a blank panel. This layout contains a blank panel.
Example: "Nothing"
### Table ### Table
This layout contains the table displaying the files and directories in the This layout contains the table displaying the files and directories in the
@ -49,20 +51,38 @@ current directory.
This layout contains the panel displaying the input prompt and logs. This layout contains the panel displaying the input prompt and logs.
Example: "InputAndLogs"
### Selection ### Selection
This layout contains the panel displaying the selected paths. This layout contains the panel displaying the selected paths.
Example: "Selection"
### HelpMenu ### HelpMenu
This layout contains the panel displaying the help menu for the current mode in This layout contains the panel displaying the help menu for the current mode in
real-time. real-time.
Example: "HelpMenu"
### SortAndFilter ### SortAndFilter
This layout contains the panel displaying the pipeline of sorters and filters This layout contains the panel displaying the pipeline of sorters and filters
applied of the list of paths being displayed. applied of the list of paths being displayed.
Example: "SortAndFilter"
### Custom Content
Custom content is a special layout to render something custom.
It contains the following information:
- [title][33]
- [body][34]
Example: { CustomContent = { title = [title][33], body = [body][34] }
### Horizontal ### Horizontal
This is a special layout that splits the panel into two horizontal parts. This is a special layout that splits the panel into two horizontal parts.
@ -72,6 +92,8 @@ It contains the following information:
- [config][15] - [config][15]
- [splits][17] - [splits][17]
Example: { Horizontal = { config = [config][15], splits = [splits][17] }
### Vertical ### Vertical
This is a special layout that splits the panel into two vertical parts. This is a special layout that splits the panel into two vertical parts.
@ -81,6 +103,8 @@ It contains the following information:
- [config][15] - [config][15]
- [splits][17] - [splits][17]
Example: { Vertical = { config = [config][15], splits = [splits][17] }
## Layout Config ## Layout Config
A layout config contains the following information: A layout config contains the following information:
@ -144,21 +168,13 @@ Type: list of [Layout][3]
The list of child layouts to fit into the parent layout. The list of child layouts to fit into the parent layout.
## Custom Content ## title
Custom content is a special layout to render something custom.
It contains the following information:
- [title][33]
- [body][34]
### title
Type: nullable string Type: nullable string
The title of the panel. The title of the panel.
### body ## body
Type: [Content Body][26] Type: [Content Body][26]
@ -175,7 +191,7 @@ Content body can be one of the following:
- [StaticTable][31] - [StaticTable][31]
- [DynamicTable][32] - [DynamicTable][32]
### Static Paragraph ## Static Paragraph
A paragraph to render. It contains the following fields: A paragraph to render. It contains the following fields:
@ -194,7 +210,7 @@ xplr.config.layouts.builtin.default = {
} }
``` ```
### Dynamic Paragraph ## Dynamic Paragraph
A [Lua function][35] to render a custom paragraph. A [Lua function][35] to render a custom paragraph.
It contains the following fields: It contains the following fields:
@ -217,7 +233,7 @@ xplr.fn.custom.render_layout = function(ctx)
end end
``` ```
### Static List ## Static List
A list to render. It contains the following fields: A list to render. It contains the following fields:
@ -236,7 +252,7 @@ xplr.config.layouts.builtin.default = {
} }
``` ```
### Dynamic List ## Dynamic List
A [Lua function][35] to render a custom list. A [Lua function][35] to render a custom list.
It contains the following fields: It contains the following fields:
@ -262,7 +278,7 @@ xplr.fn.custom.render_layout = function(ctx)
end end
``` ```
### Static Table ## Static Table
A table to render. It contains the following fields: A table to render. It contains the following fields:
@ -293,7 +309,7 @@ xplr.config.layouts.builtin.default = {
} }
``` ```
### Dynamic Table ## Dynamic Table
A [Lua function][35] to render a custom table. A [Lua function][35] to render a custom table.
It contains the following fields: It contains the following fields:

12
docs/en/src/message.md
Unescape Escape View File

@ -17,17 +17,17 @@ To send messages using the [key bindings][2] or
[Lua function calls][3], messages are represented in [Lua function calls][3], messages are represented in
[Lua][5] syntax. For example: [Lua][5] syntax. For example:
- "Quit" - `"Quit"`
- { FocusPath = "/path/to/file" } - `{ FocusPath = "/path/to/file" }`
- { Call = { command = "bash", args = { "-c", "read -p test" } } } - `{ Call = { command = "bash", args = { "-c", "read -p test" } } }`
However, to send messages using the [input pipe][4], they need to be However, to send messages using the [input pipe][4], they need to be
represented using represented using
[YAML][6] (or [JSON][7]) syntax. For example: [YAML][6] (or [JSON][7]) syntax. For example:
- Quit - `Quit`
- FocusPath: "/path/to/file" - `FocusPath: "/path/to/file"`
- Call: { command: bash, args: ["-c", "read -p test"] } - `Call: { command: bash, args: ["-c", "read -p test"] }`
## Also See: ## Also See:

186
docs/en/src/messages.md
Unescape Escape View File

@ -30,7 +30,7 @@ This operation is expensive. So, try to avoid using it too often.
Example: Example:
- Lua: "ExplorePwd" - Lua: `"ExplorePwd"`
- YAML: `ExplorePwd` - YAML: `ExplorePwd`
#### ExplorePwdAsync #### ExplorePwdAsync
@ -43,7 +43,7 @@ $PWD synchronously, use `ExplorePwd` instead.
Example: Example:
- Lua: "ExplorePwdAsync" - Lua: `"ExplorePwdAsync"`
- YAML: `ExplorePwdAsync` - YAML: `ExplorePwdAsync`
#### ExploreParentsAsync #### ExploreParentsAsync
@ -57,7 +57,7 @@ instead.
Example: Example:
- Lua: "ExploreParentsAsync" - Lua: `"ExploreParentsAsync"`
- YAML: `ExploreParentsAsync` - YAML: `ExploreParentsAsync`
### Screen ### Screen
@ -68,7 +68,7 @@ Clear the screen.
Example: Example:
- Lua: "ClearScreen" - Lua: `"ClearScreen"``
- YAML: `ClearScreen` - YAML: `ClearScreen`
#### Refresh #### Refresh
@ -81,7 +81,7 @@ Also, it will not clear the screen. Use `ClearScreen` for that.
Example: Example:
- Lua: "Refresh" - Lua: `"Refresh"`
- YAML: `Refresh` - YAML: `Refresh`
### Navigation ### Navigation
@ -92,7 +92,7 @@ Focus next node.
Example: Example:
- Lua: "FocusNext" - Lua: `"FocusNext"`
- YAML: `FocusNext` - YAML: `FocusNext`
#### FocusNextByRelativeIndex #### FocusNextByRelativeIndex
@ -104,7 +104,7 @@ Type: { FocusNextByRelativeIndex = int }
Example: Example:
- Lua: { FocusNextByRelativeIndex = 2 } - Lua: `{ FocusNextByRelativeIndex = 2 }`
- YAML: `FocusNextByRelativeIndex: 2` - YAML: `FocusNextByRelativeIndex: 2`
#### FocusNextByRelativeIndexFromInput #### FocusNextByRelativeIndexFromInput
@ -114,7 +114,7 @@ from the input buffer.
Example: Example:
- Lua: "FocusNextByRelativeIndexFromInput" - Lua: `"FocusNextByRelativeIndexFromInput"`
- YAML: `FocusNextByRelativeIndexFromInput` - YAML: `FocusNextByRelativeIndexFromInput`
#### FocusPrevious #### FocusPrevious
@ -123,7 +123,7 @@ Focus on the previous item.
Example: Example:
- Lua: "FocusPrevious" - Lua: `"FocusPrevious"`
- YAML: `FocusPrevious` - YAML: `FocusPrevious`
#### FocusPreviousByRelativeIndex #### FocusPreviousByRelativeIndex
@ -145,7 +145,7 @@ read from the input buffer.
Example: Example:
- Lua: "FocusPreviousByRelativeIndexFromInput" - Lua: `"FocusPreviousByRelativeIndexFromInput"`
- YAML: `FocusPreviousByRelativeIndexFromInput` - YAML: `FocusPreviousByRelativeIndexFromInput`
#### FocusFirst #### FocusFirst
@ -154,7 +154,7 @@ Focus on the first node.
Example: Example:
- Lua: "FocusFirst" - Lua: `"FocusFirst"`
- YAML: `FocusFirst` - YAML: `FocusFirst`
#### FocusLast #### FocusLast
@ -163,7 +163,7 @@ Focus on the last node.
Example: Example:
- Lua: "FocusLast" - Lua: `"FocusLast"`
- YAML: `FocusLast` - YAML: `FocusLast`
#### FocusPath #### FocusPath
@ -183,7 +183,7 @@ Focus on the path read from input buffer.
Example: Example:
- Lua: "FocusPathFromInput" - Lua: `"FocusPathFromInput"`
- YAML: `FocusPathFromInput` - YAML: `FocusPathFromInput`
#### FocusByIndex #### FocusByIndex
@ -194,7 +194,7 @@ Type: { FocusByIndex = int }
Example: Example:
- Lua: { FocusByIndex = 2 } - Lua: `{ FocusByIndex = 2 }`
- YAML: `FocusByIndex: 2` - YAML: `FocusByIndex: 2`
#### FocusByIndexFromInput #### FocusByIndexFromInput
@ -203,7 +203,7 @@ Focus on the absolute `n`th node where `n` is read from the input buffer.
Example: Example:
- Lua: "FocusByIndexFromInput" - Lua: `"FocusByIndexFromInput"`
- YAML: `FocusByIndexFromInput` - YAML: `FocusByIndexFromInput`
#### FocusByFileName #### FocusByFileName
@ -216,7 +216,7 @@ Type: { FocusByFileName = "string" }
Example: Example:
- Lua: { FocusByFileName = "filename.ext" } - Lua: `{ FocusByFileName = "filename.ext" }`
- YAML: `FocusByFileName: filename.ext` - YAML: `FocusByFileName: filename.ext`
#### ChangeDirectory #### ChangeDirectory
@ -227,7 +227,7 @@ Type: { ChangeDirectory = "string" }
Example: Example:
- Lua: { ChangeDirectory = "/path/to/directory" } - Lua: `{ ChangeDirectory = "/path/to/directory" }`
- YAML: `ChangeDirectory: /path/to/directory` - YAML: `ChangeDirectory: /path/to/directory`
#### Enter #### Enter
@ -236,7 +236,7 @@ Enter into the currently focused path if it's a directory.
Example: Example:
- Lua: "Enter" - Lua: `"Enter"`
- YAML: `Enter` - YAML: `Enter`
#### Back #### Back
@ -245,7 +245,7 @@ Go back to the parent directory.
Example: Example:
- Lua:"Back" - Lua: `"Back"`
- YAML: `Back` - YAML: `Back`
#### LastVisitedPath #### LastVisitedPath
@ -254,7 +254,7 @@ Go to the last path visited.
Example: Example:
- Lua: "LastVisitedPath" - Lua: `"LastVisitedPath"`
- YAML: `LastVisitedPath` - YAML: `LastVisitedPath`
#### NextVisitedPath #### NextVisitedPath
@ -263,7 +263,7 @@ Go to the next path visited.
Example: Example:
- Lua: "NextVisitedPath" - Lua: `"NextVisitedPath"`
- YAML: `NextVisitedPath` - YAML: `NextVisitedPath`
#### FollowSymlink #### FollowSymlink
@ -272,7 +272,7 @@ Follow the symlink under focus to its actual location.
Example: Example:
Lua: "FollowSymlink" Lua: `"FollowSymlink"`
YAML: `FollowSymlink` YAML: `FollowSymlink`
### Reading Input ### Reading Input
@ -285,7 +285,7 @@ Type: { UpdateInputBuffer = [Input Opertaion](https://xplr.dev/en/input-operatio
Example: Example:
- Lua: { UpdateInputBuffer = "GoToPreviousWord" } - Lua: `{ UpdateInputBuffer = "GoToPreviousWord" }`
- YAML: `UpdateInputBuffer: GoToPreviousWord` - YAML: `UpdateInputBuffer: GoToPreviousWord`
#### UpdateInputBufferFromKey #### UpdateInputBufferFromKey
@ -294,7 +294,7 @@ Update the input buffer from the key read from keyboard input.
Example: Example:
- Lua: "UpdateInputBufferFromKey" - Lua: `"UpdateInputBufferFromKey"`
- YAML: `UpdateInputBufferFromKey` - YAML: `UpdateInputBufferFromKey`
#### BufferInput #### BufferInput
@ -305,7 +305,7 @@ Type: { BufferInput = "string" }
Example: Example:
- Lua: { BufferInput = "foo" } - Lua: `{ BufferInput = "foo" }`
- YAML: `BufferInput: foo` - YAML: `BufferInput: foo`
#### BufferInputFromKey #### BufferInputFromKey
@ -315,7 +315,7 @@ input buffer.
Example: Example:
- Lua: "BufferInputFromKey" - Lua: `"BufferInputFromKey"`
- YAML: `BufferInputFromKey` - YAML: `BufferInputFromKey`
#### SetInputBuffer #### SetInputBuffer
@ -328,7 +328,7 @@ Type: { SetInputBuffer = "string" }
Example: Example:
- Lua: { SetInputBuffer = "foo" } - Lua: `{ SetInputBuffer = "foo" }`
- YAML: `SetInputBuffer: foo` - YAML: `SetInputBuffer: foo`
#### RemoveInputBufferLastCharacter #### RemoveInputBufferLastCharacter
@ -337,7 +337,7 @@ Remove input buffer's last character.
Example: Example:
- Lua: "RemoveInputBufferLastCharacter" - Lua: `"RemoveInputBufferLastCharacter"`
- YAML: `RemoveInputBufferLastCharacter` - YAML: `RemoveInputBufferLastCharacter`
#### RemoveInputBufferLastWord #### RemoveInputBufferLastWord
@ -346,7 +346,7 @@ Remove input buffer's last word.
Example: Example:
- Lua: "RemoveInputBufferLastWord" - Lua: `"RemoveInputBufferLastWord"`
- YAML: `RemoveInputBufferLastWord` - YAML: `RemoveInputBufferLastWord`
#### ResetInputBuffer #### ResetInputBuffer
@ -355,7 +355,7 @@ Reset the input buffer back to null. It will not show in the UI.
Example: Example:
- Lua: "ResetInputBuffer" - Lua: `"ResetInputBuffer"`
- YAML: `ResetInputBuffer` - YAML: `ResetInputBuffer`
### Switching Mode ### Switching Mode
@ -368,7 +368,7 @@ Type : { SwitchMode = "string" }
Example: Example:
- Lua: { SwitchMode = "default" } - Lua: `{ SwitchMode = "default" }`
- YAML: SwitchMode: default - YAML: SwitchMode: default
> **NOTE:** To be specific about which mode to switch to, use > **NOTE:** To be specific about which mode to switch to, use
@ -384,7 +384,7 @@ Type: { SwitchModeKeepingInputBuffer = "string" }
Example: Example:
- Lua: { SwitchModeKeepingInputBuffer = "default" } - Lua: `{ SwitchModeKeepingInputBuffer = "default" }`
- YAML: `SwitchModeKeepingInputBuffer: default` - YAML: `SwitchModeKeepingInputBuffer: default`
> **NOTE:** To be specific about which mode to switch to, use > **NOTE:** To be specific about which mode to switch to, use
@ -400,7 +400,7 @@ Type: { SwitchModeBuiltin = "string" }
Example: Example:
- Lua: { SwitchModeBuiltin = "default" } - Lua: `{ SwitchModeBuiltin = "default" }`
- YAML: `SwitchModeBuiltin: default` - YAML: `SwitchModeBuiltin: default`
#### SwitchModeBuiltinKeepingInputBuffer #### SwitchModeBuiltinKeepingInputBuffer
@ -412,7 +412,7 @@ Type: { SwitchModeBuiltinKeepingInputBuffer = "string" }
Example: Example:
- Lua: { SwitchModeBuiltinKeepingInputBuffer = "default" } - Lua: `{ SwitchModeBuiltinKeepingInputBuffer = "default" }`
- YAML: `SwitchModeBuiltinKeepingInputBuffer: default` - YAML: `SwitchModeBuiltinKeepingInputBuffer: default`
#### SwitchModeCustom #### SwitchModeCustom
@ -424,7 +424,7 @@ Type: { SwitchModeCustom = "string" }
Example: Example:
- Lua: { SwitchModeCustom = "my_custom_mode" } - Lua: `{ SwitchModeCustom = "my_custom_mode" }`
- YAML: `SwitchModeCustom: my_custom_mode` - YAML: `SwitchModeCustom: my_custom_mode`
#### SwitchModeCustomKeepingInputBuffer #### SwitchModeCustomKeepingInputBuffer
@ -436,7 +436,7 @@ Type: { SwitchModeCustomKeepingInputBuffer = "string" }
Example: Example:
- Lua: { SwitchModeCustomKeepingInputBuffer = "my_custom_mode" } - Lua: `{ SwitchModeCustomKeepingInputBuffer = "my_custom_mode" }`
- YAML: `SwitchModeCustomKeepingInputBuffer: my_custom_mode` - YAML: `SwitchModeCustomKeepingInputBuffer: my_custom_mode`
#### PopMode #### PopMode
@ -446,7 +446,7 @@ It clears the input buffer.
Example: Example:
- Lua: "PopMode" - Lua: `"PopMode"`
- YAML: `PopMode` - YAML: `PopMode`
#### PopModeKeepingInputBuffer #### PopModeKeepingInputBuffer
@ -456,7 +456,7 @@ It keeps the input buffer.
Example: Example:
- Lua: PopModeKeepingInputBuffer - Lua: `PopModeKeepingInputBuffer`
- YAML: `PopModeKeepingInputBuffer` - YAML: `PopModeKeepingInputBuffer`
### Switching Layout ### Switching Layout
@ -469,7 +469,7 @@ Type: { SwitchLayout = "string" }
Example: Example:
- Lua: { SwitchLayout = "default" } - Lua: `{ SwitchLayout = "default" }`
- YAML: `SwitchLayout: default` - YAML: `SwitchLayout: default`
> **NOTE:** To be specific about which layout to switch to, use `SwitchLayoutBuiltin` or > **NOTE:** To be specific about which layout to switch to, use `SwitchLayoutBuiltin` or
@ -483,7 +483,7 @@ Type: { SwitchLayoutBuiltin = "string" }
Example: Example:
- Lua: { SwitchLayoutBuiltin = "default" } - Lua: `{ SwitchLayoutBuiltin = "default" }`
- YAML: `SwitchLayoutBuiltin: default` - YAML: `SwitchLayoutBuiltin: default`
#### SwitchLayoutCustom #### SwitchLayoutCustom
@ -494,7 +494,7 @@ Type: { SwitchLayoutCustom = "string" }
Example: Example:
- Lua: { SwitchLayoutCustom = "my_custom_layout" } - Lua: `{ SwitchLayoutCustom = "my_custom_layout" }`
- YAML: `SwitchLayoutCustom: my_custom_layout` - YAML: `SwitchLayoutCustom: my_custom_layout`
### Executing Commands ### Executing Commands
@ -511,7 +511,7 @@ Type: { Call = "string" }
Example: Example:
- Lua: { Call = { command = "bash", args = { "-c", "read -p test" } } } - Lua: `{ Call = { command = "bash", args = { "-c", "read -p test" } } }`
- YAML: `Call: { command: bash, args: ["-c", "read -p test"] }` - YAML: `Call: { command: bash, args: ["-c", "read -p test"] }`
#### CallSilently #### CallSilently
@ -535,7 +535,7 @@ Type: { BashExec = "string" }
Example: Example:
- Lua: { BashExec = "read -p test" } - Lua: `{ BashExec = "read -p test" }`
- YAML: `BashExec: "read -p test"` - YAML: `BashExec: "read -p test"`
#### BashExecSilently #### BashExecSilently
@ -547,7 +547,7 @@ Type: { BashExecSilently = "string" }
Example: Example:
- Lua: { BashExecSilently = "tput bell" } - Lua: `{ BashExecSilently = "tput bell" }`
- YAML: `BashExecSilently: "tput bell"` - YAML: `BashExecSilently: "tput bell"`
### Calling Lua Functions ### Calling Lua Functions
@ -565,7 +565,7 @@ Type: { CallLua = "string" }
Example: Example:
- Lua: { CallLua = "custom.some_custom_funtion" } - Lua: `{ CallLua = "custom.some_custom_funtion" }`
- YAML: `CallLua: custom.some_custom_funtion` - YAML: `CallLua: custom.some_custom_funtion`
#### CallLuaSilently #### CallLuaSilently
@ -577,7 +577,7 @@ Type: { CallLuaSilently = "string" }
Example: Example:
- Lua: { CallLuaSilently = "custom.some_custom_function" } - Lua: `{ CallLuaSilently = "custom.some_custom_function" }`
- YAML: `CallLuaSilently: custom.some_custom_function` - YAML: `CallLuaSilently: custom.some_custom_function`
#### LuaEval #### LuaEval
@ -592,8 +592,8 @@ Type: { LuaEval = "string" }
Example: Example:
- Lua: { LuaEval = [[return { { LogInfo = io.read() } }]] } - Lua: `{ LuaEval = [[return { { LogInfo = io.read() } }]] }`
- Lua: { LuaEval = [[function(app) return { { LogInfo = app.pwd } } end]] } - Lua: `{ LuaEval = [[function(app) return { { LogInfo = app.pwd } } end]] }`
- YAML: `LuaEval: "return { { LogInfo = io.read() } }"` - YAML: `LuaEval: "return { { LogInfo = io.read() } }"`
- YAML: `LuaEval: "function(app) return { { LogInfo = app.pwd } } end"` - YAML: `LuaEval: "function(app) return { { LogInfo = app.pwd } } end"`
@ -606,7 +606,7 @@ Type: { LuaEvalSilently = "string" }
Example: Example:
- Lua: { LuaEvalSilently = [[return { { LogInfo = "foo" } }]] } - Lua: `{ LuaEvalSilently = [[return { { LogInfo = "foo" } }]] }`
- YAML: `LuaEvalSilently: "return { { LogInfo = 'foo' } }"` - YAML: `LuaEvalSilently: "return { { LogInfo = 'foo' } }"`
### Select Operations ### Select Operations
@ -617,7 +617,7 @@ Select the focused node.
Example: Example:
- Lua: "Select" - Lua: `"Select"`
- YAML: `Select` - YAML: `Select`
#### SelectAll #### SelectAll
@ -626,7 +626,7 @@ Select all the visible nodes.
Example: Example:
- Lua: "SelectAll" - Lua: `"SelectAll"`
- YAML: `SelectAll` - YAML: `SelectAll`
#### SelectPath #### SelectPath
@ -637,7 +637,7 @@ Type: { SelectPath = "string" }
Example: Example:
- Lua: { SelectPath = "/path/to/file" } - Lua: `{ SelectPath = "/path/to/file" }`
- YAML: `SelectPath: /path/to/file` - YAML: `SelectPath: /path/to/file`
#### UnSelect #### UnSelect
@ -646,7 +646,7 @@ Unselect the focused node.
Example: Example:
- Lua: "UnSelect" - Lua: `"UnSelect"`
- YAML: `UnSelect` - YAML: `UnSelect`
#### UnSelectAll #### UnSelectAll
@ -655,7 +655,7 @@ Unselect all the visible nodes.
Example: Example:
- Lua: "UnSelectAll" - Lua: `"UnSelectAll"`
- YAML: `UnSelectAll` - YAML: `UnSelectAll`
#### UnSelectPath #### UnSelectPath
@ -666,7 +666,7 @@ Type: { UnSelectPath = "string)" }
Example: Example:
- Lua: { UnSelectPath = "/path/to/file" } - Lua: `{ UnSelectPath = "/path/to/file" }`
- YAML: `UnSelectPath: /path/to/file` - YAML: `UnSelectPath: /path/to/file`
#### ToggleSelection #### ToggleSelection
@ -675,7 +675,7 @@ Toggle selection on the focused node.
Example: Example:
- Lua: "ToggleSelection" - Lua: `"ToggleSelection"`
- YAML `ToggleSelection` - YAML `ToggleSelection`
#### ToggleSelectAll #### ToggleSelectAll
@ -683,7 +683,7 @@ Example:
Toggle between select all and unselect all. Toggle between select all and unselect all.
Example: Example:
- Lua: "ToggleSelectAll" - Lua: `"ToggleSelectAll"`
- YAML: `ToggleSelectAll` - YAML: `ToggleSelectAll`
#### ToggleSelectionByPath #### ToggleSelectionByPath
@ -694,7 +694,7 @@ Type: { ToggleSelectionByPath = "string" }
Example: Example:
- Lua: { ToggleSelectionByPath = "/path/to/file" } - Lua: `{ ToggleSelectionByPath = "/path/to/file" }`
- YAML: `ToggleSelectionByPath: /path/to/file` - YAML: `ToggleSelectionByPath: /path/to/file`
#### ClearSelection #### ClearSelection
@ -703,7 +703,7 @@ Clear the selection.
Example: Example:
- Lua: "ClearSelection" - Lua: `"ClearSelection"`
- YAML: `ClearSelection` - YAML: `ClearSelection`
### Filter Operations ### Filter Operations
@ -717,7 +717,7 @@ Type: { AddNodeFilter = { filter = [Filter](https://xplr.dev/en/filtering#filter
Example: Example:
- Lua: { AddNodeFilter = { filter = "RelativePathDoesStartWith", input = "foo" } } - Lua: `{ AddNodeFilter = { filter = "RelativePathDoesStartWith", input = "foo" } }`
- YAML: `AddNodeFilter: { filter: RelativePathDoesStartWith, input: foo }` - YAML: `AddNodeFilter: { filter: RelativePathDoesStartWith, input: foo }`
#### RemoveNodeFilter #### RemoveNodeFilter
@ -728,7 +728,7 @@ Type: { RemoveNodeFilter = { filter = [Filter](https://xplr.dev/en/filtering), i
Example: Example:
- Lua: { RemoveNodeFilter: { filter: "RelativePathDoesStartWith", input: "foo" } } - Lua: `{ RemoveNodeFilter: { filter: "RelativePathDoesStartWith", input: "foo" } }`
- YAML: `RemoveNodeFilter: { filter: RelativePathDoesStartWith, input: foo }` - YAML: `RemoveNodeFilter: { filter: RelativePathDoesStartWith, input: foo }`
#### ToggleNodeFilter #### ToggleNodeFilter
@ -740,7 +740,7 @@ Type: { ToggleNodeFilter = { filter = [Filter](https://xplr.dev/en/filtering), i
Example: Example:
- Lua: { ToggleNodeFilter = { filter = "RelativePathDoesStartWith", input = "foo" } } - Lua: `{ ToggleNodeFilter = { filter = "RelativePathDoesStartWith", input = "foo" } }`
- YAML: `ToggleNodeFilter: { filter: RelativePathDoesStartWith, input: foo }` - YAML: `ToggleNodeFilter: { filter: RelativePathDoesStartWith, input: foo }`
#### AddNodeFilterFromInput #### AddNodeFilterFromInput
@ -752,7 +752,7 @@ Type: { AddNodeFilterFromInput = [Filter](https://xplr.dev/en/filtering) }
Example: Example:
- Lua: { AddNodeFilterFromInput = "RelativePathDoesStartWith" } - Lua: `{ AddNodeFilterFromInput = "RelativePathDoesStartWith" }`
- YAML: `AddNodeFilterFromInput: RelativePathDoesStartWith` - YAML: `AddNodeFilterFromInput: RelativePathDoesStartWith`
#### RemoveNodeFilterFromInput #### RemoveNodeFilterFromInput
@ -764,7 +764,7 @@ Type: { RemoveNodeFilterFromInput = [Filter](https://xplr.dev/en/filtering) }
Example: Example:
- Lua: { RemoveNodeFilterFromInput = "RelativePathDoesStartWith" } - Lua: `{ RemoveNodeFilterFromInput = "RelativePathDoesStartWith" }`
- YAML: `RemoveNodeFilterFromInput: RelativePathDoesStartWith` - YAML: `RemoveNodeFilterFromInput: RelativePathDoesStartWith`
#### RemoveLastNodeFilter #### RemoveLastNodeFilter
@ -773,7 +773,7 @@ Remove the last node [filter](https://xplr.dev/en/filtering).
Example: Example:
- Lua: "RemoveLastNodeFilter" - Lua: `"RemoveLastNodeFilter"`
- YAML: `RemoveLastNodeFilter` - YAML: `RemoveLastNodeFilter`
#### ResetNodeFilters #### ResetNodeFilters
@ -783,7 +783,7 @@ default configuration.
Example: Example:
- Lua: "ResetNodeFilters" - Lua: `"ResetNodeFilters"`
- YAML: `ResetNodeFilters` - YAML: `ResetNodeFilters`
#### ClearNodeFilters #### ClearNodeFilters
@ -792,7 +792,7 @@ Clear all the node [filters](https://xplr.dev/en/filtering).
Example: Example:
- Lua: "ClearNodeFilters" - Lua: `"ClearNodeFilters"`
- YAML: `ClearNodeFilters` - YAML: `ClearNodeFilters`
### Sort Operations ### Sort Operations
@ -806,7 +806,7 @@ Type: { AddNodeSorter = { sorter = [Sorter](https://xplr.dev/en/sorting#sorter),
Example: Example:
- Lua: { AddNodeSorter = { sorter = "ByRelativePath", reverse = false } } - Lua: `{ AddNodeSorter = { sorter = "ByRelativePath", reverse = false } }`
- YAML: `AddNodeSorter: { sorter: ByRelativePath, reverse: false }` - YAML: `AddNodeSorter: { sorter: ByRelativePath, reverse: false }`
#### RemoveNodeSorter #### RemoveNodeSorter
@ -817,7 +817,7 @@ Type: { RemoveNodeSorter = [Sorter](https://xplr.dev/en/sorting#sorter) }
Example: Example:
- Lua: { RemoveNodeSorter = "ByRelativePath" } - Lua: `{ RemoveNodeSorter = "ByRelativePath" }`
- YAML: `RemoveNodeSorter: ByRelativePath` - YAML: `RemoveNodeSorter: ByRelativePath`
#### ReverseNodeSorter #### ReverseNodeSorter
@ -828,7 +828,7 @@ Type: { ReverseNodeSorter = [Sorter](https://xplr.dev/en/sorting#sorter) }
Example: Example:
- Lua: { ReverseNodeSorter = "ByRelativePath" } - Lua: `{ ReverseNodeSorter = "ByRelativePath" }`
- YAML: `ReverseNodeSorter: ByRelativePath` - YAML: `ReverseNodeSorter: ByRelativePath`
#### ToggleNodeSorter #### ToggleNodeSorter
@ -840,7 +840,7 @@ Type: { ToggleNodeSorter = { sorter = [Sorter](https://xplr.dev/en/sorting#sorte
Example: Example:
- Lua: { ToggleSorterSorter: { sorter = "ByRelativePath", reverse = false } } - Lua: `{ ToggleSorterSorter: { sorter = "ByRelativePath", reverse = false } }`
- YAML: `ToggleSorterSorter: {sorter: ByRelativePath, reverse: false }` - YAML: `ToggleSorterSorter: {sorter: ByRelativePath, reverse: false }`
#### ReverseNodeSorters #### ReverseNodeSorters
@ -849,7 +849,7 @@ Reverse the node [sorters](https://xplr.dev/en/sorting#sorter).
Example: Example:
- Lua: "ReverseNodeSorters" - Lua: `"ReverseNodeSorters"`
- YAML: `ReverseNodeSorters` - YAML: `ReverseNodeSorters`
#### RemoveLastNodeSorter #### RemoveLastNodeSorter
@ -858,7 +858,7 @@ Remove the last node [sorter](https://xplr.dev/en/sorting#sorter).
Example: Example:
- Lua: "RemoveLastNodeSorter" - Lua: `"RemoveLastNodeSorter"`
- YAML: `RemoveLastNodeSorter` - YAML: `RemoveLastNodeSorter`
#### ResetNodeSorters #### ResetNodeSorters
@ -868,7 +868,7 @@ the default configuration.
Example: Example:
- Lua: "ResetNodeSorters" - Lua: `"ResetNodeSorters"`
- YAML: `ResetNodeSorters` - YAML: `ResetNodeSorters`
#### ClearNodeSorters #### ClearNodeSorters
@ -877,7 +877,7 @@ Clear all the node [sorters](https://xplr.dev/en/sorting#sorter).
Example: Example:
- Lua: "ClearNodeSorters" - Lua: `"ClearNodeSorters"`
- YAML: `ClearNodeSorters` - YAML: `ClearNodeSorters`
### Mouse Operations ### Mouse Operations
@ -888,7 +888,7 @@ Enable mouse
Example: Example:
- Lua: "EnableMouse" - Lua: `"EnableMouse"`
- YAML: `EnableMouse` - YAML: `EnableMouse`
#### DisableMouse #### DisableMouse
@ -897,7 +897,7 @@ Disable mouse
Example: Example:
- Lua: "DisableMouse" - Lua: `"DisableMouse"`
- YAML: `DisableMouse` - YAML: `DisableMouse`
#### ToggleMouse #### ToggleMouse
@ -906,7 +906,7 @@ Toggle mouse
Example: Example:
- Lua: "ToggleMouse" - Lua: `"ToggleMouse"`
- YAML: `ToggleMouse` - YAML: `ToggleMouse`
### Fifo Operations ### Fifo Operations
@ -919,7 +919,7 @@ Type: { StartFifo = "string" }
Example: Example:
- Lua: { StartFifo = "/tmp/xplr.fifo } - Lua: `{ StartFifo = "/tmp/xplr.fifo }`
- YAML: `StartFifo: /tmp/xplr.fifo` - YAML: `StartFifo: /tmp/xplr.fifo`
#### StopFifo #### StopFifo
@ -928,7 +928,7 @@ Close the active fifo and stop piping.
Example: Example:
- Lua: "StopFifo" - Lua: `"StopFifo"`
- YAML: `StopFifo` - YAML: `StopFifo`
#### ToggleFifo #### ToggleFifo
@ -939,7 +939,7 @@ Type: { ToggleFifo = "string" }
Example: Example:
- Lua: { ToggleFifo = "/path/to/fifo" } - Lua: `{ ToggleFifo = "/path/to/fifo" }`
- YAML: `ToggleFifo: /path/to/fifo` - YAML: `ToggleFifo: /path/to/fifo`
### Logging ### Logging
@ -952,7 +952,7 @@ Type: { LogInfo = "string" }
Example: Example:
- Lua: { LogInfo = "launching satellite" } - Lua: `{ LogInfo = "launching satellite" }`
- YAML: `LogInfo: launching satellite` - YAML: `LogInfo: launching satellite`
#### LogSuccess #### LogSuccess
@ -963,7 +963,7 @@ Type: { LogSuccess = "String" }
Example: Example:
- Lua: { LogSuccess = "satellite reached destination" } - Lua: `{ LogSuccess = "satellite reached destination" }`
- YAML: `LogSuccess: satellite reached destination` - YAML: `LogSuccess: satellite reached destination`
#### LogWarning #### LogWarning
@ -974,7 +974,7 @@ Type: { LogWarning = "string" }
Example: Example:
- Lua: { LogWarning = "satellite is heating" } - Lua: `{ LogWarning = "satellite is heating" }`
- YAML: `LogWarning: satellite is heating` - YAML: `LogWarning: satellite is heating`
#### LogError #### LogError
@ -985,7 +985,7 @@ Type: { LogError = "string" }
Example: Example:
- Lua: { LogError = "satellite crashed" } - Lua: `{ LogError = "satellite crashed" }`
- YAML: `LogError: satellite crashed` - YAML: `LogError: satellite crashed`
### Debugging ### Debugging
@ -999,7 +999,7 @@ Type: { Debug = "string" }
Example: Example:
- Lua: { Debug = "/path/to/file" } - Lua: `{ Debug = "/path/to/file" }`
- YAML: `Debug: /path/to/file` - YAML: `Debug: /path/to/file`
### Quit Options ### Quit Options
@ -1008,7 +1008,7 @@ Example:
Example: Example:
- Lua: "Quit" - Lua: `"Quit"`
- YAML: `Quit` - YAML: `Quit`
Quit with returncode zero (success). Quit with returncode zero (success).
@ -1019,7 +1019,7 @@ Print $PWD and quit.
Example: Example:
- Lua: "PrintPwdAndQuit" - Lua: `"PrintPwdAndQuit"`
- YAML: `PrintPwdAndQuit` - YAML: `PrintPwdAndQuit`
#### PrintFocusPathAndQuit #### PrintFocusPathAndQuit
@ -1029,7 +1029,7 @@ nothing to focus.
Example: Example:
- Lua: "PrintFocusPathAndQuit" - Lua: `"PrintFocusPathAndQuit"`
- YAML: `PrintFocusPathAndQuit` - YAML: `PrintFocusPathAndQuit`
#### PrintSelectionAndQuit #### PrintSelectionAndQuit
@ -1039,7 +1039,7 @@ selected.
Example: Example:
- Lua: "PrintSelectionAndQuit" - Lua: `"PrintSelectionAndQuit"`
- YAML: `PrintSelectionAndQuit` - YAML: `PrintSelectionAndQuit`
#### PrintResultAndQuit #### PrintResultAndQuit
@ -1049,7 +1049,7 @@ node's path.
Example: Example:
- Lua: "PrintResultAndQuit" - Lua: `"PrintResultAndQuit"`
- YAML: `PrintResultAndQuit` - YAML: `PrintResultAndQuit`
#### PrintAppStateAndQuit #### PrintAppStateAndQuit
@ -1059,7 +1059,7 @@ generating the default configuration file.
Example: Example:
- Lua: "PrintAppStateAndQuit" - Lua: `"PrintAppStateAndQuit"`
- YAML: `PrintAppStateAndQuit` - YAML: `PrintAppStateAndQuit`
#### Terminate #### Terminate
@ -1068,7 +1068,7 @@ Terminate the application with a non-zero return code.
Example: Example:
- Lua: "Terminate" - Lua: `"Terminate"`
- YAML: `Terminate` - YAML: `Terminate`
## Also See: ## Also See:

9
docs/script/generate.py
Unescape Escape View File

@ -1,8 +1,8 @@
"""Generate docs from comments.""" """Generate docs from comments."""
from dataclasses import dataclass, field import os
from dataclasses import dataclass
from typing import List from typing import List
from enum import Enum
# Messages -------------------------------------------------------------------- # Messages --------------------------------------------------------------------
@ -216,9 +216,14 @@ def gen_configuration():
print(doc, file=f) print(doc, file=f)
def format_docs():
os.system("prettier --write docs/en/src")
def main(): def main():
gen_messages() gen_messages()
gen_configuration() gen_configuration()
format_docs()
if __name__ == "__main__": if __name__ == "__main__":

186
src/msg/in_/external.rs
Unescape Escape View File

@ -12,7 +12,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: "ExplorePwd" /// - Lua: `"ExplorePwd"`
/// - YAML: `ExplorePwd` /// - YAML: `ExplorePwd`
ExplorePwd, ExplorePwd,
@ -24,7 +24,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: "ExplorePwdAsync" /// - Lua: `"ExplorePwdAsync"`
/// - YAML: `ExplorePwdAsync` /// - YAML: `ExplorePwdAsync`
ExplorePwdAsync, ExplorePwdAsync,
@ -37,7 +37,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: "ExploreParentsAsync" /// - Lua: `"ExploreParentsAsync"`
/// - YAML: `ExploreParentsAsync` /// - YAML: `ExploreParentsAsync`
ExploreParentsAsync, ExploreParentsAsync,
@ -47,7 +47,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: "ClearScreen" /// - Lua: `"ClearScreen"``
/// - YAML: `ClearScreen` /// - YAML: `ClearScreen`
ClearScreen, ClearScreen,
@ -59,7 +59,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: "Refresh" /// - Lua: `"Refresh"`
/// - YAML: `Refresh` /// - YAML: `Refresh`
Refresh, Refresh,
@ -69,7 +69,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: "FocusNext" /// - Lua: `"FocusNext"`
/// - YAML: `FocusNext` /// - YAML: `FocusNext`
FocusNext, FocusNext,
@ -80,7 +80,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: { FocusNextByRelativeIndex = 2 } /// - Lua: `{ FocusNextByRelativeIndex = 2 }`
/// - YAML: `FocusNextByRelativeIndex: 2` /// - YAML: `FocusNextByRelativeIndex: 2`
FocusNextByRelativeIndex(usize), FocusNextByRelativeIndex(usize),
@ -89,7 +89,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: "FocusNextByRelativeIndexFromInput" /// - Lua: `"FocusNextByRelativeIndexFromInput"`
/// - YAML: `FocusNextByRelativeIndexFromInput` /// - YAML: `FocusNextByRelativeIndexFromInput`
FocusNextByRelativeIndexFromInput, FocusNextByRelativeIndexFromInput,
@ -97,7 +97,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: "FocusPrevious" /// - Lua: `"FocusPrevious"`
/// - YAML: `FocusPrevious` /// - YAML: `FocusPrevious`
FocusPrevious, FocusPrevious,
@ -117,7 +117,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: "FocusPreviousByRelativeIndexFromInput" /// - Lua: `"FocusPreviousByRelativeIndexFromInput"`
/// - YAML: `FocusPreviousByRelativeIndexFromInput` /// - YAML: `FocusPreviousByRelativeIndexFromInput`
FocusPreviousByRelativeIndexFromInput, FocusPreviousByRelativeIndexFromInput,
@ -125,7 +125,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: "FocusFirst" /// - Lua: `"FocusFirst"`
/// - YAML: `FocusFirst` /// - YAML: `FocusFirst`
/// ///
FocusFirst, FocusFirst,
@ -133,7 +133,7 @@ pub enum ExternalMsg {
/// Focus on the last node. /// Focus on the last node.
/// ///
/// Example: /// Example:
/// - Lua: "FocusLast" /// - Lua: `"FocusLast"`
/// - YAML: `FocusLast` /// - YAML: `FocusLast`
FocusLast, FocusLast,
@ -151,7 +151,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: "FocusPathFromInput" /// - Lua: `"FocusPathFromInput"`
/// - YAML: `FocusPathFromInput` /// - YAML: `FocusPathFromInput`
FocusPathFromInput, FocusPathFromInput,
@ -161,7 +161,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: { FocusByIndex = 2 } /// - Lua: `{ FocusByIndex = 2 }`
/// - YAML: `FocusByIndex: 2` /// - YAML: `FocusByIndex: 2`
FocusByIndex(usize), FocusByIndex(usize),
@ -169,7 +169,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: "FocusByIndexFromInput" /// - Lua: `"FocusByIndexFromInput"`
/// - YAML: `FocusByIndexFromInput` /// - YAML: `FocusByIndexFromInput`
FocusByIndexFromInput, FocusByIndexFromInput,
@ -182,7 +182,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: { FocusByFileName = "filename.ext" } /// - Lua: `{ FocusByFileName = "filename.ext" }`
/// - YAML: `FocusByFileName: filename.ext` /// - YAML: `FocusByFileName: filename.ext`
FocusByFileName(String), FocusByFileName(String),
@ -192,7 +192,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: { ChangeDirectory = "/path/to/directory" } /// - Lua: `{ ChangeDirectory = "/path/to/directory" }`
/// - YAML: `ChangeDirectory: /path/to/directory` /// - YAML: `ChangeDirectory: /path/to/directory`
ChangeDirectory(String), ChangeDirectory(String),
@ -200,7 +200,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: "Enter" /// - Lua: `"Enter"`
/// - YAML: `Enter` /// - YAML: `Enter`
Enter, Enter,
@ -208,7 +208,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua:"Back" /// - Lua: `"Back"`
/// - YAML: `Back` /// - YAML: `Back`
Back, Back,
@ -216,7 +216,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: "LastVisitedPath" /// - Lua: `"LastVisitedPath"`
/// - YAML: `LastVisitedPath` /// - YAML: `LastVisitedPath`
LastVisitedPath, LastVisitedPath,
@ -224,7 +224,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: "NextVisitedPath" /// - Lua: `"NextVisitedPath"`
/// - YAML: `NextVisitedPath` /// - YAML: `NextVisitedPath`
NextVisitedPath, NextVisitedPath,
@ -233,7 +233,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// Lua: "FollowSymlink" /// Lua: `"FollowSymlink"`
/// YAML: `FollowSymlink` /// YAML: `FollowSymlink`
FollowSymlink, FollowSymlink,
@ -245,7 +245,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: { UpdateInputBuffer = "GoToPreviousWord" } /// - Lua: `{ UpdateInputBuffer = "GoToPreviousWord" }`
/// - YAML: `UpdateInputBuffer: GoToPreviousWord` /// - YAML: `UpdateInputBuffer: GoToPreviousWord`
UpdateInputBuffer(InputOperation), UpdateInputBuffer(InputOperation),
@ -253,7 +253,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: "UpdateInputBufferFromKey" /// - Lua: `"UpdateInputBufferFromKey"`
/// - YAML: `UpdateInputBufferFromKey` /// - YAML: `UpdateInputBufferFromKey`
UpdateInputBufferFromKey, UpdateInputBufferFromKey,
@ -263,7 +263,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: { BufferInput = "foo" } /// - Lua: `{ BufferInput = "foo" }`
/// - YAML: `BufferInput: foo` /// - YAML: `BufferInput: foo`
BufferInput(String), BufferInput(String),
@ -272,7 +272,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: "BufferInputFromKey" /// - Lua: `"BufferInputFromKey"`
/// - YAML: `BufferInputFromKey` /// - YAML: `BufferInputFromKey`
BufferInputFromKey, BufferInputFromKey,
@ -284,7 +284,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: { SetInputBuffer = "foo" } /// - Lua: `{ SetInputBuffer = "foo" }`
/// - YAML: `SetInputBuffer: foo` /// - YAML: `SetInputBuffer: foo`
SetInputBuffer(String), SetInputBuffer(String),
@ -292,7 +292,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: "RemoveInputBufferLastCharacter" /// - Lua: `"RemoveInputBufferLastCharacter"`
/// - YAML: `RemoveInputBufferLastCharacter` /// - YAML: `RemoveInputBufferLastCharacter`
RemoveInputBufferLastCharacter, RemoveInputBufferLastCharacter,
@ -300,7 +300,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: "RemoveInputBufferLastWord" /// - Lua: `"RemoveInputBufferLastWord"`
/// - YAML: `RemoveInputBufferLastWord` /// - YAML: `RemoveInputBufferLastWord`
RemoveInputBufferLastWord, RemoveInputBufferLastWord,
@ -308,7 +308,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: "ResetInputBuffer" /// - Lua: `"ResetInputBuffer"`
/// - YAML: `ResetInputBuffer` /// - YAML: `ResetInputBuffer`
ResetInputBuffer, ResetInputBuffer,
@ -320,7 +320,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: { SwitchMode = "default" } /// - Lua: `{ SwitchMode = "default" }`
/// - YAML: SwitchMode: default /// - YAML: SwitchMode: default
/// ///
/// > **NOTE:** To be specific about which mode to switch to, use /// > **NOTE:** To be specific about which mode to switch to, use
@ -335,7 +335,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: { SwitchModeKeepingInputBuffer = "default" } /// - Lua: `{ SwitchModeKeepingInputBuffer = "default" }`
/// - YAML: `SwitchModeKeepingInputBuffer: default` /// - YAML: `SwitchModeKeepingInputBuffer: default`
/// ///
/// > **NOTE:** To be specific about which mode to switch to, use /// > **NOTE:** To be specific about which mode to switch to, use
@ -350,7 +350,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: { SwitchModeBuiltin = "default" } /// - Lua: `{ SwitchModeBuiltin = "default" }`
/// - YAML: `SwitchModeBuiltin: default` /// - YAML: `SwitchModeBuiltin: default`
SwitchModeBuiltin(String), SwitchModeBuiltin(String),
@ -361,7 +361,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: { SwitchModeBuiltinKeepingInputBuffer = "default" } /// - Lua: `{ SwitchModeBuiltinKeepingInputBuffer = "default" }`
/// - YAML: `SwitchModeBuiltinKeepingInputBuffer: default` /// - YAML: `SwitchModeBuiltinKeepingInputBuffer: default`
SwitchModeBuiltinKeepingInputBuffer(String), SwitchModeBuiltinKeepingInputBuffer(String),
@ -372,7 +372,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: { SwitchModeCustom = "my_custom_mode" } /// - Lua: `{ SwitchModeCustom = "my_custom_mode" }`
/// - YAML: `SwitchModeCustom: my_custom_mode` /// - YAML: `SwitchModeCustom: my_custom_mode`
SwitchModeCustom(String), SwitchModeCustom(String),
@ -383,7 +383,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: { SwitchModeCustomKeepingInputBuffer = "my_custom_mode" } /// - Lua: `{ SwitchModeCustomKeepingInputBuffer = "my_custom_mode" }`
/// - YAML: `SwitchModeCustomKeepingInputBuffer: my_custom_mode` /// - YAML: `SwitchModeCustomKeepingInputBuffer: my_custom_mode`
SwitchModeCustomKeepingInputBuffer(String), SwitchModeCustomKeepingInputBuffer(String),
@ -392,7 +392,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: "PopMode" /// - Lua: `"PopMode"`
/// - YAML: `PopMode` /// - YAML: `PopMode`
PopMode, PopMode,
@ -401,7 +401,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: PopModeKeepingInputBuffer /// - Lua: `PopModeKeepingInputBuffer`
/// - YAML: `PopModeKeepingInputBuffer` /// - YAML: `PopModeKeepingInputBuffer`
PopModeKeepingInputBuffer, PopModeKeepingInputBuffer,
@ -413,7 +413,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: { SwitchLayout = "default" } /// - Lua: `{ SwitchLayout = "default" }`
/// - YAML: `SwitchLayout: default` /// - YAML: `SwitchLayout: default`
/// ///
/// > **NOTE:** To be specific about which layout to switch to, use `SwitchLayoutBuiltin` or /// > **NOTE:** To be specific about which layout to switch to, use `SwitchLayoutBuiltin` or
@ -426,7 +426,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: { SwitchLayoutBuiltin = "default" } /// - Lua: `{ SwitchLayoutBuiltin = "default" }`
/// - YAML: `SwitchLayoutBuiltin: default` /// - YAML: `SwitchLayoutBuiltin: default`
SwitchLayoutBuiltin(String), SwitchLayoutBuiltin(String),
@ -436,7 +436,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: { SwitchLayoutCustom = "my_custom_layout" } /// - Lua: `{ SwitchLayoutCustom = "my_custom_layout" }`
/// - YAML: `SwitchLayoutCustom: my_custom_layout` /// - YAML: `SwitchLayoutCustom: my_custom_layout`
SwitchLayoutCustom(String), SwitchLayoutCustom(String),
@ -452,7 +452,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: { Call = { command = "bash", args = { "-c", "read -p test" } } } /// - Lua: `{ Call = { command = "bash", args = { "-c", "read -p test" } } }`
/// - YAML: `Call: { command: bash, args: ["-c", "read -p test"] }` /// - YAML: `Call: { command: bash, args: ["-c", "read -p test"] }`
Call(Command), Call(Command),
@ -474,7 +474,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: { BashExec = "read -p test" } /// - Lua: `{ BashExec = "read -p test" }`
/// - YAML: `BashExec: "read -p test"` /// - YAML: `BashExec: "read -p test"`
BashExec(String), BashExec(String),
@ -485,7 +485,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: { BashExecSilently = "tput bell" } /// - Lua: `{ BashExecSilently = "tput bell" }`
/// - YAML: `BashExecSilently: "tput bell"` /// - YAML: `BashExecSilently: "tput bell"`
BashExecSilently(String), BashExecSilently(String),
@ -502,7 +502,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: { CallLua = "custom.some_custom_funtion" } /// - Lua: `{ CallLua = "custom.some_custom_funtion" }`
/// - YAML: `CallLua: custom.some_custom_funtion` /// - YAML: `CallLua: custom.some_custom_funtion`
CallLua(String), CallLua(String),
@ -513,7 +513,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: { CallLuaSilently = "custom.some_custom_function" } /// - Lua: `{ CallLuaSilently = "custom.some_custom_function" }`
/// - YAML: `CallLuaSilently: custom.some_custom_function` /// - YAML: `CallLuaSilently: custom.some_custom_function`
CallLuaSilently(String), CallLuaSilently(String),
@ -527,8 +527,8 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: { LuaEval = [[return { { LogInfo = io.read() } }]] } /// - Lua: `{ LuaEval = [[return { { LogInfo = io.read() } }]] }`
/// - Lua: { LuaEval = [[function(app) return { { LogInfo = app.pwd } } end]] } /// - Lua: `{ LuaEval = [[function(app) return { { LogInfo = app.pwd } } end]] }`
/// - YAML: `LuaEval: "return { { LogInfo = io.read() } }"` /// - YAML: `LuaEval: "return { { LogInfo = io.read() } }"`
/// - YAML: `LuaEval: "function(app) return { { LogInfo = app.pwd } } end"` /// - YAML: `LuaEval: "function(app) return { { LogInfo = app.pwd } } end"`
LuaEval(String), LuaEval(String),
@ -540,7 +540,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: { LuaEvalSilently = [[return { { LogInfo = "foo" } }]] } /// - Lua: `{ LuaEvalSilently = [[return { { LogInfo = "foo" } }]] }`
/// - YAML: `LuaEvalSilently: "return { { LogInfo = 'foo' } }"` /// - YAML: `LuaEvalSilently: "return { { LogInfo = 'foo' } }"`
LuaEvalSilently(String), LuaEvalSilently(String),
@ -550,7 +550,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: "Select" /// - Lua: `"Select"`
/// - YAML: `Select` /// - YAML: `Select`
Select, Select,
@ -558,7 +558,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: "SelectAll" /// - Lua: `"SelectAll"`
/// - YAML: `SelectAll` /// - YAML: `SelectAll`
SelectAll, SelectAll,
@ -568,7 +568,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: { SelectPath = "/path/to/file" } /// - Lua: `{ SelectPath = "/path/to/file" }`
/// - YAML: `SelectPath: /path/to/file` /// - YAML: `SelectPath: /path/to/file`
SelectPath(String), SelectPath(String),
@ -576,7 +576,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: "UnSelect" /// - Lua: `"UnSelect"`
/// - YAML: `UnSelect` /// - YAML: `UnSelect`
UnSelect, UnSelect,
@ -584,7 +584,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: "UnSelectAll" /// - Lua: `"UnSelectAll"`
/// - YAML: `UnSelectAll` /// - YAML: `UnSelectAll`
UnSelectAll, UnSelectAll,
@ -594,7 +594,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: { UnSelectPath = "/path/to/file" } /// - Lua: `{ UnSelectPath = "/path/to/file" }`
/// - YAML: `UnSelectPath: /path/to/file` /// - YAML: `UnSelectPath: /path/to/file`
UnSelectPath(String), UnSelectPath(String),
@ -602,14 +602,14 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: "ToggleSelection" /// - Lua: `"ToggleSelection"`
/// - YAML `ToggleSelection` /// - YAML `ToggleSelection`
ToggleSelection, ToggleSelection,
/// Toggle between select all and unselect all. /// Toggle between select all and unselect all.
/// Example: /// Example:
/// ///
/// - Lua: "ToggleSelectAll" /// - Lua: `"ToggleSelectAll"`
/// - YAML: `ToggleSelectAll` /// - YAML: `ToggleSelectAll`
ToggleSelectAll, ToggleSelectAll,
@ -619,7 +619,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: { ToggleSelectionByPath = "/path/to/file" } /// - Lua: `{ ToggleSelectionByPath = "/path/to/file" }`
/// - YAML: `ToggleSelectionByPath: /path/to/file` /// - YAML: `ToggleSelectionByPath: /path/to/file`
ToggleSelectionByPath(String), ToggleSelectionByPath(String),
@ -627,7 +627,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: "ClearSelection" /// - Lua: `"ClearSelection"`
/// - YAML: `ClearSelection` /// - YAML: `ClearSelection`
ClearSelection, ClearSelection,
@ -640,7 +640,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: { AddNodeFilter = { filter = "RelativePathDoesStartWith", input = "foo" } } /// - Lua: `{ AddNodeFilter = { filter = "RelativePathDoesStartWith", input = "foo" } }`
/// - YAML: `AddNodeFilter: { filter: RelativePathDoesStartWith, input: foo }` /// - YAML: `AddNodeFilter: { filter: RelativePathDoesStartWith, input: foo }`
AddNodeFilter(NodeFilterApplicable), AddNodeFilter(NodeFilterApplicable),
@ -650,7 +650,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: { RemoveNodeFilter: { filter: "RelativePathDoesStartWith", input: "foo" } } /// - Lua: `{ RemoveNodeFilter: { filter: "RelativePathDoesStartWith", input: "foo" } }`
/// - YAML: `RemoveNodeFilter: { filter: RelativePathDoesStartWith, input: foo }` /// - YAML: `RemoveNodeFilter: { filter: RelativePathDoesStartWith, input: foo }`
RemoveNodeFilter(NodeFilterApplicable), RemoveNodeFilter(NodeFilterApplicable),
@ -661,7 +661,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: { ToggleNodeFilter = { filter = "RelativePathDoesStartWith", input = "foo" } } /// - Lua: `{ ToggleNodeFilter = { filter = "RelativePathDoesStartWith", input = "foo" } }`
/// - YAML: `ToggleNodeFilter: { filter: RelativePathDoesStartWith, input: foo }` /// - YAML: `ToggleNodeFilter: { filter: RelativePathDoesStartWith, input: foo }`
ToggleNodeFilter(NodeFilterApplicable), ToggleNodeFilter(NodeFilterApplicable),
@ -672,7 +672,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: { AddNodeFilterFromInput = "RelativePathDoesStartWith" } /// - Lua: `{ AddNodeFilterFromInput = "RelativePathDoesStartWith" }`
/// - YAML: `AddNodeFilterFromInput: RelativePathDoesStartWith` /// - YAML: `AddNodeFilterFromInput: RelativePathDoesStartWith`
AddNodeFilterFromInput(NodeFilter), AddNodeFilterFromInput(NodeFilter),
@ -683,7 +683,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: { RemoveNodeFilterFromInput = "RelativePathDoesStartWith" } /// - Lua: `{ RemoveNodeFilterFromInput = "RelativePathDoesStartWith" }`
/// - YAML: `RemoveNodeFilterFromInput: RelativePathDoesStartWith` /// - YAML: `RemoveNodeFilterFromInput: RelativePathDoesStartWith`
RemoveNodeFilterFromInput(NodeFilter), RemoveNodeFilterFromInput(NodeFilter),
@ -691,7 +691,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: "RemoveLastNodeFilter" /// - Lua: `"RemoveLastNodeFilter"`
/// - YAML: `RemoveLastNodeFilter` /// - YAML: `RemoveLastNodeFilter`
RemoveLastNodeFilter, RemoveLastNodeFilter,
@ -700,7 +700,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: "ResetNodeFilters" /// - Lua: `"ResetNodeFilters"`
/// - YAML: `ResetNodeFilters` /// - YAML: `ResetNodeFilters`
ResetNodeFilters, ResetNodeFilters,
@ -708,7 +708,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: "ClearNodeFilters" /// - Lua: `"ClearNodeFilters"`
/// - YAML: `ClearNodeFilters` /// - YAML: `ClearNodeFilters`
ClearNodeFilters, ClearNodeFilters,
@ -721,7 +721,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: { AddNodeSorter = { sorter = "ByRelativePath", reverse = false } } /// - Lua: `{ AddNodeSorter = { sorter = "ByRelativePath", reverse = false } }`
/// - YAML: `AddNodeSorter: { sorter: ByRelativePath, reverse: false }` /// - YAML: `AddNodeSorter: { sorter: ByRelativePath, reverse: false }`
AddNodeSorter(NodeSorterApplicable), AddNodeSorter(NodeSorterApplicable),
@ -731,7 +731,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: { RemoveNodeSorter = "ByRelativePath" } /// - Lua: `{ RemoveNodeSorter = "ByRelativePath" }`
/// - YAML: `RemoveNodeSorter: ByRelativePath` /// - YAML: `RemoveNodeSorter: ByRelativePath`
RemoveNodeSorter(NodeSorter), RemoveNodeSorter(NodeSorter),
@ -741,7 +741,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: { ReverseNodeSorter = "ByRelativePath" } /// - Lua: `{ ReverseNodeSorter = "ByRelativePath" }`
/// - YAML: `ReverseNodeSorter: ByRelativePath` /// - YAML: `ReverseNodeSorter: ByRelativePath`
ReverseNodeSorter(NodeSorter), ReverseNodeSorter(NodeSorter),
@ -752,7 +752,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: { ToggleSorterSorter: { sorter = "ByRelativePath", reverse = false } } /// - Lua: `{ ToggleSorterSorter: { sorter = "ByRelativePath", reverse = false } }`
/// - YAML: `ToggleSorterSorter: {sorter: ByRelativePath, reverse: false }` /// - YAML: `ToggleSorterSorter: {sorter: ByRelativePath, reverse: false }`
ToggleNodeSorter(NodeSorterApplicable), ToggleNodeSorter(NodeSorterApplicable),
@ -760,7 +760,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: "ReverseNodeSorters" /// - Lua: `"ReverseNodeSorters"`
/// - YAML: `ReverseNodeSorters` /// - YAML: `ReverseNodeSorters`
ReverseNodeSorters, ReverseNodeSorters,
@ -768,7 +768,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: "RemoveLastNodeSorter" /// - Lua: `"RemoveLastNodeSorter"`
/// - YAML: `RemoveLastNodeSorter` /// - YAML: `RemoveLastNodeSorter`
RemoveLastNodeSorter, RemoveLastNodeSorter,
@ -777,7 +777,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: "ResetNodeSorters" /// - Lua: `"ResetNodeSorters"`
/// - YAML: `ResetNodeSorters` /// - YAML: `ResetNodeSorters`
ResetNodeSorters, ResetNodeSorters,
@ -785,7 +785,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: "ClearNodeSorters" /// - Lua: `"ClearNodeSorters"`
/// - YAML: `ClearNodeSorters` /// - YAML: `ClearNodeSorters`
ClearNodeSorters, ClearNodeSorters,
@ -795,7 +795,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: "EnableMouse" /// - Lua: `"EnableMouse"`
/// - YAML: `EnableMouse` /// - YAML: `EnableMouse`
EnableMouse, EnableMouse,
@ -803,7 +803,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: "DisableMouse" /// - Lua: `"DisableMouse"`
/// - YAML: `DisableMouse` /// - YAML: `DisableMouse`
DisableMouse, DisableMouse,
@ -811,7 +811,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: "ToggleMouse" /// - Lua: `"ToggleMouse"`
/// - YAML: `ToggleMouse` /// - YAML: `ToggleMouse`
ToggleMouse, ToggleMouse,
@ -823,7 +823,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: { StartFifo = "/tmp/xplr.fifo } /// - Lua: `{ StartFifo = "/tmp/xplr.fifo }`
/// - YAML: `StartFifo: /tmp/xplr.fifo` /// - YAML: `StartFifo: /tmp/xplr.fifo`
StartFifo(String), StartFifo(String),
@ -831,7 +831,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: "StopFifo" /// - Lua: `"StopFifo"`
/// - YAML: `StopFifo` /// - YAML: `StopFifo`
StopFifo, StopFifo,
@ -841,7 +841,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: { ToggleFifo = "/path/to/fifo" } /// - Lua: `{ ToggleFifo = "/path/to/fifo" }`
/// - YAML: `ToggleFifo: /path/to/fifo` /// - YAML: `ToggleFifo: /path/to/fifo`
ToggleFifo(String), ToggleFifo(String),
@ -853,7 +853,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: { LogInfo = "launching satellite" } /// - Lua: `{ LogInfo = "launching satellite" }`
/// - YAML: `LogInfo: launching satellite` /// - YAML: `LogInfo: launching satellite`
LogInfo(String), LogInfo(String),
@ -863,7 +863,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: { LogSuccess = "satellite reached destination" } /// - Lua: `{ LogSuccess = "satellite reached destination" }`
/// - YAML: `LogSuccess: satellite reached destination` /// - YAML: `LogSuccess: satellite reached destination`
LogSuccess(String), LogSuccess(String),
@ -873,7 +873,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: { LogWarning = "satellite is heating" } /// - Lua: `{ LogWarning = "satellite is heating" }`
/// - YAML: `LogWarning: satellite is heating` /// - YAML: `LogWarning: satellite is heating`
LogWarning(String), LogWarning(String),
@ -883,7 +883,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: { LogError = "satellite crashed" } /// - Lua: `{ LogError = "satellite crashed" }`
/// - YAML: `LogError: satellite crashed` /// - YAML: `LogError: satellite crashed`
LogError(String), LogError(String),
@ -896,7 +896,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: { Debug = "/path/to/file" } /// - Lua: `{ Debug = "/path/to/file" }`
/// - YAML: `Debug: /path/to/file` /// - YAML: `Debug: /path/to/file`
Debug(String), Debug(String),
@ -904,7 +904,7 @@ pub enum ExternalMsg {
/// Example: /// Example:
/// ///
/// - Lua: "Quit" /// - Lua: `"Quit"`
/// - YAML: `Quit` /// - YAML: `Quit`
/// ///
/// Quit with returncode zero (success). /// Quit with returncode zero (success).
@ -914,7 +914,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: "PrintPwdAndQuit" /// - Lua: `"PrintPwdAndQuit"`
/// - YAML: `PrintPwdAndQuit` /// - YAML: `PrintPwdAndQuit`
PrintPwdAndQuit, PrintPwdAndQuit,
@ -923,7 +923,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: "PrintFocusPathAndQuit" /// - Lua: `"PrintFocusPathAndQuit"`
/// - YAML: `PrintFocusPathAndQuit` /// - YAML: `PrintFocusPathAndQuit`
PrintFocusPathAndQuit, PrintFocusPathAndQuit,
@ -932,7 +932,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: "PrintSelectionAndQuit" /// - Lua: `"PrintSelectionAndQuit"`
/// - YAML: `PrintSelectionAndQuit` /// - YAML: `PrintSelectionAndQuit`
PrintSelectionAndQuit, PrintSelectionAndQuit,
@ -941,7 +941,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: "PrintResultAndQuit" /// - Lua: `"PrintResultAndQuit"`
/// - YAML: `PrintResultAndQuit` /// - YAML: `PrintResultAndQuit`
PrintResultAndQuit, PrintResultAndQuit,
@ -950,7 +950,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: "PrintAppStateAndQuit" /// - Lua: `"PrintAppStateAndQuit"`
/// - YAML: `PrintAppStateAndQuit` /// - YAML: `PrintAppStateAndQuit`
PrintAppStateAndQuit, PrintAppStateAndQuit,
@ -958,7 +958,7 @@ pub enum ExternalMsg {
/// ///
/// Example: /// Example:
/// ///
/// - Lua: "Terminate" /// - Lua: `"Terminate"`
/// - YAML: `Terminate` /// - YAML: `Terminate`
Terminate, Terminate,
} }

Write Preview
Loading…
Cancel
Save