Mercurial > vim

comparison runtime/doc/options.txt @ 16439:9d20e26dc13c v8.1.1224

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
patch 8.1.1224: MS-Windows: cannot specify font weight commit https://github.com/vim/vim/commit/f720d0a77e393990b2171a77210565bdc82064f2 Author: Bram Moolenaar <Bram@vim.org> Date: Sun Apr 28 14:02:47 2019 +0200 patch 8.1.1224: MS-Windows: cannot specify font weight Problem: MS-Windows: cannot specify font weight. Solution: Add the "W" option to 'guifont'. (closes https://github.com/vim/vim/issues/4309) Move GUI font explanation out of options.txt.
author Bram Moolenaar <Bram@vim.org>
date Sun, 28 Apr 2019 14:15:06 +0200
parents 8c3a1bd270bb
children 32a543152dc0
comparison
equal deleted inserted replaced
16438:6b1f87294f4f 16439:9d20e26dc13c
3725 'guifont' 'gfn' string (default "") 3725 'guifont' 'gfn' string (default "")
3726 global 3726 global
3727 {not in Vi} 3727 {not in Vi}
3728 {only available when compiled with GUI enabled} 3728 {only available when compiled with GUI enabled}
3729 This is a list of fonts which will be used for the GUI version of Vim. 3729 This is a list of fonts which will be used for the GUI version of Vim.
3730 In its simplest form the value is just one font name. When 3730 In its simplest form the value is just one font name.
3731 the font cannot be found you will get an error message. To try other 3731 See |gui-font| for the details.
3732 font names a list can be specified, font names separated with commas.
3733 The first valid font is used.
3734
3735 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3736 not empty, then 'guifont' is not used.
3737
3738 Note: As to the GTK GUIs, no error is given against any invalid names,
3739 and the first element of the list is always picked up and made use of.
3740 This is because, instead of identifying a given name with a font, the
3741 GTK GUIs use it to construct a pattern and try to look up a font which
3742 best matches the pattern among available fonts, and this way, the
3743 matching never fails. An invalid name doesn't matter because a number
3744 of font properties other than name will do to get the matching done.
3745
3746 Spaces after a comma are ignored. To include a comma in a font name
3747 precede it with a backslash. Setting an option requires an extra
3748 backslash before a space and a backslash. See also
3749 |option-backslash|. For example: >
3750 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
3751 < will make Vim try to use the font "Screen15" first, and if it fails it
3752 will try to use "7x13" and then "font,with,commas" instead.
3753
3754 If none of the fonts can be loaded, Vim will keep the current setting.
3755 If an empty font list is given, Vim will try using other resource
3756 settings (for X, it will use the Vim.font resource), and finally it
3757 will try some builtin default which should always be there ("7x13" in
3758 the case of X). The font names given should be "normal" fonts. Vim
3759 will try to find the related bold and italic fonts.
3760
3761 For Win32, GTK, Motif, Mac OS and Photon: >
3762 :set guifont=*
3763 < will bring up a font requester, where you can pick the font you want.
3764
3765 The font name depends on the GUI used. See |setting-guifont| for a
3766 way to set 'guifont' for various systems.
3767
3768 For the GTK+ 2 and 3 GUIs, the font name looks like this: >
3769 :set guifont=Andale\ Mono\ 11
3770 < That's all. XLFDs are not used. For Chinese this is reported to work
3771 well: >
3772 if has("gui_gtk2")
3773 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12
3774 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12
3775 endif
3776 <
3777 (Replace gui_gtk2 with gui_gtk3 for the GTK+ 3 GUI)
3778
3779 For Mac OSX you can use something like this: >
3780 :set guifont=Monaco:h10
3781 < Also see 'macatsui', it can help fix display problems.
3782 *E236*
3783 Note that the fonts must be mono-spaced (all characters have the same
3784 width). An exception is GTK: all fonts are accepted, but mono-spaced
3785 fonts look best.
3786
3787 To preview a font on X11, you might be able to use the "xfontsel"
3788 program. The "xlsfonts" program gives a list of all available fonts.
3789
3790 For the Win32 GUI *E244* *E245*
3791 - takes these options in the font name:
3792 hXX - height is XX (points, can be floating-point)
3793 wXX - width is XX (points, can be floating-point)
3794 b - bold
3795 i - italic
3796 u - underline
3797 s - strikeout
3798 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
3799 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3800 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3801 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
3802 Normally you would use "cDEFAULT".
3803 qXX - quality XX. Valid quality names are: PROOF, DRAFT,
3804 ANTIALIASED, NONANTIALIASED, CLEARTYPE, DEFAULT.
3805 Normally you would use "qDEFAULT".
3806 Some quality values are not supported in legacy OSs.
3807
3808 Use a ':' to separate the options.
3809 - A '_' can be used in the place of a space, so you don't need to use
3810 backslashes to escape the spaces.
3811 - Examples: >
3812 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3813 :set guifont=Andale_Mono:h7.5:w4.5
3814 < See also |font-sizes|.
3815 3732
3816 *'guifontset'* *'gfs'* 3733 *'guifontset'* *'gfs'*
3817 *E250* *E252* *E234* *E597* *E598* 3734 *E250* *E252* *E234* *E597* *E598*
3818 'guifontset' 'gfs' string (default "") 3735 'guifontset' 'gfs' string (default "")
3819 global 3736 global
3822 with the |+xfontset| feature} 3739 with the |+xfontset| feature}
3823 {not available in the GTK+ GUI} 3740 {not available in the GTK+ GUI}
3824 When not empty, specifies two (or more) fonts to be used. The first 3741 When not empty, specifies two (or more) fonts to be used. The first
3825 one for normal English, the second one for your special language. See 3742 one for normal English, the second one for your special language. See
3826 |xfontset|. 3743 |xfontset|.
3827 Setting this option also means that all font names will be handled as 3744
3828 a fontset name. Also the ones used for the "font" argument of the
3829 |:highlight| command.
3830 The fonts must match with the current locale. If fonts for the
3831 character sets that the current locale uses are not included, setting
3832 'guifontset' will fail.
3833 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3834 the comma-separated names are alternative names, one of which will be
3835 used. In 'guifontset' the whole string is one fontset name,
3836 including the commas. It is not possible to specify alternative
3837 fontset names.
3838 This example works on many X11 systems: >
3839 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3840 <
3841 *'guifontwide'* *'gfw'* *E231* *E533* *E534* 3745 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3842 'guifontwide' 'gfw' string (default "") 3746 'guifontwide' 'gfw' string (default "")
3843 global 3747 global
3844 {not in Vi} 3748 {not in Vi}
3845 {only available when compiled with GUI enabled} 3749 {only available when compiled with GUI enabled}
3846 When not empty, specifies a comma-separated list of fonts to be used 3750 When not empty, specifies a comma-separated list of fonts to be used
3847 for double-width characters. The first font that can be loaded is 3751 for double-width characters. The first font that can be loaded is
3848 used. 3752 used. See |gui-fontwide|.
3849 Note: The size of these fonts must be exactly twice as wide as the one
3850 specified with 'guifont' and the same height.
3851
3852 All GUI versions but GTK+:
3853
3854 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3855 'guifontset' is empty or invalid.
3856 When 'guifont' is set and a valid font is found in it and
3857 'guifontwide' is empty Vim will attempt to find a matching
3858 double-width font and set 'guifontwide' to it.
3859
3860 GTK+ GUI only: *guifontwide_gtk*
3861
3862 If set and valid, 'guifontwide' is always used for double width
3863 characters, even if 'encoding' is not set to "utf-8".
3864 Vim does not attempt to find an appropriate value for 'guifontwide'
3865 automatically. If 'guifontwide' is empty Pango/Xft will choose the
3866 font for characters not available in 'guifont'. Thus you do not need
3867 to set 'guifontwide' at all unless you want to override the choice
3868 made by Pango/Xft.
3869
3870 Windows +multibyte only: *guifontwide_win_mbyte*
3871
3872 If set and valid, 'guifontwide' is used for IME instead of 'guifont'.
3873 3753
3874 *'guiheadroom'* *'ghr'* 3754 *'guiheadroom'* *'ghr'*
3875 'guiheadroom' 'ghr' number (default 50) 3755 'guiheadroom' 'ghr' number (default 50)
3876 global 3756 global
3877 {not in Vi} {only for GTK and X11 GUI} 3757 {not in Vi} {only for GTK and X11 GUI}