]> git.lizzy.rs Git - micro.git/blobdiff - runtime/help/options.md
Merge branch 'python-highlight-zero' of https://github.com/a11ce/micro into a11ce...
[micro.git] / runtime / help / options.md
index 56fc6ca4ed45399db879f18651b448abcc1c061a..36341b8af64d0a5e986eff58c8977a5b44ced332 100644 (file)
@@ -37,21 +37,45 @@ Here are the available options:
    closed cleanly. In the case of a system crash or a micro crash, the contents
    of the buffer can be recovered automatically by opening the file that was
    being edited before the crash, or manually by searching for the backup in
-   the backup directory. Backups are made in the background when a buffer is
-   modified and the latest backup is more than 8 seconds old, or when micro
-   detects a crash. It is highly recommended that you leave this feature
-   enabled.
+   the backup directory. Backups are made in the background for newly modified
+   buffers every 8 seconds, or when micro detects a crash.
 
     default value: `true`
 
-* `basename`: in the infobar, show only the basename of the file being edited
-   rather than the full path.
+* `backupdir`: the directory micro should place backups in. For the default
+   value of `""` (empty string), the backup directory will be
+   `ConfigDir/backups`, which is `~/.config/micro/backups` by default. The
+   directory specified for backups will be created if it does not exist.
+
+    default value: `""` (empty string)
+
+* `basename`: in the infobar and tabbar, show only the basename of the file
+   being edited rather than the full path.
 
     default value: `false`
 
+* `clipboard`: specifies how micro should access the system clipboard.
+   Possible values are:
+    * `external`: accesses clipboard via an external tool, such as xclip/xsel
+       or wl-clipboard on Linux, pbcopy/pbpaste on MacOS, and system calls on
+       Windows. On Linux, if you do not have one of the tools installed, or if
+       they are not working, micro will throw an error and use an internal
+       clipboard.
+    * `terminal`: accesses the clipboard via your terminal emulator. Note that
+       there is limited support among terminal emulators for this feature
+       (called OSC 52). Terminals that are known to work are Kitty (enable
+       reading with `clipboard_control` setting), iTerm2 (only copying),
+       st, rxvt-unicode and xterm if enabled (see `> help copypaste` for
+       details). Note that Gnome-terminal does not support this feature. With
+       this setting, copy-paste **will** work over ssh. See `> help copypaste`
+       for details.
+    * `internal`: micro will use an internal clipboard.
+
+    default value: `external`
+
 * `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.
+   specified column. This is useful if you want column 80 to be highlighted
+   special for example.
 
        default value: `0`
 
@@ -80,14 +104,30 @@ Here are the available options:
 
        default value: `false`
 
+* `divchars`: specifies the "divider" characters used for the dividing line
+   between vertical/horizontal splits. The first character is for vertical
+   dividers, and the second is for horizontal dividers. By default, for
+   horizontal splits the statusline serves as a divider, but if the statusline
+   is disabled the horizontal divider character will be used.
+
+    default value: `|-`
+
+* `divreverse`: colorschemes provide the color (foreground and background) for
+   the characters displayed in split dividers. With this option enabled, the
+   colors specified by the colorscheme will be reversed (foreground and
+   background colors swapped).
+
+    default value: `true`
+
 * `encoding`: the encoding to open and save files with. Supported encodings
    are listed at https://www.w3.org/TR/encoding/.
 
     default value: `utf-8`
 
-* `eofnewline`: micro will automatically add a newline to the file.
+* `eofnewline`: micro will automatically add a newline to the end of the
+   file if one does not exist.
 
-       default value: `false`
+       default value: `true`
 
 * `fastdirty`: this determines what kind of algorithm micro uses to determine
    if a buffer is modified or not. When `fastdirty` is on, micro just uses a
@@ -95,18 +135,21 @@ Here are the available options:
    This is fast, but can be inaccurate. If `fastdirty` is off, then micro will
    hash the current buffer against a hash of the original file (created when
    the buffer was loaded). This is more accurate but obviously more resource
-   intensive. This option is only for people who really care about having
-   accurate modified status.
+   intensive. This option will be automatically disabled if the file size
+   exceeds 50KB.
 
-       default value: `true`
+       default value: `false`
 
 * `fileformat`: this determines what kind of line endings micro will use for
-   the file. UNIX line endings are just `\n` (linefeed) whereas dos line
+   the file. Unix line endings are just `\n` (linefeed) whereas dos line
    endings are `\r\n` (carriage return + linefeed). The two possible values for
    this option are `unix` and `dos`. The fileformat will be automatically
    detected (when you open an existing file) and displayed on the statusline,
    but this option is useful if you would like to change the line endings or if
-   you are starting a new file.
+   you are starting a new file. Changing this option while editing a file will
+   change its line endings. Opening a file with this option set will only have
+   an effect if the file is empty/newly created, because otherwise the fileformat
+   will be automatically detected from the existing line endings.
 
        default value: `unix`
 
@@ -118,7 +161,7 @@ Here are the available options:
 
 * `ignorecase`: perform case-insensitive searches.
 
-       default value: `false`
+       default value: `true`
 
 * `indentchar`: sets the indentation character.
 
@@ -162,7 +205,7 @@ Here are the available options:
 
        default value: `true`
 
-* `paste`: Treat characters sent from the terminal in a single chunk as a paste
+* `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
@@ -171,14 +214,30 @@ Here are the available options:
 
     default value: `false`
 
