Newer Older
Kim F. Storm's avatar
Kim F. Storm committed
1 2
Known Problems with GNU Emacs

Paul Eggert's avatar
Paul Eggert committed
Copyright (C) 1987-1989, 1993-1999, 2001-2020 Free Software Foundation,
Paul Eggert's avatar
Paul Eggert committed
5 6 7
See the end of the file for license conditions.

Dave Love's avatar
Dave Love committed
This file describes various problems that have been encountered
9 10
in compiling, installing and running GNU Emacs.  Try doing C-c C-t
and browsing through the outline headers.  (See C-h m for help on
11 12 13
Outline mode.)  Information about systems that are no longer supported,
and old Emacs releases, has been removed.  Consult older versions of
this file if you are interested in that information.
Dave Love's avatar
Dave Love committed

* Mule-UCS doesn't work in Emacs 23 onwards
Dave Love's avatar
Dave Love committed
16 17 18

It's completely redundant now, as far as we know.

* Emacs startup failures

** Emacs fails to start, complaining about missing fonts.

A typical error message might be something like

  No fonts match ‘-*-fixed-medium-r-*--6-*-*-*-*-*-iso8859-1’
Kenichi Handa's avatar
Kenichi Handa committed

This happens because some X resource specifies a bad font family for
Emacs to use.  The possible places where this specification might be are:
Kenichi Handa's avatar
Kenichi Handa committed

Ivan Shmakov's avatar
Ivan Shmakov committed
30 31 32
  - in the X server resources database, often initialized from
    ~/.Xresources (use $ xrdb -query to find out the current state)

  - in your ~/.Xdefaults file
Kenichi Handa's avatar
Kenichi Handa committed

  - client-side X resource file, such as  ~/Emacs or
Kenichi Handa's avatar
Kenichi Handa committed

38 39 40
One of these files might have bad or malformed specification of a
fontset that Emacs should use.  To fix the problem, you need to find
the problematic line(s) and correct them.
Kenichi Handa's avatar
Kenichi Handa committed

Ivan Shmakov's avatar
Ivan Shmakov committed
42 43 44 45 46 47
After correcting ~/.Xresources, the new data has to be merged into the
X server resources database.  Depending on the circumstances, the
following command may do the trick.  See xrdb(1) for more information.

  $ xrdb -merge ~/.Xresources

48 49 50 51 52 53 54
** Emacs compiled with Cairo crashes when restoring session from desktop file.

This can happen if the '.emacs.desktop' file contains setting for
'font-backend' frame parameter.  A workaround is to delete the
offending '.emacs.desktop' file, or edit it to remove the setting of

** Emacs aborts while starting up, only when run without X.
Kenichi Handa's avatar
Kenichi Handa committed

57 58 59 60 61 62 63 64 65
This problem often results from compiling Emacs with GCC when GCC was
installed incorrectly.  The usual error in installing GCC is to
specify --includedir=/usr/include.  Installation of GCC makes
corrected copies of the system header files.  GCC is supposed to use
the corrected copies in preference to the original system headers.
Specifying --includedir=/usr/include causes the original system header
files to be used.  On some systems, the definition of ioctl in the
original system header files is invalid for ANSI C and causes Emacs
not to work.
Kenichi Handa's avatar
Kenichi Handa committed

67 68 69 70
The fix is to reinstall GCC, and this time do not specify --includedir
when you configure it.  Then recompile Emacs.  Specifying --includedir
is appropriate only in very special cases and it should *never* be the
same directory where system header files are kept.
Kenichi Handa's avatar
Kenichi Handa committed

** Emacs does not start, complaining that it cannot open termcap database file.
Kenichi Handa's avatar
Kenichi Handa committed

74 75 76 77
If your system uses Terminfo rather than termcap (most modern
systems do), this could happen if the proper version of
ncurses is not visible to the Emacs configure script (i.e. it
cannot be found along the usual path the linker looks for
libraries).  It can happen because your version of ncurses is
obsolete, or is available only in form of binaries.
Kenichi Handa's avatar
Kenichi Handa committed

81 82 83 84
The solution is to install an up-to-date version of ncurses in
the developer's form (header files, static libraries and
symbolic links); in some GNU/Linux distributions (e.g. Debian)
it constitutes a separate package.
Kenichi Handa's avatar
Kenichi Handa committed

** Emacs 20 and later fails to load Lisp files at startup.

The typical error message might be like this:

  "Cannot open load file: fontset"

