1Poezio(1)                                                            Poezio(1)
2
3
4

NAME

6       Poezio - a ncurses jabber client written in python
7

SYNOPSIS

9       poezio [-f CONFIG_FILE] [-d DEBUG_FILE] [-h]
10

DESCRIPTION

12       Poezio  is  a  console jabber (XMPP) client written in Python and using
13       ncurses to draw its interface. It aims at being  similar  to  the  most
14       famous  IRC clients, like weechat or irssi. Some keyboard shortcuts are
15       inspired from emacs. For more information on XMPP  see  http://xmpp.org
16       and on Poezio see https://poez.io
17

OPTIONS

19       -f, --file CONFIG_FILE
20              Run  poezio  using  CONFIG_FILE  as  the  config file instead of
21              ~/.config/poezio/poezio.cfg.
22
23       -d, --debug DEBUG_FILE
24              Log debug from both poezio and slixmpp in DEBUG_FILE. Debug con‐
25              tains  incoming and outgoing stanzas in addition to various mes‐
26              sage helping poezio's debugging.
27
28       -c, --check-config
29              Display the list of  modified/unmodified  config  options,  with
30              their changes from the default.
31
32       -h, --help
33              Display the poezio help message.
34
35

BASICS

37       The  following  sections  will  give you a short overview on how to use
38       poezio. Poezio has many more options, commands and key bindings, please
39       refer  to poezio.cfg(7), poezio.commands(7), poezio.keys(7) or the full
40       documentation which should have  been  provided  alongside  the  source
41       code, or check it online at https://doc.poez.io/.
42
43       A  tab,  in  Poezio,  is the base structure of the interface. A tab may
44       contains one or more windows, the main types are:
45
46              Roster tab
47                    It contains a browsable list of your contacts on the left,
48                    as well as an info window on the right.
49
50              Chatroom tab
51                    This tab displays the contents of a multi-user chat.
52
53              Conversation tab
54                    It  is  used  for  one-to-one  communication, usually when
55                    using a real Jabber account.
56
57

KEY BINDINGS

59       While most of the keyboard shortcuts are common to all types  of  tabs,
60       some of them are tab-specific.
61
62   Text edition
63       These  shortcuts work in any kind of tab; most of them are identical to
64       emacs' ones.
65
66              Ctrl+A  Move the cursor to the beginning of the line.
67
68              Ctrl+E  Move the cursor to the end of the line.
69
70              Ctrl+W  Delete the word before the cursor.
71
72              Ctrl+K  Delete the text from the cursor to the end of  the  line
73                      and save it in the clipboard.
74
75              Ctrl+U  Delete  the  text  from the beginning of the line to the
76                      cursor and save it in the clipboard.
77
78              Ctrl+Y  Insert the text in the clipboard after the cursor.
79
80              Ctrl+D  Delete the char after the cursor (same as the Suppr key)
81
82
83   Navigation keybindings
84              F5, Ctrl+N
85                      Go to the previous tab.
86
87              F6, Ctrl+P
88                      Go to the next tab.
89
90              Alt+<number>
91                      Go to the specified tab (from 0 to 9)
92
93              Alt+J <two-digits-number>
94                      Go to the specified tab (from 00 to 99)
95
96              Alt+Z   Go to the last visited tab.
97
98              Alt+E   Go to the next important  tab  (private  message,  high‐
99                      light, simple message)
100
101              F7      Decrease the information window size.
102
103              F8      Increase the information window size.
104
105              Alt+R   Go to the roster.
106
107              Ctrl+L  Redraw the screen.
108
109              Up, Down
110                      Browse  the  history  of  the  last messages or commands
111                      you've entered.
112
113
114   Roster keybindings
115              o       Hide or show the offline contacts.
116
117              s       Search through your contact list.
118
119              Ctrl+G  Cancel a search.
120
121
122   MUC-specific keybindings
123              Alt+V   Move the line separator at the bottom of the  text  win‐
124                      dow.
125
126              Tab     Complete the nickname that you're typing. If nothing has
127                      been entered, insert the nickname of the last  user  who
128                      spoke.
129
130              Alt+/   Complete  the word that you're typing, based on the list
131                      of the recently said words in the conversation.
132
133

COMMANDS

135       Most commands support tab completion, both  for  their  names  and  for
136       their  arguments.  You  can use the /help command to list all available
137       commands, and /help <command> for a complete description of <command>.
138
139       The following is a basic description of the most widely used  commands;
140       you  should  refer to /help inside poezio for more documentation. <foo>
141       denotes a obligatory argument, while  [bar]  is  an  optional  argument
142       (without  argument,  the /remove command, for example, acts on the cur‐
143       rently selected contact)
144
145   Roster commands
146              /add <jid>
147                   Add a JID to your roster.
148
149              /remove [jid]
150                   Remove a contact from your roster.
151
152              /accept [jid]
153                   Accept a JID that wants to subscribe to your presence.
154
155              /deny [jid]
156                   The opposite of /accept.
157
158
159   MUC-specific commands
160              /kick <user>
161                   Kick the specified user from the room.
162
163              /show <status> [message]
164                   Change your status, and  status  message,  in  the  current
165                   room.  You can use “avail”, “busy”, “away” and “xa” as your
166                   status, followed by an optional message.
167
168              /ignore <user>
169                   Ignore the specified user.
170
171              /topic [topic text]
172                   View or change the topic of the room.
173
174              /query <user>
175                   Talk privately with the specified participant.
176
177              /part
178                   Leave the current room.
179
180

BUGS

182       Sure.
183
184

KNOWN ISSUES

186       If you're using a terminal multiplexer such as screen or tmux,  it  may
187       be  setting $TERM to "screen", which breaks 256-color support. Consider
188       setting your $TERM to something like "screen-256color".
189
190

FEEDBACK

192       You  are  encouraged  to   report   bugs   or   feature   requests   on
193       https://lab.louiz.org/poezio/poezio.   You can also find us on the Jab‐
194       ber chatroom xmpp:poezio@muc.poez.io?join
195
196

AUTHORS

198       Written by Florent Le Coz <louiz@louiz.org>
199
200       Later completed by Baptiste Jonglez <baptiste--poezio@jonglez.org>
201
202
203
204Poezio dev team                  May 31, 2020                        Poezio(1)
Impressum