Mercurial > ~mikael > mcabber > hg

comparison mcabber/doc/mcabber.1 @ 618:341568185492

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update documentation
author Mikael Berthe <mikael@lilotux.net>
date Fri, 16 Dec 2005 16:20:30 +0100
parents 803973541c22
children 7d9841ea20d8
comparison
equal deleted inserted replaced
617:d3a8b43bf9e7 618:341568185492
54 .TP 54 .TP
55 \(bu 55 \(bu
56 Commands completion: If possible, mcabber will try to complete your command line if you hit the Tab key\&. 56 Commands completion: If possible, mcabber will try to complete your command line if you hit the Tab key\&.
57 .TP 57 .TP
58 \(bu 58 \(bu
59 Input line history: Any message or command entered is in the input line history and can be reused easily\&.
60 .TP
61 \(bu
59 External actions: Some events (like receiving a message) can trigger an external action, for example a shell script (you need to enable it in your configuration file)\&. A sample events script ("eventcmd") is provided with mcabber source code, in the contrib directory\&. 62 External actions: Some events (like receiving a message) can trigger an external action, for example a shell script (you need to enable it in your configuration file)\&. A sample events script ("eventcmd") is provided with mcabber source code, in the contrib directory\&.
60 .LP 63 .LP
61 64
62 .SH "OPTIONS" 65 .SH "OPTIONS"
63 66
76 79
77 80
78 PageUp and PageDown keys are used to move in the roster\&. 81 PageUp and PageDown keys are used to move in the roster\&.
79 82
80 83
84 Up and Down arrow keys can be used to move in the input line history; they jump to the previous/next line from the history beginning with the same string (from first column to the cursor column)\&.
85
86
81 To send a message, move to the choosen buddy in the buddylist, type your message and hit enter\&. If the line begins with a slash, this will be interpreted as a command (see the COMMAND section below)\&. Hit escape to leave the chat mode\&. 87 To send a message, move to the choosen buddy in the buddylist, type your message and hit enter\&. If the line begins with a slash, this will be interpreted as a command (see the COMMAND section below)\&. Hit escape to leave the chat mode\&.
82 88
83 Here is a quick description of the key bindings: 89 Here is a quick description of the key bindings:
84 90
85 Ctrl\-a Go to the beginning of the input line 91 Ctrl\-a Go to the beginning of the input line
86 92
87 Ctrl\-e Go to the end of the input line 93 Ctrl\-e Go to the end of the input line
88 94
89 Ctrl\-l Force a resize 95 Ctrl\-l Force a refresh
96
97 Up/Down Move in the input line history
90 98
91 PgUp/PgDown Move inside the roster (buddylist) 99 PgUp/PgDown Move inside the roster (buddylist)
92 100
93 Tab Complete current word, in the input line 101 Tab Complete current word, in the input line
94 102
95 Ctrl\-g Cancel completion / ctrl\-g 103 Ctrl\-g Cancel completion / ctrl\-g
96 104
97 Ctrl\-p/Ctrl\-n Scroll up/down half a screen in the buffer window (chat mode) 105 Ctrl\-p/Ctrl\-n Scroll up/down half a screen in the buffer window (chat mode)
98 106
122 Aliases are expanded only once, thus they can not be chained\&. "/alias name" displays the value associated with the "name" alias; "/alias name =" unsets the "name" alias\&. 130 Aliases are expanded only once, thus they can not be chained\&. "/alias name" displays the value associated with the "name" alias; "/alias name =" unsets the "name" alias\&.
123 131
124 Example: "/alias away = status away"\&. 132 Example: "/alias away = status away"\&.
125 133
126 .TP 134 .TP
135 \fB/authorization\fR allow|cancel|request [jid]
136 Manage the presence subscriptions\&.
137
138 If no jid is provided, the current buddy is used\&.
139
140 \fBallow\fR allow the buddy to receive your presence updates
141 \fBcancel\fR cancel the buddy' subscription to your presence updates
142 \fBrequest\fR request a subscription to the buddy's presence updates
143
144 .TP
127 \fB/bind\fR keycode = command line 145 \fB/bind\fR keycode = command line
128 Bind a command line to the key with the "keycode" code number\&. 146 Bind a command line to the key with the "keycode" code number\&.
129 147
130 Keycodes of unused keys are displayed by mcabber in the log window when pressing the key, for example "Unknown key=265"\&. "/bind keycode" displays the command line bound to the given keycode; "/bind keycode" unbinds the given keycode\&. 148 Keycodes of unused keys are displayed by mcabber in the log window when pressing the key, for example "Unknown key=265"\&. "/bind keycode" displays the command line bound to the given keycode; "/bind keycode" unbinds the given keycode\&.
131 149
132 Note: aliases can be used in key bindings\&. 150 Note: aliases can be used in key bindings\&.
133 151
134 Example: "/bind 265 = status online" (265 is F1 for me, but it may depend on your ncurses installation)\&. 152 Example: "/bind 265 = status online" (265 is F1 for me, but it may depend on your ncurses installation)\&.
135 153
136 .TP 154 .TP
137 \fB/buffer\fR clear|top|bottom|search_backward|search_forward 155 \fB/buffer\fR clear|top|bottom|date|%|search_backward|search_forward
138 The buffer command manipulates the current buddy's buffer (chat window)\&. 156 The buffer command manipulates the current buddy's buffer (chat window)\&.
139 157
140 \fBclear\fR clear the current buddy chat window 158 \fBclear\fR clear the current buddy chat window
141 \fBbottom\fR jump to the bottom of the current buddy chat buffer 159 \fBbottom\fR jump to the bottom of the current buddy chat buffer
142 \fBtop\fR jump to the top of the current buddy chat buffer 160 \fBtop\fR jump to the top of the current buddy chat buffer
143 \fBup\fR [n] scroll the buffer up n lines (default: half a screen) 161 \fBup\fR [n] scroll the buffer up n lines (default: half a screen)
144 \fBdown\fR [n] scroll the buffer down n lines (default: half a screen) 162 \fBdown\fR [n] scroll the buffer down n lines (default: half a screen)
163 \fBdate\fR date jump to the first line after the specified date in the chat buffer (date format: "YYYY\-mm\-dd[THH:MM:SS]", "\-" and ":" are optional)
164 \fB%\fR n jump to position %n of the buddy chat buffer
145 \fBsearch_backward\fR text search for "text" in the current buddy chat buffer 165 \fBsearch_backward\fR text search for "text" in the current buddy chat buffer
146 \fBsearch_forward\fR text search for "text" in the current buddy chat buffer 166 \fBsearch_forward\fR text search for "text" in the current buddy chat buffer
147 \fBdate\fR date jump to the first line after the specified date in the chat buffer (date format: "YYYY\-mm\-dd[THH:MM:SS]", "\-" and ":" are optional)
148 \fB%\fR n jump to position %n of the buddy chat buffer
149 167
150 .TP 168 .TP
151 \fB/clear\fR 169 \fB/clear\fR
152 The clear command is actually an alias for "/buffer clear"\&. 170 The clear command is actually an alias for "/buffer clear"\&.
153 171
232 \fBdown\fR move down in the roster 250 \fBdown\fR move down in the roster
233 \fBhide_offline\fR hide offline buddies 251 \fBhide_offline\fR hide offline buddies
234 \fBshow_offline\fR show offline buddies 252 \fBshow_offline\fR show offline buddies
235 \fBtoggle_offline\fR toggle display of offline buddies 253 \fBtoggle_offline\fR toggle display of offline buddies
236 \fBsearch\fR bud search for a buddy with a name or buddy containing "bud" (only in the displayed buddylist) 254 \fBsearch\fR bud search for a buddy with a name or buddy containing "bud" (only in the displayed buddylist)
237 \fBalternate\fR jump to alternate buddy\&. The "alternate" buddy is the last buddy left while being in chat mode (this command is thus especially useful after commands like "/roster unread_first") 255 \fBalternate\fR jump to alternate buddy\&. The "alternate" buddy is the last buddy left while being in chat mode (this command is thus especially useful after commands like "/roster unread_first")
238 \fBunread_first\fR jump to the first unread message 256 \fBunread_first\fR jump to the first unread message
239 \fBunread_next\fR jump to the next unread message 257 \fBunread_next\fR jump to the next unread message
240 258
241 .TP 259 .TP
242 \fB/say\fR text 260 \fB/say\fR text