]> git.lizzy.rs Git - micro.git/blobdiff - runtime/help/options.md
Fix merge conflict / syntax of colors.md
[micro.git] / runtime / help / options.md
index 94e020f68d3355f9f68a62cbc36c54a3c75db09a..0dca26da380b584d6a4a1954994bd33dca1cf38c 100644 (file)
@@ -14,27 +14,27 @@ Here are the options that you can set:
 
        default value: `default`
        Note that the default colorschemes (default, solarized, and solarized-tc)
-       are not located in configDir, because they are embedded in the micro binary
+       are not located in configDir, because they are embedded in the micro binary.
 
        The colorscheme can be selected from all the files in the 
        ~/.config/micro/colorschemes/ directory. Micro comes by default with three
        colorschemes:
 
-       * default: this is the default colorscheme.
+    You can read more about micro's colorschemes in the `colors` help topic
+    (`help colors`).
 
-       * solarized: this is the solarized colorscheme (used in the screenshot). 
-         You should have the solarized color palette in your terminal to use it.
+* `colorcolumn`: if this is not set to 0, it will display a column at the specified
+   column. This is useful if you want column 80 to be highlighted special for example.
 
-       * solarized-tc: this is the solarized colorscheme for true color, just 
-         make sure your terminal supports true color before using it and that the 
-         MICRO_TRUECOLOR environment variable is set to 1 before starting micro.
+       default value: `0`
 
-       * monokai-tc: this is the monokai colorscheme. It requires true color to
-         look perfect, but the 256 color approximation looks good as well.
+* `eofnewline`: micro will automatically add a newline to the file.
 
-       * atom-dark-tc: this colorscheme is based off of Atom's "dark" colorscheme.
-         It requires true color to look good.
+       default value: `false`
 
+* `rmtrailingws`: micro will automatically trim trailing whitespaces at eol.
+
+       default value: `false`
 
 * `tabsize`: sets the tab size to `option`
 
@@ -44,6 +44,11 @@ Here are the options that you can set:
 
        default value: ` `
 
+* `infobar`: enables the line at the bottom of the editor where messages are printed.
+   This option is `global only`.
+
+       default value: `on`
+
 * `filetype`: sets the filetype for the current buffer. This setting is `local only`
 
     default value: this will be automatically set depending on the file you have open
@@ -68,7 +73,7 @@ Here are the options that you can set:
 * `cursorline`: highlight the line that the cursor is on in a different color
    (the color is defined by the colorscheme you are using)
 
-       default value: `off`
+       default value: `on`
 
 * `ruler`: display line numbers
 
@@ -96,24 +101,54 @@ Here are the options that you can set:
 
        default value: `2`
 
----
+* `softwrap`: should micro wrap lines that are too long to fit on the screen
 
-Default plugin options:
+       default value: `off`
 
-* `linter`: lint languages on save (supported languages are C, D, Go, Java,
-   Javascript, Lua). Provided by the `linter` plugin.
+* `splitRight`: when a vertical split is created, should it be created to the right of
+   the current split?
 
        default value: `on`
 
-* `autoclose`: Automatically close `{}` `()` `[]` `""` `''`. Provided by the autoclose plugin
+* `splitBottom`: when a horizontal split is created, should it be created below the
+   current split?
 
        default value: `on`
 
-* `goimports`: Run goimports on save. Provided by the `go` plugin.
+* `autosave`: micro will save the buffer every 8 seconds automatically.
+   Micro also will automatically save and quit when you exit without asking.
+   Be careful when using this feature, because you might accidentally save a file,
+   overwriting what was there before.
 
        default value: `off`
 
-* `gofmt`: Run gofmt on save. Provided by the `go` plugin.
+* `pluginchannels`: contains all the channels micro's plugin manager will search
+   for plugins in. A channel is simply a list of 'repository' json files which contain
+   metadata about the given plugin. See the `Plugin Manager` section of the `plugins` help topic
+   for more information.
+
+       default value: `https://github.com/micro-editor/plugin-channel`
+
+* `pluginrepos`: contains all the 'repositories' micro's plugin manager will search for
+   plugins in. A repository consists of a `repo.json` file which contains metadata for a
+   single plugin.
+
+       default value: ` `
+
+* `useprimary` (only useful on Linux): 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.
+
+       default value: `on`
+
+---
+
+Default plugin options:
+
+* `autoclose`: Automatically close `{}` `()` `[]` `""` `''`. Provided by the `autoclose` plugin
+
+       default value: `on`
+
+* `linter`: Automatically lint when the file is saved. Provided by the `linter` plugin
 
        default value: `on`
 
@@ -136,16 +171,16 @@ In the `settings.json` file you can also put set options locally by specifying a
 Here is an example which has `tabstospaces` on for all files except Go files, and
 `tabsize` 4 for all files except Ruby files:
 
-```
+```json
 {
     "*.go": {
         "tabstospaces": false
     },
     "*.rb": {
         "tabsize": 2
-    }
+    },
     "tabstospaces": true,
-    "tabsize": 4,
+    "tabsize": 4
 }
 ```