Changed some command outputs for doc

3 files changed, 96 insertions, 87 deletions

diff --git a/src/common/command.c b/src/common/command.c
index 1eaa7f641..222e1154b 100644
--- a/src/common/command.c
+++ b/src/common/command.c
@@ -44,18 +44,21 @@
 t_weechat_command weechat_commands[] =
 { { "alias", N_("create an alias for a command"),
     N_("[alias_name [command [arguments]]"),
-    N_("alias_name: name of alias\ncommand: command name (WeeChat "
-    "or IRC command, without first '/')\n" "arguments: arguments for command"),
+    N_("alias_name: name of alias\n"
+       "   command: command name (WeeChat or IRC command, without "
+       "first '/')\n"
+        "arguments: arguments for command"),
     "%- %A", 0, MAX_ARGS, NULL, weechat_cmd_alias },
   { "buffer", N_("manage buffers"),
     N_("[action | number | [[server] [channel]]]"),
-    N_("action: action to do:\n"
-       "  move: move buffer in the list (may be relative, for example -1)\n"
+    N_(" action: action to do:\n"
+       "   move: move buffer in the list (may be relative, for example -1)\n"
        "  close: close buffer (for channel: same as /part without part message)\n"
-       "  list: list opened buffers (no parameter implies this list)\n"
-       "  notify: set notify level for buffer (0=never, 1=highlight, 2=1+msg, 3=2+join/part)\n"
-       "server,channel: jump to buffer by server and/or channel name\n"
-       "number: jump to buffer by number"),
+       "   list: list opened buffers (no parameter implies this list)\n"
+       " notify: set notify level for buffer (0=never, 1=highlight, 2=1+msg, 3=2+join/part)\n"
+       "server\n"
+       "channel: jump to buffer by server and/or channel name\n"
+       " number: jump to buffer by number"),
     "move|close|list|notify", 0, MAX_ARGS, weechat_cmd_buffer, NULL },
   { "charset", N_("change charset for server or channel"),
     N_("[(decode_iso | decode_utf | encode) charset]"),
@@ -78,7 +81,7 @@ t_weechat_command weechat_commands[] =
     "%S", 0, 1, weechat_cmd_disconnect, NULL },
   { "debug", N_("print debug messages"),
     N_("dump | windows"),
-    N_("dump: save memory dump in WeeChat log file (same dump is written when WeeChat crashes)\n"
+    N_("   dump: save memory dump in WeeChat log file (same dump is written when WeeChat crashes)\n"
        "windows: display windows tree"),
     "dump|windows", 1, 1, weechat_cmd_debug, NULL },
   { "help", N_("display help about commands"),
@@ -103,10 +106,12 @@ t_weechat_command weechat_commands[] =
     0, 4, weechat_cmd_ignore, NULL },
   { "key", N_("bind/unbind keys"),
     N_("[key function/command] [unbind key] [functions] [reset -yes]"),
-    N_("key: bind this key to an internal function or a command (beginning by \"/\")\n"
-       "unbind: unbind a key\n"
+    N_("      key: bind this key to an internal function or a command "
+       "(beginning by \"/\")\n"
+       "   unbind: unbind a key\n"
        "functions: list internal functions for key bindings\n"
-       "reset: restore bindings to the default values and delete ALL personal binding (use carefully!)"),
+       "    reset: restore bindings to the default values and delete ALL "
+       "personal bindings (use carefully!)"),
     "unbind|functions|reset %k", 0, MAX_ARGS, NULL, weechat_cmd_key },
   { "plugin", N_("list/load/unload plugins"),
     N_("[load filename] | [autoload] | [reload] | [unload]"),
@@ -120,16 +125,16 @@ t_weechat_command weechat_commands[] =
        "[-command command] [-autojoin channel[,channel]] ] | "
        "[del servername]"),
     N_("servername: server name, for internal & display use\n"
-       "hostname: name or IP address of server\n"
-       "port: port for server (integer)\n"
-       "ipv6: use IPv6 protocol\n"
-       "ssl: use SSL protocol\n"
-       "password: password for server\n"
-       "nick1: first nick for server\n"
-       "nick2: alternate nick for server\n"
-       "nick3: second alternate nick for server\n"
-       "username: user name\n"
-       "realname: real name of user"),
+       "  hostname: name or IP address of server\n"
+       "      port: port for server (integer)\n"
+       "      ipv6: use IPv6 protocol\n"
+       "       ssl: use SSL protocol\n"
+       "  password: password for server\n"
+       "     nick1: first nick for server\n"
+       "     nick2: alternate nick for server\n"
+       "     nick3: second alternate nick for server\n"
+       "  username: user name\n"
+       "  realname: real name of user"),
     NULL, 0, MAX_ARGS, weechat_cmd_server, NULL },
   { "save", N_("save config to disk"),
     N_("[file]"), N_("file: filename for writing config"),
@@ -164,18 +169,18 @@ t_weechat_command weechat_commands[] =
   { "window", N_("manage windows"),
     N_("[list | -1 | +1 | b# | up | down | left | right | splith [pct] "
        "| splitv [pct] | resize pct | merge [all]]"),
-    N_("list: list opened windows (no parameter implies this list)\n"
-       "-1: jump to previous window\n"
-       "+1: jump to next window\n"
-       "b#: jump to next window displaying buffer number #\n"
-       "up: switch to window above current one\n"
-       "down: switch to window below current one\n"
-       "left: switch to window on the left\n"
-       "right: switch to window on the right\n"
+    N_("  list: list opened windows (no parameter implies this list)\n"
+       "    -1: jump to previous window\n"
+       "    +1: jump to next window\n"
+       "    b#: jump to next window displaying buffer number #\n"
+       "    up: switch to window above current one\n"
+       "  down: switch to window below current one\n"
+       "  left: switch to window on the left\n"
+       " right: switch to window on the right\n"
        "splith: split current window horizontally\n"
        "splitv: split current window vertically\n"
-       "resize: resize window size, new size is <pct>%% of parent window\n"
-       "merge: merge window with another (all = keep only one window)\n\n"
+       "resize: resize window size, new size is pct%% of parent window\n"
+       " merge: merge window with another (all = keep only one window)\n\n"
        "For splith and splitv, pct is a pourcentage which represents "
        "size of new window, computed with current window as size reference. "
        "For example 25 means create a new window with size = current_size / 4"),
diff --git a/src/common/weechat.c b/src/common/weechat.c
index 27fb267f2..2ffcf9ac6 100644
--- a/src/common/weechat.c
+++ b/src/common/weechat.c
@@ -333,57 +333,59 @@ weechat_display_config_options ()
                 switch (weechat_options[i][j].option_type)
                 {
                     case OPTION_TYPE_BOOLEAN:
-                        printf (_("  . type boolean (values: 'on' or 'off')\n"));
+                        printf (_("  . type: boolean\n"));
+                        printf (_("  . values: 'on' or 'off'\n"));
                         printf (_("  . default value: '%s'\n"),
-                            (weechat_options[i][j].default_int == BOOL_TRUE) ?
-                            "on" : "off");
+                                (weechat_options[i][j].default_int == BOOL_TRUE) ?
+                                "on" : "off");
                         break;
                     case OPTION_TYPE_INT:
-                        printf (_("  . type integer (values: between %d and %d)\n"),
-                            weechat_options[i][j].min,
-                            weechat_options[i][j].max);
+                        printf (_("  . type: integer\n"));
+                        printf (_("  . values: between %d and %d\n"),
+                                weechat_options[i][j].min,
+                                weechat_options[i][j].max);
                         printf (_("  . default value: %d\n"),
-                            weechat_options[i][j].default_int);
+                                weechat_options[i][j].default_int);
                         break;
                     case OPTION_TYPE_INT_WITH_STRING:
-                        printf (_("  . type string (values: "));
+                        printf (_("  . type: string\n"));
+                        printf (_("  . values: "));
                         k = 0;
                         while (weechat_options[i][j].array_values[k])
                         {
                             printf ("'%s'",
-                                weechat_options[i][j].array_values[k]);
+                                    weechat_options[i][j].array_values[k]);
                             if (weechat_options[i][j].array_values[k + 1])
                                 printf (", ");
                             k++;
                         }
-                        printf (")\n");
+                        printf ("\n");
                         printf (_("  . default value: '%s'\n"),
-                            (weechat_options[i][j].default_string) ?
-                            weechat_options[i][j].default_string : _("empty"));
+                                (weechat_options[i][j].default_string) ?
+                                weechat_options[i][j].default_string : _("empty"));
                         break;
                     case OPTION_TYPE_COLOR:
-                        printf (_("  . type color (Curses or Gtk color, look at WeeChat doc)\n"));
+                        printf (_("  . type: color\n"));
+                        printf (_("  . values: Curses or Gtk color\n"));
                         printf (_("  . default value: '%s'\n"),
-                            (weechat_options[i][j].default_string) ?
-                            weechat_options[i][j].default_string : _("empty"));
+                                (weechat_options[i][j].default_string) ?
+                                weechat_options[i][j].default_string : _("empty"));
                         break;
                     case OPTION_TYPE_STRING:
-                        printf (_("  . type string (any string)\n"));
+                        printf (_("  . type: string\n"));
+                        printf (_("  . values: any string\n"));
                         printf (_("  . default value: '%s'\n"),
-                            (weechat_options[i][j].default_string) ?
-                            weechat_options[i][j].default_string : _("empty"));
+                                (weechat_options[i][j].default_string) ?
+                                weechat_options[i][j].default_string : _("empty"));
                         break;
                 }
                 printf (_("  . description: %s\n"),
-                    _(weechat_options[i][j].long_description));
+                        _(weechat_options[i][j].long_description));
                 printf ("\n");
                 j++;
             }
         }
     }
-    printf (_("Moreover, you can define aliases in [alias] section, by adding lines like:\n"));
-    printf ("j=join\n");
-    printf (_("where 'j' is alias name, and 'join' associated command.\n\n"));
 }
 
 /*
diff --git a/src/irc/irc-commands.c b/src/irc/irc-commands.c
index 413197a46..cddcbc6e0 100644
--- a/src/irc/irc-commands.c
+++ b/src/irc/irc-commands.c
@@ -45,25 +45,25 @@ t_irc_command irc_commands[] =
     "", 1, MAX_ARGS, 1, NULL, irc_cmd_send_amsg, NULL },
   { "away", N_("toggle away status"),
     N_("[-all] [message]"),
-    N_("-all: toggle away status on all connected servers\n"
+    N_("   -all: toggle away status on all connected servers\n"
        "message: message for away (if no message is given, away status is removed)"),
     "%y", 0, MAX_ARGS, 1, NULL, irc_cmd_send_away, NULL },
   { "ban", N_("bans nicks or hosts"),
     N_("[channel] [nickname [nickname ...]]"),
-    N_("channel: channel for ban\n"
+    N_(" channel: channel for ban\n"
        "nickname: user or host to ban"),
     "", 0, MAX_ARGS, 1, NULL, irc_cmd_send_ban, NULL },
   { "ctcp", N_("send a CTCP message (Client-To-Client Protocol)"),
     N_("nickname type [arguments]"),
-    N_("nickname: user to send CTCP to\n"
-       "type: CTCP type (examples: \"version\", \"ping\", ..)\n"
+    N_(" nickname: user to send CTCP to\n"
+       "     type: CTCP type (examples: \"version\", \"ping\", ..)\n"
        "arguments: arguments for CTCP"),
     "%n action|ping|version", 2, MAX_ARGS, 1, NULL, irc_cmd_send_ctcp, NULL },
   { "dcc", N_("starts DCC (file or chat) or close chat"),
     N_("action [nickname [file]]"),
-    N_("action: 'send' (file) or 'chat' or 'close' (chat)\n"
+    N_(  "action: 'send' (file) or 'chat' or 'close' (chat)\n"
        "nickname: nickname to send file or chat\n"
-       "file: filename (on local host)"),
+       "    file: filename (on local host)"),
     "chat|send|close %n %f", 1, MAX_ARGS, 1, NULL, irc_cmd_send_dcc, NULL },
   { "dehalfop", N_("removes half channel operator status from nickname(s)"),
     N_("[nickname [nickname]]"), "",
@@ -88,7 +88,7 @@ t_irc_command irc_commands[] =
   { "invite", N_("invite a nick on a channel"),
     N_("nickname channel"),
     N_("nickname: nick to invite\n"
-       "channel: channel to invite"),
+       " channel: channel to invite"),
     "%n %c", 1, 2, 1, irc_cmd_send_invite, NULL, irc_cmd_recv_invite },
   { "ison", N_("check if a nickname is currently on IRC"),
     N_("nickname [nickname ...]"),
@@ -97,28 +97,28 @@ t_irc_command irc_commands[] =
   { "join", N_("join a channel"),
     N_("channel[,channel] [key[,key]]"),
     N_("channel: channel name to join\n"
-       "key: key to join the channel"),
+       "    key: key to join the channel"),
     NULL, 1, MAX_ARGS, 1, NULL, irc_cmd_send_join, irc_cmd_recv_join },
   { "kick", N_("forcibly remove a user from a channel"),
     N_("[channel] nickname [comment]"),
-    N_("channel: channel where user is\n"
+    N_(" channel: channel where user is\n"
        "nickname: nickname to kick\n"
-       "comment: comment for kick"),
+       " comment: comment for kick"),
     "%n %-", 1, MAX_ARGS, 1, NULL, irc_cmd_send_kick, irc_cmd_recv_kick },
   { "kickban", N_("kicks and bans a nick from a channel"),
     N_("[channel] nickname [comment]"),
-    N_("channel: channel where user is\n"
+    N_(" channel: channel where user is\n"
        "nickname: nickname to kick and ban\n"
-       "comment: comment for kick"),
+       " comment: comment for kick"),
     "%n %-", 1, MAX_ARGS, 1, NULL, irc_cmd_send_kickban, NULL },
   { "kill", N_("close client-server connection"),
     N_("nickname comment"),
     N_("nickname: nickname\n"
-       "comment: comment for kill"),
+       " comment: comment for kill"),
     "%n %-", 2, MAX_ARGS, 1, NULL, irc_cmd_send_kill, irc_cmd_recv_kill },
   { "links", N_("list all servernames which are known by the server answering the query"),
     N_("[[server] server_mask]"),
-    N_("server: this server should answer the query\n"
+    N_("     server: this server should answer the query\n"
        "server_mask: list of servers must match this mask"),
     NULL, 0, 2, 1, NULL, irc_cmd_send_links, NULL },
   { "list", N_("list channels and their topic"),
@@ -127,7 +127,7 @@ t_irc_command irc_commands[] =
     NULL, 0, MAX_ARGS, 1, NULL, irc_cmd_send_list, NULL },
   { "lusers", N_("get statistics about the size of the IRC network"),
     N_("[mask [target]]"),
-    N_("mask: servers matching the mask only\n"
+    N_("  mask: servers matching the mask only\n"
        "target: server for forwarding request"),
     NULL, 0, 2, 1, NULL, irc_cmd_send_lusers, NULL },
   { "me", N_("send a CTCP action to the current channel"),
@@ -173,12 +173,13 @@ t_irc_command irc_commands[] =
     NULL, 0, 1, 1, NULL, irc_cmd_send_names, NULL },
   { "nick", N_("change current nickname"),
     N_("[-all] nickname"),
-    N_("-all: set new nickname for all connected servers\n"
+    N_("    -all: set new nickname for all connected servers\n"
        "nickname: new nickname"),
     NULL, 1, 2, 0, irc_cmd_send_nick, NULL, irc_cmd_recv_nick },
   { "notice", N_("send notice message to user"),
     N_("nickname text"),
-    N_("nickname: user to send notice to\ntext: text to send"),
+    N_("nickname: user to send notice to\n"
+       "    text: text to send"),
     "%n %-", 2, MAX_ARGS, 1, NULL, irc_cmd_send_notice, irc_cmd_recv_notice },
   { "op", N_("gives channel operator status to nickname(s)"),
     N_("nickname [nickname]"), "",
@@ -189,7 +190,7 @@ t_irc_command irc_commands[] =
     NULL, 2, 2, 1, NULL, irc_cmd_send_oper, NULL },
   { "part", N_("leave a channel"),
     N_("[channel[,channel]] [part_message]"),
-    N_("channel: channel name to leave\n"
+    N_("     channel: channel name to leave\n"
        "part_message: part message (displayed to other users)"),
     "%p", 0, MAX_ARGS, 1, NULL, irc_cmd_send_part, irc_cmd_recv_part },
   { "ping", N_("ping server"),
@@ -198,7 +199,7 @@ t_irc_command irc_commands[] =
     NULL, 1, 2, 1, NULL, irc_cmd_send_ping, irc_cmd_recv_ping },
   { "pong", N_("answer to a ping message"),
     N_("daemon [daemon2]"),
-    N_("daemon: daemon who has responded to Ping message\n"
+    N_(" daemon: daemon who has responded to Ping message\n"
        "daemon2: forward message to this daemon"),
     NULL, 1, 2, 1, NULL, irc_cmd_send_pong, irc_cmd_recv_pong },
   { "privmsg", N_("message received"), "", "",
@@ -206,7 +207,7 @@ t_irc_command irc_commands[] =
   { "query", N_("send a private message to a nick"),
     N_("nickname [text]"),
     N_("nickname: nickname for private conversation\n"
-       "text: text to send"),
+       "    text: text to send"),
     "%n %-", 1, MAX_ARGS, 1, NULL, irc_cmd_send_query, NULL },
   { "quit", N_("close all connections & quit"),
     N_("[quit_message]"),
@@ -223,7 +224,7 @@ t_irc_command irc_commands[] =
   { "service", N_("register a new service"),
     N_("nickname reserved distribution type reserved info"),
     N_("distribution: visibility of service\n"
-       "type: reserved for future usage"),
+       "        type: reserved for future usage"),
     NULL, 6, 6, 1, NULL, irc_cmd_send_service, NULL },
   { "servlist", N_("list services currently connected to the network"),
     N_("[mask [type]]"),
@@ -236,17 +237,18 @@ t_irc_command irc_commands[] =
     NULL, 2, 2, 1, NULL, irc_cmd_send_squery, NULL },
   { "squit", N_("disconnect server links"),
     N_("server comment"),
-    N_("server: server name\ncomment: comment for quit"),
+    N_( "server: server name\n"
+       "comment: comment for quit"),
     NULL, 2, 2, 1, NULL, irc_cmd_send_squit, NULL },
   { "stats", N_("query statistics about server"),
     N_("[query [server]]"),
-    N_("query: c/h/i/k/l/m/o/y/u (see RFC1459)\n"
+    N_(" query: c/h/i/k/l/m/o/y/u (see RFC1459)\n"
        "server: server name"),
     NULL, 0, 2, 1, NULL, irc_cmd_send_stats, NULL },
   { "summon", N_("give users who are on a host running an IRC server a message "
     "asking them to please join IRC"),
     N_("user [target [channel]]"),
-    N_("user: username\ntarget: server name\n"
+    N_("   user: username\ntarget: server name\n"
        "channel: channel name"),
     NULL, 1, 3, 1, NULL, irc_cmd_send_summon, NULL },
   { "time", N_("query local time from server"),
@@ -264,9 +266,9 @@ t_irc_command irc_commands[] =
     NULL, 0, 1, 1, NULL, irc_cmd_send_trace, NULL },
   { "unban", N_("unbans nicks or hosts"),
     N_("[channel] nickname [nickname ...]"),
-    N_("channel: channel for unban\n"
+    N_(" channel: channel for unban\n"
        "nickname: user or host to unban"),
-    "%n", 1, MAX_ARGS, 1, NULL, irc_cmd_send_unban, NULL },
+    "", 1, MAX_ARGS, 1, NULL, irc_cmd_send_unban, NULL },
   { "userhost", N_("return a list of information about nicknames"),
     N_("nickname [nickname ...]"),
     N_("nickname: nickname"),
@@ -277,7 +279,7 @@ t_irc_command irc_commands[] =
     NULL, 0, 1, 1, NULL, irc_cmd_send_users, NULL },
   { "version", N_("gives the version info of nick or server (current or specified)"),
     N_("[server | nickname]"),
-    N_("server: server name\n"
+    N_("  server: server name\n"
        "nickname: nickname"),
     NULL, 0, 1, 1, NULL, irc_cmd_send_version, NULL },
   { "voice", N_("gives voice to nickname(s)"),
@@ -291,18 +293,18 @@ t_irc_command irc_commands[] =
   { "who", N_("generate a query which returns a list of information"),
     N_("[mask [\"o\"]]"),
     N_("mask: only information which match this mask\n"
-       "o: only operators are returned according to the mask supplied"),
+       "   o: only operators are returned according to the mask supplied"),
     "%C", 0, 2, 1, NULL, irc_cmd_send_who, NULL },
   { "whois", N_("query information about user(s)"),
     N_("[server] nickname[,nickname]"),
-    N_("server: server name\n"
+    N_("  server: server name\n"
        "nickname: nickname (may be a mask)"),
     "", 1, MAX_ARGS, 1, NULL, irc_cmd_send_whois, NULL },
   { "whowas", N_("ask for information about a nickname which no longer exists"),
     N_("nickname [,nickname [,nickname ...]] [count [target]]"),
     N_("nickname: nickname to search\n"
-       "count: number of replies to return (full search if negative number)\n"
-       "target: reply should match this mask"),
+       "   count: number of replies to return (full search if negative number)\n"
+       "  target: reply should match this mask"),
     "", 1, MAX_ARGS, 1, NULL, irc_cmd_send_whowas, NULL },
   { "001", N_("a server message"), "", "",
     NULL, 0, 0, 1, NULL, NULL, irc_cmd_recv_server_msg },
@@ -411,7 +413,7 @@ t_irc_command irc_commands[] =
   { "332", N_("topic of channel"),
     N_("channel :topic"),
     N_("channel: name of channel\n"
-       "topic: topic of the channel"),
+       "  topic: topic of the channel"),
     NULL, 2, MAX_ARGS, 1, NULL, NULL, irc_cmd_recv_332 },
   { "333", N_("infos about topic (nick & date changed)"), "", "",
     NULL, 0, 0, 1, NULL, NULL, irc_cmd_recv_333 },
@@ -432,7 +434,7 @@ t_irc_command irc_commands[] =
   { "353", N_("list of nicks on channel"),
     N_("channel :[[@|+]nick ...]"),
     N_("channel: name of channel\n"
-       "nick: nick on the channel"),
+       "   nick: nick on the channel"),
     NULL, 2, MAX_ARGS, 1, NULL, NULL, irc_cmd_recv_353 },
   { "364", N_("links"), "", "",
     NULL, 0, 0, 1, NULL, NULL, irc_cmd_recv_server_msg },