runtime/help/help.md

   1 # Micro help text
   2
   3 Thank you for downloading and using micro.
   4 Micro is a terminal-based text editor that aims to be easy to use and intuitive,
   5 while also taking advantage of the full capabilities of modern terminals.
   6
   7 If you want to see all the keybindings press CtrlE and type `help keybindings`.
   8
   9 See the next section for more information about documentation and help.
  10
  11 ### Quick-start
  12
  13 Press CtrlQ to quit, and CtrlS to save. Press CtrlE to start typing commands
  14 and you can see which commands are available by pressing tab, or by
  15 viewing the help topic `> help commands`. When I write `> ...` I mean press
  16 CtrlE and then type whatever is there.
  17
  18 Move the cursor around with the mouse or the arrow keys. Type `>help defaultkeys` to
  19 get a quick, easy overview of the default hotkeys and what they do. For more info
  20 on rebinding keys, see type `>help keybindings`
  21
  22 If the colorscheme doesn't look good, you can change it with `> set colorscheme ...`.
  23 You can press tab to see the available colorschemes, or see more information with
  24 `> help colors`.
  25
  26 Press CtrlW to move between splits, and type `> vsplit filename` or `> hsplit filename`
  27 to open a new split.
  28
  29 ### Accessing more help
  30
  31 Micro has a built-in help system much like Vim's (although less extensive).
  32
  33 To use it, press CtrlE to access command mode and type in `help` followed by a topic.
  34 Typing `help` followed by nothing will open this page.
  35
  36 Here are the possible help topics that you can read:
  37
  38 * tutorial: A brief tutorial which gives an overview of all the other help topics
  39 * keybindings: Gives a full list of the default keybindings as well as how to rebind them
  40 * defaultkeys: Gives a more straight-forward list of the hotkey commands and what they do.
  41 * commands: Gives a list of all the commands and what they do
  42 * options: Gives a list of all the options you can customize
  43 * plugins: Explains how micro's plugin system works and how to create your own plugins
  44 * colors: Explains micro's colorscheme and syntax highlighting engine and how to create your
  45   own colorschemes or add new languages to the engine
  46
  47 For example, to open the help page on plugins you would press CtrlE and type `help plugins`.
  48
  49 I recommend looking at the `tutorial` help file because it is short for each section and
  50 gives concrete examples of how to use the various configuration options in micro. However,
  51 it does not give the in-depth documentation that the other topics provide.