X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;f=runtime%2Fhelp%2Fhelp.md;h=eb9b0a1a0850067dbd2581bb86d12c9af554583e;hb=f3e8413e772924947238bdb9f928375e24ff7213;hp=58548d97d283af710ed95ec1ce7529b6a62dd59e;hpb=75d2708b131ee147392a1eab5572ae2578b1c254;p=micro.git diff --git a/runtime/help/help.md b/runtime/help/help.md index 58548d97..eb9b0a1a 100644 --- a/runtime/help/help.md +++ b/runtime/help/help.md @@ -3,138 +3,56 @@ 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 +To open the command bar, press Ctrl-e. This enables a `>` prompt for typing +commands. From now on when the documentation says to run a command such as +`> help`, this means press Ctrl-e and type `help` (and press enter to execute +the command). -Once you have built the editor, simply start it by running `micro path/to/file.txt` or simply `micro` to open an empty buffer. +For a list of the default keybindings run `> help defaultkeys`. +For more information on keybindings see `> help keybindings`. -Micro also supports creating buffers from stdin: +## Quick-start -``` -$ ifconfig | micro -``` +Press Ctrl-q to quit, and Ctrl-s to save. Press Ctrl-e to start typing commands and +you can see which commands are available by pressing tab, or by viewing the help +topic `> help commands`. -You can move the cursor around with the arrow keys and mouse. +Move the cursor around with the mouse or the arrow keys. Run +`> 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`. -### Keybindings +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 about colorschemes and syntax highlighting with `> help colors`. -These are the default keybindings, along with their actions. +Press Ctrl-w to move between splits, and type `> vsplit filename` or +`> hsplit filename` to open a new split. -#### Editor bindings +## Accessing more help -* Ctrl-q: Quit -* Ctrl-e: Execute a command -* Ctrl-g: Toggle help text -* Ctrl-b: Run a shell command +Micro has a built-in help system which can be accessed with the `help` command. -#### Buffer bindings +To use it, press Ctrl-e to access command mode and type in `help` followed by a +topic. Typing `help` followed by nothing will open this page. -* 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 line -* End: Go to end of line -* Ctrl-r: Toggle line numbers +Here are the possible help topics that you can read: -The buffer bindings may be rebound using the `~/.config/micro/bindings.json` file. Each key is bound to an action. +* 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 -For example, to bind `Ctrl-y` to undo and `Ctrl-z` to redo, you could put the following in the `bindings.json` file. +For example, to open the help page on plugins you would run `> help plugins`. -```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" flags`: This will replace `search` with `value`. The `flags` are optional. - At this point, there is only one flag: `c`, which enables `check` mode which asks if you'd like - to perform the replacement each time - - 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` - -* `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` - -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. - -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.