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