Micro stores all of the user configuration in its configuration directory.
-Micro uses the `$XDG_CONFIG_HOME/micro` as the configuration directory. As per
-the XDG spec, if `$XDG_CONFIG_HOME` is not set, `~/.config/micro` is used as
-the config directory.
+Micro uses `$MICRO_CONFIG_HOME` as the configuration directory. If this environment
+variable is not set, it uses `$XDG_CONFIG_HOME/micro` instead. If that
+environment variable is not set, it uses `~/.config/micro` as the configuration
+directory. In the documentation, we use `~/.config/micro` to refer to the
+configuration directory (even if it may in fact be somewhere else if you have
+set either of the above environment variables).
-Here are the options that you can set:
+Here are the available options:
* `autoindent`: when creating a new line, use the same indentation as the
previous line.
default value: `unix`
-* `filetype`: sets the filetype for the current buffer. This setting is
- `local only`.
+* `filetype`: sets the filetype for the current buffer. Set this option to `off`
+ to completely disable filetype detection.
- default value: this will be automatically set depending on the file you have
- open
+ default value: `unknown`. This will be automatically overridden depending
+ on the file you open.
* `ignorecase`: perform case-insensitive searches.
default value: `false`
-* `mouse`: whether to enable mouse support. When mouse support is disabled,
+* `mouse`: mouse support. When mouse support is disabled,
usually the terminal will be able to access mouse events which can be useful
if you want to copy from the terminal instead of from micro (if over ssh for
example, because the terminal has access to the local clipboard and micro
default value: `true`
-* `rmtrailingws`: micro will automatically trim trailing whitespaces at eol.
+* `paste`: Treat characters sent from the terminal in a single chunk as a paste
+ event rather than a series of manual key presses. If you are pasting using
+ the terminal keybinding (not Ctrl-v, which is micro's default paste keybinding)
+ then it is a good idea to enable this option during the paste and disable
+ once the paste is over. See `> help copypaste` for details about copying
+ and pasting in a terminal environment.
+
+ default value: `false`
+
+* `readonly`: when enabled, disallows edits to the buffer. It is recommended
+ to only ever set this option locally using `setlocal`.
+
+ default value: `false`
+
+* `rmtrailingws`: micro will automatically trim trailing whitespaces at ends of
+ lines.
default value: `false`
default value: `true`
* `savecursor`: remember where the cursor was last time the file was opened and
- put it there when you open the file again.
+ put it there when you open the file again. Information is saved to
+ `~/.config/micro/buffers/`
default value: `false`
* `savehistory`: remember command history between closing and re-opening
- micro.
+ micro. Information is saved to `~/.config/micro/buffers/history`.
default value: `true`
* `saveundo`: when this option is on, undo is saved even after you close a file
- so if you close and reopen a file, you can keep undoing.
+ so if you close and reopen a file, you can keep undoing. Information is
+ saved to `~/.config/micro/buffers/`.
default value: `false`
default value: `false`
-* `scrollmargin`: amount of lines you would like to see above and below the
- cursor.
+* `scrollmargin`: margin at which the view starts scrolling when the cursor
+ approaches the edge of the view.
default value: `3`
default value: `2`
-* `smartpaste`: should micro add leading whitespace when pasting multiple lines?
+* `smartpaste`: add leading whitespace when pasting multiple lines.
This will attempt to preserve the current indentation level when pasting an
unindented block.
default value: `true`
-* `softwrap`: should micro wrap lines that are too long to fit on the screen.
+* `softwrap`: wrap lines that are too long to fit on the screen.
default value: `false`
-* `splitbottom`: when a horizontal split is created, should it be created below
- the current split?
+* `splitbottom`: when a horizontal split is created, create it below the
+ current split.
default value: `true`
-* `splitright`: when a vertical split is created, should it be created to the
- right of the current split?
+* `splitright`: when a vertical split is created, create it to the right of the
+ current split.
default value: `true`
default value: `$(filename) $(modified)($(line),$(col)) $(opt:filetype)
$(opt:fileformat) $(opt:encoding)`
-* `statusformatl`: format string definition for the left-justified part of the
+* `statusformatr`: format string definition for the right-justified part of the
statusline.
- default value: `$(bind:ToggleKeyMenu): show bindings, $(bind:ToggleHelp):
- toggle help`
+ default value: `$(bind:ToggleKeyMenu): bindings, $(bind:ToggleHelp): help`
* `statusline`: display the status line at the bottom of the screen.
default value: `sudo`
-* `syntax`: turns syntax on or off.
+* `syntax`: enables syntax highlighting.
default value: `true`
default value: `false`
-* `tabsize`: sets the tab size to `option`
+* `tabsize`: the size in spaces that a tab character should be displayed with.
default value: `4`
-* `tabstospaces`: use spaces instead of tabs
-
- default value: `false`
-
-* `termtitle`: defines whether or not your terminal's title will be set by micro
- when opened.
+* `tabstospaces`: use spaces instead of tabs.
default value: `false`
-* `useprimary` (only useful on *nix): defines whether or not micro will use the
+* `useprimary` (only useful on unix): defines whether or not micro will use the
primary clipboard to copy selections in the background. This does not affect
- the normal clipboard using Ctrl-C and Ctrl-V.
+ the normal clipboard using Ctrl-c and Ctrl-v.
default value: `true`
---
-Plugin options: all plugins come with a special option to enable or disable them. THe option
+Plugin options: all plugins come with a special option to enable or disable them. The option
is a boolean with the same name as the plugin itself.
-Any option you set in the editor will be saved to the file
+Any option you set in the editor will be saved to the file
~/.config/micro/settings.json so, in effect, your configuration file will be
created for you. If you'd like to take your configuration with you to another
machine, simply copy the settings.json to the other machine.
You can set these settings either globally or locally. Locally means that the
setting won't be saved to `~/.config/micro/settings.json` and that it will only
be set in the current buffer. Setting an option globally is the default, and
-will set the option in all buffers.
+will set the option in all buffers. Use the `setlocal` command to set an option
+locally rather than globally.
The `colorscheme` option is global only, and the `filetype` option is local
only. To set an option locally, use `setlocal` instead of `set`.
projects / micro.git / blobdiff