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