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