XNEURRC(5)

📦 version 0.20.0, in debian bookworm, debian trixie, nixos 26.05, ubuntu jammy, ubuntu questing, ubuntu resolute, ubuntu stonking

🌸 XNEURRC — the config file for XNeur (xneurrc(5)) 🌸

okay bestie, sit down, hydrate, and let me tell you about xneurrc, the configuration file for XNeur 💖

✨ NAME ✨

xneurrc — the configuration file for XNeur, no cap 🎀

💜 DESCRIPTION 💜

So this file is where all the options for XNeur live. You can make it or change it by hand, or let gXNeur or kXNeur do it for you, which, honestly, iconic behaviour.

Where the manual settings hang out:

  • ~/.xneur/xneurrc

And where the base settings live:

  • {prefix}/etc/xneur/xneurrc

👑 OPTIONS 👑

okay this is the long part, grab a snack 🍓 every single one of these is a real option, so don't skip, i'm watching 💅

  • Version <number> — says which program version this config file is vibing with. For XNeur version 0.5.0, the value of <number> is 0.5.0. periodt.
  • ManualMode <param> — describes the program's working mode. Here <param> can be "Yes" or "No", which mean, respectively, working in manual or automatic mode.
    • In automatic mode, the program determines the input language "on fly" and switches the keyboard layout, and at the same time it changes the word you typed. main character energy, it's doing everything for you ✨
    • In manual mode, the program does not use any language recognition algorithms. Layout switching and text conversion happen on your request, when you press hot keys. you're driving 🫶
  • LogLevel <level> — sets how much diagnostic output goes to the console.
    • Here <level> takes the values "Error", "Warning", "Log", "Debug", "Trace". Change this and you control how detailed the console output gets. lowkey a volume knob for yapping 📢
  • ExcludeLanguage <language> — defines the language the program WILL NOT work with. like, not invited to the party 🙈
    • Here <language> stands for the language for which the layout should be specified (e.g. ru, us, by, de...).
  • DefaultXkbGroup <group> — defines the initial keyboard layout for all new applications.
    • Here <group> stands for the number of the XKB layout for this language in the system (takes values from 0 to 3).
  • ExcludeApp <app_name> — defines an application in which the program WILL NOT work.
    • Here <app_name> is an identifier of the program window whose input is processed by XNeur. <app_name> can be obtained with the xprop utility.
    • You can have multiple entries for this option in a single configuration file — it's like "one program, one ExcludeApp option". slay, stack them 💅
  • SetAutoApp <app_name> — defines an application in which the program will always work in automatic mode, independent of the DefaultMode option.
    • Here <app_name> is an identifier of the program window whose input is processed by xneur. app_name can be obtained with the xprop utility.
    • Multiple entries for this option in a single configuration file are allowed, like "one program - one option SetAutoApp".
  • SetManualApp <app_name> — defines an application in which the program will always work in manual mode, independent of the DefaultMode option.
    • Here <app_name> is an identifier of the program window whose input is processed by xneur. app_name can be obtained with the xprop utility.
    • Multiple entries for this option in a single configuration file are allowed, like "one program - one option SetManualApp".
  • AddBind <action> [Control | Alt | Shift | Super] [key] — defines hot keys for xneur control. your little shortcut squad ⌨️✨
    • Here <action> stands for an action of XNeur, and <key> stands for a special key.
    • <action> takes the following values: "ChangeWord" (replace word/cancel last auto replacement), "ChangeString" (replace last string), "ChangeMode" (switch between the auto and the manual program modes), "ChangeSelected" (convert selected text to another layout), "TranslitSelected" (convert selected Cyrillic test to translit), "ChangecaseSelected" (change lettercase of selected text), "EnableLayout1" (enable of first layout), "EnableLayout2" (enable of second layout), "EnableLayout3" (enable of third layout), "EnableLayout4" (enable of fourth layout), "ReplaceAbbreviation" (replace abbreviation to full text) or "BlockKeyboardAndMouseEvents" (blocking all events of keyboard and mouse).
    • [key] takes the values defined in your latin keyboard. Skip this value if the hot key is undefined.
  • AddAction [Control | Alt | Shift | Super] <key> <action> — defines hot keys for user actions.
    • Here <action> is user actions (e.g. firefox or gnome-terminal), and <key> stands for a special key.
    • <key> takes the values defined in your latin keyboard.
  • ReplaceAbbreviationIgnoreLayout <param> — this option enables or disables ignoring the keyboard layout for the abbreviations list.
    • Here <param> takes the values "Yes", "No".
  • ReplaceAbbreviation <abbreviation> <full_text> — defines an abbreviation which will be replased to full text. 💫
    • Here <abbreviation> is abreviation and <full_text> is text.
    • Multiple entries for this option in a single configuration file are allowed, like "one abbreviation - one option ReplaceAbbreviation".
  • PlaySound <param> — this option enables or disables sound playing 🔊
    • Here <param> takes the values "Yes", "No".
  • AddSound <action> <state> <sound> — binds sounds for some actions.
    • Here <action> takes the following values: "XneurStart", "XneurReload", "XneurStop", "PressKeyLayout1", "PressKeyLayout2", "PressKeyLayout3", "PressKeyLayout4", "EnableLayout1", "EnableLayout2", "EnableLayout3", "EnableLayout4", "AutomaticChangeWord", "ManualChangeWord", "ChangeString", "ChangeSelected", "TranslitSelected", "ChangecaseSelected", "ReplaceAbbreviation", "CorrectIncidentalCaps", "CorrectTwoCapitalLetter", "ExecuteUserAction" and "BlockKeyboardAndMouseEvents".
    • <sound> is a .wav file placed in ~/.xneur/sounds or in the basic place ({prefix}/share/xneur/sounds/).
    • <state> takes the values "Disable", "Enable".
  • SoundVolumePercent <percent> — defines the sound playing volume percent.
    • Here <percent> takes the values from 0 to 100.
  • EducationMode <param> — defines if XNeur will work in self-training. A wrong input will be added to the dictionary if it is twice converted into a specific layout manually. If this option is on, this will lead to a bigger dictionary. It does not make sence for the manual operating mode. 📚
    • Here <param> takes the values "Yes", "No".
  • LayoutRememberMode <param> — this option enables or disables layout remember for each window.
    • Here <param> takes the values "Yes", "No".
  • LayoutRememberModeForApp <app_name> — this option force enables layout remember for each application, not window.
    • Here <app_name> is an identifier of the program window whose input is processed by xneur. app_name can be obtained with the xprop utility.
  • SaveSelectionMode <param> — defines if a selection will stay after changes made by user actions, defined by the AddBind parameter.
    • Here <param> takes the values "Yes", "No".
  • RotateLayoutAfterChangeSelectedMode <param> — this option enables or disables rotating layout after converting selected text.
    • Here <param> takes the values "Yes", "No".
  • SendDelay <value> — this option defines the delay in milliseconds before sendind events to application.
    • Here <value> must be until 0 to 50.
  • LogSave <param> — this option enables or disables logging keyboard. Log places in ~/.xneur/xneurlog 📝
    • Here <param> takes the values "Yes", "No".
  • LogSize <bytes> — this option sets the max size of the log file (bytes).
  • LogMail <e-mail> — this option defines the e-mail for sending the log file, if its size is greater then max size. 💌
  • LogHostIP <ip> — this option defines the ip of the host to send e-mail without login and password.
  • LogPort <port> — this option defines the port of the host to send e-mail without login and password.
  • CorrectIncidentalCaps <param> — this option enables or disables correction of iNCIDENTAL CapsLock.
    • Here <param> takes the values "Yes", "No".
  • CorrectTwoCapitalLetter <param> — this option enables or disables correction of two CApital letters.
    • Here <param> takes the values "Yes", "No".
  • FlushBufferWhenPressEscape <param> — this option enables or disables flushing the internal buffer when Escape is pressed.
    • Here <param> takes the values "Yes", "No".
  • FlushBufferWhenPressEnter <param> — this option enables or disables flushing the internal buffer when Enter or Tab is pressed.
    • Here <param> takes the values "Yes", "No".
  • DontProcessWhenPressEnter <param> — this option disables or enables processing a word when Enter or Tab is pressed.
    • Here <param> takes the values "Yes", "No".
  • ShowOSD <param> — this option disables or enables showing OSD.
    • Here <param> takes the values "Yes", "No".
  • FontOSD <param> — this option sets the font for OSD.
    • Here <param> takes the value that can be received with the command xfontsel -print.
  • AddOSD <action> <state> <text> — binds OSD for some actions.
    • Here <action> takes the following values: "XneurStart", "XneurReload", "XneurStop", "PressKeyLayout1", "PressKeyLayout2", "PressKeyLayout3", "PressKeyLayout4", "EnableLayout1", "EnableLayout2", "EnableLayout3", "EnableLayout4", "AutomaticChangeWord", "ManualChangeWord", "ChangeString", "ChangeSelected", "TranslitSelected", "ChangecaseSelected", "ReplaceAbbreviation", "CorrectIncidentalCaps", "CorrectTwoCapitalLetter", "ExecuteUserAction" and "BlockKeyboardAndMouseEvents".
    • <text> is text will be displayed.
    • <state> takes the values "Disable", "Enable".
  • ShowPopup <param> — this option disables or enables showing popup messages.
    • Here <param> takes the values "Yes", "No".
  • PopupExpireTimeout <value> — this option defines the popup expiration interval in milliseconds.
    • Here <value> must be until 0 to 30000.
  • AddPopup <action> <state> <text> — binds popup messages for some actions.

