Diff to HTML by rtfpessoa

Files changed (6) hide show
  1. runtime/doc/eval.txt +2 -7
  2. runtime/doc/helphelp.txt +56 -1
  3. runtime/doc/options.txt +28 -27
  4. runtime/doc/pi_netrw.txt +2 -2
  5. runtime/doc/quickref.txt +2 -2
  6. runtime/doc/version9.txt +3 -2
runtime/doc/eval.txt CHANGED
@@ -1,4 +1,4 @@
1
- *eval.txt* For Vim version 9.1. Last change: 2024 Oct 28
2
 
3
 
4
  VIM REFERENCE MANUAL by Bram Moolenaar
@@ -2027,10 +2027,6 @@ v:cmdbang Set like v:cmdarg for a file read/write command. When a "!"
2027
  can only be used in autocommands. For user commands |<bang>|
2028
  can be used.
2029
 
2030
- *v:cmdcomplete* *cmdcomplete-variable*
2031
- v:cmdcomplete When evaluating 'findexpr': if 'findexpr' is used for cmdline
2032
- completion the value is |v:true|, otherwise it is |v:false|.
2033
-
2034
  *v:collate* *collate-variable*
2035
  v:collate The current locale setting for collation order of the runtime
2036
  environment. This allows Vim scripts to be aware of the
@@ -2228,8 +2224,7 @@ v:fcs_choice What should happen after a |FileChangedShell| event was
2228
 
2229
  *v:fname* *fname-variable*
2230
  v:fname When evaluating 'includeexpr': the file name that was
2231
- detected. When evaluating 'findexpr': the argument passed to
2232
- the |:find| command. Empty otherwise.
2233
 
2234
  *v:fname_in* *fname_in-variable*
2235
  v:fname_in The name of the input file. Valid while evaluating:
1
+ *eval.txt* For Vim version 9.1. Last change: 2024 Nov 02
2
 
3
 
4
  VIM REFERENCE MANUAL by Bram Moolenaar
2027
  can only be used in autocommands. For user commands |<bang>|
2028
  can be used.
2029
 
 
 
 
 
2030
  *v:collate* *collate-variable*
2031
  v:collate The current locale setting for collation order of the runtime
2032
  environment. This allows Vim scripts to be aware of the
2224
 
2225
  *v:fname* *fname-variable*
2226
  v:fname When evaluating 'includeexpr': the file name that was
2227
+ detected. Empty otherwise.
 
2228
 
2229
  *v:fname_in* *fname_in-variable*
2230
  v:fname_in The name of the input file. Valid while evaluating:
runtime/doc/helphelp.txt CHANGED
@@ -1,4 +1,4 @@
1
- *helphelp.txt* For Vim version 9.1. Last change: 2024 Apr 10
2
 
3
 
4
  VIM REFERENCE MANUAL by Bram Moolenaar
@@ -246,6 +246,61 @@ command: >
246
  To rebuild the help tags in the runtime directory
247
  (requires write permission there): >
248
  :helptags $VIMRUNTIME/doc
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
249
 
250
  ==============================================================================
251
  2. Translated help files *help-translated*
1
+ *helphelp.txt* For Vim version 9.1. Last change: 2024 Nov 02
2
 
3
 
4
  VIM REFERENCE MANUAL by Bram Moolenaar
246
  To rebuild the help tags in the runtime directory
247
  (requires write permission there): >
248
  :helptags $VIMRUNTIME/doc
