Merge from emacs-23
[bpt/emacs.git] / doc / emacs / mule.texi
1 @c This is part of the Emacs manual.
2 @c Copyright (C) 1997, 1999, 2000, 2001, 2002, 2003, 2004,
3 @c 2005, 2006, 2007, 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
4 @c See file emacs.texi for copying conditions.
5 @node International, Major Modes, Frames, Top
6 @chapter International Character Set Support
7 @c This node is referenced in the tutorial. When renaming or deleting
8 @c it, the tutorial needs to be adjusted. (TUTORIAL.de)
9 @cindex MULE
10 @cindex international scripts
11 @cindex multibyte characters
12 @cindex encoding of characters
13
14 @cindex Celtic
15 @cindex Chinese
16 @cindex Cyrillic
17 @cindex Czech
18 @cindex Devanagari
19 @cindex Hindi
20 @cindex Marathi
21 @cindex Ethiopic
22 @cindex German
23 @cindex Greek
24 @cindex Hebrew
25 @cindex IPA
26 @cindex Japanese
27 @cindex Korean
28 @cindex Lao
29 @cindex Latin
30 @cindex Polish
31 @cindex Romanian
32 @cindex Slovak
33 @cindex Slovenian
34 @cindex Thai
35 @cindex Tibetan
36 @cindex Turkish
37 @cindex Vietnamese
38 @cindex Dutch
39 @cindex Spanish
40 Emacs supports a wide variety of international character sets,
41 including European and Vietnamese variants of the Latin alphabet, as
42 well as Cyrillic, Devanagari (for Hindi and Marathi), Ethiopic, Greek,
43 Han (for Chinese and Japanese), Hangul (for Korean), Hebrew, IPA,
44 Kannada, Lao, Malayalam, Tamil, Thai, Tibetan, and Vietnamese scripts.
45 Emacs also supports various encodings of these characters used by
46 other internationalized software, such as word processors and mailers.
47
48 Emacs allows editing text with international characters by supporting
49 all the related activities:
50
51 @itemize @bullet
52 @item
53 You can visit files with non-@acronym{ASCII} characters, save non-@acronym{ASCII} text, and
54 pass non-@acronym{ASCII} text between Emacs and programs it invokes (such as
55 compilers, spell-checkers, and mailers). Setting your language
56 environment (@pxref{Language Environments}) takes care of setting up the
57 coding systems and other options for a specific language or culture.
58 Alternatively, you can specify how Emacs should encode or decode text
59 for each command; see @ref{Text Coding}.
60
61 @item
62 You can display non-@acronym{ASCII} characters encoded by the various
63 scripts. This works by using appropriate fonts on graphics displays
64 (@pxref{Defining Fontsets}), and by sending special codes to text-only
65 displays (@pxref{Terminal Coding}). If some characters are displayed
66 incorrectly, refer to @ref{Undisplayable Characters}, which describes
67 possible problems and explains how to solve them.
68
69 @item
70 Characters from scripts whose natural ordering of text is from right
71 to left are reordered for display (@pxref{Bidirectional Editing}).
72 These scripts include Arabic, Hebrew, Syriac, Thaana, and a few
73 others.
74
75 @item
76 You can insert non-@acronym{ASCII} characters or search for them. To do that,
77 you can specify an input method (@pxref{Select Input Method}) suitable
78 for your language, or use the default input method set up when you set
79 your language environment. If
80 your keyboard can produce non-@acronym{ASCII} characters, you can select an
81 appropriate keyboard coding system (@pxref{Terminal Coding}), and Emacs
82 will accept those characters. Latin-1 characters can also be input by
83 using the @kbd{C-x 8} prefix, see @ref{Unibyte Mode}.
84
85 On X Window systems, your locale should be set to an appropriate value
86 to make sure Emacs interprets keyboard input correctly; see
87 @ref{Language Environments, locales}.
88 @end itemize
89
90 The rest of this chapter describes these issues in detail.
91
92 @menu
93 * International Chars:: Basic concepts of multibyte characters.
94 * Enabling Multibyte:: Controlling whether to use multibyte characters.
95 * Language Environments:: Setting things up for the language you use.
96 * Input Methods:: Entering text characters not on your keyboard.
97 * Select Input Method:: Specifying your choice of input methods.
98 * Coding Systems:: Character set conversion when you read and
99 write files, and so on.
100 * Recognize Coding:: How Emacs figures out which conversion to use.
101 * Specify Coding:: Specifying a file's coding system explicitly.
102 * Output Coding:: Choosing coding systems for output.
103 * Text Coding:: Choosing conversion to use for file text.
104 * Communication Coding:: Coding systems for interprocess communication.
105 * File Name Coding:: Coding systems for file @emph{names}.
106 * Terminal Coding:: Specifying coding systems for converting
107 terminal input and output.
108 * Fontsets:: Fontsets are collections of fonts
109 that cover the whole spectrum of characters.
110 * Defining Fontsets:: Defining a new fontset.
111 * Modifying Fontsets:: Modifying an existing fontset.
112 * Undisplayable Characters:: When characters don't display.
113 * Unibyte Mode:: You can pick one European character set
114 to use without multibyte characters.
115 * Charsets:: How Emacs groups its internal character codes.
116 * Bidirectional Editing:: Support for right-to-left scripts.
117 @end menu
118
119 @node International Chars
120 @section Introduction to International Character Sets
121
122 The users of international character sets and scripts have
123 established many more-or-less standard coding systems for storing
124 files. These coding systems are typically @dfn{multibyte}, meaning
125 that sequences of two or more bytes are used to represent individual
126 non-@acronym{ASCII} characters.
127
128 @cindex Unicode
129 Internally, Emacs uses its own multibyte character encoding, which
130 is a superset of the @dfn{Unicode} standard. This internal encoding
131 allows characters from almost every known script to be intermixed in a
132 single buffer or string. Emacs translates between the multibyte
133 character encoding and various other coding systems when reading and
134 writing files, and when exchanging data with subprocesses.
135
136 @kindex C-h h
137 @findex view-hello-file
138 @cindex undisplayable characters
139 @cindex @samp{?} in display
140 The command @kbd{C-h h} (@code{view-hello-file}) displays the file
141 @file{etc/HELLO}, which shows how to say ``hello'' in many languages.
142 This illustrates various scripts. If some characters can't be
143 displayed on your terminal, they appear as @samp{?} or as hollow boxes
144 (@pxref{Undisplayable Characters}).
145
146 Keyboards, even in the countries where these character sets are
147 used, generally don't have keys for all the characters in them. You
148 can insert characters that your keyboard does not support, using
149 @kbd{C-q} (@code{quoted-insert}) or @kbd{C-x 8 @key{RET}}
150 (@code{ucs-insert}). @xref{Inserting Text}. Emacs also supports
151 various @dfn{input methods}, typically one for each script or
152 language, which make it easier to type characters in the script.
153 @xref{Input Methods}.
154
155 @kindex C-x RET
156 The prefix key @kbd{C-x @key{RET}} is used for commands that pertain
157 to multibyte characters, coding systems, and input methods.
158
159 @kindex C-x =
160 @findex what-cursor-position
161 The command @kbd{C-x =} (@code{what-cursor-position}) shows
162 information about the character at point. In addition to the
163 character position, which was described in @ref{Position Info}, this
164 command displays how the character is encoded. For instance, it
165 displays the following line in the echo area for the character
166 @samp{c}:
167
168 @smallexample
169 Char: c (99, #o143, #x63) point=28062 of 36168 (78%) column=53
170 @end smallexample
171
172 The four values after @samp{Char:} describe the character that
173 follows point, first by showing it and then by giving its character
174 code in decimal, octal and hex. For a non-@acronym{ASCII} multibyte
175 character, these are followed by @samp{file} and the character's
176 representation, in hex, in the buffer's coding system, if that coding
177 system encodes the character safely and with a single byte
178 (@pxref{Coding Systems}). If the character's encoding is longer than
179 one byte, Emacs shows @samp{file ...}.
180
181 As a special case, if the character lies in the range 128 (0200
182 octal) through 159 (0237 octal), it stands for a ``raw'' byte that
183 does not correspond to any specific displayable character. Such a
184 ``character'' lies within the @code{eight-bit-control} character set,
185 and is displayed as an escaped octal character code. In this case,
186 @kbd{C-x =} shows @samp{part of display ...} instead of @samp{file}.
187
188 @cindex character set of character at point
189 @cindex font of character at point
190 @cindex text properties at point
191 @cindex face at point
192 With a prefix argument (@kbd{C-u C-x =}), this command displays a
193 detailed description of the character in a window:
194
195 @itemize @bullet
196 @item
197 The character set name, and the codes that identify the character
198 within that character set; @acronym{ASCII} characters are identified
199 as belonging to the @code{ascii} character set.
200
201 @item
202 The character's syntax and categories.
203
204 @item
205 The character's encodings, both internally in the buffer, and externally
206 if you were to save the file.
207
208 @item
209 What keys to type to input the character in the current input method
210 (if it supports the character).
211
212 @item
213 If you are running Emacs on a graphical display, the font name and
214 glyph code for the character. If you are running Emacs on a text-only
215 terminal, the code(s) sent to the terminal.
216
217 @item
218 The character's text properties (@pxref{Text Properties,,,
219 elisp, the Emacs Lisp Reference Manual}), including any non-default
220 faces used to display the character, and any overlays containing it
221 (@pxref{Overlays,,, elisp, the same manual}).
222 @end itemize
223
224 Here's an example showing the Latin-1 character A with grave accent,
225 in a buffer whose coding system is @code{utf-8-unix}:
226
227 @smallexample
228 character: @`A (192, #o300, #xc0)
229 preferred charset: unicode (Unicode (ISO10646))
230 code point: 0xC0
231 syntax: w which means: word
232 category: j:Japanese l:Latin v:Vietnamese
233 buffer code: #xC3 #x80
234 file code: not encodable by coding system undecided-unix
235 display: by this font (glyph code)
236 xft:-unknown-DejaVu Sans Mono-normal-normal-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 the variable
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 To see a list of all the supported input methods, type @kbd{M-x
653 list-input-methods}. The list gives information about each input
654 method, 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 The coding system @code{raw-text} is good for a file which is mainly
765 @acronym{ASCII} text, but may contain byte values above 127 which are
766 not meant to encode non-@acronym{ASCII} characters. With
767 @code{raw-text}, Emacs copies those byte values unchanged, and sets
768 @code{enable-multibyte-characters} to @code{nil} in the current buffer
769 so that they will be interpreted properly. @code{raw-text} handles
770 end-of-line conversion in the usual way, based on the data
771 encountered, and has the usual three variants to specify the kind of
772 end-of-line conversion to use.
773
774 In contrast, the coding system @code{no-conversion} specifies no
775 character code conversion at all---none for non-@acronym{ASCII} byte values and
776 none for end of line. This is useful for reading or writing binary
777 files, tar files, and other files that must be examined verbatim. It,
778 too, sets @code{enable-multibyte-characters} to @code{nil}.
779
780 The easiest way to edit a file with no conversion of any kind is with
781 the @kbd{M-x find-file-literally} command. This uses
782 @code{no-conversion}, and also suppresses other Emacs features that
783 might convert the file contents before you see them. @xref{Visiting}.
784
785 The coding system @code{emacs-internal} (or @code{utf-8-emacs},
786 which is equivalent) means that the file contains non-@acronym{ASCII}
787 characters stored with the internal Emacs encoding. This coding
788 system handles end-of-line conversion based on the data encountered,
789 and has the usual three variants to specify the kind of end-of-line
790 conversion.
791
792 @node Recognize Coding
793 @section Recognizing Coding Systems
794
795 Whenever Emacs reads a given piece of text, it tries to recognize
796 which coding system to use. This applies to files being read, output
797 from subprocesses, text from X selections, etc. Emacs can select the
798 right coding system automatically most of the time---once you have
799 specified your preferences.
800
801 Some coding systems can be recognized or distinguished by which byte
802 sequences appear in the data. However, there are coding systems that
803 cannot be distinguished, not even potentially. For example, there is no
804 way to distinguish between Latin-1 and Latin-2; they use the same byte
805 values with different meanings.
806
807 Emacs handles this situation by means of a priority list of coding
808 systems. Whenever Emacs reads a file, if you do not specify the coding
809 system to use, Emacs checks the data against each coding system,
810 starting with the first in priority and working down the list, until it
811 finds a coding system that fits the data. Then it converts the file
812 contents assuming that they are represented in this coding system.
813
814 The priority list of coding systems depends on the selected language
815 environment (@pxref{Language Environments}). For example, if you use
816 French, you probably want Emacs to prefer Latin-1 to Latin-2; if you use
817 Czech, you probably want Latin-2 to be preferred. This is one of the
818 reasons to specify a language environment.
819
820 @findex prefer-coding-system
821 However, you can alter the coding system priority list in detail
822 with the command @kbd{M-x prefer-coding-system}. This command reads
823 the name of a coding system from the minibuffer, and adds it to the
824 front of the priority list, so that it is preferred to all others. If
825 you use this command several times, each use adds one element to the
826 front of the priority list.
827
828 If you use a coding system that specifies the end-of-line conversion
829 type, such as @code{iso-8859-1-dos}, what this means is that Emacs
830 should attempt to recognize @code{iso-8859-1} with priority, and should
831 use DOS end-of-line conversion when it does recognize @code{iso-8859-1}.
832
833 @vindex file-coding-system-alist
834 Sometimes a file name indicates which coding system to use for the
835 file. The variable @code{file-coding-system-alist} specifies this
836 correspondence. There is a special function
837 @code{modify-coding-system-alist} for adding elements to this list. For
838 example, to read and write all @samp{.txt} files using the coding system
839 @code{chinese-iso-8bit}, you can execute this Lisp expression:
840
841 @smallexample
842 (modify-coding-system-alist 'file "\\.txt\\'" 'chinese-iso-8bit)
843 @end smallexample
844
845 @noindent
846 The first argument should be @code{file}, the second argument should be
847 a regular expression that determines which files this applies to, and
848 the third argument says which coding system to use for these files.
849
850 @vindex inhibit-eol-conversion
851 @cindex DOS-style end-of-line display
852 Emacs recognizes which kind of end-of-line conversion to use based on
853 the contents of the file: if it sees only carriage-returns, or only
854 carriage-return linefeed sequences, then it chooses the end-of-line
855 conversion accordingly. You can inhibit the automatic use of
856 end-of-line conversion by setting the variable @code{inhibit-eol-conversion}
857 to non-@code{nil}. If you do that, DOS-style files will be displayed
858 with the @samp{^M} characters visible in the buffer; some people
859 prefer this to the more subtle @samp{(DOS)} end-of-line type
860 indication near the left edge of the mode line (@pxref{Mode Line,
861 eol-mnemonic}).
862
863 @vindex inhibit-iso-escape-detection
864 @cindex escape sequences in files
865 By default, the automatic detection of coding system is sensitive to
866 escape sequences. If Emacs sees a sequence of characters that begin
867 with an escape character, and the sequence is valid as an ISO-2022
868 code, that tells Emacs to use one of the ISO-2022 encodings to decode
869 the file.
870
871 However, there may be cases that you want to read escape sequences
872 in a file as is. In such a case, you can set the variable
873 @code{inhibit-iso-escape-detection} to non-@code{nil}. Then the code
874 detection ignores any escape sequences, and never uses an ISO-2022
875 encoding. The result is that all escape sequences become visible in
876 the buffer.
877
878 The default value of @code{inhibit-iso-escape-detection} is
879 @code{nil}. We recommend that you not change it permanently, only for
880 one specific operation. That's because many Emacs Lisp source files
881 in the Emacs distribution contain non-@acronym{ASCII} characters encoded in the
882 coding system @code{iso-2022-7bit}, and they won't be
883 decoded correctly when you visit those files if you suppress the
884 escape sequence detection.
885
886 @vindex auto-coding-alist
887 @vindex auto-coding-regexp-alist
888 @vindex auto-coding-functions
889 The variables @code{auto-coding-alist},
890 @code{auto-coding-regexp-alist} and @code{auto-coding-functions} are
891 the strongest way to specify the coding system for certain patterns of
892 file names, or for files containing certain patterns; these variables
893 even override @samp{-*-coding:-*-} tags in the file itself. Emacs
894 uses @code{auto-coding-alist} for tar and archive files, to prevent it
895 from being confused by a @samp{-*-coding:-*-} tag in a member of the
896 archive and thinking it applies to the archive file as a whole.
897 Likewise, Emacs uses @code{auto-coding-regexp-alist} to ensure that
898 RMAIL files, whose names in general don't match any particular
899 pattern, are decoded correctly. One of the builtin
900 @code{auto-coding-functions} detects the encoding for XML files.
901
902 @vindex rmail-decode-mime-charset
903 @vindex rmail-file-coding-system
904 When you get new mail in Rmail, each message is translated
905 automatically from the coding system it is written in, as if it were a
906 separate file. This uses the priority list of coding systems that you
907 have specified. If a MIME message specifies a character set, Rmail
908 obeys that specification, unless @code{rmail-decode-mime-charset} is
909 @code{nil}. For reading and saving Rmail files themselves, Emacs uses
910 the coding system specified by the variable
911 @code{rmail-file-coding-system}. The default value is @code{nil},
912 which means that Rmail files are not translated (they are read and
913 written in the Emacs internal character code).
914
915 @node Specify Coding
916 @section Specifying a File's Coding System
917
918 If Emacs recognizes the encoding of a file incorrectly, you can
919 reread the file using the correct coding system by typing @kbd{C-x
920 @key{RET} r @var{coding-system} @key{RET}}. To see what coding system
921 Emacs actually used to decode the file, look at the coding system
922 mnemonic letter near the left edge of the mode line (@pxref{Mode
923 Line}), or type @kbd{C-h C @key{RET}}.
924
925 @vindex coding
926 You can specify the coding system for a particular file in the file
927 itself, using the @w{@samp{-*-@dots{}-*-}} construct at the beginning,
928 or a local variables list at the end (@pxref{File Variables}). You do
929 this by defining a value for the ``variable'' named @code{coding}.
930 Emacs does not really have a variable @code{coding}; instead of
931 setting a variable, this uses the specified coding system for the
932 file. For example, @samp{-*-mode: C; coding: latin-1;-*-} specifies
933 use of the Latin-1 coding system, as well as C mode. When you specify
934 the coding explicitly in the file, that overrides
935 @code{file-coding-system-alist}.
936
937 @node Output Coding
938 @section Choosing Coding Systems for Output
939
940 @vindex buffer-file-coding-system
941 Once Emacs has chosen a coding system for a buffer, it stores that
942 coding system in @code{buffer-file-coding-system}. That makes it the
943 default for operations that write from this buffer into a file, such
944 as @code{save-buffer} and @code{write-region}. You can specify a
945 different coding system for further file output from the buffer using
946 @code{set-buffer-file-coding-system} (@pxref{Text Coding}).
947
948 You can insert any character Emacs supports into any Emacs buffer,
949 but most coding systems can only handle a subset of these characters.
950 Therefore, it's possible that the characters you insert cannot be
951 encoded with the coding system that will be used to save the buffer.
952 For example, you could visit a text file in Polish, encoded in
953 @code{iso-8859-2}, and add some Russian words to it. When you save
954 that buffer, Emacs cannot use the current value of
955 @code{buffer-file-coding-system}, because the characters you added
956 cannot be encoded by that coding system.
957
958 When that happens, Emacs tries the most-preferred coding system (set
959 by @kbd{M-x prefer-coding-system} or @kbd{M-x
960 set-language-environment}). If that coding system can safely encode
961 all of the characters in the buffer, Emacs uses it, and stores its
962 value in @code{buffer-file-coding-system}. Otherwise, Emacs displays
963 a list of coding systems suitable for encoding the buffer's contents,
964 and asks you to choose one of those coding systems.
965
966 If you insert the unsuitable characters in a mail message, Emacs
967 behaves a bit differently. It additionally checks whether the
968 most-preferred coding system is recommended for use in MIME messages;
969 if not, Emacs tells you that the most-preferred coding system is not
970 recommended and prompts you for another coding system. This is so you
971 won't inadvertently send a message encoded in a way that your
972 recipient's mail software will have difficulty decoding. (You can
973 still use an unsuitable coding system if you type its name in response
974 to the question.)
975
976 @vindex sendmail-coding-system
977 When you send a message with Message mode (@pxref{Sending Mail}),
978 Emacs has four different ways to determine the coding system to use
979 for encoding the message text. It tries the buffer's own value of
980 @code{buffer-file-coding-system}, if that is non-@code{nil}.
981 Otherwise, it uses the value of @code{sendmail-coding-system}, if that
982 is non-@code{nil}. The third way is to use the default coding system
983 for new files, which is controlled by your choice of language
984 environment, if that is non-@code{nil}. If all of these three values
985 are @code{nil}, Emacs encodes outgoing mail using the Latin-1 coding
986 system.
987
988 @node Text Coding
989 @section Specifying a Coding System for File Text
990
991 In cases where Emacs does not automatically choose the right coding
992 system for a file's contents, you can use these commands to specify
993 one:
994
995 @table @kbd
996 @item C-x @key{RET} f @var{coding} @key{RET}
997 Use coding system @var{coding} for saving or revisiting the visited
998 file in the current buffer.
999
1000 @item C-x @key{RET} c @var{coding} @key{RET}
1001 Specify coding system @var{coding} for the immediately following
1002 command.
1003
1004 @item C-x @key{RET} r @var{coding} @key{RET}
1005 Revisit the current file using the coding system @var{coding}.
1006
1007 @item M-x recode-region @key{RET} @var{right} @key{RET} @var{wrong} @key{RET}
1008 Convert a region that was decoded using coding system @var{wrong},
1009 decoding it using coding system @var{right} instead.
1010 @end table
1011
1012 @kindex C-x RET f
1013 @findex set-buffer-file-coding-system
1014 The command @kbd{C-x @key{RET} f}
1015 (@code{set-buffer-file-coding-system}) sets the file coding system for
1016 the current buffer---in other words, it says which coding system to
1017 use when saving or reverting the visited file. You specify which
1018 coding system using the minibuffer. If you specify a coding system
1019 that cannot handle all of the characters in the buffer, Emacs warns
1020 you about the troublesome characters when you actually save the
1021 buffer.
1022
1023 @cindex specify end-of-line conversion
1024 You can also use this command to specify the end-of-line conversion
1025 (@pxref{Coding Systems, end-of-line conversion}) for encoding the
1026 current buffer. For example, @kbd{C-x @key{RET} f dos @key{RET}} will
1027 cause Emacs to save the current buffer's text with DOS-style CRLF line
1028 endings.
1029
1030 @kindex C-x RET c
1031 @findex universal-coding-system-argument
1032 Another way to specify the coding system for a file is when you visit
1033 the file. First use the command @kbd{C-x @key{RET} c}
1034 (@code{universal-coding-system-argument}); this command uses the
1035 minibuffer to read a coding system name. After you exit the minibuffer,
1036 the specified coding system is used for @emph{the immediately following
1037 command}.
1038
1039 So if the immediately following command is @kbd{C-x C-f}, for example,
1040 it reads the file using that coding system (and records the coding
1041 system for when you later save the file). Or if the immediately following
1042 command is @kbd{C-x C-w}, it writes the file using that coding system.
1043 When you specify the coding system for saving in this way, instead
1044 of with @kbd{C-x @key{RET} f}, there is no warning if the buffer
1045 contains characters that the coding system cannot handle.
1046
1047 Other file commands affected by a specified coding system include
1048 @kbd{C-x i} and @kbd{C-x C-v}, as well as the other-window variants
1049 of @kbd{C-x C-f}. @kbd{C-x @key{RET} c} also affects commands that
1050 start subprocesses, including @kbd{M-x shell} (@pxref{Shell}). If the
1051 immediately following command does not use the coding system, then
1052 @kbd{C-x @key{RET} c} ultimately has no effect.
1053
1054 An easy way to visit a file with no conversion is with the @kbd{M-x
1055 find-file-literally} command. @xref{Visiting}.
1056
1057 The default value of the variable @code{buffer-file-coding-system}
1058 specifies the choice of coding system to use when you create a new file.
1059 It applies when you find a new file, and when you create a buffer and
1060 then save it in a file. Selecting a language environment typically sets
1061 this variable to a good choice of default coding system for that language
1062 environment.
1063
1064 @kindex C-x RET r
1065 @findex revert-buffer-with-coding-system
1066 If you visit a file with a wrong coding system, you can correct this
1067 with @kbd{C-x @key{RET} r} (@code{revert-buffer-with-coding-system}).
1068 This visits the current file again, using a coding system you specify.
1069
1070 @findex recode-region
1071 If a piece of text has already been inserted into a buffer using the
1072 wrong coding system, you can redo the decoding of it using @kbd{M-x
1073 recode-region}. This prompts you for the proper coding system, then
1074 for the wrong coding system that was actually used, and does the
1075 conversion. It first encodes the region using the wrong coding system,
1076 then decodes it again using the proper coding system.
1077
1078 @node Communication Coding
1079 @section Coding Systems for Interprocess Communication
1080
1081 This section explains how to specify coding systems for use
1082 in communication with other processes.
1083
1084 @table @kbd
1085 @item C-x @key{RET} x @var{coding} @key{RET}
1086 Use coding system @var{coding} for transferring selections to and from
1087 other window-based applications.
1088
1089 @item C-x @key{RET} X @var{coding} @key{RET}
1090 Use coding system @var{coding} for transferring @emph{one}
1091 selection---the next one---to or from another window-based application.
1092
1093 @item C-x @key{RET} p @var{input-coding} @key{RET} @var{output-coding} @key{RET}
1094 Use coding systems @var{input-coding} and @var{output-coding} for
1095 subprocess input and output in the current buffer.
1096
1097 @item C-x @key{RET} c @var{coding} @key{RET}
1098 Specify coding system @var{coding} for the immediately following
1099 command.
1100 @end table
1101
1102 @kindex C-x RET x
1103 @kindex C-x RET X
1104 @findex set-selection-coding-system
1105 @findex set-next-selection-coding-system
1106 The command @kbd{C-x @key{RET} x} (@code{set-selection-coding-system})
1107 specifies the coding system for sending selected text to other windowing
1108 applications, and for receiving the text of selections made in other
1109 applications. This command applies to all subsequent selections, until
1110 you override it by using the command again. The command @kbd{C-x
1111 @key{RET} X} (@code{set-next-selection-coding-system}) specifies the
1112 coding system for the next selection made in Emacs or read by Emacs.
1113
1114 @vindex x-select-request-type
1115 The variable @code{x-select-request-type} specifies the data type to
1116 request from the X Window System for receiving text selections from
1117 other applications. If the value is @code{nil} (the default), Emacs
1118 tries @code{COMPOUND_TEXT} and @code{UTF8_STRING}, in this order, and
1119 uses various heuristics to choose the more appropriate of the two
1120 results; if none of these succeed, Emacs falls back on @code{STRING}.
1121 If the value of @code{x-select-request-type} is one of the symbols
1122 @code{COMPOUND_TEXT}, @code{UTF8_STRING}, @code{STRING}, or
1123 @code{TEXT}, Emacs uses only that request type. If the value is a
1124 list of some of these symbols, Emacs tries only the request types in
1125 the list, in order, until one of them succeeds, or until the list is
1126 exhausted.
1127
1128 @kindex C-x RET p
1129 @findex set-buffer-process-coding-system
1130 The command @kbd{C-x @key{RET} p} (@code{set-buffer-process-coding-system})
1131 specifies the coding system for input and output to a subprocess. This
1132 command applies to the current buffer; normally, each subprocess has its
1133 own buffer, and thus you can use this command to specify translation to
1134 and from a particular subprocess by giving the command in the
1135 corresponding buffer.
1136
1137 You can also use @kbd{C-x @key{RET} c} just before the command that
1138 runs or starts a subprocess, to specify the coding system to use for
1139 communication with that subprocess.
1140
1141 The default for translation of process input and output depends on the
1142 current language environment.
1143
1144 @vindex locale-coding-system
1145 @cindex decoding non-@acronym{ASCII} keyboard input on X
1146 The variable @code{locale-coding-system} specifies a coding system
1147 to use when encoding and decoding system strings such as system error
1148 messages and @code{format-time-string} formats and time stamps. That
1149 coding system is also used for decoding non-@acronym{ASCII} keyboard input on X
1150 Window systems. You should choose a coding system that is compatible
1151 with the underlying system's text representation, which is normally
1152 specified by one of the environment variables @env{LC_ALL},
1153 @env{LC_CTYPE}, and @env{LANG}. (The first one, in the order
1154 specified above, whose value is nonempty is the one that determines
1155 the text representation.)
1156
1157 @vindex x-select-request-type
1158 The variable @code{x-select-request-type} specifies a selection data
1159 type of selection to request from the X server. The default value is
1160 @code{nil}, which means Emacs tries @code{COMPOUND_TEXT} and
1161 @code{UTF8_STRING}, and uses whichever result seems more appropriate.
1162 You can explicitly specify the data type by setting the variable to
1163 one of the symbols @code{COMPOUND_TEXT}, @code{UTF8_STRING},
1164 @code{STRING} and @code{TEXT}.
1165
1166 @node File Name Coding
1167 @section Coding Systems for File Names
1168
1169 @table @kbd
1170 @item C-x @key{RET} F @var{coding} @key{RET}
1171 Use coding system @var{coding} for encoding and decoding file
1172 @emph{names}.
1173 @end table
1174
1175 @vindex file-name-coding-system
1176 @cindex file names with non-@acronym{ASCII} characters
1177 The variable @code{file-name-coding-system} specifies a coding
1178 system to use for encoding file names. It has no effect on reading
1179 and writing the @emph{contents} of files.
1180
1181 @findex set-file-name-coding-system
1182 @kindex C-x @key{RET} F
1183 If you set the variable to a coding system name (as a Lisp symbol or
1184 a string), Emacs encodes file names using that coding system for all
1185 file operations. This makes it possible to use non-@acronym{ASCII}
1186 characters in file names---or, at least, those non-@acronym{ASCII}
1187 characters which the specified coding system can encode. Use @kbd{C-x
1188 @key{RET} F} (@code{set-file-name-coding-system}) to specify this
1189 interactively.
1190
1191 If @code{file-name-coding-system} is @code{nil}, Emacs uses a
1192 default coding system determined by the selected language environment.
1193 In the default language environment, non-@acronym{ASCII} characters in
1194 file names are not encoded specially; they appear in the file system
1195 using the internal Emacs representation.
1196
1197 @strong{Warning:} if you change @code{file-name-coding-system} (or the
1198 language environment) in the middle of an Emacs session, problems can
1199 result if you have already visited files whose names were encoded using
1200 the earlier coding system and cannot be encoded (or are encoded
1201 differently) under the new coding system. If you try to save one of
1202 these buffers under the visited file name, saving may use the wrong file
1203 name, or it may get an error. If such a problem happens, use @kbd{C-x
1204 C-w} to specify a new file name for that buffer.
1205
1206 @findex recode-file-name
1207 If a mistake occurs when encoding a file name, use the command
1208 @kbd{M-x recode-file-name} to change the file name's coding
1209 system. This prompts for an existing file name, its old coding
1210 system, and the coding system to which you wish to convert.
1211
1212 @node Terminal Coding
1213 @section Coding Systems for Terminal I/O
1214
1215 @table @kbd
1216 @item C-x @key{RET} k @var{coding} @key{RET}
1217 Use coding system @var{coding} for keyboard input.
1218
1219 @item C-x @key{RET} t @var{coding} @key{RET}
1220 Use coding system @var{coding} for terminal output.
1221 @end table
1222
1223 @kindex C-x RET t
1224 @findex set-terminal-coding-system
1225 The command @kbd{C-x @key{RET} t} (@code{set-terminal-coding-system})
1226 specifies the coding system for terminal output. If you specify a
1227 character code for terminal output, all characters output to the
1228 terminal are translated into that coding system.
1229
1230 This feature is useful for certain character-only terminals built to
1231 support specific languages or character sets---for example, European
1232 terminals that support one of the ISO Latin character sets. You need to
1233 specify the terminal coding system when using multibyte text, so that
1234 Emacs knows which characters the terminal can actually handle.
1235
1236 By default, output to the terminal is not translated at all, unless
1237 Emacs can deduce the proper coding system from your terminal type or
1238 your locale specification (@pxref{Language Environments}).
1239
1240 @kindex C-x RET k
1241 @findex set-keyboard-coding-system
1242 @vindex keyboard-coding-system
1243 The command @kbd{C-x @key{RET} k} (@code{set-keyboard-coding-system})
1244 or the variable @code{keyboard-coding-system} specifies the coding
1245 system for keyboard input. Character-code translation of keyboard
1246 input is useful for terminals with keys that send non-@acronym{ASCII}
1247 graphic characters---for example, some terminals designed for ISO
1248 Latin-1 or subsets of it.
1249
1250 By default, keyboard input is translated based on your system locale
1251 setting. If your terminal does not really support the encoding
1252 implied by your locale (for example, if you find it inserts a
1253 non-@acronym{ASCII} character if you type @kbd{M-i}), you will need to set
1254 @code{keyboard-coding-system} to @code{nil} to turn off encoding.
1255 You can do this by putting
1256
1257 @lisp
1258 (set-keyboard-coding-system nil)
1259 @end lisp
1260
1261 @noindent
1262 in your init file.
1263
1264 There is a similarity between using a coding system translation for
1265 keyboard input, and using an input method: both define sequences of
1266 keyboard input that translate into single characters. However, input
1267 methods are designed to be convenient for interactive use by humans, and
1268 the sequences that are translated are typically sequences of @acronym{ASCII}
1269 printing characters. Coding systems typically translate sequences of
1270 non-graphic characters.
1271
1272 @node Fontsets
1273 @section Fontsets
1274 @cindex fontsets
1275
1276 A font typically defines shapes for a single alphabet or script.
1277 Therefore, displaying the entire range of scripts that Emacs supports
1278 requires a collection of many fonts. In Emacs, such a collection is
1279 called a @dfn{fontset}. A fontset is defined by a list of font specs,
1280 each assigned to handle a range of character codes, and may fall back
1281 on another fontset for characters which are not covered by the fonts
1282 it specifies.
1283
1284 Each fontset has a name, like a font. However, while fonts are
1285 stored in the system and the available font names are defined by the
1286 system, fontsets are defined within Emacs itself. Once you have
1287 defined a fontset, you can use it within Emacs by specifying its name,
1288 anywhere that you could use a single font. Of course, Emacs fontsets
1289 can use only the fonts that the system supports; if certain characters
1290 appear on the screen as hollow boxes, this means that the fontset in
1291 use for them has no font for those characters.@footnote{The Emacs
1292 installation instructions have information on additional font
1293 support.}
1294
1295 Emacs creates three fontsets automatically: the @dfn{standard
1296 fontset}, the @dfn{startup fontset} and the @dfn{default fontset}.
1297 The default fontset is most likely to have fonts for a wide variety of
1298 non-@acronym{ASCII} characters and is the default fallback for the
1299 other two fontsets, and if you set a default font rather than fontset.
1300 However it does not specify font family names, so results can be
1301 somewhat random if you use it directly. You can specify use of a
1302 specific fontset with the @samp{-fn} option. For example,
1303
1304 @example
1305 emacs -fn fontset-standard
1306 @end example
1307
1308 @noindent
1309 You can also specify a fontset with the @samp{Font} resource (@pxref{X
1310 Resources}).
1311
1312 If no fontset is specified for use, then Emacs uses an
1313 @acronym{ASCII} font, with @samp{fontset-default} as a fallback for
1314 characters the font does not cover. The standard fontset is only used if
1315 explicitly requested, despite its name.
1316
1317 A fontset does not necessarily specify a font for every character
1318 code. If a fontset specifies no font for a certain character, or if
1319 it specifies a font that does not exist on your system, then it cannot
1320 display that character properly. It will display that character as a
1321 hex code or thin space or an empty box instead. (@xref{Text Display, ,
1322 glyphless characters}, for details.)
1323
1324 @node Defining Fontsets
1325 @section Defining fontsets
1326
1327 @vindex standard-fontset-spec
1328 @vindex w32-standard-fontset-spec
1329 @vindex ns-standard-fontset-spec
1330 @cindex standard fontset
1331 When running on X, Emacs creates a standard fontset automatically according to the value
1332 of @code{standard-fontset-spec}. This fontset's name is
1333
1334 @example
1335 -*-fixed-medium-r-normal-*-16-*-*-*-*-*-fontset-standard
1336 @end example
1337
1338 @noindent
1339 or just @samp{fontset-standard} for short.
1340
1341 On GNUstep and Mac, fontset-standard is created using the value of
1342 @code{ns-standard-fontset-spec}, and on Windows it is
1343 created using the value of @code{w32-standard-fontset-spec}.
1344
1345 Bold, italic, and bold-italic variants of the standard fontset are
1346 created automatically. Their names have @samp{bold} instead of
1347 @samp{medium}, or @samp{i} instead of @samp{r}, or both.
1348
1349 @cindex startup fontset
1350 Emacs generates a fontset automatically, based on any default
1351 @acronym{ASCII} font that you specify with the @samp{Font} resource or
1352 the @samp{-fn} argument, or the default font that Emacs found when it
1353 started. This is the @dfn{startup fontset} and its name is
1354 @code{fontset-startup}. It does this by replacing the
1355 @var{charset_registry} field with @samp{fontset}, and replacing
1356 @var{charset_encoding} field with @samp{startup}, then using the
1357 resulting string to specify a fontset.
1358
1359 For instance, if you start Emacs this way,
1360
1361 @example
1362 emacs -fn "*courier-medium-r-normal--14-140-*-iso8859-1"
1363 @end example
1364
1365 @noindent
1366 Emacs generates the following fontset and uses it for the initial X
1367 window frame:
1368
1369 @example
1370 -*-courier-medium-r-normal-*-14-140-*-*-*-*-fontset-startup
1371 @end example
1372
1373 The startup fontset will use the font that you specify or a variant
1374 with a different registry and encoding for all the characters which
1375 are supported by that font, and fallback on @samp{fontset-default} for
1376 other characters.
1377
1378 With the X resource @samp{Emacs.Font}, you can specify a fontset name
1379 just like an actual font name. But be careful not to specify a fontset
1380 name in a wildcard resource like @samp{Emacs*Font}---that wildcard
1381 specification matches various other resources, such as for menus, and
1382 menus cannot handle fontsets.
1383
1384 You can specify additional fontsets using X resources named
1385 @samp{Fontset-@var{n}}, where @var{n} is an integer starting from 0.
1386 The resource value should have this form:
1387
1388 @smallexample
1389 @var{fontpattern}, @r{[}@var{charset}:@var{font}@r{]@dots{}}
1390 @end smallexample
1391
1392 @noindent
1393 @var{fontpattern} should have the form of a standard X font name, except
1394 for the last two fields. They should have the form
1395 @samp{fontset-@var{alias}}.
1396
1397 The fontset has two names, one long and one short. The long name is
1398 @var{fontpattern}. The short name is @samp{fontset-@var{alias}}. You
1399 can refer to the fontset by either name.
1400
1401 The construct @samp{@var{charset}:@var{font}} specifies which font to
1402 use (in this fontset) for one particular character set. Here,
1403 @var{charset} is the name of a character set, and @var{font} is the
1404 font to use for that character set. You can use this construct any
1405 number of times in defining one fontset.
1406
1407 For the other character sets, Emacs chooses a font based on
1408 @var{fontpattern}. It replaces @samp{fontset-@var{alias}} with values
1409 that describe the character set. For the @acronym{ASCII} character font,
1410 @samp{fontset-@var{alias}} is replaced with @samp{ISO8859-1}.
1411
1412 In addition, when several consecutive fields are wildcards, Emacs
1413 collapses them into a single wildcard. This is to prevent use of
1414 auto-scaled fonts. Fonts made by scaling larger fonts are not usable
1415 for editing, and scaling a smaller font is not useful because it is
1416 better to use the smaller font in its own size, which is what Emacs
1417 does.
1418
1419 Thus if @var{fontpattern} is this,
1420
1421 @example
1422 -*-fixed-medium-r-normal-*-24-*-*-*-*-*-fontset-24
1423 @end example
1424
1425 @noindent
1426 the font specification for @acronym{ASCII} characters would be this:
1427
1428 @example
1429 -*-fixed-medium-r-normal-*-24-*-ISO8859-1
1430 @end example
1431
1432 @noindent
1433 and the font specification for Chinese GB2312 characters would be this:
1434
1435 @example
1436 -*-fixed-medium-r-normal-*-24-*-gb2312*-*
1437 @end example
1438
1439 You may not have any Chinese font matching the above font
1440 specification. Most X distributions include only Chinese fonts that
1441 have @samp{song ti} or @samp{fangsong ti} in @var{family} field. In
1442 such a case, @samp{Fontset-@var{n}} can be specified as below:
1443
1444 @smallexample
1445 Emacs.Fontset-0: -*-fixed-medium-r-normal-*-24-*-*-*-*-*-fontset-24,\
1446 chinese-gb2312:-*-*-medium-r-normal-*-24-*-gb2312*-*
1447 @end smallexample
1448
1449 @noindent
1450 Then, the font specifications for all but Chinese GB2312 characters have
1451 @samp{fixed} in the @var{family} field, and the font specification for
1452 Chinese GB2312 characters has a wild card @samp{*} in the @var{family}
1453 field.
1454
1455 @findex create-fontset-from-fontset-spec
1456 The function that processes the fontset resource value to create the
1457 fontset is called @code{create-fontset-from-fontset-spec}. You can also
1458 call this function explicitly to create a fontset.
1459
1460 @xref{Fonts}, for more information about font naming.
1461
1462 @node Modifying Fontsets
1463 @section Modifying Fontsets
1464 @cindex fontsets, modifying
1465 @findex set-fontset-font
1466
1467 Fontsets do not always have to be created from scratch. If only
1468 minor changes are required it may be easier to modify an existing
1469 fontset. Modifying @samp{fontset-default} will also affect other
1470 fontsets that use it as a fallback, so can be an effective way of
1471 fixing problems with the fonts that Emacs chooses for a particular
1472 script.
1473
1474 Fontsets can be modified using the function @code{set-fontset-font},
1475 specifying a character, a charset, a script, or a range of characters
1476 to modify the font for, and a font-spec for the font to be used. Some
1477 examples are:
1478
1479 @example
1480 ;; Use Liberation Mono for latin-3 charset.
1481 (set-fontset-font "fontset-default" 'iso-8859-3 "Liberation Mono")
1482
1483 ;; Prefer a big5 font for han characters
1484 (set-fontset-font "fontset-default" 'han (font-spec :registry "big5")
1485 nil 'prepend)
1486
1487 ;; Use DejaVu Sans Mono as a fallback in fontset-startup before
1488 ;; resorting to fontset-default.
1489 (set-fontset-font "fontset-startup" nil "DejaVu Sans Mono" nil 'append)
1490
1491 ;; Use MyPrivateFont for the Unicode private use area.
1492 (set-fontset-font "fontset-default" '(#xe000 . #xf8ff) "MyPrivateFont")
1493
1494 @end example
1495
1496
1497 @node Undisplayable Characters
1498 @section Undisplayable Characters
1499
1500 There may be a some non-@acronym{ASCII} characters that your terminal cannot
1501 display. Most text-only terminals support just a single character
1502 set (use the variable @code{default-terminal-coding-system}
1503 (@pxref{Terminal Coding}) to tell Emacs which one); characters which
1504 can't be encoded in that coding system are displayed as @samp{?} by
1505 default.
1506
1507 Graphical displays can display a broader range of characters, but
1508 you may not have fonts installed for all of them; characters that have
1509 no font appear as a hollow box.
1510
1511 If you use Latin-1 characters but your terminal can't display
1512 Latin-1, you can arrange to display mnemonic @acronym{ASCII} sequences
1513 instead, e.g.@: @samp{"o} for o-umlaut. Load the library
1514 @file{iso-ascii} to do this.
1515
1516 @vindex latin1-display
1517 If your terminal can display Latin-1, you can display characters
1518 from other European character sets using a mixture of equivalent
1519 Latin-1 characters and @acronym{ASCII} mnemonics. Customize the variable
1520 @code{latin1-display} to enable this. The mnemonic @acronym{ASCII}
1521 sequences mostly correspond to those of the prefix input methods.
1522
1523 @node Unibyte Mode
1524 @section Unibyte Editing Mode
1525
1526 @cindex European character sets
1527 @cindex accented characters
1528 @cindex ISO Latin character sets
1529 @cindex Unibyte operation
1530 The ISO 8859 Latin-@var{n} character sets define character codes in
1531 the range 0240 to 0377 octal (160 to 255 decimal) to handle the
1532 accented letters and punctuation needed by various European languages
1533 (and some non-European ones). Note that Emacs considers bytes with
1534 codes in this range as raw bytes, not as characters, even in a unibyte
1535 session, i.e.@: if you disable multibyte characters. However, Emacs
1536 can still handle these character codes as if they belonged to
1537 @emph{one} of the single-byte character sets at a time. To specify
1538 @emph{which} of these codes to use, invoke @kbd{M-x
1539 set-language-environment} and specify a suitable language environment
1540 such as @samp{Latin-@var{n}}.
1541
1542 For more information about unibyte operation, see @ref{Enabling
1543 Multibyte}. Note particularly that you probably want to ensure that
1544 your initialization files are read as unibyte if they contain
1545 non-@acronym{ASCII} characters.
1546
1547 @vindex unibyte-display-via-language-environment
1548 Emacs can also display bytes in the range 160 to 255 as readable
1549 characters, provided the terminal or font in use supports them. This
1550 works automatically. On a graphical display, Emacs can also display
1551 single-byte characters through fontsets, in effect by displaying the
1552 equivalent multibyte characters according to the current language
1553 environment. To request this, set the variable
1554 @code{unibyte-display-via-language-environment} to a non-@code{nil}
1555 value. Note that setting this only affects how these bytes are
1556 displayed, but does not change the fundamental fact that Emacs treats
1557 them as raw bytes, not as characters.
1558
1559 @cindex @code{iso-ascii} library
1560 If your terminal does not support display of the Latin-1 character
1561 set, Emacs can display these characters as @acronym{ASCII} sequences which at
1562 least give you a clear idea of what the characters are. To do this,
1563 load the library @code{iso-ascii}. Similar libraries for other
1564 Latin-@var{n} character sets could be implemented, but we don't have
1565 them yet.
1566
1567 @findex standard-display-8bit
1568 @cindex 8-bit display
1569 Normally non-ISO-8859 characters (decimal codes between 128 and 159
1570 inclusive) are displayed as octal escapes. You can change this for
1571 non-standard ``extended'' versions of ISO-8859 character sets by using the
1572 function @code{standard-display-8bit} in the @code{disp-table} library.
1573
1574 There are two ways to input single-byte non-@acronym{ASCII}
1575 characters:
1576
1577 @itemize @bullet
1578 @cindex 8-bit input
1579 @item
1580 You can use an input method for the selected language environment.
1581 @xref{Input Methods}. When you use an input method in a unibyte buffer,
1582 the non-@acronym{ASCII} character you specify with it is converted to unibyte.
1583
1584 @item
1585 If your keyboard can generate character codes 128 (decimal) and up,
1586 representing non-@acronym{ASCII} characters, you can type those character codes
1587 directly.
1588
1589 On a graphical display, you should not need to do anything special to use
1590 these keys; they should simply work. On a text-only terminal, you
1591 should use the command @code{M-x set-keyboard-coding-system} or the
1592 variable @code{keyboard-coding-system} to specify which coding system
1593 your keyboard uses (@pxref{Terminal Coding}). Enabling this feature
1594 will probably require you to use @kbd{ESC} to type Meta characters;
1595 however, on a console terminal or in @code{xterm}, you can arrange for
1596 Meta to be converted to @kbd{ESC} and still be able type 8-bit
1597 characters present directly on the keyboard or using @kbd{Compose} or
1598 @kbd{AltGr} keys. @xref{User Input}.
1599
1600 @kindex C-x 8
1601 @cindex @code{iso-transl} library
1602 @cindex compose character
1603 @cindex dead character
1604 @item
1605 For Latin-1 only, you can use the key @kbd{C-x 8} as a ``compose
1606 character'' prefix for entry of non-@acronym{ASCII} Latin-1 printing
1607 characters. @kbd{C-x 8} is good for insertion (in the minibuffer as
1608 well as other buffers), for searching, and in any other context where
1609 a key sequence is allowed.
1610
1611 @kbd{C-x 8} works by loading the @code{iso-transl} library. Once that
1612 library is loaded, the @key{ALT} modifier key, if the keyboard has
1613 one, serves the same purpose as @kbd{C-x 8}: use @key{ALT} together
1614 with an accent character to modify the following letter. In addition,
1615 if the keyboard has keys for the Latin-1 ``dead accent characters,''
1616 they too are defined to compose with the following character, once
1617 @code{iso-transl} is loaded.
1618
1619 Use @kbd{C-x 8 C-h} to list all the available @kbd{C-x 8} translations.
1620 @end itemize
1621
1622 @node Charsets
1623 @section Charsets
1624 @cindex charsets
1625
1626 In Emacs, @dfn{charset} is short for ``character set''. Emacs
1627 supports most popular charsets (such as @code{ascii},
1628 @code{iso-8859-1}, @code{cp1250}, @code{big5}, and @code{unicode}), in
1629 addition to some charsets of its own (such as @code{emacs},
1630 @code{unicode-bmp}, and @code{eight-bit}). All supported characters
1631 belong to one or more charsets.
1632
1633 Emacs normally ``does the right thing'' with respect to charsets, so
1634 that you don't have to worry about them. However, it is sometimes
1635 helpful to know some of the underlying details about charsets.
1636
1637 One example is font selection (@pxref{Fonts}). Each language
1638 environment (@pxref{Language Environments}) defines a ``priority
1639 list'' for the various charsets. When searching for a font, Emacs
1640 initially attempts to find one that can display the highest-priority
1641 charsets. For instance, in the Japanese language environment, the
1642 charset @code{japanese-jisx0208} has the highest priority, so Emacs
1643 tries to use a font whose @code{registry} property is
1644 @samp{JISX0208.1983-0}.
1645
1646 @findex list-charset-chars
1647 @cindex characters in a certain charset
1648 @findex describe-character-set
1649 There are two commands that can be used to obtain information about
1650 charsets. The command @kbd{M-x list-charset-chars} prompts for a
1651 charset name, and displays all the characters in that character set.
1652 The command @kbd{M-x describe-character-set} prompts for a charset
1653 name, and displays information about that charset, including its
1654 internal representation within Emacs.
1655
1656 @findex list-character-sets
1657 To display a list of all supported charsets, type @kbd{M-x
1658 list-character-sets}. The list gives the names of charsets and
1659 additional information to identity each charset (see
1660 @url{http://www.itscj.ipsj.or.jp/ISO-IR/} for details). In this list,
1661 charsets are divided into two categories: @dfn{normal charsets} are
1662 listed first, followed by @dfn{supplementary charsets}. A
1663 supplementary charset is one that is used to define another charset
1664 (as a parent or a subset), or to provide backward-compatibility for
1665 older Emacs versions.
1666
1667 To find out which charset a character in the buffer belongs to, put
1668 point before it and type @kbd{C-u C-x =} (@pxref{International
1669 Chars}).
1670
1671 @node Bidirectional Editing
1672 @section Bidirectional Editing
1673 @cindex bidirectional editing
1674 @cindex right-to-left text
1675
1676 Emacs supports editing text written in scripts, such as Arabic and
1677 Hebrew, whose natural ordering of horizontal text for display is from
1678 right to left. However, digits and Latin text embedded in these
1679 scripts are still displayed left to right. It is also not uncommon to
1680 have small portions of text in Arabic or Hebrew embedded in otherwise
1681 Latin document, e.g., as comments and strings in a program source
1682 file. For these reasons, text that uses these scripts is actually
1683 @dfn{bidirectional}: a mixture of runs of left-to-right and
1684 right-to-left characters.
1685
1686 This section describes the facilities and options provided by Emacs
1687 for editing bidirectional text.
1688
1689 @cindex logical order
1690 @cindex visual order
1691 Emacs stores right-to-left and bidirectional text in the so-called
1692 @dfn{logical} (or @dfn{reading}) order: the buffer or string position
1693 of the first character you read precedes that of the next character.
1694 Reordering of bidirectional text into the @dfn{visual} order happens
1695 at display time. As result, character positions no longer increase
1696 monotonically with their positions on display. Emacs implements the
1697 Unicode Bidirectional Algorithm described in the Unicode Standard
1698 Annex #9, for reordering of bidirectional text for display.
1699
1700 @vindex bidi-display-reordering
1701 The buffer-local variable @code{bidi-display-reordering} controls
1702 whether text in the buffer is reordered for display. If its value is
1703 non-@code{nil}, Emacs reorders characters that have right-to-left
1704 directionality when they are displayed. The default value is
1705 @code{nil}.
1706
1707 Each paragraph of bidirectional text can have its own @dfn{base
1708 direction}, either right-to-left or left-to-right. (Paragraph
1709 boundaries are defined by the regular expressions
1710 @code{paragraph-start} and @code{paragraph-separate}, see
1711 @ref{Paragraphs}.) Text in left-to-right paragraphs begins at the
1712 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
1737 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.
1748
1749 @ignore
1750 arch-tag: 310ba60d-31ef-4ce7-91f1-f282dd57b6b3
1751 @end ignore