runtime/help/tutorial.md

   1 # Tutorial
   2
   3 This is a brief intro to micro's configuration system that will give some simple
   4 examples showing how to configure settings, rebind keys, and use `init.lua` to
   5 configure micro to your liking.
   6
   7 Hopefully you'll find this useful.
   8
   9 See `> help defaultkeys` for a list an explanation of the default keybindings.
  10
  11 ### Settings
  12
  13 In micro, your settings are stored in `~/.config/micro/settings.json`, a file
  14 that is created the first time you run micro. It is a json file which holds all
  15 the settings and their values. To change an option, you can either change the
  16 value in the `settings.json` file, or you can type it in directly while using
  17 micro.
  18
  19 Press CtrlE to go to command mode, and type `set option value` (in the
  20 future, I will use `> set option value` to indicate pressing CtrlE). The change
  21 will take effect immediately and will also be saved to the `settings.json` file
  22 so that the setting will stick even after you close micro.
  23
  24 You can also set options locally which means that the setting will only have the
  25 value you give it in the buffer you set it in. For example, if you have two
  26 splits open, and you type `> setlocal tabsize 2`, the tabsize will only be 2 in
  27 the current buffer. Also micro will not save this local change to the
  28 `settings.json` file. However, you can still set options locally in the
  29 `settings.json` file. For example, if you want the `tabsize` to be 2 only in
  30 Ruby files, and 4 otherwise, you could put the following in `settings.json`:
  31
  32 ```json
  33 {
  34     "*.rb": {
  35         "tabsize": 2
  36     },
  37     "tabsize": 4
  38 }
  39 ```
  40
  41 Micro will set the `tabsize` to 2 only in files which match the glob `*.rb`.
  42
  43 If you would like to know more about all the available options, see the
  44 `options` topic (`> help options`).
  45
  46 ### Keybindings
  47
  48 Keybindings work in much the same way as options. You configure them using the
  49 `~/.config/micro/bindings.json` file.
  50
  51 For example if you would like to bind `CtrlR` to redo you could put the
  52 following in `bindings.json`:
  53
  54 ```json
  55 {
  56     "CtrlR": "redo"
  57 }
  58 ```
  59
  60 Very simple.
  61
  62 You can also bind keys while in micro by using the `> bind key action` command,
  63 but the bindings you make with the command won't be saved to the `bindings.json`
  64 file.
  65
  66 For more information about keybindings, like which keys can be bound, and
  67 what actions are available, see the `keybindings` help topic (`> help keybindings`).
  68
  69 ### Configuration with Lua
  70
  71 If you need more power than the json files provide, you can use the `init.lua`
  72 file. Create it in `~/.config/micro`. This file is a lua file that is run when
  73 micro starts and is essentially a one-file plugin. The plugin name is `initlua`.
  74
  75 This example will show you how to use the `init.lua` file by creating
  76 a binding to `CtrlR` which will execute the bash command `go run` on the current file,
  77 given that the current file is a Go file.
  78
  79 You can do that by putting the following in `init.lua`:
  80
  81 ```lua
  82 local config = import("micro/config")
  83 local shell = import("micro/shell")
  84
  85 function init()
  86     -- true means overwrite any existing binding to CtrlR
  87     -- this will modify the bindings.json file
  88     config.TryBindKey("CtrlR", "lua:initlua.gorun", true)
  89 end
  90
  91 function gorun(bp)
  92     local buf = bp.Buf
  93     if buf:FileType() == "go" then
  94         -- the true means run in the foreground
  95         -- the false means send output to stdout (instead of returning it)
  96         shell.RunInteractiveShell("go run " .. buf.Path, true, false)
  97     end
  98 end
  99 ```
 100
 101 Alternatively, you could get rid of the `TryBindKey` line, and put this line in the
 102 `bindings.json` file:
 103
 104 ```json
 105 {
 106     "CtrlR": "lua:initlua.gorun"
 107 }
 108 ```
 109
 110 For more information about plugins and the lua system that micro uses, see the
 111 `plugins` help topic (`> help plugins`).