2022-04-16 07:40:39 +00:00
<!DOCTYPE HTML>
< html lang = "en" class = "sidebar-visible no-js dark" >
< head >
<!-- Book generated using mdBook -->
< meta charset = "UTF-8" >
< title > General - xplr book< / title >
<!-- Custom HTML head -->
< meta content = "text/html; charset=utf-8" http-equiv = "Content-Type" >
< meta name = "description" content = "A hackable, minimal, fast TUI file explorer" >
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
< meta name = "theme-color" content = "#ffffff" / >
< link rel = "shortcut icon" href = "favicon.png" >
< link rel = "stylesheet" href = "css/variables.css" >
< link rel = "stylesheet" href = "css/general.css" >
< link rel = "stylesheet" href = "css/chrome.css" >
< link rel = "stylesheet" href = "css/print.css" media = "print" >
<!-- Fonts -->
< link rel = "stylesheet" href = "FontAwesome/css/font-awesome.css" >
< link rel = "stylesheet" href = "fonts/fonts.css" >
<!-- Highlight.js Stylesheets -->
< link rel = "stylesheet" href = "highlight.css" >
< link rel = "stylesheet" href = "tomorrow-night.css" >
< link rel = "stylesheet" href = "ayu-highlight.css" >
<!-- Custom theme stylesheets -->
<!-- EthicalAds -->
< script async src = "https://media.ethicalads.io/media/client/ethicalads.min.js" > < / script >
< / head >
< body >
<!-- Provide site root to javascript -->
< script type = "text/javascript" >
var path_to_root = "";
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "coal" : "dark";
< / script >
<!-- Work around some values being stored in localStorage wrapped in quotes -->
< script type = "text/javascript" >
try {
var theme = localStorage.getItem('mdbook-theme');
var sidebar = localStorage.getItem('mdbook-sidebar');
if (theme.startsWith('"') & & theme.endsWith('"')) {
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
}
if (sidebar.startsWith('"') & & sidebar.endsWith('"')) {
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
}
} catch (e) { }
< / script >
<!-- Set the theme before any content is loaded, prevents flash -->
< script type = "text/javascript" >
var theme;
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
if (theme === null || theme === undefined) { theme = default_theme; }
var html = document.querySelector('html');
html.classList.remove('no-js')
html.classList.remove('dark')
html.classList.add(theme);
html.classList.add('js');
< / script >
<!-- Hide / unhide sidebar before it is displayed -->
< script type = "text/javascript" >
var html = document.querySelector('html');
var sidebar = 'hidden';
if (document.body.clientWidth >= 1080) {
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
sidebar = sidebar || 'visible';
}
html.classList.remove('sidebar-visible');
html.classList.add("sidebar-" + sidebar);
< / script >
< nav id = "sidebar" class = "sidebar" aria-label = "Table of contents" >
< div class = "sidebar-scrollbox" >
2022-05-25 15:48:39 +00:00
< ol class = "chapter" > < li class = "chapter-item expanded " > < a href = "introduction.html" > < strong aria-hidden = "true" > 1.< / strong > Introduction< / a > < / li > < li class = "chapter-item expanded " > < a href = "quickstart.html" > < strong aria-hidden = "true" > 2.< / strong > Quickstart< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "install.html" > < strong aria-hidden = "true" > 2.1.< / strong > Install< / a > < / li > < li class = "chapter-item expanded " > < a href = "post-install.html" > < strong aria-hidden = "true" > 2.2.< / strong > Post Install< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < a href = "configuration.html" > < strong aria-hidden = "true" > 3.< / strong > Configuration< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "general-config.html" class = "active" > < strong aria-hidden = "true" > 3.1.< / strong > General< / a > < / li > < li class = "chapter-item expanded " > < a href = "node_types.html" > < strong aria-hidden = "true" > 3.2.< / strong > Node Types< / a > < / li > < li class = "chapter-item expanded " > < a href = "layouts.html" > < strong aria-hidden = "true" > 3.3.< / strong > Layouts< / a > < / li > < li class = "chapter-item expanded " > < a href = "modes.html" > < strong aria-hidden = "true" > 3.4.< / strong > Modes< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < a href = "concept.html" > < strong aria-hidden = "true" > 4.< / strong > Concept< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "key-bindings.html" > < strong aria-hidden = "true" > 4.1.< / strong > Key Bindings< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "configure-key-bindings.html" > < strong aria-hidden = "true" > 4.1.1.< / strong > Configure Key Bindings< / a > < / li > < li class = "chapter-item expanded " > < a href = "default-key-bindings.html" > < strong aria-hidden = "true" > 4.1.2.< / strong > Default Key Bindings< / a > < / li > < li class = "chapter-item expanded " > < a href = "debug-key-bindings.html" > < strong aria-hidden = "true" > 4.1.3.< / strong > Debug Key Bindings< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < a href = "node-type.html" > < strong aria-hidden = "true" > 4.2.< / strong > Node Type< / a > < / li > < li class = "chapter-item expanded " > < a href = "layout.html" > < strong aria-hidden = "true" > 4.3.< / strong > Layout< / a > < / li > < li class = "chapter-item expanded " > < a href = "mode.html" > < strong aria-hidden = "true" > 4.4.< / strong > Mode< / a > < / li > < li class = "chapter-item expanded " > < a href = "message.html" > < strong aria-hidden = "true" > 4.5.< / strong > Message< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "messages.html" > < strong aria-hidden = "true" > 4.5.1.< / strong > Full List of Messages< / a > < / li > < li class = "chapter-item expanded " > < a href = "input-operation.html" > < strong aria-hidden = "true" > 4.5.2.< / strong > Input Operation< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < a href = "borders.html" > < strong aria-hidden = "true" > 4.6.< / strong > Borders< / a > < / li > < li class = "chapter-item expanded " > < a href = "style.html" > < strong aria-hidden = "true" > 4.7.< / strong > Style< / a > < / li > < li class = "chapter-item expanded " > < a href = "sorting.html" > < strong aria-hidden = "true" > 4.8.< / strong > Sorting< / a > < / li > < li class = "chapter-item expanded " > < a href = "filtering.html" > < strong aria-hidden = "true" > 4.9.< / strong > Filtering< / a > < / li > < li class = "chapter-item expanded " > < a href = "column-renderer.html" > < strong aria-hidden = "true" > 4.10.< / strong > Column Renderer< / a > < / li > < li class = "chapter-item expanded " > < a href = "lua-function-calls.html" > < strong aria-hidden = "true" > 4.11.< / strong > Lua Function Calls< / a > < / li > < li class = "chapter-item expanded " > < a href = "environment-variables-and-pipes.html" > < strong aria-hidden = "true" > 4.12.< / strong > Environment Variables and Pipes< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < a href = "awesome-hacks.html" > < strong aria-hidden = "true" > 5.< / strong > Awesome Hacks< / a > < / li > < li class = "chapter-item expanded " > < a href = "plugin.html" > < strong aria-hidden = "true" > 6.< / strong > Plugin< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "installing-plugins.html" > < strong aria-hidden = "true" > 6.1.< / strong > Installing Plugins< / a > < / li > < li class = "chapter-item expanded " > < a href = "writing-plugins.html" > < strong aria-hidden = "true" > 6.2.< / strong > Writing Plug
2022-04-16 07:40:39 +00:00
<!-- EthicalAds -->
< div
id="docs-sidebar-bottom"
class="dark flat"
data-ea-publisher="xplrdev"
data-ea-type="image"
>< / div >
2022-05-23 06:36:33 +00:00
2022-04-16 07:40:39 +00:00
< / div >
< div id = "sidebar-resize-handle" class = "sidebar-resize-handle" > < / div >
< / nav >
< div id = "page-wrapper" class = "page-wrapper" >
< div class = "page" >
< div id = "menu-bar-hover-placeholder" > < / div >
< div id = "menu-bar" class = "menu-bar sticky bordered" >
< div class = "left-buttons" >
< button id = "sidebar-toggle" class = "icon-button" type = "button" title = "Toggle Table of Contents" aria-label = "Toggle Table of Contents" aria-controls = "sidebar" >
< i class = "fa fa-bars" > < / i >
< / button >
< button id = "theme-toggle" class = "icon-button" type = "button" title = "Change theme" aria-label = "Change theme" aria-haspopup = "true" aria-expanded = "false" aria-controls = "theme-list" >
< i class = "fa fa-paint-brush" > < / i >
< / button >
< ul id = "theme-list" class = "theme-popup" aria-label = "Themes" role = "menu" >
< li role = "none" > < button role = "menuitem" class = "theme" id = "light" > Light< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "rust" > Rust< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "coal" > Coal< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "navy" > Navy< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "ayu" > Ayu< / button > < / li >
< / ul >
< button id = "search-toggle" class = "icon-button" type = "button" title = "Search. (Shortkey: s)" aria-label = "Toggle Searchbar" aria-expanded = "false" aria-keyshortcuts = "S" aria-controls = "searchbar" >
< i class = "fa fa-search" > < / i >
< / button >
< / div >
< h1 class = "menu-title" > xplr book< / h1 >
< div class = "right-buttons" >
< a href = "print.html" title = "Print this book" aria-label = "Print this book" >
< i id = "print-button" class = "fa fa-print" > < / i >
< / a >
< a href = "https://github.com/sayanarijit/xplr" title = "Git repository" aria-label = "Git repository" >
< i id = "git-repository-button" class = "fa fa-github" > < / i >
< / a >
< a href = "https://github.com/sayanarijit/xplr/edit/main/docs/en/src/general-config.md" title = "Suggest an edit" aria-label = "Suggest an edit" >
< i id = "git-edit-button" class = "fa fa-edit" > < / i >
< / a >
< / div >
< / div >
< div id = "search-wrapper" class = "hidden" >
< form id = "searchbar-outer" class = "searchbar-outer" >
< input type = "search" id = "searchbar" name = "searchbar" placeholder = "Search this book ..." aria-controls = "searchresults-outer" aria-describedby = "searchresults-header" >
< / form >
< div id = "searchresults-outer" class = "searchresults-outer hidden" >
< div id = "searchresults-header" class = "searchresults-header" > < / div >
< ul id = "searchresults" >
< / ul >
< / div >
< / div >
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
< script type = "text/javascript" >
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
});
< / script >
< div id = "content" class = "content" >
< main >
< h3 id = "general-configuration" > < a class = "header" href = "#general-configuration" > General Configuration< / a > < / h3 >
< p > The general configuration properties are grouped together in
< code > xplr.config.general< / code > .< / p >
< h4 id = "xplrconfiggeneraldisable_debug_error_mode" > < a class = "header" href = "#xplrconfiggeneraldisable_debug_error_mode" > xplr.config.general.disable_debug_error_mode< / a > < / h4 >
< p > Set it to < code > true< / code > if you want to ignore the startup errors. You can still see
the errors in the logs.< / p >
< p > Type: boolean< / p >
< h4 id = "xplrconfiggeneralenable_mouse" > < a class = "header" href = "#xplrconfiggeneralenable_mouse" > xplr.config.general.enable_mouse< / a > < / h4 >
< p > Set it to < code > true< / code > if you want to enable mouse scrolling.< / p >
< p > Type: boolean< / p >
< h4 id = "xplrconfiggeneralshow_hidden" > < a class = "header" href = "#xplrconfiggeneralshow_hidden" > xplr.config.general.show_hidden< / a > < / h4 >
< p > Set it to < code > true< / code > to show hidden files by default.< / p >
< p > Type: boolean< / p >
< h4 id = "xplrconfiggeneralread_only" > < a class = "header" href = "#xplrconfiggeneralread_only" > xplr.config.general.read_only< / a > < / h4 >
< p > Set it to < code > true< / code > to use only a subset of selected operations that forbids
executing commands or performing write operations on the file-system.< / p >
< p > Type: boolean< / p >
< h4 id = "xplrconfiggeneralenable_recover_mode" > < a class = "header" href = "#xplrconfiggeneralenable_recover_mode" > xplr.config.general.enable_recover_mode< / a > < / h4 >
< p > Set it to < code > true< / code > if you want to enable a safety feature that will save you
from yourself when you type recklessly.< / p >
< p > Type: boolean< / p >
< h4 id = "xplrconfiggeneralhide_remaps_in_help_menu" > < a class = "header" href = "#xplrconfiggeneralhide_remaps_in_help_menu" > xplr.config.general.hide_remaps_in_help_menu< / a > < / h4 >
< p > Set it to < code > true< / code > if you want to hide all remaps in the help menu.< / p >
< p > Type: boolean< / p >
< h4 id = "xplrconfiggeneralenforce_bounded_index_navigation" > < a class = "header" href = "#xplrconfiggeneralenforce_bounded_index_navigation" > xplr.config.general.enforce_bounded_index_navigation< / a > < / h4 >
< p > Set it to < code > true< / code > if you want the cursor to stay in the same position when
the focus is on the first path and you navigate to the previous path
(by pressing < code > up< / code > /< code > k< / code > ), or when the focus is on the last path and you
navigate to the next path (by pressing < code > down< / code > /< code > j< / code > ).
The default behavior is to rotate from the last/first path.< / p >
< p > Type: boolean< / p >
< h4 id = "xplrconfiggeneralpromptformat" > < a class = "header" href = "#xplrconfiggeneralpromptformat" > xplr.config.general.prompt.format< / a > < / h4 >
< p > This is the shape of the prompt for the input buffer.< / p >
< p > Type: nullable string< / p >
< h4 id = "xplrconfiggeneralpromptstyle" > < a class = "header" href = "#xplrconfiggeneralpromptstyle" > xplr.config.general.prompt.style< / a > < / h4 >
< p > This is the style of the prompt for the input buffer.< / p >
< p > Type: < a href = "https://xplr.dev/en/style" > Style< / a > < / p >
< h4 id = "xplrconfiggenerallogsinfoformat" > < a class = "header" href = "#xplrconfiggenerallogsinfoformat" > xplr.config.general.logs.info.format< / a > < / h4 >
< p > The string to indicate an information in logs.< / p >
< p > Type: nullable string< / p >
< h4 id = "xplrconfiggenerallogsinfostyle" > < a class = "header" href = "#xplrconfiggenerallogsinfostyle" > xplr.config.general.logs.info.style< / a > < / h4 >
< p > The style for the informations logs.< / p >
< p > Type: < a href = "https://xplr.dev/en/style" > Style< / a > < / p >
< h4 id = "xplrconfiggenerallogssuccessformat" > < a class = "header" href = "#xplrconfiggenerallogssuccessformat" > xplr.config.general.logs.success.format< / a > < / h4 >
< p > The string to indicate an success in logs.< / p >
< p > Type: nullable string< / p >
< h4 id = "xplrconfiggenerallogssuccessstyle" > < a class = "header" href = "#xplrconfiggenerallogssuccessstyle" > xplr.config.general.logs.success.style< / a > < / h4 >
< p > The style for the success logs.< / p >
< p > Type: < a href = "https://xplr.dev/en/style" > Style< / a > < / p >
< h4 id = "xplrconfiggenerallogswarningformat" > < a class = "header" href = "#xplrconfiggenerallogswarningformat" > xplr.config.general.logs.warning.format< / a > < / h4 >
< p > The string to indicate an warnings in logs.< / p >
< p > Type: nullable string< / p >
< h4 id = "xplrconfiggenerallogswarningstyle" > < a class = "header" href = "#xplrconfiggenerallogswarningstyle" > xplr.config.general.logs.warning.style< / a > < / h4 >
< p > The style for the warnings logs.< / p >
< p > Type: < a href = "https://xplr.dev/en/style" > Style< / a > < / p >
< h4 id = "xplrconfiggenerallogserrorformat" > < a class = "header" href = "#xplrconfiggenerallogserrorformat" > xplr.config.general.logs.error.format< / a > < / h4 >
< p > The string to indicate an error in logs.< / p >
< p > Type: nullable string< / p >
< h4 id = "xplrconfiggenerallogserrorstyle" > < a class = "header" href = "#xplrconfiggenerallogserrorstyle" > xplr.config.general.logs.error.style< / a > < / h4 >
< p > The style for the error logs.< / p >
< p > Type: < a href = "https://xplr.dev/en/style" > Style< / a > < / p >
< h4 id = "xplrconfiggeneraltableheadercols" > < a class = "header" href = "#xplrconfiggeneraltableheadercols" > xplr.config.general.table.header.cols< / a > < / h4 >
< p > Columns to display in the table header.< / p >
< p > Type: nullable list of tables with the following fields:< / p >
< ul >
< li > format: nullable string< / li >
< li > style: < a href = "https://xplr.dev/en/style" > Style< / a > < / li >
< / ul >
< h4 id = "xplrconfiggeneraltableheaderstyle" > < a class = "header" href = "#xplrconfiggeneraltableheaderstyle" > xplr.config.general.table.header.style< / a > < / h4 >
< p > Style of the table header.< / p >
< p > Type: < a href = "https://xplr.dev/en/style" > Style< / a > < / p >
< h4 id = "xplrconfiggeneraltableheaderheight" > < a class = "header" href = "#xplrconfiggeneraltableheaderheight" > xplr.config.general.table.header.height< / a > < / h4 >
< p > Height of the table header.< / p >
< p > Type: nullable integer< / p >
< h4 id = "xplrconfiggeneraltablerowcols" > < a class = "header" href = "#xplrconfiggeneraltablerowcols" > xplr.config.general.table.row.cols< / a > < / h4 >
< p > Columns to display in each row in the table.< / p >
< p > Type: nullable list of tables with the following fields:< / p >
< ul >
< li > format: nullable string< / li >
< li > style: < a href = "https://xplr.dev/en/style" > Style< / a > < / li >
< / ul >
< h4 id = "xplrconfiggeneraltablerowstyle" > < a class = "header" href = "#xplrconfiggeneraltablerowstyle" > xplr.config.general.table.row.style< / a > < / h4 >
< p > Default style of the table.< / p >
< p > Type: < a href = "https://xplr.dev/en/style" > Style< / a > < / p >
< h4 id = "xplrconfiggeneraltablerowheight" > < a class = "header" href = "#xplrconfiggeneraltablerowheight" > xplr.config.general.table.row.height< / a > < / h4 >
< p > Height of the table rows.< / p >
< p > Type: nullable integer< / p >
< h4 id = "xplrconfiggeneraltablestyle" > < a class = "header" href = "#xplrconfiggeneraltablestyle" > xplr.config.general.table.style< / a > < / h4 >
< p > Default style of the table.< / p >
< p > Type: < a href = "https://xplr.dev/en/style" > Style< / a > < / p >
< h4 id = "xplrconfiggeneraltabletree" > < a class = "header" href = "#xplrconfiggeneraltabletree" > xplr.config.general.table.tree< / a > < / h4 >
< p > Tree to display in the table.< / p >
< p > Type: nullable list of tables with the following fields:< / p >
< ul >
< li > format: nullable string< / li >
< li > style: < a href = "https://xplr.dev/en/style" > Style< / a > < / li >
< / ul >
< h4 id = "xplrconfiggeneraltablecol_spacing" > < a class = "header" href = "#xplrconfiggeneraltablecol_spacing" > xplr.config.general.table.col_spacing< / a > < / h4 >
< p > Spacing between the columns in the table.< / p >
< p > Type: nullable integer< / p >
< h4 id = "xplrconfiggeneraltablecol_widths" > < a class = "header" href = "#xplrconfiggeneraltablecol_widths" > xplr.config.general.table.col_widths< / a > < / h4 >
< p > Constraint for the column widths.< / p >
< p > Type: nullable list of < a href = "https://xplr.dev/en/layouts#constraint" > Constraint< / a > < / p >
< h4 id = "xplrconfiggeneraldefault_uiprefix" > < a class = "header" href = "#xplrconfiggeneraldefault_uiprefix" > xplr.config.general.default_ui.prefix< / a > < / h4 >
< p > The content that is placed before the item name for each row by default.< / p >
< p > Type: nullable string< / p >
< h4 id = "xplrconfiggeneraldefault_uisuffix" > < a class = "header" href = "#xplrconfiggeneraldefault_uisuffix" > xplr.config.general.default_ui.suffix< / a > < / h4 >
< p > The content which is appended to each item name for each row by default.< / p >
< p > Type: nullable string< / p >
< h4 id = "xplrconfiggeneraldefault_uistyle" > < a class = "header" href = "#xplrconfiggeneraldefault_uistyle" > xplr.config.general.default_ui.style< / a > < / h4 >
< p > The default style of each item for each row.< / p >
< p > Type: < a href = "https://xplr.dev/en/style" > Style< / a > < / p >
< h4 id = "xplrconfiggeneralfocus_uiprefix" > < a class = "header" href = "#xplrconfiggeneralfocus_uiprefix" > xplr.config.general.focus_ui.prefix< / a > < / h4 >
< p > The string placed before the item name for a focused row.< / p >
< p > Type: nullable string< / p >
< h4 id = "xplrconfiggeneralfocus_uisuffix" > < a class = "header" href = "#xplrconfiggeneralfocus_uisuffix" > xplr.config.general.focus_ui.suffix< / a > < / h4 >
< p > The string placed after the item name for a focused row.< / p >
< p > Type: nullable string< / p >
< h4 id = "xplrconfiggeneralfocus_uistyle" > < a class = "header" href = "#xplrconfiggeneralfocus_uistyle" > xplr.config.general.focus_ui.style< / a > < / h4 >
< p > Style for focused item.
Type: < a href = "https://xplr.dev/en/style" > Style< / a > < / p >
< h4 id = "xplrconfiggeneralselection_uiprefix" > < a class = "header" href = "#xplrconfiggeneralselection_uiprefix" > xplr.config.general.selection_ui.prefix< / a > < / h4 >
< p > The string placed before the item name for a selected row.< / p >
< p > Type: nullable string< / p >
< h4 id = "xplrconfiggeneralselection_uisuffix" > < a class = "header" href = "#xplrconfiggeneralselection_uisuffix" > xplr.config.general.selection_ui.suffix< / a > < / h4 >
< p > The string placed after the item name for a selected row.< / p >
< p > Type: nullable string< / p >
< h4 id = "xplrconfiggeneralselection_uistyle" > < a class = "header" href = "#xplrconfiggeneralselection_uistyle" > xplr.config.general.selection_ui.style< / a > < / h4 >
< p > Style for selected rows.< / p >
< p > Type: < a href = "https://xplr.dev/en/style" > Style< / a > < / p >
< h4 id = "xplrconfiggeneralfocus_selection_uiprefix" > < a class = "header" href = "#xplrconfiggeneralfocus_selection_uiprefix" > xplr.config.general.focus_selection_ui.prefix< / a > < / h4 >
< p > The string placed before item name for a selected row that gets the focus.< / p >
< p > Type: nullable string< / p >
< h4 id = "xplrconfiggeneralfocus_selection_uisuffix" > < a class = "header" href = "#xplrconfiggeneralfocus_selection_uisuffix" > xplr.config.general.focus_selection_ui.suffix< / a > < / h4 >
< p > The string placed after the item name for a selected row that gets the focus.< / p >
< p > Type: nullable string< / p >
< h4 id = "xplrconfiggeneralfocus_selection_uistyle" > < a class = "header" href = "#xplrconfiggeneralfocus_selection_uistyle" > xplr.config.general.focus_selection_ui.style< / a > < / h4 >
< p > Style for a selected row that gets the focus.< / p >
< p > Type: < a href = "https://xplr.dev/en/style" > Style< / a > < / p >
< h4 id = "xplrconfiggeneralsort_and_filter_uiseparatorformat" > < a class = "header" href = "#xplrconfiggeneralsort_and_filter_uiseparatorformat" > xplr.config.general.sort_and_filter_ui.separator.format< / a > < / h4 >
< p > The shape of the separator for the Sort & filter panel.< / p >
< p > Type: nullable string< / p >
< h4 id = "xplrconfiggeneralsort_and_filter_uiseparatorstyle" > < a class = "header" href = "#xplrconfiggeneralsort_and_filter_uiseparatorstyle" > xplr.config.general.sort_and_filter_ui.separator.style< / a > < / h4 >
< p > The style of the separator for the Sort & filter panel.< / p >
< p > Type: < a href = "https://xplr.dev/en/style" > Style< / a > < / p >
< h4 id = "xplrconfiggeneralsort_and_filter_uidefault_identifierformat" > < a class = "header" href = "#xplrconfiggeneralsort_and_filter_uidefault_identifierformat" > xplr.config.general.sort_and_filter_ui.default_identifier.format< / a > < / h4 >
< p > The content of the default identifier in Sort & filter panel.< / p >
< p > Type: nullable string< / p >
< h4 id = "xplrconfiggeneralsort_and_filter_uidefault_identifierstyle" > < a class = "header" href = "#xplrconfiggeneralsort_and_filter_uidefault_identifierstyle" > xplr.config.general.sort_and_filter_ui.default_identifier.style< / a > < / h4 >
< p > Style for the default identifier in Sort & filter panel.< / p >
< p > Type: < a href = "https://xplr.dev/en/style" > Style< / a > < / p >
< h4 id = "xplrconfiggeneralsort_and_filter_uisort_direction_identifiersforwardformat" > < a class = "header" href = "#xplrconfiggeneralsort_and_filter_uisort_direction_identifiersforwardformat" > xplr.config.general.sort_and_filter_ui.sort_direction_identifiers.forward.format< / a > < / h4 >
< p > The shape of the forward direction indicator for sort identifiers in Sort & filter panel.< / p >
< p > Type: nullable string< / p >
< h4 id = "xplrconfiggeneralsort_and_filter_uisort_direction_identifiersforwardstyle" > < a class = "header" href = "#xplrconfiggeneralsort_and_filter_uisort_direction_identifiersforwardstyle" > xplr.config.general.sort_and_filter_ui.sort_direction_identifiers.forward.style< / a > < / h4 >
< p > Style of forward direction indicator in Sort & filter panel.< / p >
< p > Type: < a href = "https://xplr.dev/en/style" > Style< / a > < / p >
< h4 id = "xplrconfiggeneralsort_and_filter_uisort_direction_identifiersreverseformat" > < a class = "header" href = "#xplrconfiggeneralsort_and_filter_uisort_direction_identifiersreverseformat" > xplr.config.general.sort_and_filter_ui.sort_direction_identifiers.reverse.format< / a > < / h4 >
< p > The shape of the reverse direction indicator for sort identifiers in Sort & filter panel.< / p >
< p > Type: nullable string< / p >
< h4 id = "xplrconfiggeneralsort_and_filter_uisort_direction_identifiersreversestyle" > < a class = "header" href = "#xplrconfiggeneralsort_and_filter_uisort_direction_identifiersreversestyle" > xplr.config.general.sort_and_filter_ui.sort_direction_identifiers.reverse.style< / a > < / h4 >
< p > Style of reverse direction indicator in Sort & filter panel.< / p >
< p > Type: < a href = "https://xplr.dev/en/style" > Style< / a > < / p >
< h4 id = "xplrconfiggeneralsort_and_filter_uisorter_identifiers" > < a class = "header" href = "#xplrconfiggeneralsort_and_filter_uisorter_identifiers" > xplr.config.general.sort_and_filter_ui.sorter_identifiers< / a > < / h4 >
< p > The identifiers used to denote applied sorters in the Sort & filter panel.< / p >
< p > Type: nullable mapping of the following key-value pairs:< / p >
< ul >
< li > key: < a href = "https://xplr.dev/en/sorting#sorter" > Sorter< / a > < / li >
< li > value:
< ul >
< li > format: nullable string< / li >
< li > style: < a href = "https://xplr.dev/en/style" > Style< / a > < / li >
< / ul >
< / li >
< / ul >
< h4 id = "xplrconfiggeneralsort_and_filter_uifilter_identifiers" > < a class = "header" href = "#xplrconfiggeneralsort_and_filter_uifilter_identifiers" > xplr.config.general.sort_and_filter_ui.filter_identifiers< / a > < / h4 >
< p > The identifiers used to denote applied filters in the Sort & filter panel.< / p >
< p > Type: nullable mapping of the following key-value pairs:< / p >
< ul >
< li > key: < a href = "https://xplr.dev/en/filtering#filter" > Filter< / a > < / li >
< li > value:
< ul >
< li > format: nullable string< / li >
< li > style: < a href = "https://xplr.dev/en/style" > Style< / a > < / li >
< / ul >
< / li >
< / ul >
2022-10-06 15:18:43 +00:00
< h4 id = "xplrconfiggeneralsort_and_filter_uisearch_identifier" > < a class = "header" href = "#xplrconfiggeneralsort_and_filter_uisearch_identifier" > xplr.config.general.sort_and_filter_ui.search_identifier< / a > < / h4 >
< p > The identifiers used to denote applied search input.< / p >
< p > Type: { format = nullable string, style = < a href = "https://xplr.dev/en/style" > Style< / a > }< / p >
2022-04-16 07:40:39 +00:00
< h4 id = "xplrconfiggeneralpanel_uidefaulttitleformat" > < a class = "header" href = "#xplrconfiggeneralpanel_uidefaulttitleformat" > xplr.config.general.panel_ui.default.title.format< / a > < / h4 >
< p > The content for panel title by default.< / p >
< p > Type: nullable string< / p >
< h4 id = "xplrconfiggeneralpanel_uidefaulttitlestyle" > < a class = "header" href = "#xplrconfiggeneralpanel_uidefaulttitlestyle" > xplr.config.general.panel_ui.default.title.style< / a > < / h4 >
< p > The style for panel title by default.< / p >
< p > Type: < a href = "https://xplr.dev/en/style" > Style< / a > < / p >
< h4 id = "xplrconfiggeneralpanel_uidefaultstyle" > < a class = "header" href = "#xplrconfiggeneralpanel_uidefaultstyle" > xplr.config.general.panel_ui.default.style< / a > < / h4 >
< p > Style of the panels by default.< / p >
< p > Type: < a href = "https://xplr.dev/en/style" > Style< / a > < / p >
< h4 id = "xplrconfiggeneralpanel_uidefaultborders" > < a class = "header" href = "#xplrconfiggeneralpanel_uidefaultborders" > xplr.config.general.panel_ui.default.borders< / a > < / h4 >
< p > Defines where to show borders for the panels by default.< / p >
< p > Type: nullable list of < a href = "https://xplr.dev/en/borders#border" > Border< / a > < / p >
< h4 id = "xplrconfiggeneralpanel_uidefaultborder_type" > < a class = "header" href = "#xplrconfiggeneralpanel_uidefaultborder_type" > xplr.config.general.panel_ui.default.border_type< / a > < / h4 >
< p > Type of the borders by default.< / p >
< p > Type: nullable < a href = "https://xplr.dev/en/borders#border-type" > Border Type< / a > < / p >
< h4 id = "xplrconfiggeneralpanel_uidefaultborder_style" > < a class = "header" href = "#xplrconfiggeneralpanel_uidefaultborder_style" > xplr.config.general.panel_ui.default.border_style< / a > < / h4 >
< p > Style of the panel borders by default.< / p >
< p > Type: < a href = "https://xplr.dev/en/style" > Style< / a > < / p >
< h4 id = "xplrconfiggeneralpanel_uitabletitleformat" > < a class = "header" href = "#xplrconfiggeneralpanel_uitabletitleformat" > xplr.config.general.panel_ui.table.title.format< / a > < / h4 >
< p > The content for the table panel title.< / p >
< p > Type: nullable string< / p >
< h4 id = "xplrconfiggeneralpanel_uitabletitlestyle" > < a class = "header" href = "#xplrconfiggeneralpanel_uitabletitlestyle" > xplr.config.general.panel_ui.table.title.style< / a > < / h4 >
< p > Style of the table panel title.< / p >
< p > Type: < a href = "https://xplr.dev/en/style" > Style< / a > < / p >
< h4 id = "xplrconfiggeneralpanel_uitablestyle" > < a class = "header" href = "#xplrconfiggeneralpanel_uitablestyle" > xplr.config.general.panel_ui.table.style< / a > < / h4 >
< p > Style of the table panel.< / p >
< p > Type: < a href = "https://xplr.dev/en/style" > Style< / a > < / p >
< h4 id = "xplrconfiggeneralpanel_uitableborders" > < a class = "header" href = "#xplrconfiggeneralpanel_uitableborders" > xplr.config.general.panel_ui.table.borders< / a > < / h4 >
< p > Defines where to show borders for the table panel.< / p >
< p > Type: nullable list of < a href = "https://xplr.dev/en/borders#border" > Border< / a > < / p >
< h4 id = "xplrconfiggeneralpanel_uitableborder_type" > < a class = "header" href = "#xplrconfiggeneralpanel_uitableborder_type" > xplr.config.general.panel_ui.table.border_type< / a > < / h4 >
< p > Type of the borders for table panel.< / p >
< p > Type: nullable < a href = "https://xplr.dev/en/borders#border-type" > Border Type< / a > < / p >
< h4 id = "xplrconfiggeneralpanel_uitableborder_style" > < a class = "header" href = "#xplrconfiggeneralpanel_uitableborder_style" > xplr.config.general.panel_ui.table.border_style< / a > < / h4 >
< p > Style of the table panel borders.< / p >
< p > Type: < a href = "https://xplr.dev/en/style" > Style< / a > < / p >
< h4 id = "xplrconfiggeneralpanel_uihelp_menutitleformat" > < a class = "header" href = "#xplrconfiggeneralpanel_uihelp_menutitleformat" > xplr.config.general.panel_ui.help_menu.title.format< / a > < / h4 >
< p > The content for the help menu panel title.< / p >
< p > Type: nullable string< / p >
< h4 id = "xplrconfiggeneralpanel_uihelp_menutitlestyle" > < a class = "header" href = "#xplrconfiggeneralpanel_uihelp_menutitlestyle" > xplr.config.general.panel_ui.help_menu.title.style< / a > < / h4 >
< p > Style of the help menu panel title.< / p >
< p > Type: < a href = "https://xplr.dev/en/style" > Style< / a > < / p >
< h4 id = "xplrconfiggeneralpanel_uihelp_menustyle" > < a class = "header" href = "#xplrconfiggeneralpanel_uihelp_menustyle" > xplr.config.general.panel_ui.help_menu.style< / a > < / h4 >
< p > Style of the help menu panel.< / p >
< p > Type: < a href = "https://xplr.dev/en/style" > Style< / a > < / p >
< h4 id = "xplrconfiggeneralpanel_uihelp_menuborders" > < a class = "header" href = "#xplrconfiggeneralpanel_uihelp_menuborders" > xplr.config.general.panel_ui.help_menu.borders< / a > < / h4 >
< p > Defines where to show borders for the help menu panel.< / p >
< p > Type: nullable list of < a href = "https://xplr.dev/en/borders#border" > Border< / a > < / p >
< h4 id = "xplrconfiggeneralpanel_uihelp_menuborder_type" > < a class = "header" href = "#xplrconfiggeneralpanel_uihelp_menuborder_type" > xplr.config.general.panel_ui.help_menu.border_type< / a > < / h4 >
< p > Type of the borders for help menu panel.< / p >
< p > Type: nullable < a href = "https://xplr.dev/en/borders#border-type" > Border Type< / a > < / p >
< h4 id = "xplrconfiggeneralpanel_uihelp_menuborder_style" > < a class = "header" href = "#xplrconfiggeneralpanel_uihelp_menuborder_style" > xplr.config.general.panel_ui.help_menu.border_style< / a > < / h4 >
< p > Style of the help menu panel borders.< / p >
< p > Type: < a href = "https://xplr.dev/en/style" > Style< / a > < / p >
< h4 id = "xplrconfiggeneralpanel_uiinput_and_logstitleformat" > < a class = "header" href = "#xplrconfiggeneralpanel_uiinput_and_logstitleformat" > xplr.config.general.panel_ui.input_and_logs.title.format< / a > < / h4 >
< p > The content for the input & logs panel title.< / p >
< p > Type: nullable string< / p >
< h4 id = "xplrconfiggeneralpanel_uiinput_and_logstitlestyle" > < a class = "header" href = "#xplrconfiggeneralpanel_uiinput_and_logstitlestyle" > xplr.config.general.panel_ui.input_and_logs.title.style< / a > < / h4 >
< p > Style of the input & logs panel title.< / p >
< p > Type: < a href = "https://xplr.dev/en/style" > Style< / a > < / p >
< h4 id = "xplrconfiggeneralpanel_uiinput_and_logsborders" > < a class = "header" href = "#xplrconfiggeneralpanel_uiinput_and_logsborders" > xplr.config.general.panel_ui.input_and_logs.borders< / a > < / h4 >
< h4 id = "xplrconfiggeneralpanel_uiinput_and_logsstyle" > < a class = "header" href = "#xplrconfiggeneralpanel_uiinput_and_logsstyle" > xplr.config.general.panel_ui.input_and_logs.style< / a > < / h4 >
< p > Style of the input & logs panel.< / p >
< p > Type: < a href = "https://xplr.dev/en/style" > Style< / a >
Defines where to show borders for the input & logs panel.< / p >
< p > Type: nullable list of < a href = "https://xplr.dev/en/borders#border" > Border< / a > < / p >
< h4 id = "xplrconfiggeneralpanel_uiinput_and_logsborder_type" > < a class = "header" href = "#xplrconfiggeneralpanel_uiinput_and_logsborder_type" > xplr.config.general.panel_ui.input_and_logs.border_type< / a > < / h4 >
< p > Type of the borders for input & logs panel.< / p >
< p > Type: nullable < a href = "https://xplr.dev/en/borders#border-type" > Border Type< / a > < / p >
< h4 id = "xplrconfiggeneralpanel_uiinput_and_logsborder_style" > < a class = "header" href = "#xplrconfiggeneralpanel_uiinput_and_logsborder_style" > xplr.config.general.panel_ui.input_and_logs.border_style< / a > < / h4 >
< p > Style of the input & logs panel borders.< / p >
< p > Type: < a href = "https://xplr.dev/en/style" > Style< / a > < / p >
< h4 id = "xplrconfiggeneralpanel_uiselectiontitleformat" > < a class = "header" href = "#xplrconfiggeneralpanel_uiselectiontitleformat" > xplr.config.general.panel_ui.selection.title.format< / a > < / h4 >
< p > The content for the selection panel title.< / p >
< p > Type: nullable string< / p >
< h4 id = "xplrconfiggeneralpanel_uiselectiontitlestyle" > < a class = "header" href = "#xplrconfiggeneralpanel_uiselectiontitlestyle" > xplr.config.general.panel_ui.selection.title.style< / a > < / h4 >
< p > Style of the selection panel title.< / p >
< p > Type: < a href = "https://xplr.dev/en/style" > Style< / a > < / p >
< h4 id = "xplrconfiggeneralpanel_uiselectionborders" > < a class = "header" href = "#xplrconfiggeneralpanel_uiselectionborders" > xplr.config.general.panel_ui.selection.borders< / a > < / h4 >
< h4 id = "xplrconfiggeneralpanel_uiselectionstyle" > < a class = "header" href = "#xplrconfiggeneralpanel_uiselectionstyle" > xplr.config.general.panel_ui.selection.style< / a > < / h4 >
< p > Style of the selection panel.< / p >
< p > Type: < a href = "https://xplr.dev/en/style" > Style< / a >
Defines where to show borders for the selection panel.< / p >
< p > Type: nullable list of < a href = "https://xplr.dev/en/borders#border" > Border< / a > < / p >
< h4 id = "xplrconfiggeneralpanel_uiselectionborder_type" > < a class = "header" href = "#xplrconfiggeneralpanel_uiselectionborder_type" > xplr.config.general.panel_ui.selection.border_type< / a > < / h4 >
< p > Type of the borders for selection panel.< / p >
< p > Type: nullable < a href = "https://xplr.dev/en/borders#border-type" > Border Type< / a > < / p >
< h4 id = "xplrconfiggeneralpanel_uiselectionborder_style" > < a class = "header" href = "#xplrconfiggeneralpanel_uiselectionborder_style" > xplr.config.general.panel_ui.selection.border_style< / a > < / h4 >
< p > Style of the selection panel borders.< / p >
< p > Type: < a href = "https://xplr.dev/en/style" > Style< / a > < / p >
< h4 id = "xplrconfiggeneralpanel_uisort_and_filtertitleformat" > < a class = "header" href = "#xplrconfiggeneralpanel_uisort_and_filtertitleformat" > xplr.config.general.panel_ui.sort_and_filter.title.format< / a > < / h4 >
< p > The content for the sort & filter panel title.< / p >
< p > Type: nullable string< / p >
< h4 id = "xplrconfiggeneralpanel_uisort_and_filtertitlestyle" > < a class = "header" href = "#xplrconfiggeneralpanel_uisort_and_filtertitlestyle" > xplr.config.general.panel_ui.sort_and_filter.title.style< / a > < / h4 >
< p > Style of the sort & filter panel title.< / p >
< p > Type: < a href = "https://xplr.dev/en/style" > Style< / a > < / p >
< h4 id = "xplrconfiggeneralpanel_uisort_and_filterstyle" > < a class = "header" href = "#xplrconfiggeneralpanel_uisort_and_filterstyle" > xplr.config.general.panel_ui.sort_and_filter.style< / a > < / h4 >
< p > Style of the sort & filter panel.< / p >
< p > Type: < a href = "https://xplr.dev/en/style" > Style< / a > < / p >
< h4 id = "xplrconfiggeneralpanel_uisort_and_filterborders" > < a class = "header" href = "#xplrconfiggeneralpanel_uisort_and_filterborders" > xplr.config.general.panel_ui.sort_and_filter.borders< / a > < / h4 >
< p > Defines where to show borders for the sort & filter panel.< / p >
< p > Type: nullable list of < a href = "https://xplr.dev/en/borders#border" > Border< / a > < / p >
< h4 id = "xplrconfiggeneralpanel_uisort_and_filterborder_type" > < a class = "header" href = "#xplrconfiggeneralpanel_uisort_and_filterborder_type" > xplr.config.general.panel_ui.sort_and_filter.border_type< / a > < / h4 >
< p > Type of the borders for sort & filter panel.< / p >
< p > Type: nullable < a href = "https://xplr.dev/en/borders#border-type" > Border Type< / a > < / p >
< h4 id = "xplrconfiggeneralpanel_uisort_and_filterborder_style" > < a class = "header" href = "#xplrconfiggeneralpanel_uisort_and_filterborder_style" > xplr.config.general.panel_ui.sort_and_filter.border_style< / a > < / h4 >
< p > Style of the sort & filter panel borders.< / p >
< p > Type: < a href = "https://xplr.dev/en/style" > Style< / a > < / p >
< h4 id = "xplrconfiggeneralinitial_sorting" > < a class = "header" href = "#xplrconfiggeneralinitial_sorting" > xplr.config.general.initial_sorting< / a > < / h4 >
< p > Initial group if sorters applied to the nodes list in the table.< / p >
< p > Type: nullable list of < a href = "https://xplr.dev/en/sorting#node-sorter-applicable" > Node Sorter< / a > < / p >
< h4 id = "xplrconfiggeneralinitial_mode" > < a class = "header" href = "#xplrconfiggeneralinitial_mode" > xplr.config.general.initial_mode< / a > < / h4 >
< p > The name of one of the modes to use when xplr loads.< / p >
< p > Type: nullable string< / p >
< h4 id = "xplrconfiggeneralinitial_layout" > < a class = "header" href = "#xplrconfiggeneralinitial_layout" > xplr.config.general.initial_layout< / a > < / h4 >
< p > The name of one of the layouts to use when xplr loads.< / p >
< p > Type: nullable string< / p >
< h4 id = "xplrconfiggeneralstart_fifo" > < a class = "header" href = "#xplrconfiggeneralstart_fifo" > xplr.config.general.start_fifo< / a > < / h4 >
< p > Set it to a file path to start fifo when xplr loads.
Generally it is used to integrate with external tools like previewers.< / p >
< p > Type: nullable string< / p >
2022-06-06 14:14:13 +00:00
< h4 id = "xplrconfiggeneralglobal_key_bindings" > < a class = "header" href = "#xplrconfiggeneralglobal_key_bindings" > xplr.config.general.global_key_bindings< / a > < / h4 >
< p > Use it to define a set of key bindings that are available by default in
every < a href = "https://xplr.dev/en/mode" > mode< / a > . They can be overwritten.< / p >
< p > Type: < a href = "https://xplr.dev/en/configure-key-bindings#key-bindings" > Key Bindings< / a > < / p >
2022-04-16 07:40:39 +00:00
< / main >
< nav class = "nav-wrapper" aria-label = "Page navigation" >
<!-- Mobile navigation buttons -->
< a rel = "prev" href = "configuration.html" class = "mobile-nav-chapters previous" title = "Previous chapter" aria-label = "Previous chapter" aria-keyshortcuts = "Left" >
< i class = "fa fa-angle-left" > < / i >
< / a >
< a rel = "next" href = "node_types.html" class = "mobile-nav-chapters next" title = "Next chapter" aria-label = "Next chapter" aria-keyshortcuts = "Right" >
< i class = "fa fa-angle-right" > < / i >
< / a >
< div style = "clear: both" > < / div >
< / nav >
< / div >
< / div >
< nav class = "nav-wide-wrapper" aria-label = "Page navigation" >
< a rel = "prev" href = "configuration.html" class = "nav-chapters previous" title = "Previous chapter" aria-label = "Previous chapter" aria-keyshortcuts = "Left" >
< i class = "fa fa-angle-left" > < / i >
< / a >
< a rel = "next" href = "node_types.html" class = "nav-chapters next" title = "Next chapter" aria-label = "Next chapter" aria-keyshortcuts = "Right" >
< i class = "fa fa-angle-right" > < / i >
< / a >
< / nav >
< / div >
< script type = "text/javascript" >
window.playground_copyable = true;
< / script >
< script src = "elasticlunr.min.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "mark.min.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "searcher.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "clipboard.min.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "highlight.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "book.js" type = "text/javascript" charset = "utf-8" > < / script >
<!-- Custom JS scripts -->
< / body >
< / html >
