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