92 93 94 95
This could happen if you compress the file lisp/subdirs.el.  That file
tells Emacs what are the directories where it should look for Lisp
files.  Emacs cannot work with subdirs.el compressed, since the
Auto-compress mode it needs for this will not be loaded until later,
when your .emacs file is processed.  (The package 'fontset.el' is
97 98
required to set up fonts used to display text on window systems, and
it's loaded very early in the startup procedure.)

100 101
Similarly, any other .el file for which there's no corresponding .elc
file could fail to load if it is compressed.
Dave Love's avatar
Dave Love committed

The solution is to uncompress all .el files that don't have a .elc file.
Kenichi Handa's avatar
Kenichi Handa committed

Another possible reason for such failures is stale *.elc files
lurking somewhere on your load-path -- see the next section.
Dave Love's avatar
Dave Love committed

** Emacs prints an error at startup after upgrading from an earlier version.
Dave Love's avatar
Dave Love committed

An example of such an error is:
Dave Love's avatar
Dave Love committed

  x-complement-fontset-spec: "Wrong type argument: stringp, nil"
Dave Love's avatar
Dave Love committed

114 115 116
This can be another symptom of stale *.elc files in your load-path.
The following command will print any duplicate Lisp files that are
present in load-path:
Dave Love's avatar
Dave Love committed

Glenn Morris's avatar
Glenn Morris committed
    emacs -batch -f list-load-path-shadows
Dave Love's avatar
Dave Love committed

120 121 122
If this command prints any file names, some of these files are stale,
and should be deleted or their directories removed from your

* Crash bugs

** Emacs crashes when running in a terminal, if compiled with GCC 4.5.0

128 129
This version of GCC is buggy: see

130 131
132 133 134 135

You can work around this error in gcc-4.5 by omitting sibling call
optimization.  To do this, configure Emacs with

 ./configure CFLAGS="-g -O2 -fno-optimize-sibling-calls"

138 139 140 141 142
** Emacs compiled with GCC 4.6.1 crashes on MS-Windows when C-g is pressed

This is known to happen when Emacs is compiled with MinGW GCC 4.6.1
with the -O2 option (which is the default in the Windows build).  The
reason is a bug in MinGW GCC 4.6.1; to work around, either add the
143 144
'-fno-omit-frame-pointer' switch to GCC or compile without
optimizations ('--no-opt' switch to the configure.bat script).

** Emacs crashes in x-popup-dialog.

148 149
This can happen if the dialog widget cannot find the font it wants to
use.  You can work around the problem by specifying another font with
an X resource--for example, 'Emacs.dialog*.font: 9x15' (or any font that
happens to exist on your X server).
Dave Love's avatar
Dave Love committed

** Emacs crashes when you use Bibtex mode.
Dave Love's avatar
Dave Love committed

This happens if your system puts a small limit on stack size.  You can
prevent the problem by using a suitable shell command (often 'ulimit')
to raise the stack size limit before you run Emacs.

Patches to raise the stack size limit automatically in 'main'
(src/emacs.c) on various systems would be greatly appreciated.
Dave Love's avatar
Dave Love committed

** Error message 'Symbol’s value as variable is void: x', followed by
a segmentation fault and core dump.

165 166
This has been tracked to a bug in tar!  People report that tar erroneously
added a line like this at the beginning of files of Lisp code:

   x FILENAME, N bytes, B tape blocks

170 171
If your tar has this problem, install GNU tar--if you can manage to
untar it :-).

** Emacs can crash when displaying PNG images with transparency.

This is due to a bug introduced in ImageMagick 6.8.2-3.  The bug should
be fixed in ImageMagick 6.8.3-10.  See <URL:>.

178 179 180 181 182
** Crashes when displaying GIF images in Emacs built with version
libungif-4.1.0 are resolved by using version libungif-4.1.0b1.
Configure checks for the correct version, but this problem could occur
if a binary built against a shared libungif is run on a system with an
older version.

** Emacs aborts inside the function 'tparam1'.

186 187 188 189 190
This can happen if Emacs was built without terminfo support, but the
terminal's capabilities use format that is only supported by terminfo.
If your system has ncurses installed, this might happen if your
version of ncurses is broken; upgrading to a newer version of ncurses
and reconfiguring and rebuilding Emacs should solve this.

192 193 194
All modern systems support terminfo, so even if ncurses is not the
problem, you should look for a way to configure Emacs so that it uses
terminfo when built.

** Emacs crashes when using some version of the Exceed X server.

198 199 200
Upgrading to a newer version of Exceed has been reported to prevent
these crashes.  You should consider switching to a free X server, such
as Xming or Cygwin/X.

202 203 204 205 206 207 208 209 210 211 212 213
** Emacs crashes with SIGSEGV in XtInitializeWidgetClass.

It crashes on X, but runs fine when called with option "-nw".

This has been observed when Emacs is linked with GNU ld but without passing
the -z nocombreloc flag.  Emacs normally knows to pass the -z nocombreloc
flag when needed, so if you come across a situation where the flag is
necessary but missing, please report it via M-x report-emacs-bug.

On platforms such as Solaris, you can also work around this problem by
configuring your compiler to use the native linker instead of GNU ld.

** When Emacs is compiled with Gtk+, closing a display kills Emacs.

There is a long-standing bug in GTK that prevents it from recovering
from disconnects:

219 220 221 222
Thus, for instance, when Emacs is run as a server on a text terminal,
and an X frame is created, and the X server for that frame crashes or
exits unexpectedly, Emacs must exit to prevent a GTK error that would
result in an endless loop.

224 225
If you need Emacs to be able to recover from closing displays, compile
it with the Lucid toolkit instead of GTK.

227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246
** Emacs compiled with GTK+ 3 crashes when run under some X servers.
This happens when the X server does not provide certain display
features that the underlying GTK+ 3 toolkit assumes.  For example, this
issue has been seen with remote X servers like X2Go.  The symptoms
are an Emacs crash, possibly triggered by the mouse entering the Emacs
window, or an attempt to resize the Emacs window.  The crash backtrace
contains a call to XQueryPointer.

This issue was fixed in the GTK+ 3 toolkit in commit 4b1c0256 in February 2018.

If your GTK+ 3 is still affected, you can avoid the issue by recompiling
Emacs with a different X toolkit, eg --with-toolkit=gtk2.


247 248 249 250 251 252 253 254
** Emacs compiled with GTK crashes at startup due to X protocol error.

This is known to happen on elementary OS GNU/Linux systems.

The error message is:

  X protocol error: BadMatch (invalid parameter attributes) on protocol request 140
  When compiled with GTK, Emacs cannot recover from X disconnects.
  This is a GTK bug:
256 257 258 259 260 261 262 263 264 265 266 267 268
  For details, see etc/PROBLEMS.
  Fatal error 6: Aborted

followed by a C backtrace.  (Sometimes the offending protocol request
number is 139.)

The relevant bug report is here:

A workaround is to set XLIB_SKIP_ARGB_VISUALS=1 in the environment
before starting Emacs, or run Emacs as root.

** Emacs crashes when you try to view a file with complex characters.

271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
One possible reason for this could be a bug in the libotf or the
libm17n-flt/m17n-db libraries Emacs uses for displaying complex
scripts.  Make sure you have the latest versions of these libraries
installed.  If the problem still persists with the latest released
versions of these libraries, you can try building these libraries from
their CVS repository:

  cvs -z3 co libotf
  cvs -z3 co m17n-db
  cvs -z3 co m17n-lib

