runtime/help/options.md

   1 ### Options
   2
   3 Micro stores all of the user configuration in its configuration directory.
   4
   5 Micro uses the `$XDG_CONFIG_HOME/micro` as the configuration directory. As per
   6 the XDG spec, if `$XDG_CONFIG_HOME` is not set, `~/.config/micro` is used as
   7 the config directory.
   8
   9 Here are the options that you can set:
  10
  11 * `colorscheme`: loads the colorscheme stored in
  12    $(configDir)/colorschemes/`option`.micro
  13    This setting is `global only`.
  14
  15         default value: `default`
  16         Note that the default colorschemes (default, solarized, and solarized-tc)
  17         are not located in configDir, because they are embedded in the micro binary.
  18
  19         The colorscheme can be selected from all the files in the
  20         ~/.config/micro/colorschemes/ directory. Micro comes by default with three
  21         colorschemes:
  22
  23     You can read more about micro's colorschemes in the `colors` help topic
  24     (`help colors`).
  25
  26 * `colorcolumn`: if this is not set to 0, it will display a column at the specified
  27    column. This is useful if you want column 80 to be highlighted special for example.
  28
  29         default value: `0`
  30
  31 * `eofnewline`: micro will automatically add a newline to the file.
  32
  33         default value: `false`
  34
  35 * `rmtrailingws`: micro will automatically trim trailing whitespaces at eol.
  36
  37         default value: `false`
  38
  39 * `tabsize`: sets the tab size to `option`
  40
  41         default value: `4`
  42
  43 * `indentchar`: sets the indentation character
  44
  45         default value: ` `
  46
  47 * `infobar`: enables the line at the bottom of the editor where messages are printed.
  48    This option is `global only`.
  49
  50         default value: `on`
  51
  52 * `filetype`: sets the filetype for the current buffer. This setting is `local only`
  53
  54     default value: this will be automatically set depending on the file you have open
  55
  56 * `ignorecase`: perform case-insensitive searches
  57
  58         default value: `off`
  59
  60 * `syntax`: turns syntax on or off
  61
  62         default value: `on`
  63
  64 * `tabstospaces`: use spaces instead of tabs
  65
  66         default value: `off`
  67
  68 * `tabmovement`: navigate spaces at the beginning of lines as if they are tabs (e.g. move over 4 spaces at once).
  69    This option only does anything if `tabstospaces` is on.
  70
  71     default value: `off`
  72
  73 * `autoindent`: when creating a new line use the same indentation as the
  74    previous line
  75
  76         default value: `on`
  77
  78 * `cursorline`: highlight the line that the cursor is on in a different color
  79    (the color is defined by the colorscheme you are using)
  80
  81         default value: `on`
  82
  83 * `ruler`: display line numbers
  84
  85         default value: `on`
  86
  87 * `statusline`: display the status line at the bottom of the screen
  88
  89         default value: `on`
  90
  91 * `savecursor`: remember where the cursor was last time the file was opened and
  92    put it there when you open the file again
  93
  94         default value: `off`
  95
  96 * `saveundo`: when this option is on, undo is saved even after you close a file
  97    so if you close and reopen a file, you can keep undoing
  98
  99         default value: `off`
 100
 101 * `scrollmargin`: amount of lines you would like to see above and below the cursor
 102
 103         default value: `3`
 104
 105 * `scrollspeed`: amount of lines to scroll for one scroll event
 106
 107         default value: `2`
 108
 109 * `softwrap`: should micro wrap lines that are too long to fit on the screen
 110
 111         default value: `off`
 112
 113 * `splitRight`: when a vertical split is created, should it be created to the right of
 114    the current split?
 115
 116         default value: `on`
 117
 118 * `splitBottom`: when a horizontal split is created, should it be created below the
 119    current split?
 120
 121         default value: `on`
 122
 123 * `autosave`: micro will save the buffer every 8 seconds automatically.
 124    Micro also will automatically save and quit when you exit without asking.
 125    Be careful when using this feature, because you might accidentally save a file,
 126    overwriting what was there before.
 127
 128         default value: `off`
 129
 130 * `pluginchannels`: contains all the channels micro's plugin manager will search
 131    for plugins in. A channel is simply a list of 'repository' json files which contain
 132    metadata about the given plugin. See the `Plugin Manager` section of the `plugins` help topic
 133    for more information.
 134
 135         default value: `https://github.com/micro-editor/plugin-channel`
 136
 137 * `pluginrepos`: contains all the 'repositories' micro's plugin manager will search for
 138    plugins in. A repository consists of a `repo.json` file which contains metadata for a
 139    single plugin.
 140
 141         default value: ` `
 142
 143 * `useprimary` (only useful on Linux): defines whether or not micro will use the primary clipboard to copy selections
 144    in the background. This does not affect the normal clipboard using Ctrl-C and Ctrl-V.
 145
 146         default value: `on`
 147
 148 * `keepautoindent`: when using autoindent, whitespace is added for you. This option determines if
 149    when you move to the next line without any insertions the whitespace that was added should be deleted.
 150    By default the autoindent whitespace is deleted if the line was left empty.
 151
 152     default value: `off`
 153
 154 * `termtitle`: defines whether or not your terminal's title will be set by micro when opened.
 155
 156     default value: `off`
 157
 158 * `mouse`: whether to enable mouse support. When mouse support is disabled, usually the terminal will be able
 159    to access mouse events which can be useful if you want to copy from the terminal instead of from micro (if
 160    over ssh for example, because the terminal has access to the local clipboard and micro does not).
 161
 162     default value: `on`
 163
 164 * `fileformat`: this determines what kind of line endings micro will use for the file. Unix line endings
 165    are just `\n` (lf) whereas dos line endings are `\r\n` (crlf). The two possible values for this option
 166    are `unix` and `dos`. The fileformat will be automatically detected and displayed on the statusline but
 167    this option is useful if you would like to change the line endings or if you are starting a new file.
 168
 169     default value: `unix`
 170
 171 * `fastdirty`: this determines what kind of algorithm micro uses to determine if a buffer is modified or
 172    not. When `fastdirty` is on, micro just uses a boolean `modified` that is set to `true` as soon as the user
 173    makes an edit. This is fast, but can be inaccurate. If `fastdirty` is off, then micro will hash the current
 174    buffer against a hash of the original file (created when the buffer was loaded). This is more accurate but
 175    obviously more resource intensive. This option is only for people who really care about having accurate
 176    modified status.
 177
 178     default value: `on`
 179
 180 ---
 181
 182 Default plugin options:
 183
 184 * `autoclose`: Automatically close `{}` `()` `[]` `""` `''`. Provided by the `autoclose` plugin
 185
 186         default value: `on`
 187
 188 * `linter`: Automatically lint when the file is saved. Provided by the `linter` plugin
 189
 190         default value: `on`
 191
 192 * `ftoptions`: by default, micro will set some options based on the filetype. At the moment, micro will
 193    use tabs for makefiles and spaces for python files regardless of your settings. If you would like to
 194    disable this behavior turn this option off.
 195
 196         default value: `on`
 197
 198 Any option you set in the editor will be saved to the file
 199 ~/.config/micro/settings.json so, in effect, your configuration file will be
 200 created for you. If you'd like to take your configuration with you to another
 201 machine, simply copy the settings.json to the other machine.
 202
 203 # Global and local settings
 204
 205 You can set these settings either globally or locally. Locally means that the setting
 206 won't be saved to `~/.config/micro/settings.json` and that it will only be set in
 207 the current buffer. Setting an option globally is the default, and will set the option
 208 in all buffers.
 209
 210 The `colorscheme` option is global only, and the `filetype` option is local only. To
 211 set an option locally, use `setlocal` instead of `set`.
 212
 213 In the `settings.json` file you can also put set options locally by specifying a glob.
 214 Here is an example which has `tabstospaces` on for all files except Go files, and
 215 `tabsize` 4 for all files except Ruby files:
 216
 217 ```json
 218 {
 219     "*.go": {
 220         "tabstospaces": false
 221     },
 222     "*.rb": {
 223         "tabsize": 2
 224     },
 225     "tabstospaces": true,
 226     "tabsize": 4
 227 }
 228 ```
 229
 230 As you can see it is quite easy to set options locally using the `settings.json` file.