NAME

arif_rime - example Rime IME integration for ARIF

SYNOPSYS

#include <arif_rime.h>

extern struct arif_engine const arif_rime_engine;

DESCRIPTION

An example implementation of ARIF engine, powered by the Rime IME core library.

See the manual page of arif_set_engine() for how to use this engine.

Initialization

The init() function of arif_rime_engine ignores the first argument. Engine configuration is instead read from environment variables.

Note that the variables are only read during the first init() call, initialization of subsequent engine instances share the same configuration.

ENVIRONMENT

ARIF_RIME_SHARED_DATA_DIR: Path to the directory where Rime schema data files are stored.

: Defaults to "/usr/share/rime-data".

ARIF_RIME_USER_DATA_DIR: Path to the directory where user configuration files are stored.
ARIF_RIME_LOG_DIR: Path to the directory where Rime log files will be written to.

: Defaults to "/tmp".

ARIF_RIME_LOG_LEVEL: Rime minimum log level. Should be one of INFO, WARNING, ERROR or FATAL (case insensitive).

: Default log level is INFO.

ARIF_RIME_MODULES: A whitespace-separated list of Rime modules to load before Rime initialization.

BUGS

This is only an example to shed light on how an ARIF engine can be implemented. It is not intended for everyday use.

Only part of Rime's features are supported, and may not work as expected with certain configurations.

COPYRIGHT

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.

You should have received a copy of the license along with this document. If not, see <https://www.gnu.org/licenses/fdl-1.3.html>.