vim/doc at 474b981e40ce211dc3498186ba78ec8461efb9c1 - vim

aniani/vim

mirror of https://github.com/vim/vim.git synced 2025-10-22 08:34:29 -04:00

Files

Girish Palya 474b981e40 patch 9.1.1835: completion: not possible to style popup borders globally

Problem:  not possible to style popup borders globally
Solution: Add the 'pumborder' option (Girish Palya)

This commit introduces a new global option, 'pumborder' ('pb'), that
allows users to define borders and optional decorations for the
completion popup menu.

```
Defines a border and optional decorations for the popup menu in
completion.  The value is a comma-separated list of keywords.

Border styles (at most one):
"single"singleuse thin box-drawing characters
"double"doubleuse double-line box-drawing characters
"round"rounduse rounded corners
"ascii"asciiuse ASCII characters (-, |, +)
"custom:XXXXXXXX"
    use eight characters given after "custom:",
    in order: top, right, bottom, left,
    topleft, topright, botright, botleft

Additional flags:
"margin"marginadds one-cell spacing inside the left and right border
"shadow"shadowdraws a shadow at the right and bottom edges

Highlight groups:
|hl-PmenuBorder|hl-PmenuBorderused for the border characters
|hl-PmenuShadow|hl-PmenuShadowused for the shadow

Examples: >
  :set pumborder=single
  :set pumborder=double,margin,shadow
  :set pumborder=custom:─│─│┌┐┘└,shadow

Border styles using box-drawing characters ("single", "double",
"round") are only available when |'encoding'| is "utf-8" and
|'ambiwidth'| is "single".  "margin" requires a border style.
See also: |ins-completion-menu|.
```

fixes: https://github.com/vim/vim/pull/18441#issuecomment-3360188458
closes: #18486
closes: #17091

Signed-off-by: Girish Palya <girishji@gmail.com>
Signed-off-by: Christian Brabandt <cb@256bit.org>

2025-10-07 20:51:02 +00:00

arabic.txt

patch 9.1.0000: Vim 9.1 release

2024-01-02 16:51:11 +01:00

autocmd.txt

patch 9.1.1757: The colorresp plugin causes additional redraws

2025-09-14 04:38:33 -04:00

builtin.txt

runtime(doc): make :h virtcol() more accurate

2025-10-01 18:30:38 +00:00

change.txt

runtime(doc): Use correct option-name tags

2025-08-06 12:44:36 +02:00

channel.txt

runtime(doc): minor updates.

2024-07-17 20:04:22 +02:00

cmdline.txt

runtime(doc): fix inconsistent indent in cmdline.txt

2025-09-24 18:01:29 +00:00

debug.txt

runtime(doc): remove dead links

2025-08-10 10:28:16 +02:00

debugger.txt

patch 9.1.0000: Vim 9.1 release

2024-01-02 16:51:11 +01:00

develop.txt

runtime(doc): Tweak documentation style

2025-09-29 19:57:27 +00:00

diff.txt

Fix some typos in documentation, C code and test files

2025-09-15 19:42:30 +00:00

digraph.txt

patch 9.1.1640: Unicode has deprecated some code-points

2025-08-16 18:33:05 +02:00

doctags.c

patch 9.0.0110: help tag generation picks up words in code examples

2022-07-30 12:03:16 +01:00

doctags.vim

patch 8.2.0140: CI does not test building doc tags

2020-01-21 22:13:42 +01:00

editing.txt

runtime(doc): mention 'findfunc' at :h :find

2025-09-09 15:31:30 -04:00

eval.txt

runtime(doc): make order of verbs match order of operators

2025-09-25 20:07:24 +00:00

evim-fr.1

…

evim-fr.UTF-8.1

…

evim-it.1

translation(it): update Italian manpages

2024-08-17 15:14:43 +02:00

evim-it.UTF-8.1

translation(it): update Italian manpages

2024-08-17 15:14:43 +02:00

evim-ja.UTF-8.1

…

evim-pl.1

…

evim-pl.UTF-8.1

…

evim-ru.1

translation(ru): update man pages

2024-08-20 19:57:00 +02:00

evim-ru.UTF-8.1

translation(ru): update man pages

2024-08-20 19:57:00 +02:00

evim-tr.1

patch 8.2.0859: no Turkish translation of the manual

2020-05-31 14:25:22 +02:00

evim-tr.UTF-8.1

patch 8.2.0859: no Turkish translation of the manual

2020-05-31 14:25:22 +02:00

evim.1

patch 9.1.0676: style issues with man pages

2024-08-15 21:39:33 +02:00

evim.man

patch 9.1.0676: style issues with man pages

2024-08-15 21:39:33 +02:00

farsi.txt

patch 9.1.0000: Vim 9.1 release

2024-01-02 16:51:11 +01:00

filetype.txt

runtime(doc): Improve documentation of the ..= assignment operator

