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