<!DOCTYPE HTML>
< html lang = "en" class = "sidebar-visible no-js colibri" >
< head >
<!-- Book generated using mdBook -->
< meta charset = "UTF-8" >
< title > Usage< / title >
<!-- Custom HTML head -->
< 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" >
<!-- 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" >
<!-- 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 -->
< / 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 " > < a href = "install.html" > < strong aria-hidden = "true" > 1.< / strong > Installation< / a > < / li > < li class = "chapter-item expanded " > < a href = "usage.html" class = "active" > < strong aria-hidden = "true" > 2.< / strong > Usage< / a > < / 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 = "keymap.html" > < strong aria-hidden = "true" > 4.2.< / strong > Keymap< / a > < / li > < li class = "chapter-item expanded " > < a href = "remapping.html" > < strong aria-hidden = "true" > 4.3.< / strong > Key Remapping< / a > < / li > < li class = "chapter-item expanded " > < a href = "hooks.html" > < strong aria-hidden = "true" > 4.4.< / strong > Hooks< / a > < / li > < li class = "chapter-item expanded " > < a href = "languages.html" > < strong aria-hidden = "true" > 4.5.< / 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 > < / 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" >
< 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 >
< 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 >
< / 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 >
<!-- 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 = "usage" > < a class = "header" href = "#usage" > Usage< / a > < / h1 >
< p > (Currently not fully documented, see the < a href = "./keymap.html" > keymappings< / a > list for more.)< / p >
< p > See < a href = "https://github.com/helix-editor/helix/blob/master/runtime/tutor.txt" > tutor.txt< / a > (accessible via < code > hx --tutor< / code > or < code > :tutor< / code > ) for a vimtutor-like introduction.< / p >
< h2 id = "registers" > < a class = "header" href = "#registers" > Registers< / a > < / h2 >
< p > Vim-like registers can be used to yank and store text to be pasted later. Usage is similar, with < code > " < / code > being used to select a register:< / p >
< ul >
< li > < code > " ay< / code > - Yank the current selection to register < code > a< / code > .< / li >
< li > < code > " op< / code > - Paste the text in register < code > o< / code > after the selection.< / li >
< / ul >
< p > If there is a selected register before invoking a change or delete command, the selection will be stored in the register and the action will be carried out:< / p >
< ul >
< li > < code > " hc< / code > - Store the selection in register < code > h< / code > and then change it (delete and enter insert mode).< / li >
< li > < code > " md< / code > - Store the selection in register < code > m< / code > and delete it.< / li >
< / ul >
< h3 id = "special-registers" > < a class = "header" href = "#special-registers" > Special Registers< / a > < / h3 >
< table > < thead > < tr > < th > Register character< / th > < th > Contains< / th > < / tr > < / thead > < tbody >
< tr > < td > < code > /< / code > < / td > < td > Last search< / td > < / tr >
< tr > < td > < code > :< / code > < / td > < td > Last executed command< / td > < / tr >
< tr > < td > < code > " < / code > < / td > < td > Last yanked text< / td > < / tr >
< tr > < td > < code > _< / code > < / td > < td > Black hole< / td > < / tr >
< / tbody > < / table >
< blockquote >
< p > There is no special register for copying to system clipboard, instead special commands and keybindings are provided. See the < a href = "keymap.html#space-mode" > keymap< / a > for the specifics.
The black hole register works as a no-op register, meaning no data will be written to / read from it.< / p >
< / blockquote >
< h2 id = "surround" > < a class = "header" href = "#surround" > Surround< / a > < / h2 >
< p > Functionality similar to < a href = "https://github.com/tpope/vim-surround" > vim-surround< / a > is built into
helix. The keymappings have been inspired from < a href = "https://github.com/machakann/vim-sandwich" > vim-sandwich< / a > :< / p >
< p > < img src = "https://user-images.githubusercontent.com/23398472/122865801-97073180-d344-11eb-8142-8f43809982c6.gif" alt = "surround demo" / > < / p >
< ul >
< li > < code > ms< / code > - Add surround characters< / li >
< li > < code > mr< / code > - Replace surround characters< / li >
< li > < code > md< / code > - Delete surround characters< / li >
< / ul >
< p > < code > ms< / code > acts on a selection, so select the text first and use < code > ms< char> < / code > . < code > mr< / code > and < code > md< / code > work
on the closest pairs found and selections are not required; use counts to act in outer pairs.< / p >
< p > It can also act on multiple seletions (yay!). For example, to change every occurance of < code > (use)< / code > to < code > [use]< / code > :< / p >
< ul >
< li > < code > %< / code > to select the whole file< / li >
< li > < code > s< / code > to split the selections on a search term< / li >
< li > Input < code > use< / code > and hit Enter< / li >
< li > < code > mr([< / code > to replace the parens with square brackets< / li >
< / ul >
< p > Multiple characters are currently not supported, but planned.< / p >
< h2 id = "textobjects" > < a class = "header" href = "#textobjects" > Textobjects< / a > < / h2 >
< p > Currently supported: < code > word< / code > , < code > surround< / code > , < code > function< / code > , < code > class< / code > , < code > parameter< / code > .< / p >
< p > < img src = "https://user-images.githubusercontent.com/23398472/124231131-81a4bb00-db2d-11eb-9d10-8e577ca7b177.gif" alt = "textobject-demo" / >
< img src = "https://user-images.githubusercontent.com/23398472/132537398-2a2e0a54-582b-44ab-a77f-eb818942203d.gif" alt = "textobject-treesitter-demo" / > < / p >
< ul >
< li > < code > ma< / code > - Select around the object (< code > va< / code > in vim, < code > < alt-a> < / code > in kakoune)< / li >
< li > < code > mi< / code > - Select inside the object (< code > vi< / code > in vim, < code > < alt-i> < / code > in kakoune)< / li >
< / ul >
< table > < thead > < tr > < th > Key after < code > mi< / code > or < code > ma< / code > < / th > < th > Textobject selected< / th > < / tr > < / thead > < tbody >
< tr > < td > < code > w< / code > < / td > < td > Word< / td > < / tr >
< tr > < td > < code > W< / code > < / td > < td > WORD< / td > < / tr >
< tr > < td > < code > (< / code > , < code > [< / code > , < code > '< / code > , etc< / td > < td > Specified surround pairs< / td > < / tr >
< tr > < td > < code > f< / code > < / td > < td > Function< / td > < / tr >
< tr > < td > < code > c< / code > < / td > < td > Class< / td > < / tr >
< tr > < td > < code > p< / code > < / td > < td > Parameter< / td > < / tr >
< / tbody > < / table >
< p > Note: < code > f< / code > , < code > c< / code > , etc need a tree-sitter grammar active for the current
document and a special tree-sitter query file to work properly. < a href = "https://github.com/search?q=repo%3Ahelix-editor%2Fhelix+filename%3Atextobjects.scm&type=Code&ref=advsearch&l=&l=" > Only
some grammars< / a >
currently have the query file implemented. Contributions are welcome !< / p >
< / main >
< nav class = "nav-wrapper" aria-label = "Page navigation" >
<!-- Mobile navigation buttons -->
< a rel = "prev" href = "install.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 = "from-vim.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 = "install.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 = "from-vim.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 >
