aniani/profanity
1
0
Fork 0
mirror of https://github.com/profanity-im/profanity.git synced 2024-11-03 19:37:16 -05:00
Code

Updated online help

Browse Source
This commit is contained in:
James Booth 2013-03-10 19:17:24 +00:00
parent c8088bea41
commit 177168a20f
1 changed files with 51 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

82
src/command/command.c
View File

@ -153,6 +153,8 @@ static struct cmd_t main_commands[] =
"Example : /help list", "Example : /help list",
"Example : /help connect", "Example : /help connect",
"Example : /help settings", "Example : /help settings",
"",
"For more details help, see the user guide at http://www.profanity.im/userguide.html.",
NULL } } }, NULL } } },
{ "/about", { "/about",
@ -169,7 +171,7 @@ static struct cmd_t main_commands[] =
{ "/connect account [server]", { "/connect account [server]",
"-------------------------", "-------------------------",
"Connect to an XMPP service using the specified account.", "Connect to an XMPP service using the specified account.",
"Use the server argument for chat services hosted at a different domain to the 'domain' part of the Jabber ID.", "Use the server argument for chat services hosted at a different domain to the 'domainpart' of the Jabber ID.",
"An account is automatically created if one does not exist. See the /account command for more details.", "An account is automatically created if one does not exist. See the /account command for more details.",
"", "",
"Example: /connect myuser@gmail.com", "Example: /connect myuser@gmail.com",
@ -180,28 +182,28 @@ static struct cmd_t main_commands[] =
_cmd_disconnect, parse_args, 0, 0, _cmd_disconnect, parse_args, 0, 0,
{ "/disconnect", "Logout of current session.", { "/disconnect", "Logout of current session.",
{ "/disconnect", { "/disconnect",
"------------------", "-----------",
"Disconnect from the current session session.", "Disconnect from the current chat service.",
NULL } } }, NULL } } },
{ "/account", { "/account",
_cmd_account, parse_args, 0, 4, _cmd_account, parse_args, 0, 4,
{ "/account [command] [account] [property] [value]", "Manage accounts.", { "/account [command] [account] [property] [value]", "Manage accounts.",
{ "/account [command] [account] [property] [value]", { "/account [command] [account] [property] [value]",
"---------------------------------------------", "-----------------------------------------------",
"Commands for creating and managing accounts.", "Commands for creating and managing accounts.",
"list : List all accounts.", "list : List all accounts.",
"show account : Show information about an account.", "show account : Show information about an account.",
"enable account : Enable the account, so it is used for autocomplete.", "enable account : Enable the account, it will be used for autocomplete.",
"disable account : Disable the account.", "disable account : Disable the account.",
"add account : Create a new account.", "add account : Create a new account.",
"rename account newname : Rename account to newname.", "rename account newname : Rename account to newname.",
"set account property value : Set 'property' of 'account' to 'value'.", "set account property value : Set 'property' of 'account' to 'value'.",
"", "",
"When connected, the /account command can be called with no arguments, to info about the current account.", "When connected, the /account command can be called with no arguments, to show current account settings.",
"The 'property' may be one of.", "The 'property' may be one of.",
"jid : The Jabber ID of the account, the account name will be used if this property is not set.", "jid : The Jabber ID of the account, the account name will be used if this property is not set.",
"server : The chat service server, if different to the domain part of the JID.", "server : The chat server, if different to the domainpart of the JID.",
"status : The presence status to use on login, use 'last' to use whatever your last status was.", "status : The presence status to use on login, use 'last' to use whatever your last status was.",
"online|chat|away", "online|chat|away",
"|xa|dnd : Priority for the specified presence.", "|xa|dnd : Priority for the specified presence.",
@ -212,8 +214,8 @@ static struct cmd_t main_commands[] =
" : /account set work server talk.google.com", " : /account set work server talk.google.com",
" : /account set work resource desktop", " : /account set work resource desktop",
" : /account set work status dnd", " : /account set work status dnd",
" : /account set dnd -1", " : /account set work dnd -1",
" : /account set online 10", " : /account set work online 10",
" : /account rename work gtalk", " : /account rename work gtalk",
NULL } } }, NULL } } },
@ -253,7 +255,7 @@ static struct cmd_t main_commands[] =
{ "/msg jid|nick [message]", "Start chat with user.", { "/msg jid|nick [message]", "Start chat with user.",
{ "/msg jid|nick [message]", { "/msg jid|nick [message]",
"-----------------------", "-----------------------",
"Open a chat window with for the user JID (Jabber ID) and send the message if one is supplied.", "Open a chat window with for the user JID (Jabber ID) and send the message if one is supplied.",
"When in a chat room, supply the nickname to start private chat with the room member.", "When in a chat room, supply the nickname to start private chat with the room member.",
"Use quotes if the nickname includes spaces.", "Use quotes if the nickname includes spaces.",
"", "",
@ -265,11 +267,14 @@ static struct cmd_t main_commands[] =
{ "/info", { "/info",
_cmd_info, parse_args, 0, 1, _cmd_info, parse_args, 0, 1,
{ "/info [jid|nick]", "Find out a contacts presence information.", { "/info [jid|nick]", "Show basic information about a contact, or room member.",
{ "/info [jid|nick]", { "/info [jid|nick]",
"----------------", "----------------",
"Find out a contact, or room members presence information, including all of their available resources.", "Show information including current subscription status and summary information for each connected resource.",
"If in a chat window the parameter is not required, the current recipient will be used.", "If in a chat window the parameter is not required, the current recipient will be used.",
"",
"Example : /info mybuddy@chat.server.org (contact)",
"Example : /info kai (room member)",
NULL } } }, NULL } } },
{ "/caps", { "/caps",
@ -281,17 +286,26 @@ static struct cmd_t main_commands[] =
"If in the console window or a regular chat window, a full JID is required.", "If in the console window or a regular chat window, a full JID is required.",
"If in a chat room, the nickname is required.", "If in a chat room, the nickname is required.",
"If in private chat, no parameter is required.", "If in private chat, no parameter is required.",
"",
"Example : /caps mybuddy@chat.server.org/laptop (contact's laptop resource)",
"Example : /caps mybuddy@chat.server.org/phone (contact's phone resource)",
"Example : /caps bruce (room member)",
NULL } } }, NULL } } },
{ "/software", { "/software",
_cmd_software, parse_args, 0, 1, _cmd_software, parse_args, 0, 1,
{ "/software [fulljid|nick]", "Find out a software version information about a contacts resource.", { "/software [fulljid|nick]", "Find out software version information about a contacts resource.",
{ "/software [fulljid|nick]", { "/software [fulljid|nick]",
"------------------------", "------------------------",
"Find out a contact, or room members software version information.", "Find out a contact, or room members software version information, if such requests are supported.",
"If in the console window or a regular chat window, a full JID is required.", "If in the console window or a regular chat window, a full JID is required.",
"If in a chat room, the nickname is required.", "If in a chat room, the nickname is required.",
"If in private chat, no parameter is required.", "If in private chat, no parameter is required.",
"If the contacts software does not support software version requests, nothing will be displayed.",
"",
"Example : /software mybuddy@chat.server.org/laptop (contact's laptop resource)",
"Example : /software mybuddy@chat.server.org/phone (contact's phone resource)",
"Example : /software bruce (room member)",
NULL } } }, NULL } } },
{ "/status", { "/status",
@ -301,6 +315,9 @@ static struct cmd_t main_commands[] =
"------------------", "------------------",
"Find out a contact, or room members presence information.", "Find out a contact, or room members presence information.",
"If in a chat window the parameter is not required, the current recipient will be used.", "If in a chat window the parameter is not required, the current recipient will be used.",
"",
"Example : /status buddy@server.com (contact)",
"Example : /status jon (room member)",
NULL } } }, NULL } } },
{ "/join", { "/join",
@ -310,7 +327,7 @@ static struct cmd_t main_commands[] =
"-----------------", "-----------------",
"Join a chat room at the conference server.", "Join a chat room at the conference server.",
"If nick is specified you will join with this nickname.", "If nick is specified you will join with this nickname.",
"Otherwise the first part of your JID (before the @) will be used.", "Otherwise the 'localpart' of your JID (before the @) will be used.",
"If the room doesn't exist, and the server allows it, a new one will be created.", "If the room doesn't exist, and the server allows it, a new one will be created.",
"", "",
"Example : /join jdev@conference.jabber.org", "Example : /join jdev@conference.jabber.org",
@ -463,10 +480,10 @@ static struct cmd_t setting_commands[] =
{ "/splash", { "/splash",
_cmd_set_splash, parse_args, 1, 1, _cmd_set_splash, parse_args, 1, 1,
{ "/splash on|off", "Splash logo on startup.", { "/splash on|off", "Splash logo on startup and /about command.",
{ "/splash on|off", { "/splash on|off",
"--------------", "--------------",
"Switch on or off the ascii logo on start up.", "Switch on or off the ascii logo on start up and when the /about command is called.",
NULL } } }, NULL } } },
{ "/vercheck", { "/vercheck",
@ -484,7 +501,7 @@ static struct cmd_t setting_commands[] =
{ "/titlebar property on|off", { "/titlebar property on|off",
"-------------------------", "-------------------------",
"Show various properties in the window title bar.", "Show various properties in the window title bar.",
"Possible properties are 'version'.", "Currently The only supported property is 'version'.",
NULL } } }, NULL } } },
{ "/mouse", { "/mouse",
@ -492,7 +509,7 @@ static struct cmd_t setting_commands[] =
{ "/mouse on|off", "Use profanity mouse handling.", { "/mouse on|off", "Use profanity mouse handling.",
{ "/mouse on|off", { "/mouse on|off",
"-------------", "-------------",
"If set to 'on', profanity will handle mouse actions, which enabled scrolling the main window with the mouse wheel.", "If set to 'on', profanity will handle mouse actions, which enables scrolling the main window with the mouse wheel.",
"To select text, use the shift key while selcting an area.", "To select text, use the shift key while selcting an area.",
"If set to 'off', profanity leaves mouse handling to the terminal implementation.", "If set to 'off', profanity leaves mouse handling to the terminal implementation.",
"The default is 'on', if you have strange behaviour with mouse actions, set to 'off'.", "The default is 'on', if you have strange behaviour with mouse actions, set to 'off'.",
@ -504,6 +521,8 @@ static struct cmd_t setting_commands[] =
{ "/chlog on|off", { "/chlog on|off",
"-------------", "-------------",
"Switch chat logging on or off.", "Switch chat logging on or off.",
"This setting will be enabled if /history is set to on.",
"When disabling this option, /history will also be disabled.",
NULL } } }, NULL } } },
{ "/states", { "/states",
@ -512,27 +531,27 @@ static struct cmd_t setting_commands[] =
{ "/states on|off", { "/states on|off",
"--------------", "--------------",
"Sending of chat state notifications during chat sessions.", "Sending of chat state notifications during chat sessions.",
"Such as whether you have become inactive, or have close the chat window.", "Such as whether you have become inactive, or have closed the chat window.",
NULL } } }, NULL } } },
{ "/outtype", { "/outtype",
_cmd_set_outtype, parse_args, 1, 1, _cmd_set_outtype, parse_args, 1, 1,
{ "/outtype on|off", "Send typing notification to recipient.", { "/outtype on|off", "Send typing notification to recipient.",
{ "/outtype on|off", { "/outtype on|off",
"--------------", "---------------",
"Send an indication that you are typing to the other person in chat.", "Send an indication that you are typing to the chat recipient.",
"Chat states must be enabled for this to work, see the /states command.", "Chat states (/states) will be enabled if this setting is set.",
NULL } } }, NULL } } },
{ "/gone", { "/gone",
_cmd_set_gone, parse_args, 1, 1, _cmd_set_gone, parse_args, 1, 1,
{ "/gone minutes", "Send 'gone' state to recipient after a period.", { "/gone minutes", "Send 'gone' state to recipient after a period.",
{ "/gone minutes", { "/gone minutes",
"--------------", "-------------",
"Send a 'gone' state to the recipient after the specified number of minutes." "Send a 'gone' state to the recipient after the specified number of minutes."
"This indicates to the recipient's client that you have left the conversation.", "This indicates to the recipient's client that you have left the conversation.",
"A value of 0 will disable sending this chat state automatically after a period.", "A value of 0 will disable sending this chat state.",
"Chat states must be enabled for this to work, see the /states command.", "Chat states (/states) will be enabled if this setting is set.",
NULL } } }, NULL } } },
{ "/history", { "/history",
@ -540,7 +559,7 @@ static struct cmd_t setting_commands[] =
{ "/history on|off", "Chat history in message windows.", { "/history on|off", "Chat history in message windows.",
{ "/history on|off", { "/history on|off",
"---------------", "---------------",
"Switch chat history on or off, requires /chlog to be enabled.", "Switch chat history on or off, requires /chlog will automatically be enabled when this setting in on.",
"When history is enabled, previous messages are shown in chat windows.", "When history is enabled, previous messages are shown in chat windows.",
NULL } } }, NULL } } },
@ -557,7 +576,7 @@ static struct cmd_t setting_commands[] =
_cmd_set_reconnect, parse_args, 1, 1, _cmd_set_reconnect, parse_args, 1, 1,
{ "/reconnect seconds", "Set reconnect interval.", { "/reconnect seconds", "Set reconnect interval.",
{ "/reconnect seconds", { "/reconnect seconds",
"--------------------", "------------------",
"Set the reconnect attempt interval in seconds for when the connection is lost.", "Set the reconnect attempt interval in seconds for when the connection is lost.",
"A value of 0 will switch of reconnect attempts.", "A value of 0 will switch of reconnect attempts.",
NULL } } }, NULL } } },
@ -606,9 +625,10 @@ static struct cmd_t setting_commands[] =
_cmd_set_statuses, parse_args, 1, 1, _cmd_set_statuses, parse_args, 1, 1,
{ "/statuses on|off", "Set notifications for status messages.", { "/statuses on|off", "Set notifications for status messages.",
{ "/statuses on|off", { "/statuses on|off",
"---------------", "----------------",
"Set notifications for status messages, such as online/offline or join/part channels.", "Show status updates from contacts, such as online/offline/away etc.",
"When notifications are off status messages, such as online/offline or join/part, are not displayed.", "When disabled, status updates are not displayed.",
"The default is 'on'.",
NULL } } } NULL } } }
}; };