mlang.txt (8433B)
1 *mlang.txt* For Vim version 9.2. Last change: 2026 Jul 28 2 3 4 VIM REFERENCE MANUAL by Bram Moolenaar 5 6 7 Multi-language features *multilang* *multi-lang* 8 9 This is about using messages and menus in various languages. For editing 10 multibyte text see |multibyte|. 11 12 The basics are explained in the user manual: |usr_45.txt|. 13 14 1. Messages |multilang-messages| 15 2. Menus |multilang-menus| 16 3. Scripts |multilang-scripts| 17 18 Also see |help-translated| for multi-language help. 19 20 {not available when compiled without the |+multi_lang| feature} 21 22 ============================================================================== 23 1. Messages *multilang-messages* 24 25 Vim picks up the locale from the environment. In most cases this means Vim 26 will use the language that you prefer, unless it's not available. 27 28 To see a list of supported locale names on your system, look in one of these 29 directories (for Unix): 30 /usr/lib/locale ~ 31 /usr/share/locale ~ 32 Unfortunately, upper/lowercase differences matter. Also watch out for the 33 use of "-" and "_". 34 35 *:lan* *:lang* *:language* *E197* 36 :lan[guage] 37 :lan[guage] mes[sages] 38 :lan[guage] cty[pe] 39 :lan[guage] tim[e] 40 :lan[guage] col[late] 41 Print the current language (aka locale). 42 With the "messages" argument the language used for 43 messages is printed. Technical: LC_MESSAGES. 44 With the "ctype" argument the language used for 45 character encoding is printed. Technical: LC_CTYPE. 46 With the "time" argument the language used for 47 strftime() is printed. Technical: LC_TIME. 48 With the "collate" argument the language used for 49 collation order is printed. Technical: LC_COLLATE. 50 Without argument all parts of the locale are printed 51 (this is system dependent). 52 The current language can also be obtained with the 53 |v:lang|, |v:ctype|, |v:collate| and |v:lc_time| 54 variables. 55 56 :lan[guage] {name} 57 :lan[guage] mes[sages] {name} 58 :lan[guage] cty[pe] {name} 59 :lan[guage] tim[e] {name} 60 :lan[guage] col[late] {name} 61 Set the current language (aka locale) to {name}. 62 The POSIX format of {name} is: > 63 language[_territory][.encoding] 64 < The locale {name} must be a valid locale on your 65 system. Some systems accept aliases like "en" or 66 "en_US", but some only accept the full specification 67 like "en_US.ISO_8859-1". On Unix systems you can use 68 this command to see what locales are supported: > 69 :!locale -a 70 < With the "messages" argument the language used for 71 messages is set. This can be different when you want, 72 for example, English messages while editing Japanese 73 text. This sets $LC_MESSAGES. 74 With the "ctype" argument the language used for 75 character encoding is set. This affects the libraries 76 that Vim was linked with. It's unusual to set this to 77 a different value from 'encoding' or "C". This sets 78 $LC_CTYPE. 79 With the "time" argument the language used for time 80 and date messages is set. This affects strftime(). 81 This sets $LC_TIME. 82 With the "collate" argument the language used for the 83 collation order is set. This affects sorting of 84 characters. This sets $LC_COLLATE. 85 Without an argument all are set, and additionally 86 $LANG is set. 87 If available the LC_NUMERIC value will always be set 88 to "C", so that floating point numbers use '.' as the 89 decimal point. 90 This will make a difference for items that depend on 91 the language (some messages, time and date format). 92 Not fully supported on all systems 93 If this fails there will be an error message. If it 94 succeeds there is no message. Example: > 95 :language 96 Current language: C 97 :language de_DE.ISO_8859-1 98 :language mes 99 Current messages language: de_DE.ISO_8859-1 100 :lang mes en 101 < 102 103 MS-WINDOWS MESSAGE TRANSLATIONS *win32-gettext* 104 105 If you used the self-installing .exe file, message translations should work 106 already. Otherwise get the libintl.dll file if you don't have it yet: 107 108 http://sourceforge.net/projects/gettext 109 Or: 110 https://mlocati.github.io/gettext-iconv-windows/ 111 112 This also contains tools xgettext, msgformat and others. 113 114 libintl.dll should be placed in same directory as (g)vim.exe, or one of the 115 directories listed in the PATH environment value. Vim also looks for the 116 alternate names "libintl-8.dll" and "intl.dll". 117 118 Message files (vim.mo) have to be placed in "$VIMRUNTIME/lang/xx/LC_MESSAGES", 119 where "xx" is the abbreviation of the language (mostly two letters). 120 121 If you write your own translations you need to generate the .po file and 122 convert it to a .mo file. You need to get the source distribution and read 123 the file "src/po/README.txt". 124 125 The language of the messages comes from the display language of Windows, not 126 from the regional format. The other locale categories, such as the one used 127 for |strftime()|, do follow the regional format. 128 129 To overrule the automatic choice of the language, set the $LANG variable to 130 the language of your choice. use "en" to disable translations. > 131 132 :let $LANG = 'ja' 133 134 (text for Windows by Muraoka Taro) 135 136 ============================================================================== 137 2. Menus *multilang-menus* 138 139 See |45.2| for the basics, esp. using 'langmenu'. 140 141 Note that if changes have been made to the menus after the translation was 142 done, some of the menus may be shown in English. Please try contacting the 143 maintainer of the translation and ask him to update it. You can find the 144 name and e-mail address of the translator in 145 "$VIMRUNTIME/lang/menu_<lang>.vim". 146 147 To set the font (or fontset) to use for the menus, use the |:highlight| 148 command. Example: > 149 150 :highlight Menu font=k12,r12 151 152 153 ALIAS LOCALE NAMES 154 155 Unfortunately, the locale names are different on various systems, even though 156 they are for the same language and encoding. If you do not get the menu 157 translations you expected, check the output of this command: > 158 159 echo v:lang 160 161 Now check the "$VIMRUNTIME/lang" directory for menu translation files that use 162 a similar language. A difference in a "-" being a "_" already causes a file 163 not to be found! Another common difference to watch out for is "iso8859-1" 164 versus "iso_8859-1". Fortunately Vim makes all names lowercase, thus you 165 don't have to worry about case differences. Spaces are changed to 166 underscores, to avoid having to escape them. 167 168 If you find a menu translation file for your language with a different name, 169 create a file in your own runtime directory to load that one. The name of 170 that file could be: > 171 172 ~/.vim/lang/menu_<v:lang>.vim 173 174 Check the 'runtimepath' option for directories which are searched. In that 175 file put a command to load the menu file with the other name: > 176 177 runtime lang/menu_<other_lang>.vim 178 179 180 TRANSLATING MENUS 181 182 If you want to do your own translations, you can use the |:menutrans| command, 183 explained below. It is recommended to put the translations for one language 184 in a Vim script. For a language that has no translation yet, please consider 185 becoming the maintainer and make your translations available to all Vim users. 186 Send an e-mail to the Vim maintainer <maintainer@vim.org>. 187 188 *:menut* *:menutrans* *:menutranslate* 189 :menut[ranslate] clear 190 Clear all menu translations. 191 192 :menut[ranslate] {english} {mylang} 193 Translate menu name {english} to {mylang}. All 194 special characters like "&" and "<Tab>" need to be 195 included. Spaces and dots need to be escaped with a 196 backslash, just like in other |:menu| commands. 197 Case in {english} is ignored. 198 199 See the $VIMRUNTIME/lang directory for examples. 200 201 To try out your translations you first have to remove all menus. This is how 202 you can do it without restarting Vim: > 203 :source $VIMRUNTIME/delmenu.vim 204 :source <your-new-menu-file> 205 :source $VIMRUNTIME/menu.vim 206 207 Each part of a menu path is translated separately. The result is that when 208 "Help" is translated to "Hilfe" and "Overview" to "Überblick" then 209 "Help.Overview" will be translated to "Hilfe.Überblick". 210 211 ============================================================================== 212 3. Scripts *multilang-scripts* 213 214 In Vim scripts you can use the |v:lang| variable to get the current language 215 (locale). The default value is "C" or comes from the $LANG environment 216 variable. 217 218 The following example shows how this variable is used in a simple way, to make 219 a message adapt to language preferences of the user, > 220 221 :if v:lang =~ "de_DE" 222 : echo "Guten Morgen" 223 :else 224 : echo "Good morning" 225 :endif 226 < 227 228 vim:tw=78:sw=4:ts=8:noet:ft=help:norl: