X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;ds=sidebyside;f=runtime%2Fhelp%2Fhelp.md;h=94db565d42b280b0913ec3eb989a4305f998944c;hb=0a500be3ba5f29bae5f0976ac7ecbc0f80e20446;hp=5863b8a581b6f3ac8ecdd50cc9bf09b43ed03493;hpb=1f62ff9d80d39240b077bb026deb97a631a4595b;p=micro.git diff --git a/runtime/help/help.md b/runtime/help/help.md index 5863b8a5..94db565d 100644 --- a/runtime/help/help.md +++ b/runtime/help/help.md @@ -1,107 +1,60 @@ # Micro help text -### Keybindings +Thank you for downloading and using micro. -These are the default keybindings, along with their actions. +Micro is a terminal-based text editor that aims to be easy to use and intuitive, +while also taking advantage of the full capabilities of modern terminals. -#### Editor bindings +If you want to see all the keybindings press CtrlE and type `help keybindings`. -* Ctrl-q: Quit -* Ctrl-e: Execute a command -* Ctrl-g: Toggle help text -* Ctrl-b: Run a shell command +See the next section for more information about documentation and help. -#### Buffer bindings -* Ctrl-s: Save -* Ctrl-o: Open file +## Quick-start -* Ctrl-z: Undo -* Ctrl-y: Redo +Press CtrlQ to quit, and CtrlS to save. Press CtrlE to start typing commands and +you can see which commands are available by pressing tab, or by viewing the help +topic `> help commands`. When I write `> ...` I mean press CtrlE and then type +whatever is there. -* Ctrl-f: Find -* Ctrl-n: Find next -* Ctrl-p: Find previous +Move the cursor around with the mouse or the arrow keys. Type +`> help defaultkeys` to get a quick, easy overview of the default hotkeys and +what they do. For more info on rebinding keys, see type `> help keybindings`. -* Ctrl-a: Select all +If the colorscheme doesn't look good, you can change it with +`> set colorscheme ...`. You can press tab to see the available colorschemes, or +see more information with `> help colors`. -* Ctrl-c: Copy -* Ctrl-x: Cut -* Ctrl-k: Cut line -* Ctrl-v: Paste +Press CtrlW to move between splits, and type `> vsplit filename` or +`> hsplit filename` to open a new split. -* Ctrl-u: Half page up -* Ctrl-d: Half page down -* PageUp: Page up -* PageDown: Page down -* Home: Go to beginning of file -* End: Go to end of file +## Accessing more help -* Ctrl-r: Toggle line numbers +Micro has a built-in help system much like Vim's (although less extensive). -The buffer bindings may be rebound using the `~/.config/micro/bindings.json` file. Each key is bound to an action. +To use it, press CtrlE to access command mode and type in `help` followed by a +topic. Typing `help` followed by nothing will open this page. -For example, to bind `Ctrl-y` to undo and `Ctrl-z` to redo, you could put the following in the `bindings.json` file. +Here are the possible help topics that you can read: -```json -{ - "CtrlY": "Undo", - "CtrlZ": "Redo" -} -``` +* tutorial: A brief tutorial which gives an overview of all the other help + topics +* keybindings: Gives a full list of the default keybindings as well as how to + rebind them +* defaultkeys: Gives a more straight-forward list of the hotkey commands and what + they do. +* commands: Gives a list of all the commands and what they do +* options: Gives a list of all the options you can customize +* plugins: Explains how micro's plugin system works and how to create your own + plugins +* colors: Explains micro's colorscheme and syntax highlighting engine and how to + create your own colorschemes or add new languages to the engine -### Possible commands +For example, to open the help page on plugins you would press CtrlE and type +`help plugins`. -You can execute an editor command by pressing `Ctrl-e` followed by the command. -Here are the possible commands that you can use. - -* `quit`: Quits micro. -* `save`: Saves the current buffer. - -`replace "search" "value"`: This will replace `search` with `value`. -Note that `search` must be a valid regex. If one of the arguments -does not have any spaces in it, you may omit the quotes. - -`set option value`: sets the option to value. Please see the next section for a list of options you can set. - -`run sh-command`: runs the given shell command in the background. The command's output will be displayed -in one line when it finishes running. - -### Options - -Micro stores all of the user configuration in its configuration directory. - -Micro uses the `$XDG_CONFIG_HOME/micro` as the configuration directory. As per the XDG spec, -if `$XDG_CONFIG_HOME` is not set, `~/.config/micro` is used as the config directory. - -Here are the options that you can set: - -`colorscheme`: loads the colorscheme stored in $(configDir)/colorschemes/`option`.micro - default value: `default` - Note that the default colorschemes (default, solarized, and solarized-tc) are not located in configDir, - because they are embedded in the micro binary - -`tabsize`: sets the tab size to `option` - default value: `4` - -`syntax`: turns syntax on or off - default value: `on` - -`tabsToSpaces`: use spaces instead of tabs - default value: `off` - -`autoindent`: when creating a new line use the same indentation as the previous line - default value: `on` - -`ruler`: display line numbers - default value: `on` - -`gofmt`: Run `gofmt` whenever the file is saved (this only applies to `.go` files) - default value: `off` - -`goimports`: run `goimports` whenever the file is saved (this only applies to `.go` files) - default value: `off` - -In the future, the `gofmt` and `goimports` will be refactored using a plugin system. However, -currently they just make it easier to program micro in micro. +I recommend looking at the `tutorial` help file because it is short for each +section and gives concrete examples of how to use the various configuration +options in micro. However, it does not give the in-depth documentation that the +other topics provide.