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

EXAMPLES

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

AUTHORS

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

COPYRIGHT

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

FEEDBACK

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

WWW

133     https://www.gajim.org/
134

XMPP

136     You are welcome to join us at gajim@conference.gajim.org
137

MAILING LIST

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

BUGS

149     Please submit bugs at https://dev.gajim.org/gajim/gajim/issues
150