One known problem that causes such crashes is with using Noto Serif
Kannada fonts.  To work around that, force Emacs not to select these
fonts, by adding the following to your ~/.emacs init file:

  (push "Noto Serif Kannada" face-ignored-fonts)

You can try this interactively in a running Emacs session like this:

  M-: (push "Noto Serif Kannada" face-ignored-fonts) RET

Another set of problems is caused by an incompatible libotf library.
In this case, displaying the etc/HELLO file (as shown by C-h h)
triggers the following message to be shown in the terminal from which
you launched Emacs:

  symbol lookup error: /usr/bin/emacs: undefined symbol: OTF_open
298 299 300

This problem occurs because unfortunately there are two libraries
called "libotf".  One is the library for handling OpenType fonts,
Paul Eggert's avatar
Paul Eggert committed
301, which is the one that Emacs expects.
302 303 304 305 306 307 308 309 310 311
The other is a library for Open Trace Format, and is used by some
versions of the MPI message passing interface for parallel

For example, on RHEL6 GNU/Linux, the OpenMPI rpm provides a version
of "" in /usr/lib/openmpi/lib.  This directory is not
normally in the ld search path, but if you want to use OpenMPI,
you must issue the command "module load openmpi".  This adds
/usr/lib/openmpi/lib to LD_LIBRARY_PATH.  If you then start Emacs from
the same shell, you will encounter this crash.
Ref: <URL:>
313 314 315 316 317 318 319 320

There is no good solution to this problem if you need to use both
OpenMPI and Emacs with libotf support.  The best you can do is use a
wrapper shell script (or function) "emacs" that removes the offending
element from LD_LIBRARY_PATH before starting emacs proper.
Or you could recompile Emacs with an -Wl,-rpath option that
gives the location of the correct libotf.

321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397
* Problems when reading or debugging Emacs C code

Because Emacs does not install a copy of its C source code, users
normally cannot easily read that code via commands like 'M-x
describe-function' (C-h f) that display the definition of a function.
However, some GNU/Linux systems provide separate packages containing
this source code which can get C-h f to work if you are willing to do
some tinkering, and some systems also provide packages containing
debug info, which when combined with the source can be used to debug
Emacs at the C level.

** Debian-based source and debuginfo

On recent Debian-based systems, you can obtain and use a source
package of Emacs as follows.

*** Add the appropriate URI to /etc/apt/sources.list.

To do this, become superuser and uncomment or add the appropriate
'deb-src' line.  Details depend on the distribution.

*** Execute a command like 'apt-get source emacs'.

On older systems, append the top-level version number, e.g., 'apt-get
source emacs25'.  The target directory for unpacking the source tree
is the current directory.

*** Set find-function-C-source-directory accordingly.

