runtime/help/help.md

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