Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/khaphanspace/gonhanh.org/llms.txt

Use this file to discover all available pages before exploring further.

Linux support is currently in beta. Some features may not work as expected. Please report issues on GitHub.
Gõ Nhanh for Linux uses the Fcitx5 input method framework to provide Vietnamese input across all applications.

​
Quick Installation

Run the automated installation script: 
curl -fsSL https://raw.githubusercontent.com/khaphanspace/gonhanh.org/main/scripts/setup/linux.sh | bash
After installation, log out and log back in to complete the setup.

​
Requirements

​
Runtime Dependencies

  • Fcitx5 — Input method framework
  • Rust core library — Bundled with installation

​
Supported Distributions

  • Ubuntu 20.04+
  • Debian 11+
  • Fedora 35+
  • Arch Linux
  • Other distributions with Fcitx5 support

​
Manual Installation

If you prefer to install manually or the script doesn’t work:
1

Install Fcitx5

sudo apt install fcitx5 fcitx5-configtool
2

Configure environment variables

Add these lines to your ~/.bashrc or ~/.zshrc:
export GTK_IM_MODULE=fcitx
export QT_IM_MODULE=fcitx
export XMODIFIERS=@im=fcitx
export LD_LIBRARY_PATH="$HOME/.local/lib:$LD_LIBRARY_PATH"
Then reload your shell config:
source ~/.bashrc
3

Download and install Gõ Nhanh

Follow the installation script or build from source (see Build from Source).
4

Restart Fcitx5

fcitx5 -r &
5

Add Gõ Nhanh to input methods

fcitx5-configtool
In the configuration tool:
  1. Go to Input Method tab
  2. Click Add
  3. Search for GoNhanh or Gõ Nhanh
  4. Add it to your input methods

​
Usage

​
Keyboard Shortcuts

ShortcutFunction
Ctrl + Space or Super + SpaceSwitch input methods (depends on desktop environment)
The exact keyboard shortcut to switch input methods depends on your Fcitx5 configuration and desktop environment.

​
Command-Line Interface

Gõ Nhanh provides a CLI for quick configuration: 
# Toggle Vietnamese input on/off
gn

# Enable Vietnamese input
gn on

# Disable Vietnamese input
gn off

# Switch to VNI mode
gn vni

# Switch to Telex mode
gn telex

# Check current status
gn status

# Update to latest version
gn update

# Uninstall
gn uninstall

# Show version
gn version

# Show help
gn help

​
Input Methods

TypeResult
s, f, r, x, jsắc, huyền, hỏi, ngã, nặng
aa, oo, eeâ, ô, ê
aw, ow, uwă, ơ, ư
w (after consonant)ư
ddđ
Example: vieetj → việt

​
File Locations

Gõ Nhanh installs files in the following locations:
FileLocation
Fcitx5 addon~/.local/lib/fcitx5/gonhanh.so
Addon config~/.local/share/fcitx5/addon/gonhanh.conf
Input method config~/.local/share/fcitx5/inputmethod/gonhanh.conf
Rust core library~/.local/lib/libgonhanh_core.so
CLI binary~/.local/bin/gn

​
Troubleshooting

​
Command gn not found

Reload your shell configuration: 
source ~/.bashrc
# or for zsh
source ~/.zshrc
Make sure ~/.local/bin is in your PATH.

​
Can’t type Vietnamese

1

Log out and log back in

Environment variables need to be reloaded.
2

Check if Fcitx5 is running

pgrep fcitx5
If not running, start it:
fcitx5 -d
3

Verify environment variables

echo $GTK_IM_MODULE
Should output: fcitx
4

Check if Gõ Nhanh is in input methods

fcitx5-configtool
Go to Input Method → Ensure GoNhanh is listed

​
Fcitx5 addon not loading

Check Fcitx5 logs for errors: 
fcitx5 --verbose=*:4
Verify the library can be loaded: 
ldd ~/.local/lib/fcitx5/gonhanh.so

​
Missing symbols error

Check that LD_LIBRARY_PATH includes ~/.local/lib: 
echo $LD_LIBRARY_PATH
Should include: /home/yourusername/.local/lib

​
Build from Source

For advanced users who want to build from source:
1

Install build dependencies

sudo apt install cmake pkg-config fcitx5 fcitx5-dev \
  libfcitx5core-dev libfcitx5config-dev libfcitx5utils-dev \
  libxkbcommon-dev
2

Clone the repository

git clone https://github.com/khaphanspace/gonhanh.org.git
cd gonhanh.org
3

Build the project

cd platforms/linux
./scripts/build.sh
For debug build:
./scripts/build.sh --debug
4

Install

User-local installation (recommended, no sudo):
./scripts/install.sh
Or system-wide:
cd build
sudo make install

​
Updating

Update to the latest version: 
gn update
Or re-run the installation script: 
curl -fsSL https://raw.githubusercontent.com/khaphanspace/gonhanh.org/main/scripts/setup/linux.sh | bash

​
Uninstallation

Using the CLI: 
gn uninstall
Or manually remove files: 
rm -rf ~/.local/lib/fcitx5/gonhanh.so \
       ~/.local/share/fcitx5/addon/gonhanh.conf \
       ~/.local/share/fcitx5/inputmethod/gonhanh.conf \
       ~/.local/lib/libgonhanh_core.so \
       ~/.local/bin/gn
Then restart Fcitx5: 
fcitx5 -r

​
Desktop Environment Support

Gõ Nhanh works with all major Linux desktop environments:
  • GNOME — Tested on Ubuntu, Fedora
  • KDE Plasma — Full support
  • XFCE — Full support
  • Cinnamon — Tested on Linux Mint
  • MATE — Full support
  • i3/Sway — Works with proper Fcitx5 configuration
Some tiling window managers may require additional Fcitx5 configuration. Check your WM’s documentation for input method setup.

​
License

Gõ Nhanh for Linux is licensed under GPL-3.0-or-later (same as Fcitx5).

Build docs developers (and LLMs) love

Get started for freeTalk to us