2022-12-07 15:30:18 +04:00
<!DOCTYPE HTML>
< html lang = "en" class = "sidebar-visible no-js colibri" >
< head >
<!-- Book generated using mdBook -->
< meta charset = "UTF-8" >
< title > Key Remapping< / title >
2022-12-15 12:50:32 +04:00
2022-12-07 15:30:18 +04:00
<!-- Custom HTML head -->
2022-12-15 12:50:32 +04:00
2022-12-07 15:30:18 +04:00
< meta content = "text/html; charset=utf-8" http-equiv = "Content-Type" >
< meta name = "description" content = "" >
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
< meta name = "theme-color" content = "#ffffff" / >
< link rel = "icon" href = "favicon.svg" >
< 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" >
2022-12-15 12:50:32 +04:00
2022-12-07 15:30:18 +04:00
<!-- Fonts -->
< link rel = "stylesheet" href = "FontAwesome/css/font-awesome.css" >
< link rel = "preconnect" href = "https://fonts.gstatic.com" >
< link href = "https://fonts.googleapis.com/css2?family=Inter:wght@200;400;500;700&display=swap" rel = "stylesheet" >
< link rel = "stylesheet" href = "fonts/fonts.css" >
2022-12-15 12:50:32 +04:00
2022-12-07 15:30:18 +04:00
<!-- 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 -->
2022-12-15 12:50:32 +04:00
2022-12-07 15:30:18 +04:00
< / 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 ? "colibri" : "colibri";
< / 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('colibri')
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" >
< ol class = "chapter" > < li class = "chapter-item expanded affix " > < a href = "title-page.html" > Helix< / a > < / li > < li class = "chapter-item expanded " > < a href = "install.html" > < strong aria-hidden = "true" > 1.< / strong > Installation< / a > < / li > < li class = "chapter-item expanded " > < a href = "usage.html" > < strong aria-hidden = "true" > 2.< / strong > Usage< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "keymap.html" > < strong aria-hidden = "true" > 2.1.< / strong > Keymap< / a > < / li > < li class = "chapter-item expanded " > < a href = "commands.html" > < strong aria-hidden = "true" > 2.2.< / strong > Commands< / a > < / li > < li class = "chapter-item expanded " > < a href = "lang-support.html" > < strong aria-hidden = "true" > 2.3.< / strong > Language Support< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < a href = "from-vim.html" > < strong aria-hidden = "true" > 3.< / strong > Migrating from Vim< / a > < / li > < li class = "chapter-item expanded " > < a href = "configuration.html" > < strong aria-hidden = "true" > 4.< / strong > Configuration< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "themes.html" > < strong aria-hidden = "true" > 4.1.< / strong > Themes< / a > < / li > < li class = "chapter-item expanded " > < a href = "remapping.html" class = "active" > < strong aria-hidden = "true" > 4.2.< / strong > Key Remapping< / a > < / li > < li class = "chapter-item expanded " > < a href = "languages.html" > < strong aria-hidden = "true" > 4.3.< / strong > Languages< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < a href = "guides/index.html" > < strong aria-hidden = "true" > 5.< / strong > Guides< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "guides/adding_languages.html" > < strong aria-hidden = "true" > 5.1.< / strong > Adding Languages< / a > < / li > < li class = "chapter-item expanded " > < a href = "guides/textobject.html" > < strong aria-hidden = "true" > 5.2.< / strong > Adding Textobject Queries< / a > < / li > < li class = "chapter-item expanded " > < a href = "guides/indent.html" > < strong aria-hidden = "true" > 5.3.< / strong > Adding Indent Queries< / a > < / li > < / ol > < / li > < / ol >
< / div >
< div id = "sidebar-resize-handle" class = "sidebar-resize-handle" > < / div >
< / nav >
< div id = "page-wrapper" class = "page-wrapper" >
< div class = "page" >
2022-12-15 12:50:32 +04:00
< div id = "menu-bar-hover-placeholder" > < / div >
2022-12-07 15:30:18 +04:00
< 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 >
< li role = "none" > < button role = "menuitem" class = "theme" id = "colibri" > Colibri (default)< / 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" > < / 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 >
2022-12-12 06:00:08 +04:00
< a href = "https://github.com/helix-editor/helix" title = "Git repository" aria-label = "Git repository" >
< i id = "git-repository-button" class = "fa fa-github" > < / i >
< / a >
2022-12-07 15:30:18 +04:00
< / div >
< / div >
< div id = "search-wrapper" class = "hidden" >
< form id = "searchbar-outer" class = "searchbar-outer" >
< input type = "search" name = "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 >
2022-12-15 12:50:32 +04:00
2022-12-07 15:30:18 +04:00
<!-- 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 >
< h1 id = "key-remapping" > < a class = "header" href = "#key-remapping" > Key Remapping< / a > < / h1 >
< p > One-way key remapping is temporarily supported via a simple TOML configuration
file. (More powerful solutions such as rebinding via commands will be
available in the future).< / p >
< p > To remap keys, write a < code > config.toml< / code > file in your < code > helix< / code > configuration
directory (default < code > ~/.config/helix< / code > in Linux systems) with a structure like
this:< / p >
< pre > < code class = "language-toml" > # At most one section each of 'keys.normal', 'keys.insert' and 'keys.select'
[keys.normal]
C-s = " :w" # Maps the Ctrl-s to the typable command :w which is an alias for :write (save file)
C-o = " :open ~/.config/helix/config.toml" # Maps the Ctrl-o to opening of the helix config file
a = " move_char_left" # Maps the 'a' key to the move_char_left command
w = " move_line_up" # Maps the 'w' key move_line_up
" C-S-esc" = " extend_line" # Maps Ctrl-Shift-Escape to extend_line
g = { a = " code_action" } # Maps `ga` to show possible code actions
" ret" = [" open_below" , " normal_mode" ] # Maps the enter key to open_below then re-enter normal mode
[keys.insert]
" A-x" = " normal_mode" # Maps Alt-X to enter normal mode
j = { k = " normal_mode" } # Maps `jk` to exit insert mode
< / code > < / pre >
< blockquote >
< p > NOTE: Typable commands can also be remapped, remember to keep the < code > :< / code > prefix to indicate it's a typable command.< / p >
< / blockquote >
< p > Ctrl, Shift and Alt modifiers are encoded respectively with the prefixes
< code > C-< / code > , < code > S-< / code > and < code > A-< / code > . Special keys are encoded as follows:< / p >
< div class = "table-wrapper" > < table > < thead > < tr > < th > Key name< / th > < th > Representation< / th > < / tr > < / thead > < tbody >
< tr > < td > Backspace< / td > < td > < code > " backspace" < / code > < / td > < / tr >
< tr > < td > Space< / td > < td > < code > " space" < / code > < / td > < / tr >
< tr > < td > Return/Enter< / td > < td > < code > " ret" < / code > < / td > < / tr >
< tr > < td > -< / td > < td > < code > " minus" < / code > < / td > < / tr >
< tr > < td > Left< / td > < td > < code > " left" < / code > < / td > < / tr >
< tr > < td > Right< / td > < td > < code > " right" < / code > < / td > < / tr >
< tr > < td > Up< / td > < td > < code > " up" < / code > < / td > < / tr >
< tr > < td > Down< / td > < td > < code > " down" < / code > < / td > < / tr >
< tr > < td > Home< / td > < td > < code > " home" < / code > < / td > < / tr >
< tr > < td > End< / td > < td > < code > " end" < / code > < / td > < / tr >
< tr > < td > Page Up< / td > < td > < code > " pageup" < / code > < / td > < / tr >
< tr > < td > Page Down< / td > < td > < code > " pagedown" < / code > < / td > < / tr >
< tr > < td > Tab< / td > < td > < code > " tab" < / code > < / td > < / tr >
< tr > < td > Delete< / td > < td > < code > " del" < / code > < / td > < / tr >
< tr > < td > Insert< / td > < td > < code > " ins" < / code > < / td > < / tr >
< tr > < td > Null< / td > < td > < code > " null" < / code > < / td > < / tr >
< tr > < td > Escape< / td > < td > < code > " esc" < / code > < / td > < / tr >
< / tbody > < / table >
< / div >
< p > Keys can be disabled by binding them to the < code > no_op< / code > command.< / p >
< p > Commands can be found at < a href = "https://docs.helix-editor.com/keymap.html" > Keymap< / a > Commands.< / p >
< blockquote >
< p > Commands can also be found in the source code at < a href = "https://github.com/helix-editor/helix/blob/master/helix-term/src/commands.rs" > < code > helix-term/src/commands.rs< / code > < / a > at the invocation of < code > static_commands!< / code > macro and the < code > TypableCommandList< / code > .< / p >
< / blockquote >
< / main >
< nav class = "nav-wrapper" aria-label = "Page navigation" >
<!-- Mobile navigation buttons -->
< a rel = "prev" href = "themes.html" class = "mobile-nav-chapters previous" title = "Previous chapter" aria-label = "Previous chapter" aria-keyshortcuts = "Left" >
< i class = "fa fa-angle-left" > < / i >
< / a >
2022-12-15 12:50:32 +04:00
2022-12-07 15:30:18 +04:00
< a rel = "next" href = "languages.html" class = "mobile-nav-chapters next" title = "Next chapter" aria-label = "Next chapter" aria-keyshortcuts = "Right" >
< i class = "fa fa-angle-right" > < / i >
< / a >
2022-12-15 12:50:32 +04:00
2022-12-07 15:30:18 +04:00
< div style = "clear: both" > < / div >
< / nav >
< / div >
< / div >
< nav class = "nav-wide-wrapper" aria-label = "Page navigation" >
< a rel = "prev" href = "themes.html" class = "nav-chapters previous" title = "Previous chapter" aria-label = "Previous chapter" aria-keyshortcuts = "Left" >
< i class = "fa fa-angle-left" > < / i >
< / a >
2022-12-15 12:50:32 +04:00
2022-12-07 15:30:18 +04:00
< a rel = "next" href = "languages.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 >
2022-12-15 12:50:32 +04:00
2022-12-07 15:30:18 +04:00
< script type = "text/javascript" >
window.playground_copyable = true;
< / script >
2022-12-15 12:50:32 +04:00
2022-12-07 15:30:18 +04:00
< 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 >
2022-12-15 12:50:32 +04:00
2022-12-07 15:30:18 +04:00
< 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 -->
2022-12-15 12:50:32 +04:00
2022-12-07 15:30:18 +04:00
< / body >
< / html >
