/usr/share/doc/tklib/html/khim.html is in tklib 0.5-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 | <html><head>
<title>khim - Kevin's Hacky Input Method</title>
<style type="text/css"><!--
HTML {
background: #FFFFFF;
color: black;
}
BODY {
background: #FFFFFF;
color: black;
}
DIV.doctools {
margin-left: 10%;
margin-right: 10%;
}
DIV.doctools H1,DIV.doctools H2 {
margin-left: -5%;
}
H1, H2, H3, H4 {
margin-top: 1em;
font-family: sans-serif;
font-size: large;
color: #005A9C;
background: transparent;
text-align: left;
}
H1.title {
text-align: center;
}
UL,OL {
margin-right: 0em;
margin-top: 3pt;
margin-bottom: 3pt;
}
UL LI {
list-style: disc;
}
OL LI {
list-style: decimal;
}
DT {
padding-top: 1ex;
}
UL.toc,UL.toc UL, UL.toc UL UL {
font: normal 12pt/14pt sans-serif;
list-style: none;
}
LI.section, LI.subsection {
list-style: none;
margin-left: 0em;
text-indent: 0em;
padding: 0em;
}
PRE {
display: block;
font-family: monospace;
white-space: pre;
margin: 0%;
padding-top: 0.5ex;
padding-bottom: 0.5ex;
padding-left: 1ex;
padding-right: 1ex;
width: 100%;
}
PRE.example {
color: black;
background: #f5dcb3;
border: 1px solid black;
}
UL.requirements LI, UL.syntax LI {
list-style: none;
margin-left: 0em;
text-indent: 0em;
padding: 0em;
}
DIV.synopsis {
color: black;
background: #80ffff;
border: 1px solid black;
font-family: serif;
margin-top: 1em;
margin-bottom: 1em;
}
UL.syntax {
margin-top: 1em;
border-top: 1px solid black;
}
UL.requirements {
margin-bottom: 1em;
border-bottom: 1px solid black;
}
--></style>
</head>
<! -- Generated from file '' by tcllib/doctools with format 'html'
-->
<! -- CVS: $Id$ khim.n
-->
<body><div class="doctools">
<h1 class="title">khim(3tk) 1.0 khim "Kevin's Hacky Input Method"</h1>
<div id="name" class="section"><h2><a name="name">Name</a></h2>
<p>khim - Provides key bindings for entering international characters on a keyboard that does not support them</p>
</div>
<div id="toc" class="section"><h2><a name="toc">Table Of Contents</a></h2>
<ul class="toc">
<li class="section"><a href="#toc">Table Of Contents</a></li>
<li class="section"><a href="#synopsis">Synopsis</a></li>
<li class="section"><a href="#section1">Description</a></li>
<li class="section"><a href="#section2">PROCEDURES</a></li>
<li class="section"><a href="#section3">LOCALISATION</a></li>
<li class="section"><a href="#section4">ACKNOWLEDGMENTS</a></li>
<li class="section"><a href="#keywords">Keywords</a></li>
</ul>
</div>
<div id="synopsis" class="section"><h2><a name="synopsis">Synopsis</a></h2>
<div class="synopsis">
<ul class="requirements">
<li>package require <b class="pkgname">Tcl</b></li>
<li>package require <b class="pkgname">khim <span class="opt">?1.0?</span></b></li>
</ul>
<ul class="syntax">
<li><a href="#1"><b class="cmd">::khim::getOptions</b> <i class="arg">path</i></a></li>
<li><a href="#2"><b class="cmd">::khim::getConfig</b></a></li>
<li><a href="#3"><b class="cmd">::khim::setConfig</b> <i class="arg">version</i> <i class="arg">enabled</i> <i class="arg">compose</i> <i class="arg">map</i></a></li>
<li><a href="#4"><b class="cmd">::khim::showHelp</b> <i class="arg">path</i></a></li>
</ul>
</div>
</div>
<div id="section1" class="section"><h2><a name="section1">Description</a></h2>
<p>This package provides a set of key bindings to allow
a user to enter arbitrary characters on a keyboard that
does not support them. It works by designating some seldom-used key
of the keyboard as a "Compose" key (this key is distinct from any key
so labeled, and is often "Pause," "F12" or "L2"), and having the
"Compose" key, followed by a two-key sequence, have the effect of
inserting some character in a widget.
In addition, the "Compose" key, when struck twice in succession,
brings up a dialog containing a Unicode character map, allowing
arbitrary characters to be inserted.</p>
<p>The vast bulk of the package's functionality is implemented in a
single bindtag, <b class="const">KHIM</b>. An application can request that any
text or entry widget use the package to allow for entry of arbitrary
characters by placing this binding tag ahead of the <b class="const">Text</b> or
<b class="const">Entry</b> binding tag for the widget:</p>
<pre class="example">
text .t -width 80 -height 24
bindtags .t {.t KHIM Text . all}
</pre>
<p>Note that the <b class="const">KHIM</b> tag must precede the <b class="const">Text</b> or
<b class="const">Entry</b> class binding, or the package will not function
correctly.</p>
</div>
<div id="section2" class="section"><h2><a name="section2">PROCEDURES</a></h2>
<p>In addition to commands supporting the KHIM binding tag, the following
commands are exported from the package:</p>
<dl class="definitions">
<dt><a name="1"><b class="cmd">::khim::getOptions</b> <i class="arg">path</i></a></dt>
<dd><p>Posts a top-level modal dialog with the path name <i class="arg">path</i> that
prompts the user for KHIM options. The user is allowed to reconfigure
the key sequences for the "Compose" key, change the choice of key to
use for the "Compose" function, and enable/disable the KHIM key
bindings entirely.</p></dd>
<dt><a name="2"><b class="cmd">::khim::getConfig</b></a></dt>
<dd><p>Returns a Tcl script that restores the current configuration of KHIM:
the enabled/disabled state, the choice of "Compose" key, and the key
sequences that may be composed. This script is designed to be
saved to a configuration file for use in a subsequent invocation of
the same application:</p>
<pre class="example">
# Save KHIM configuration
set f [open ~/.khimrc w]
puts $f [::khim::getConfig]
close $f
# Restore KHIM configuration
source ~/.khimrc
</pre>
</dd>
<dt><a name="3"><b class="cmd">::khim::setConfig</b> <i class="arg">version</i> <i class="arg">enabled</i> <i class="arg">compose</i> <i class="arg">map</i></a></dt>
<dd><p>Restores an earlier saved configuration. Few, if any, applications
will call this command in any other way than to evaluate it as
returned from <b class="cmd">::khim::getConfig</b>.</p></dd>
<dt><a name="4"><b class="cmd">::khim::showHelp</b> <i class="arg">path</i></a></dt>
<dd><p>Displays a top-level dialog giving user-level help for KHIM; the
dialog will have the path name <i class="arg">path</i>.</p></dd>
</dl>
</div>
<div id="section3" class="section"><h2><a name="section3">LOCALISATION</a></h2>
<p>Programmers who wish to make KHIM available in a non-English-speaking
locale may do so by providing a <b class="const">.msg</b> file with the appropriate
localised text. The catalog requires the following messages:</p>
<dl class="definitions">
<dt><b class="const">Apply</b></dt>
<dd><p>Text that will appear on the "Apply" button in the dialog that sets
KHIM options.</p></dd>
<dt><b class="const">Cancel</b></dt>
<dd><p>Text that will appear on the "Cancel" button in several dialogs.</p></dd>
<dt><b class="const">Change</b></dt>
<dd><p>Text that will appear on the "Change" button, which alters the binding
of a pair of composed characters (creating or replacing as
appropriate).</p></dd>
<dt><b class="const">Character</b></dt>
<dd><p>Text that will appear on the label of the entry widget that accepts a
character resulting from a composed sequence.</p></dd>
<dt><b class="const">{Compose Key}</b></dt>
<dd><p>Window title for a dialog that prompts the user to strike the key that
will be used for the "Compose" key.</p></dd>
<dt><b class="const">{Compose key:}</b></dt>
<dd><p>Label that identifies a component showing the "Compose" key choice in
the KHIM options dialog.</p></dd>
<dt><b class="const">{Composed sequence must be two characters long}</b></dt>
<dd><p>Error message that is displayed if the user attempts to define a
"Compose" sequence that is shorter or longer than two characters.</p></dd>
<dt><b class="const">Delete</b></dt>
<dd><p>Text for a button that deletes a "Compose" sequence.</p></dd>
<dt><b class="const">Help...</b></dt>
<dd><p>Text for a button that displays the KHIM user help dialog.</p></dd>
<dt><b class="const">HELPTEXT</b></dt>
<dd><p>Complete text for the user-level help for KHIM. Refer to
"<b class="file">en.msg</b>" for the English-language version of the help.</p></dd>
<dt><b class="const">{Input key sequence}</b></dt>
<dd><p>Text for a label of the entry widget that prompts the user for a
two-character sequence to use with the "Compose" key.</p></dd>
<dt><b class="const">{Insert Character}</b></dt>
<dd><p>Window title of the dialog box that displays a Unicode character map
and prompts the user to select a character to insert.</p></dd>
<dt><b class="const">{Key sequences}</b></dt>
<dd><p>Text for a label at the head of a listbox showing the composed
sequences that are currently bound.</p></dd>
<dt><b class="const">{KHIM Controls}</b></dt>
<dd><p>Window title for the dialog box that prompts for KHIM settings.</p></dd>
<dt><b class="const">{KHIM Help}</b></dt>
<dd><p>Window title for the window that display help text for KHIM.</p></dd>
<dt><b class="const">OK</b></dt>
<dd><p>Label for the OK button on several dialogs.</p></dd>
<dt><b class="const">Select code page:</b></dt>
<dd><p>Label for a spinbox that prompts the user for a Unicode code page number.</p></dd>
<dt><b class="const">SELECT COMPOSE KEY</b></dt>
<dd><p>A message, which should be composed in short lines, prompting the user
to press the key that will become the "Compose" key in KHIM.</p></dd>
<dt><b class="const">Unicode...</b></dt>
<dd><p>Text for a button that brings up the character map to select the
character to which a composed sequence binds.</p></dd>
<dt><b class="const">{Use KHIM}</b></dt>
<dd><p>Text for a checkbutton that asks whether the user wishes to use KHIM
to manage composed key sequences.</p></dd>
</dl>
</div>
<div id="section4" class="section"><h2><a name="section4">ACKNOWLEDGMENTS</a></h2>
<p>KHIM was originally inspired by the key bindings that Brent Welch
developed for the 'sedit' editor used in the 'exmh' mail user agent.
The code for KHIM is entirely separate from that for 'sedit'.</p>
</div>
<div id="keywords" class="section"><h2><a name="keywords">Keywords</a></h2>
<p>character, i18n, input, international, method</p>
</div>
</div></body></html>
|