249
+ <
250
+ *help-TOC* *help-toc-install*
251
+
252
+ If you want to access an interactive table of contents, from any position in
253
+ the file, you can use the helptoc plugin. Load the plugin with: >
254
+
255
+ packadd helptoc
256
+
257
+ Then you can use the `:HelpToc` command to open a popup menu.
258
+ The latter supports the following normal commands: >
259
+
260
+ key | effect
261
+ ----+---------------------------------------------------------
262
+ j | select next entry
263
+ k | select previous entry
264
+ J | same as j, and jump to corresponding line in main buffer
265
+ K | same as k, and jump to corresponding line in main buffer
266
+ c | select nearest entry from cursor position in main buffer
267
+ g | select first entry
268
+ G | select last entry
269
+ H | collapse one level
270
+ L | expand one level
271
+ p | print current entry on command-line
272
+
273
+ P | same as p but automatically, whenever selection changes
274
+ | press multiple times to toggle feature on/off
275
+
276
+ q | quit menu
277
+ z | redraw menu with current entry at center
278
+ + | increase width of popup menu
279
+ - | decrease width of popup menu
280
+ ? | show/hide a help window
281
+
282
+ <C-D> | scroll down half a page
283
+ <C-U> | scroll up half a page
284
+ <PageUp> | scroll down a whole page
285
+ <PageDown> | scroll up a whole page
286
+ <Home> | select first entry
287
+ <End> | select last entry
288
+
289
+ The plugin can also provide a table of contents in man pages, markdown files,
290
+ and terminal buffers. In the latter, the entries will be the past executed
291
+ shell commands. To find those, the following regex is used: >
292
+
293
+ ^\w\+@\w\+:\f\+\$\s
294
+
295
+ This is meant to match a default bash prompt. If it doesn't match your prompt,
296
+ you can change the regex with the `shell_prompt` key from the `g:helptoc`
297
+ dictionary variable: >
298
+
299
+ let g:helptoc = {'shell_prompt': 'regex matching your shell prompt'}
300
+
301
+ Tip: After inserting a pattern to look for with the `/` command, if you press
302
+ <Esc> instead of <CR>, you can then get more context for each remaining entry
303
+ by pressing `J` or `K`.
304
 
305
  ==============================================================================
306
  2. Translated help files *help-translated*
runtime/doc/options.txt CHANGED
@@ -1,4 +1,4 @@
1
- *options.txt* For Vim version 9.1. Last change: 2024 Oct 28
2
 
3
 
4
  VIM REFERENCE MANUAL by Bram Moolenaar
@@ -439,10 +439,11 @@ Note: In the future more global options can be made |global-local|. Using
439
  ":setlocal" on a global option might work differently then.
440
 
441
  *option-value-function*
442
- Some options ('completefunc', 'imactivatefunc', 'imstatusfunc', 'omnifunc',
443
- 'operatorfunc', 'quickfixtextfunc', 'tagfunc' and 'thesaurusfunc') are set to
444
- a function name or a function reference or a lambda function. When using a
445
- lambda it will be converted to the name, e.g. "<lambda>123". Examples:
 
446
  >
447
  set opfunc=MyOpFunc
448
  set opfunc=function('MyOpFunc')
@@ -3552,36 +3553,36 @@ A jump table for the options with a short description can be found at |Q_op|.
3552
  eob EndOfBuffer |hl-EndOfBuffer|
3553
  lastline NonText |hl-NonText|
3554
 
3555
- *'findexpr'* *'fexpr'* *E1514*
3556
- 'findexpr' 'fexpr' string (default "")
3557
  global or local to buffer |global-local|
3558
  {not available when compiled without the |+eval|
3559
  feature}
3560
- Expression that is evaluated to obtain the filename(s) for the |:find|
3561
  command. When this option is empty, the internal |file-searching|
3562
  mechanism is used.
3563
 
3564
- While evaluating the expression, the |v:fname| variable is set to the
3565
- argument of the |:find| command.
3566
 
3567
- The expression is evaluated only once per |:find| command invocation.
3568
- The expression can process all the directories specified in 'path'.
 
 
 
3569
 
3570
- The expression may be evaluated for command-line completion as well,
3571
- in which case the |v:cmdcomplete| variable will be set to |v:true|,
3572
- otherwise it will be set to |v:false|.
3573
 
3574
- If a match is found, the expression should return a |List| containing
3575
- one or more file names. If a match is not found, the expression
3576
  should return an empty List.
3577
 
3578
- If any errors are encountered during the expression evaluation, an
3579
  empty List is used as the return value.
3580
 
3581
- Using a function call without arguments is faster |expr-option-function|
3582
-
3583
  It is not allowed to change text or jump to another window while
3584
- evaluating 'findexpr' |textlock|.
3585
 
3586
  This option cannot be set from a |modeline| or in the |sandbox|, for
3587
  security reasons.
@@ -3589,18 +3590,18 @@ A jump table for the options with a short description can be found at |Q_op|.
3589
  Examples:
3590
  >
