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 ### Accessing more help
   7
   8 Micro has a built-in help system much like Vim's (although less extensive).
   9
  10 To use it, press CtrlE to access command mode and type in help followed by a topic.
  11 Typing help followed by nothing will open this page.
  12
  13 Here are the possible help topics that you can read:
  14
  15 * tutorial: A brief tutorial which gives an overview of all the other help topics
  16 * keybindings: Gives a full list of the default keybindings as well as how to rebind them
  17 * commands: Gives a list of all the commands and what they do
  18 * options: Gives a list of all the options you can customize
  19 * plugins: Explains how micro's plugin system works and how to create your own plugins
  20 * colors: Explains micro's colorscheme and syntax highlighting engine and how to create your
  21   own colorschemes or add new languages to the engine
  22
  23 For example to open the help page on plugins you would press CtrlE and type `help plugins`.
  24
  25 I recommend looking at the `tutorial` help file because it is short for each section and
  26 gives concrete examples of how to use the various configuration options in micro. However,
  27 it does not give the in-depth documentation that the other topics provide.
  28
  29 ### Usage
  30
  31 Once you have built the editor, simply start it by running
  32 `micro path/to/file.txt` or simply `micro` to open an empty buffer.
  33
  34 Micro also supports creating buffers from stdin:
  35
  36 ```
  37 $ ifconfig | micro
  38 ```
  39
  40 You can move the cursor around with the arrow keys and mouse.