Mercurial > ~mikael > mcabber > hg

comparison mcabber/doc/mcabber.1.txt @ 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
35 - 'MUC support' (Multi-User Chat). 35 - 'MUC support' (Multi-User Chat).
36 - 'History logging:' If enabled (see the CONFIGURATION FILE section), 36 - 'History logging:' If enabled (see the CONFIGURATION FILE section),
37 `mcabber` can save discussions to history log files. 37 `mcabber` can save discussions to history log files.
38 - 'Commands completion:' If possible, `mcabber` will try to complete your 38 - 'Commands completion:' If possible, `mcabber` will try to complete your
39 command line if you hit the Tab key. 39 command line if you hit the Tab key.
40 - 'Input line history:' Any message or command entered is in the input line
41 history and can be reused easily.
40 - 'External actions:' Some events (like receiving a message) can trigger an 42 - 'External actions:' Some events (like receiving a message) can trigger an
41 external action, for example a shell script (you need to enable it in your 43 external action, for example a shell script (you need to enable it in your
42 configuration file). A sample events script ("eventcmd") is provided with 44 configuration file). A sample events script ("eventcmd") is provided with
43 `mcabber` source code, in the contrib directory. 45 `mcabber` source code, in the contrib directory.
44 46
56 Text typing occurs in the 'input line'; basic operations are supported 58 Text typing occurs in the 'input line'; basic operations are supported
57 (left arrow, right arrow, home/end keys, insert, delete, backspace...). 59 (left arrow, right arrow, home/end keys, insert, delete, backspace...).
58 60
59 PageUp and PageDown keys are used to move in the roster. 61 PageUp and PageDown keys are used to move in the roster.
60 62
63 Up and Down arrow keys can be used to move in the input line history; they
64 jump to the previous/next line from the history beginning with the same string
65 (from first column to the cursor column).
66
61 To send a message, move to the choosen buddy in the buddylist, type your 67 To send a message, move to the choosen buddy in the buddylist, type your
62 message and hit enter. If the line begins with a slash, this will be 68 message and hit enter. If the line begins with a slash, this will be
63 interpreted as a command (see the COMMAND section below). Hit escape to 69 interpreted as a command (see the COMMAND section below). Hit escape to
64 leave the chat mode. 70 leave the chat mode.
65 71
66 Here is a quick description of the key bindings: 72 Here is a quick description of the key bindings:
67 73
68 Ctrl-a:: Go to the beginning of the input line 74 Ctrl-a:: Go to the beginning of the input line
69 Ctrl-e:: Go to the end of the input line 75 Ctrl-e:: Go to the end of the input line
70 Ctrl-l:: Force a resize 76 Ctrl-l:: Force a refresh
77 Up/Down:: Move in the input line history
71 PgUp/PgDown:: Move inside the roster (buddylist) 78 PgUp/PgDown:: Move inside the roster (buddylist)
72 Tab:: Complete current word, in the input line 79 Tab:: Complete current word, in the input line
73 Ctrl-g:: Cancel completion / ctrl-g 80 Ctrl-g:: Cancel completion / ctrl-g
74 Ctrl-p/Ctrl-n:: Scroll up/down half a screen in the buffer window (chat mode) 81 Ctrl-p/Ctrl-n:: Scroll up/down half a screen in the buffer window (chat mode)
75 Ctrl-u:: Delete from beginning of the line to the cursor 82 Ctrl-u:: Delete from beginning of the line to the cursor
92 Aliases are expanded only once, thus they can not be chained. + 99 Aliases are expanded only once, thus they can not be chained. +
93 "/alias name" displays the value associated with the "name" alias; 100 "/alias name" displays the value associated with the "name" alias;
94 "/alias name =" unsets the "name" alias. + 101 "/alias name =" unsets the "name" alias. +
95 Example: "/alias away = status away". 102 Example: "/alias away = status away".
96 103
104 /authorization allow|cancel|request [jid]::
105 Manage the presence subscriptions. +
106 If no jid is provided, the current buddy is used.
107
108 'allow';; allow the buddy to receive your presence updates
109 'cancel';; cancel the buddy' subscription to your presence updates
110 'request';; request a subscription to the buddy's presence updates
111
97 /bind keycode = command line:: 112 /bind keycode = command line::
98 Bind a command line to the key with the "keycode" code number. + 113 Bind a command line to the key with the "keycode" code number. +
99 Keycodes of unused keys are displayed by `mcabber` in the log window 114 Keycodes of unused keys are displayed by `mcabber` in the log window
100 when pressing the key, for example "Unknown key=265". + 115 when pressing the key, for example "Unknown key=265". +
101 "/bind keycode" displays the command line bound to the given keycode; 116 "/bind keycode" displays the command line bound to the given keycode;
102 "/bind keycode" unbinds the given keycode. + 117 "/bind keycode" unbinds the given keycode. +
103 Note: aliases can be used in key bindings. + 118 Note: aliases can be used in key bindings. +
104 Example: "/bind 265 = status online" (265 is F1 for me, but it may 119 Example: "/bind 265 = status online" (265 is F1 for me, but it may
105 depend on your ncurses installation). 120 depend on your ncurses installation).
106 121
107 /buffer clear|top|bottom|search_backward|search_forward|date|%:: 122 /buffer clear|top|bottom|date|%|search_backward|search_forward::
108 The 'buffer' command manipulates the current buddy's buffer 123 The 'buffer' command manipulates the current buddy's buffer
109 (chat window). 124 (chat window).
110 125
111 'clear';; clear the current buddy chat window 126 'clear';; clear the current buddy chat window
112 'bottom';; jump to the bottom of the current buddy chat buffer 127 'bottom';; jump to the bottom of the current buddy chat buffer
113 'top';; jump to the top of the current buddy chat buffer 128 'top';; jump to the top of the current buddy chat buffer
114 'up' [n];; scroll the buffer up n lines (default: half a screen) 129 'up' [n];; scroll the buffer up n lines (default: half a screen)
115 'down' [n];; scroll the buffer down n lines (default: half a screen) 130 'down' [n];; scroll the buffer down n lines (default: half a screen)
131 'date' 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)
132 '%' n;; jump to position %n of the buddy chat buffer
116 'search_backward' text;; search for "text" in the current buddy chat buffer 133 'search_backward' text;; search for "text" in the current buddy chat buffer
117 'search_forward' text;; search for "text" in the current buddy chat buffer 134 'search_forward' text;; search for "text" in the current buddy chat buffer
118 'date' 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)
119 '%' n;; jump to position %n of the buddy chat buffer
120 135
121 /clear:: 136 /clear::
122 The 'clear' command is actually an alias for "/buffer clear". 137 The 'clear' command is actually an alias for "/buffer clear".
123 138
124 /connect:: 139 /connect::