diff --git a/helpexample.txt b/helpexample.txt new file mode 100644 index 00000000..4dc40169 --- /dev/null +++ b/helpexample.txt @@ -0,0 +1,89 @@ +ROSTER + +Synopsis: +/roster +/roster online +/roster show [offline|resource|empty] +/roster hide [offline|resource|empty] +/roster by group|presence|none +/roster size +/roster add [] +/roster remove +/roster remove_all contacts +/roster nick +/roster clearnick + +Description: +Manage your roster, and roster display settings. Passing no arguments displays your roster. + +Arguments: +online : Show all online contacts in your roster. +show : Show the roster panel. +show offline : Show offline contacts in the roster panel. +show resource : Show contact's connected resources in the roster panel. +show empty : When grouping by presence, show empty presence groups +hide : Hide the roster panel. +hide offline : Hide offline contacts in the roster panel. +hide resource : Hide contact's connected resources in the roster panel. +hide empty : When grouping by presence, hide empty presence groups +by group : Group contacts in the roster panel by roster group. +by presence : Group contacts in the roster panel by presence. +by none : No grouping in the roster panel. +size : Percentage of the screen taken up by the roster (1-99). +add [] : Add a new item to the roster. +remove : Removes an item from the roster. +remove_all contacts : Remove all items from roster. +nick : Change a contacts nickname. +clearnick : Removes the current nickname. + +Exmaples: +/roster +/roster add someone@contacts.org +/roster add someone@contacts.org Buddy +/roster remove someone@contacts.org +/roster nick myfriend@chat.org My Friend +/roster clearnick kai@server.com +/roster size 15 + +OTR + +Synopsis: +/otr gen +/otr myfp +/otr theirfp +/otr start [] +/otr end +/otr trust +/otr untrust +/otr log on|off|redact +/otr warn on|off +/otr libver +/otr policy manual|opportunistic|always +/otr secret +/otr question +/otr answer + +Description: +Off The Record message encryption commands. + +Arguments: +gen : Generate your private key. +myfp : Show your fingerprint. +theirfp : Show contacts fingerprint. +start : Start an OTR session with current recipient. +start : Start an OTR session with the contact. +end : End the current OTR session. +trust : Indicate that you have verified the contact's fingerprint. +untrust : Indicate the the contact's fingerprint is not verified. +log on : Enable plaintext logging of OTR messages. +log off : Disable logging of OTR messages. +log redact : Log OTR messages as [redacted], the default. +warn on : Show in the titlebar when unencrypted messaging is being used. +warn off : Show in the titlebar when unencrypted messaging is being used. +libver : Show which version of the libotr library is being used. +policy manual : Set the global OTR policy. +policy opportunistici : Set the global OTR policy. +policy always : Set the global OTR policy. +secret : Verify a contacts identity using a shared secret. +question : Verify a contacts identity using a question and expected answer. +answer : Respond to a question answer verification request with your answer.