okay we are so not done yet, bestie, keep scrolling 💖

Here's the full menu of <action> values, and yes, you write them exactly like this — quotes and all, no freestyling:

  • "XneurStart"
  • "XneurReload"
  • "XneurStop"
  • "PressKeyLayout1"
  • "PressKeyLayout2"
  • "PressKeyLayout3"
  • "PressKeyLayout4"
  • "EnableLayout1"
  • "EnableLayout2"
  • "EnableLayout3"
  • "EnableLayout4"
  • "AutomaticChangeWord"
  • "ManualChangeWord"
  • "ChangeString"
  • "ChangeSelected"
  • "TranslitSelected"
  • "ChangecaseSelected"
  • "ReplaceAbbreviation"
  • "CorrectIncidentalCaps"
  • "CorrectTwoCapitalLetter"
  • "ExecuteUserAction"
  • "BlockKeyboardAndMouseEvents"

<text> is the text that will be displayed. 💬

<state> takes the values "Disable" and "Enable". Two moods only, bestie.

  • CheckOnProcess param — turns the language check on or off while you're typing (on the input process). Here, param takes the values "Yes", "No".
  • DisableCapsLock param — turns CapsLock use on or off. Here, param takes the values "Yes", "No".
  • CorrectSpaceWithPunctuation param — toggles the correction of spaces before and after punctuation. Here, param takes the values "Yes", "No".
  • CorrectTwoSpaceWithCommaAndSpace param — toggles correcting two spaces into a comma plus a space. Here, param takes the values "Yes", "No".
  • CorrectTwoMinusWithDash param — toggles correcting two minus signs into a dash. Here, param takes the values "Yes", "No".
  • CorrectDashWithEmDas param — toggles correcting two minus signs into an emdash. Here, param takes the values "Yes", "No".
  • CorrectCWithCopyright param — toggles correcting (c) into a copyright sign. Here, param takes the values "Yes", "No".
  • CorrectTMWithTrademark param — toggles correcting (tm) into a trademark sign. Here, param takes the values "Yes", "No".
  • CorrectRWithRegistered param — toggles correcting (r) into a registered sign. Here, param takes the values "Yes", "No".
  • CorrectThreePointsWithEllipsis param — toggles correcting three points into an ellipsis sign. Here, param takes the values "Yes", "No".
  • Autocompletion param — toggles pattern mining and recognition, aka autocompletion. Here, param takes the values "Yes", "No".
  • AddSpaceAfterAutocompletion param — toggles adding a space after autocompletion. Here, param takes the values "Yes", "No".
  • AutocompletionExcludeApp app_name — names an application that the program will exclude from the autocompletion process. Here, app_name is an identifier of the program window whose input is processed by xneur. You can get app_name with the xprop utility. Multiple entries for this option in a single configuration file are allowed — like, "one program, one AutocompletionExcludeApp option". 💅
  • LoadModule module.so — defines a loadable plugin for xneur. Here, module.so is the name of the shared library.
  • TroubleshootBackspace param — toggles autoswitching when backspace is pressed. Here, param takes the values "Yes", "No".
  • TroubleshootLeftArrow param — toggles autoswitching when the left arrow is pressed. Here, param takes the values "Yes", "No".
  • TroubleshootRightArrow param — toggles autoswitching when the right arrow is pressed. Here, param takes the values "Yes", "No".
  • TroubleshootUpArrow param — toggles autoswitching when the up arrow is pressed. Here, param takes the values "Yes", "No".
  • TroubleshootDownArrow param — toggles autoswitching when the Down arrow is pressed. Here, param takes the values "Yes", "No".
  • TroubleshootDelete param — toggles autoswitching when Delete is pressed. Here, param takes the values "Yes", "No".
  • TroubleshootSwitch param — toggles autoswitching when the layout is switched (Pause/Break by default). Here, param takes the values "Yes", "No".
  • TroubleshootFullScreen param — toggles autoswitching for full screen apps. Here, param takes the values "Yes", "No".
  • DontSendKeyRelease param — toggles sending the KeyRelease event. Here, param takes the values "Yes", "No".
  • CompatibilityWithCompletion param — toggles the work-arround for compatibility with the completion. Here, param takes the values "Yes", "No".
  • TrackingInput param — disabling this option will add any application to the list of excluded applications. Here, param takes the values "Yes", "No".
  • TrackingMouse param — disabling this option will disable mouse tracking. Here, param takes the values "Yes", "No".

🌈 SEE ALSO 🌈

xneur(1), gxneur(1)

👑 AUTHOR 👑

Andrew Crew Kuznetsov, Nikolay Yankin

and that's the whole page, bestie — every last option accounted for, no skips, no crumbs 🫶 This one's from the XNEURRC(5) manual page, so that's the footer energy: XNEURRC(5), periodt. Go forth and configure, you absolute icon 💖✨

📦 where this page comes from