aniani/profanity
1
0
Fork 0
mirror of https://github.com/profanity-im/profanity.git synced 2024-12-04 14:46:46 -05:00
Code

Moved remaining help to new format

Browse Source
This commit is contained in:
James Booth 2015-07-26 00:17:16 +01:00
parent b33f4777d0
commit cb7504e67f
2 changed files with 507 additions and 404 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

89
helpexample.txt
View File

@ -1,89 +0,0 @@
ROSTER
Synopsis:
/roster
/roster online
/roster show [offline|resource|empty]
/roster hide [offline|resource|empty]
/roster by group|presence|none
/roster size <percent>
/roster add <jid> [<nick>]
/roster remove <jid>
/roster remove_all contacts
/roster nick <jid> <nick>
/roster clearnick <jid>
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 <precent> : Percentage of the screen taken up by the roster (1-99).
add <jid> [<nick>] : Add a new item to the roster.
remove <jid> : Removes an item from the roster.
remove_all contacts : Remove all items from roster.
nick <jid> <nick> : Change a contacts nickname.
clearnick <jid> : 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 [<contact>]
/otr end
/otr trust
/otr untrust
/otr log on|off|redact
/otr warn on|off
/otr libver
/otr policy manual|opportunistic|always
/otr secret <secret>
/otr question <question> <answer>
/otr answer <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 <contact> : 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 <secret> : Verify a contacts identity using a shared secret.
question <question> <answer> : Verify a contacts identity using a question and expected answer.
answer <answer> : Respond to a question answer verification request with your answer.

822
src/command/command.c
View File