3591
  " Use glob()
3592
- func FindExprGlob()
3593
- let pat = v:cmdcomplete ? $'{v:fname}*' : v:fname
3594
  return glob(pat, v:false, v:true)
3595
  endfunc
3596
- set findexpr=FindExprGlob()
3597
 
3598
  " Use the 'git ls-files' output
3599
- func FindGitFiles()
3600
  let fnames = systemlist('git ls-files')
3601
- return fnames->filter('v:val =~? v:fname')
3602
  endfunc
3603
- set findexpr=FindGitFiles()
3604
  <
3605
  *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3606
  'fixendofline' 'fixeol' boolean (default on)
1
+ *options.txt* For Vim version 9.1. Last change: 2024 Nov 02
2
 
3
 
4
  VIM REFERENCE MANUAL by Bram Moolenaar
439
  ":setlocal" on a global option might work differently then.
440
 
441
  *option-value-function*
442
+ Some options ('completefunc', 'findfunc', 'imactivatefunc', 'imstatusfunc',
443
+ 'omnifunc', 'operatorfunc', 'quickfixtextfunc', 'tagfunc' and 'thesaurusfunc')
444
+ are set to a function name or a function reference or a lambda function. When
445
+ using a lambda it will be converted to the name, e.g. "<lambda>123".
446
+ Examples:
447
  >
448
  set opfunc=MyOpFunc
449
  set opfunc=function('MyOpFunc')
3553
  eob EndOfBuffer |hl-EndOfBuffer|
3554
  lastline NonText |hl-NonText|
3555
 
3556
+ *'findfunc'* *'ffu'* *E1514*
3557
+ 'findfunc' 'ffu' string (default empty)
3558
  global or local to buffer |global-local|
3559
  {not available when compiled without the |+eval|
3560
  feature}
3561
+ Function that is called to obtain the filename(s) for the |:find|
3562
  command. When this option is empty, the internal |file-searching|
3563
  mechanism is used.
3564
 
3565
+ The value can be the name of a function, a |lambda| or a |Funcref|.
3566
+ See |option-value-function| for more information.
3567
 
3568
+ The function is called with two arguments. The first argument is a
3569
+ |String| and is the |:find| command argument. The second argument is
3570
+ a |Boolean| and is set to |v:true| when the function is called to get
3571
+ a List of command-line completion matches for the |:find| command.
3572
+ The function should return a List of strings.
3573
 
3574
+ The function is called only once per |:find| command invocation.
3575
+ The function can process all the directories specified in 'path'.
 
3576
 
3577
+ If a match is found, the function should return a |List| containing
3578
+ one or more file names. If a match is not found, the function
3579
  should return an empty List.
3580
 
3581
+ If any errors are encountered during the function invocation, an
3582
  empty List is used as the return value.
3583
 
 
 
3584
  It is not allowed to change text or jump to another window while
3585
+ executing the 'findfunc' |textlock|.
3586
 
3587
  This option cannot be set from a |modeline| or in the |sandbox|, for
3588
  security reasons.
3590
  Examples:
3591
  >
3592
  " Use glob()
3593
+ func FindFuncGlob(cmdarg, cmdcomplete)
3594
+ let pat = a:cmdcomplete ? $'{a:cmdarg}*' : a:cmdarg
3595
  return glob(pat, v:false, v:true)
3596
  endfunc
3597
+ set findfunc=FindFuncGlob
3598
 
3599
  " Use the 'git ls-files' output
3600
+ func FindGitFiles(cmdarg, cmdcomplete)
3601
  let fnames = systemlist('git ls-files')
3602
+ return fnames->filter('v:val =~? a:cmdarg')
3603
  endfunc
3604
+ set findfunc=FindGitFiles
3605
  <
3606
  *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3607
  'fixendofline' 'fixeol' boolean (default on)
runtime/doc/pi_netrw.txt CHANGED
@@ -1,4 +1,4 @@
1
- *pi_netrw.txt* For Vim version 9.1. Last change: 2024 Nov 01
2
 
3
  ------------------------------------------------
4
  NETRW REFERENCE MANUAL by Charles E. Campbell
