From 0f4f60c018a396e42f00f45b1279fcb06fa046e1 Mon Sep 17 00:00:00 2001 From: Zachary Yedidia Date: Sat, 15 Jun 2019 22:08:10 -0400 Subject: [PATCH] Update docs --- runtime/help/gimmickcolors.md | 14 -------------- runtime/help/keybindings.md | 3 ++- runtime/help/options.md | 36 +++++++++++++++++++---------------- 3 files changed, 22 insertions(+), 31 deletions(-) delete mode 100644 runtime/help/gimmickcolors.md diff --git a/runtime/help/gimmickcolors.md b/runtime/help/gimmickcolors.md deleted file mode 100644 index b13a6456..00000000 --- a/runtime/help/gimmickcolors.md +++ /dev/null @@ -1,14 +0,0 @@ -# Gimmick colors - -We have included a few colorschemes that are for fun: - -* funky-cactus: I don't know why I made this. (Written by CaptainMcClellan) -* gameboy-tc: Colorscheme based on the olive green original Gameboy! -* nes-tc: A colorscheme and syntax highlighting using only colors in the - Nintendo Entertainment System color palette. -* symbian-tc: Colorscheme based on SymbOS's GUI. -* matrix: Pretend it's 1981 with a colorscheme based on a monochrome - IBM 5151. (Does not include the ghosting and trailing) - -Check the plugin repo periodically for gimmick-color extension packs and genuine -additional themes. \ No newline at end of file diff --git a/runtime/help/keybindings.md b/runtime/help/keybindings.md index eee3e2fa..661c02fa 100644 --- a/runtime/help/keybindings.md +++ b/runtime/help/keybindings.md @@ -8,7 +8,8 @@ command or you can also be added in the file `~/.config/micro/bindings.json` as discussed below. For a list of the default keybindings in the json format used by micro, please see the end of this file. For a more user-friendly list with explanations of what the default hotkeys are and what they do, please see -`>help defaultkeys` +`> help defaultkeys` (a json formatted list of default keys is included +at the end of this document). If `~/.config/micro/bindings.json` does not exist, you can simply create it. Micro will know what to do with it. diff --git a/runtime/help/options.md b/runtime/help/options.md index 0a85d4ae..d9a44aec 100644 --- a/runtime/help/options.md +++ b/runtime/help/options.md @@ -51,8 +51,12 @@ Here are the options that you can set: default value: `true` -* `eofnewline`: micro will automatically add a newline to the end of the file - when saving. +* `encoding`: the encoding to open and save files with. Supported encodings + are listed at https://www.w3.org/TR/encoding/. + + default value: `utf-8` + +* `eofnewline`: micro will automatically add a newline to the file. default value: `false` @@ -109,6 +113,16 @@ Here are the options that you can set: default value: `false` +* `matchbrace`: highlight matching braces for '()', '{}', '[]' + + default value: `false` + +* `matchbraceleft`: when matching a closing brace, should matching match the + brace directly under the cursor, or the character to the left? only matters + if `matchbrace` is true + + default value: `false` + * `mouse`: whether to enable mouse support. When mouse support is disabled, usually the terminal will be able to access mouse events which can be useful if you want to copy from the terminal instead of from micro (if over ssh for @@ -190,26 +204,16 @@ Here are the options that you can set: default value: `true` -* `matchbrace`: highlight matching braces for '()', '{}', '[]' - - default value: `false` - -* `matchbraceleft`: when matching a closing brace, should matching match the - brace directly under the cursor, or the character to the left? only matters - if `matchbrace` is true - - default value: `false` - -* `syntax`: turns syntax highlighting on or off. - - default value: `true` - * `sucmd`: specifies the super user command. On most systems this is "sudo" but on BSD it can be "doas." This option can be customized and is only used when saving with su. default value: `sudo` +* `syntax`: turns syntax on or off. + + default value: `true` + * `tabmovement`: navigate spaces at the beginning of lines as if they are tabs (e.g. move over 4 spaces at once). This option only does anything if `tabstospaces` is on.