aboutsummaryrefslogtreecommitdiff
path: root/runtime/doc
diff options
context:
space:
mode:
authorMichael Reed <m.reed@mykolab.com>2015-05-18 11:07:24 -0400
committerMichael Reed <m.reed@mykolab.com>2015-05-18 11:07:24 -0400
commit182b550ef2ba2b954e1f034ca04407f2e0c1c5f6 (patch)
tree5fabe22f8185b16c00285827fb57eb1dbec6c566 /runtime/doc
parentf415932b2da69261631044d6f910a14e24175b6c (diff)
parenta16eab9e57368188c834634cd824ce1ac5613db1 (diff)
downloadrneovim-182b550ef2ba2b954e1f034ca04407f2e0c1c5f6.tar.gz
rneovim-182b550ef2ba2b954e1f034ca04407f2e0c1c5f6.tar.bz2
rneovim-182b550ef2ba2b954e1f034ca04407f2e0c1c5f6.zip
Merge pull request #2532 from Pyrohh/doc-cleanup-3
[RDY] Doc cleanup (3) + terminal remnants Reviewed-by: Justin M. Keyes <justinkz@gmail.com>
Diffstat (limited to 'runtime/doc')
-rw-r--r--runtime/doc/debugger.txt27
-rw-r--r--runtime/doc/eval.txt7
-rw-r--r--runtime/doc/options.txt87
-rw-r--r--runtime/doc/os_unix.txt3
-rw-r--r--runtime/doc/quickref.txt4
-rw-r--r--runtime/doc/starting.txt17
-rw-r--r--runtime/doc/term.txt26
-rw-r--r--runtime/doc/todo.txt7
-rw-r--r--runtime/doc/various.txt9
-rw-r--r--runtime/doc/vim_diff.txt5
10 files changed, 22 insertions, 170 deletions
diff --git a/runtime/doc/debugger.txt b/runtime/doc/debugger.txt
index 7806419d4e..f1eb5639bd 100644
--- a/runtime/doc/debugger.txt
+++ b/runtime/doc/debugger.txt
@@ -7,8 +7,6 @@
Debugger Support Features *debugger-support*
1. Debugger Features |debugger-features|
-2. Vim Compile Options |debugger-compilation|
-3. Integrated Debuggers |debugger-integration|
==============================================================================
1. Debugger Features *debugger-features*
@@ -106,29 +104,4 @@ Another way to use the balloon is with the 'balloonexpr' option. This is
completely user definable.
==============================================================================
-2. Vim Compile Options *debugger-compilation*
-
-The debugger features were added explicitly for use with Sun's Visual
-WorkShop Integrated Programming Environment (ipe). However, they were done
-in as generic a manner as possible so that integration with other debuggers
-could also use some or all of the tools used with Sun's ipe.
-
-The following compile time preprocessor variables control the features:
-
- Alternate Command Input ALT_X_INPUT
- Debug Glyphs FEAT_SIGNS
- Debug Highlights FEAT_SIGNS
- Message Footer FEAT_FOOTER
- Balloon Evaluation FEAT_BEVAL
-
-The first integration with a full IPE/IDE was with Sun Visual WorkShop. To
-compile a gvim which interfaces with VWS set the following flag, which sets
-all the above flags:
-
- Sun Visual WorkShop FEAT_SUN_WORKSHOP
-
-==============================================================================
-3. Integrated Debuggers *debugger-integration*
-
-
vim:tw=78:sw=4:ts=8:ft=help:norl:
diff --git a/runtime/doc/eval.txt b/runtime/doc/eval.txt
index 5eb8f62d8b..4e825e123c 100644
--- a/runtime/doc/eval.txt
+++ b/runtime/doc/eval.txt
@@ -6771,13 +6771,6 @@ menu Compiled with support for |:menu|.
mksession Compiled with support for |:mksession|.
modify_fname Compiled with file name modifiers. |filename-modifiers|
mouse Compiled with support mouse.
-mouse_dec Compiled with support for Dec terminal mouse.
-mouse_gpm Compiled with support for gpm (Linux console mouse)
-mouse_netterm Compiled with support for netterm mouse.
-mouse_sysmouse Compiled with support for sysmouse (*BSD console mouse)
-mouse_sgr Compiled with support for sgr mouse.
-mouse_urxvt Compiled with support for urxvt mouse.
-mouse_xterm Compiled with support for xterm mouse.
mouseshape Compiled with support for 'mouseshape'.
multi_byte Compiled with support for 'encoding'
multi_byte_encoding 'encoding' is set to a multi-byte encoding.
diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt
index 439c8778cc..5db27886bf 100644
--- a/runtime/doc/options.txt
+++ b/runtime/doc/options.txt
@@ -4552,10 +4552,10 @@ A jump table for the options with a short description can be found at |Q_op|.
*'mouse'* *E538*
'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
global
- Enable the use of the mouse. Only works for certain terminals
- (xterm, Win32 |win32-mouse|, *BSD console with sysmouse and Linux
- console with gpm). For using the mouse in the GUI, see |gui-mouse|.
- The mouse can be enabled for different modes:
+
+ Enable the use of the mouse. Only works for certain terminals.
+ For using the mouse in the GUI, see |gui-mouse|. The mouse can be
+ enabled for different modes:
n Normal mode
v Visual mode
i Insert mode
@@ -6771,80 +6771,16 @@ A jump table for the options with a short description can be found at |Q_op|.
by user preferences or the current theme is used.
*'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
-'ttybuiltin' 'tbi' Removed. {Nvim}
+'ttybuiltin' 'tbi' Removed. |vim-differences| {Nvim}
*'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
'ttyfast' 'tf' Removed. |vim-differences| {Nvim}
*'ttymouse'* *'ttym'*
-'ttymouse' 'ttym' string (default depends on 'term')
- global
- {only in Unix, doesn't work in the GUI; not
- available when compiled without |+mouse|}
- Name of the terminal type for which mouse codes are to be recognized.
- Currently these strings are valid:
- *xterm-mouse*
- xterm xterm-like mouse handling. The mouse generates
- "<Esc>[Mscr", where "scr" is three bytes:
- "s" = button state
- "c" = column plus 33
- "r" = row plus 33
- This only works up to 223 columns! See "dec",
- "urxvt", and "sgr" for solutions.
- xterm2 Works like "xterm", but with the xterm reporting the
- mouse position while the mouse is dragged. This works
- much faster and more precise. Your xterm must at
- least at patchlevel 88 / XFree 3.3.3 for this to
- work. See below for how Vim detects this
- automatically.
- *netterm-mouse*
- netterm NetTerm mouse handling. The mouse generates
- "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
- for the row and column.
- *dec-mouse*
- dec DEC terminal mouse handling. The mouse generates a
- rather complex sequence, starting with "<Esc>[".
- This is also available for an Xterm, if it was
- configured with "--enable-dec-locator".
- *urxvt-mouse*
- urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
- The mouse works only if the terminal supports this
- encoding style, but it does not have 223 columns limit
- unlike "xterm" or "xterm2".
- *sgr-mouse*
- sgr Mouse handling for the terminal that emits SGR-styled
- mouse reporting. The mouse works even in columns
- beyond 223. This option is backward compatible with
- "xterm2" because it can also decode "xterm2" style
- mouse codes.
-
- The mouse handling must be enabled at compile time |+mouse_xterm|
- |+mouse_dec| |+mouse_netterm| |+mouse_urxvt| |+mouse_sgr|.
- Only "xterm"(2) is really recognized. NetTerm mouse codes are always
- recognized, if enabled at compile time. DEC terminal mouse codes
- are recognized if enabled at compile time, and 'ttymouse' is not
- "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
- with them).
- This option is automatically set to "xterm", when the 'term' option is
- set to a name that starts with "xterm", "mlterm", or "screen", and
- 'ttymouse' is not set already.
- Additionally, if vim is compiled with the |+termresponse| feature and
- |t_RV| is set to the escape sequence to request the xterm version
- number, more intelligent detection process runs.
- The "xterm2" value will be set if the xterm version is reported to be
- from 95 to 276. The "sgr" value will be set if the xterm version is
- 277 or highter.
- If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
- automatically, set t_RV to an empty string: >
- :set t_RV=
-<
+'ttymouse' 'ttym' Removed. |vim-differences| {Nvim}
+
*'ttyscroll'* *'tsl'*
-'ttyscroll' 'tsl' number (default 999)
- global
- Maximum number of lines to scroll the screen. If there are more lines
- to scroll the window is redrawn. For terminals where scrolling is
- very slow and redrawing is not slow this can be set to a small number,
- e.g., 3, to speed up displaying.
+'ttyscroll' 'tsl' Removed. |vim-differences| {Nvim}
*'ttytype'* *'tty'*
'ttytype' 'tty' string (default from $TERM)
@@ -7163,12 +7099,7 @@ A jump table for the options with a short description can be found at |Q_op|.
has been changed.
*'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
-'weirdinvert' 'wiv' boolean (default off)
- global
- This option has the same effect as the 't_xs' terminal option.
- It is provided for backwards compatibility with version 4.x.
- Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
- vice versa. Has no effect when the GUI is running.
+'weirdinvert' 'wiv' Removed. |vim-differences| {Nvim}
*'whichwrap'* *'ww'*
'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
diff --git a/runtime/doc/os_unix.txt b/runtime/doc/os_unix.txt
index 2955a532fe..604fa5827a 100644
--- a/runtime/doc/os_unix.txt
+++ b/runtime/doc/os_unix.txt
@@ -35,8 +35,7 @@ When using Vim in an xterm the mouse clicks can be used by Vim by setting
'mouse' to "a". If there is access to an X-server gui style copy/paste will
be used and visual feedback will be provided while dragging with the mouse.
If you then still want the xterm copy/paste with the mouse, press the shift
-key when using the mouse. See |mouse-using|. Visual feedback while dragging
-can also be achieved via the 'ttymouse' option if your xterm is new enough.
+key when using the mouse. See |mouse-using|.
*terminal-colors*
To use colors in Vim you can use the following example (if your terminal
diff --git a/runtime/doc/quickref.txt b/runtime/doc/quickref.txt
index 5daeb15c00..92492f72e1 100644
--- a/runtime/doc/quickref.txt
+++ b/runtime/doc/quickref.txt
@@ -902,8 +902,6 @@ Short explanation of each option: *option-list*
'toolbariconsize' 'tbis' size of the toolbar icons (for GTK 2 only)
'ttimeout' time out on mappings
'ttimeoutlen' 'ttm' time out time for key codes in milliseconds
-'ttymouse' 'ttym' type of mouse codes generated
-'ttyscroll' 'tsl' maximum number of lines for a scroll
'ttytype' 'tty' alias for 'term'
'undodir' 'udir' where to store undo files
'undofile' 'udf' save undo information in a file
@@ -919,7 +917,6 @@ Short explanation of each option: *option-list*
'virtualedit' 've' when to use virtual editing
'visualbell' 'vb' use visual bell instead of beeping
'warn' warn for shell command when buffer was changed
-'weirdinvert' 'wiv' for terminals that have weird inversion method
'whichwrap' 'ww' allow specified keys to cross line boundaries
'wildchar' 'wc' command-line character for wildcard expansion
'wildcharm' 'wcm' like 'wildchar' but also works when mapped
@@ -1137,7 +1134,6 @@ Context-sensitive completion on the command-line:
|-s| -s {scriptin} first read commands from the file {scriptin}
|-w| -w {scriptout} write typed chars to file {scriptout} (append)
|-W| -W {scriptout} write typed chars to file {scriptout} (overwrite)
-|-T| -T {terminal} set terminal name
|-u| -u {vimrc} read inits from {vimrc} instead of other inits
|-U| -U {gvimrc} idem, for when starting the GUI
|-i| -i {viminfo} read info from {viminfo} instead of other files
diff --git a/runtime/doc/starting.txt b/runtime/doc/starting.txt
index 017fba1824..3475a63307 100644
--- a/runtime/doc/starting.txt
+++ b/runtime/doc/starting.txt
@@ -309,13 +309,6 @@ argument.
'tabpagemax' pages (default 10). If there are more tab pages
than arguments, the last few tab pages will be editing an
empty file. Also see |tabpage|.
-
- *-T*
--T {terminal} Set the terminal type to "terminal". This influences the
- codes that Vim will send to your terminal. This is normally
- not needed, because Vim will be able to find out what type
- of terminal you are using. (See |terminal-info|.)
-
*-d*
-d Start in |diff-mode|.
@@ -772,7 +765,7 @@ To change it later, use a ":let" command like this: >
In case you need the value of $VIMRUNTIME in a shell (e.g., for a script that
greps in the help files) you might be able to use this: >
- VIMRUNTIME=`vim -e -T dumb --cmd 'exe "set t_cm=\<C-M>"|echo $VIMRUNTIME|quit' | tr -d '\015' `
+ VIMRUNTIME="$(nvim -e --cmd 'echo $VIMRUNTIME|quit' 2>&1)"
==============================================================================
5. Suspending *suspend*
@@ -832,10 +825,10 @@ vimrc file.
These commands will write ":map" and ":set" commands to a file, in such a way
that when these commands are executed, the current key mappings and options
will be set to the same values. The options 'columns', 'endofline',
-'fileformat', 'lines', 'modified', 'scroll', 'term', and 'ttymouse' are not
-included, because these are terminal or file dependent. Note that the options
-'binary', 'paste' and 'readonly' are included, this might not always be what
-you want.
+'fileformat', 'lines', 'modified', 'scroll', and 'term' are not included,
+because these are terminal or file dependent.
+Note that the options 'binary', 'paste' and 'readonly' are included, this
+might not always be what you want.
When special keys are used in mappings, The 'cpoptions' option will be
temporarily set to its Vim default, to avoid the mappings to be
diff --git a/runtime/doc/term.txt b/runtime/doc/term.txt
index e0e7f37948..da3e1ac11e 100644
--- a/runtime/doc/term.txt
+++ b/runtime/doc/term.txt
@@ -27,9 +27,6 @@ NOTE: Most of this is not used when running the |GUI|.
When Vim is started a default terminal type is assumed. for MS-DOS this is
the pc terminal, for Unix an ansi terminal.
-You can give the terminal name with the '-T' Vim argument. If it is not given
-Vim will try to get the name from the TERM environment variable.
-
*termcap* *terminfo* *E557* *E558* *E559*
On Unix the terminfo database or termcap file is used. This is referred to as
"termcap" in all the documentation. At compile time, when running configure,
@@ -243,7 +240,7 @@ Added by Vim (there are no standard codes for these):
t_EI end insert mode (block cursor shape) *t_EI* *'t_EI'*
|termcap-cursor-shape|
t_RV request terminal version string (for xterm) *t_RV* *'t_RV'*
- |xterm-8bit| |v:termresponse| |'ttymouse'| |xterm-codes|
+ |xterm-8bit| |v:termresponse| |xterm-codes|
t_u7 request cursor position (for xterm) *t_u7* *'t_u7'*
see |'ambiwidth'|
@@ -504,10 +501,6 @@ If the characters from the terminal are arriving with more than 1 second
between them you might want to set the 'timeout' and/or 'ttimeout' option.
See the "Options" chapter |options|.
-If your terminal scrolls very slowly, but redrawing is not slow, set the
-'ttyscroll' option to a small number, e.g., 3. This will make Vim redraw the
-screen instead of scrolling, when there are more than 3 lines to be scrolled.
-
If you are using a color terminal that is slow, use this command: >
hi NonText cterm=NONE ctermfg=NONE
This avoids that spaces are sent when they have different attributes. On most
@@ -533,11 +526,6 @@ Don't forget to enable the mouse with this command: >
:set mouse=a
Otherwise Vim won't recognize the mouse in all modes (See 'mouse').
-Currently the mouse is supported for Unix in an xterm window, in a *BSD
-console with |sysmouse|, in a Linux console (with GPM |gpm-mouse|), for
-MS-DOS and in a Windows console.
-Mouse clicks can be used to position the cursor, select an area and paste.
-
These characters in the 'mouse' option tell in which situations the mouse will
be used by Vim:
n Normal mode
@@ -600,7 +588,7 @@ When the X-server clipboard is available, the command server described in
*xterm-copy-paste*
NOTE: In some (older) xterms, it's not possible to move the cursor past column
95 or 223. This is an xterm problem, not Vim's. Get a newer xterm
-|color-xterm|. Also see |'ttymouse'|.
+|color-xterm|.
Copy/paste in xterm with (current mode NOT included in 'mouse'):
1. Press left mouse button on first letter of text, move mouse pointer to last
@@ -731,20 +719,10 @@ and then drag) will result in whole words to be selected. This continues
until the button is released, at which point the selection is per character
again.
- *gpm-mouse*
-The GPM mouse is only supported when the |+mouse_gpm| feature was enabled at
-compile time. The GPM mouse driver (Linux console) does not support quadruple
-clicks.
-
In Insert mode, when a selection is started, Vim goes into Normal mode
temporarily. When Visual or Select mode ends, it returns to Insert mode.
This is like using CTRL-O in Insert mode. Select mode is used when the
'selectmode' option contains "mouse".
- *sysmouse*
-The sysmouse is only supported when the |+mouse_sysmouse| feature was enabled
-at compile time. The sysmouse driver (*BSD console) does not support keyboard
-modifiers.
-
*drag-status-line*
When working with several windows, the size of the windows can be changed by
dragging the status line with the mouse. Point the mouse at a status line,
diff --git a/runtime/doc/todo.txt b/runtime/doc/todo.txt
index 5078f5c7ce..c0e4bf6865 100644
--- a/runtime/doc/todo.txt
+++ b/runtime/doc/todo.txt
@@ -540,11 +540,6 @@ is confusing. Should say "the argument list is empty".
xterm supports escape sequences to mark a paste operation. Need to be
enabled. (Bruno Sutic, 2014 Jul 11) How to know the terminal supports this?
-URXVT:
-- will get stuck if byte sequence does not contain the expected semicolon.
-- Use urxvt mouse support also in xterm. Explanations:
- http://www.midnight-commander.org/ticket/2662
-
Patch to have the fold and sign column and at the last line of the buffer.
(Marco Hinz, 2014 Sep 25)
Alternate suggestion: let all columns continue, also the number column.
@@ -3146,8 +3141,6 @@ Performance:
default, instead of using the block size of the device, because the swap
file is created only after setting the block size in mf_open(). How can
this be improved?
-8 Set default for 'ttyscroll' to half a screen height? Should speed up
- MS-DOS version. (Negri)
7 C syntax highlighting gets a lot slower after ":set foldmethod=syntax".
(Charles Campbell) Inserting a "{" is very slow. (dman)
7 HTML syntax highlighting is slow for long lines. Try displaying
diff --git a/runtime/doc/various.txt b/runtime/doc/various.txt
index 6419ecb628..ef5844b2d2 100644
--- a/runtime/doc/various.txt
+++ b/runtime/doc/various.txt
@@ -231,7 +231,7 @@ g8 Print the hex values of the bytes used in the
and |nvim-terminal-emulator| for more information.
*:!cmd* *:!* *E34*
-:!{cmd} Execute {cmd} with the shell. See also 'shell'.
+:!{cmd} Execute {cmd} with 'shell'. See also |:terminal|.
Any '!' in {cmd} is replaced with the previous
external command (see also 'cpoptions'). But not when
@@ -364,13 +364,6 @@ N *+mksession* |:mksession|
N *+modify_fname* |filename-modifiers|
N *+mouse* Mouse handling |mouse-using|
N *+mouseshape* |'mouseshape'|
-B *+mouse_dec* Unix only: Dec terminal mouse handling |dec-mouse|
-N *+mouse_gpm* Unix only: Linux console mouse handling |gpm-mouse|
-B *+mouse_netterm* Unix only: netterm mouse handling |netterm-mouse|
-N *+mouse_sysmouse* Unix only: *BSD console mouse handling |sysmouse|
-B *+mouse_sgr* Unix only: sgr mouse handling |sgr-mouse|
-B *+mouse_urxvt* Unix only: urxvt mouse handling |urxvt-mouse|
-N *+mouse_xterm* Unix only: xterm mouse handling |xterm-mouse|
N *+multi_byte* 16 and 32 bit characters |multibyte|
*+multi_byte_ime* Win32 input method for multibyte chars |multibyte-ime|
N *+multi_lang* non-English language support |multi-lang|
diff --git a/runtime/doc/vim_diff.txt b/runtime/doc/vim_diff.txt
index 4ad559600a..2bfd5f19a5 100644
--- a/runtime/doc/vim_diff.txt
+++ b/runtime/doc/vim_diff.txt
@@ -115,11 +115,14 @@ MS-DOS support:
Other options:
'macatsui'
- 'shortname'
'shelltype'
+ 'shortname'
'termencoding'
'textauto'
'textmode'
+ 'ttybuiltin'
+ 'ttymouse'
+ 'weirdinvert'
Other commands:
:fixdel