2025-09-24 18:00:16 +00:00

fold.txt

patch 9.1.1819: Cannot configure the inner foldlevel indicator

2025-10-03 08:24:31 +00:00

ft_ada.txt

runtime(doc): Use correct option-name tags

2025-08-06 12:44:36 +02:00

ft_context.txt

patch 9.1.0000: Vim 9.1 release

2024-01-02 16:51:11 +01:00

ft_hare.txt

runtime(doc): Tweak documentation style more in options and ft_hare

2025-09-14 11:05:46 -04:00

ft_mp.txt

patch 9.1.0000: Vim 9.1 release

2024-01-02 16:51:11 +01:00

ft_ps1.txt

Update runtime files

2021-06-27 15:18:56 +02:00

ft_raku.txt

Update runtime files.

2022-02-26 12:25:45 +00:00

ft_rust.txt

runtime(rust): improve loading time

2025-07-20 10:38:16 +02:00

ft_sql.txt

runtime(doc): remove dead links

2025-08-10 10:28:16 +02:00

gui_w32.txt

patch 9.1.1834: MS-Windows: not possible to highlight the title bar

2025-10-07 19:41:59 +00:00

gui_x11.txt

patch 9.1.1784: Wayland code can be improved

2025-09-22 19:09:52 +00:00

gui.txt

runtime(doc): remove dead links

2025-08-10 10:28:16 +02:00

hangulin.txt

patch 9.1.0000: Vim 9.1 release

2024-01-02 16:51:11 +01:00

hebrew.txt

patch 9.1.0000: Vim 9.1 release

2024-01-02 16:51:11 +01:00

help.txt

patch 9.1.1485: missing Wayland clipboard support

2025-06-27 21:10:35 +02:00

help.txt.info

…

helphelp.txt

runtime(doc): Tweak documentation style

2025-09-29 19:57:27 +00:00

howto.txt

runtime(doc): Use correct option-name tags

2025-08-06 12:44:36 +02:00

if_cscop.txt

runtime(doc): remove dead links

2025-08-10 10:28:16 +02:00

if_lua.txt

patch 9.1.0000: Vim 9.1 release

2024-01-02 16:51:11 +01:00

if_mzsch.txt

patch 9.1.0000: Vim 9.1 release

2024-01-02 16:51:11 +01:00

if_ole.txt

runtime(doc): fix inconsistent indent (#14089 )

2024-02-25 08:42:52 +01:00

if_perl.txt

runtime(doc): update if_perl after v9.1.1822)

2025-10-04 11:02:00 +00:00

if_pyth.txt

patch 9.1.1239: if_python: no tuple data type support

2025-03-26 18:46:21 +01:00

if_ruby.txt

patch 9.1.0000: Vim 9.1 release

2024-01-02 16:51:11 +01:00

if_sniff.txt

patch 9.1.0000: Vim 9.1 release

2024-01-02 16:51:11 +01:00

if_tcl.txt

runtime(doc): Add [range] spec to :help :tcl and :help :tclfile

2025-08-29 18:19:04 +02:00

indent.txt

patch 9.1.0934: hard to view an existing buffer in the preview window

2024-12-16 21:22:09 +01:00

index.txt

runtime(doc): tweak option name notation further

2025-08-06 17:00:58 +02:00

insert.txt

runtime(doc): fix doc style from commit 5c9b71d63c

2025-09-16 14:41:01 +02:00

intro.txt

runtime(doc): fix typo in :h credits section

2025-10-05 18:36:39 +00:00

Make_all.mak

patch 9.1.1485: missing Wayland clipboard support

2025-06-27 21:10:35 +02:00

Make_mvc.mak

patch 9.1.1675: MS-Windows: Makefiles can be refactored

2025-08-23 17:00:17 +02:00

Makefile

runtime(doc): non-portable sed regex in Makefile for pi_netrw.txt rule

2025-03-28 19:11:11 +01:00

makehtml.awk

Update runtime files

2020-05-26 21:20:45 +02:00

maketags.awk

