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

Tidied help

Browse Source
This commit is contained in:
James Booth 2013-06-30 22:59:06 +01:00
parent c970bb2790
commit e933572ab9
1 changed files with 31 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

64
src/command/command.c
View File

@ -163,7 +163,7 @@ static struct cmd_t command_defs[] =
"Example : /help presence", "Example : /help presence",
"Example : /help who", "Example : /help who",
"", "",
"For more details help, see the user guide at http://www.profanity.im/userguide.html.", "For more detailed help, see the user guide at http://www.profanity.im/userguide.html.",
NULL } } }, NULL } } },
{ "/about", { "/about",
@ -197,11 +197,11 @@ static struct cmd_t command_defs[] =
{ "/msg", { "/msg",
_cmd_msg, parse_args_with_freetext, 1, 2, NULL, _cmd_msg, parse_args_with_freetext, 1, 2, NULL,
{ "/msg jid|nick [message]", "Start chat with user.", { "/msg contact|nick [message]", "Start chat with user.",
{ "/msg jid|nick [message]", { "/msg contact|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 for the contact 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 a nickname to start private chat with a room member.",
"Use quotes if the nickname includes spaces.", "Use quotes if the nickname includes spaces.",
"", "",
"Example : /msg myfriend@server.com Hey, here's a message!", "Example : /msg myfriend@server.com Hey, here's a message!",
@ -232,32 +232,32 @@ static struct cmd_t command_defs[] =
{ "/group", { "/group",
_cmd_group, parse_args_with_freetext, 0, 3, NULL, _cmd_group, parse_args_with_freetext, 0, 3, NULL,
{ "/group show|add|remove [group] [contact]", "Manage roster groups.", { "/group [show|add|remove] [group] [contact]", "Manage roster groups.",
{ "/group show|add|remove [group] [contact]", { "/group [show|add|remove] [group] [contact]",
"-------------------------------------", "------------------------------------------",
"View, add to, and remove from roster groups.", "View, add to, and remove from roster groups.",
"Passing no argument will list all roster groups.", "Passing no argument will list all roster groups.",
"The 'show' command takes 'group' as an argument, and lists all roster items in that group.", "The 'show' command takes 'group' as an argument, and lists all roster items in that group.",
"The 'add' command takes 'group' and 'contact' arguments, and add the contact to the group.", "The 'add' command takes 'group' and 'contact' arguments, and adds the contact to the group.",
"The 'remove' command takes 'group' and 'contact' arguments and removed the contact from the group,", "The 'remove' command takes 'group' and 'contact' arguments and removes the contact from the group,",
"", "",
"Example : /group", "Example : /group",
"Example : /group show friends", "Example : /group show friends",
"Example : /group add friends newfriend@server.org", "Example : /group add friends newfriend@server.org",
"Example : /group add family brother (using contacts nickname)", "Example : /group add family Brother (using contacts nickname)",
"Example : /group remove colleagues boss@work.com", "Example : /group remove colleagues boss@work.com",
NULL } } }, NULL } } },
{ "/info", { "/info",
_cmd_info, parse_args, 0, 1, NULL, _cmd_info, parse_args, 0, 1, NULL,
{ "/info [jid|nick]", "Show basic information about a contact, or room member.", { "/info [contact|nick]", "Show basic information about a contact, or room member.",
{ "/info [jid|nick]", { "/info [contact|nick]",
"----------------", "--------------------",
"Show information including current subscription status and summary information for each connected resource.", "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 mybuddy@chat.server.org",
"Example : /info kai (room member)", "Example : /info kai",
NULL } } }, NULL } } },
{ "/caps", { "/caps",
@ -284,7 +284,7 @@ static struct cmd_t command_defs[] =
"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.", "If the contact's 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/laptop (contact's laptop resource)",
"Example : /software mybuddy@chat.server.org/phone (contact's phone resource)", "Example : /software mybuddy@chat.server.org/phone (contact's phone resource)",
@ -293,14 +293,14 @@ static struct cmd_t command_defs[] =
{ "/status", { "/status",
_cmd_status, parse_args, 0, 1, NULL, _cmd_status, parse_args, 0, 1, NULL,
{ "/status [jid|nick]", "Find out your contacts presence information.", { "/status [contact|nick]", "Find out a contacts presence information.",
{ "/status [jid|nick]", { "/status [contact|nick]",
"------------------", "----------------------",
"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 buddy@server.com",
"Example : /status jon (room member)", "Example : /status jon",
NULL } } }, NULL } } },
{ "/join", { "/join",
@ -311,7 +311,7 @@ static struct cmd_t command_defs[] =
"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 'localpart' of your JID (before the @) will be used.", "Otherwise the 'localpart' of your JID (before the @) will be used.",
"If no server is supplied, it will default to 'conference.<domain-part>'", "If no server is supplied, a default of 'conference.<domain-part>' 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",
@ -329,11 +329,10 @@ static struct cmd_t command_defs[] =
{ "/invite", { "/invite",
_cmd_invite, parse_args_with_freetext, 1, 2, NULL, _cmd_invite, parse_args_with_freetext, 1, 2, NULL,
{ "/invite jid [message]", "Invite contact to chat room.", { "/invite contact [message]", "Invite contact to chat room.",
{ "/invite jid [message]", { "/invite contact [message]",
"--------------------------", "-------------------------",
"Send a direct invite to the specified contact to the current chat room.", "Send a direct invite to the specified contact to the current chat room.",
"The jid must be a contact in your roster.",
"If a message is supplied it will be send as the reason for the invite.", "If a message is supplied it will be send as the reason for the invite.",
NULL } } }, NULL } } },
@ -404,7 +403,7 @@ static struct cmd_t command_defs[] =
{ "/wins [tidy|prune]", { "/wins [tidy|prune]",
"------------------", "------------------",
"Passing no argument will list all currently active windows and information about their usage.", "Passing no argument will list all currently active windows and information about their usage.",
"tidy : Shuffle windows so there are no gaps between used windows.", "tidy : Shuffle windows so there are no gaps.",
"prune : Close all windows with no unread messages, and then tidy as above.", "prune : Close all windows with no unread messages, and then tidy as above.",
NULL } } }, NULL } } },
@ -438,7 +437,7 @@ static struct cmd_t command_defs[] =
"---------", "---------",
"Send the url as a tiny url.", "Send the url as a tiny url.",
"", "",
"Example : /tiny http://www.google.com", "Example : /tiny http://www.profanity.im",
NULL } } }, NULL } } },
{ "/duck", { "/duck",
@ -522,7 +521,6 @@ static struct cmd_t command_defs[] =
" : on|off", " : on|off",
"invite : Notifications for chat room invites.", "invite : Notifications for chat room invites.",
" : on|off", " : on|off",
"",
"sub : Notifications for subscription requests.", "sub : Notifications for subscription requests.",
" : on|off", " : on|off",
"", "",
@ -644,7 +642,7 @@ static struct cmd_t command_defs[] =
{ "/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 will automatically be enabled when this setting in on.", "Switch chat history on or off, /chlog will automatically be enabled when this setting is 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 } } },
@ -663,7 +661,7 @@ static struct cmd_t command_defs[] =
{ "/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 off reconnect attempts.",
NULL } } }, NULL } } },
{ "/autoping", { "/autoping",