diff options
author | Bram Moolenaar <Bram@vim.org> | 2005-04-15 21:00:38 +0000 |
---|---|---|
committer | Bram Moolenaar <Bram@vim.org> | 2005-04-15 21:00:38 +0000 |
commit | 402d2fea7025356c7abcb891017a1b7ddf99cbbf (patch) | |
tree | 83c5973b6316912331d4a4c070996d7888097e5c /runtime/doc | |
parent | 4499d2ee58db42e4ec59bb2c2dbb5eeca2313e8b (diff) |
updated for version 7.0066
Diffstat (limited to 'runtime/doc')
65 files changed, 1400 insertions, 675 deletions
diff --git a/runtime/doc/Makefile b/runtime/doc/Makefile index 1c2959de5f..3aef1ca97c 100644 --- a/runtime/doc/Makefile +++ b/runtime/doc/Makefile @@ -257,6 +257,11 @@ HTMLS = \ workshop.html CONVERTED = \ + vim-fr.UTF-8.1 \ + evim-fr.UTF-8.1 \ + vimdiff-fr.UTF-8.1 \ + vimtutor-fr.UTF-8.1 \ + xxd-fr.UTF-8.1 \ vim-it.UTF-8.1 \ evim-it.UTF-8.1 \ vimdiff-it.UTF-8.1 \ @@ -380,32 +385,47 @@ os_risc.txt: os_win32.txt: touch os_win32.txt +vim-fr.UTF-8.1: vim-fr.1 + iconv -f latin1 -t utf-8 $< >$@ + +evim-fr.UTF-8.1: evim-fr.1 + iconv -f latin1 -t utf-8 $< >$@ + +vimdiff-fr.UTF-8.1: vimdiff-fr.1 + iconv -f latin1 -t utf-8 $< >$@ + +vimtutor-fr.UTF-8.1: vimtutor-fr.1 + iconv -f latin1 -t utf-8 $< >$@ + +xxd-fr.UTF-8.1: xxd-fr.1 + iconv -f latin1 -t utf-8 $< >$@ + vim-it.UTF-8.1: vim-it.1 - iconv -f latin1 -t utf-8 $> >$@ + iconv -f latin1 -t utf-8 $< >$@ evim-it.UTF-8.1: evim-it.1 - iconv -f latin1 -t utf-8 $> >$@ + iconv -f latin1 -t utf-8 $< >$@ vimdiff-it.UTF-8.1: vimdiff-it.1 - iconv -f latin1 -t utf-8 $> >$@ + iconv -f latin1 -t utf-8 $< >$@ vimtutor-it.UTF-8.1: vimtutor-it.1 - iconv -f latin1 -t utf-8 $> >$@ + iconv -f latin1 -t utf-8 $< >$@ xxd-it.UTF-8.1: xxd-it.1 - iconv -f latin1 -t utf-8 $> >$@ + iconv -f latin1 -t utf-8 $< >$@ vim-ru.UTF-8.1: vim-ru.1 - iconv -f KOI8-R -t utf-8 $> >$@ + iconv -f KOI8-R -t utf-8 $< >$@ evim-ru.UTF-8.1: evim-ru.1 - iconv -f KOI8-R -t utf-8 $> >$@ + iconv -f KOI8-R -t utf-8 $< >$@ vimdiff-ru.UTF-8.1: vimdiff-ru.1 - iconv -f KOI8-R -t utf-8 $> >$@ + iconv -f KOI8-R -t utf-8 $< >$@ vimtutor-ru.UTF-8.1: vimtutor-ru.1 - iconv -f KOI8-R -t utf-8 $> >$@ + iconv -f KOI8-R -t utf-8 $< >$@ xxd-ru.UTF-8.1: xxd-ru.1 - iconv -f KOI8-R -t utf-8 $> >$@ + iconv -f KOI8-R -t utf-8 $< >$@ diff --git a/runtime/doc/change.txt b/runtime/doc/change.txt index 7a58cd88cc..c507ccd4ab 100644 --- a/runtime/doc/change.txt +++ b/runtime/doc/change.txt @@ -1,4 +1,4 @@ -*change.txt* For Vim version 7.0aa. Last change: 2005 Mar 16 +*change.txt* For Vim version 7.0aa. Last change: 2005 Apr 03 VIM REFERENCE MANUAL by Bram Moolenaar @@ -915,6 +915,8 @@ inside of strings can change! Also see 'softtabstop' option. > current line). This always works |linewise|, thus this command can be used to put a yanked block as new lines. + The cursor is left on the first non-blank in the last + new line. The register can also be '=' followed by an optional expression. The expression continues until the end of the command. You need to escape the '|' and '"' @@ -964,9 +966,9 @@ When using a put command like |p| or |P| in Visual mode, Vim will try to replace the selected text with the contents of the register. Whether this works well depends on the type of selection and the type of the text in the register. With blockwise selection it also depends on the size of the block -and whether the corners are on an existing character. (implementation detail: +and whether the corners are on an existing character. (Implementation detail: it actually works by first putting the register after the selection and then -deleting the selection). +deleting the selection.) *blockwise-register* If you use a blockwise Visual mode command to get the text into the register, @@ -1417,7 +1419,7 @@ If the 'comments' option includes "/*", "*" and/or "*/", then Vim has some built in stuff to treat these types of comments a bit more cleverly. Opening a new line before or after "/*" or "*/" (with 'r' or 'o' present in 'formatoptions') gives the correct start of the line automatically. The same -happens with formatting and auto-wrapping. Opening a line after a line +happens with formatting and auto-wrapping. Opening a line after a line starting with "/*" or "*" and containing "*/", will cause no comment leader to be inserted, and the indent of the new line is taken from the line containing the start of the comment. diff --git a/runtime/doc/debugger.txt b/runtime/doc/debugger.txt index 4e4f1c06a7..566b83a843 100644 --- a/runtime/doc/debugger.txt +++ b/runtime/doc/debugger.txt @@ -1,4 +1,4 @@ -*debugger.txt* For Vim version 7.0aa. Last change: 2005 Mar 07 +*debugger.txt* For Vim version 7.0aa. Last change: 2005 Mar 29 VIM REFERENCE MANUAL by Gordon Prieur @@ -27,19 +27,19 @@ Environment (IDE): These features were added specifically for use in the Motif version of gvim. However, the |alt-input| and |debug-highlight| were written to be usable in -both vim and gvim. Some of the other features could be used in the non-GUI -vim with slight modifications. However, I did not do this nor did I test the +both vim and gvim. Some of the other features could be used in the non-GUI +vim with slight modifications. However, I did not do this nor did I test the reliability of building for vim or non Motif GUI versions. 1.1 Alternate Command Input *alt-input* For Vim to work with a debugger there must be at least an input connection -with a debugger or external tool. In many cases there will also be an output +with a debugger or external tool. In many cases there will also be an output connection but this isn't absolutely necessary. The purpose of the input connection is to let the external debugger send -commands to Vim. The commands sent by the debugger should give the debugger +commands to Vim. The commands sent by the debugger should give the debugger enough control to display the current debug environment and state. The current implementation is based on the X Toolkit dispatch loop and the @@ -49,15 +49,15 @@ XtAddInput() function call. 1.2 Debug Signs *debug-signs* Many debuggers mark specific lines by placing a small sign or color highlight -on the line. The |:sign| command lets the debugger set this graphic mark. Some +on the line. The |:sign| command lets the debugger set this graphic mark. Some examples where this feature would be used would be a debugger showing an arrow -representing the Program Counter (PC) of the program being debugged. Another -example would be a small stop sign for a line with a breakpoint. These visible +representing the Program Counter (PC) of the program being debugged. Another +example would be a small stop sign for a line with a breakpoint. These visible highlights let the user keep track of certain parts of the state of the debugger. -This feature can be used with more than debuggers, too. An IPE can use a sign -to highlight build errors, searched text, or other things. The sign feature +This feature can be used with more than debuggers, too. An IPE can use a sign +to highlight build errors, searched text, or other things. The sign feature can also work together with the |debug-highlight| to ensure the mark is highly visible. @@ -66,17 +66,17 @@ Debug signs are defined and placed using the |:sign| command. 1.3 Debug Source Highlight *debug-highlight* -This feature allows a line to have a predominant highlight. The highlight is -intended to make a specific line stand out. The highlight could be made to +This feature allows a line to have a predominant highlight. The highlight is +intended to make a specific line stand out. The highlight could be made to work for both vim and gvim, whereas the debug sign is, in most cases, limited -to gvim. The one exception to this is Sun Microsystem's dtterm. The dtterm +to gvim. The one exception to this is Sun Microsystem's dtterm. The dtterm from Sun has a "sign gutter" for showing signs. 1.4 Message Footer *gui-footer* -The message footer can be used to display messages from a debugger or IPE. It -can also be used to display menu and toolbar tips. The footer area is at the +The message footer can be used to display messages from a debugger or IPE. It +can also be used to display menu and toolbar tips. The footer area is at the bottom of the GUI window, below the line used to display colon commands. The display of the footer is controlled by the 'guioptions' letter 'F'. @@ -85,7 +85,7 @@ The display of the footer is controlled by the 'guioptions' letter 'F'. 1.5 Balloon Evaluation *balloon-eval* This feature allows a debugger, or other external tool, to display dynamic -information based on where the mouse is pointing. The purpose of this feature +information based on where the mouse is pointing. The purpose of this feature was to allow Sun's Visual WorkShop debugger to display expression evaluations. However, the feature was implemented in as general a manner as possible and could be used for displaying other information as well. @@ -111,7 +111,7 @@ 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 +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. @@ -123,7 +123,7 @@ The following compile time preprocessor variables control the features: Message Footer FEAT_FOOTER Balloon Evaluation FEAT_BEVAL -The first integration with a full IPE/IDE was with Sun Visual WorkShop. To +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: diff --git a/runtime/doc/develop.txt b/runtime/doc/develop.txt index 6e4f4e35a9..bc8b0e8c09 100644 --- a/runtime/doc/develop.txt +++ b/runtime/doc/develop.txt @@ -1,4 +1,4 @@ -*develop.txt* For Vim version 7.0aa. Last change: 2004 Jan 17 +*develop.txt* For Vim version 7.0aa. Last change: 2005 Mar 29 VIM REFERENCE MANUAL by Bram Moolenaar @@ -366,7 +366,33 @@ window View on a buffer. There can be several windows in Vim, fit in the shell. -To be continued... +Spell checking *develop-spell* + +When spell checking was going to be added to Vim a survey was done over the +available spell checking libraries and programs. Unfortunately, the result +was that none of them provided sufficient capabilities to be used as the spell +checking engine in Vim, for various reasons: + +- Missing support for multi-byte encodings. At least UTF-8 must be supported, + so that more than one language can be used in the same file. +- For the programs and libraries: Using them as-is would require installing + them separately from Vim. That's not impossible, but a drawback. +- Performance: A few tests showed that it's possible to check spelling on the + fly (while redrawing), just like syntax highlighting. But the mechanisms + used by other code are much slower. Myspell uses a simplistic hashtable, + for example. +- For a program like aspell a communication mechanism would have to be setup. + That's complicated to do in a portable way (Unix-only would be relatively + simple, but that's not good enough). And performance will become a problem + (lots of process switching involved). +- Missing support for words with non-word characters, such as "Etten-Leur" and + "et al.", would require marking the pieces of them OK, lowering the + reliability. +- Missing support for regions or dialects. Makes it difficult to accept + all English words and highlight non-Canadian words differently. +- Missing support for rare words. Many words are correct but hardly ever used + and could be a misspelled often-used word. + ============================================================================== 4. Assumptions *design-assumptions* diff --git a/runtime/doc/editing.txt b/runtime/doc/editing.txt index 3fb4e54dee..8ae870a5a6 100644 --- a/runtime/doc/editing.txt +++ b/runtime/doc/editing.txt @@ -1,4 +1,4 @@ -*editing.txt* For Vim version 7.0aa. Last change: 2005 Feb 14 +*editing.txt* For Vim version 7.0aa. Last change: 2005 Apr 04 VIM REFERENCE MANUAL by Bram Moolenaar @@ -46,7 +46,7 @@ However, the alternate file name is not changed when |:keepalt| is used. name. {not in Vi} All file names are remembered in the buffer list. When you enter a file name, -for editing (e.g., with ":e filename") or writing (e.g., with ":w file name"), +for editing (e.g., with ":e filename") or writing (e.g., with ":w filename"), the file name is added to the list. You can use the buffer list to remember which files you edited and to quickly switch from one file to another (e.g., to copy text) with the |CTRL-^| command. First type the number of the file @@ -57,7 +57,7 @@ CTRL-G or *CTRL-G* *:f* *:fi* *:file* :f[ile] Prints the current file name (as typed), the cursor position (unless the 'ruler' option is set), and the file status (readonly, modified, read errors, - new file). See the 'shortmess' option about how tho + new file). See the 'shortmess' option about how to make this message shorter. {Vi does not include column number} @@ -910,8 +910,8 @@ if the system allows it (the directory must be writable). *write-fail* If the writing of the new file fails, you have to be careful not to lose your changes AND the original file. If there is no backup file and writing -the new file failed, you have already lost the original file! DON'T EXIT VIM -UNTIL YOU WRITE OUT THE FILE! If a backup was made, it is put back in place +the new file failed, you have already lost the original file! DON'T EXIT VIM +UNTIL YOU WRITE OUT THE FILE! If a backup was made, it is put back in place of the original file (if possible). If you exit Vim, and lose the changes you made, the original file will mostly still be there. If putting back the original file fails, there will be an error message telling you that you @@ -1391,6 +1391,11 @@ It is also possible that you modified the file yourself, from another edit session or with another command (e.g., a filter command). Then you will know which version of the file you want to keep. +There is one situation where you get the message while there is nothing wrong: +On a Win32 system on the day daylight saving time starts. There is something +in the Win32 libraries that confuses Vim about the hour time difference. The +problem goes away the next day. + ============================================================================== 11. File Searching *file-searching* @@ -1401,7 +1406,7 @@ options. There are three different types of searching: 1) Downward search: Downward search uses the wildcards '*', '**' and possibly others - supported by your operating system. '*' and '**' are handled inside Vim, so + supported by your operating system. '*' and '**' are handled inside Vim, so they work on all operating systems. The usage of '*' is quite simple: It matches 0 or more characters. @@ -1435,10 +1440,10 @@ options. There are three different types of searching: 2) Upward search: Here you can give a directory and then search the directory tree upward for - a file. You could give stop-directories to limit the upward search. The + a file. You could give stop-directories to limit the upward search. The stop-directories are appended to the path (for the 'path' option) or to - the filename (for the 'tags' option) with a ';'. If you want several - stop-directories separate them with ';'. If you want no stop-directory + the filename (for the 'tags' option) with a ';'. If you want several + stop-directories separate them with ';'. If you want no stop-directory ("search upward till the root directory) just use ';'. > /usr/include/sys;/usr < will search in: > @@ -1457,7 +1462,7 @@ options. There are three different types of searching: /u/user_x/work/include /u/user_x/include -3) Combined up/downward search +3) Combined up/downward search: If Vim's current path is /u/user_x/work/release and you do > set path=**;/u/user_x < and then search for a file with |gf| the file is searched in: > @@ -1465,10 +1470,10 @@ options. There are three different types of searching: /u/user_x/work/** /u/user_x/** < - BE CAREFUL! This might consume a lot of time, as the search of + BE CAREFUL! This might consume a lot of time, as the search of '/u/user_x/**' includes '/u/user_x/work/**' and '/u/user_x/work/release/**'. So '/u/user_x/work/release/**' is searched - three and '/u/user_x/work/**' is searched two times. + three times and '/u/user_x/work/**' is searched twice. In the above example you might want to set path to: > :set path=**,/u/user_x/** diff --git a/runtime/doc/eval.txt b/runtime/doc/eval.txt index dc260b9f08..a0e446fcbe 100644 --- a/runtime/doc/eval.txt +++ b/runtime/doc/eval.txt @@ -1,4 +1,4 @@ -*eval.txt* For Vim version 7.0aa. Last change: 2005 Mar 26 +*eval.txt* For Vim version 7.0aa. Last change: 2005 Apr 04 VIM REFERENCE MANUAL by Bram Moolenaar @@ -1412,7 +1412,7 @@ v:warningmsg Last given warning message. It's allowed to set this variable. See |function-list| for a list grouped by what the function is used for. -(Use CTRL-] on the function name to jump to the full explanation) +(Use CTRL-] on the function name to jump to the full explanation.) USAGE RESULT DESCRIPTION ~ @@ -1620,7 +1620,7 @@ writefile({list}, {fname} [, {binary}]) add({list}, {expr}) *add()* Append the item {expr} to List {list}. Returns the resulting - List. Examples: > + List. Examples: > :let alist = add([1, 2, 3], item) :call add(mylist, "woodstock") < Note that when {expr} is a List it is appended as a single @@ -1809,6 +1809,7 @@ char2nr({expr}) *char2nr()* < The current 'encoding' is used. Example for "utf-8": > char2nr("á") returns 225 char2nr("á"[0]) returns 195 +< nr2char() does the opposite. cindent({lnum}) *cindent()* Get the amount of indent for line {lnum} according the C @@ -2551,10 +2552,10 @@ getqflist() *getqflist()* getreg([{regname}]) *getreg()* The result is a String, which is the contents of register - {regname}. Example: > + {regname}. Example: > :let cliptext = getreg('*') < getreg('=') returns the last evaluated value of the expression - register. (For use in maps). + register. (For use in maps.) If {regname} is not specified, |v:register| is used. @@ -2677,7 +2678,7 @@ histadd({history}, {item}) *histadd()* < This function is not available in the |sandbox|. histdel({history} [, {item}]) *histdel()* - Clear {history}, ie. delete all its entries. See |hist-names| + Clear {history}, i.e. delete all its entries. See |hist-names| for the possible values of {history}. If the parameter {item} is given as String, this is seen @@ -2753,7 +2754,7 @@ hlID({name}) The result is a Number, which is the ID of the highlight group hostname() *hostname()* The result is a String, which is the name of the machine on - which Vim is currently running. Machine names greater than + which Vim is currently running. Machine names greater than 256 characters long are truncated. iconv({expr}, {from}, {to}) *iconv()* @@ -2873,7 +2874,7 @@ insert({list}, {item} [, {idx}]) *insert()* {idx}. If {idx} is zero it goes before the first item, just like omitting {idx}. A negative {idx} is also possible, see |list-index|. -1 inserts just before the last item. - Returns the resulting List. Examples: > + Returns the resulting List. Examples: > :let mylist = insert([2, 3, 5], 1) :call insert(mylist, 4, -1) :call insert(mylist, 6, len(mylist)) @@ -3131,7 +3132,7 @@ match({expr}, {pat}[, {start}[, {count}]]) *match()* If {start} is given, the search starts from byte index {start} in a String or item {start} in a List. The result, however, is still the index counted from the - first character/item. Example: > + first character/item. Example: > :echo match("testing", "ing", 2) < result is again "4". > :echo match("testing", "ing", 4) @@ -3405,7 +3406,7 @@ repeat({expr}, {count}) *repeat()* :let seperator = repeat('-', 80) < When {count} is zero or negative the result is empty. When {expr} is a List the result is {expr} concatenated - {count} times. Example: > + {count} times. Example: > :let longlist = repeat(['a', 'b'], 3) < Results in ['a', 'b', 'a', 'b', 'a', 'b']. @@ -3544,7 +3545,7 @@ server2client( {clientid}, {string}) *server2client()* {only available when compiled with the |+clientserver| feature} Note: This id has to be stored before the next command can be - received. Ie. before returning from the received command and + received. I.e. before returning from the received command and before calling any commands that waits for input. See also |clien |