diff options
Diffstat (limited to 'runtime/doc')
29 files changed, 126 insertions, 555 deletions
diff --git a/runtime/doc/cmdline.txt b/runtime/doc/cmdline.txt index 2892faa496..77813423ba 100644 --- a/runtime/doc/cmdline.txt +++ b/runtime/doc/cmdline.txt @@ -1053,7 +1053,6 @@ VARIOUS The command-line window cannot be used: - when there already is a command-line window (no nesting) -- for entering an encryption key or when using inputsecret() - when Vim was not compiled with the |+vertsplit| feature Some options are set when the command-line window is opened: diff --git a/runtime/doc/editing.txt b/runtime/doc/editing.txt index e4867e7a90..3496a03921 100644 --- a/runtime/doc/editing.txt +++ b/runtime/doc/editing.txt @@ -136,22 +136,8 @@ as the original file with 'backupext' appended. The default "~" is a bit strange to avoid accidentally overwriting existing files. If you prefer ".bak" change the 'backupext' option. Extra dots are replaced with '_' on MS-DOS machines, when Vim has detected that an MS-DOS-like filesystem is being used -(e.g., messydos or crossdos) or when the 'shortname' option is on. The -backup file can be placed in another directory by setting 'backupdir'. - - *auto-shortname* -Technical: On the Amiga you can use 30 characters for a file name. But on an - MS-DOS-compatible filesystem only 8 plus 3 characters are - available. Vim tries to detect the type of filesystem when it is - creating the .swp file. If an MS-DOS-like filesystem is suspected, - a flag is set that has the same effect as setting the 'shortname' - option. This flag will be reset as soon as you start editing a - new file. The flag will be used when making the file name for the - ".swp" and ".~" files for the current file. But when you are - editing a file in a normal filesystem and write to an MS-DOS-like - filesystem the flag will not have been set. In that case the - creation of the ".~" file may fail and you will get an error - message. Use the 'shortname' option in this case. +(e.g., messydos or crossdos). The backup file can be placed in another +directory by setting 'backupdir'. When you started editing without giving a file name, "No File" is displayed in messages. If the ":write" command is used with a file name argument, the file @@ -550,10 +536,6 @@ Before editing binary, executable or Vim script files you should set the option. This will avoid the use of 'fileformat'. Without this you risk that single <NL> characters are unexpectedly replaced with <CR><NL>. -You can encrypt files that are written by setting the 'key' option. This -provides some security against others reading your files. |encryption| - - ============================================================================== 3. The argument list *argument-list* *arglist* @@ -1356,119 +1338,12 @@ There are a few things to remember when editing binary files: ============================================================================== 9. Encryption *encryption* -Vim is able to write files encrypted, and read them back. The encrypted text -cannot be read without the right key. -{only available when compiled with the |+cryptv| feature} *E833* - -The text in the swap file and the undo file is also encrypted. *E843* -However, this is done block-by-block and may reduce the time needed to crack a -password. You can disable the swap file, but then a crash will cause you to -lose your work. The undo file can be disabled without much disadvantage. > - :set noundofile - :noswapfile edit secrets - -Note: The text in memory is not encrypted. A system administrator may be able -to see your text while you are editing it. When filtering text with -":!filter" or using ":w !command" the text is not encrypted, this may reveal -it to others. The 'viminfo' file is not encrypted. - -WARNING: If you make a typo when entering the key and then write the file and -exit, the text will be lost! - -The normal way to work with encryption, is to use the ":X" command, which will -ask you to enter a key. A following write command will use that key to -encrypt the file. If you later edit the same file, Vim will ask you to enter -a key. If you type the same key as that was used for writing, the text will -be readable again. If you use a wrong key, it will be a mess. - - *:X* -:X Prompt for an encryption key. The typing is done without showing the - actual text, so that someone looking at the display won't see it. - The typed key is stored in the 'key' option, which is used to encrypt - the file when it is written. The file will remain unchanged until you - write it. See also |-x|. - -The value of the 'key' options is used when text is written. When the option -is not empty, the written file will be encrypted, using the value as the -encryption key. A magic number is prepended, so that Vim can recognize that -the file is encrypted. - -To disable the encryption, reset the 'key' option to an empty value: > - :set key= - -You can use the 'cryptmethod' option to select the type of encryption, use one -of these two: > - :setlocal cm=zip " weak method, backwards compatible - :setlocal cm=blowfish " strong method -Do this before writing the file. When reading an encrypted file it will be -set automatically to the method used when that file was written. You can -change 'cryptmethod' before writing that file to change the method. -To set the default method, used for new files, use one of these in your -|vimrc| file: > - set cm=zip - set cm=blowfish -The message given for reading and writing a file will show "[crypted]" when -using zip, "[blowfish]" when using blowfish. - -When writing an undo file, the same key and method will be used for the text -in the undo file. |persistent-undo|. - - *E817* *E818* *E819* *E820* -When encryption does not work properly, you would be able to write your text -to a file and never be able to read it back. Therefore a test is performed to -check if the encryption works as expected. If you get one of these errors -don't write the file encrypted! You need to rebuild the Vim binary to fix -this. - -*E831* This is an internal error, "cannot happen". If you can reproduce it, -please report to the developers. - -When reading a file that has been encrypted and the 'key' option is not empty, -it will be used for decryption. If the value is empty, you will be prompted -to enter the key. If you don't enter a key, or you enter the wrong key, the -file is edited without being decrypted. There is no warning about using the -wrong key (this makes brute force methods to find the key more difficult). - -If want to start reading a file that uses a different key, set the 'key' -option to an empty string, so that Vim will prompt for a new one. Don't use -the ":set" command to enter the value, other people can read the command over -your shoulder. - -Since the value of the 'key' option is supposed to be a secret, its value can -never be viewed. You should not set this option in a vimrc file. - -An encrypted file can be recognized by the "file" command, if you add these -lines to "/etc/magic", "/usr/share/misc/magic" or wherever your system has the -"magic" file: > - 0 string VimCrypt~ Vim encrypted file - >9 string 01 - "zip" cryptmethod - >9 string 02 - "blowfish" cryptmethod - - -Notes: -- Encryption is not possible when doing conversion with 'charconvert'. -- Text you copy or delete goes to the numbered registers. The registers can - be saved in the .viminfo file, where they could be read. Change your - 'viminfo' option to be safe. -- Someone can type commands in Vim when you walk away for a moment, he should - not be able to get the key. -- If you make a typing mistake when entering the key, you might not be able to - get your text back! -- If you type the key with a ":set key=value" command, it can be kept in the - history, showing the 'key' value in a viminfo file. -- There is never 100% safety. The encryption in Vim has not been tested for - robustness. -- The algorithm used for 'cryptmethod' "zip" is breakable. A 4 character key - in about one hour, a 6 character key in one day (on a Pentium 133 PC). This - requires that you know some text that must appear in the file. An expert - can break it for any key. When the text has been decrypted, this also means - that the key can be revealed, and other files encrypted with the same key - can be decrypted. -- Pkzip uses the same encryption as 'cryptmethod' "zip", and US Govt has no - objection to its export. Pkzip's public file APPNOTE.TXT describes this - algorithm in detail. -- Vim originates from the Netherlands. That is where the sources come from. - Thus the encryption code is not exported from the USA. + *:X* *E817* *E818* *E819* *E820* +Support for editing encrypted files has been removed, but may be added back in +the future. See the following discussions for more information: + + https://github.com/neovim/neovim/issues/694 + https://github.com/neovim/neovim/issues/701 ============================================================================== 10. Timestamps *timestamp* *timestamps* diff --git a/runtime/doc/eval.txt b/runtime/doc/eval.txt index 0778cf6122..46ee28a461 100644 --- a/runtime/doc/eval.txt +++ b/runtime/doc/eval.txt @@ -2811,7 +2811,7 @@ exists({expr}) The result is a Number, which is non-zero if {expr} is For checking for a supported feature use |has()|. Examples: > - exists("&shortname") + exists("&mouse") exists("$HOSTNAME") exists("*strftime") exists("*s:MyFunc") @@ -5604,7 +5604,6 @@ setwinvar({nr}, {varname}, {val}) *setwinvar()* sha256({string}) *sha256()* Returns a String with 64 hex charactes, which is the SHA256 checksum of {string}. - {only available when compiled with the |+cryptv| feature} shellescape({string} [, {special}]) *shellescape()* Escape {string} for use as a shell command argument. @@ -6667,7 +6666,6 @@ arp Compiled with ARP support (Amiga). autocmd Compiled with autocommand support. |autocommand| balloon_eval Compiled with |balloon-eval| support. balloon_multiline GUI supports multiline balloons. -beos BeOS version of Vim. browse Compiled with |:browse| support, and browse() will work. browsefilter Compiled with support for |browsefilter|. @@ -6681,7 +6679,6 @@ cmdline_hist Compiled with |cmdline-history| support. cmdline_info Compiled with 'showcmd' and 'ruler' support. comments Compiled with |'comments'| support. compatible Compiled to be very Vi compatible. -cryptv Compiled with encryption support |encryption|. cscope Compiled with |cscope| support. debug Compiled with "DEBUG" defined. dialog_con Compiled with console dialog support. @@ -6691,7 +6688,6 @@ digraphs Compiled with support for digraphs. dnd Compiled with support for the "~ register |quote_~|. dos16 16 bits DOS version of Vim. dos32 32 bits DOS (DJGPP) version of Vim. -ebcdic Compiled on a machine with ebcdic character set. emacs_tags Compiled with support for Emacs tags. eval Compiled with expression evaluation support. Always true, of course! @@ -6718,7 +6714,6 @@ gui_gtk Compiled with GTK+ GUI (any version). gui_gtk2 Compiled with GTK+ 2 GUI (gui_gtk is also defined). gui_mac Compiled with Macintosh GUI. gui_motif Compiled with Motif GUI. -gui_photon Compiled with Photon GUI. gui_running Vim is running in the GUI, or it will start soon. gui_win32 Compiled with MS Windows Win32 GUI. gui_win32s idem, and Win32s system being used (Windows 3.1) diff --git a/runtime/doc/filetype.txt b/runtime/doc/filetype.txt index 94454fb469..2894814025 100644 --- a/runtime/doc/filetype.txt +++ b/runtime/doc/filetype.txt @@ -34,9 +34,8 @@ if you didn't do that already. Detail: The ":filetype on" command will load one of these files: Amiga $VIMRUNTIME/filetype.vim - Mac $VIMRUNTIME:filetype.vim + Mac $VIMRUNTIME/filetype.vim MS-DOS $VIMRUNTIME\filetype.vim - RiscOS Vim:Filetype Unix $VIMRUNTIME/filetype.vim VMS $VIMRUNTIME/filetype.vim This file is a Vim script that defines autocommands for the @@ -268,38 +267,6 @@ the 'runtimepath' for a directory to use. If there isn't one, set 'runtimepath' in the |system-vimrc|. Be careful to keep the default directories! - - *autocmd-osfiletypes* -NOTE: this code is currently disabled, as the RISC OS implementation was -removed. In the future this will use the 'filetype' option. - -On operating systems which support storing a file type with the file, you can -specify that an autocommand should only be executed if the file is of a -certain type. - -The actual type checking depends on which platform you are running Vim -on; see your system's documentation for details. - -To use osfiletype checking in an autocommand you should put a list of types to -match in angle brackets in place of a pattern, like this: > - - :au BufRead *.html,<&faf;HTML> runtime! syntax/html.vim - -This will match: - -- Any file whose name ends in ".html" -- Any file whose type is "&faf" or "HTML", where the meaning of these types - depends on which version of Vim you are using. - Unknown types are considered NOT to match. - -You can also specify a type and a pattern at the same time (in which case they -must both match): > - - :au BufRead <&fff>diff* - -This will match files of type "&fff" whose names start with "diff". - - *plugin-details* The "plugin" directory can be in any of the directories in the 'runtimepath' option. All of these directories will be searched for plugins and they are diff --git a/runtime/doc/gui.txt b/runtime/doc/gui.txt index bdddec585d..c174914c54 100644 --- a/runtime/doc/gui.txt +++ b/runtime/doc/gui.txt @@ -24,9 +24,7 @@ Other GUI documentation: 1. Starting the GUI *gui-start* *E229* *E233* First you must make sure you actually have a version of Vim with the GUI code -included. You can check this with the ":version" command, it says "with xxx -GUI", where "xxx" is X11-Motif, X11-Athena, Photon, GTK, GTK2, etc., or -"MS-Windows 32 bit GUI version". +included. How to start the GUI depends on the system used. Mostly you can run the GUI version of Vim with: @@ -690,13 +688,10 @@ because the item will never be selected. Use a single colon to keep it simple. *gui-toolbar* -The toolbar is currently available in the Win32, Athena, Motif, GTK+ (X11), -and Photon GUI. It should turn up in other GUIs in due course. The -default toolbar is setup in menu.vim. -The display of the toolbar is controlled by the 'guioptions' letter 'T'. You -can thus have menu & toolbar together, or either on its own, or neither. -The appearance is controlled by the 'toolbar' option. You can choose between -an image, text or both. +The default toolbar is setup in menu.vim. The display of the toolbar is +controlled by the 'guioptions' letter 'T'. You can thus have menu & toolbar +together, or either on its own, or neither. The appearance is controlled by +the 'toolbar' option. You can choose between an image, text or both. *toolbar-icon* The toolbar is defined as a special menu called ToolBar, which only has one @@ -779,9 +774,9 @@ from the main menu bar. You must then use the |:popup| or |:tearoff| command to display it. *popup-menu* -In the Win32, GTK+, Motif, Athena and Photon GUI, you can define the -special menu "PopUp". This is the menu that is displayed when the right mouse -button is pressed, if 'mousemodel' is set to popup or popup_setpos. +You can define the special menu "PopUp". This is the menu that is displayed +when the right mouse button is pressed, if 'mousemodel' is set to popup or +popup_setpos. 5.3 Showing What Menus Are Mapped To *showing-menus* diff --git a/runtime/doc/index.txt b/runtime/doc/index.txt index 6792acd390..01ec37b5a0 100644 --- a/runtime/doc/index.txt +++ b/runtime/doc/index.txt @@ -1072,7 +1072,6 @@ tag command action ~ |:@@| :@@ repeat the previous ":@" |:Next| :N[ext] go to previous file in the argument list |:Print| :P[rint] print lines -|:X| :X ask for encryption key |:append| :a[ppend] append text |:abbreviate| :ab[breviate] enter abbreviation |:abclear| :abc[lear] remove all abbreviations diff --git a/runtime/doc/insert.txt b/runtime/doc/insert.txt index 60454fa8e1..8126a5b458 100644 --- a/runtime/doc/insert.txt +++ b/runtime/doc/insert.txt @@ -1972,7 +1972,6 @@ self explanatory. Using the long or the short version depends on the possible [converted] conversion from 'fileencoding' to 'encoding' done - [crypted] file was decrypted [READ ERRORS] not all of the file could be read diff --git a/runtime/doc/manpages/vim.1 b/runtime/doc/manpages/vim.1 index 820caa24f5..59f21e1b9b 100644 --- a/runtime/doc/manpages/vim.1 +++ b/runtime/doc/manpages/vim.1 @@ -395,9 +395,6 @@ If the {scriptout} file exists, characters are appended. \-W {scriptout} Like \-w, but an existing file is overwritten. .TP -\-x -Use encryption when writing files. Will prompt for a crypt key. -.TP \-X Don't connect to the X server. Shortens startup time in a terminal, but the window title and clipboard will not be used. diff --git a/runtime/doc/mbyte.txt b/runtime/doc/mbyte.txt index 87ae8777c2..2a5ccc626e 100644 --- a/runtime/doc/mbyte.txt +++ b/runtime/doc/mbyte.txt @@ -276,8 +276,7 @@ u Unicode Universal encoding, can replace all others. ISO 10646. Other encodings cannot be used by Vim internally. But files in other encodings can be edited by using conversion, see 'fileencoding'. -Note that all encodings must use ASCII for the characters up to 128 (except -when compiled for EBCDIC). +Note that all encodings must use ASCII for the characters up to 128. Supported 'encoding' values are: *encoding-values* 1 latin1 8-bit characters (ISO 8859-1, also used for cp1252) diff --git a/runtime/doc/nvim_clipboard.txt b/runtime/doc/nvim_clipboard.txt index cf38dea3d6..cf63685499 100644 --- a/runtime/doc/nvim_clipboard.txt +++ b/runtime/doc/nvim_clipboard.txt @@ -6,25 +6,27 @@ Clipboard integration for Nvim *nvim-clipboard* -Nvim has no connection to the system clipboard, instead it is accessible -through the |nvim-provider| infrastructure which transparently uses shell -commands for communicating with the clipboard. +Nvim has no direct connection to the system clipboard. Instead, it is +accessible through the |nvim-provider| infrastructure, which transparently +uses shell commands for communicating with the clipboard. -To use clipboard on Nvim, make sure you have one of the following programs -installed and available on $PATH: +Clipboard access is implicitly enabled if any of the following clipboard tools +is found in your `$PATH`. - xclip -- xsel(newer alternative to xclip) -- pbcopy/pbpaste(already available on Mac OS X) +- xsel (newer alternative to xclip) +- pbcopy/pbpaste (only for Mac OS X) -Having any of these programs should enable the '+' and '*' registers. As an -optional step, set the 'unnamedclip' option to transparently access clipboard -using the unnamed register. If you use the same |vimrc| for both Vim and Nvim, -make sure you only set the option when `has('nvim')` is true: +The presence of a suitable clipboard tool implicitly enables the '+' and '*' +registers. + +If you want to ALWAYS use the clipboard for ALL operations (as opposed +to interacting with the '+' and/or '*' registers explicitly), set the +following option: > - if has('nvim') - set unnamedclip - endif + set clipboard+=unnamedplus < +See 'clipboard' for details and more options. + ============================================================================== vim:tw=78:ts=8:noet:ft=help:norl: diff --git a/runtime/doc/nvim_intro.txt b/runtime/doc/nvim_intro.txt index 8a82a09890..d6389a815d 100644 --- a/runtime/doc/nvim_intro.txt +++ b/runtime/doc/nvim_intro.txt @@ -17,7 +17,7 @@ differentiate Nvim from Vim: 2. Job control |job-control| 3. Python plugins |nvim-python| 4. Clipboard integration |nvim-clipboard| -5. Remote plugins |remote-plugin| +5. Remote plugins |remote-plugin| 6. Provider infrastructure |nvim-provider| ============================================================================== diff --git a/runtime/doc/nvim_provider.txt b/runtime/doc/nvim_provider.txt index e67a5c174c..2ab0510a3b 100644 --- a/runtime/doc/nvim_provider.txt +++ b/runtime/doc/nvim_provider.txt @@ -25,7 +25,7 @@ examples of integration with external systems that are implemented in Vim and are now decoupled from Nvim core as providers: The first example is clipboard integration: On the original Vim source code, -clipboard functions account for more than 1k lines of C source code(and that +clipboard functions account for more than 1k lines of C source code (and that is just on ui.c). All to peform two tasks that are now accomplished with simple shell commands such as xclip or pbcopy/pbpaste. @@ -57,21 +57,20 @@ What these functions do is simple: implemented, and is called by the "has" vimscript function to check if features are available. -The basic idea is that the provider#(name)#Call function should implement +The basic idea is that the provider#(name)#Call function should implement integration with an external system, because calling shell commands and -|msgpack-rpc| clients(Nvim only) is easier to do in vimscript. +|msgpack-rpc| clients (Nvim only) is easier to do in vimscript. -Now, back to the python example. Instead of modifying vimscript to allow the -definition of lowercase functions and commands(for the |:python|, |:pyfile| -and |:pydo| commands, and the |pyeval()| function), which would break -backwards compatibility with Vim, we implemented the +Now, back to the python example. Instead of modifying vimscript to allow for +the definition of lowercase functions and commands (for the |:python|, +|:pyfile|, and |:pydo| commands, and the |pyeval()| function), which would +break backwards compatibility with Vim, we implemented the autoload/provider/python.vim script and the provider#python#Call function that is only defined if an external python host is started successfully. -That works well with the has('python') expression (normally used by python +That works well with the `has('python')` expression (normally used by python plugins) because if the python host isn't installed then the plugin will -"think" it is running in a Vim compiled without +python feature. - +"think" it is running in a Vim compiled without |+python| feature. ============================================================================== vim:tw=78:ts=8:noet:ft=help:norl: diff --git a/runtime/doc/nvim_python.txt b/runtime/doc/nvim_python.txt index e60cc93b19..486c25edd0 100644 --- a/runtime/doc/nvim_python.txt +++ b/runtime/doc/nvim_python.txt @@ -13,16 +13,16 @@ Python plugins and scripting in Nvim *nvim-python* 1. Introduction *nvim-python-intro* Through an external python interpreter connected via |msgpack-rpc|, Nvim -offers some support for the classic |python-vim| interface. For now only the +offers some support for the legacy |python-vim| interface. For now only the old Vim 7.3 API is supported. ============================================================================== 2. Quickstart *nvim-python-quickstart* -If you just want to start using python plugins with Nvim quickly, here's a -simple step-by-step: +If you just want to start using Vim python plugins with Nvim quickly, here's a +simple tutorial: -- Make sure python 2.6 or 2.7 is available on your `$PATH` +- Make sure python 2.6 or 2.7 is available in your `$PATH` - Install the `neovim` python package: > $ pip install neovim diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt index 813ed83be4..c646caae4f 100644 --- a/runtime/doc/options.txt +++ b/runtime/doc/options.txt @@ -1413,9 +1413,6 @@ A jump table for the options with a short description can be found at |Q_op|. Note that v:fname_in and v:fname_out will never be the same. Note that v:charconvert_from and v:charconvert_to may be different from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4. - Encryption is not done by Vim when using 'charconvert'. If you want - to encrypt the file after conversion, 'charconvert' should take care - of this. This option cannot be set from a |modeline| or in the |sandbox|, for security reasons. @@ -2197,36 +2194,8 @@ A jump table for the options with a short description can be found at |Q_op|. variables overrule the terminal size values obtained with system specific functions. - *'cryptmethod'* *'cm'* -'cryptmethod' string (default "zip") - global or local to buffer |global-local| - {not in Vi} - Method used for encryption when the buffer is written to a file: - *pkzip* - zip PkZip compatible method. A weak kind of encryption. - Backwards compatible with Vim 7.2 and older. - *blowfish* - blowfish Blowfish method. Strong encryption. Requires Vim 7.3 - or later, files can NOT be read by Vim 7.2 and older. - This adds a "seed" to the file, every time you write - the file the encrypted bytes will be different. - - When reading an encrypted file 'cryptmethod' will be set automatically - to the detected method of the file being read. Thus if you write it - without changing 'cryptmethod' the same method will be used. - Changing 'cryptmethod' does not mark the file as modified, you have to - explicitly write it, you don't get a warning unless there are other - modifications. Also see |:X|. - - When setting the global value to an empty string, it will end up with - the value "zip". When setting the local value to an empty string the - buffer will use the global value. - - When a new encryption method is added in a later version of Vim, and - the current version does not recognize it, you will get *E821* . - You need to edit this file with the later version of Vim. - +'cryptmethod' Removed. {Nvim} *'cscopepathcomp'* *'cspc'* 'cscopepathcomp' 'cspc' number (default 0) @@ -3482,7 +3451,7 @@ A jump table for the options with a short description can be found at |Q_op|. the case of X). The font names given should be "normal" fonts. Vim will try to find the related bold and italic fonts. - For Win32, GTK, Motif, Mac OS and Photon: > + For Win32, GTK, Motif, and Mac OS: > :set guifont=* < will bring up a font requester, where you can pick the font you want. @@ -3679,7 +3648,7 @@ A jump table for the options with a short description can be found at |Q_op|. 't' Include tearoff menu items. Currently only works for Win32, GTK+, and Motif 1.2 GUI. *'go-T'* - 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon + 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, and Athena GUIs. *'go-r'* 'r' Right-hand scrollbar is always present. @@ -4296,7 +4265,6 @@ A jump table for the options with a short description can be found at |Q_op|. "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,=" for AMIGA: "@,48-57,/,.,-,_,+,,,$,:" for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~" - for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,=" otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=") global {not in Vi} @@ -4420,23 +4388,8 @@ A jump table for the options with a short description can be found at |Q_op|. Otherwise only one space is inserted. NOTE: This option is set when 'compatible' is set. - *'key'* -'key' string (default "") - local to buffer - {not in Vi} - {only available when compiled with the |+cryptv| - feature} - The key that is used for encrypting and decrypting the current buffer. - See |encryption| and 'cryptmethod'. - Careful: Do not set the key value by hand, someone might see the typed - key. Use the |:X| command. But you can make 'key' empty: > - :set key= -< It is not possible to get the value of this option with ":set key" or - "echo &key". This is to avoid showing it to someone who shouldn't - know. It also means you cannot see it yourself once you have set it, - be careful not to make a typing error! - You can use "&key" in an expression to detect whether encryption is - enabled. When 'key' is set it returns "*****" (five stars). + *'key'* +'key' Removed. {Nvim} *'keymap'* *'kmp'* *E544* 'keymap' 'kmp' string (default "") @@ -5250,14 +5203,6 @@ A jump table for the options with a short description can be found at |Q_op|. This option cannot be set from a |modeline| or in the |sandbox|, for security reasons. - - *'osfiletype'* *'oft'* -'osfiletype' 'oft' string (default: "") - local to buffer - {not in Vi} - This option was supported on RISC OS, which has been removed. - - *'paragraphs'* *'para'* 'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp") global @@ -5742,9 +5687,6 @@ A jump table for the options with a short description can be found at |Q_op|. Macintosh: "$VIM:vimfiles, $VIMRUNTIME, $VIM:vimfiles:after" - RISC-OS: "Choices:vimfiles, - $VIMRUNTIME, - Choices:vimfiles/after" VMS: "sys$login:vimfiles, $VIM/vimfiles, $VIMRUNTIME, @@ -6255,17 +6197,7 @@ A jump table for the options with a short description can be found at |Q_op|. set and to the Vim default value when 'compatible' is reset. *'shortname'* *'sn'* *'noshortname'* *'nosn'* -'shortname' 'sn' boolean (default off) - local to buffer - {not in Vi, not in MS-DOS versions} - Filenames are assumed to be 8 characters plus one extension of 3 - characters. Multiple dots in file names are not allowed. When this - option is on, dots in file names are replaced with underscores when - adding an extension (".~" or ".swp"). This option is not available - for MS-DOS, because then it would always be on. This option is useful - when editing files on an MS-DOS compatible filesystem, e.g., messydos - or crossdos. When running the Win32 GUI version under Win32s, this - option is always on by default. +'shortname' 'sn' Removed. {Nvim} *'showbreak'* *'sbr'* *E595* 'showbreak' 'sbr' string (default "") @@ -7126,7 +7058,6 @@ A jump table for the options with a short description can be found at |Q_op|. 'term' string (default is $TERM, if that fails: in the GUI: "builtin_gui" on Amiga: "amiga" - on BeOS: "beos-ansi" on Mac: "mac-ansi" on MS-DOS: "pcterm" on Unix: "ansi" @@ -7390,8 +7321,7 @@ A jump table for the options with a short description can be found at |Q_op|. *'toolbar'* *'tb'* 'toolbar' 'tb' string (default "icons,tooltips") global - {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and - |+GUI_Photon|} + {only for |+GUI_GTK|, |+GUI_Athena|, and |+GUI_Motif|} The contents of this option controls various toolbar settings. The possible values are: icons Toolbar buttons are shown with icons. @@ -7603,13 +7533,6 @@ A jump table for the options with a short description can be found at |Q_op|. Note that this causes the whole buffer to be stored in memory. Set this option to a lower value if you run out of memory. - {Nvim} *'unnamedclip'* *ucp'* -'unnamedclip' 'ucp' boolean (default off) - global - Use the unnamed register to access the clipboard(when available). - This option has the same effect of setting 'clipboard' to - 'unnamed/unnamedplus' in Vim. - *'updatecount'* *'uc'* 'updatecount' 'uc' number (default: 200) global @@ -7675,8 +7598,7 @@ A jump table for the options with a short description can be found at |Q_op|. "$VIM/vimfiles/view", for Unix: "~/.vim/view", for Macintosh: "$VIM:vimfiles:view" - for VMS: "sys$login:vimfiles/view" - for RiscOS: "Choices:vimfiles/view") + for VMS: "sys$login:vimfiles/view") global {not in Vi} {not available when compiled without the |+mksession| @@ -8070,7 +7992,7 @@ A jump table for the options with a short description can be found at |Q_op|. 'winaltkeys' 'wak' string (default "menu") global {not in Vi} - {only used in Win32, Motif, GTK and Photon GUI} + {only used in Win32, Motif, and GTK} Some GUI versions allow the access to menu entries by using the ALT key in combination with a character that appears underlined in the menu. This conflicts with the use of the ALT key for mappings and diff --git a/runtime/doc/os_mac.txt b/runtime/doc/os_mac.txt index 9ed23b4ae1..67790f1dea 100644 --- a/runtime/doc/os_mac.txt +++ b/runtime/doc/os_mac.txt @@ -54,7 +54,7 @@ algorithm is used: You can use the |$VIM| and |$VIMRUNTIME| variable. > - :so $VIMRUNTIME:syntax:syntax.vim + :so $VIMRUNTIME/syntax/syntax.vim ============================================================================== 2. .vimrc and .vim files *mac-vimfile* diff --git a/runtime/doc/print.txt b/runtime/doc/print.txt index 5fcaa6f624..0ffc661c95 100644 --- a/runtime/doc/print.txt +++ b/runtime/doc/print.txt @@ -96,8 +96,7 @@ If the option is empty, then vim will use the system default printer for Windows: cp1252, Macintosh: mac-roman, VMS: dec-mcs, - HPUX: hp-roman8, - EBCDIC: ebcdic-uk) + HPUX: hp-roman8) global Sets the character encoding used when printing. This option tells VIM which print character encoding file from the "print" directory in 'runtimepath' to @@ -121,10 +120,9 @@ other than latin1 will require VIM to be compiled with the |+iconv| feature. If no conversion is possible then printing will fail. Any characters that cannot be converted will be replaced with upside down question marks. -Four print character encoding files are provided to support default Mac, VMS, -HPUX, and EBCDIC character encodings and are used by default on these -platforms. Code page 1252 print character encoding is used by default on -the Windows platform. +Three print character encoding files are provided to support default Mac, VMS, +and HPUX character encodings and are used by default on these platforms. Code +page 1252 print character encoding is used by default on the Windows platform. *pexpr-option* 'printexpr' 'pexpr' String (default: see below) diff --git a/runtime/doc/quickref.txt b/runtime/doc/quickref.txt index a332b6fcc9..d320e6cd24 100644 --- a/runtime/doc/quickref.txt +++ b/runtime/doc/quickref.txt @@ -653,7 +653,6 @@ Short explanation of each option: *option-list* 'confirm' 'cf' ask what to do about unsaved/read-only files 'copyindent' 'ci' make 'autoindent' use existing indent structure 'cpoptions' 'cpo' flags for Vi-compatible behavior -'cryptmethod' 'cm' type of encryption to use for file writing 'cscopepathcomp' 'cspc' how many components of the path to show 'cscopeprg' 'csprg' command to execute cscope 'cscopequickfix' 'csqf' use quickfix window for cscope results @@ -756,7 +755,6 @@ Short explanation of each option: *option-list* 'iskeyword' 'isk' characters included in keywords 'isprint' 'isp' printable characters 'joinspaces' 'js' two spaces after a period with a join command -'key' encryption key 'keymap' 'kmp' name of a keyboard mapping 'keymodel' 'km' enable starting/stopping selection with keys 'keywordprg' 'kp' program to use for the "K" command @@ -804,7 +802,6 @@ Short explanation of each option: *option-list* 'omnifunc' 'ofu' function for filetype-specific completion 'opendevice' 'odev' allow reading/writing devices on MS-Windows 'operatorfunc' 'opfunc' function to be called for |g@| operator -'osfiletype' 'oft' no longer supported 'paragraphs' 'para' nroff macros that separate paragraphs 'paste' allow pasting text 'pastetoggle' 'pt' key code that causes 'paste' to toggle @@ -859,7 +856,6 @@ Short explanation of each option: *option-list* 'shiftround' 'sr' round indent to multiple of shiftwidth 'shiftwidth' 'sw' number of spaces to use for (auto)indent step 'shortmess' 'shm' list of flags, reduce length of messages -'shortname' 'sn' non-MS-DOS: Filenames assumed to be 8.3 chars 'showbreak' 'sbr' string to use at the start of wrapped lines 'showcmd' 'sc' show (partial) command in status line 'showfulltag' 'sft' show full tag pattern when completing tag diff --git a/runtime/doc/recover.txt b/runtime/doc/recover.txt index 75318b00e6..570340cf0c 100644 --- a/runtime/doc/recover.txt +++ b/runtime/doc/recover.txt @@ -33,20 +33,13 @@ with the extension ".swp". - On Unix, a '.' is prepended to swap file names in the same directory as the edited file. This avoids that the swap file shows up in a directory listing. -- On MS-DOS machines and when the 'shortname' option is on, any '.' in the - original file name is replaced with '_'. - If this file already exists (e.g., when you are recovering from a crash) a warning is given and another extension is used, ".swo", ".swn", etc. - An existing file will never be overwritten. - The swap file is deleted as soon as Vim stops editing the file. -Technical: The replacement of '.' with '_' is done to avoid problems with - MS-DOS compatible filesystems (e.g., crossdos, multidos). If Vim - is able to detect that the file is on an MS-DOS-like filesystem, a - flag is set that has the same effect as the 'shortname' option. - This flag is reset when you start editing another file. *E326* - If the ".swp" file name already exists, the last character is +Technical: If the ".swp" file name already exists, the last character is decremented until there is no file with that name or ".saa" is reached. In the last case, no swap file is created. @@ -196,42 +189,4 @@ will continue to get warning messages that the ".swp" file already exists. {Vi: recovers in another way and sends mail if there is something to recover} -ENCRYPTION AND THE SWAP FILE *:recover-crypt* - -When the text file is encrypted the swap file is encrypted as well. This -makes recovery a bit more complicated. When recovering from a swap file and -encryption has been used, you will be asked to enter one or two crypt keys. - -If the text file does not exist you will only be asked to enter the crypt key -for the swap file. - -If the text file does exist, it may be encrypted in a different way than the -swap file. You will be asked for the crypt key twice: - - Need encryption key for "/tmp/tt" ~ - Enter encryption key: ****** ~ - "/tmp/tt" [crypted] 23200L, 522129C ~ - Using swap file "/tmp/.tt.swp" ~ - Original file "/tmp/tt" ~ - Swap file is encrypted: "/tmp/.tt.swp" ~ - If you entered a new crypt key but did not write the text file, ~ - enter the new crypt key. ~ - If you wrote the text file after changing the crypt key press enter ~ - to use the same key for text file and swap file ~ - Enter encryption key: ~ - -You can be in one of these two situations: - -1. The encryption key was not changed, or after changing the key the text file - was written. You will be prompted for the crypt key twice. The second - time you can simply press Enter. That means the same key is used for the - text file and the swap file. -2. You entered a new encryption key, but did not save the text file. Vim will - then use the new key for the swap file, and the text file will still be - encrypted with the old key. At the second prompt enter the new key. - -Note that after recovery the key of the swap file will be used for the text -file. Thus if you write the text file, you need to use that new key. - - vim:tw=78:ts=8:ft=help:norl: diff --git a/runtime/doc/remote_plugin.txt b/runtime/doc/remote_plugin.txt index ca7e763d1b..e5d1efcc96 100644 --- a/runtime/doc/remote_plugin.txt +++ b/runtime/doc/remote_plugin.txt @@ -14,12 +14,12 @@ Nvim support for remote plugins *remote-plugin* ============================================================================== 1. Introduction *remote-plugin-intro* -A big Nvim goal is to allow extensibility in arbitrary programming languages -without requiring direct support from the editor. This is achieved with -remote plugins, coprocesses that have a direct communication channel(via +Extensibility is a primary goal of Nvim. Any programming language may be used +to extend nvim without changes to nvim itself. This is achieved with remote +plugins, coprocesses that have a direct communication channel (via |msgpack-rpc|) with the Nvim process. -Even though these plugins are running in separate processes, they can call, be +Even though these plugins are running in separate processes they can call, be called, and receive events just as if the code was being executed in the main process. @@ -27,24 +27,24 @@ process. 2. Plugin hosts *remote-plugin-hosts* While plugins can be implemented as arbitrary programs that communicate -directly with Nvim API and are called via |rpcrequest()| and |rpcnotify()|, -that is not the best approach available. Instead, developers should first -check if a plugin host implementation is available for their favorite -programming language. +directly with the high-level Nvim API and are called via |rpcrequest()| and +|rpcnotify()|, that is not the best approach available. Instead, developers +should first check if a plugin host implementation is available for their +chosen programming language. Plugin hosts are programs that provide a high level environment for plugins, -and also take care of most boilerplate involved in defining commands, autocmds -and functions that are implemented over msgpack-rpc connections. They are -loaded the first time one of its registered plugins are required, keeping -Nvim startup as fast a possible despite the number of installed plugins/hosts. +taking care of most boilerplate involved in defining commands, autocmds, and +functions that are implemented over |msgpack-rpc| connections. Hosts are +loaded only when one of their registered plugins require it, keeping Nvim's +startup as fast as possible if many plugins/hosts are installed. ============================================================================== 3. Example *remote-plugin-example* The best way to learn about remote plugins is with an example, so let's see -how a very useless python plugin looks like. This plugin exports a command, a -function and an autocmd. The plugin is called 'Limit', and all it does is -limit the number of requests made to it. Here's the plugin source code: +what a python plugin looks like. This plugin exports a command, a function and +an autocmd. The plugin is called 'Limit', and all it does is limit the number +of requests made to it. Here's the plugin source code: > import neovim @@ -53,7 +53,7 @@ limit the number of requests made to it. Here's the plugin source code: def __init__(self, vim): self.vim = vim self.calls = 0 - + @neovim.command('Cmd', range='', nargs='*', sync=True) def command_handler(self, args, range): self._increment_calls() @@ -61,76 +61,75 @@ limit the number of requests made to it. Here's the plugin source code: 'Command: Called %d times, args: %s, range: %s' % (self.calls, args, range)) - + @neovim.autocmd('BufEnter', pattern='*.py', eval='expand("<afile>")', sync=True) def autocmd_handler(self, filename): self._increment_calls() self.vim.current.line = ( 'Autocmd: Called %s times, file: %s' % (self.calls, filename)) - + @neovim.function('Func') def function_handler(self, args): self._increment_calls() self.vim.current.line = ( 'Function: Called %d times, args: %s' % (self.calls, args)) - + def _increment_calls(self): if self.calls == 5: raise Exception('Too many calls!') self.calls += 1 < -As can be seen, the plugin is implemented using pure python idioms(classes, -methods and decorators), the translation between these language-specific -idioms to vimscript occurs while the plugin manifest is being generated(see +As can be seen, the plugin is implemented using pure python idioms (classes, +methods, and decorators), the translation between these language-specific +idioms to vimscript occurs while the plugin manifest is being generated (see below). Notice that the exported command and autocmd are defined with the "sync" flag, which affects how Nvim calls the plugin: with "sync" the |rpcrequest()| function is used, which will block Nvim until the handler function returns a value. Without the "sync" flag, the call is made using a fire and forget -approach with |rpcnotify()|(return values or exceptions raised in the handler -function are ignored) +approach with |rpcnotify()| (return values or exceptions raised in the handler +function are ignored). To test the above plugin, it must be saved in "rplugin/python" in a -'runtimepath' directory(~/.nvim/rplugin/python/limit.py for example). -Then, the remote plugin manifest must be generated with -`:UpdateRemotePlugins`. +'runtimepath' directory (~/.nvim/rplugin/python/limit.py for example). Then, +the remote plugin manifest must be generated with `:UpdateRemotePlugins`. ============================================================================== -4. remote plugin manifest *remote-plugin-manifest* +4. Remote plugin manifest *remote-plugin-manifest* -Just installing remote plugins to "rplugin/{host}" isn't enough to -load them at startup. The `:UpdateRemotePlugins` command must be executed -every time a remote plugin is installed, updated, or deleted. +Just installing remote plugins to "rplugin/{host}" isn't enough for them to be +automatically loaded when required. The `:UpdateRemotePlugins` command must be +executed every time a remote plugin is installed, updated, or deleted. `:UpdateRemotePlugins` will generate the remote plugin manifest, a special vimscript file containing declarations for all vimscript entities (commands/autocommands/functions) defined by all remote plugins, with each entity associated with the host and plugin path. The manifest can be seen as a -generated extension to the user's vimrc(it even has the vimrc filename +generated extension to the user's vimrc (it even has the vimrc filename prepended). The manifest declarations are nothing but calls to the remote#host#RegisterPlugin function, which will take care of bootstrapping the host as soon as the -declared command, autocommand or function is used for the first time. +declared command, autocommand, or function is used for the first time. -The manifest generation step is necessary to keep editor startup fast in -situations where a user has remote plugins with different hosts. For -example, imagine a user that has three plugins, for python, java and .NET -hosts respectively, if we were to load all three plugins at startup, then -three language runtimes would also be spawned which could take seconds! +The manifest generation step is necessary to keep Nvim's startup fast in +situations where a user has remote plugins with different hosts. For example, +say a user has three plugins, for python, java and .NET hosts respectively. If +we were to load all three plugins at startup, then three language runtimes +would also be spawned which could take seconds! With the manifest, each host will only be loaded when required. Continuing -with the example, imagine the java plugin is a semantic completion engine for -java files, if it defines an BufEnter *.java autocommand then the java host -will only be spawned when java source files are loaded. - -If the explicit call to `:UpdateRemotePlugins` seems incovenient, try -to see it like this: Its a way to give IDE-like capabilities to nvim while -still keeping it a fast/lightweight editor for general use. It can also be -seen as an analogous to the |:helptags| facility. +with the example, say the java plugin is a semantic completion engine for java +source files. If it defines the autocommand "BufEnter *.java", then the java +host will only be spawned when files ending with ".java" are loaded. + +If the explicit call to `:UpdateRemotePlugins` seems incovenient, try to see +it like this: It's a way to give IDE-like capabilities to nvim while still +keeping it fast and lightweight for general use. It can also be seen as +analogous to the |:helptags| facility. ============================================================================== vim:tw=78:ts=8:noet:ft=help:norl: diff --git a/runtime/doc/spell.txt b/runtime/doc/spell.txt index 3ffd8932e1..91322def5b 100644 --- a/runtime/doc/spell.txt +++ b/runtime/doc/spell.txt @@ -336,8 +336,6 @@ If 'encoding' is "latin1" Vim will look for: This assumes none of them are found (Polish doesn't make sense when leaving out the non-ASCII characters). -Spelling for EBCDIC is currently not supported. - A spell file might not be available in the current 'encoding'. See |spell-mkspell| about how to create a spell file. Converting a spell file with "iconv" will NOT work! diff --git a/runtime/doc/starting.txt b/runtime/doc/starting.txt index d002a3a4ab..bceaea0d83 100644 --- a/runtime/doc/starting.txt +++ b/runtime/doc/starting.txt @@ -482,14 +482,6 @@ a slash. Thus "-R" means recovery and "-/R" readonly. ":rv" or ":wv" are used. See also |viminfo-file|. {not in Vi} - *-x* --x Use encryption to read/write files. Will prompt for a key, - which is then stored in the 'key' option. All writes will - then use this key to encrypt the text. The '-x' argument is - not needed when reading a file, because there is a check if - the file that is being read has been encrypted, and Vim asks - for a key automatically. |encryption| - *-X* -X Do not try connecting to the X server to get the current window title and copy/paste using the X clipboard. This @@ -775,7 +767,7 @@ accordingly. Vim proceeds in this order: a. If vim was started as |evim| or |eview| or with the |-y| argument, the script $VIMRUNTIME/evim.vim will be loaded. *system-vimrc* - b. For Unix, MS-DOS, MS-Windows, VMS, Macintosh, RISC-OS and Amiga + b. For Unix, MS-DOS, MS-Windows, VMS, Macintosh, and Amiga, the system vimrc file is read for initializations. The path of this file is shown with the ":version" command. Mostly it's "$VIM/vimrc". Note that this file is ALWAYS read in 'compatible' mode, since the @@ -1143,10 +1135,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', 'key', 'lines', 'modified', 'scroll', 'term', 'ttyfast' 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', 'term', 'ttyfast' 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. 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/todo.txt b/runtime/doc/todo.txt index 1cab028bc2..40f30ff077 100644 --- a/runtime/doc/todo.txt +++ b/runtime/doc/todo.txt @@ -232,8 +232,6 @@ Go through more coverity reports. Patch to add ":undorecover", get as much text out of the undo file as possible. (Christian Brabandt, 2014 Mar 12) -Include Haiku port? (Adrien Destugues, Siarzhuk Zharski, 2013 Oct 24) - Updated spec ftplugin. (Matěj Cepl, 2013 Oct 16) Some quickfix messages appear twice. (Gary Johnson, 2014 Feb 16) @@ -2249,7 +2247,7 @@ GUI: Need better separation of Vim core and GUI code. 8 When fontset support is enabled, setting 'guifont' to a single font doesn't work. -8 Menu priority for sub-menus for: Amiga, BeOS. +8 Menu priority for sub-menus for: Amiga. 8 When translating menus ignore the part after the Tab, the shortcut. So that the same menu item with a different shortcut (e.g., for the Mac) are still translated. @@ -3373,8 +3371,6 @@ Built-in script language: Patch by Ilya Sher, 2004 Mar 4. Return a list instead. char2hex() convert char string to hex string. - crypt() encrypt string - decrypt() decrypt string base64enc() base 64 encoding base64dec() base 64 decoding attributes() return file protection flags "drwxrwxrwx" @@ -3745,7 +3741,7 @@ Win32 GUI: GUI: -8 Make inputdialog() work for Photon, Amiga. +8 Make inputdialog() work for Amiga. - <C--> cannot be mapped. Should be possible to recognize this as a normal "-" with the Ctrl modifier. 7 Implement ":popup" for other systems than Windows. @@ -3824,8 +3820,6 @@ GUI: Autocommands: -9 Rework the code from FEAT_OSFILETYPE for autocmd-osfiletypes to use - 'filetype'. Only for when the current buffer is known. - Put autocommand event names in a hashtable for faster lookup? 8 When the SwapExists event is triggered, provide information about the swap file, e.g., whether the process is running, file was modified, etc. @@ -4819,8 +4813,7 @@ Digraphs: Writing files: - In vim_rename(), should lock "from" file when deleting "to" file for - systems other than Amiga. Avoids problems with unexpected longname to - shortname conversion. + systems other than Amiga. 8 write mch_isdevice() for Amiga, Mac, VMS, etc. 8 When appending to a file, Vim should also make a backup and a 'patchmode' file. diff --git a/runtime/doc/undo.txt b/runtime/doc/undo.txt index 46469b3533..fba981d4a3 100644 --- a/runtime/doc/undo.txt +++ b/runtime/doc/undo.txt @@ -256,9 +256,6 @@ message about that when opening a file. Undo files are normally saved in the same directory as the file. This can be changed with the 'undodir' option. -When the file is encrypted, the text in the undo file is also crypted. The -same key and method is used. |encryption| - You can also save and restore undo histories by using ":wundo" and ":rundo" respectively: *:wundo* *:rundo* @@ -321,13 +318,6 @@ Reading an existing undo file may fail for several reasons: the undo file cannot be used, it would corrupt the text. This also happens when 'encoding' differs from when the undo file was written. *E825* The undo file does not contain valid contents and cannot be used. -*E826* The undo file is encrypted but decryption failed. -*E827* The undo file is encrypted but this version of Vim does not support - encryption. Open the file with another Vim. -*E832* The undo file is encrypted but 'key' is not set, the text file is not - encrypted. This would happen if the text file was written by Vim - encrypted at first, and later overwritten by not encrypted text. - You probably want to delete this undo file. "Not reading undo file, owner differs" The undo file is owned by someone else than the owner of the text file. For safety the undo file is not used. diff --git a/runtime/doc/usr_05.txt b/runtime/doc/usr_05.txt index ac377675ee..a409d7e3ce 100644 --- a/runtime/doc/usr_05.txt +++ b/runtime/doc/usr_05.txt @@ -317,7 +317,6 @@ Then copy the file to your plugin directory: Amiga s:vimfiles/plugin Macintosh $VIM:vimfiles:plugin Mac OS X ~/.vim/plugin/ - RISC-OS Choices:vimfiles.plugin Example for Unix (assuming you didn't have a plugin directory yet): > diff --git a/runtime/doc/usr_11.txt b/runtime/doc/usr_11.txt index 9935ded48c..ec404f3301 100644 --- a/runtime/doc/usr_11.txt +++ b/runtime/doc/usr_11.txt @@ -283,8 +283,6 @@ machines. Therefore, don't rely on Vim always warning you. If you really don't want to see this message, you can add the 'A' flag to the 'shortmess' option. But it's very unusual that you need this. -For remarks about encryption and the swap file, see |:recover-crypt|. - ============================================================================== *11.4* Further reading diff --git a/runtime/doc/usr_23.txt b/runtime/doc/usr_23.txt index 63cbc612de..0578a63ae5 100644 --- a/runtime/doc/usr_23.txt +++ b/runtime/doc/usr_23.txt @@ -6,15 +6,13 @@ This chapter is about editing files that are not ordinary files. With Vim you -can edit files that are compressed or encrypted. Some files need to be -accessed over the internet. With some restrictions, binary files can be -edited as well. +can edit files that are compressed. Some files need to be accessed over the +internet. With some restrictions, binary files can be edited as well. |23.1| DOS, Mac and Unix files |23.2| Files on the internet -|23.3| Encryption -|23.4| Binary files -|23.5| Compressed files +|23.3| Binary files +|23.4| Compressed files Next chapter: |usr_24.txt| Inserting quickly Previous chapter: |usr_22.txt| Finding the file to edit @@ -154,89 +152,7 @@ http://. For more information, also about passwords, see |netrw|. ============================================================================== -*23.3* Encryption - -Some information you prefer to keep to yourself. For example, when writing -a test on a computer that students also use. You don't want clever students -to figure out a way to read the questions before the exam starts. Vim can -encrypt the file for you, which gives you some protection. - To start editing a new file with encryption, use the "-x" argument to start -Vim. Example: > - - vim -x exam.txt - -Vim prompts you for a key used for encrypting and decrypting the file: - - Enter encryption key: ~ - -Carefully type the secret key now. You cannot see the characters you type, -they will be replaced by stars. To avoid the situation that a typing mistake -will cause trouble, Vim asks you to enter the key again: - - Enter same key again: ~ - -You can now edit this file normally and put in all your secrets. When you -finish editing the file and tell Vim to exit, the file is encrypted and -written. - When you edit the file with Vim, it will ask you to enter the same key -again. You don't need to use the "-x" argument. You can also use the normal -":edit" command. Vim adds a magic string to the file by which it recognizes -that the file was encrypted. - If you try to view this file using another program, all you get is garbage. -Also, if you edit the file with Vim and enter the wrong key, you get garbage. -Vim does not have a mechanism to check if the key is the right one (this makes -it much harder to break the key). - - -SWITCHING ENCRYPTION ON AND OFF - -To disable the encryption of a file, set the 'key' option to an empty string: -> - :set key= - -The next time you write the file this will be done without encryption. - Setting the 'key' option to enable encryption is not a good idea, because -the password appears in the clear. Anyone shoulder-surfing can read your -password. - To avoid this problem, the ":X" command was created. It asks you for an -encryption key, just like the "-x" argument did: > - - :X - Enter encryption key: ****** - Enter same key again: ****** - - -LIMITS ON ENCRYPTION - -The encryption algorithm used by Vim is weak. It is good enough to keep out -the casual prowler, but not good enough to keep out a cryptology expert with -lots of time on his hands. Also you should be aware that the swap file is not -encrypted; so while you are editing, people with superuser privileges can read -the unencrypted text from this file. - One way to avoid letting people read your swap file is to avoid using one. -If the -n argument is supplied on the command line, no swap file is used -(instead, Vim puts everything in memory). For example, to edit the encrypted -file "file.txt" without a swap file use the following command: > - - vim -x -n file.txt - -When already editing a file, the swapfile can be disabled with: > - - :setlocal noswapfile - -Since there is no swapfile, recovery will be impossible. Save the file a bit -more often to avoid the risk of losing your changes. - -While the file is in memory, it is in plain text. Anyone with privilege can -look in the editor's memory and discover the contents of the file. - If you use a viminfo file, be aware that the contents of text registers are -written out in the clear as well. - If you really want to secure the contents of a file, edit it only on a -portable computer not connected to a network, use good encryption tools, and -keep the computer locked up in a big safe when not in use. - -============================================================================== -*23.4* Binary files +*23.3* Binary files You can edit binary files with Vim. Vim wasn't really made for this, thus there are a few restrictions. But you can read a file, change a character and @@ -322,7 +238,7 @@ the right are ignored. See the manual page of xxd for more information. ============================================================================== -*23.5* Compressed files +*23.4* Compressed files This is easy: You can edit a compressed file just like any other file. The "gzip" plugin takes care of decompressing the file when you edit it. And diff --git a/runtime/doc/usr_toc.txt b/runtime/doc/usr_toc.txt index d98a999aa4..9e4bf5ca93 100644 --- a/runtime/doc/usr_toc.txt +++ b/runtime/doc/usr_toc.txt @@ -198,9 +198,8 @@ Subjects that can be read independently. |usr_23.txt| Editing other files |23.1| DOS, Mac and Unix files |23.2| Files on the internet - |23.3| Encryption - |23.4| Binary files - |23.5| Compressed files + |23.3| Binary files + |23.4| Compressed files |usr_24.txt| Inserting quickly |24.1| Making corrections diff --git a/runtime/doc/various.txt b/runtime/doc/various.txt index c3c4ed7cfe..6f639e0fe9 100644 --- a/runtime/doc/various.txt +++ b/runtime/doc/various.txt @@ -319,7 +319,6 @@ N *+cmdline_hist* command line history |cmdline-history| N *+cmdline_info* |'showcmd'| and |'ruler'| N *+comments* |'comments'| support B *+conceal* "conceal" support, see |conceal| |:syn-conceal| etc. -N *+cryptv* encryption support |encryption| B *+cscope* |cscope| support m *+cursorbind* |'cursorbind'| support m *+cursorshape* |termcap-cursor-shape| support diff --git a/runtime/doc/vi_diff.txt b/runtime/doc/vi_diff.txt index aa90dc94b0..a3abd2cfd3 100644 --- a/runtime/doc/vi_diff.txt +++ b/runtime/doc/vi_diff.txt @@ -137,10 +137,7 @@ Support for different systems. - In protected mode on Windows 3.1 and MS-DOS (DPMI driver required). - Windows 95 and Windows NT, with support for long file names. - VMS - - BeOS - Macintosh - - Risc OS - - IBM OS/390 Note that on some systems features need to be disabled to reduce resource usage, esp. on MS-DOS. For some outdated systems you need to use an older Vim version. @@ -162,7 +159,7 @@ Graphical User Interface (GUI). |gui| define your own menus. Better support for CTRL/SHIFT/ALT keys in combination with special keys and mouse. Supported for various platforms, such as X11 (with Motif and Athena interfaces), GTK, Win32 - (Windows 95 and later), BeOS, Amiga and Macintosh. + (Windows 95 and later), Amiga and Macintosh. Multiple windows and buffers. |windows.txt| Vim can split the screen into several windows, each editing a @@ -751,10 +748,6 @@ switched off by setting the 'updatecount' option to 0 or starting Vim with the "-n" option. Use the 'directory' option for placing the .swp file somewhere else. -Vim is able to work correctly on filesystems with 8.3 file names, also when -using messydos or crossdos filesystems on the Amiga, or any 8.3 mounted -filesystem under Unix. See |'shortname'|. - Error messages are shown at least one second (Vi overwrites error messages). If Vim gives the |hit-enter| prompt, you can hit any key. Characters other @@ -939,8 +932,6 @@ Only Vim is able to accept options in between and after the file names. -W {name} Vim: Append to script file {name}. --x Vi, Vim: Ask for encryption key. See |encryption|. - -X Vim: Don't connect to the X server. -y Vim: Start in easy mode, like |evim|. |