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