Convert all docs to asciidoc format, add scripting guide

4 files changed, 19 insertions, 17 deletions

diff --git a/src/core/wee-config.c b/src/core/wee-config.c
index 3e6996d96..a72727b85 100644
--- a/src/core/wee-config.c
+++ b/src/core/wee-config.c
@@ -1945,8 +1945,8 @@ config_weechat_init_options ()
     config_plugin_path = config_file_new_option (
         weechat_config_file, ptr_section,
         "path", "string",
-        N_("path for searching plugins ('%h' will be replaced by "
-           "WeeChat home, ~/.weechat by default)"),
+        N_("path for searching plugins (\"%h\" will be replaced by "
+           "WeeChat home, \"~/.weechat\" by default)"),
         NULL, 0, 0, "%h/plugins", NULL, 0, NULL, NULL, NULL, NULL, NULL, NULL);
     config_plugin_save_config_on_unload = config_file_new_option (
         weechat_config_file, ptr_section,
diff --git a/src/plugins/irc/irc-config.c b/src/plugins/irc/irc-config.c
index ad4859643..7955b319e 100644
--- a/src/plugins/irc/irc-config.c
+++ b/src/plugins/irc/irc-config.c
@@ -754,9 +754,10 @@ irc_config_server_new_option (struct t_config_file *config_file,
             new_option = weechat_config_new_option (
                 config_file, section,
                 option_name, "string",
-                N_("command(s) to run when connected to server (many commands should "
-                   "be separated by ';', use '\\;' for a semicolon, special variables "
-                   "$nick, $channel and $server are replaced by their value)"),
+                N_("command(s) to run when connected to server (many commands "
+                   "should be separated by \";\", use \"\\;\" for a semicolon, "
+                   "special variables $nick, $channel and $server are replaced "
+                   "by their value)"),
                 NULL, 0, 0,
                 default_value, value,
                 null_value_allowed,
@@ -1182,13 +1183,13 @@ irc_config_init ()
     irc_config_network_default_msg_part = weechat_config_new_option (
         irc_config_file, ptr_section,
         "default_msg_part", "string",
-        N_("default part message (leaving channel) ('%v' will be replaced by "
-           "WeeChat version in string)"),
+        N_("default part message (leaving channel) (\"%v\" will be replaced "
+           "by WeeChat version in string)"),
         NULL, 0, 0, "WeeChat %v", NULL, 0, NULL, NULL, NULL, NULL, NULL, NULL);
     irc_config_network_default_msg_quit = weechat_config_new_option (
         irc_config_file, ptr_section,
         "default_msg_quit", "string",
-        N_("default quit message (disconnecting from server) ('%v' will be "
+        N_("default quit message (disconnecting from server) (\"%v\" will be "
            "replaced by WeeChat version in string)"),
         NULL, 0, 0, "WeeChat %v", NULL, 0, NULL, NULL, NULL, NULL, NULL, NULL);
     irc_config_network_away_check = weechat_config_new_option (
@@ -1236,9 +1237,9 @@ irc_config_init ()
     irc_config_network_colors_send = weechat_config_new_option (
         irc_config_file, ptr_section,
         "colors_send", "boolean",
-        N_("allow user to send colors with special codes (^Cb=bold, "
-           "^Ccxx=color, ^Ccxx,yy=color+background, ^Cu=underline, "
-           "^Cr=reverse)"),
+        N_("allow user to send colors with special codes (ctrl-c + a code and "
+           "optional color: b=bold, cxx=color, cxx,yy=color+background, "
+           "u=underline, r=reverse)"),
         NULL, 0, 0, "on", NULL, 0, NULL, NULL, NULL, NULL, NULL, NULL);
     irc_config_network_send_unknown_commands = weechat_config_new_option (
         irc_config_file, ptr_section,
diff --git a/src/plugins/logger/logger-config.c b/src/plugins/logger/logger-config.c
index 3a2f72e54..102921acd 100644
--- a/src/plugins/logger/logger-config.c
+++ b/src/plugins/logger/logger-config.c
@@ -368,16 +368,17 @@ logger_config_init ()
     logger_config_file_path = weechat_config_new_option (
         logger_config_file, ptr_section,
         "path", "string",
-        N_("path for WeeChat log files ('%h' will be replaced by WeeChat "
-           "home, ~/.weechat by default)"),
+        N_("path for WeeChat log files (\"%h\" will be replaced by WeeChat "
+           "home, \"~/.weechat\" by default)"),
         NULL, 0, 0, "%h/logs/", NULL, 0, NULL, NULL,
         &logger_config_change_file_option_restart_log, NULL, NULL, NULL);
     logger_config_file_mask = weechat_config_new_option (
         logger_config_file, ptr_section,
         "mask", "string",
-        N_("default file name mask for log files (format is 'directory/to/file' "
-           "or 'file', without first '/' because 'path' option is used to "
-           "build complete path to file); local buffer variables are permitted"),
+        N_("default file name mask for log files (format is "
+           "\"directory/to/file\" or \"file\", without first \"/\" because "
+           "\"path\" option is used to build complete path to file); local "
+           "buffer variables are permitted"),
         NULL, 0, 0, "$plugin.$name.weechatlog", NULL, 0, NULL, NULL,
         &logger_config_change_file_option_restart_log, NULL, NULL, NULL);
     logger_config_file_info_lines = weechat_config_new_option (
diff --git a/src/plugins/xfer/xfer-config.c b/src/plugins/xfer/xfer-config.c
index f3288307f..346cebe8e 100644
--- a/src/plugins/xfer/xfer-config.c
+++ b/src/plugins/xfer/xfer-config.c
@@ -280,7 +280,7 @@ xfer_config_init ()
     xfer_config_file_auto_rename = weechat_config_new_option (
         xfer_config_file, ptr_section,
         "auto_rename", "boolean",
-        N_("rename incoming files if already exists (add '.1', '.2', ...)"),
+        N_("rename incoming files if already exists (add \".1\", \".2\", ...)"),
         NULL, 0, 0, "on", NULL, 0, NULL, NULL, NULL, NULL, NULL, NULL);
     xfer_config_file_auto_resume = weechat_config_new_option (
         xfer_config_file, ptr_section,