| 1 |
.\" This file is distributed under the same license as the ibus |
| 2 |
.\" package. |
| 3 |
.\" Copyright (C) Takao Fujiwara <[email protected]>, 2013-2017. |
| 4 |
.\" Copyright (c) Peng Huang <[email protected]>, 2013. |
| 5 |
.\" |
| 6 |
.TH "IBUS" 1 "Jul 2022" "@VERSION@" "User Commands" |
| 7 |
.SH NAME |
| 8 |
.B ibus |
| 9 |
\- command line utility for ibus |
| 10 |
|
| 11 |
.SH "SYNOPSIS" |
| 12 |
.B ibus |
| 13 |
\fICOMMAND\fR [\fIOPTION\fR]... |
| 14 |
|
| 15 |
.SH "DESCRIPTION" |
| 16 |
|
| 17 |
.PP |
| 18 |
IBus is an Intelligent Input Bus. It is a new input framework for Linux |
| 19 |
OS. It provides full featured and user friendly input method user |
| 20 |
interface. It also may help developers to develop input method easily. |
| 21 |
|
| 22 |
.PP |
| 23 |
.B ibus |
| 24 |
is a command line utility which can restart or exit ibus-daemon, |
| 25 |
get or set the current ibus engine or list the ibus engines. |
| 26 |
|
| 27 |
.PP |
| 28 |
Homepage: https://github.com/ibus/ibus/wiki |
| 29 |
|
| 30 |
.SH "COMMAND" |
| 31 |
.TP |
| 32 |
\fBhelp\fR |
| 33 |
Show the commands list. |
| 34 |
.TP |
| 35 |
\fBengine\fR [\fBENGINE_NAME\fR] |
| 36 |
Show the curent ibus engine when |
| 37 |
.B ENGINE_NAME |
| 38 |
is not given. Set |
| 39 |
.B ENGINE_NAME |
| 40 |
to the current ibus engine. |
| 41 |
.TP |
| 42 |
\fBexit\fR |
| 43 |
Exit ibus-daemon. |
| 44 |
.TP |
| 45 |
\fBlist-engine\fR |
| 46 |
Show ibus engines list. |
| 47 |
.TP |
| 48 |
\fBrestart\fR [\fB\-\-type=TYPE|\-\-verbose|\-\-help\fR] |
| 49 |
Restart ibus-daemon. This command tries to restart ibus-daemon via systemd |
| 50 |
firstly and directly secondary by default. If |
| 51 |
.B \-\-type=systemd |
| 52 |
is given, It tries to restart via systemd only. If |
| 53 |
.B \-\-type=direct |
| 54 |
is given, It tries to restart with an IBus API only. GNOME desktop runs |
| 55 |
ibus-daemon via systemd and other desktops run ibus-daemon directly. |
| 56 |
.TP |
| 57 |
\fBstart\fR [\fB\-\-type=TYPE|\-\-verbose|\-\-help\fR] |
| 58 |
Start ibus-daemon. This command tries to start ibus-daemon via systemd |
| 59 |
firstly and directly secondary by default. If |
| 60 |
.B \-\-type=systemd |
| 61 |
is given, It tries to start as a background process via systemd only. If |
| 62 |
.B \-\-type=direct |
| 63 |
is given, It tries to start directly only as a foreground process and other |
| 64 |
option arguments of ibus command are sent to ibus-daemon. E.g. |
| 65 |
ibus start |
| 66 |
.B \-\-type=direct |
| 67 |
.B \-\-xim |
| 68 |
& |
| 69 |
GNOME desktop runs ibus-daemon via systemd and other desktops run ibus-daemon directly. |
| 70 |
.TP |
| 71 |
\fBversion\fR |
| 72 |
Show the ibus version. |
| 73 |
.TP |
| 74 |
\fBread\-cache\fR [\fB\-\-system|\-\-file=FILE|\-\-help\fR] |
| 75 |
Show the content of the user registry cache if |
| 76 |
.B \-\-system |
| 77 |
is not given. |
| 78 |
Show the content of the system registry cache if |
| 79 |
.B \-\-system |
| 80 |
is given. |
| 81 |
Show the content of the custom registry cache |
| 82 |
.B FILE |
| 83 |
if |
| 84 |
.B \-\-file=FILE |
| 85 |
is given. |
| 86 |
.TP |
| 87 |
\fBwrite\-cache\fR [\fB\-\-system|\-\-file=FILE|\-\-help\fR] |
| 88 |
Save the user registry cache if |
| 89 |
.B \-\-system |
| 90 |
is not given. |
| 91 |
Save the system registry cache if |
| 92 |
.B \-\-system |
| 93 |
is given. |
| 94 |
Save the custom registry cache |
| 95 |
.B FILE |
| 96 |
if |
| 97 |
.B \-\-file=FILE |
| 98 |
is given. |
| 99 |
|
| 100 |
By default, it reads the component XML files from the standard |
| 101 |
component directory (\fI/usr/share/ibus/component\fP), you can set |
| 102 |
\fIIBUS_COMPONENT_PATH\fP environment variable for custom component |
| 103 |
directories, separated by ':'. |
| 104 |
.TP |
| 105 |
\fBaddress\fR |
| 106 |
Show the D-Bus address of ibus-daemon. |
| 107 |
.TP |
| 108 |
\fBread\-config\fR |
| 109 |
Print the setting values in a gsettings configuration file. |
| 110 |
.TP |
| 111 |
\fBreset\-config\fR |
| 112 |
Reset the user setting values to the default ones in a gsettings |
| 113 |
configuration file. |
| 114 |
.TP |
| 115 |
\fBwatch\fR |
| 116 |
Under construction. |
| 117 |
.TP |
| 118 |
\fBemoji\fR [\fB\-\-font=FONT|\-\-lang=LANG|\-\-help|\-\-partial\-match\fR] |
| 119 |
Launch IBus Emojier ( |
| 120 |
.B ibus\-emoji (1) |
| 121 |
) and save the selected emoji to your clipboard. Can choose an emoji font with |
| 122 |
.B \-\-font |
| 123 |
option. Can choose a language of emoji annotations with |
| 124 |
.B \-\-lang |
| 125 |
option. If LANG="en", IBus Emojier loads /usr/share/ibus/dicts/emoji-en.dict . |
| 126 |
.B \-\-partial\-match |
| 127 |
option enables to match annotations with a partial string. These settings |
| 128 |
are available with |
| 129 |
.B ibus\-setup (1) |
| 130 |
utility. |
| 131 |
.TP |
| 132 |
\fBim-module\fR [\fB\-\-type=TYPE|\-\-help\fR] |
| 133 |
Show an internal im-module value in a virtual GTK application. If IBus is |
| 134 |
installed and configured properly, the output is "ibus". This sub-command |
| 135 |
is useful for some users who build IBus from the source codes and check |
| 136 |
the configurations. Currently the sub-command supports GTK applications only |
| 137 |
and the default is GTK3. If you wish to check a GTK4 application, you can |
| 138 |
specify |
| 139 |
.B \-\-type=gtk4 |
| 140 |
option and you can choose one of "gtk2", "gtk3" and "gtk4". |
| 141 |
|
| 142 |
.SH BUGS |
| 143 |
If you find a bug, please report it at https://github.com/ibus/ibus/issues |
| 144 |
|
| 145 |
.SH "SEE ALSO" |
| 146 |
.BR ibus-emoji (7) |