@ -1144,399 +1144,591 @@ static struct cmd_t command_defs[] =
NULL } } NULL } }
}, },
// OLD STYLE
{ "/alias", { "/alias",
cmd_alias, parse_args_with_freetext, 1, 3, NULL, cmd_alias, parse_args_with_freetext, 1, 3, NULL,
{ "/alias add|remove|list [name value]", "Add your own command aliases.", { NULL, NULL, { NULL },
{ "/alias add|remove|list [name value]", {
"-----------------------------------", "/alias list",
"Add, remove or show command aliases.", "/alias add <name> <value>",
"", "/alias remove <name>",
"add name value : Add a new command alias.", NULL
"remove name : Remove a command alias.", },
"list : List all aliases.", "Add, remove or list command aliases.",
"", {
"Example: /alias add friends /who online friends", { "list", "List all aliases." },
"Example: /alias add /q /quit", { "add <name> <value>", "Add a new command alias." },
"Example: /alias a /away \"I'm in a meeting.\"", { "remove <name>", "Remove a command alias." },
"Example: /alias remove q", END_ARGS },
"Example: /alias list", {
"", "/alias add friends /who online friends",
"The above aliases will be available as /friends and /a", "/alias add /q /quit",
NULL, "/alias a /away \"I'm in a meeting.\"",
NULL, NULL, NULL, NULL } } }, "/alias remove q",
"/alias list",
NULL } }
},
{ "/chlog", { "/chlog",
cmd_chlog, parse_args, 1, 1, &cons_chlog_setting, cmd_chlog, parse_args, 1, 1, &cons_chlog_setting,
{ "/chlog on|off", "Chat logging to file.", { NULL, NULL, { NULL },
{ "/chlog on|off", {
"-------------", "/chlog on|off",
"Switch chat logging on or off.", NULL
"This setting will be enabled if /history is set to on.", },
"When disabling this option, /history will also be disabled.", "Switch chat logging on or off. "
"See the /grlog setting for enabling logging of chat room (groupchat) messages.", "This setting will be enabled if /history is set to on. "
NULL, "When disabling this option, /history will also be disabled. "
NULL, NULL, NULL, NULL } } }, "See the /grlog setting for enabling logging of chat room (groupchat) messages.",
{
{ "on|off", "Enable or disable chat logging." },
END_ARGS },
{
NULL } }
},
{ "/grlog", { "/grlog",
cmd_grlog, parse_args, 1, 1, &cons_grlog_setting, cmd_grlog, parse_args, 1, 1, &cons_grlog_setting,
{ "/grlog on|off", "Chat logging of chat rooms to file.", { NULL, NULL, { NULL },
{ "/grlog on|off", {
"-------------", "/grlog on|off",
"Switch chat room logging on or off.", NULL
"See the /chlog setting for enabling logging of one to one chat.", },
NULL, "Switch chat room logging on or off. "
NULL, NULL, NULL, NULL } } }, "See the /chlog setting for enabling logging of one to one chat.",
{
{ "on|off", "Enable or disable chat room logging." },
END_ARGS },
{
NULL } }
},
{ "/states", { "/states",
cmd_states, parse_args, 1, 1, &cons_states_setting, cmd_states, parse_args, 1, 1, &cons_states_setting,
{ "/states on|off", "Send chat states during a chat session.", { NULL, NULL, { NULL },
{ "/states on|off", {
"--------------", "/states on|off",
"Send chat state notifications during chat sessions.", NULL
NULL, },
NULL, NULL, NULL, NULL } } }, "Send chat state notifications to recipient during chat sessions, such as typing, paused, active, gone.",
{
{ "on|off", "Enable or disable sending of chat state notifications." },
END_ARGS },
{
NULL } }
},
{ "/pgp", { "/pgp",
cmd_pgp, parse_args, 1, 3, NULL, cmd_pgp, parse_args, 1, 3, NULL,
{ "/pgp command [args..]", "Open PGP commands.", { NULL, NULL, { NULL },
{ "/pgp command [args..]", {
"---------------------", "/pgp libver",
"Open PGP commands.", "/pgp keys",
"", "/pgp fps",
"keys : List all keys.", "/pgp setkey <contact> <keyid>",
"libver : Show which version of the libgpgme library is being used.", "/pgp start [<contact>]",
"fps : Show known fingerprints.", "/pgp end",
"setkey contact keyid : Manually associate a key ID with a JID.", "/pgp log on|off|redact",
"start [contact] : Start PGP encrypted chat, current contact will be used if not specified.", NULL
"end : End PGP encrypted chat with the current recipient.", },
"log on|off|redact : PGP message logging, default: redact.", "Open PGP commands to manage keys, and perform PGP encryption during chat sessions. "
NULL, "See the /account command to set your own PGP key.",
NULL, NULL, NULL, NULL } } }, {
{ "libver", "Show which version of the libgpgme library is being used." },
{ "keys", "List all keys." },
{ "fps", "Show known fingerprints." },
{ "setkey <contact> <keyid>", "Manually associate a key ID with a JID." },
{ "start [<contact>]", "Start PGP encrypted chat, current contact will be used if not specified." },
{ "end", "End PGP encrypted chat with the current recipient." },
{ "log on|off", "Enable or disable plaintext logging of PGP encrypted messages." },
{ "log redact", "Log PGP encrypted messages, but replace the contents with [redacted]. This is the default." },
END_ARGS },
{
"/pgp log off",
"/pgp setkey buddy@buddychat.org BA19CACE5A9592C5",
"/pgp start buddy@buddychat.org",
"/pgp end",
NULL } }
},
{ "/otr", { "/otr",
cmd_otr, parse_args, 1, 3, NULL, cmd_otr, parse_args, 1, 3, NULL,
{ "/otr command [args..]", "Off The Record encryption commands.", { NULL, NULL, { NULL },
{ "/otr command [args..]", {
"---------------------", "/otr libver",
"Off The Record encryption commands.", "/otr gen",
"", "/otr myfp|theirfp",
"gen : Generate your private key.", "/otr start [<contact>]",
"myfp : Show your fingerprint.", "/otr end",
"theirfp : Show contacts fingerprint.", "/otr trust|untrust",
"start [contact] : Start an OTR session with contact, or current recipient if omitted.", "/otr secret <secret>",
"end : End the current OTR session,", "/otr question <question> <answer>",
"trust : Indicate that you have verified the contact's fingerprint.", "/otr answer <answer>",
"untrust : Indicate the the contact's fingerprint is not verified,", "/otr policy manual|opportunistic|always",
"log on|off|redact : OTR message logging, default: redact.", "/otr log on|off|redact",
"warn on|off : Show in the titlebar when unencrypted messaging is being used.", NULL
"libver : Show which version of the libotr library is being used.", },
"policy manual|opportunistic|always : Set the global OTR policy.", "Off The Record (OTR) commands to manage keys, and perform OTR encryption during chat sessions.",
"secret [secret] : Verify a contacts identity using a shared secret.", {
"question [question] [answer] : Verify a contacts identity using a question and expected answer.", { "libver", "Show which version of the libotr library is being used." },
"answer [answer] : Respond to a question answer verification request with your answer.", { "gen", "Generate your private key." },
NULL, { "myfp", "Show your fingerprint." },
NULL, NULL, NULL, NULL } } }, { "theirfp", "Show contacts fingerprint." },
{ "start [<contact>]", "Start an OTR session with contact, or current recipient if omitted." },
{ "end", "End the current OTR session," },
{ "trust|untrust", "Indicate whether or not you trust the contact's fingerprint." },
{ "secret <secret>", "Verify a contact's identity using a shared secret." },
{ "question <question> <answer>", "Verify a contact's identity using a question and expected answer." },
{ "answer <answer>", "Respond to a question answer verification request with your answer." },
{ "policy manual", "Set the global OTR policy to manual, OTR sessions must be started manually." },
{ "policy opportunistic", "Set the global OTR policy to opportunistic, and OTR sessions will be attempted upon starting a conversation." },
{ "policy always", "Set the global OTR policy to always, an error will be displayed if an OTR session cannot be initiated upon starting a conversation." },
{ "log on|off", "Enable or disable plaintext logging of OTR encrypted messages." },
{ "log redact", "Log OTR encrypted messages, but replace the contents with [redacted]. This is the default." },
END_ARGS },
{
"/otr log off",
"/otr policy manual",
"/otr gen",
"/otr start buddy@buddychat.org",
"/otr myfp",
"/otr theirfp",
"/otr question \"What is the name of my rabbit?\" fiffi",
"/otr end",
NULL } }
},
{ "/outtype", { "/outtype",
cmd_outtype, parse_args, 1, 1, &cons_outtype_setting, cmd_outtype, parse_args, 1, 1, &cons_outtype_setting,
{ "/outtype on|off", "Send typing notification to recipient.", { NULL, NULL, { NULL },
{ "/outtype on|off", {
"---------------", "/outtype on|off",
"Send typing notifications, chat states (/states) will be enabled if this setting is set.", NULL
NULL, },
NULL, NULL, NULL, NULL } } }, "Send typing notifications, chat states (/states) will be enabled if this setting is enabled.",
{
{ "on|off", "Enable or disable sending typing notifications." },
END_ARGS },
{
NULL } }
},
{ "/gone", { "/gone",
cmd_gone, parse_args, 1, 1, &cons_gone_setting, cmd_gone, parse_args, 1, 1, &cons_gone_setting,
{ "/gone minutes", "Send 'gone' state to recipient after a period.", { NULL, NULL, { NULL },
{ "/gone minutes", {
"-------------", "/gone <minutes>",
"Send a 'gone' state to the recipient after the specified number of minutes.", NULL
"A value of 0 will disable sending this chat state.", },
"Chat states (/states) will be enabled if this setting is set.", "Send a 'gone' state to the recipient after the specified number of minutes. "
NULL, "Chat states (/states) will be enabled if this setting is set.",
NULL, NULL, NULL, NULL } } }, {
{ "<minutes>", "Number of minutes of inactivity before sending the 'gone' state, a value of 0 will disable sending this state." },
END_ARGS },
{
NULL } }
},
{ "/history", { "/history",
cmd_history, parse_args, 1, 1, &cons_history_setting, cmd_history, parse_args, 1, 1, &cons_history_setting,
{ "/history on|off", "Chat history in message windows.", { NULL, NULL, { NULL },
{ "/history on|off", {
"---------------", "/history on|off",
"Switch chat history on or off, /chlog will automatically be enabled when this setting is on.", NULL
"When history is enabled, previous messages are shown in chat windows.", },
NULL, "Switch chat history on or off, /chlog will automatically be enabled when this setting is on. "
NULL, NULL, NULL, NULL } } }, "When history is enabled, previous messages are shown in chat windows.",
{
{ "on|off", "Enable or disable showing chat history." },
END_ARGS },
{
NULL } }
},
{ "/log", { "/log",
cmd_log, parse_args, 1, 2, &cons_log_setting, cmd_log, parse_args, 1, 2, &cons_log_setting,
{ "/log where|rotate|maxsize|shared [value]", "Manage system logging settings.", { NULL, NULL, { NULL },
{ "/log where|rotate|maxsize|shared [value]", {
"----------------------------------------", "/log where",
"Manage profanity logging settings.", "/log rotate on|off",
"", "/log maxsize <bytes>",
"where : Show the current log file location.", "/log shared on|off",
"rotate on|off : Rotate log, default on.", NULL
"maxsize bytes : With rotate enabled, specifies the max log size, defaults to 1048580 (1MB).", },
"shared on|off : Share logs between all instances, default: on.", "Manage profanity log settings.",
NULL, {
NULL, NULL, NULL, NULL } } }, { "where", "Show the current log file location." },
{ "rotate on|off", "Rotate log, default on." },
{ "maxsize <bytes>", "With rotate enabled, specifies the max log size, defaults to 1048580 (1MB)." },
{ "shared on|off", "Share logs between all instances, default: on. When off, the process id will be included in the log." },
END_ARGS },
{
NULL } }
},
{ "/carbons", { "/carbons",
cmd_carbons, parse_args, 1, 1, &cons_carbons_setting, cmd_carbons, parse_args, 1, 1, &cons_carbons_setting,
{ "/carbons on|off", "Message carbons.", { NULL, NULL, { NULL },
{ "/carbons on|off", {
"---------------", "/carbons on|off",
"Enable or disable message carbons.", NULL
"The message carbons feature ensures that both sides of all conversations are shared with all the user's clients that implement this protocol.", },
NULL, "Enable or disable message carbons. "
NULL, NULL, NULL, NULL } } }, "Message carbons ensure that both sides of all conversations are shared with all the user's clients that implement this protocol.",
{
{ "on|off", "Enable or disable message carbons." },
END_ARGS },
{
NULL } }
},
{ "/receipts", { "/receipts",
cmd_receipts, parse_args, 2, 2, &cons_receipts_setting, cmd_receipts, parse_args, 2, 2, &cons_receipts_setting,
{ "/receipts send|request on|off", "Message delivery receipts.", { NULL, NULL, { NULL },
{ "/receipts send|request on|off", {
"-----------------------------", "/receipts request on|off",
"Enable or disable message delivery receipts. The interface will indicate when a message has been received.", "/receipts send on|off",
"", NULL
"send on|off : Enable or disable sending of delivery receipts.", },
"request on|off : Enable or disable sending of delivery receipt requests.", "Enable or disable message delivery receipts. The interface will indicate when a message has been received.",
NULL, {
NULL, NULL, NULL, NULL } } }, { "request on|off", "Whether or not to request a receipt upon sending a message." },
{ "send on|off", "Whether or not to send a receipt if one has been requested with a received message." },
END_ARGS },
{
NULL } }
},
{ "/reconnect", { "/reconnect",
cmd_reconnect, parse_args, 1, 1, &cons_reconnect_setting, cmd_reconnect, parse_args, 1, 1, &cons_reconnect_setting,
{ "/reconnect seconds", "Set reconnect interval.", { NULL, NULL, { NULL },
{ "/reconnect seconds", {
"------------------", "/reconnect <seconds>",
"Set the reconnect attempt interval in seconds for when the connection is lost.", NULL
"A value of 0 will switch off reconnect attempts.", },
NULL, "Set the reconnect attempt interval for when the connection is lost.",
NULL, NULL, NULL, NULL } } }, {
{ "<seconds>", "Number of seconds before attempting to reconnect, a value of 0 disables reconnect." },
END_ARGS },
{
NULL } }
},
{ "/autoping", { "/autoping",
cmd_autoping, parse_args, 1, 1, &cons_autoping_setting, cmd_autoping, parse_args, 1, 1, &cons_autoping_setting,
{ "/autoping seconds", "Server ping interval.", { NULL, NULL, { NULL },
{ "/autoping seconds", {
"-----------------", "/autoping <seconds>",
"Set the number of seconds between server pings, so ensure connection kept alive.", NULL
"A value of 0 will switch off autopinging the server.", },
NULL, "Set the interval between sending ping requests to the server to ensure the connection is kept alive.",
NULL, NULL, NULL, NULL } } }, {
{ "<seconds>", "Number of seconds between sending pings, a value of 0 disables autoping." },
END_ARGS },
{
NULL } }
},
{ "/ping", { "/ping",
cmd_ping, parse_args, 0, 1, NULL, cmd_ping, parse_args, 0, 1, NULL,
{ "/ping [target]", "Send ping IQ request.", { NULL, NULL, { NULL },
{ "/ping [target]", {
"--------------", "/ping [<jid>]",
"Sends an IQ ping stanza to the specified target.", NULL
"If no target is supplied, your chat server will be pinged.", },
NULL, "Sends an IQ ping stanza to the specified JID. "
NULL, NULL, NULL, NULL } } }, "If no JID is supplied, your chat server will be pinged.",
{
{ "<jid>", "The Jabber ID to send the ping request to." },
END_ARGS },
{
NULL } }
},
{ "/autoaway", { "/autoaway",
cmd_autoaway, parse_args_with_freetext, 2, 2, &cons_autoaway_setting, cmd_autoaway, parse_args_with_freetext, 2, 2, &cons_autoaway_setting,
{ "/autoaway mode|time|message|check value", "Set auto idle/away properties.", { NULL, NULL, { NULL },
{ "/autoaway mode|time|message|check value", {
"---------------------------------------", "/autoaway mode idle|away|off",
"Manage autoway properties.", "/autoaway time <minutes>",
"", "/autoaway message <message>|off",
"mode idle : Sends idle time, status remains online.", "/autoaway check on|off",
"mode away : Sends an away presence.", NULL
"mode off : Disabled (default).", },
"time minutes : Number of minutes before the presence change is sent, default: 15.", "Manage autoway settings for idle time.",
"message text|off : Optional message to send with the presence change, default: off (disabled).", {
"check on|off : When enabled, checks for activity and sends online presence, default: on.", { "mode idle", "Sends idle time, status remains online." },
"", { "mode away", "Sends an away presence." },
"Example: /autoaway mode idle", { "mode off", "Disabled (default)." },
"Example: /autoaway time 30", { "time <minutes>", "Number of minutes before the presence change is sent, default: 15." },
"Example: /autoaway message I'm not really doing much", { "message <message>", "Optional message to send with the presence change, default: off (disabled)." },
"Example: /autoaway check off", { "message off", "Send no message with autoaway presence." },
NULL, { "check on|off", "When enabled, checks for activity and sends online presence, default: on." },
NULL, NULL, NULL, NULL } } }, END_ARGS },
{
"/autoaway mode idle",
"/autoaway time 30",
"/autoaway message I'm not really doing much",
"/autoaway check off",
NULL } }
},
{ "/priority", { "/priority",
cmd_priority, parse_args, 1, 1, &cons_priority_setting, cmd_priority, parse_args, 1, 1, &cons_priority_setting,
{ "/priority value", "Set priority for the current account.", { NULL, NULL, { NULL },
{ "/priority value", {
"---------------", "/priority <priority>",
"Set priority for the current account.", NULL
"", },
"value : Number between -128 and 127, default: 0.", "Set priority for the current account. "
"", "See the /account command for specific priority settings per presence status.",
"See the /account command for specific priority settings per presence status.", {
NULL, { "<priority>", "Number between -128 and 127, default: 0." },
NULL, NULL, NULL, NULL } } }, END_ARGS },
{
NULL } }
},
{ "/account", { "/account",
cmd_account, parse_args, 0, 4, NULL, cmd_account, parse_args, 0, 4, NULL,
{ "/account [command] [account] [property] [value]", "Manage accounts.", { NULL, NULL, { NULL },
{ "/account [command] [account] [property] [value]", {
"-----------------------------------------------", "/account",
"Commands for creating and managing accounts.", "/account list",
"", "/account show <account>",
"list : List all accounts.", "/account enable|disable <account>",
"show account : Show information about an account.", "/account default set <account>",
"enable account : Enable the account, it will be used for autocomplete.", "/account default off",
"disable account : Disable the account.", "/account add <account>",
"default [set|off] [account] : Set the default account.", "/account remove <account>",
"add account : Create a new account.", "/account rename <account> <newaccount>",
"remove account : Remove an account.", "/account set <account> jid <jid>",
"rename account newname : Rename account to newname.", "/account set <account> server <server>",
"set account property value : Set 'property' of 'account' to 'value'.", "/account set <account> port <port>",
"clear account property value : Clear 'property' of 'account'.", "/account set <account> status <status>",
"", "/account set <account> online|chat|away|xa|dnd <priority>",
"Account properties.", "/account set <account> resource <resource>",
"", "/account set <account> password <password>",
"jid : The Jabber ID of the account, account name will be used if not set.", "/account set <account> eval_password <command>",
"server : The chat server, if different to the domainpart of the JID.", "/account set <account> muc <service>",
"port : The port used for connecting if not the default (5222, or 5223 for SSL).", "/account set <account> nick <nick>",
"status : The presence status to use on login, use 'last' to use your last status before logging out.", "/account set <account> otr manual|opportunistic|always",
"online|chat|away|xa|dnd : Priority for the specified presence.", "/account set <account> pgpkeyid <pgpkeyid>",
"resource : The resource to be used.", "/account clear <account> password",
"password : Password for the account, note this is currently stored in plaintext if set.", "/account clear <account> eval_password",
"eval_password : Shell command evaluated to retrieve password for the account. Can be used to retrieve password from keyring.", "/account clear <account> server",
"muc : The default MUC chat service to use.", "/account clear <account> port",
"nick : The default nickname to use when joining chat rooms.", "/account clear <account> otr",
"otr : Override global OTR policy for this account: manual, opportunistic or always.", "/account clear <account> pgpkeyid",
"", NULL
"Example: /account add me", },
"Example: /account set me jid me@chatty", "Commands for creating and managing accounts. "
"Example: /account set me server talk.chat.com", "Calling with no arguments will display information for the current account.",
"Example: /account set me port 5111", {
"Example: /account set me muc chatservice.mycompany.com", { "list", "List all accounts." },
"Example: /account set me nick dennis", { "show <account>", "Show details for the specified account." },
"Example: /account set me status dnd", { "enable <account>", "Enable the account, it will be used for autocompletion." },
"Example: /account set me dnd -1", { "disable <account>", "Disable the account." },
"Example: /account rename me gtalk", { "default set <account>", "Set the default account, used when no argument passed to the /connect command." },
NULL, { "default off", "Clear the default account setting." },
NULL, NULL, NULL, NULL } } }, { "add <account>", "Create a new account." },
{ "remove <account>", "Remove an account." },
{ "rename <account> <newaccount>", "Rename 'account' to 'newaccount'." },
{ "set <account> jid <jid>", "Set the Jabber ID for the account, account name will be used if not set." },
{ "set <account> server <server>", "The chat server, if different to the domainpart of the JID." },
{ "set <account> port <port>", "The port used for connecting if not the default (5222, or 5223 for SSL)." },
{ "set <account> status <status>", "The presence status to use on login, use 'last' to use your last status before logging out." },
{ "set <account> online|chat|away|xa|dnd <priority>", "Set the priority (-128..127) to use for the specified presence." },
{ "set <account> resource <resource>", "The resource to be used for this account." },
{ "set <account> password <password>", "Password for the account, note this is currently stored in plaintext if set." },
{ "set <account> eval_password <command>", "Shell command evaluated to retrieve password for the account. Can be used to retrieve password from keyring." },
{ "set <account> muc <service>", "The default MUC chat service to use, defaults to 'conference.<domainpart>' where the domain part is from the account JID." },
{ "set <account> nick <nick>", "The default nickname to use when joining chat rooms." },
{ "set <account> otr manual|opportunistic|always", "Override global OTR policy for this account, see /otr." },
{ "set <account> pgpkeyid <pgpkeyid>", "Set the ID of the PGP key for this account, see /pgp." },
{ "clear <account> server", "Remove the server setting for this account." },
{ "clear <account> port", "Remove the port setting for this account." },
{ "clear <account> password", "Remove the password setting for this account." },
{ "clear <account> eval_password", "Remove the eval_password setting for this account." },
{ "clear <account> otr", "Remove the OTR policy setting for this account." },
{ "clear <account> pgpkeyid", "Remove pgpkeyid associated with this account." },
END_ARGS },
{
"/account add me",
"/account set me jid me@chatty",
"/account set me server talk.chat.com",
"/account set me port 5111",
"/account set me muc chatservice.mycompany.com",
"/account set me nick dennis",
"/account set me status dnd",
"/account set me dnd -1",
"/account rename me gtalk",
NULL } }
},
{ "/prefs", { "/prefs",
cmd_prefs, parse_args, 0, 1, NULL, cmd_prefs, parse_args, 0, 1, NULL,
{ "/prefs [ui|desktop|chat|log|conn|presence]", "Show configuration.", { NULL, NULL, { NULL },
{ "/prefs [ui|desktop|chat|log|conn|presence]", {
"------------------------------------------", "/prefs [ui|desktop|chat|log|conn|presence]",
"Show preferences for different areas of functionality.", NULL
"", },
"ui : User interface preferences.", "Show preferences for different areas of functionality. "
"desktop : Desktop notification preferences.", "Passing no arguments shows all preferences.",
"chat : Chat state preferences.", {
"log : Logging preferences.", { "ui", "User interface preferences." },
"conn : Connection handling preferences.", { "desktop", "Desktop notification preferences." },
"presence : Chat presence preferences.", { "chat", "Chat state preferences." },
"", { "log", "Logging preferences." },
"No argument shows all preferences.", { "conn", "Connection handling preferences." },
NULL, { "presence", "Chat presence preferences." },
NULL, NULL, NULL, NULL } } }, END_ARGS },
{
NULL } }
},
{ "/theme", { "/theme",
cmd_theme, parse_args, 1, 2, &cons_theme_setting, cmd_theme, parse_args, 1, 2, &cons_theme_setting,
{ "/theme list|load|colours [theme-name]", "Change colour theme.", { NULL, NULL, { NULL },
{ "/theme list|load|colours [theme-name]", {
"-------------------------------------", "/theme list",
"Load a theme, includes colours and UI options.", "/theme load <theme>",
"", "/theme colours",
"list : List all available themes.", NULL
"load theme-name : Load the named theme. 'default' will reset to the default theme.", },
"colours : Show the colour values as rendered by the terminal.", "Load a theme, includes colours and UI options.",
"", {
"Example: /theme list", { "list", "List all available themes." },
"Example: /theme load mycooltheme", { "load <theme>", "Load the specified theme. 'default' will reset to the default theme." },
NULL, { "colours", "Show the colour values as rendered by the terminal." },
NULL, NULL, NULL, NULL } } }, END_ARGS },
{
"/theme list",
"/theme load forest",
NULL } }
},
{ "/statuses", { "/statuses",
cmd_statuses, parse_args, 2, 2, &cons_statuses_setting, cmd_statuses, parse_args, 2, 2, &cons_statuses_setting,
{ "/statuses console|chat|muc setting", "Set preferences for presence change messages.", { NULL, NULL, { NULL },
{ "/statuses console|chat|muc setting", {
"----------------------------------", "/statuses console|chat|muc all|online|none",
"Configure which presence changes are displayed in various windows.", NULL
"", },
"console : Configure what is displayed in the console window.", "Configure which presence changes are displayed in various windows. "
"chat : Configure what is displayed in chat windows.", "The default is 'all' for all windows.",
"muc : Configure what is displayed in chat room windows.", {
"", { "console", "Configure what is displayed in the console window." },
"Available options are:", { "chat", "Configure what is displayed in chat windows." },
"", { "muc", "Configure what is displayed in chat room windows." },
"all : Show all presence changes.", { "all", "Show all presence changes." },
"online : Show only online/offline changes.", { "online", "Show only online/offline changes." },
"none : Don't show any presence changes.", { "none", "Don't show any presence changes." },
"", END_ARGS },
"The default is 'all' for all windows.", {
"", "/statuses console none",
"Example: /statuses console none", "/statuses chat online",
"Example: /statuses chat online", "/statuses muc all",
"Example: /statuses muc all", NULL } }
NULL, },
NULL, NULL, NULL, NULL } } },
{ "/xmlconsole", { "/xmlconsole",
cmd_xmlconsole, parse_args, 0, 0, NULL, cmd_xmlconsole, parse_args, 0, 0, NULL,
{ "/xmlconsole", "Open the XML console", { NULL, NULL, { NULL },
{ "/xmlconsole", {
"-----------", "/xmlconsole",
"Open the XML console to view incoming and outgoing XMPP traffic.", NULL
NULL, },
NULL, NULL, NULL, NULL } } }, "Open the XML console to view incoming and outgoing XMPP traffic.",
{
END_ARGS },
{
NULL } }
},
{ "/away", { "/away",
cmd_away, parse_args_with_freetext, 0, 1, NULL, cmd_away, parse_args_with_freetext, 0, 1, NULL,
{ "/away [message]", "Set status to away.", { NULL, NULL, { NULL },
{ "/away [message]", {
"---------------", "/away [<message>]",
"Set your status to 'away' with the optional message.", NULL
"", },
"Example: /away Gone for lunch", "Set your status to 'away'.",
NULL, {
NULL, NULL, NULL, NULL } } }, { "<message>", "Optional message to use with the status." },
END_ARGS },
{
"/away",
"/away Gone for lunch",
NULL } }
},
{ "/chat", { "/chat",
cmd_chat, parse_args_with_freetext, 0, 1, NULL, cmd_chat, parse_args_with_freetext, 0, 1, NULL,
{ "/chat [message]", "Set status to chat (available for chat).", { NULL, NULL, { NULL },
{ "/chat [message]", {
"---------------", "/chat [<message>]",
"Set your status to 'chat', meaning 'available for chat', with the optional message.", NULL
"", },
"Example: /chat Please talk to me!", "Set your status to 'chat' (available for chat).",
NULL, {
NULL, NULL, NULL, NULL } } }, { "<message>", "Optional message to use with the status." },
END_ARGS },
{
"/chat",
"/chat Please talk to me!",
NULL } }
},
{ "/dnd", { "/dnd",
cmd_dnd, parse_args_with_freetext, 0, 1, NULL, cmd_dnd, parse_args_with_freetext, 0, 1, NULL,
{ "/dnd [message]", "Set status to dnd (do not disturb).", { NULL, NULL, { NULL },
{ "/dnd [message]", {
"--------------", "/dnd [<message>]",
"Set your status to 'dnd', meaning 'do not disturb', with the optional message.", NULL
"", },
"Example: /dnd I'm in the zone", "Set your status to 'dnd' (do not disturb).",
NULL, {
NULL, NULL, NULL, NULL } } }, { "<message>", "Optional message to use with the status." },
END_ARGS },
{
"/dnd",
"/dnd I'm in the zone",
NULL } }
},
{ "/online", { "/online",
cmd_online, parse_args_with_freetext, 0, 1, NULL, cmd_online, parse_args_with_freetext, 0, 1, NULL,
{ "/online [message]", "Set status to online.", { NULL, NULL, { NULL },
{ "/online [message]", {
"-----------------", "/online [<message>]",
"Set your status to 'online' with the optional message.", NULL
"", },
"Example: /online Up the Irons!", "Set your status to 'online'.",
NULL, {
NULL, NULL, NULL, NULL } } }, { "<message>", "Optional message to use with the status." },
END_ARGS },
{
"/online",
"/online Up the Irons!",
NULL } }
},
{ "/xa", { "/xa",
cmd_xa, parse_args_with_freetext, 0, 1, NULL, cmd_xa, parse_args_with_freetext, 0, 1, NULL,
{ "/xa [message]", "Set status to xa (extended away).", { NULL, NULL, { NULL },
{ "/xa [message]", {
"-------------", "/xa [<message>]",
"Set your status to 'xa', meaning 'extended away', with the optional message.", NULL
"", },
"Example: /xa This meeting is going to be a long one", "Set your status to 'xa' (extended away).",
NULL, {
NULL, NULL, NULL, NULL } } }, { "<message>", "Optional message to use with the status." },
END_ARGS },
{
"/xa",
"/xa This meeting is going to be a long one",
NULL } }
},
}; };
static Autocomplete commands_ac; static Autocomplete commands_ac;