+* `parsecursor`: if enabled, this will cause micro to parse filenames such as
+   file.txt:10:5 as requesting to open `file.txt` with the cursor at line 10
+   and column 5. The column number can also be dropped to open the file at a
+   given line and column 0. Note that with this option enabled it is not possible
+   to open a file such as `file.txt:10:5`, where `:10:5` is part of the filename.
+   It is also possible to open a file with a certain cursor location by using the
+   `+LINE,COL` flag syntax. See `micro -help` for the command line options.
+
+    default value: `false`
+
+* `permbackup`: this option causes backups (see `backup` option) to be
+   permanently saved. With permanent backups, micro will not remove backups when
+   files are closed and will never apply them to existing files. Use this option
+   if you are interested in manually managing your backup files.
+
+    default value: `false`
+
 * `pluginchannels`: list of URLs pointing to plugin channels for downloading and
    installing plugins. A plugin channel consists of a json file with links to
    plugin repos, which store information about plugin versions and download URLs.
    By default, this option points to the official plugin channel hosted on GitHub
    at https://github.com/micro-editor/plugin-channel.
 
-    default value: `https://raw.githubusercontent.com/micro-editor/plugin-channel
-                    /master/channel.json`
+    default value: `https://raw.githubusercontent.com/micro-editor/plugin-channel/master/channel.json`
 
 * `pluginrepos`: a list of links to plugin repositories.
 
@@ -198,6 +257,12 @@ Here are the available options:
 
        default value: `true`
 
+* `relativeruler`: make line numbers display relatively. If set to true, all lines except
+       for the line that the cursor is located will display the distance from the 
+       cursor's line. 
+
+       default value: `false` 
+
 * `savecursor`: remember where the cursor was last time the file was opened and
    put it there when you open the file again. Information is saved to
    `~/.config/micro/buffers/`
@@ -296,16 +361,115 @@ Here are the available options:
 
        default value: `true`
 
+* `xterm`: micro will assume that the terminal it is running in conforms to
+  `xterm-256color` regardless of what the `$TERM` variable actually contains.
+   Enabling this option may cause unwanted effects if your terminal in fact
+   does not conform to the `xterm-256color` standard.
+
+    Default value: `false`
+
 ---
 
 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.
 
+By default, the following plugins are provided, each with an option to enable
+or disable them:
+
+* `autoclose`: automatically closes brackets, quotes, etc...
+* `comment`: provides automatic commenting for a number of languages
+* `ftoptions`: alters some default options depending on the filetype
+* `linter`: provides extensible linting for many languages
+* `literate`: provides advanced syntax highlighting for the Literate
+   programming tool.
+* `status`: provides some extensions to the status line (integration with
+   Git and more).
+* `diff`: integrates the `diffgutter` option with Git. If you are in a Git
+   directory, the diff gutter will show changes with respect to the most
+   recent Git commit rather than the diff since opening 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.
 
+## Settings.json file
+
+The settings.json file should go in your configuration directory (by default
+at `~/.config/micro`), and should contain only options which have been modified
+from their default setting. Here is the full list of options in json format,
+so that you can see what the formatting should look like.
+
+```json
+{
+    "autoclose": true,
+    "autoindent": true,
+    "autosave": 0,
+    "autosu": false,
+    "backup": true,
+    "backupdir": "",
+    "basename": false,
+    "clipboard": "external",
+    "colorcolumn": 0,
+    "colorscheme": "default",
+    "comment": true,
+    "cursorline": true,
+    "diff": true,
+    "diffgutter": false,
+    "divchars": "|-",
+    "divreverse": true,
+    "encoding": "utf-8",
+    "eofnewline": true,
+    "fastdirty": false,
+    "fileformat": "unix",
+    "filetype": "unknown",
+    "ftoptions": true,
+    "ignorecase": false,
+    "indentchar": " ",
+    "infobar": true,
+    "initlua": true,
+    "keepautoindent": false,
+    "keymenu": false,
+    "linter": true,
+    "literate": true,
+    "matchbrace": true,
+    "mkparents": false,
+    "mouse": true,
+    "parsecursor": false,
+    "paste": false,
+    "permbackup": false,
+    "pluginchannels": [
+        "https://raw.githubusercontent.com/micro-editor/plugin-channel/master/channel.json"
+    ],
+    "pluginrepos": [],
+    "readonly": false,
+    "relativeruler": false,
+    "rmtrailingws": false,
+    "ruler": true,
+    "savecursor": false,
+    "savehistory": true,
+    "saveundo": false,
+    "scrollbar": false,
+    "scrollmargin": 3,
+    "scrollspeed": 2,
+    "smartpaste": true,
+    "softwrap": false,
+    "splitbottom": true,
+    "splitright": true,
+    "status": true,
+    "statusformatl": "$(filename) $(modified)($(line),$(col)) $(status.paste)| ft:$(opt:filetype) | $(opt:fileformat) | $(opt:encoding)",
+    "statusformatr": "$(bind:ToggleKeyMenu): bindings, $(bind:ToggleHelp): help",
+    "statusline": true,
+    "sucmd": "sudo",
+    "syntax": true,
+    "tabmovement": false,
+    "tabsize": 4,
+    "tabstospaces": false,
+    "useprimary": true,
+    "xterm": false
+}
+```
+
 ## Global and local settings
 
 You can set these settings either globally or locally. Locally means that the