]> code.delx.au - gnu-emacs/blob - doc/emacs/mule.texi
e0653c96f8b0bfe9105eac8cbd63e29948a48fd1
[gnu-emacs] / doc / emacs / mule.texi
1 @c This is part of the Emacs manual.
2 @c Copyright (C) 1997, 1999-2013 Free Software Foundation, Inc.
3 @c See file emacs.texi for copying conditions.
4 @node International
5 @chapter International Character Set Support
6 @c This node is referenced in the tutorial. When renaming or deleting
7 @c it, the tutorial needs to be adjusted. (TUTORIAL.de)
8 @cindex international scripts
9 @cindex multibyte characters
10 @cindex encoding of characters
11
12 @cindex Celtic
13 @cindex Chinese
14 @cindex Cyrillic
15 @cindex Czech
16 @cindex Devanagari
17 @cindex Hindi
18 @cindex Marathi
19 @cindex Ethiopic
20 @cindex German
21 @cindex Greek
22 @cindex Hebrew
23 @cindex IPA
24 @cindex Japanese
25 @cindex Korean
26 @cindex Lao
27 @cindex Latin
28 @cindex Polish
29 @cindex Romanian
30 @cindex Slovak
31 @cindex Slovenian
32 @cindex Thai
33 @cindex Tibetan
34 @cindex Turkish
35 @cindex Vietnamese
36 @cindex Dutch
37 @cindex Spanish
38 Emacs supports a wide variety of international character sets,
39 including European and Vietnamese variants of the Latin alphabet, as
40 well as Cyrillic, Devanagari (for Hindi and Marathi), Ethiopic, Greek,
41 Han (for Chinese and Japanese), Hangul (for Korean), Hebrew, IPA,
42 Kannada, Lao, Malayalam, Tamil, Thai, Tibetan, and Vietnamese scripts.
43 Emacs also supports various encodings of these characters that are used by
44 other internationalized software, such as word processors and mailers.
45
46 Emacs allows editing text with international characters by supporting
47 all the related activities:
48
49 @itemize @bullet
50 @item
51 You can visit files with non-@acronym{ASCII} characters, save non-@acronym{ASCII} text, and
52 pass non-@acronym{ASCII} text between Emacs and programs it invokes (such as
53 compilers, spell-checkers, and mailers). Setting your language
54 environment (@pxref{Language Environments}) takes care of setting up the
55 coding systems and other options for a specific language or culture.
56 Alternatively, you can specify how Emacs should encode or decode text
57 for each command; see @ref{Text Coding}.
58
59 @item
60 You can display non-@acronym{ASCII} characters encoded by the various
61 scripts. This works by using appropriate fonts on graphics displays
62 (@pxref{Defining Fontsets}), and by sending special codes to text
63 displays (@pxref{Terminal Coding}). If some characters are displayed
64 incorrectly, refer to @ref{Undisplayable Characters}, which describes
65 possible problems and explains how to solve them.
66
67 @item
68 Characters from scripts whose natural ordering of text is from right
69 to left are reordered for display (@pxref{Bidirectional Editing}).
70 These scripts include Arabic, Hebrew, Syriac, Thaana, and a few
71 others.
72
73 @item
74 You can insert non-@acronym{ASCII} characters or search for them. To do that,
75 you can specify an input method (@pxref{Select Input Method}) suitable
76 for your language, or use the default input method set up when you chose
77 your language environment. If
78 your keyboard can produce non-@acronym{ASCII} characters, you can select an
79 appropriate keyboard coding system (@pxref{Terminal Coding}), and Emacs
80 will accept those characters. Latin-1 characters can also be input by
81 using the @kbd{C-x 8} prefix, see @ref{Unibyte Mode}.
82
83 With the X Window System, your locale should be set to an appropriate
84 value to make sure Emacs interprets keyboard input correctly; see
85 @ref{Language Environments, locales}.
86 @end itemize
87
88 The rest of this chapter describes these issues in detail.
89
90 @menu
91 * International Chars:: Basic concepts of multibyte characters.
92 * Language Environments:: Setting things up for the language you use.
93 * Input Methods:: Entering text characters not on your keyboard.
94 * Select Input Method:: Specifying your choice of input methods.
95 * Coding Systems:: Character set conversion when you read and
96 write files, and so on.
97 * Recognize Coding:: How Emacs figures out which conversion to use.
98 * Specify Coding:: Specifying a file's coding system explicitly.
99 * Output Coding:: Choosing coding systems for output.
100 * Text Coding:: Choosing conversion to use for file text.
101 * Communication Coding:: Coding systems for interprocess communication.
102 * File Name Coding:: Coding systems for file @emph{names}.
103 * Terminal Coding:: Specifying coding systems for converting
104 terminal input and output.
105 * Fontsets:: Fontsets are collections of fonts
106 that cover the whole spectrum of characters.
107 * Defining Fontsets:: Defining a new fontset.
108 * Modifying Fontsets:: Modifying an existing fontset.
109 * Undisplayable Characters:: When characters don't display.
110 * Unibyte Mode:: You can pick one European character set
111 to use without multibyte characters.
112 * Charsets:: How Emacs groups its internal character codes.
113 * Bidirectional Editing:: Support for right-to-left scripts.
114 @end menu
115
116 @node International Chars
117 @section Introduction to International Character Sets
118
119 The users of international character sets and scripts have
120 established many more-or-less standard coding systems for storing
121 files. These coding systems are typically @dfn{multibyte}, meaning
122 that sequences of two or more bytes are used to represent individual
123 non-@acronym{ASCII} characters.
124
125 @cindex Unicode
126 Internally, Emacs uses its own multibyte character encoding, which
127 is a superset of the @dfn{Unicode} standard. This internal encoding
128 allows characters from almost every known script to be intermixed in a
129 single buffer or string. Emacs translates between the multibyte
130 character encoding and various other coding systems when reading and
131 writing files, and when exchanging data with subprocesses.
132
133 @kindex C-h h
134 @findex view-hello-file
135 @cindex undisplayable characters
136 @cindex @samp{?} in display
137 The command @kbd{C-h h} (@code{view-hello-file}) displays the file
138 @file{etc/HELLO}, which illustrates various scripts by showing
139 how to say ``hello'' in many languages. If some characters can't be
140 displayed on your terminal, they appear as @samp{?} or as hollow boxes
141 (@pxref{Undisplayable Characters}).
142
143 Keyboards, even in the countries where these character sets are
144 used, generally don't have keys for all the characters in them. You
145 can insert characters that your keyboard does not support, using
146 @kbd{C-q} (@code{quoted-insert}) or @kbd{C-x 8 @key{RET}}
147 (@code{insert-char}). @xref{Inserting Text}. Emacs also supports
148 various @dfn{input methods}, typically one for each script or
149 language, which make it easier to type characters in the script.
150 @xref{Input Methods}.
151
152 @kindex C-x RET
153 The prefix key @kbd{C-x @key{RET}} is used for commands that pertain
154 to multibyte characters, coding systems, and input methods.
155
156 @kindex C-x =
157 @findex what-cursor-position
158 The command @kbd{C-x =} (@code{what-cursor-position}) shows
159 information about the character at point. In addition to the
160 character position, which was described in @ref{Position Info}, this
161 command displays how the character is encoded. For instance, it
162 displays the following line in the echo area for the character
163 @samp{c}:
164
165 @smallexample
166 Char: c (99, #o143, #x63) point=28062 of 36168 (78%) column=53
167 @end smallexample
168
169 The four values after @samp{Char:} describe the character that
170 follows point, first by showing it and then by giving its character
171 code in decimal, octal and hex. For a non-@acronym{ASCII} multibyte
172 character, these are followed by @samp{file} and the character's
173 representation, in hex, in the buffer's coding system, if that coding
174 system encodes the character safely and with a single byte
175 (@pxref{Coding Systems}). If the character's encoding is longer than
176 one byte, Emacs shows @samp{file ...}.
177
178 As a special case, if the character lies in the range 128 (0200
179 octal) through 159 (0237 octal), it stands for a ``raw'' byte that
180 does not correspond to any specific displayable character. Such a
181 ``character'' lies within the @code{eight-bit-control} character set,
182 and is displayed as an escaped octal character code. In this case,
183 @kbd{C-x =} shows @samp{part of display ...} instead of @samp{file}.
184
185 @cindex character set of character at point
186 @cindex font of character at point
187 @cindex text properties at point
188 @cindex face at point
189 With a prefix argument (@kbd{C-u C-x =}), this command displays a
190 detailed description of the character in a window:
191
192 @itemize @bullet
193 @item
194 The character set name, and the codes that identify the character
195 within that character set; @acronym{ASCII} characters are identified
196 as belonging to the @code{ascii} character set.
197
198 @item
199 The character's syntax and categories.
200
201 @item
202 The character's encodings, both internally in the buffer, and externally
203 if you were to save the file.
204
205 @item
206 What keys to type to input the character in the current input method
207 (if it supports the character).
208
209 @item
210 If you are running Emacs on a graphical display, the font name and
211 glyph code for the character. If you are running Emacs on a text
212 terminal, the code(s) sent to the terminal.
213
214 @item
215 The character's text properties (@pxref{Text Properties,,,
216 elisp, the Emacs Lisp Reference Manual}), including any non-default
217 faces used to display the character, and any overlays containing it
218 (@pxref{Overlays,,, elisp, the same manual}).
219 @end itemize
220
221 Here's an example showing the Latin-1 character A with grave accent,
222 in a buffer whose coding system is @code{utf-8-unix}:
223
224 @smallexample
225 position: 1 of 1 (0%), column: 0
226 character: @`A (displayed as @`A) (codepoint 192, #o300, #xc0)
227 preferred charset: unicode (Unicode (ISO10646))
228 code point in charset: 0xC0
229 syntax: w which means: word
230 category: .:Base, L:Left-to-right (strong),
231 j:Japanese, l:Latin, v:Viet
232 buffer code: #xC3 #x80
233 file code: not encodable by coding system undecided-unix
234 display: by this font (glyph code)
235 xft:-unknown-DejaVu Sans Mono-normal-normal-
236 normal-*-13-*-*-*-m-0-iso10646-1 (#x82)
237
238 Character code properties: customize what to show
239 name: LATIN CAPITAL LETTER A WITH GRAVE
240 old-name: LATIN CAPITAL LETTER A GRAVE
241 general-category: Lu (Letter, Uppercase)
242 decomposition: (65 768) ('A' '`')
243 @end smallexample
244
245 @node Language Environments
246 @section Language Environments
247 @cindex language environments
248
249 All supported character sets are supported in Emacs buffers whenever
250 multibyte characters are enabled; there is no need to select a
251 particular language in order to display its characters.
252 However, it is important to select a @dfn{language
253 environment} in order to set various defaults. Roughly speaking, the
254 language environment represents a choice of preferred script rather
255 than a choice of language.
256
257 The language environment controls which coding systems to recognize
258 when reading text (@pxref{Recognize Coding}). This applies to files,
259 incoming mail, and any other text you read into Emacs. It may also
260 specify the default coding system to use when you create a file. Each
261 language environment also specifies a default input method.
262
263 @findex set-language-environment
264 @vindex current-language-environment
265 To select a language environment, customize
266 @code{current-language-environment} or use the command @kbd{M-x
267 set-language-environment}. It makes no difference which buffer is
268 current when you use this command, because the effects apply globally
269 to the Emacs session. The supported language environments
270 (see the variable @code{language-info-alist}) include:
271
272 @cindex Euro sign
273 @cindex UTF-8
274 @quotation
275 ASCII, Belarusian, Bengali, Brazilian Portuguese, Bulgarian, Cham,
276 Chinese-BIG5, Chinese-CNS, Chinese-EUC-TW, Chinese-GB, Chinese-GBK,
277 Chinese-GB18030, Croatian, Cyrillic-ALT, Cyrillic-ISO, Cyrillic-KOI8,
278 Czech, Devanagari, Dutch, English, Esperanto, Ethiopic, French,
279 Georgian, German, Greek, Gujarati, Hebrew, IPA, Italian, Japanese,
280 Kannada, Khmer, Korean, Lao, Latin-1, Latin-2, Latin-3, Latin-4,
281 Latin-5, Latin-6, Latin-7, Latin-8 (Celtic), Latin-9 (updated Latin-1
282 with the Euro sign), Latvian, Lithuanian, Malayalam, Oriya, Polish,
283 Punjabi, Romanian, Russian, Sinhala, Slovak, Slovenian, Spanish,
284 Swedish, TaiViet, Tajik, Tamil, Telugu, Thai, Tibetan, Turkish, UTF-8
285 (for a setup which prefers Unicode characters and files encoded in
286 UTF-8), Ukrainian, Vietnamese, Welsh, and Windows-1255 (for a setup
287 which prefers Cyrillic characters and files encoded in Windows-1255).
288 @end quotation
289
290 To display the script(s) used by your language environment on a
291 graphical display, you need to have suitable fonts.
292 @xref{Fontsets}, for more details about setting up your fonts.
293
294 @findex set-locale-environment
295 @vindex locale-language-names
296 @vindex locale-charset-language-names
297 @cindex locales
298 Some operating systems let you specify the character-set locale you
299 are using by setting the locale environment variables @env{LC_ALL},
300 @env{LC_CTYPE}, or @env{LANG}. (If more than one of these is
301 set, the first one that is nonempty specifies your locale for this
302 purpose.) During startup, Emacs looks up your character-set locale's
303 name in the system locale alias table, matches its canonical name
304 against entries in the value of the variables
305 @code{locale-charset-language-names} and @code{locale-language-names}
306 (the former overrides the latter),
307 and selects the corresponding language environment if a match is found.
308 It also adjusts the display
309 table and terminal coding system, the locale coding system, the
310 preferred coding system as needed for the locale, and---last but not
311 least---the way Emacs decodes non-@acronym{ASCII} characters sent by your keyboard.
312
313 @c This seems unlikely, doesn't it?
314 If you modify the @env{LC_ALL}, @env{LC_CTYPE}, or @env{LANG}
315 environment variables while running Emacs (by using @kbd{M-x setenv}),
316 you may want to invoke the @code{set-locale-environment}
317 function afterwards to readjust the language environment from the new
318 locale.
319
320 @vindex locale-preferred-coding-systems
321 The @code{set-locale-environment} function normally uses the preferred
322 coding system established by the language environment to decode system
323 messages. But if your locale matches an entry in the variable
324 @code{locale-preferred-coding-systems}, Emacs uses the corresponding
325 coding system instead. For example, if the locale @samp{ja_JP.PCK}
326 matches @code{japanese-shift-jis} in
327 @code{locale-preferred-coding-systems}, Emacs uses that encoding even
328 though it might normally use @code{japanese-iso-8bit}.
329
330 You can override the language environment chosen at startup with
331 explicit use of the command @code{set-language-environment}, or with
332 customization of @code{current-language-environment} in your init
333 file.
334
335 @kindex C-h L
336 @findex describe-language-environment
337 To display information about the effects of a certain language
338 environment @var{lang-env}, use the command @kbd{C-h L @var{lang-env}
339 @key{RET}} (@code{describe-language-environment}). This tells you
340 which languages this language environment is useful for, and lists the
341 character sets, coding systems, and input methods that go with it. It
342 also shows some sample text to illustrate scripts used in this
343 language environment. If you give an empty input for @var{lang-env},
344 this command describes the chosen language environment.
345 @anchor{Describe Language Environment}
346
347 @vindex set-language-environment-hook
348 You can customize any language environment with the normal hook
349 @code{set-language-environment-hook}. The command
350 @code{set-language-environment} runs that hook after setting up the new
351 language environment. The hook functions can test for a specific
352 language environment by checking the variable
353 @code{current-language-environment}. This hook is where you should
354 put non-default settings for specific language environments, such as
355 coding systems for keyboard input and terminal output, the default
356 input method, etc.
357
358 @vindex exit-language-environment-hook
359 Before it starts to set up the new language environment,
360 @code{set-language-environment} first runs the hook
361 @code{exit-language-environment-hook}. This hook is useful for undoing
362 customizations that were made with @code{set-language-environment-hook}.
363 For instance, if you set up a special key binding in a specific language
364 environment using @code{set-language-environment-hook}, you should set
365 up @code{exit-language-environment-hook} to restore the normal binding
366 for that key.
367
368 @node Input Methods
369 @section Input Methods
370
371 @cindex input methods
372 An @dfn{input method} is a kind of character conversion designed
373 specifically for interactive input. In Emacs, typically each language
374 has its own input method; sometimes several languages that use the same
375 characters can share one input method. A few languages support several
376 input methods.
377
378 The simplest kind of input method works by mapping @acronym{ASCII} letters
379 into another alphabet; this allows you to use one other alphabet
380 instead of @acronym{ASCII}. The Greek and Russian input methods
381 work this way.
382
383 A more powerful technique is composition: converting sequences of
384 characters into one letter. Many European input methods use composition
385 to produce a single non-@acronym{ASCII} letter from a sequence that consists of a
386 letter followed by accent characters (or vice versa). For example, some
387 methods convert the sequence @kbd{o ^} into a single accented letter.
388 These input methods have no special commands of their own; all they do
389 is compose sequences of printing characters.
390
391 The input methods for syllabic scripts typically use mapping followed
392 by composition. The input methods for Thai and Korean work this way.
393 First, letters are mapped into symbols for particular sounds or tone
394 marks; then, sequences of these that make up a whole syllable are
395 mapped into one syllable sign.
396
397 Chinese and Japanese require more complex methods. In Chinese input
398 methods, first you enter the phonetic spelling of a Chinese word (in
399 input method @code{chinese-py}, among others), or a sequence of
400 portions of the character (input methods @code{chinese-4corner} and
401 @code{chinese-sw}, and others). One input sequence typically
402 corresponds to many possible Chinese characters. You select the one
403 you mean using keys such as @kbd{C-f}, @kbd{C-b}, @kbd{C-n},
404 @kbd{C-p} (or the arrow keys), and digits, which have special meanings
405 in this situation.
406
407 The possible characters are conceptually arranged in several rows,
408 with each row holding up to 10 alternatives. Normally, Emacs displays
409 just one row at a time, in the echo area; @code{(@var{i}/@var{j})}
410 appears at the beginning, to indicate that this is the @var{i}th row
411 out of a total of @var{j} rows. Type @kbd{C-n} or @kbd{C-p} to
412 display the next row or the previous row.
413
414 Type @kbd{C-f} and @kbd{C-b} to move forward and backward among
415 the alternatives in the current row. As you do this, Emacs highlights
416 the current alternative with a special color; type @code{C-@key{SPC}}
417 to select the current alternative and use it as input. The
418 alternatives in the row are also numbered; the number appears before
419 the alternative. Typing a number selects the associated alternative
420 of the current row and uses it as input.
421
422 @key{TAB} in these Chinese input methods displays a buffer showing
423 all the possible characters at once; then clicking @kbd{Mouse-2} on
424 one of them selects that alternative. The keys @kbd{C-f}, @kbd{C-b},
425 @kbd{C-n}, @kbd{C-p}, and digits continue to work as usual, but they
426 do the highlighting in the buffer showing the possible characters,
427 rather than in the echo area.
428
429 In Japanese input methods, first you input a whole word using
430 phonetic spelling; then, after the word is in the buffer, Emacs
431 converts it into one or more characters using a large dictionary. One
432 phonetic spelling corresponds to a number of different Japanese words;
433 to select one of them, use @kbd{C-n} and @kbd{C-p} to cycle through
434 the alternatives.
435
436 Sometimes it is useful to cut off input method processing so that the
437 characters you have just entered will not combine with subsequent
438 characters. For example, in input method @code{latin-1-postfix}, the
439 sequence @kbd{o ^} combines to form an @samp{o} with an accent. What if
440 you want to enter them as separate characters?
441
442 One way is to type the accent twice; this is a special feature for
443 entering the separate letter and accent. For example, @kbd{o ^ ^} gives
444 you the two characters @samp{o^}. Another way is to type another letter
445 after the @kbd{o}---something that won't combine with that---and
446 immediately delete it. For example, you could type @kbd{o o @key{DEL}
447 ^} to get separate @samp{o} and @samp{^}.
448
449 Another method, more general but not quite as easy to type, is to use
450 @kbd{C-\ C-\} between two characters to stop them from combining. This
451 is the command @kbd{C-\} (@code{toggle-input-method}) used twice.
452 @ifnottex
453 @xref{Select Input Method}.
454 @end ifnottex
455
456 @cindex incremental search, input method interference
457 @kbd{C-\ C-\} is especially useful inside an incremental search,
458 because it stops waiting for more characters to combine, and starts
459 searching for what you have already entered.
460
461 To find out how to input the character after point using the current
462 input method, type @kbd{C-u C-x =}. @xref{Position Info}.
463
464 @vindex input-method-verbose-flag
465 @vindex input-method-highlight-flag
466 The variables @code{input-method-highlight-flag} and
467 @code{input-method-verbose-flag} control how input methods explain
468 what is happening. If @code{input-method-highlight-flag} is
469 non-@code{nil}, the partial sequence is highlighted in the buffer (for
470 most input methods---some disable this feature). If
471 @code{input-method-verbose-flag} is non-@code{nil}, the list of
472 possible characters to type next is displayed in the echo area (but
473 not when you are in the minibuffer).
474
475 Another facility for typing characters not on your keyboard is by
476 using @kbd{C-x 8 @key{RET}} (@code{insert-char}) to insert a single
477 character based on its Unicode name or code-point; see @ref{Inserting
478 Text}.
479
480 @node Select Input Method
481 @section Selecting an Input Method
482
483 @table @kbd
484 @item C-\
485 Enable or disable use of the selected input method (@code{toggle-input-method}).
486
487 @item C-x @key{RET} C-\ @var{method} @key{RET}
488 Select a new input method for the current buffer (@code{set-input-method}).
489
490 @item C-h I @var{method} @key{RET}
491 @itemx C-h C-\ @var{method} @key{RET}
492 @findex describe-input-method
493 @kindex C-h I
494 @kindex C-h C-\
495 Describe the input method @var{method} (@code{describe-input-method}).
496 By default, it describes the current input method (if any). This
497 description should give you the full details of how to use any
498 particular input method.
499
500 @item M-x list-input-methods
501 Display a list of all the supported input methods.
502 @end table
503
504 @findex set-input-method
505 @vindex current-input-method
506 @kindex C-x RET C-\
507 To choose an input method for the current buffer, use @kbd{C-x
508 @key{RET} C-\} (@code{set-input-method}). This command reads the
509 input method name from the minibuffer; the name normally starts with the
510 language environment that it is meant to be used with. The variable
511 @code{current-input-method} records which input method is selected.
512
513 @findex toggle-input-method
514 @kindex C-\
515 Input methods use various sequences of @acronym{ASCII} characters to
516 stand for non-@acronym{ASCII} characters. Sometimes it is useful to
517 turn off the input method temporarily. To do this, type @kbd{C-\}
518 (@code{toggle-input-method}). To reenable the input method, type
519 @kbd{C-\} again.
520
521 If you type @kbd{C-\} and you have not yet selected an input method,
522 it prompts you to specify one. This has the same effect as using
523 @kbd{C-x @key{RET} C-\} to specify an input method.
524
525 When invoked with a numeric argument, as in @kbd{C-u C-\},
526 @code{toggle-input-method} always prompts you for an input method,
527 suggesting the most recently selected one as the default.
528
529 @vindex default-input-method
530 Selecting a language environment specifies a default input method for
531 use in various buffers. When you have a default input method, you can
532 select it in the current buffer by typing @kbd{C-\}. The variable
533 @code{default-input-method} specifies the default input method
534 (@code{nil} means there is none).
535
536 In some language environments, which support several different input
537 methods, you might want to use an input method different from the
538 default chosen by @code{set-language-environment}. You can instruct
539 Emacs to select a different default input method for a certain
540 language environment, if you wish, by using
541 @code{set-language-environment-hook} (@pxref{Language Environments,
542 set-language-environment-hook}). For example:
543
544 @lisp
545 (defun my-chinese-setup ()
546 "Set up my private Chinese environment."
547 (if (equal current-language-environment "Chinese-GB")
548 (setq default-input-method "chinese-tonepy")))
549 (add-hook 'set-language-environment-hook 'my-chinese-setup)
550 @end lisp
551
552 @noindent
553 This sets the default input method to be @code{chinese-tonepy}
554 whenever you choose a Chinese-GB language environment.
555
556 You can instruct Emacs to activate a certain input method
557 automatically. For example:
558
559 @lisp
560 (add-hook 'text-mode-hook
561 (lambda () (set-input-method "german-prefix")))
562 @end lisp
563
564 @noindent
565 This automatically activates the input method ``german-prefix'' in
566 Text mode.
567
568 @findex quail-set-keyboard-layout
569 Some input methods for alphabetic scripts work by (in effect)
570 remapping the keyboard to emulate various keyboard layouts commonly used
571 for those scripts. How to do this remapping properly depends on your
572 actual keyboard layout. To specify which layout your keyboard has, use
573 the command @kbd{M-x quail-set-keyboard-layout}.
574
575 @findex quail-show-key
576 You can use the command @kbd{M-x quail-show-key} to show what key (or
577 key sequence) to type in order to input the character following point,
578 using the selected keyboard layout. The command @kbd{C-u C-x =} also
579 shows that information, in addition to other information about the
580 character.
581
582 @findex list-input-methods
583 @kbd{M-x list-input-methods} displays a list of all the supported
584 input methods. The list gives information about each input method,
585 including the string that stands for it in the mode line.
586
587 @node Coding Systems
588 @section Coding Systems
589 @cindex coding systems
590
591 Users of various languages have established many more-or-less standard
592 coding systems for representing them. Emacs does not use these coding
593 systems internally; instead, it converts from various coding systems to
594 its own system when reading data, and converts the internal coding
595 system to other coding systems when writing data. Conversion is
596 possible in reading or writing files, in sending or receiving from the
597 terminal, and in exchanging data with subprocesses.
598
599 Emacs assigns a name to each coding system. Most coding systems are
600 used for one language, and the name of the coding system starts with
601 the language name. Some coding systems are used for several
602 languages; their names usually start with @samp{iso}. There are also
603 special coding systems, such as @code{no-conversion}, @code{raw-text},
604 and @code{emacs-internal}.
605
606 @cindex international files from DOS/Windows systems
607 A special class of coding systems, collectively known as
608 @dfn{codepages}, is designed to support text encoded by MS-Windows and
609 MS-DOS software. The names of these coding systems are
610 @code{cp@var{nnnn}}, where @var{nnnn} is a 3- or 4-digit number of the
611 codepage. You can use these encodings just like any other coding
612 system; for example, to visit a file encoded in codepage 850, type
613 @kbd{C-x @key{RET} c cp850 @key{RET} C-x C-f @var{filename}
614 @key{RET}}.
615
616 In addition to converting various representations of non-@acronym{ASCII}
617 characters, a coding system can perform end-of-line conversion. Emacs
618 handles three different conventions for how to separate lines in a file:
619 newline (``unix''), carriage-return linefeed (``dos''), and just
620 carriage-return (``mac'').
621
622 @table @kbd
623 @item C-h C @var{coding} @key{RET}
624 Describe coding system @var{coding} (@code{describe-coding-system}).
625
626 @item C-h C @key{RET}
627 Describe the coding systems currently in use.
628
629 @item M-x list-coding-systems
630 Display a list of all the supported coding systems.
631 @end table
632
633 @kindex C-h C
634 @findex describe-coding-system
635 The command @kbd{C-h C} (@code{describe-coding-system}) displays
636 information about particular coding systems, including the end-of-line
637 conversion specified by those coding systems. You can specify a coding
638 system name as the argument; alternatively, with an empty argument, it
639 describes the coding systems currently selected for various purposes,
640 both in the current buffer and as the defaults, and the priority list
641 for recognizing coding systems (@pxref{Recognize Coding}).
642
643 @findex list-coding-systems
644 To display a list of all the supported coding systems, type @kbd{M-x
645 list-coding-systems}. The list gives information about each coding
646 system, including the letter that stands for it in the mode line
647 (@pxref{Mode Line}).
648
649 @cindex end-of-line conversion
650 @cindex line endings
651 @cindex MS-DOS end-of-line conversion
652 @cindex Macintosh end-of-line conversion
653 Each of the coding systems that appear in this list---except for
654 @code{no-conversion}, which means no conversion of any kind---specifies
655 how and whether to convert printing characters, but leaves the choice of
656 end-of-line conversion to be decided based on the contents of each file.
657 For example, if the file appears to use the sequence carriage-return
658 linefeed to separate lines, DOS end-of-line conversion will be used.
659
660 Each of the listed coding systems has three variants, which specify
661 exactly what to do for end-of-line conversion:
662
663 @table @code
664 @item @dots{}-unix
665 Don't do any end-of-line conversion; assume the file uses
666 newline to separate lines. (This is the convention normally used
667 on Unix and GNU systems, and Mac OS X.)
668
669 @item @dots{}-dos
670 Assume the file uses carriage-return linefeed to separate lines, and do
671 the appropriate conversion. (This is the convention normally used on
672 Microsoft systems.@footnote{It is also specified for MIME @samp{text/*}
673 bodies and in other network transport contexts. It is different
674 from the SGML reference syntax record-start/record-end format, which
675 Emacs doesn't support directly.})
676
677 @item @dots{}-mac
678 Assume the file uses carriage-return to separate lines, and do the
679 appropriate conversion. (This was the convention used on the
680 Macintosh system prior to OS X.)
681 @end table
682
683 These variant coding systems are omitted from the
684 @code{list-coding-systems} display for brevity, since they are entirely
685 predictable. For example, the coding system @code{iso-latin-1} has
686 variants @code{iso-latin-1-unix}, @code{iso-latin-1-dos} and
687 @code{iso-latin-1-mac}.
688
689 @cindex @code{undecided}, coding system
690 The coding systems @code{unix}, @code{dos}, and @code{mac} are
691 aliases for @code{undecided-unix}, @code{undecided-dos}, and
692 @code{undecided-mac}, respectively. These coding systems specify only
693 the end-of-line conversion, and leave the character code conversion to
694 be deduced from the text itself.
695
696 @cindex @code{raw-text}, coding system
697 The coding system @code{raw-text} is good for a file which is mainly
698 @acronym{ASCII} text, but may contain byte values above 127 that are
699 not meant to encode non-@acronym{ASCII} characters. With
700 @code{raw-text}, Emacs copies those byte values unchanged, and sets
701 @code{enable-multibyte-characters} to @code{nil} in the current buffer
702 so that they will be interpreted properly. @code{raw-text} handles
703 end-of-line conversion in the usual way, based on the data
704 encountered, and has the usual three variants to specify the kind of
705 end-of-line conversion to use.
706
707 @cindex @code{no-conversion}, coding system
708 In contrast, the coding system @code{no-conversion} specifies no
709 character code conversion at all---none for non-@acronym{ASCII} byte values and
710 none for end of line. This is useful for reading or writing binary
711 files, tar files, and other files that must be examined verbatim. It,
712 too, sets @code{enable-multibyte-characters} to @code{nil}.
713
714 The easiest way to edit a file with no conversion of any kind is with
715 the @kbd{M-x find-file-literally} command. This uses
716 @code{no-conversion}, and also suppresses other Emacs features that
717 might convert the file contents before you see them. @xref{Visiting}.
718
719 @cindex @code{emacs-internal}, coding system
720 The coding system @code{emacs-internal} (or @code{utf-8-emacs},
721 which is equivalent) means that the file contains non-@acronym{ASCII}
722 characters stored with the internal Emacs encoding. This coding
723 system handles end-of-line conversion based on the data encountered,
724 and has the usual three variants to specify the kind of end-of-line
725 conversion.
726
727 @node Recognize Coding
728 @section Recognizing Coding Systems
729
730 Whenever Emacs reads a given piece of text, it tries to recognize
731 which coding system to use. This applies to files being read, output
732 from subprocesses, text from X selections, etc. Emacs can select the
733 right coding system automatically most of the time---once you have
734 specified your preferences.
735
736 Some coding systems can be recognized or distinguished by which byte
737 sequences appear in the data. However, there are coding systems that
738 cannot be distinguished, not even potentially. For example, there is no
739 way to distinguish between Latin-1 and Latin-2; they use the same byte
740 values with different meanings.
741
742 Emacs handles this situation by means of a priority list of coding
743 systems. Whenever Emacs reads a file, if you do not specify the coding
744 system to use, Emacs checks the data against each coding system,
745 starting with the first in priority and working down the list, until it
746 finds a coding system that fits the data. Then it converts the file
747 contents assuming that they are represented in this coding system.
748
749 The priority list of coding systems depends on the selected language
750 environment (@pxref{Language Environments}). For example, if you use
751 French, you probably want Emacs to prefer Latin-1 to Latin-2; if you use
752 Czech, you probably want Latin-2 to be preferred. This is one of the
753 reasons to specify a language environment.
754
755 @findex prefer-coding-system
756 However, you can alter the coding system priority list in detail
757 with the command @kbd{M-x prefer-coding-system}. This command reads
758 the name of a coding system from the minibuffer, and adds it to the
759 front of the priority list, so that it is preferred to all others. If
760 you use this command several times, each use adds one element to the
761 front of the priority list.
762
763 If you use a coding system that specifies the end-of-line conversion
764 type, such as @code{iso-8859-1-dos}, what this means is that Emacs
765 should attempt to recognize @code{iso-8859-1} with priority, and should
766 use DOS end-of-line conversion when it does recognize @code{iso-8859-1}.
767
768 @vindex file-coding-system-alist
769 Sometimes a file name indicates which coding system to use for the
770 file. The variable @code{file-coding-system-alist} specifies this
771 correspondence. There is a special function
772 @code{modify-coding-system-alist} for adding elements to this list. For
773 example, to read and write all @samp{.txt} files using the coding system
774 @code{chinese-iso-8bit}, you can execute this Lisp expression:
775
776 @smallexample
777 (modify-coding-system-alist 'file "\\.txt\\'" 'chinese-iso-8bit)
778 @end smallexample
779
780 @noindent
781 The first argument should be @code{file}, the second argument should be
782 a regular expression that determines which files this applies to, and
783 the third argument says which coding system to use for these files.
784
785 @vindex inhibit-eol-conversion
786 @cindex DOS-style end-of-line display
787 Emacs recognizes which kind of end-of-line conversion to use based on
788 the contents of the file: if it sees only carriage-returns, or only
789 carriage-return linefeed sequences, then it chooses the end-of-line
790 conversion accordingly. You can inhibit the automatic use of
791 end-of-line conversion by setting the variable @code{inhibit-eol-conversion}
792 to non-@code{nil}. If you do that, DOS-style files will be displayed
793 with the @samp{^M} characters visible in the buffer; some people
794 prefer this to the more subtle @samp{(DOS)} end-of-line type
795 indication near the left edge of the mode line (@pxref{Mode Line,
796 eol-mnemonic}).
797
798 @vindex inhibit-iso-escape-detection
799 @cindex escape sequences in files
800 By default, the automatic detection of coding system is sensitive to
801 escape sequences. If Emacs sees a sequence of characters that begin
802 with an escape character, and the sequence is valid as an ISO-2022
803 code, that tells Emacs to use one of the ISO-2022 encodings to decode
804 the file.
805
806 However, there may be cases that you want to read escape sequences
807 in a file as is. In such a case, you can set the variable
808 @code{inhibit-iso-escape-detection} to non-@code{nil}. Then the code
809 detection ignores any escape sequences, and never uses an ISO-2022
810 encoding. The result is that all escape sequences become visible in
811 the buffer.
812
813 The default value of @code{inhibit-iso-escape-detection} is
814 @code{nil}. We recommend that you not change it permanently, only for
815 one specific operation. That's because some Emacs Lisp source files
816 in the Emacs distribution contain non-@acronym{ASCII} characters encoded in the
817 coding system @code{iso-2022-7bit}, and they won't be
818 decoded correctly when you visit those files if you suppress the
819 escape sequence detection.
820 @c I count a grand total of 3 such files, so is the above really true?
821
822 @vindex auto-coding-alist
823 @vindex auto-coding-regexp-alist
824 The variables @code{auto-coding-alist} and
825 @code{auto-coding-regexp-alist} are
826 the strongest way to specify the coding system for certain patterns of
827 file names, or for files containing certain patterns, respectively.
828 These variables even override @samp{-*-coding:-*-} tags in the file
829 itself (@pxref{Specify Coding}). For example, Emacs
830 uses @code{auto-coding-alist} for tar and archive files, to prevent it
831 from being confused by a @samp{-*-coding:-*-} tag in a member of the
832 archive and thinking it applies to the archive file as a whole.
833 @ignore
834 @c This describes old-style BABYL files, which are no longer relevant.
835 Likewise, Emacs uses @code{auto-coding-regexp-alist} to ensure that
836 RMAIL files, whose names in general don't match any particular
837 pattern, are decoded correctly.
838 @end ignore
839
840 @vindex auto-coding-functions
841 Another way to specify a coding system is with the variable
842 @code{auto-coding-functions}. For example, one of the builtin
843 @code{auto-coding-functions} detects the encoding for XML files.
844 Unlike the previous two, this variable does not override any
845 @samp{-*-coding:-*-} tag.
846
847 @node Specify Coding
848 @section Specifying a File's Coding System
849
850 If Emacs recognizes the encoding of a file incorrectly, you can
851 reread the file using the correct coding system with @kbd{C-x
852 @key{RET} r} (@code{revert-buffer-with-coding-system}). This command
853 prompts for the coding system to use. To see what coding system Emacs
854 actually used to decode the file, look at the coding system mnemonic
855 letter near the left edge of the mode line (@pxref{Mode Line}), or
856 type @kbd{C-h C} (@code{describe-coding-system}).
857
858 @vindex coding
859 You can specify the coding system for a particular file in the file
860 itself, using the @w{@samp{-*-@dots{}-*-}} construct at the beginning,
861 or a local variables list at the end (@pxref{File Variables}). You do
862 this by defining a value for the ``variable'' named @code{coding}.
863 Emacs does not really have a variable @code{coding}; instead of
864 setting a variable, this uses the specified coding system for the
865 file. For example, @samp{-*-mode: C; coding: latin-1;-*-} specifies
866 use of the Latin-1 coding system, as well as C mode. When you specify
867 the coding explicitly in the file, that overrides
868 @code{file-coding-system-alist}.
869
870 @node Output Coding
871 @section Choosing Coding Systems for Output
872
873 @vindex buffer-file-coding-system
874 Once Emacs has chosen a coding system for a buffer, it stores that
875 coding system in @code{buffer-file-coding-system}. That makes it the
876 default for operations that write from this buffer into a file, such
877 as @code{save-buffer} and @code{write-region}. You can specify a
878 different coding system for further file output from the buffer using
879 @code{set-buffer-file-coding-system} (@pxref{Text Coding}).
880
881 You can insert any character Emacs supports into any Emacs buffer,
882 but most coding systems can only handle a subset of these characters.
883 Therefore, it's possible that the characters you insert cannot be
884 encoded with the coding system that will be used to save the buffer.
885 For example, you could visit a text file in Polish, encoded in
886 @code{iso-8859-2}, and add some Russian words to it. When you save
887 that buffer, Emacs cannot use the current value of
888 @code{buffer-file-coding-system}, because the characters you added
889 cannot be encoded by that coding system.
890
891 When that happens, Emacs tries the most-preferred coding system (set
892 by @kbd{M-x prefer-coding-system} or @kbd{M-x
893 set-language-environment}). If that coding system can safely encode
894 all of the characters in the buffer, Emacs uses it, and stores its
895 value in @code{buffer-file-coding-system}. Otherwise, Emacs displays
896 a list of coding systems suitable for encoding the buffer's contents,
897 and asks you to choose one of those coding systems.
898
899 If you insert the unsuitable characters in a mail message, Emacs
900 behaves a bit differently. It additionally checks whether the
901 @c What determines this?
902 most-preferred coding system is recommended for use in MIME messages;
903 if not, it informs you of this fact and prompts you for another coding
904 system. This is so you won't inadvertently send a message encoded in
905 a way that your recipient's mail software will have difficulty
906 decoding. (You can still use an unsuitable coding system if you enter
907 its name at the prompt.)
908
909 @c It seems that select-message-coding-system does this.
910 @c Both sendmail.el and smptmail.el call it; i.e., smtpmail.el still
911 @c obeys sendmail-coding-system.
912 @vindex sendmail-coding-system
913 When you send a mail message (@pxref{Sending Mail}),
914 Emacs has four different ways to determine the coding system to use
915 for encoding the message text. It tries the buffer's own value of
916 @code{buffer-file-coding-system}, if that is non-@code{nil}.
917 Otherwise, it uses the value of @code{sendmail-coding-system}, if that
918 is non-@code{nil}. The third way is to use the default coding system
919 for new files, which is controlled by your choice of language
920 @c i.e., default-sendmail-coding-system
921 environment, if that is non-@code{nil}. If all of these three values
922 are @code{nil}, Emacs encodes outgoing mail using the Latin-1 coding
923 system.
924 @c FIXME? Where does the Latin-1 default come in?
925
926 @node Text Coding
927 @section Specifying a Coding System for File Text
928
929 In cases where Emacs does not automatically choose the right coding
930 system for a file's contents, you can use these commands to specify
931 one:
932
933 @table @kbd
934 @item C-x @key{RET} f @var{coding} @key{RET}
935 Use coding system @var{coding} to save or revisit the file in
936 the current buffer (@code{set-buffer-file-coding-system}).
937
938 @item C-x @key{RET} c @var{coding} @key{RET}
939 Specify coding system @var{coding} for the immediately following
940 command (@code{universal-coding-system-argument}).
941
942 @item C-x @key{RET} r @var{coding} @key{RET}
943 Revisit the current file using the coding system @var{coding}
944 (@code{revert-buffer-with-coding-system}).
945
946 @item M-x recode-region @key{RET} @var{right} @key{RET} @var{wrong} @key{RET}
947 Convert a region that was decoded using coding system @var{wrong},
948 decoding it using coding system @var{right} instead.
949 @end table
950
951 @kindex C-x RET f
952 @findex set-buffer-file-coding-system
953 The command @kbd{C-x @key{RET} f}
954 (@code{set-buffer-file-coding-system}) sets the file coding system for
955 the current buffer (i.e., the coding system to use when saving or
956 reverting the file). You specify which coding system using the
957 minibuffer. You can also invoke this command by clicking with
958 @kbd{Mouse-3} on the coding system indicator in the mode line
959 (@pxref{Mode Line}).
960
961 If you specify a coding system that cannot handle all the characters
962 in the buffer, Emacs will warn you about the troublesome characters,
963 and ask you to choose another coding system, when you try to save the
964 buffer (@pxref{Output Coding}).
965
966 @cindex specify end-of-line conversion
967 You can also use this command to specify the end-of-line conversion
968 (@pxref{Coding Systems, end-of-line conversion}) for encoding the
969 current buffer. For example, @kbd{C-x @key{RET} f dos @key{RET}} will
970 cause Emacs to save the current buffer's text with DOS-style
971 carriage-return linefeed line endings.
972
973 @kindex C-x RET c
974 @findex universal-coding-system-argument
975 Another way to specify the coding system for a file is when you visit
976 the file. First use the command @kbd{C-x @key{RET} c}
977 (@code{universal-coding-system-argument}); this command uses the
978 minibuffer to read a coding system name. After you exit the minibuffer,
979 the specified coding system is used for @emph{the immediately following
980 command}.
981
982 So if the immediately following command is @kbd{C-x C-f}, for example,
983 it reads the file using that coding system (and records the coding
984 system for when you later save the file). Or if the immediately following
985 command is @kbd{C-x C-w}, it writes the file using that coding system.
986 When you specify the coding system for saving in this way, instead
987 of with @kbd{C-x @key{RET} f}, there is no warning if the buffer
988 contains characters that the coding system cannot handle.
989
990 Other file commands affected by a specified coding system include
991 @kbd{C-x i} and @kbd{C-x C-v}, as well as the other-window variants
992 of @kbd{C-x C-f}. @kbd{C-x @key{RET} c} also affects commands that
993 start subprocesses, including @kbd{M-x shell} (@pxref{Shell}). If the
994 immediately following command does not use the coding system, then
995 @kbd{C-x @key{RET} c} ultimately has no effect.
996
997 An easy way to visit a file with no conversion is with the @kbd{M-x
998 find-file-literally} command. @xref{Visiting}.
999
1000 The default value of the variable @code{buffer-file-coding-system}
1001 specifies the choice of coding system to use when you create a new file.
1002 It applies when you find a new file, and when you create a buffer and
1003 then save it in a file. Selecting a language environment typically sets
1004 this variable to a good choice of default coding system for that language
1005 environment.
1006
1007 @kindex C-x RET r
1008 @findex revert-buffer-with-coding-system
1009 If you visit a file with a wrong coding system, you can correct this
1010 with @kbd{C-x @key{RET} r} (@code{revert-buffer-with-coding-system}).
1011 This visits the current file again, using a coding system you specify.
1012
1013 @findex recode-region
1014 If a piece of text has already been inserted into a buffer using the
1015 wrong coding system, you can redo the decoding of it using @kbd{M-x
1016 recode-region}. This prompts you for the proper coding system, then
1017 for the wrong coding system that was actually used, and does the
1018 conversion. It first encodes the region using the wrong coding system,
1019 then decodes it again using the proper coding system.
1020
1021 @node Communication Coding
1022 @section Coding Systems for Interprocess Communication
1023
1024 This section explains how to specify coding systems for use
1025 in communication with other processes.
1026
1027 @table @kbd
1028 @item C-x @key{RET} x @var{coding} @key{RET}
1029 Use coding system @var{coding} for transferring selections to and from
1030 other graphical applications (@code{set-selection-coding-system}).
1031
1032 @item C-x @key{RET} X @var{coding} @key{RET}
1033 Use coding system @var{coding} for transferring @emph{one}
1034 selection---the next one---to or from another graphical application
1035 (@code{set-next-selection-coding-system}).
1036
1037 @item C-x @key{RET} p @var{input-coding} @key{RET} @var{output-coding} @key{RET}
1038 Use coding systems @var{input-coding} and @var{output-coding} for
1039 subprocess input and output in the current buffer
1040 (@code{set-buffer-process-coding-system}).
1041 @end table
1042
1043 @kindex C-x RET x
1044 @kindex C-x RET X
1045 @findex set-selection-coding-system
1046 @findex set-next-selection-coding-system
1047 The command @kbd{C-x @key{RET} x} (@code{set-selection-coding-system})
1048 specifies the coding system for sending selected text to other windowing
1049 applications, and for receiving the text of selections made in other
1050 applications. This command applies to all subsequent selections, until
1051 you override it by using the command again. The command @kbd{C-x
1052 @key{RET} X} (@code{set-next-selection-coding-system}) specifies the
1053 coding system for the next selection made in Emacs or read by Emacs.
1054
1055 @vindex x-select-request-type
1056 The variable @code{x-select-request-type} specifies the data type to
1057 request from the X Window System for receiving text selections from
1058 other applications. If the value is @code{nil} (the default), Emacs
1059 tries @code{UTF8_STRING} and @code{COMPOUND_TEXT}, in this order, and
1060 uses various heuristics to choose the more appropriate of the two
1061 results; if none of these succeed, Emacs falls back on @code{STRING}.
1062 If the value of @code{x-select-request-type} is one of the symbols
1063 @code{COMPOUND_TEXT}, @code{UTF8_STRING}, @code{STRING}, or
1064 @code{TEXT}, Emacs uses only that request type. If the value is a
1065 list of some of these symbols, Emacs tries only the request types in
1066 the list, in order, until one of them succeeds, or until the list is
1067 exhausted.
1068
1069 @kindex C-x RET p
1070 @findex set-buffer-process-coding-system
1071 The command @kbd{C-x @key{RET} p} (@code{set-buffer-process-coding-system})
1072 specifies the coding system for input and output to a subprocess. This
1073 command applies to the current buffer; normally, each subprocess has its
1074 own buffer, and thus you can use this command to specify translation to
1075 and from a particular subprocess by giving the command in the
1076 corresponding buffer.
1077
1078 You can also use @kbd{C-x @key{RET} c}
1079 (@code{universal-coding-system-argument}) just before the command that
1080 runs or starts a subprocess, to specify the coding system for
1081 communicating with that subprocess. @xref{Text Coding}.
1082
1083 The default for translation of process input and output depends on the
1084 current language environment.
1085
1086 @vindex locale-coding-system
1087 @cindex decoding non-@acronym{ASCII} keyboard input on X
1088 The variable @code{locale-coding-system} specifies a coding system
1089 to use when encoding and decoding system strings such as system error
1090 messages and @code{format-time-string} formats and time stamps. That
1091 coding system is also used for decoding non-@acronym{ASCII} keyboard
1092 input on the X Window System. You should choose a coding system that is compatible
1093 with the underlying system's text representation, which is normally
1094 specified by one of the environment variables @env{LC_ALL},
1095 @env{LC_CTYPE}, and @env{LANG}. (The first one, in the order
1096 specified above, whose value is nonempty is the one that determines
1097 the text representation.)
1098
1099 @node File Name Coding
1100 @section Coding Systems for File Names
1101
1102 @table @kbd
1103 @item C-x @key{RET} F @var{coding} @key{RET}
1104 Use coding system @var{coding} for encoding and decoding file
1105 names (@code{set-file-name-coding-system}).
1106 @end table
1107
1108 @findex set-file-name-coding-system
1109 @kindex C-x @key{RET} F
1110 @cindex file names with non-@acronym{ASCII} characters
1111 The command @kbd{C-x @key{RET} F} (@code{set-file-name-coding-system})
1112 specifies a coding system to use for encoding file @emph{names}. It
1113 has no effect on reading and writing the @emph{contents} of files.
1114
1115 @vindex file-name-coding-system
1116 In fact, all this command does is set the value of the variable
1117 @code{file-name-coding-system}. If you set the variable to a coding
1118 system name (as a Lisp symbol or a string), Emacs encodes file names
1119 using that coding system for all file operations. This makes it
1120 possible to use non-@acronym{ASCII} characters in file names---or, at
1121 least, those non-@acronym{ASCII} characters that the specified coding
1122 system can encode.
1123
1124 If @code{file-name-coding-system} is @code{nil}, Emacs uses a
1125 default coding system determined by the selected language environment,
1126 and stored in the @code{default-file-name-coding-system} variable.
1127 @c FIXME? Is this correct? What is the "default language environment"?
1128 In the default language environment, non-@acronym{ASCII} characters in
1129 file names are not encoded specially; they appear in the file system
1130 using the internal Emacs representation.
1131
1132 @cindex file-name encoding, MS-Windows
1133 @vindex w32-unicode-filenames
1134 When Emacs runs on MS-Windows versions that are descendants of the
1135 NT family (Windows 2000, XP, Vista, Windows 7, and Windows 8), the
1136 value of @code{file-name-coding-system} is largely ignored, as Emacs
1137 by default uses APIs that allow to pass Unicode file names directly.
1138 By contrast, on Windows 9X, file names are encoded using
1139 @code{file-name-coding-system}, which should be set to the codepage
1140 (@pxref{Coding Systems, codepage}) pertinent for the current system
1141 locale. The value of the variable @code{w32-unicode-filenames}
1142 controls whether Emacs uses the Unicode APIs when it calls OS
1143 functions that accept file names. This variable is set by the startup
1144 code to @code{nil} on Windows 9X, and to @code{t} on newer versions of
1145 MS-Windows.
1146
1147 @strong{Warning:} if you change @code{file-name-coding-system} (or the
1148 language environment) in the middle of an Emacs session, problems can
1149 result if you have already visited files whose names were encoded using
1150 the earlier coding system and cannot be encoded (or are encoded
1151 differently) under the new coding system. If you try to save one of
1152 these buffers under the visited file name, saving may use the wrong file
1153 name, or it may encounter an error. If such a problem happens, use @kbd{C-x
1154 C-w} to specify a new file name for that buffer.
1155
1156 @findex recode-file-name
1157 If a mistake occurs when encoding a file name, use the command
1158 @kbd{M-x recode-file-name} to change the file name's coding
1159 system. This prompts for an existing file name, its old coding
1160 system, and the coding system to which you wish to convert.
1161
1162 @node Terminal Coding
1163 @section Coding Systems for Terminal I/O
1164
1165 @table @kbd
1166 @item C-x @key{RET} t @var{coding} @key{RET}
1167 Use coding system @var{coding} for terminal output
1168 (@code{set-terminal-coding-system}).
1169
1170 @item C-x @key{RET} k @var{coding} @key{RET}
1171 Use coding system @var{coding} for keyboard input
1172 (@code{set-keyboard-coding-system}).
1173 @end table
1174
1175 @kindex C-x RET t
1176 @findex set-terminal-coding-system
1177 The command @kbd{C-x @key{RET} t} (@code{set-terminal-coding-system})
1178 specifies the coding system for terminal output. If you specify a
1179 character code for terminal output, all characters output to the
1180 terminal are translated into that coding system.
1181
1182 This feature is useful for certain character-only terminals built to
1183 support specific languages or character sets---for example, European
1184 terminals that support one of the ISO Latin character sets. You need to
1185 specify the terminal coding system when using multibyte text, so that
1186 Emacs knows which characters the terminal can actually handle.
1187
1188 By default, output to the terminal is not translated at all, unless
1189 Emacs can deduce the proper coding system from your terminal type or
1190 your locale specification (@pxref{Language Environments}).
1191
1192 @kindex C-x RET k
1193 @findex set-keyboard-coding-system
1194 @vindex keyboard-coding-system
1195 The command @kbd{C-x @key{RET} k} (@code{set-keyboard-coding-system}),
1196 or the variable @code{keyboard-coding-system}, specifies the coding
1197 system for keyboard input. Character-code translation of keyboard
1198 input is useful for terminals with keys that send non-@acronym{ASCII}
1199 graphic characters---for example, some terminals designed for ISO
1200 Latin-1 or subsets of it.
1201
1202 By default, keyboard input is translated based on your system locale
1203 setting. If your terminal does not really support the encoding
1204 implied by your locale (for example, if you find it inserts a
1205 non-@acronym{ASCII} character if you type @kbd{M-i}), you will need to set
1206 @code{keyboard-coding-system} to @code{nil} to turn off encoding.
1207 You can do this by putting
1208
1209 @lisp
1210 (set-keyboard-coding-system nil)
1211 @end lisp
1212
1213 @noindent
1214 in your init file.
1215
1216 There is a similarity between using a coding system translation for
1217 keyboard input, and using an input method: both define sequences of
1218 keyboard input that translate into single characters. However, input
1219 methods are designed to be convenient for interactive use by humans, and
1220 the sequences that are translated are typically sequences of @acronym{ASCII}
1221 printing characters. Coding systems typically translate sequences of
1222 non-graphic characters.
1223
1224 @node Fontsets
1225 @section Fontsets
1226 @cindex fontsets
1227
1228 A font typically defines shapes for a single alphabet or script.
1229 Therefore, displaying the entire range of scripts that Emacs supports
1230 requires a collection of many fonts. In Emacs, such a collection is
1231 called a @dfn{fontset}. A fontset is defined by a list of font specifications,
1232 each assigned to handle a range of character codes, and may fall back
1233 on another fontset for characters that are not covered by the fonts
1234 it specifies.
1235
1236 @cindex fonts for various scripts
1237 @cindex Intlfonts package, installation
1238 Each fontset has a name, like a font. However, while fonts are
1239 stored in the system and the available font names are defined by the
1240 system, fontsets are defined within Emacs itself. Once you have
1241 defined a fontset, you can use it within Emacs by specifying its name,
1242 anywhere that you could use a single font. Of course, Emacs fontsets
1243 can use only the fonts that the system supports. If some characters
1244 appear on the screen as empty boxes or hex codes, this means that the
1245 fontset in use for them has no font for those characters. In this
1246 case, or if the characters are shown, but not as well as you would
1247 like, you may need to install extra fonts. Your operating system may
1248 have optional fonts that you can install; or you can install the GNU
1249 Intlfonts package, which includes fonts for most supported
1250 scripts.@footnote{If you run Emacs on X, you may need to inform the X
1251 server about the location of the newly installed fonts with commands
1252 such as:
1253 @c FIXME? I feel like this may be out of date.
1254 @c E.g., the intlfonts tarfile is ~ 10 years old.
1255
1256 @example
1257 xset fp+ /usr/local/share/emacs/fonts
1258 xset fp rehash
1259 @end example
1260 }
1261
1262 Emacs creates three fontsets automatically: the @dfn{standard
1263 fontset}, the @dfn{startup fontset} and the @dfn{default fontset}.
1264 @c FIXME? The doc of *standard*-fontset-spec says:
1265 @c "You have the biggest chance to display international characters
1266 @c with correct glyphs by using the *standard* fontset." (my emphasis)
1267 @c See http://lists.gnu.org/archive/html/emacs-devel/2012-04/msg00430.html
1268 The default fontset is most likely to have fonts for a wide variety of
1269 non-@acronym{ASCII} characters, and is the default fallback for the
1270 other two fontsets, and if you set a default font rather than fontset.
1271 However, it does not specify font family names, so results can be
1272 somewhat random if you use it directly. You can specify use of a
1273 particular fontset by starting Emacs with the @samp{-fn} option.
1274 For example,
1275
1276 @example
1277 emacs -fn fontset-standard
1278 @end example
1279
1280 @noindent
1281 You can also specify a fontset with the @samp{Font} resource (@pxref{X
1282 Resources}).
1283
1284 If no fontset is specified for use, then Emacs uses an
1285 @acronym{ASCII} font, with @samp{fontset-default} as a fallback for
1286 characters the font does not cover. The standard fontset is only used if
1287 explicitly requested, despite its name.
1288
1289 A fontset does not necessarily specify a font for every character
1290 code. If a fontset specifies no font for a certain character, or if
1291 it specifies a font that does not exist on your system, then it cannot
1292 display that character properly. It will display that character as a
1293 hex code or thin space or an empty box instead. (@xref{Text Display, ,
1294 glyphless characters}, for details.)
1295
1296 @node Defining Fontsets
1297 @section Defining fontsets
1298
1299 @vindex standard-fontset-spec
1300 @vindex w32-standard-fontset-spec
1301 @vindex ns-standard-fontset-spec
1302 @cindex standard fontset
1303 When running on X, Emacs creates a standard fontset automatically according to the value
1304 of @code{standard-fontset-spec}. This fontset's name is
1305
1306 @example
1307 -*-fixed-medium-r-normal-*-16-*-*-*-*-*-fontset-standard
1308 @end example
1309
1310 @noindent
1311 or just @samp{fontset-standard} for short.
1312
1313 On GNUstep and Mac OS X, the standard fontset is created using the value of
1314 @code{ns-standard-fontset-spec}, and on MS Windows it is
1315 created using the value of @code{w32-standard-fontset-spec}.
1316
1317 @c FIXME? How does one access these, or do anything with them?
1318 @c Does it matter?
1319 Bold, italic, and bold-italic variants of the standard fontset are
1320 created automatically. Their names have @samp{bold} instead of
1321 @samp{medium}, or @samp{i} instead of @samp{r}, or both.
1322
1323 @cindex startup fontset
1324 Emacs generates a fontset automatically, based on any default
1325 @acronym{ASCII} font that you specify with the @samp{Font} resource or
1326 the @samp{-fn} argument, or the default font that Emacs found when it
1327 started. This is the @dfn{startup fontset} and its name is
1328 @code{fontset-startup}. It does this by replacing the
1329 @var{charset_registry} field with @samp{fontset}, and replacing
1330 @var{charset_encoding} field with @samp{startup}, then using the
1331 resulting string to specify a fontset.
1332
1333 For instance, if you start Emacs with a font of this form,
1334
1335 @c FIXME? I think this is a little misleading, because you cannot (?)
1336 @c actually specify a font with wildcards, it has to be a complete spec.
1337 @c Also, an X font specification of this form hasn't (?) been
1338 @c mentioned before now, and is somewhat obsolete these days.
1339 @c People are more likely to use a form like
1340 @c emacs -fn "DejaVu Sans Mono-12"
1341 @c How does any of this apply in that case?
1342 @example
1343 emacs -fn "*courier-medium-r-normal--14-140-*-iso8859-1"
1344 @end example
1345
1346 @noindent
1347 Emacs generates the following fontset and uses it for the initial X
1348 window frame:
1349
1350 @example
1351 -*-courier-medium-r-normal-*-14-140-*-*-*-*-fontset-startup
1352 @end example
1353
1354 The startup fontset will use the font that you specify, or a variant
1355 with a different registry and encoding, for all the characters that
1356 are supported by that font, and fallback on @samp{fontset-default} for
1357 other characters.
1358
1359 With the X resource @samp{Emacs.Font}, you can specify a fontset name
1360 just like an actual font name. But be careful not to specify a fontset
1361 name in a wildcard resource like @samp{Emacs*Font}---that wildcard
1362 specification matches various other resources, such as for menus, and
1363 @c FIXME is this still true?
1364 menus cannot handle fontsets. @xref{X Resources}.
1365
1366 You can specify additional fontsets using X resources named
1367 @samp{Fontset-@var{n}}, where @var{n} is an integer starting from 0.
1368 The resource value should have this form:
1369
1370 @smallexample
1371 @var{fontpattern}, @r{[}@var{charset}:@var{font}@r{]@dots{}}
1372 @end smallexample
1373
1374 @noindent
1375 @var{fontpattern} should have the form of a standard X font name (see
1376 the previous fontset-startup example), except
1377 for the last two fields. They should have the form
1378 @samp{fontset-@var{alias}}.
1379
1380 The fontset has two names, one long and one short. The long name is
1381 @var{fontpattern}. The short name is @samp{fontset-@var{alias}}. You
1382 can refer to the fontset by either name.
1383
1384 The construct @samp{@var{charset}:@var{font}} specifies which font to
1385 use (in this fontset) for one particular character set. Here,
1386 @var{charset} is the name of a character set, and @var{font} is the
1387 font to use for that character set. You can use this construct any
1388 number of times in defining one fontset.
1389
1390 For the other character sets, Emacs chooses a font based on
1391 @var{fontpattern}. It replaces @samp{fontset-@var{alias}} with values
1392 that describe the character set. For the @acronym{ASCII} character font,
1393 @samp{fontset-@var{alias}} is replaced with @samp{ISO8859-1}.
1394
1395 In addition, when several consecutive fields are wildcards, Emacs
1396 collapses them into a single wildcard. This is to prevent use of
1397 auto-scaled fonts. Fonts made by scaling larger fonts are not usable
1398 for editing, and scaling a smaller font is not also useful, because it is
1399 better to use the smaller font in its own size, which is what Emacs
1400 does.
1401
1402 Thus if @var{fontpattern} is this,
1403
1404 @example
1405 -*-fixed-medium-r-normal-*-24-*-*-*-*-*-fontset-24
1406 @end example
1407
1408 @noindent
1409 the font specification for @acronym{ASCII} characters would be this:
1410
1411 @example
1412 -*-fixed-medium-r-normal-*-24-*-ISO8859-1
1413 @end example
1414
1415 @noindent
1416 and the font specification for Chinese GB2312 characters would be this:
1417
1418 @example
1419 -*-fixed-medium-r-normal-*-24-*-gb2312*-*
1420 @end example
1421
1422 You may not have any Chinese font matching the above font
1423 specification. Most X distributions include only Chinese fonts that
1424 have @samp{song ti} or @samp{fangsong ti} in the @var{family} field. In
1425 such a case, @samp{Fontset-@var{n}} can be specified as:
1426
1427 @smallexample
1428 Emacs.Fontset-0: -*-fixed-medium-r-normal-*-24-*-*-*-*-*-fontset-24,\
1429 chinese-gb2312:-*-*-medium-r-normal-*-24-*-gb2312*-*
1430 @end smallexample
1431
1432 @noindent
1433 Then, the font specifications for all but Chinese GB2312 characters have
1434 @samp{fixed} in the @var{family} field, and the font specification for
1435 Chinese GB2312 characters has a wild card @samp{*} in the @var{family}
1436 field.
1437
1438 @findex create-fontset-from-fontset-spec
1439 The function that processes the fontset resource value to create the
1440 fontset is called @code{create-fontset-from-fontset-spec}. You can also
1441 call this function explicitly to create a fontset.
1442
1443 @xref{Fonts}, for more information about font naming.
1444
1445 @node Modifying Fontsets
1446 @section Modifying Fontsets
1447 @cindex fontsets, modifying
1448 @findex set-fontset-font
1449
1450 Fontsets do not always have to be created from scratch. If only
1451 minor changes are required it may be easier to modify an existing
1452 fontset. Modifying @samp{fontset-default} will also affect other
1453 fontsets that use it as a fallback, so can be an effective way of
1454 fixing problems with the fonts that Emacs chooses for a particular
1455 script.
1456
1457 Fontsets can be modified using the function @code{set-fontset-font},
1458 specifying a character, a charset, a script, or a range of characters
1459 to modify the font for, and a font specification for the font to be
1460 used. Some examples are:
1461
1462 @example
1463 ;; Use Liberation Mono for latin-3 charset.
1464 (set-fontset-font "fontset-default" 'iso-8859-3
1465 "Liberation Mono")
1466
1467 ;; Prefer a big5 font for han characters
1468 (set-fontset-font "fontset-default"
1469 'han (font-spec :registry "big5")
1470 nil 'prepend)
1471
1472 ;; Use DejaVu Sans Mono as a fallback in fontset-startup
1473 ;; before resorting to fontset-default.
1474 (set-fontset-font "fontset-startup" nil "DejaVu Sans Mono"
1475 nil 'append)
1476
1477 ;; Use MyPrivateFont for the Unicode private use area.
1478 (set-fontset-font "fontset-default" '(#xe000 . #xf8ff)
1479 "MyPrivateFont")
1480
1481 @end example
1482
1483
1484 @node Undisplayable Characters
1485 @section Undisplayable Characters
1486
1487 There may be some non-@acronym{ASCII} characters that your
1488 terminal cannot display. Most text terminals support just a single
1489 character set (use the variable @code{default-terminal-coding-system}
1490 to tell Emacs which one, @ref{Terminal Coding}); characters that
1491 can't be encoded in that coding system are displayed as @samp{?} by
1492 default.
1493
1494 Graphical displays can display a broader range of characters, but
1495 you may not have fonts installed for all of them; characters that have
1496 no font appear as a hollow box.
1497
1498 If you use Latin-1 characters but your terminal can't display
1499 Latin-1, you can arrange to display mnemonic @acronym{ASCII} sequences
1500 instead, e.g., @samp{"o} for o-umlaut. Load the library
1501 @file{iso-ascii} to do this.
1502
1503 @vindex latin1-display
1504 If your terminal can display Latin-1, you can display characters
1505 from other European character sets using a mixture of equivalent
1506 Latin-1 characters and @acronym{ASCII} mnemonics. Customize the variable
1507 @code{latin1-display} to enable this. The mnemonic @acronym{ASCII}
1508 sequences mostly correspond to those of the prefix input methods.
1509
1510 @node Unibyte Mode
1511 @section Unibyte Editing Mode
1512
1513 @cindex European character sets
1514 @cindex accented characters
1515 @cindex ISO Latin character sets
1516 @cindex Unibyte operation
1517 The ISO 8859 Latin-@var{n} character sets define character codes in
1518 the range 0240 to 0377 octal (160 to 255 decimal) to handle the
1519 accented letters and punctuation needed by various European languages
1520 (and some non-European ones). Note that Emacs considers bytes with
1521 codes in this range as raw bytes, not as characters, even in a unibyte
1522 buffer, i.e., if you disable multibyte characters. However, Emacs can
1523 still handle these character codes as if they belonged to @emph{one}
1524 of the single-byte character sets at a time. To specify @emph{which}
1525 of these codes to use, invoke @kbd{M-x set-language-environment} and
1526 specify a suitable language environment such as @samp{Latin-@var{n}}.
1527 @xref{Disabling Multibyte, , Disabling Multibyte Characters, elisp,
1528 GNU Emacs Lisp Reference Manual}.
1529
1530 @vindex unibyte-display-via-language-environment
1531 Emacs can also display bytes in the range 160 to 255 as readable
1532 characters, provided the terminal or font in use supports them. This
1533 works automatically. On a graphical display, Emacs can also display
1534 single-byte characters through fontsets, in effect by displaying the
1535 equivalent multibyte characters according to the current language
1536 environment. To request this, set the variable
1537 @code{unibyte-display-via-language-environment} to a non-@code{nil}
1538 value. Note that setting this only affects how these bytes are
1539 displayed, but does not change the fundamental fact that Emacs treats
1540 them as raw bytes, not as characters.
1541
1542 @cindex @code{iso-ascii} library
1543 If your terminal does not support display of the Latin-1 character
1544 set, Emacs can display these characters as @acronym{ASCII} sequences which at
1545 least give you a clear idea of what the characters are. To do this,
1546 load the library @code{iso-ascii}. Similar libraries for other
1547 Latin-@var{n} character sets could be implemented, but have not been
1548 so far.
1549
1550 @findex standard-display-8bit
1551 @cindex 8-bit display
1552 Normally non-ISO-8859 characters (decimal codes between 128 and 159
1553 inclusive) are displayed as octal escapes. You can change this for
1554 non-standard ``extended'' versions of ISO-8859 character sets by using the
1555 function @code{standard-display-8bit} in the @code{disp-table} library.
1556
1557 There are two ways to input single-byte non-@acronym{ASCII}
1558 characters:
1559
1560 @itemize @bullet
1561 @cindex 8-bit input
1562 @item
1563 You can use an input method for the selected language environment.
1564 @xref{Input Methods}. When you use an input method in a unibyte buffer,
1565 the non-@acronym{ASCII} character you specify with it is converted to unibyte.
1566
1567 @item
1568 If your keyboard can generate character codes 128 (decimal) and up,
1569 representing non-@acronym{ASCII} characters, you can type those character codes
1570 directly.
1571
1572 On a graphical display, you should not need to do anything special to
1573 use these keys; they should simply work. On a text terminal, you
1574 should use the command @code{M-x set-keyboard-coding-system} or customize the
1575 variable @code{keyboard-coding-system} to specify which coding system
1576 your keyboard uses (@pxref{Terminal Coding}). Enabling this feature
1577 will probably require you to use @kbd{ESC} to type Meta characters;
1578 however, on a console terminal or in @code{xterm}, you can arrange for
1579 Meta to be converted to @kbd{ESC} and still be able type 8-bit
1580 characters present directly on the keyboard or using @kbd{Compose} or
1581 @kbd{AltGr} keys. @xref{User Input}.
1582
1583 @kindex C-x 8
1584 @cindex @code{iso-transl} library
1585 @cindex compose character
1586 @cindex dead character
1587 @item
1588 For Latin-1 only, you can use the key @kbd{C-x 8} as a ``compose
1589 character'' prefix for entry of non-@acronym{ASCII} Latin-1 printing
1590 characters. @kbd{C-x 8} is good for insertion (in the minibuffer as
1591 well as other buffers), for searching, and in any other context where
1592 a key sequence is allowed.
1593
1594 @kbd{C-x 8} works by loading the @code{iso-transl} library. Once that
1595 library is loaded, the @key{ALT} modifier key, if the keyboard has
1596 one, serves the same purpose as @kbd{C-x 8}: use @key{ALT} together
1597 with an accent character to modify the following letter. In addition,
1598 if the keyboard has keys for the Latin-1 ``dead accent characters'',
1599 they too are defined to compose with the following character, once
1600 @code{iso-transl} is loaded.
1601
1602 Use @kbd{C-x 8 C-h} to list all the available @kbd{C-x 8} translations.
1603 @end itemize
1604
1605 @node Charsets
1606 @section Charsets
1607 @cindex charsets
1608
1609 In Emacs, @dfn{charset} is short for ``character set''. Emacs
1610 supports most popular charsets (such as @code{ascii},
1611 @code{iso-8859-1}, @code{cp1250}, @code{big5}, and @code{unicode}), in
1612 addition to some charsets of its own (such as @code{emacs},
1613 @code{unicode-bmp}, and @code{eight-bit}). All supported characters
1614 belong to one or more charsets.
1615
1616 Emacs normally ``does the right thing'' with respect to charsets, so
1617 that you don't have to worry about them. However, it is sometimes
1618 helpful to know some of the underlying details about charsets.
1619
1620 One example is font selection (@pxref{Fonts}). Each language
1621 environment (@pxref{Language Environments}) defines a ``priority
1622 list'' for the various charsets. When searching for a font, Emacs
1623 initially attempts to find one that can display the highest-priority
1624 charsets. For instance, in the Japanese language environment, the
1625 charset @code{japanese-jisx0208} has the highest priority, so Emacs
1626 tries to use a font whose @code{registry} property is
1627 @samp{JISX0208.1983-0}.
1628
1629 @findex list-charset-chars
1630 @cindex characters in a certain charset
1631 @findex describe-character-set
1632 There are two commands that can be used to obtain information about
1633 charsets. The command @kbd{M-x list-charset-chars} prompts for a
1634 charset name, and displays all the characters in that character set.
1635 The command @kbd{M-x describe-character-set} prompts for a charset
1636 name, and displays information about that charset, including its
1637 internal representation within Emacs.
1638
1639 @findex list-character-sets
1640 @kbd{M-x list-character-sets} displays a list of all supported
1641 charsets. The list gives the names of charsets and additional
1642 information to identity each charset; see the
1643 @url{http://www.itscj.ipsj.or.jp/ISO-IR/, International Register of
1644 Coded Character Sets} for more details. In this list,
1645 charsets are divided into two categories: @dfn{normal charsets} are
1646 listed first, followed by @dfn{supplementary charsets}. A
1647 supplementary charset is one that is used to define another charset
1648 (as a parent or a subset), or to provide backward-compatibility for
1649 older Emacs versions.
1650
1651 To find out which charset a character in the buffer belongs to, put
1652 point before it and type @kbd{C-u C-x =} (@pxref{International
1653 Chars}).
1654
1655 @node Bidirectional Editing
1656 @section Bidirectional Editing
1657 @cindex bidirectional editing
1658 @cindex right-to-left text
1659
1660 Emacs supports editing text written in scripts, such as Arabic and
1661 Hebrew, whose natural ordering of horizontal text for display is from
1662 right to left. However, digits and Latin text embedded in these
1663 scripts are still displayed left to right. It is also not uncommon to
1664 have small portions of text in Arabic or Hebrew embedded in an otherwise
1665 Latin document; e.g., as comments and strings in a program source
1666 file. For these reasons, text that uses these scripts is actually
1667 @dfn{bidirectional}: a mixture of runs of left-to-right and
1668 right-to-left characters.
1669
1670 This section describes the facilities and options provided by Emacs
1671 for editing bidirectional text.
1672
1673 @cindex logical order
1674 @cindex visual order
1675 Emacs stores right-to-left and bidirectional text in the so-called
1676 @dfn{logical} (or @dfn{reading}) order: the buffer or string position
1677 of the first character you read precedes that of the next character.
1678 Reordering of bidirectional text into the @dfn{visual} order happens
1679 at display time. As result, character positions no longer increase
1680 monotonically with their positions on display. Emacs implements the
1681 Unicode Bidirectional Algorithm described in the Unicode Standard
1682 Annex #9, for reordering of bidirectional text for display.
1683
1684 @vindex bidi-display-reordering
1685 The buffer-local variable @code{bidi-display-reordering} controls
1686 whether text in the buffer is reordered for display. If its value is
1687 non-@code{nil}, Emacs reorders characters that have right-to-left
1688 directionality when they are displayed. The default value is
1689 @code{t}.
1690
1691 @cindex base direction of paragraphs
1692 @cindex paragraph, base direction
1693 Each paragraph of bidirectional text can have its own @dfn{base
1694 direction}, either right-to-left or left-to-right. (Paragraph
1695 @c paragraph-separate etc have no influence on this?
1696 boundaries are empty lines, i.e., lines consisting entirely of
1697 whitespace characters.) Text in left-to-right paragraphs begins on
1698 the screen at the left margin of the window and is truncated or
1699 continued when it reaches the right margin. By contrast, text in
1700 right-to-left paragraphs is displayed starting at the right margin and
1701 is continued or truncated at the left margin.
1702
1703 @vindex bidi-paragraph-direction
1704 Emacs determines the base direction of each paragraph dynamically,
1705 based on the text at the beginning of the paragraph. However,
1706 sometimes a buffer may need to force a certain base direction for its
1707 paragraphs. The variable @code{bidi-paragraph-direction}, if
1708 non-@code{nil}, disables the dynamic determination of the base
1709 direction, and instead forces all paragraphs in the buffer to have the
1710 direction specified by its buffer-local value. The value can be either
1711 @code{right-to-left} or @code{left-to-right}. Any other value is
1712 interpreted as @code{nil}.
1713
1714 @cindex LRM
1715 @cindex RLM
1716 Alternatively, you can control the base direction of a paragraph by
1717 inserting special formatting characters in front of the paragraph.
1718 The special character @code{RIGHT-TO-LEFT MARK}, or @sc{rlm}, forces
1719 the right-to-left direction on the following paragraph, while
1720 @code{LEFT-TO-RIGHT MARK}, or @sc{lrm} forces the left-to-right
1721 direction. (You can use @kbd{C-x 8 RET} to insert these characters.)
1722 In a GUI session, the @sc{lrm} and @sc{rlm} characters display as very
1723 thin blank characters; on text terminals they display as blanks.
1724
1725 Because characters are reordered for display, Emacs commands that
1726 operate in the logical order or on stretches of buffer positions may
1727 produce unusual effects. For example, @kbd{C-f} and @kbd{C-b}
1728 commands move point in the logical order, so the cursor will sometimes
1729 jump when point traverses reordered bidirectional text. Similarly, a
1730 highlighted region covering a contiguous range of character positions
1731 may look discontinuous if the region spans reordered text. This is
1732 normal and similar to the behavior of other programs that support
1733 bidirectional text. If you set @code{visual-order-cursor-movement} to
1734 a non-@code{nil} value, cursor motion by the arrow keys follows the
1735 visual order on screen (@pxref{Moving Point, visual-order movement}).