CI: Check help tags for errors (duplicates, missing, etc) (#13865 )

2024-01-14 19:24:05 +01:00

map.txt

runtime(doc): Use correct option-name tags

2025-08-06 12:44:36 +02:00

mbyte.txt

runtime(doc): Add explanation for Vim's IME

2025-10-04 10:23:38 +00:00

message.txt

runtime(doc): Use correct option-name tags

2025-08-06 12:44:36 +02:00

mlang.txt

patch 9.1.0559: translation of vim scripts can be improved

2024-07-11 21:14:15 +02:00

motion.txt

runtime(doc): add back bars for the '' mark

2025-08-06 13:41:05 +02:00

netbeans.txt

runtime(doc): remove dead links

2025-08-10 10:28:16 +02:00

options.txt

patch 9.1.1835: completion: not possible to style popup borders globally

2025-10-07 20:51:02 +00:00

os_390.txt

runtime(doc): Use correct option-name tags

2025-08-06 12:44:36 +02:00

os_amiga.txt

runtime(doc): remove dead links

2025-08-10 10:28:16 +02:00

os_beos.txt

patch 9.1.0000: Vim 9.1 release

2024-01-02 16:51:11 +01:00

os_dos.txt

runtime(doc): tweak option name notation further

2025-08-06 17:00:58 +02:00

os_haiku.txt

patch 9.1.1743: Haiku: no full-screen support

2025-09-08 15:42:25 -04:00

os_mac.txt

runtime(doc): remove dead links

2025-08-10 10:28:16 +02:00

os_mint.txt

patch 9.1.0000: Vim 9.1 release

2024-01-02 16:51:11 +01:00

os_msdos.txt

patch 9.1.0000: Vim 9.1 release

2024-01-02 16:51:11 +01:00

os_os2.txt

patch 9.1.0000: Vim 9.1 release

2024-01-02 16:51:11 +01:00

os_qnx.txt

runtime(doc): Use correct option-name tags

2025-08-06 12:44:36 +02:00

os_risc.txt

patch 9.1.0000: Vim 9.1 release

2024-01-02 16:51:11 +01:00

os_unix.txt

patch 9.1.0000: Vim 9.1 release

2024-01-02 16:51:11 +01:00

os_vms.txt

runtime(doc): Tweak documentation style

2025-08-06 11:43:45 +02:00

os_win32.txt

runtime(doc): Tweak documentation style

2025-10-01 20:07:33 +00:00

pattern.txt

patch 9.1.1826: Patch v9.1.1230 causes confusion about Ctrl-C behaviour

2025-10-05 13:04:52 +00:00

pi_getscript.txt

runtime(doc): remove dead links

2025-08-10 10:28:16 +02:00

pi_gzip.txt

runtime(doc): mention bzip3 in gzip plugin documentation

2025-03-05 20:22:24 +01:00

pi_logipat.txt

Update runtime files.

2020-01-14 19:29:13 +01:00

pi_netrw.txt

runtime(doc): remove dead links

2025-08-10 10:28:16 +02:00

pi_paren.txt

runtime(matchparen): Add matchparen_disable_cursor_hl config option

2024-11-04 20:46:54 +01:00

pi_spec.txt

patch 9.1.0000: Vim 9.1 release

2024-01-02 16:51:11 +01:00

pi_tar.txt

runtime(doc): remove dead links

2025-08-10 10:28:16 +02:00

pi_tutor.txt

runtime(doc): remove outdated Contribution section in pi_tutor

2025-05-19 19:34:44 +02:00

pi_vimball.txt

runtime(doc): Use correct option-name tags

2025-08-06 12:44:36 +02:00

pi_zip.txt

runtime(zip): add *.pkpass to list of zip extensions

2025-10-06 17:56:20 +00:00

popup.txt

patch 9.1.1795: Vim9: popup_show() may return void

2025-09-26 16:30:52 +00:00

print.txt

runtime(doc): remove dead links

2025-08-10 10:28:16 +02:00

quickfix.txt

runtime(doc): Improve documentation of the ..= assignment operator

2025-09-24 18:00:16 +00:00

quickref.txt

patch 9.1.1672: completion: cannot add timeouts for 'cpt' sources

2025-08-23 16:20:03 +02:00

quotes.txt

patch 9.1.0000: Vim 9.1 release

2024-01-02 16:51:11 +01:00

recover.txt

patch 9.1.0000: Vim 9.1 release

2024-01-02 16:51:11 +01:00

remote.txt

runtime(doc): Fix missing heading in remote.txt

2025-08-22 12:44:31 -04:00

repeat.txt

runtime(doc): Tweak documentation

2025-07-15 20:06:49 +02:00

rileft.txt

patch 9.1.0000: Vim 9.1 release

2024-01-02 16:51:11 +01:00

russian.txt

patch 9.1.0000: Vim 9.1 release

2024-01-02 16:51:11 +01:00

scroll.txt

runtime(doc): Remove wrong help tag CTRL-SHIFT-CR

2024-07-06 11:29:38 +02:00

sign.txt

runtime(doc): Use the optional tail command-name spec at :help :sign

2025-10-05 13:11:26 +00:00

spell.txt

runtime(doc): Remove dead link from todo.txt

2025-09-02 21:03:16 +02:00

sponsor.txt

runtime(doc): Fix 2 minor issues after 32d6bd6df

2025-08-10 14:49:05 +02:00

starting.txt

runtime(doc): Use correct option-name tags

2025-08-06 12:44:36 +02:00

syntax.txt

patch 9.1.1835: completion: not possible to style popup borders globally

2025-10-07 20:51:02 +00:00

tabpage.txt

runtime(doc): Use correct option-name tags

2025-08-06 12:44:36 +02:00