]> git.lizzy.rs Git - micro.git/blob - runtime/help/help.md
Update tcell to include true color fix
[micro.git] / runtime / help / help.md
1 # Micro help text
2
3 Micro is a terminal-based text editor that aims to be easy to use and intuitive, 
4 while also taking advantage of the full capabilities of modern terminals.
5
6 To open the command bar, press Ctrl-e. This enables a `>` prompt for typing
7 commands. From now on when the documentation says to run a command such as
8 `> help`, this means press Ctrl-e and type `help` (and press enter to execute
9 the command).
10
11 For a list of the default keybindings run `> help defaultkeys`.
12 For more information on keybindings see `> help keybindings`.
13
14 ## Quick-start
15
16 Press Ctrl-q to quit, and Ctrl-s to save. Press Ctrl-e to start typing commands and
17 you can see which commands are available by pressing tab, or by viewing the help
18 topic `> help commands`.
19
20 Move the cursor around with the mouse or the arrow keys. Run
21 `> help defaultkeys` to  get a quick, easy overview of the default hotkeys and
22 what they do. For more info on rebinding keys, see type `> help keybindings`.
23
24 If the colorscheme doesn't look good, you can change it with
25 `> set colorscheme ...`. You can press tab to see the available colorschemes, or
26 see more information about colorschemes and syntax highlighting with `> help colors`.
27
28 Press Ctrl-w to move between splits, and type `> vsplit filename` or
29 `> hsplit filename` to open a new split.
30
31 ## Accessing more help
32
33 Micro has a built-in help system which can be accessed with the `help` command.
34
35 To use it, press Ctrl-e to access command mode and type in `help` followed by a
36 topic. Typing `help` followed by nothing will open this page.
37
38 Here are the possible help topics that you can read:
39
40 * tutorial: A brief tutorial which gives an overview of all the other help
41   topics
42 * keybindings: Gives a full list of the default keybindings as well as how to
43   rebind them
44 * defaultkeys: Gives a more straight-forward list of the hotkey commands and what
45   they do.
46 * commands: Gives a list of all the commands and what they do
47 * options: Gives a list of all the options you can customize
48 * plugins: Explains how micro's plugin system works and how to create your own
49   plugins
50 * colors: Explains micro's colorscheme and syntax highlighting engine and how to
51   create your own colorschemes or add new languages to the engine
52
53 For example, to open the help page on plugins you would run `> help plugins`.
54
55 I recommend looking at the `tutorial` help file because it is short for each
56 section and gives concrete examples of how to use the various configuration
57 options in micro. However, it does not give the in-depth documentation that the
58 other topics provide.