237 lines
6.2 KiB
HTML
237 lines
6.2 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of Compose</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>Compose</H1>
|
|
Section: File Formats (5)<BR>Updated: libX11 1.6.9<BR><A HREF="#index">Index</A>
|
|
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
|
|
|
<A NAME="lbAB"> </A>
|
|
<H2>NAME</H2>
|
|
|
|
Compose - X client mappings for multi-key input sequences
|
|
<A NAME="lbAC"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
The X library, libX11, provides a simple input method for characters
|
|
beyond those represented on typical keyboards using sequences of key
|
|
strokes that are combined to enter a single character.
|
|
<P>
|
|
|
|
The compose file is searched for in the following order:
|
|
<DL COMPACT>
|
|
<DT id="1">-<DD>
|
|
If the environment variable
|
|
<B>$XCOMPOSEFILE</B>
|
|
|
|
is set, its value is used as the name of the Compose file.
|
|
<DT id="2">-<DD>
|
|
If the user's home directory has a file named
|
|
<I>.XCompose</I>,
|
|
|
|
it is used as the Compose file.
|
|
<DT id="3">-<DD>
|
|
The system provided compose file is used by mapping the locale to a compose
|
|
file from the list in
|
|
<I>/usr/share/X11/locale/compose.dir</I>.
|
|
|
|
</DL>
|
|
<P>
|
|
|
|
Compose files can use an
|
|
"<B>include</B>"
|
|
|
|
instruction.
|
|
This allows local modifications to be made to existing compose
|
|
files without including all of the content directly.
|
|
For example, the
|
|
system's iso8859-1 compose file can be included with a line like this:
|
|
<DL COMPACT><DT id="4"><DD>
|
|
<B>include "</B><I>%S/iso8859-1/Compose</I><B>"</B>
|
|
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
There are several substitutions that can be made in the file name of the
|
|
include instruction:
|
|
<DL COMPACT>
|
|
<DT id="5"><I>%H</I>
|
|
|
|
<DD>
|
|
expands to the user's home directory (the
|
|
<B>$HOME</B>
|
|
|
|
environment variable)
|
|
<DT id="6"><I>%L</I>
|
|
|
|
<DD>
|
|
expands to the name of the locale specific Compose file (i.e.,
|
|
"<I>/usr/share/X11/locale/<localename>/Compose</I>")
|
|
|
|
<DT id="7"><I>%S</I>
|
|
|
|
<DD>
|
|
expands to the name of the system directory for Compose files (i.e.,
|
|
"<I>/usr/share/X11/locale</I>")
|
|
|
|
</DL>
|
|
<P>
|
|
|
|
For example, you can include in your compose file the default Compose file
|
|
by using:
|
|
<DL COMPACT><DT id="8"><DD>
|
|
<B>include "%L"</B>
|
|
|
|
</DL>
|
|
|
|
and then rewrite only the few rules that you need to change.
|
|
New
|
|
compose rules can be added, and previous ones replaced.
|
|
<A NAME="lbAD"> </A>
|
|
<H2>FILE FORMAT</H2>
|
|
|
|
|
|
Compose files are plain text files, with a separate line for each compose
|
|
sequence.
|
|
Comments begin with <B>#</B> characters.
|
|
Each compose sequence
|
|
specifies one or more events and a resulting input sequence, with an optional
|
|
comment at the end of the line:
|
|
<DL COMPACT><DT id="9"><DD>
|
|
<I>EVENT</I> [<I>EVENT</I>...] <B>:</B> <I>RESULT</I> [<B>#</B> <I>COMMENT</I>]
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
Each event consists of a specified input keysym, and optional modifier states:
|
|
<DL COMPACT><DT id="10"><DD>
|
|
[([<B>!</B>] ([<B>~</B>] <I>MODIFIER</I>)...) | <B>None</B>] <B><</B><I>keysym</I><B>></B>
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
If the modifier list is preceded by
|
|
"<B>!</B>"
|
|
|
|
it must match exactly.
|
|
MODIFIER may be one of Ctrl, Lock, Caps, Shift, Alt or Meta.
|
|
Each modifier may be preceded by a
|
|
"<B>~</B>"
|
|
|
|
character to indicate that the modifier must not be present.
|
|
If
|
|
"<B>None</B>"
|
|
|
|
is specified, no modifier may be present.
|
|
<P>
|
|
|
|
The result specifies a string, keysym, or both, that the X client receives
|
|
as input when the sequence of events is input:
|
|
<DL COMPACT><DT id="11"><DD>
|
|
<B>"</B><I>STRING</I><B>"</B> | <I>keysym</I> | <B>"</B><I>STRING</I><B>"</B> <I>keysym</I>
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
Keysyms are specified without the <B>XK_</B> prefix.
|
|
<P>
|
|
|
|
Strings may be direct text encoded in the locale for which the compose file is
|
|
to be used, or an escaped octal or hexadecimal character code.
|
|
Octal codes
|
|
are specified as <B>"\123"</B> and hexadecimal codes as
|
|
<B>"\x3a"</B>.
|
|
It is not necessary to specify in the right part of a rule a locale encoded
|
|
string in addition to the keysym name.
|
|
If the string is omitted, Xlib
|
|
figures it out from the keysym according to the current locale.
|
|
I.e., if a rule looks like:
|
|
<DL COMPACT><DT id="12"><DD>
|
|
<B><dead_grave> <A> : "\300" Agrave</B>
|
|
</DL>
|
|
|
|
the result of the composition is always the letter with the "\300"
|
|
code.
|
|
But if the rule is:
|
|
<DL COMPACT><DT id="13"><DD>
|
|
<B><dead_grave> <A> : Agrave</B>
|
|
</DL>
|
|
|
|
the result depends on how Agrave is mapped in the current locale.
|
|
<A NAME="lbAE"> </A>
|
|
<H2>ENVIRONMENT</H2>
|
|
|
|
<DL COMPACT>
|
|
<DT id="14"><B>XCOMPOSEFILE</B>
|
|
|
|
<DD>
|
|
File to use for compose sequences.
|
|
<DT id="15"><B>XCOMPOSECACHE</B>
|
|
|
|
<DD>
|
|
Directory to use for caching compiled compose files.
|
|
</DL>
|
|
<A NAME="lbAF"> </A>
|
|
<H2>FILES</H2>
|
|
|
|
<DL COMPACT>
|
|
<DT id="16"><I>$HOME/.XCompose</I>
|
|
|
|
<DD>
|
|
User default compose file if XCOMPOSEFILE is not set.
|
|
<DT id="17"><I>/usr/share/X11/locale/compose.dir</I>
|
|
|
|
<DD>
|
|
File listing the compose file path to use for each locale.
|
|
<DT id="18"><I>/usr/share/X11/locale/<localemapping>/Compose</I>
|
|
|
|
<DD>
|
|
System default compose file for the locale, mapped via compose.dir.
|
|
<DT id="19"><I>/var/cache/libx11/compose/</I>
|
|
|
|
<DD>
|
|
System-wide cache directory for compiled compose files.
|
|
<DT id="20"><I>$HOME/.compose-cache/</I>
|
|
|
|
<DD>
|
|
Per-user cache directory for compiled compose files.
|
|
</DL>
|
|
<A NAME="lbAG"> </A>
|
|
<H2>SEE ALSO</H2>
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?3+XLookupString">XLookupString</A></B>(3),
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?3+XmbLookupString">XmbLookupString</A></B>(3),
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?3+XwcLookupString">XwcLookupString</A></B>(3),
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?3+Xutf8LookupString">Xutf8LookupString</A></B>(3),
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?1+mkcomposecache">mkcomposecache</A></B>(1),
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?7+locale">locale</A></B>(7).
|
|
|
|
<BR>
|
|
|
|
<I>Xlib - C Language X Interface</I>
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="21"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="22"><A HREF="#lbAC">DESCRIPTION</A><DD>
|
|
<DT id="23"><A HREF="#lbAD">FILE FORMAT</A><DD>
|
|
<DT id="24"><A HREF="#lbAE">ENVIRONMENT</A><DD>
|
|
<DT id="25"><A HREF="#lbAF">FILES</A><DD>
|
|
<DT id="26"><A HREF="#lbAG">SEE ALSO</A><DD>
|
|
</DL>
|
|
<HR>
|
|
This document was created by
|
|
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
|
using the manual pages.<BR>
|
|
Time: 00:06:02 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|