X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;f=runtime%2Fhelp%2Fhelp.md;h=662642602ab3bf417b6c38b9012c36c8ef501210;hb=ea6a87d41a9fcaa9fff81c1a5310726b1e15c548;hp=84265a4819acfc0ac391e70a357fe633b8d7c739;hpb=c903e949ef48ed8d5258996e740ef8e3c44c129d;p=micro.git diff --git a/runtime/help/help.md b/runtime/help/help.md index 84265a48..66264260 100644 --- a/runtime/help/help.md +++ b/runtime/help/help.md @@ -1,138 +1,62 @@ # Micro help text +Thank you for downloading and using micro. + 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. -### Usage - -Once you have built the editor, simply start it by running `micro path/to/file.txt` or simply `micro` to open an empty buffer. - -Micro also supports creating buffers from stdin: - -``` -$ ifconfig | micro -``` - -You can move the cursor around with the arrow keys and mouse. - -### Keybindings - -These are the default keybindings, along with their actions. - -#### Editor bindings - -* Ctrl-q: Quit -* Ctrl-e: Execute a command -* Ctrl-g: Toggle help text -* Ctrl-b: Run a shell command - -#### Buffer bindings - -* Ctrl-s: Save -* Ctrl-o: Open file -* Ctrl-z: Undo -* Ctrl-y: Redo -* Ctrl-f: Find -* Ctrl-n: Find next -* Ctrl-p: Find previous -* Ctrl-a: Select all -* Ctrl-c: Copy -* Ctrl-x: Cut -* Ctrl-k: Cut line -* Ctrl-v: Paste -* 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 -* Ctrl-r: Toggle line numbers - -The buffer bindings may be rebound using the `~/.config/micro/bindings.json` file. Each key is bound to an action. - -For example, to bind `Ctrl-y` to undo and `Ctrl-z` to redo, you could put the following in the `bindings.json` file. - -```json -{ - "CtrlY": "Undo", - "CtrlZ": "Redo" -} -``` - -### Possible commands - -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 - - The colorscheme can be selected from all the files in the ~/.config/micro/colorschemes/ directory. Micro comes by default with three colorschemes: - - * default: this is the default colorscheme. - * solarized: this is the solarized colorscheme (used in the screenshot). You should have the - solarized color palette in your terminal to use it. - * solarized-tc: this is the solarized colorscheme for true color, just make sure - your terminal supports true color before using it and that the MICRO_TRUECOLOR environment - variable is set to 1 before starting micro. - -* `tabsize`: sets the tab size to `option` - default value: `4` +For a list of the default keybindings press CtrlE and type `help defaultkeys`. +For more information on keybindings see `> help keybindings`. -* `syntax`: turns syntax on or off +See the next section for more information about documentation and help. - default value: `on` +## Quick-start -* `tabsToSpaces`: use spaces instead of tabs +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. - default value: `off` +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`. -* `autoindent`: when creating a new line use the same indentation as the previous line +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`. - default value: `on` +Press CtrlW to move between splits, and type `> vsplit filename` or +`> hsplit filename` to open a new split. -* `ruler`: display line numbers - default value: `on` +## Accessing more help -* `gofmt`: Run `gofmt` whenever the file is saved (this only applies to `.go` files) +Micro has a built-in help system much like Vim's (although less extensive). - default value: `off` +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. -* `goimports`: run `goimports` whenever the file is saved (this only applies to `.go` files) +Here are the possible help topics that you can read: - default value: `off` +* 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 -Any option you set in the editor will be saved to the file ~/.config/micro/settings.json so, -in effect, your configuration file will be created for you. If you'd like to take your configuration -with you to another machine, simply copy the settings.json to the other machine. +For example, to open the help page on plugins you would press CtrlE and type +`help plugins`. -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.