@@ -1542,7 +1542,7 @@ OPENING FILES AND LAUNCHING APPS *netrw-gx* *:Open* *:Launch* {{
1542
  Netrw determines which special handler by the following method:
1543
 
1544
  * if |g:netrw_browsex_viewer| exists, then it will be used to attempt to
1545
- view files. Examples of useful settings (place into your <.vimrc>):
1546
  If the viewer you wish to use does not support handling of a remote URL
1547
  directory, set |g:netrw_browsex_support_remote| to 0.
1548
  * otherwise:
1
+ *pi_netrw.txt* For Vim version 9.1. Last change: 2024 Nov 02
2
 
3
  ------------------------------------------------
4
  NETRW REFERENCE MANUAL by Charles E. Campbell
1542
  Netrw determines which special handler by the following method:
1543
 
1544
  * if |g:netrw_browsex_viewer| exists, then it will be used to attempt to
1545
+ view files.
1546
  If the viewer you wish to use does not support handling of a remote URL
1547
  directory, set |g:netrw_browsex_support_remote| to 0.
1548
  * otherwise:
runtime/doc/quickref.txt CHANGED
@@ -1,4 +1,4 @@
1
- *quickref.txt* For Vim version 9.1. Last change: 2024 Oct 22
2
 
3
 
4
  VIM REFERENCE MANUAL by Bram Moolenaar
@@ -707,7 +707,7 @@ Short explanation of each option: *option-list*
707
  'fileignorecase' 'fic' ignore case when using file names
708
  'filetype' 'ft' type of file, used for autocommands
709
  'fillchars' 'fcs' characters to use for displaying special items
710
- 'findexpr' 'fexpr' expression to evaluate for |:find|
711
  'fixendofline' 'fixeol' make sure last line in file has <EOL>
712
  'fkmap' 'fk' obsolete option for Farsi
713
  'foldclose' 'fcl' close a fold when the cursor leaves it
1
+ *quickref.txt* For Vim version 9.1. Last change: 2024 Nov 02
2
 
3
 
4
  VIM REFERENCE MANUAL by Bram Moolenaar
707
  'fileignorecase' 'fic' ignore case when using file names
708
  'filetype' 'ft' type of file, used for autocommands
709
  'fillchars' 'fcs' characters to use for displaying special items
710
+ 'findfunc' 'ffu' function to be called for the |:find| command
711
  'fixendofline' 'fixeol' make sure last line in file has <EOL>
712
  'fkmap' 'fk' obsolete option for Farsi
713
  'foldclose' 'fcl' close a fold when the cursor leaves it
runtime/doc/version9.txt CHANGED
@@ -1,4 +1,4 @@
1
- *version9.txt* For Vim version 9.1. Last change: 2024 Oct 27
2
 
3
 
4
  VIM REFERENCE MANUAL by Bram Moolenaar
@@ -41602,6 +41602,7 @@ Changed~
41602
  selection in the quickfix list with the "u" action.
41603
  - the putty terminal is detected using an |TermResponse| autocommand in
41604
  |defaults.vim| and Vim switches to a dark background
 
41605
 
41606
  *added-9.2*
41607
  Added ~
@@ -41651,7 +41652,7 @@ Options: ~
41651
 
41652
  'completeitemalign' Order of |complete-items| in Insert mode completion
41653
  popup
41654
- 'findexpr' Vim expression to obtain the results for a |:find|
41655
  command
41656
  'winfixbuf' Keep buffer focused in a window
41657
  'tabclose' Which tab page to focus after closing a tab page
1
+ *version9.txt* For Vim version 9.1. Last change: 2024 Nov 02
2
 
3
 
4
  VIM REFERENCE MANUAL by Bram Moolenaar
41602
  selection in the quickfix list with the "u" action.
41603
  - the putty terminal is detected using an |TermResponse| autocommand in
41604
  |defaults.vim| and Vim switches to a dark background
41605
+ - the |help-TOC| package is included to ease navigating the documentation.
41606
 
41607
  *added-9.2*
41608
  Added ~
41652
 
41653
  'completeitemalign' Order of |complete-items| in Insert mode completion
41654
  popup
41655
+ 'findfunc' Vim function to obtain the results for a |:find|
41656
  command
41657
  'winfixbuf' Keep buffer focused in a window
41658
  'tabclose' Which tab page to focus after closing a tab page