1XNEURRC(5)                    File Formats Manual                   XNEURRC(5)
2
3
4

NAME

6       xneurrc - configuration file for XNeur
7

DESCRIPTION

9       In this file defined options for XNeur. May be created or changed manu‐
10       allly  or  with  gXNeur  or  kXNeur.  Location  for  manual   settings:
11       ~/.xneur/xneurrc. Location of base settings: {prefix}/etc/xneur/xneurrc
12

OPTIONS

14       Version <number>
15               Defines  conformity  of  the  configuration file to the program
16               version. For XNeur version 0.5.0,  the  value  of  <number>  is
17               0.5.0.
18
19       ManualMode <param>
20               Describes  program working mode. Here, the value of <param> can
21               be "Yes" or "No", which means, respectively, work in manual  or
22               automatic mode.
23
24               In  the  automatic  mode,  the  program "on fly" determines the
25               input language and switches the keyboard layout,  at  the  same
26               time  changing  the word typed in. In the manual mode, the pro‐
27               gram does not use algorithms of  language  recognition,  layout
28               switching  and  text  conversion  take place on user request by
29               pressing hot keys.
30
31       LogLevel <level>
32               Defines level of diagnostic output to console.
33
34               Here, <level>  takes  the  values  "Error",  "Warning",  "Log",
35               "Debug",  "Trace".  By  changing  this parameter, the detail of
36               output to console can be controlled.
37
38       ExcludeLanguage <language>
39               Defines the language, with which the program WILL NOT work.
40
41               Here, <language> stands for the language, for which the  layout
42               should be specified (e.g. ru, us, by, de...).
43
44       DefaultXkbGroup <group>
45               Define initial keyboard layout for all new applications.
46
47               Here, <group> stands for the number of XKB layout for this lan‐
48               guage in the system (takes values from 0 to 3).
49
50       ExcludeApp <app_name>
51               Defines an application, in which the program WILL NOT work.
52
53               Here, <app_name> is an identifier of the program window,  input
54               in  which  is  processed  by XNeur.  <app_name> can be obtained
55               with the xprop utility.  Multiple entries for this option in  a
56               single  configuration file are allowed, like "one program - one
57               option ExcludeApp".
58
59       SetAutoApp <app_name>
60               Defines an application, in which the program will  always  work
61               in the automatic mode, independent of the DefaultMode option.
62
63               Here,  <app_name> is an identifier of the program window, input
64               in which is processed by xneur.  app_name can be obtained  with
65               the  xprop utility.  Multiple entries for this option in a sin‐
66               gle configuration file are allowed, like  "one  program  -  one
67               option SetAutoApp".
68
69       SetManualApp <app_name>
70               Defines  an  application, in which the program will always work
71               in the manual mode, independent of the DefaultMode option.
72
73               Here, <app_name> is an identifier of the program window,  input
74               in  which is processed by xneur.  app_name can be obtained with
75               the xprop utility.  Multiple entries for this option in a  sin‐
76               gle  configuration  file  are  allowed, like "one program - one
77               option SetManualApp".
78
79       AddBind <action> [Control | Alt | Shift | Super] [key]
80               Defines hot keys for xneur control.
81
82               Here, <action> stands for an action of XNeur, <key> stands  for
83               a special key.
84
85               <action>  takes  the  following  values:  "ChangeWord" (replace
86               word/cancel last  auto  replacement),  "ChangeString"  (replace
87               last  string),  "ChangeMode"  (switch  between the auto and the
88               manual program modes), "ChangeSelected" (convert selected  text
89               to another layout), "TranslitSelected" (convert selected Cyril‐
90               lic test to translit), "ChangecaseSelected" (change  lettercase
91               of  selected  text),  "EnableLayout1" (enable of first layout),
92               "EnableLayout2"  (enable  of  second  layout),  "EnableLayout3"
93               (enable  of  third  layout),  "EnableLayout4" (enable of fourth
94               layout), "ReplaceAbbreviation" (replace  abbreviation  to  full
95               text)  or "BlockKeyboardAndMouseEvents" (blocking all events of
96               keyboard and mouse).
97
98               [key] takes the values defined in  your  latin  keyboard.  Skip
99               this value if hot key undefined.
100
101       AddAction [Control | Alt | Shift | Super] <key> <action>
102               Defines hot keys for user actions.
103
104               Here,  <action>  is  user actions (e.g. firefox or gnome-termi‐
105               nal), <key> stands for a special key.
106
107               <key> takes the values defined in your latin keyboard.
108
109       ReplaceAbbreviationIgnoreLayout <param>
110               This option enable or disable of the ignore keyboard layout for
111               abbreviations list.
112
113               Here, <param> takes the values "Yes", "No".
114
115       ReplaceAbbreviation <abbreviation> <full_text>
116               Define an abbreviation, which be replased to full text.
117
118               Here,  <abbreviation>  is  abreviation and <full_text> is text.
119               Multiple entries for this option in a single configuration file
120               are  allowed, like "one abbreviation - one option ReplaceAbbre‐
121               viation".
122
123       PlaySound <param>
124               This option enable or disable sound playing.
125
126               Here, <param> takes the values "Yes", "No".
127
128       AddSound <action> <state> <sound>
129               Binds sounds for some actions.
130
131               Here,  <action>  takes  the  following  values:   "XneurStart",
132               "XneurReload",  "XneurStop",  "PressKeyLayout1",  "PressKeyLay‐
133               out2", "PressKeyLayout3",  "PressKeyLayout4",  "EnableLayout1",
134               "EnableLayout2",  "EnableLayout3", "EnableLayout4", "Automatic‐
135               ChangeWord",  "ManualChangeWord",  "ChangeString",   "ChangeSe‐
136               lected",  "TranslitSelected", "ChangecaseSelected", "ReplaceAb‐
137               breviation",  "CorrectIncidentalCaps",   "CorrectTwoCapitalLet‐
138               ter", "ExecuteUserAction" and "BlockKeyboardAndMouseEvents".
139
140               <sound>  is  .wav  file  placed  in ~/.xneur/sounds or in basic
141               place ({prefix}/share/xneur/sounds/).
142
143               <state> takes the values "Disable", "Enable".
144
145       SoundVolumePercent <percent>
146               Defined sound playing volume percent.
147
148               Here, <percent> takes the values from 0 to 100.
149
150       EducationMode <param>
151               Defines, if XNeur will work in  self-training.  A  wrong  input
152               will  be added to the dictionary, if it is twice converted into
153               a specific layout manually. If this option  is  on,  this  will
154               lead to a bigger dictionary. Does not make sence for the manual
155               operating mode.
156
157               Here, <param> takes the values "Yes", "No".
158
159       LayoutRememberMode <param>
160               This option enable or disable layout remember for each window
161
162               Here, <param> takes the values "Yes", "No".
163
164       LayoutRememberModeForApp <app_name>
165               This option force enable layout remember for each  application,
166               not window.
167
168               Here,  <app_name> is an identifier of the program window, input
169               in which is processed by xneur.  app_name can be obtained  with
170               the xprop utility.
171
172       SaveSelectionMode <param>
173               Define,  if  a  selection will stay after changes, made by user
174               actions, defined by the AddBind parameter.
175
176               Here, <param> takes the values "Yes", "No".
177
178       RotateLayoutAfterChangeSelectedMode <param>
179               This option enable or disable  rotating  layout  after  convert
180               selected text.
181
182               Here, <param> takes the values "Yes", "No".
183
184       SendDelay <value>
185               This  option define delay in milliseconds before sendind events
186               to application.
187
188               Here, <value> must be until 0 to 50.
189
190       LogSave <param>
191               This option enable or disable logging keyboard. Log  places  in
192               ~/.xneur/xneurlog
193
194               Here, <param> takes the values "Yes", "No".
195
196       LogSize <bytes>
197               This option set max size of log file (bytes)
198
199       LogMail <e-mail>
200               This  option  define  e-mail  for  send  log file, if it's size
201               greater then max size
202
203       LogHostIP <ip>
204               This option define ip of host to send e-mail without login  and
205               password.
206
207       LogPort <port>
208               This  option  define  port of host to send e-mail without login
209               and password.
210
211       CorrectIncidentalCaps <param>
212               This option enable or disable  correction  of  iNCIDENTAL  Cap‐
213               sLock.
214
215               Here, <param> takes the values "Yes", "No".
216
217       CorrectTwoCapitalLetter <param>
218               This option enable or disable correction of two CApital letter.
219
220               Here, <param> takes the values "Yes", "No".
221
222       FlushBufferWhenPressEscape <param>
223               This  option  enable  or  disable flushing internal buffer when
224               pressed Escape.
225
226               Here, <param> takes the values "Yes", "No".
227
228       FlushBufferWhenPressEnter <param>
229               This option enable or disable  flushing  internal  buffer  when
230               pressed Enter or Tab.
231
232               Here, <param> takes the values "Yes", "No".
233
234       DontProcessWhenPressEnter <param>
235               This  option  disable  or  enable  processing word when pressed
236               Enter or Tab.
237
238               Here, <param> takes the values "Yes", "No".
239
240       ShowOSD <param>
241               This option disable or enable show OSD.
242
243               Here, <param> takes the values "Yes", "No".
244
245       FontOSD <param>
246               This option set font for OSD.
247
248               Here, <param> takes the value, that can be received  with  com‐
249               mand "xfontsel -print".
250
251       AddOSD <action> <state> <text>
252               Binds OSD for some actions.
253
254               Here,   <action>  takes  the  following  values:  "XneurStart",
255               "XneurReload",  "XneurStop",  "PressKeyLayout1",  "PressKeyLay‐
256               out2",  "PressKeyLayout3",  "PressKeyLayout4", "EnableLayout1",
257               "EnableLayout2", "EnableLayout3", "EnableLayout4",  "Automatic‐
258               ChangeWord",   "ManualChangeWord",  "ChangeString",  "ChangeSe‐
259               lected", "TranslitSelected", "ChangecaseSelected",  "ReplaceAb‐
260               breviation",   "CorrectIncidentalCaps",  "CorrectTwoCapitalLet‐
261               ter", "ExecuteUserAction" and "BlockKeyboardAndMouseEvents".
262
263               <text> is text will be displayed.
264
265               <state> takes the values "Disable", "Enable".
266
267       ShowPopup <param>
268               This option disable or enable show popup messages.
269
270               Here, <param> takes the values "Yes", "No".
271
272       PopupExpireTimeout <value>
273               This option define popup expiration interval in milliseconds.
274
275               Here, <value> must be until 0 to 30000.
276
277       AddPopup <action> <state> <text>
278               Binds popup messages for some actions.
279
280               Here,  <action>  takes  the  following  values:   "XneurStart",
281               "XneurReload",  "XneurStop",  "PressKeyLayout1",  "PressKeyLay‐
282               out2", "PressKeyLayout3",  "PressKeyLayout4",  "EnableLayout1",
283               "EnableLayout2",  "EnableLayout3", "EnableLayout4", "Automatic‐
284               ChangeWord",  "ManualChangeWord",  "ChangeString",   "ChangeSe‐
285               lected",  "TranslitSelected", "ChangecaseSelected", "ReplaceAb‐
286               breviation",  "CorrectIncidentalCaps",   "CorrectTwoCapitalLet‐
287               ter", "ExecuteUserAction" and "BlockKeyboardAndMouseEvents".
288
289               <text> is text will be displayed.
290
291               <state> takes the values "Disable", "Enable".
292
293       CheckOnProcess <param>
294               This  option  disable  or  enable  checking  language  on input
295               process.
296
297               Here, <param> takes the values "Yes", "No".
298
299       DisableCapsLock <param>
300               This option disable or enable CapsLock use.
301
302               Here, <param> takes the values "Yes", "No".
303
304       CorrectSpaceWithPunctuation <param>
305               This option disable or  enable  correction  spaces  before  and
306               after punctuation.
307
308               Here, <param> takes the values "Yes", "No".
309
310       Autocompletion <param>
311               This  option  disable  or enable pattern mining and recognition
312               (autocompletion).
313
314               Here, <param> takes the values "Yes", "No".
315
316       AddSpaceAfterAutocompletion <param>
317               This option disable or enable adding  space  after  autocomple‐
318               tion.
319
320               Here, <param> takes the values "Yes", "No".
321
322       AutocompletionExcludeApp <app_name>
323               Defines  an  application,  in which the program will exclude it
324               from autocompletion process.
325
326               Here, <app_name> is an identifier of the program window,  input
327               in  which is processed by xneur.  app_name can be obtained with
328               the xprop utility.  Multiple entries for this option in a  sin‐
329               gle  configuration  file  are  allowed, like "one program - one
330               option AutocompletionExcludeApp".
331
332       LoadModule <module.so>
333               This option define loadable plugin for xneur.
334
335               Here, <module.so> is name of shared library.
336
337       TroubleshootBackspace <param>
338               This  option  disable  or  enable  autoswitching   if   pressed
339               backspace.
340
341               Here, <param> takes the values "Yes", "No".
342
343       TroubleshootLeftArrow <param>
344               This  option  disable  or  enable autoswitching if pressed left
345               arrow.
346
347               Here, <param> takes the values "Yes", "No".
348
349       TroubleshootRightArrow <param>
350               This option disable or enable autoswitching  if  pressed  right
351               arrow.
352
353               Here, <param> takes the values "Yes", "No".
354
355       TroubleshootUpArrow <param>
356               This  option  disable  or  enable  autoswitching  if pressed up
357               arrow.
358
359               Here, <param> takes the values "Yes", "No".
360
361       TroubleshootDownArrow <param>
362               This option disable or enable  autoswitching  if  pressed  Down
363               arrow.
364
365               Here, <param> takes the values "Yes", "No".
366
367       TroubleshootDelete <param>
368               This option disable or enable autoswitching if pressed Delete.
369
370               Here, <param> takes the values "Yes", "No".
371
372       TroubleshootSwitch <param>
373               This  option disable or enable autoswitching if layout switched
374               (Pause/Break by default).
375
376               Here, <param> takes the values "Yes", "No".
377
378
379       DontSendKeyRelease <param>
380               This option disable or enable sending KeyRelease event.
381
382               Here, <param> takes the values "Yes", "No".
383
384
385       CompatibilityWithCompletion <param>
386               This option disable or enable  work-arround  for  compatibility
387               with the completion.
388
389               Here, <param> takes the values "Yes", "No".
390
391
392       TrackingInput <param>
393               Disabling  this  option will add any application to the list of
394               excluded applications.
395
396               Here, <param> takes the values "Yes", "No".
397
398
399

SEE ALSO

401       xneur(1), gxneur(1)
402

AUTHOR

404       Andrew Crew Kuznetsov, Nikolay Yankin
405
406
407
408                                                                    XNEURRC(5)