gajim-remote(1)

1GAJIM-REMOTE(1)             User's Reference Manual            GAJIM-REMOTE(1)
2

NAME

4     gajim-remote — a remote control utility for gajim(1)
5

SYNOPSIS

7     gajim-remote command
8

DESCRIPTION

10     gajim-remote is a script to control and communicate with a running
11     instance of gajim(1) by D-Bus.
12

OPTIONS

14     Available commands
15
16   account_info ⟨account⟩
17     Gets detailed info on a account
18
19   change_status [status] [message] [account]
20     Changes the status of account or accounts
21
22   check_gajim_running
23     Check if Gajim is running
24
25   contact_info ⟨jid⟩
26     Gets detailed info on a contact
27
28   get_status [account]
29     Returns current status (the global one unless account is specified)
30
31   get_status_message [account]
32     Returns current status message (the global one unless account is speci‐
33     fied)
34
35   get_unread_msgs_number
36     Returns number of unread messages
37
38   help [command]
39     Shows a help on specific command
40
41   list_accounts
42     Prints a list of registered accounts
43
44   list_contacts [account]
45     Prints a list of all contacts in the roster. Each contact appears on a
46     separate line
47
48   prefs_del ⟨key⟩
49     Deletes a preference item
50
51   prefs_list
52     Lists all preferences and their values
53
54   prefs_put ⟨key=value⟩
55     Sets value of 'key' to 'value'.
56
57   prefs_store
58     Writes the current state of Gajim preferences to the .config file
59
60   remove_contact ⟨jid⟩ [account]
61     Removes contact from roster
62
63   send_chat_message ⟨jid⟩ ⟨message⟩ [PGP key] [account]
64     Sends new chat message to a contact in the roster. Both OpenPGP key and
65     account are optional. If you want to set only 'account', without 'OpenPGP
66     key', just set 'OpenPGP key' to ''.
67
68   send_file ⟨file⟩ ⟨jid⟩ [account]
69     Sends file to a contact
70
71   send_groupchat_message ⟨room_jid⟩ ⟨message⟩ [account]
72     Sends new message to a groupchat you've joined.
73
74   send_single_message ⟨jid subject⟩ ⟨message⟩ [PGP key] [account]
75     Sends new single message to a contact in the roster. Both OpenPGP key and
76     account are optional. If you want to set only 'account', without 'OpenPGP
77     key', just set 'OpenPGP key' to ''.
78
79   send_xml ⟨xml⟩ [account]
80     Sends custom XML
81
82   set_priority ⟨priority⟩ [account]
83     Changes the priority of account or accounts
84
85   show_next_pending_event
86     Pops up a window with the next pending event
87
88   toggle_ipython
89     Shows or hides the ipython window
90
91   toggle_roster_appearance
92     Shows or hides the roster window
93

EXAMPLES

95     Open a URI of group chat gajim
96
97           $ gajim-remote handle_uri xmpp:gajim@conference.gajim.org?join
98
99     Send custom XML
100
101           $ gajim-remote send_xml $(cat filename.xml) "your@jabber.id"
102

AUTHORS

104     gajim-remote is written and maintained by Yann Leboulanger, and Denis
105     Fomin, with contributions and patches merged from many individuals around
106     the world.  See files AUTHORS and THANKS, for a complete list.
107

COPYRIGHT

109     Copyright (C) 2003-2020 Gajim Team
110
111     gajim-remote is free software; you can redistribute it and/or modify it
112     under the terms of the GNU General Public License as published by the
113     Free Software Foundation; version 3 only.
114
115     gajim-remote is distributed in the hope that it will be useful, but WITH‐
116     OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
117     FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
118     more details.
119
120     You should have received a copy of the GNU General Public License along
121     with gajim-remote.  If not, see <https://www.gnu.org/licenses/>.
122

FEEDBACK

124     You can report bugs or feature requests in our bug tracker at
125     https://dev.gajim.org/gajim/gajim/issues or in the gajim-devel mailing
126     list; if you want to send us a patch, please do so in our bug tracker.
127     You can also find us in our chat room.
128

WWW

130     https://www.gajim.org/
131

XMPP

133     You are welcome to join us at gajim@conference.gajim.org
134

MAILING LIST

136     Below are public mailing lists on lists.gajim.org
137
138           https://lists.gajim.org/cgi-bin/listinfo/gajim-devel
139           https://lists.gajim.org/cgi-bin/listinfo/translators
140
141     More mailing lists at
142
143           https://lists.gajim.org/cgi-bin/listinfo
144

BUGS

146     Please submit bugs at https://dev.gajim.org/gajim/gajim/issues
147