Once you have installed the source package, for example at
/home/myself/deb-src/emacs-26.3, add the following line to your
startup file:

     (setq find-function-C-source-directory

The installation directory of the Emacs source package will contain
the exact package name and version number of Emacs that is installed
on your system.  If a new Emacs package is installed, the source
package must be reinstalled as well, and the setting in your startup
file must be updated.

*** Debian-based debuginfo

You can also install a debug package of Emacs with a command like
'apt-get install emacs-dbg' (on older systems, 'apt-get install
emacs25-dbg').  You need to arrange for GDB to find where you
installed the source code, e.g., by using GDB's 'directory' command.

** Red Hat-based source and debuginfo

On recent Red Hat-based systems, you can install source and debug info
via superuser commands like the following:

  # Add the *-debuginfo repositories (exact command depends on system).
  dnf config-manager --set-enabled fedora-debuginfo updates-debuginfo'

  # Install Emacs source and debug info.
  dnf install emacs-debugsource

To get describe-function and similar commands to work, you can then
add something like the following to your startup file:

     (setq find-function-C-source-directory

However, the exact directory name will depend on the system, and you
will need to both upgrade source and debug info when your system
upgrades or patches Emacs, and change your startup file accordingly.

** Source and debuginfo for other systems

If your system follows neither the Debian nor the Red Hat patterns,
you can obtain the source and debuginfo by obtaining the source code
of Emacs, building Emacs with the appropriate debug flags enabled, and
running the just-built Emacs.

* General runtime problems

** Lisp problems

*** Changes made to .el files do not take effect.

404 405 406 407
You may have forgotten to recompile them into .elc files.
Then the old .elc files will be loaded, and your changes
will not be seen.  To fix this, do M-x byte-recompile-directory
and specify the directory that contains the Lisp files.

Emacs prints a warning when loading a .elc file which is older
than the corresponding .el file.

Alternatively, if you set the option 'load-prefer-newer' non-nil,
413 414 415
Emacs will load whichever version of a file is the newest.

*** Watch out for the EMACSLOADPATH environment variable

EMACSLOADPATH overrides which directories the function "load" will search.

419 420
If you observe strange problems, check for this variable in your
Dave Love's avatar
Dave Love committed

*** Using epop3.el package causes Emacs to signal an error.
Dave Love's avatar
Dave Love committed

The error message might be something like this:

  "Lisp nesting exceeds max-lisp-eval-depth"

428 429
This happens because epop3 redefines the function gethash, which is a
built-in primitive beginning with Emacs 21.1.  We don't have a patch
Ivan Shmakov's avatar
Ivan Shmakov committed
for epop3 to fix it, but perhaps a newer version of epop3 corrects that.

*** Buffers from 'with-output-to-temp-buffer' get set up in Help mode.

434 435 436
Changes in Emacs 20.4 to the hooks used by that function cause
problems for some packages, specifically BBDB.  See the function's
documentation for the hooks involved.  BBDB 2.00.06 fixes the problem.

*** The Hyperbole package causes *Help* buffers not to be displayed in
439 440
Help mode due to setting 'temp-buffer-show-hook' rather than using
'add-hook'.  Using '(add-hook 'temp-buffer-show-hook 'help-mode-finish)'
after loading Hyperbole should fix this.

** Keyboard problems

445 446 447 448
*** Unable to enter the M-| key on some German keyboards.
Some users have reported that M-| suffers from "keyboard ghosting".
This can't be fixed by Emacs, as the keypress never gets passed to it
at all (as can be verified using "xev").  You can work around this by
typing 'ESC |' instead.

*** "Compose Character" key does strange things when used as a Meta key.

453 454 455 456 457 458
If you define one key to serve as both Meta and Compose Character, you
will get strange results.  In previous Emacs versions, this "worked"
in that the key acted as Meta--that's because the older Emacs versions
did not try to support Compose Character.  Now Emacs tries to do
character composition in the standard X way.  This means that you
must pick one meaning or the other for any given key.

460 461
You can use both functions (Meta, and Compose Character) if you assign
them to two different keys.

*** C-z just refreshes the screen instead of suspending Emacs.

465 466
You are probably using a shell that doesn't support job control, even
though the system itself is capable of it.  Either use a different shell,
or set the variable 'cannot-suspend' to a non-nil value.

** Mailers and other helper programs

*** movemail compiled with POP support can't connect to the POP server.

473 474 475 476 477 478 479 480 481 482 483
This problem can occur if you do not configure --with-mailutils,
and don't have GNU Mailutils installed.  Then Emacs uses its own
version of movemail, which doesn't support secure POP connections.
To solve this, install GNU Mailutils.

Also, make sure that the 'pop' entry in /etc/services, or in the
services NIS map if your machine uses NIS, has the same port number as
the entry on the POP server.  A common error is for the POP server to
be listening on port 110, the assigned port for the POP3 protocol,
while the client is trying to connect on port 109, the assigned port
for the old POP protocol.

*** RMAIL gets error getting new mail.

RMAIL gets new mail from /usr/spool/mail/$USER using a program
called 'movemail'.  This program interlocks with /bin/mail using
the protocol defined by /bin/mail.

There are two different protocols in general use.  One of them uses
492 493
the 'flock' system call.  The other involves creating a lock file;
'movemail' must be able to write in /usr/spool/mail in order to do
this.  You control which one is used by defining, or not defining,
Glenn Morris's avatar
Glenn Morris committed
the macro MAIL_USE_FLOCK in config.h.
496 497

499 500
If your system uses the lock file protocol, and fascist restrictions
prevent ordinary users from writing the lock files in /usr/spool/mail,
501 502
you may need to make 'movemail' setgid to a suitable group such as
'mail'.  To do this,  use the following commands (as root) after doing the
make install.

505 506
        chgrp mail movemail
        chmod 2755 movemail

508 509 510 511 512 513
Installation normally copies movemail from the build directory to an
installation directory which is usually under /usr/local/lib.  The
installed copy of movemail is usually in the directory
/usr/local/lib/emacs/VERSION/TARGET.  You must change the group and
mode of the installed copy; changing the group and mode of the build
directory copy is ineffective.

*** rcs2log gives you the awk error message "too many fields".

517 518
This is due to an arbitrary limit in certain versions of awk.
The solution is to use gawk (GNU awk).

** Problems with hostname resolution

*** Emacs does not know your host's fully-qualified domain name.

524 525 526
For example, (system-name) returns some variation on
"localhost.localdomain", rather the name you were expecting.

You need to configure your machine with a fully qualified domain name,
528 529
(i.e., a name with at least one "."), either in /etc/hostname
or wherever your system calls for specifying this.

531 532
If you cannot fix the configuration, you can set the Lisp variable
mail-host-address to the value you want.

** NFS

536 537
*** Emacs says it has saved a file, but the file does not actually
appear on disk.

539 540 541 542
This can happen on certain systems when you are using NFS, if the
remote disk is full.  It is due to a bug in NFS (or certain NFS
implementations), and there is apparently nothing Emacs can do to
detect the problem.  Emacs checks the failure codes of all the system
calls involved in writing a file, including 'close'; but in the case
where the problem occurs, none of those system calls fails.

** PSGML conflicts with sgml-mode.

548 549 550 551 552 553 554
PSGML package uses the same names of some variables (like keymap)
as built-in sgml-mode.el because it was created as a replacement
of that package.  The conflict will be shown if you load
sgml-mode.el before psgml.el.  E.g. this could happen if you edit
HTML page and then start to work with SGML or XML file.  html-mode
(from sgml-mode.el) is used for HTML file and loading of psgml.el
(for sgml-mode or xml-mode) will cause an error.

556 557 558 559 560 561 562 563 564 565 566 567 568 569

*** Lines are not updated or new lines are added in the buffer upon commit.

When committing files located higher in the hierarchy than the examined
directory, some versions of the CVS program return an ambiguous message
from which PCL-CVS cannot extract the full location of the committed
files.  As a result, the corresponding lines in the PCL-CVS buffer are
not updated with the new revision of these files, and new lines are
added to the top-level directory.

This can happen with CVS versions 1.12.8 and 1.12.9.  Upgrade to CVS
1.12.10 or newer to fix this problem.

** Miscellaneous problems

572 573 574 575 576 577
*** Editing files with very long lines is slow.

For example, simply moving through a file that contains hundreds of
thousands of characters per line is slow, and consumes a lot of CPU.
This is a known limitation of Emacs with no solution at this time.

578 579
*** Emacs uses 100% of CPU time

580 581 582 583
This was a known problem with some old versions of the Semantic package.
The solution was to upgrade Semantic to version 2.0pre4 (distributed
with CEDET 1.0pre4) or later.  Note that Emacs includes Semantic since
23.2, and this issue does not apply to the included version.

585 586 587 588 589 590 591 592 593 594 595 596 597 598 599
*** Display artifacts on GUI frames on X-based systems.

This is known to be caused by using double-buffering (which is enabled
by default in Emacs 26 and later).  The artifacts typically appear
after commands that cause Emacs to scroll the display.

You can disable double-buffering by evaluating the following form:

  (modify-all-frames-parameters '((inhibit-double-buffering . t)))

To make this permanent, add it to your ~/.emacs init file.

Note that disabling double-buffering will cause flickering of the
display in some situations.

*** Self-documentation messages are garbled.
Jason Rumney's avatar
Jason Rumney committed

This means that the file 'etc/DOC' doesn't properly correspond
603 604
with the Emacs executable.  Redumping Emacs and then installing the
corresponding pair of files should fix the problem.

*** Programs running under terminal emulator do not recognize 'emacs'
terminal type.

609 610
The cause of this is a shell startup file that sets the TERMCAP
environment variable.  The terminal emulator uses that variable to
provide the information on the special terminal type that Emacs emulates.

613 614 615
Rewrite your shell startup file so that it does not change TERMCAP
in such a case.  You could use the following conditional which sets
it only if it is undefined.

    if ( ! ${?TERMCAP} ) setenv TERMCAP ~/my-termcap-file

619 620
Or you could set TERMCAP only when you set TERM--which should not
happen in a non-login shell.

*** In Shell mode, you get a ^M at the end of every line.

This happens to people who use tcsh, because it is trying to be too
smart.  It sees that the Shell uses terminal type 'unknown' and turns
626 627
on the flag to output ^M at the end of each line.  You can fix the
problem by adding this to your .cshrc file:

629 630 631
    if ($?INSIDE_EMACS && $?tcsh)
        unset edit
        stty -icrnl -onlcr -echo susp ^Z

634 635 636 637 638 639 640 641 642 643 644
*** In Shell buffers using ksh, resizing a window inserts random characters.

The characters come from the PS2 prompt, but they are not followed by
a newline, which messes up the next command you type.  This strange
effect is caused by Emacs 25 and later telling the shell that its
screen size changed.

To work around the problem, customize the option
'window-adjust-process-window-size-function' to "Do not adjust process
window sizes" (Lisp value 'ignore').

645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661
*** In Inferior Python mode, input is echoed and native completion doesn't work.

This happens when python uses a libedit based readline module, which
is the default on macOS.  This can be worked around by installing a
GNU readline based module instead, for example, using setuptools

    sudo easy_install gnureadline

And then rename the system's readline so that it won't be loaded:

    cd /Library/Frameworks/Python.framework/Versions/2.7/lib/python2.7/lib-dynload

See <> for more details on

*** Visiting files in some auto-mounted directories causes Emacs to print
'Error reading dir-locals: (file-error "Read error" "is a directory" ...'
664 665 666 667

This can happen if the auto-mounter mistakenly reports that
.dir-locals.el exists and is a directory.  There is nothing Emacs can
do about this, but you can avoid the issue by adding a suitable entry
to the variable 'locate-dominating-stop-dir-regexp'.  For example, if
669 670 671
the problem relates to "/smb/.dir-locals.el", set that variable
to a new value where you replace "net\\|afs" with "net\\|afs\\|smb".
(The default value already matches common auto-mount prefixes.)
See .

*** Attempting to visit remote files via ange-ftp fails.

If the error message is "ange-ftp-file-modtime: Specified time is not
representable", then this could happen when 'lukemftp' is used as the
ftp client.  This was reported to happen on Debian GNU/Linux, kernel
version 2.4.3, with 'lukemftp' 1.5-5, but might happen on other
680 681
systems as well.  To avoid this problem, switch to using the standard
ftp client.  On a Debian system, type

  update-alternatives --config ftp

and then choose /usr/bin/netkit-ftp.

*** Dired is very slow.

This could happen if getting a file system's status takes a long
690 691
time.  Possible reasons for this include:

  - ClearCase mounted filesystems (VOBs) that sometimes make 'df'
693 694 695 696
    response time extremely slow (dozens of seconds);

  - slow automounters on some old versions of Unix;

697 698
To work around the problem, you could use Git or some other
free-software program, instead of ClearCase.

*** ps-print commands fail to find prologue files ps-prin*.ps.
701 702 703 704 705 706 707

This can happen if you use an old version of X-Symbol package: it
defines compatibility functions which trick ps-print into thinking it
runs in XEmacs, and look for the prologue files in a wrong directory.

The solution is to upgrade X-Symbol to a later version.

*** On systems with shared libraries you might encounter run-time errors
Gerd Moellmann's avatar
Gerd Moellmann committed
709 710 711 712 713
from the dynamic linker telling you that it is unable to find some
shared libraries, for instance those for Xaw3d or image support.
These errors mean Emacs has been linked with a library whose shared
library is not in the default search path of the dynamic linker.

714 715 716
Similar problems could prevent Emacs from building, since the build
process invokes Emacs several times.

Gerd Moellmann's avatar
Gerd Moellmann committed
717 718 719 720 721 722 723 724 725 726
On many systems, it is possible to set LD_LIBRARY_PATH in your
environment to specify additional directories where shared libraries
can be found.

Other systems allow to set LD_RUN_PATH in a similar way, but before
Emacs is linked.  With LD_RUN_PATH set, the linker will include a
specified run-time search path in the executable.

Please refer to the documentation of your dynamic linker for details.

*** When you run Ispell from Emacs, it reports a "misalignment" error.

729 730 731 732
This can happen if you compiled the Ispell program to use ASCII
characters only and then try to use it from Emacs with non-ASCII
characters, like Latin-1.  The solution is to recompile Ispell with
support for 8-bit characters.

734 735
To see whether your Ispell program supports 8-bit characters, type
this at your shell's prompt:

     ispell -vv

739 740 741
and look in the output for the string "NO8BIT".  If Ispell says
"!NO8BIT (8BIT)", your speller supports 8-bit characters; otherwise it
does not.

743 744 745
To rebuild Ispell with 8-bit character support, edit the local.h file
in the Ispell distribution and make sure it does _not_ define NO8BIT.
Then rebuild the speller.

747 748
Another possible cause for "misalignment" error messages is that the
version of Ispell installed on your machine is old.  Upgrade.

750 751 752 753 754
Yet another possibility is that you are trying to spell-check a word
in a language that doesn't fit the dictionary you choose for use by
Ispell.  (Ispell can only spell-check one language at a time, because
it uses a single dictionary.)  Make sure that the text you are
spelling and the dictionary used by Ispell conform to each other.

756 757
If your spell-checking program is Aspell, it has been reported that if
you have a personal configuration file (normally ~/.aspell.conf), it
can cause this error.  Remove that file, execute 'ispell-kill-ispell'
in Emacs, and then try spell-checking again.

*** TLS problems, e.g., Gnus hangs when fetching via imaps
763 764 765 766 767 768

gnutls-cli 3.5.3 (2016-08-09) does not generate a "- Handshake was
completed" message that tls.el relies upon, causing affected Emacs
functions to hang.  To work around the problem, use older or newer
versions of gnutls-cli, or use Emacs's built-in gnutls support.

* Runtime problems related to font handling

771 772 773 774 775 776 777
** Characters are displayed as empty boxes or with wrong font under X.

*** This can occur when two different versions of FontConfig are used.
For example, XFree86 4.3.0 has one version and Gnome usually comes
with a newer version.  Emacs compiled with Gtk+ will then use the
newer version.  In most cases the problem can be temporarily fixed by
stopping the application that has the error (it can be Emacs or any
Ivan Shmakov's avatar
Ivan Shmakov committed
other application), removing ~/.fonts.cache-1, and then starting the
779 780 781 782 783 784 785 786 787 788 789 790
application again.  If removing ~/.fonts.cache-1 and restarting
doesn't help, the application with problem must be recompiled with the
same version of FontConfig as the rest of the system uses.  For KDE,
it is sufficient to recompile Qt.

*** Some fonts have a missing glyph and no default character.  This is
known to occur for character number 160 (no-break space) in some
fonts, such as Lucida but Emacs sets the display table for the unibyte
and Latin-1 version of this character to display a space.

*** Some of the fonts called for in your fontset may not exist on your
X server.

Each X font covers just a fraction of the characters that Emacs
supports.  To display the whole range of Emacs characters requires
794 795
many different fonts, collected into a fontset.  You can remedy the
problem by installing additional fonts.

The intlfonts distribution includes a full spectrum of fonts that can
display all the characters Emacs supports.  The etl-unicode collection
799 800 801 802
of fonts (available from
<>) includes fonts that
can display many Unicode characters; they can also be used by ps-print
and ps-mule to print Unicode characters.

** Under X, some characters appear improperly aligned in their lines.

You may have bad fonts.

808 809 810 811 812 813 814 815 816 817 818 819
** Under X, some characters are unexpectedly wide.

e.g. recent versions of Inconsolata show this issue for almost all of
its characters.  Due to what is probably an Xft bug, the determination
of the width of some characters is incorrect.  One workaround is to
build emacs with Cairo enabled ("configure --with-cairo" and have the
appropriate Cairo development packages installed) as this
configuration does not suffer from this problem.  See
<> and
for more discussion.

820 821 822 823 824 825 826 827
** Under X, an unexpected monospace font is used as the default font.

When compiled with XFT, Emacs tries to use a default font named
"monospace".  This is a "virtual font", which the operating system
(Fontconfig) redirects to a suitable font such as DejaVu Sans Mono.
On some systems, there exists a font that is actually named Monospace,
which takes over the virtual font.  This is considered an operating
system bug; see


831 832 833 834 835 836 837 838 839 840 841
If you encounter this problem, set the default font to a specific font
in your .Xresources or initialization file.  For instance, you can put
the following in your .Xresources:

Emacs.font: DejaVu Sans Mono 12

** Certain fonts make each line take one pixel more than it should.

This is because these fonts contain characters a little taller than
the font's nominal height.  Emacs needs to make sure that lines do not

** Font Lock displays portions of the buffer in incorrect faces.

845 846
By far the most frequent cause of this is a parenthesis '(' or a brace
'{' in column zero.  Font Lock assumes that such a paren is outside of
847 848 849 850 851 852 853 854
any comment or string.  This is of course not true in general, but the
vast majority of well-formatted program source files don't have such
parens, and therefore this assumption is used to allow optimizations
in Font Lock's syntactical analysis.  These optimizations avoid some
pathological cases where jit-lock, the Just-in-Time fontification
introduced with Emacs 21.1, could significantly slow down scrolling
through the buffer, especially scrolling backwards, and also jumping
to the end of a very large buffer.

Beginning with version 22.1, a parenthesis or a brace in column zero
857 858 859
is highlighted in bold-red face if it is inside a string or a comment,
to indicate that it could interfere with Font Lock (and also with
indentation) and should be moved or escaped with a backslash.

861 862 863
If you don't use large buffers, or have a very fast machine which
makes the delays insignificant, you can avoid the incorrect
fontification by setting the variable
'font-lock-beginning-of-syntax-function' to a nil value.  (This must
be done _after_ turning on Font Lock.)

867 868
Another alternative is to avoid a paren in column zero.  For example,
in a Lisp string you could precede the paren with a backslash.

** Emacs pauses for several seconds when changing the default font.

872 873 874 875
This has been reported for fvwm 2.2.5 and the window manager of KDE
2.1.  The reason for the pause is Xt waiting for a ConfigureNotify
event from the window manager, which the window manager doesn't send.
Xt stops waiting after a default timeout of usually 5 seconds.

A workaround for this is to add something like

emacs.waitForWM: false

to your X resources.  Alternatively, add '(wait-for-wm . nil)' to a
frame's parameter list, like this:

   (modify-frame-parameters nil '((wait-for-wm . nil)))

(this should go into your '.emacs' file).

** Underlines appear at the wrong position.

This is caused by fonts having a wrong UNDERLINE_POSITION property.
891 892
To avoid this problem (seen in some very old X releases and font packages),
set x-use-underline-position-properties to nil.

To see what is the value of UNDERLINE_POSITION defined by the font,
type 'xlsfonts -lll FONT' and look at the font's UNDERLINE_POSITION property.
Dave Love's avatar
Dave Love committed

** When using Exceed, fonts sometimes appear too tall.

899 900 901 902 903
When the display is set to an Exceed X-server and fonts are specified
(either explicitly with the -fn option or implicitly with X resources)
then the fonts may appear "too tall".  The actual character sizes are
correct but there is too much vertical spacing between rows,  which
gives the appearance of "double spacing".

905 906
To prevent this, turn off the Exceed's "automatic font substitution"
feature (in the font part of the configuration window).

908 909
** Subscript/superscript text in TeX is hard to read.

If 'tex-fontify-script' is non-nil, tex-mode displays
911 912 913 914 915 916 917 918 919
subscript/superscript text in the faces subscript/superscript, which
are smaller than the normal font and lowered/raised.  With some fonts,
nested superscripts (say) can be hard to read.  Switching to a
different font, or changing your antialiasing setting (on an LCD
screen), can both make the problem disappear.  Alternatively, customize
the following variables: tex-font-script-display (how much to
lower/raise); tex-suscript-height-ratio (how much smaller than
normal); tex-suscript-height-minimum (minimum height).

920 921 922 923 924 925 926 927 928 929 930 931 932 933
** Screen refresh is slow when there are special characters for which no suitable font is available

If the display is too slow in refreshing when you scroll to a new
region, or when you edit the buffer, it might be due to the fact that
some characters cannot be displayed in the default font, and Emacs is
spending too much time in looking for a suitable font to display them.

You can suspect this if you have several characters that are displayed
as small rectangles containing a hexadecimal code inside.

The solution is to install the appropriate fonts on your machine. For
instance if you are editing a text with a lot of math symbols, then
installing a font like 'Symbola' should solve this problem.

934 935 936 937
Another reason for slow display is reportedly the nerd-fonts
installation, even when Symbola is installed as well.  Uninstalling
nerd-fonts was reported to solve the problem in that case.

** Emacs running on GNU/Linux system with the m17n library Ver.1.7.1 or the
Michael Albinus's avatar
Michael Albinus committed
earlier version has a problem with rendering Bengali script.
940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967

The problem can be fixed by installing the newer version of the m17n
library (if any), or by following this procedure:

1. Locate the file BENG-OTF.flt installed on your system as part of the
m17n library.  Usually it is under the directory /usr/share/m17n.

2. Apply the following patch to BENG-OTF.flt

diff --git a/FLT/BENG-OTF.flt b/FLT/BENG-OTF.flt
index 45cc554..0cc5e76 100644
--- a/FLT/BENG-OTF.flt
+++ b/FLT/BENG-OTF.flt
@@ -232,7 +232,7 @@
    ("(.H)J" (1 :otf=beng=half+))
-   (".H" :otf=beng=blwf,half,vatu+)
+   (".+H" :otf=beng=blwf,half,vatu+)
    ("." =)))


If you can't modify that file directly, copy it to the directory
~/.m17n.d/ (create it if it doesn't exist), and apply the patch.

K. Handa's avatar
K. Handa committed
968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997
** Emacs running on GNU/Linux system with the m17n library Ver.1.7.1 or the
earlier version has a problem with rendering Lao script with OpenType font.

The problem can be fixed by installing the newer version of the m17n
library (if any), or by following this procedure:

1. Locate the file LAOO-OTF.flt installed on your system as part of the
m17n library.  Usually it is under the directory /usr/share/m17n.

2. Apply the following patch to LAOO-OTF.flt

diff --git a/FLT/LAOO-OTF.flt b/FLT/LAOO-OTF.flt
index 5504171..431adf8 100644
--- a/FLT/LAOO-OTF.flt
+++ b/FLT/LAOO-OTF.flt
@@ -3,7 +3,7 @@
 ;; See the end for copying conditions.

 (font layouter laoo-otf nil
-      (font (nil phetsarath\ ot unicode-bmp)))
+      (font (nil nil unicode-bmp :otf=lao\ )))

 ;;; <li> LAOO-OTF.flt


If you can't modify that file directly, copy it to the directory
~/.m17n.d/ (create it if it doesn't exist), and apply the patch.

* Internationalization problems

1000 1001 1002 1003 1004
** M-{ does not work on a Spanish PC keyboard.

Many Spanish keyboards seem to ignore that combination.  Emacs can't
do anything about it.

1005 1006 1007
** International characters aren't displayed under X.

*** Missing X fonts

1009 1010 1011 1012 1013 1014 1015 1016 1017
XFree86 4 contains many fonts in iso10646-1 encoding which have
minimal character repertoires (whereas the encoding part of the font
name is meant to be a reasonable indication of the repertoire
according to the XLFD spec).  Emacs may choose one of these to display
characters from the mule-unicode charsets and then typically won't be
able to find the glyphs to display many characters.  (Check with C-u
C-x = .)  To avoid this, you may need to use a fontset which sets the
font for the mule-unicode sets explicitly.  E.g. to use GNU unifont,
include in the fontset spec:

1019 1020 1021

** The UTF-8/16/7 coding systems don't encode CJK (Far Eastern) characters.

1025 1026 1027 1028 1029 1030 1031 1032 1033 1034
Emacs directly supports the Unicode BMP whose code points are in the
ranges 0000-33ff and e000-ffff, and indirectly supports the parts of
CJK characters belonging to these legacy charsets:

    GB2312, Big5, JISX0208, JISX0212, JISX0213-1, JISX0213-2, KSC5601

The latter support is done in Utf-Translate-Cjk mode (turned on by
default).   Which Unicode CJK characters are decoded into which Emacs
charset is decided by the current language environment.  For instance,
in Chinese-GB, most of them are decoded into chinese-gb2312.
Dave Love's avatar
Dave Love committed

1036 1037 1038 1039 1040
If you read UTF-8 data with code points outside these ranges, the
characters appear in the buffer as raw bytes of the original UTF-8
(composed into a single quasi-character) and they will be written back
correctly as UTF-8, assuming you don't break the composed sequences.
If you read such characters from UTF-16 or UTF-7 data, they are
substituted with the Unicode 'replacement character', and you lose
Dave Love's avatar
Dave Love committed

** Accented ISO-8859-1 characters are displayed as | or _.
Dave Love's avatar
Dave Love committed

1046 1047 1048 1049
Try other font set sizes (S-mouse-1).  If the problem persists with
other sizes as well, your text is corrupted, probably through software
that is not 8-bit clean.  If the problem goes away with another font
size, it's probably because some fonts pretend to be ISO-8859-1 fonts
when they are really ASCII fonts.  In particular the schumacher-clean
fonts have this bug in some versions of X.
Dave Love's avatar
Dave Love committed

To see what glyphs are included in a font, use 'xfd', like this:
Dave Love's avatar
Dave Love committed

  xfd -fn -schumacher-clean-medium-r-normal--12-120-75-75-c-60-iso8859-1
Dave Love's avatar
Dave Love committed

If this shows only ASCII glyphs, the font is indeed the source of the problem.
Dave Love's avatar
Dave Love committed

The solution is to remove the corresponding lines from the appropriate
1060 1061
'fonts.alias' file, then run 'mkfontdir' in that directory, and then run
'xset fp rehash'.

** The 'oc-unicode' package doesn't work with Emacs 21.
Dave Love's avatar
Dave Love committed

1065 1066
This package tries to define more private charsets than there are free
slots now.  The current built-in Unicode support is actually more
flexible.  (Use option 'utf-translate-cjk-mode' if you need CJK
1068 1069
support.)  Files encoded as emacs-mule using oc-unicode aren't
generally read correctly by Emacs 21.
Dave Love's avatar
Dave Love committed

* X runtime problems

** X keyboard problems

*** You "lose characters" after typing Compose Character key.
Dave Love's avatar
Dave Love committed

This is because the Compose Character key is defined as the keysym
Multi_key, and Emacs (seeing that) does the proper X
1079 1080
character-composition processing.  If you don't want your Compose key
to do that, you can redefine it with xmodmap.
Dave Love's avatar
Dave Love committed

For example, here's one way to turn it into a Meta key:

    xmodmap -e "keysym Multi_key = Meta_L"
Dave Love's avatar
Dave Love committed

1086 1087 1088
If all users at your site of a particular keyboard prefer Meta to
Compose, you can make the remapping happen automatically by adding the
xmodmap command to the xdm setup script for that display.
Dave Love's avatar
Dave Love committed

Ivan Shmakov's avatar
Ivan Shmakov committed
*** Using X Window System, control-shift-leftbutton makes Emacs hang.
Dave Love's avatar
Dave Love committed

Use the shell command 'xset bc' to make the old X Menu package work.
Dave Love's avatar
Dave Love committed

*** C-SPC fails to work on Fedora GNU/Linux (or with fcitx input method).

Fedora Core 4 steals the C-SPC key by default for the 'iiimx' program
which is the input method for some languages.  It blocks Emacs users
from using the C-SPC key for 'set-mark-command'.

1100 1101
One solutions is to remove the '<Ctrl>space' from the 'Iiimx' file
which can be found in the '/usr/lib/X11/app-defaults' directory.
1102 1103
However, that requires root access.

Another is to specify 'Emacs*useXIM: false' in your X resources.

Another is to build Emacs with the '--without-xim' configure option.

1108 1109 1110 1111
The same problem happens on any other system if you are using fcitx
(Chinese input method) which by default use C-SPC for toggling.  If
you want to use fcitx with Emacs, you have two choices.  Toggle fcitx
by another key (e.g. C-\) by modifying ~/.fcitx/config, or be
accustomed to use C-@ for 'set-mark-command'.

1114 1115 1116
*** Link-time optimization with clang doesn't work on Fedora 20.

As of May 2014, Fedora 20 has broken plugin support in clang
1117 1118 1119
(tested with clang-3.4-6.fc20) - 'clang'
prints '' instead of full path to plugin shared library, and
'clang -flto' is unable to find the plugin with the following error:
1120 1121 1122 1123 1124 1125 1126 1127

/bin/ld: error: /usr/bin/../lib/ could not load plugin library:
/usr/bin/../lib/ cannot open shared object file: No such file
or directory

The only way to avoid this is to build your own clang from source code
repositories, as described at

*** M-SPC seems to be ignored as input.
Dave Love's avatar
Dave Love committed

1130 1131
See if your X server is set up to use this as a command
for character composition.
Dave Love's avatar
Dave Love committed

*** The S-C-t key combination doesn't get passed to Emacs on X.
Dave Love's avatar
Dave Love committed

1135 1136
This happens because some X configurations assign the Ctrl-Shift-t
combination the same meaning as the Multi_key.  The offending
definition is in the file '...lib/X11/locale/iso8859-1/Compose'; there
1138 1139
might be other similar combinations which are grabbed by X for similar
Dave Love's avatar
Dave Love committed

We think that this can be countermanded with the 'xmodmap' utility, if
you want to be able to bind one of these key sequences within Emacs.
Dave Love's avatar
Dave Love committed

*** Under X, C-v and/or other keys don't work.
Dave Love's avatar
Dave Love committed

1146 1147
These may have been intercepted by your window manager.
See the WM's documentation for how to change this.
Dave Love's avatar
Dave Love committed