** User init file (C-h v user-init-file)
-SXEmacs searches for its init file in `~/.sxemacs/init.el'.
-Symlinking your old ~/.xemacs directory should be enough to get you up
-and running.
+SXEmacs looks for user init files in `user-init-directory'. The
+preferred directory is: ${XDG_CONFIG_HOME}/sxemacs but it can fall
+back to the old ~/.sxemacs directory.
- $ ln -s ~/.xemacs ~/.sxemacs RET
+The search order is:
+
+ ${XDG_CONFIG_HOME}/sxemacs
+ ${HOME}/.config/sxemacs # if $XDG_CONFIG_HOME is not set
+ ${HOME}/.sxemacs # if other dirs don't exist
+
+You can also force the use of ~/.sxemacs regardless of the existence
+of the XDG dir/var by setting $SXE_USE_LEGACY environment variable to
+a non-nil value.
+
+If you're coming from XEmacs, symlinking your old ~/.xemacs directory
+to a SXEmacs location should be enough to get you up and running:
+
+ $ ln -svfn ${HOME}/.xemacs ${XDG_CONFIG_HOME}/sxemacs
BTW, unlike XEmacs, SXEmacs doesn't attempt to "migrate" your old init
file or Gnu/Emacs .emacs file.
** Packages Hierarchy
+*** System-wide Packages (late-packages)
+
The default location that SXEmacs searches for packages is
`$prefix/share/sxemacs/'. The same as for the user-init-file, a
symlink is all you need to get up and running.
- $ ln -s /usr/local/lib/xemacs /usr/local/share/sxemacs RET
+ $ ln -svfn /usr/local/lib/xemacs /usr/local/share/sxemacs
+
+*** User Packages in ${HOME} (early-packages)
+
+For packages that you keep in your ${HOME}, the preferred location is:
+${XDG_DATA_HOME}/sxemacs. This is normally ${HOME}/.local/share/sxemacs,
+and SXEmacs will use that if ${XDG_DATA_HOME} is not set.
+
+These packages may also be located in ~/.sxemacs if that is where you
+have your user-init-directory set to.
* Build Quirks
you have taglib installed. Use the included ffi-taglib.el.
+*** XCreateIC fails at startup
+
+SXEmacs sometimes fails to create the input context with XCreateIC on
+non-C languages. SXEmacs will include the values of the LANG and
+XMODIFIERS environment variables which influence the behavior of
+XCreateIC. Failures have been observed with XMODIFIERS=@im=ibus
+
+
+*** Text gets garbled/corrupted with Xorg ATI driver
+
+Some versions of the Xorg ATI driver present display issues where text
+display gets corrupted. Because of the conservative way SXEmacs
+updates the screen it is more susceptible to these issues than other
+applications.
+
+Some users have reported the problem goes away when using proprietary
+drivers. CAVEAT EMPTOR: Proprietary drivers have also been reported
+to break other parts of the system, most notabable are bad
+interactions with graphic boot package Plymouth when it asks for
+password for encrypted volumes at boot.
+
+
* Original XEmacs PROBLEMS File
===============================