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