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