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