Mercurial > ~mikael > mcabber > hg

comparison mcabber/doc/mcabber.1.html @ 1096:3d92e648a8db

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update manpage
author Mikael Berthe <mikael@lilotux.net>
date Sat, 09 Dec 2006 11:42:14 +0100
parents f7ef8003fc35
children f64af9258f3c
comparison
equal deleted inserted replaced
1095:8188037a9e2a 1096:3d92e648a8db
37 <b>MUC support</b> (Multi-User Chat). 37 <b>MUC support</b> (Multi-User Chat).
38 </p> 38 </p>
39 </li> 39 </li>
40 <li> 40 <li>
41 <p> 41 <p>
42 <b>PGP support</b>
43 </p>
44 </li>
45 <li>
46 <p>
47 <b>Chat States</b> support (typing notifications)
48 </p>
49 </li>
50 <li>
51 <p>
42 <b>History logging:</b> If enabled (see the CONFIGURATION FILE section), 52 <b>History logging:</b> If enabled (see the CONFIGURATION FILE section),
43 <tt>mcabber</tt> can save discussions to history log files. 53 <tt>mcabber</tt> can save discussions to history log files.
44 </p> 54 </p>
45 </li> 55 </li>
46 <li> 56 <li>
112 leave the chat mode.</p> 122 leave the chat mode.</p>
113 <p>Here is a quick description of the key bindings:</p> 123 <p>Here is a quick description of the key bindings:</p>
114 <table class="hlist"> 124 <table class="hlist">
115 <tr valign="top"> 125 <tr valign="top">
116 <td> 126 <td>
127 Esc
128 </td>
129 <td>
130 Disable chat mode
131 </td>
132 </tr>
133 <tr valign="top">
134 <td>
117 Ctrl-a 135 Ctrl-a
118 </td> 136 </td>
119 <td> 137 <td>
120 Go to the beginning of the input line 138 Go to the beginning of the input line
121 </td> 139 </td>
163 <tr valign="top"> 181 <tr valign="top">
164 <td> 182 <td>
165 Ctrl-g 183 Ctrl-g
166 </td> 184 </td>
167 <td> 185 <td>
168 Cancel completion / ctrl-g 186 Cancel completion
187 </td>
188 </tr>
189 <tr valign="top">
190 <td>
191 Ctrl-c
192 </td>
193 <td>
194 Abort multi-line messages and completions
195 </td>
196 </tr>
197 <tr valign="top">
198 <td>
199 Ctrl-d
200 </td>
201 <td>
202 Send/terminate a multi-line message
169 </td> 203 </td>
170 </tr> 204 </tr>
171 <tr valign="top"> 205 <tr valign="top">
172 <td> 206 <td>
173 Ctrl-p/Ctrl-n 207 Ctrl-p/Ctrl-n
239 <td> 273 <td>
240 Jump to the next unread message 274 Jump to the next unread message
241 </td> 275 </td>
242 </tr> 276 </tr>
243 </table> 277 </table>
244 <p>Additional key bindings may be specified using the /bind command described 278 <p>Additional key bindings may be specified using the <b>/bind</b> command described
245 in the COMMANDS section.</p> 279 in the COMMANDS section.</p>
246 <h2>MCABBER'S ROSTER</h2> 280 <h2>MCABBER'S ROSTER</h2>
247 <p>The first listed resource on the roster is <b>[status]</b>, which keeps a log of 281 <p>The first listed resource on the roster is <b>[status]</b>, which keeps a log of
248 everything that appears in the short log window below the main chat area. 282 everything that appears in the short log window below the main chat area.
249 While the log window was designed for showing the latest few elements, the 283 While the log window was designed for showing the latest few elements, the
740 Send a multi-line message. To write a single message with several 774 Send a multi-line message. To write a single message with several
741 lines, the <b>multi-line mode</b> should be used.<br /> 775 lines, the <b>multi-line mode</b> should be used.<br />
742 In multi-line mode, each line (except command lines) typed in the input 776 In multi-line mode, each line (except command lines) typed in the input
743 line will be added to the multi-line message. Once the message is 777 line will be added to the multi-line message. Once the message is
744 finished, it can be sent to the current selected buddy with the "/msay 778 finished, it can be sent to the current selected buddy with the "/msay
745 send" command.<br /> 779 send" command (or Ctrl-d).<br />
746 The <b>begin</b> subcommand enables multi-line mode. Note that it allows 780 The <b>begin</b> subcommand enables multi-line mode. Note that it allows
747 a message subject to be specified.<br /> 781 a message subject to be specified.<br />
748 The <b>verbatim</b> multi-line mode disables commands, so that it is 782 The <b>verbatim</b> multi-line mode disables commands, so that it is
749 possible to enter lines starting with a slash. Only the "/msay" 783 possible to enter lines starting with a slash. Only the "/msay"
750 command (with send or abort parameters) can be used to exit verbatim 784 command (with send or abort parameters) can be used to exit verbatim
810 </td> 844 </td>
811 </tr> 845 </tr>
812 </table> 846 </table>
813 </dd> 847 </dd>
814 <dt><b> 848 <dt><b>
849 /pgp disable|enable|info [jid]
850 </b></dt>
851 <dt><b>
852 /pgp setkey [jid [key]]
853 </b></dt>
854 <dd>
855 Manipulate PGP settings for the specified jid (by default the currently selected contact). Please note that PGP encryption won't be used if no remote PGP support is detected, even if PGP is enabled with this command.
856 <table class="hlist">
857 <tr valign="top">
858 <td>
859 <b>disable</b> [jid]
860 </td>
861 <td>
862 disable PGP encryption for jid (or the currently selected contact)
863 </td>
864 </tr>
865 <tr valign="top">
866 <td>
867 <b>enable</b> [jid]
868 </td>
869 <td>
870 enable PGP encryption for jid (or the currently selected contact)
871 </td>
872 </tr>
873 <tr valign="top">
874 <td>
875 <b>info</b> [jid]
876 </td>
877 <td>
878 show current PGP settings for the contact
879 </td>
880 </tr>
881 <tr valign="top">
882 <td>
883 <b>setkey</b> [jid [key]]
884 </td>
885 <td>
886 set the PGP key to be used to encrypt message for this contact. If no key is provided, the current key is erased. You can use the shortcut-jid "." for the currently selected contact.
887 </td>
888 </tr>
889 </table>
890 </dd>
891 <dt><b>
815 /rename name 892 /rename name
816 </b></dt> 893 </b></dt>
817 <dd> 894 <dd>
818 Rename current buddy or group to the given name. 895 Rename current buddy or group to the given name.
819 Please note that a group name change is only done when the server's 896 Please note that a group name change is only done when the server's
820 acknowledgment is received, so a slight delay can be noticed. 897 acknowledgment is received, so a slight delay can be noticed.
821 </dd> 898 </dd>
822 <dt><b> 899 <dt><b>
823 /request time|version [jid] 900 /request last|time|vcard|version [jid]
824 </b></dt> 901 </b></dt>
825 <dd> 902 <dd>
826 Send a "IQ" query to the current buddy, or to the specified Jabber 903 Send a "IQ" query to the current buddy, or to the specified Jabber
827 user. If the resource is not provided with the jid, mcabber will 904 user. If the resource is not provided with the jid, mcabber will
828 send the query to all known resources for this user. 905 send the query to all known resources for this user.
831 /room join|leave|names|nick|privmsg|remove|topic|unlock|destroy 908 /room join|leave|names|nick|privmsg|remove|topic|unlock|destroy
832 </b></dt> 909 </b></dt>
833 <dt><b> 910 <dt><b>
834 /room invite|kick|ban|role|affil 911 /room invite|kick|ban|role|affil
835 </b></dt> 912 </b></dt>
913 <dt><b>
914 /room bookmark [add|del] [-autojoin|+autojoin]
915 </b></dt>
836 <dd> 916 <dd>
837 The <b>room</b> command handles Multi-User Chat room actions. 917 The <b>room</b> command handles Multi-User Chat room actions.
838 <table class="hlist"> 918 <table class="hlist">
839 <tr valign="top"> 919 <tr valign="top">
840 <td> 920 <td>
952 <td> 1032 <td>
953 <b>affil</b> jid affil [reason] 1033 <b>affil</b> jid affil [reason]
954 </td> 1034 </td>
955 <td> 1035 <td>
956 change jid's affiliation (affil can be "none", "member", "admin", "owner") 1036 change jid's affiliation (affil can be "none", "member", "admin", "owner")
1037 <b>bookmark</b> add/update/remove a room bookmark, set/unset autojoin
957 </td> 1038 </td>
958 </tr> 1039 </tr>
959 </table> 1040 </table>
960 </dd> 1041 </dd>
961 <dt><b> 1042 <dt><b>
962 /roster bottom|top|hide_offline|show_offline|toggle_offline 1043 /roster bottom|top|up|down|group_prev|group_next
1044 </b></dt>
1045 <dt><b>
1046 /roster alternate|unread_first|unread_next
1047 </b></dt>
1048 <dt><b>
1049 /roster search bud
1050 </b></dt>
1051 <dt><b>
1052 /roster hide_offline|show_offline|toggle_offline
1053 </b></dt>
1054 <dt><b>
1055 /roster item_lock|item_unlock
963 </b></dt> 1056 </b></dt>
964 <dt><b> 1057 <dt><b>
965 /roster hide|show|toggle 1058 /roster hide|show|toggle
966 </b></dt> 1059 </b></dt>
967 <dt><b> 1060 <dt><b>
968 /roster alternate|unread_first|unread_next 1061 /roster note [-|text]
969 </b></dt>
970 <dt><b>
971 /roster search bud
972 </b></dt> 1062 </b></dt>
973 <dd> 1063 <dd>
974 The <b>roster</b> command manipulates the roster/buddylist. Here are the available parameters: 1064 The <b>roster</b> command manipulates the roster/buddylist. Here are the available parameters:
975 <table class="hlist"> 1065 <table class="hlist">
976 <tr valign="top"> 1066 <tr valign="top">
1005 move down in the roster 1095 move down in the roster
1006 </td> 1096 </td>
1007 </tr> 1097 </tr>
1008 <tr valign="top"> 1098 <tr valign="top">
1009 <td> 1099 <td>
1100 <b>group_prev</b>
1101 </td>
1102 <td>
1103 jump to the previous group in the roster
1104 </td>
1105 </tr>
1106 <tr valign="top">
1107 <td>
1108 <b>group_next</b>
1109 </td>
1110 <td>
1111 jump to the next group in the roster
1112 </td>
1113 </tr>
1114 <tr valign="top">
1115 <td>
1116 <b>alternate</b>
1117 </td>
1118 <td>
1119 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")
1120 </td>
1121 </tr>
1122 <tr valign="top">
1123 <td>
1124 <b>unread_first</b>
1125 </td>
1126 <td>
1127 jump to the first unread message
1128 </td>
1129 </tr>
1130 <tr valign="top">
1131 <td>
1132 <b>unread_next</b>
1133 </td>
1134 <td>
1135 jump to the next unread message
1136 </td>
1137 </tr>
1138 <tr valign="top">
1139 <td>
1140 <b>search</b> bud
1141 </td>
1142 <td>
1143 search for a buddy with a name or jid containing "bud" (only in the displayed buddylist)
1144 </td>
1145 </tr>
1146 <tr valign="top">
1147 <td>
1010 <b>hide_offline</b> 1148 <b>hide_offline</b>
1011 </td> 1149 </td>
1012 <td> 1150 <td>
1013 hide offline buddies 1151 hide offline buddies
1014 </td> 1152 </td>
1029 toggle display of offline buddies 1167 toggle display of offline buddies
1030 </td> 1168 </td>
1031 </tr> 1169 </tr>
1032 <tr valign="top"> 1170 <tr valign="top">
1033 <td> 1171 <td>
1172 <b>item_lock</b> jid
1173 </td>
1174 <td>
1175 lock the roster item so it remains visible regardless of its status
1176 </td>
1177 </tr>
1178 <tr valign="top">
1179 <td>
1180 <b>item_unlock</b> jid
1181 </td>
1182 <td>
1183 undo the effects of item_lock
1184 </td>
1185 </tr>
1186 <tr valign="top">
1187 <td>
1034 <b>hide</b> 1188 <b>hide</b>
1035 </td> 1189 </td>
1036 <td> 1190 <td>
1037 hide roster (full-width chat window) 1191 hide roster (full-width chat window)
1038 </td> 1192 </td>
1053 toggle roster visibility 1207 toggle roster visibility
1054 </td> 1208 </td>
1055 </tr> 1209 </tr>
1056 <tr valign="top"> 1210 <tr valign="top">
1057 <td> 1211 <td>
1058 <b>item_lock</b> jid 1212 <b>note</b> [text]
1059 </td> 1213 </td>
1060 <td> 1214 <td>
1061 lock the roster item so it remains visible regardless of its status 1215 display or set an annotation (if text is "-", the annotation is deleted). In the "status" buffer, it will display all annotations.
1062 </td>
1063 </tr>
1064 <tr valign="top">
1065 <td>
1066 <b>item_unlock</b> jid
1067 </td>
1068 <td>
1069 undo the effects of item_lock
1070 </td>
1071 </tr>
1072 <tr valign="top">
1073 <td>
1074 <b>search</b> bud
1075 </td>
1076 <td>
1077 search for a buddy with a name or jid containing "bud" (only in the displayed buddylist)
1078 </td>
1079 </tr>
1080 <tr valign="top">
1081 <td>
1082 <b>alternate</b>
1083 </td>
1084 <td>
1085 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")
1086 </td>
1087 </tr>
1088 <tr valign="top">
1089 <td>
1090 <b>unread_first</b>
1091 </td>
1092 <td>
1093 jump to the first unread message
1094 </td>
1095 </tr>
1096 <tr valign="top">
1097 <td>
1098 <b>unread_next</b>
1099 </td>
1100 <td>
1101 jump to the next unread message
1102 </td> 1216 </td>
1103 </tr> 1217 </tr>
1104 </table> 1218 </table>
1105 </dd> 1219 </dd>
1106 <dt><b> 1220 <dt><b>
1157 Originally based on <a href="http://cabber.sourceforge.net">Cabber</a>, please 1271 Originally based on <a href="http://cabber.sourceforge.net">Cabber</a>, please
1158 consult the AUTHORS file for details.</p> 1272 consult the AUTHORS file for details.</p>
1159 <h2>RESOURCES</h2> 1273 <h2>RESOURCES</h2>
1160 <p><a href="http://www.lilotux.net/~mikael/mcabber/">Main web site</a></p> 1274 <p><a href="http://www.lilotux.net/~mikael/mcabber/">Main web site</a></p>
1161 <h2>COPYING</h2> 1275 <h2>COPYING</h2>
1162 <p>Copyright &#169; 2005, 2006 Mikael Berthe.<br /> 1276 <p>Copyright (C) 2005, 2006 Mikael Berthe.<br />
1163 Some portions are Copyright &#169; 2002-2004 <a href="mailto:cabber@ajmacias.com">cabber@ajmacias.com</a>.</p> 1277 Some portions are Copyright (C) 2002-2004 <a href="mailto:cabber@ajmacias.com">cabber@ajmacias.com</a>.</p>
1164 <p>Free use of this software is granted under the terms of the GNU General Public 1278 <p>Free use of this software is granted under the terms of the GNU General Public
1165 License (GPL).</p> 1279 License (GPL).</p>
1166 <div id="footer"> 1280 <div id="footer">
1167 <p> 1281 <p>
1168 Version 0.8.3-dev<br /> 1282 Version 0.9.0-dev<br />
1169 Last updated 01-Oct-2006 23:57:04 CEST 1283 Last updated 09-Dec-2006 11:19:42 CEST
1170 </p> 1284 </p>
1171 </div> 1285 </div>
1172 </div> 1286 </div>
1173 </body> 1287 </body>
1174 </html> 1288 </html>