Added lines and percentage statusbar directives (#2055)

[micro.git] / runtime / help / options.md

diff --git a/runtime/help/options.md b/runtime/help/options.md
index 5c087a0720490f97b591a140ce1cfe214cbc1ae7..89d85396cb95e3b4bea8c8db27296be9bc1c6717 100644 (file)
--- a/runtime/help/options.md
+++ b/runtime/help/options.md
@@ -159,11 +159,29 @@ Here are the available options:
        default value: `unknown`. This will be automatically overridden depending
     on the file you open.
 
-* `ignorecase`: perform case-insensitive searches.
+* `hlsearch`: highlight all instances of the searched text after a successful
+   search. This highlighting can be turned off via `UnhighlightSearch` action
+   (triggered by Esc key by default) or toggled on/off via `ToggleHighlightSearch`
+   action. Note that these actions don't change `hlsearch` setting.
+   As long as `hlsearch` is set to true, after the next search the highlighting
+   is turned on again.
 
        default value: `false`
 
-* `indentchar`: sets the indentation character.
+* `incsearch`: enable incremental search in "Find" prompt (matching as you type).
+
+       default value: `true`
+
+* `ignorecase`: perform case-insensitive searches.
+
+       default value: `true`
+
+* `indentchar`: sets the indentation character. This will not be inserted into
+  files; it is only a visual indicator that whitespace is present. If set to a
+  printing character, it functions as a subset of the "show invisibles"
+  setting available in many other text editors. The color of this character is
+  determined by the `indent-char` field in the current theme rather than the
+  default text color.
 
        default value: ` ` (space)
 
@@ -220,7 +238,7 @@ Here are the available options:
    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.
+   `+LINE:COL` flag syntax. See `micro -help` for the command line options.
 
     default value: `false`
 
@@ -249,7 +267,7 @@ Here are the available options:
     default value: `false`
 
 * `rmtrailingws`: micro will automatically trim trailing whitespaces at ends of
-   lines.
+   lines. Note: This setting overrides `keepautoindent`
 
        default value: `false`
 
@@ -315,7 +333,7 @@ Here are the available options:
 
 * `statusformatl`: format string definition for the left-justified part of the
    statusline. Special directives should be placed inside `$()`. Special
-   directives include: `filename`, `modified`, `line`, `col`, `opt`, `bind`.
+   directives include: `filename`, `modified`, `line`, `col`, `lines`, `percentage`, `opt`, `bind`.
    The `opt` and `bind` directives take either an option or an action afterward
    and fill in the value of the option or the key bound to the action.
 
@@ -351,7 +369,11 @@ Here are the available options:
 
        default value: `4`
 
-* `tabstospaces`: use spaces instead of tabs.
+* `tabstospaces`: use spaces instead of tabs. Note: This option will be
+   overridden by [the `ftoptions` plugin](https://github.com/zyedidia/micro/blob/master/runtime/plugins/ftoptions/ftoptions.lua)
+   for certain filetypes. To disable this behavior, add `"ftoptions": false` to
+   your config. See [issue #2213](https://github.com/zyedidia/micro/issues/2213)
+   for more details.
 
        default value: `false`
 
@@ -361,6 +383,11 @@ Here are the available options:
 
        default value: `true`
 
+* `wordwrap`: wrap long lines by words, i.e. break at spaces. This option
+   only does anything if `softwrap` is on.
+
+       default value: `false`
+
 * `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
@@ -423,6 +450,7 @@ so that you can see what the formatting should look like.
     "fastdirty": false,
     "fileformat": "unix",
     "filetype": "unknown",
+    "incsearch": true,
     "ftoptions": true,
     "ignorecase": false,
     "indentchar": " ",