doc: fix URLs to WeeChat docs

2026-06-12 14:14:48 +02:00 · 2023-06-05 19:08:12 +02:00
parent ab9b8e0b01
commit dccd1a348c
7 changed files with 264 additions and 264 deletions
@@ -38,7 +38,7 @@ please include:
  problem here.
 * The *gdb's backtrace* (only for a crash): if you can reproduce the crash
  (or if you have a core file), please include the backtrace from gdb (look at
-  https://weechat.org/doc/user/#report_crashes[User's guide] for more info).
+  https://weechat.org/doc/weechat/user/#report_crashes[User's guide] for more info).
 * The *actual result*.
 * The *expected result*: the correct result you are expecting.

@@ -68,7 +68,7 @@ time, for https://github.com/weechat/weechat[WeeChat] and the website
 https://github.com/weechat/weechat.org[weechat.org].

 To start a translation in a new language (not yet supported), please look at
-https://weechat.org/doc/dev/#translations[translations]
+https://weechat.org/doc/weechat/dev/#translations[translations]
 in Developer's guide.

 == Feature requests
@@ -84,7 +84,7 @@ For major new features, it's better to discuss about it in IRC
 (server: _irc.libera.chat_, channel _#weechat_).

 Before submitting any pull request, be sure you have read the
-https://weechat.org/doc/dev/#coding_rules[coding rules]
+https://weechat.org/doc/weechat/dev/#coding_rules[coding rules]
 in Developer's guide, which contains info about styles used, naming convention
 and other useful info.

@@ -23,13 +23,13 @@ Homepage: https://weechat.org/

 == Features

-* *Modular chat client*: WeeChat has a lightweight core and optional https://weechat.org/doc/user/#plugins[plugins]. All plugins (including https://weechat.org/doc/user/#irc[IRC]) are independent and can be unloaded.
+* *Modular chat client*: WeeChat has a lightweight core and optional https://weechat.org/doc/weechat/user/#plugins[plugins]. All plugins (including https://weechat.org/doc/weechat/user/#irc[IRC]) are independent and can be unloaded.
 * *Multi-platform*: WeeChat runs on GNU/Linux, *BSD, GNU/Hurd, Haiku, macOS and Windows (Bash/Ubuntu and Cygwin).
 * *Multi-protocols*: WeeChat is designed to support multiple protocols by plugins, like IRC.
 * *Standards-compliant*: the IRC plugin is compliant with RFCs https://datatracker.ietf.org/doc/html/rfc1459[1459], https://datatracker.ietf.org/doc/html/rfc2810[2810], https://datatracker.ietf.org/doc/html/rfc2811[2811], https://datatracker.ietf.org/doc/html/rfc2812[2812], https://datatracker.ietf.org/doc/html/rfc2813[2813] and https://datatracker.ietf.org/doc/html/rfc7194[7194].
 * *Small, fast, and very light*: the core is and should stay as light and fast as possible.
 * *Customizable and extensible*: there are a lot of options to customize WeeChat, and it is extensible with C plugins and https://weechat.org/scripts/[scripts] (https://weechat.org/scripts/language/perl/[Perl], https://weechat.org/scripts/language/python/[Python], https://weechat.org/scripts/language/ruby[Ruby], https://weechat.org/scripts/language/lua/[Lua], https://weechat.org/scripts/language/tcl/[Tcl], https://weechat.org/scripts/language/guile/[Scheme], https://weechat.org/scripts/language/javascript/[JavaScript] and https://weechat.org/scripts/language/php/[PHP]).
-* *Fully documented*: there is comprehensive https://weechat.org/doc/[documentation], which is https://weechat.org/doc/dev/#translations[translated] into several languages.
+* *Fully documented*: there is comprehensive https://weechat.org/doc/weechat/[documentation], which is https://weechat.org/doc/weechat/dev/#translations[translated] into several languages.
 * *Developed from scratch*: WeeChat was built from scratch and is not based on any other client.
 * *Free software*: WeeChat is released under https://www.gnu.org/licenses/gpl-3.0.html[GPLv3].

@@ -41,7 +41,7 @@ On WeeChat's website you can find https://weechat.org/about/screenshots/[more sc

 WeeChat can be installed using your favorite package manager (recommended) or by compiling it yourself.

-For detailed instructions, please check the https://weechat.org/doc/user/#install[WeeChat user's guide].
+For detailed instructions, please check the https://weechat.org/doc/weechat/user/#install[WeeChat user's guide].

 == Semantic versioning

@@ -284,12 +284,12 @@ in this format.
 === Function bar_new

 When the bar name already exists, the API function
-link:https://weechat.org/doc/plugin/#_bar_new[bar_new] returns the pointer to
+link:https://weechat.org/doc/weechat/plugin/#_bar_new[bar_new] returns the pointer to
 the bar (instead of NULL) and sets the default value for all options with the
 values received. +
 If you don't want to set default values in an existing bar, it is recommended
 to first check if the bar exists with the API function
-link:https://weechat.org/doc/plugin/#_bar_search[bar_search].
+link:https://weechat.org/doc/weechat/plugin/#_bar_search[bar_search].

 [[v3.8]]
 == Version 3.8 (2023-01-08)
@@ -372,8 +372,8 @@ int diff = string_strcasecmp ("aaa", "CCC");  /* == -1 */
 [[v3.8_api_string_lower_upper]]
 === API functions string_tolower and string_toupper

-The functions link:https://weechat.org/doc/plugin/#_string_tolower[string_tolower]
-and link:https://weechat.org/doc/plugin/#_string_toupper[string_toupper]
+The functions link:https://weechat.org/doc/weechat/plugin/#_string_tolower[string_tolower]
+and link:https://weechat.org/doc/weechat/plugin/#_string_toupper[string_toupper]
 now return newly allocated string instead of doing the change in place. +
 The returned string must then be freed after use.

@@ -482,7 +482,7 @@ And add the new key kbd:[Alt+Backspace] with this command:
 === Function string_rebuild_split_string

 The API function string_build_with_split_string has been renamed to
-link:https://weechat.org/doc/plugin/#_string_rebuild_split_string[string_rebuild_split_string]
+link:https://weechat.org/doc/weechat/plugin/#_string_rebuild_split_string[string_rebuild_split_string]
 and two new arguments have been added: _index_start_ and _index_end_.

 To stay compatible, the existing calls to the function must be done with the
@@ -526,11 +526,11 @@ which allows better compression and is much faster than zlib for both compressio

 The new compression type is `zstd`, and the default compression is now `off`
 instead of `zlib`: the compression must now be explicitly given in the
-link:https://weechat.org/doc/relay/#command_handshake[handshake] command.
+link:https://weechat.org/doc/weechat/relay/#command_handshake[handshake] command.

-The option `compression` in link:https://weechat.org/doc/relay/#command_handshake[init]
+The option `compression` in link:https://weechat.org/doc/weechat/relay/#command_handshake[init]
 command has been removed, it is now ignored and must be given in the
-link:https://weechat.org/doc/relay/#command_handshake[handshake] command
+link:https://weechat.org/doc/weechat/relay/#command_handshake[handshake] command
 (it was deprecated since WeeChat 2.9).

 The option relay.network.compression_level has been renamed to relay.network.compression
@@ -565,11 +565,11 @@ You can restore the default triggers with the following command:
 === New parameters in function hdata_search

 New parameters have been added in function
-link:https://weechat.org/doc/plugin/#_hdata_search[hdata_search], used for the
+link:https://weechat.org/doc/weechat/plugin/#_hdata_search[hdata_search], used for the
 evaluation of expression.

 New parameters are the same as function
-link:https://weechat.org/doc/plugin/#_string_eval_expression[string_eval_expression]:
+link:https://weechat.org/doc/weechat/plugin/#_string_eval_expression[string_eval_expression]:

 * pointers: hashtable with pointers (pointers)
 * extra_vars: hashtable with extra variables (strings)
@@ -591,7 +591,7 @@ WeeChat versions:

 Support of static array in hdata has been added.
 For pointers to arrays, a prefix `*,` must be added in parameter `array_size`
-of API function link:https://weechat.org/doc/plugin/#_hdata_new_var[hdata_new_var].
+of API function link:https://weechat.org/doc/weechat/plugin/#_hdata_new_var[hdata_new_var].

 [[v3.3]]
 == Version 3.3 (2021-09-19)
@@ -1016,7 +1016,7 @@ bars, so if you want to use the new default settings, you can do:
 If you changed the option "color_bg" in some bars, you should also adjust
 the new option "color_bg_inactive", depending on your needs.

-The function link:https://weechat.org/doc/plugin/#_bar_new[bar_new] in API is updated,
+The function link:https://weechat.org/doc/weechat/plugin/#_bar_new[bar_new] in API is updated,
 so this is an incompatible change: all plugins and scripts calling this function must be updated.

 The following scripts are updated consequently to be compatible with all
@@ -1082,8 +1082,8 @@ plugins/scripts to complete a string, without using the buffer input.
 Therefore two functions have been renamed in API and moved to the new
 "completion" category:

-* hook_completion_get_string -> link:https://weechat.org/doc/plugin/#_completion_get_string[completion_get_string]
-* hook_completion_list_add -> link:https://weechat.org/doc/plugin/#_completion_list_add[completion_list_add]
+* hook_completion_get_string -> link:https://weechat.org/doc/weechat/plugin/#_completion_get_string[completion_get_string]
+* hook_completion_list_add -> link:https://weechat.org/doc/weechat/plugin/#_completion_list_add[completion_list_add]

 [NOTE]
 The old names are still valid for compatibility reasons, but it is recommended
@@ -1181,7 +1181,7 @@ A `handshake` command has been added in weechat relay protocol. +
 The client should send this command before the `init` to negotiate the way to
 authenticate with the relay server.

-See the link:https://weechat.org/doc/relay/#command_handshake[handshake command]
+See the link:https://weechat.org/doc/weechat/relay/#command_handshake[handshake command]
 in Relay protocol doc for more information.

 ==== Server "nonce"
@@ -1199,7 +1199,7 @@ So the hash is computed on: (`server nonce` + `client nonce` + `password`).
 This salt is now mandatory even for algorithms `SHA256` and `SHA512`; this is
 a breaking change in protocol, needed for security reasons.

-See the link:https://weechat.org/doc/relay/#command_init[init command]
+See the link:https://weechat.org/doc/weechat/relay/#command_init[init command]
 in Relay protocol doc for more information.

 [[v2.8]]
@@ -1210,7 +1210,7 @@ in Relay protocol doc for more information.

 The command line option `-a` (or `--no-connect`), which can also be used in the
 `/plugin` command, is now used to set a new info called `auto_connect`
-(see the function link:https://weechat.org/doc/plugin/#_info_get[info_get] in the Plugin API reference).
+(see the function link:https://weechat.org/doc/weechat/plugin/#_info_get[info_get] in the Plugin API reference).

 Therefore, the option is not sent any more to the function `weechat_plugin_init`
 of plugins. +
@@ -1472,8 +1472,8 @@ base 16, 32, and 64.

 New functions in C API, supporting base 16, 32, and 64:

-* link:https://weechat.org/doc/plugin/#_string_base_encode[string_base_encode]
-* link:https://weechat.org/doc/plugin/#_string_base_decode[string_base_decode]
+* link:https://weechat.org/doc/weechat/plugin/#_string_base_encode[string_base_encode]
+* link:https://weechat.org/doc/weechat/plugin/#_string_base_decode[string_base_decode]

 Functions removed from C API:

@@ -1549,7 +1549,7 @@ See issue #787 for more information.

 [NOTE]
 It is recommended for plugins and scripts to use the WeeChat IRC parser:
-see the function link:https://weechat.org/doc/plugin/#_info_get_hashtable[info_get_hashtable]
+see the function link:https://weechat.org/doc/weechat/plugin/#_info_get_hashtable[info_get_hashtable]
 in the Plugin API reference.

 Now the whole IRC message is received by the signal callback, for example:
@@ -1870,33 +1870,33 @@ reduce memory usage).

 Following functions are changed in the C API:

-* link:https://weechat.org/doc/plugin/#_exec_on_files[exec_on_files]
-* link:https://weechat.org/doc/plugin/#_config_new[config_new]
-* link:https://weechat.org/doc/plugin/#_config_new_section[config_new_section]
-* link:https://weechat.org/doc/plugin/#_config_new_option[config_new_option]
-* link:https://weechat.org/doc/plugin/#_hook_command[hook_command]
-* link:https://weechat.org/doc/plugin/#_hook_command_run[hook_command_run]
-* link:https://weechat.org/doc/plugin/#_hook_timer[hook_timer]
-* link:https://weechat.org/doc/plugin/#_hook_fd[hook_fd]
-* link:https://weechat.org/doc/plugin/#_hook_process[hook_process]
-* link:https://weechat.org/doc/plugin/#_hook_process_hashtable[hook_process_hashtable]
-* link:https://weechat.org/doc/plugin/#_hook_connect[hook_connect]
-* link:https://weechat.org/doc/plugin/#_hook_print[hook_print]
-* link:https://weechat.org/doc/plugin/#_hook_signal[hook_signal]
-* link:https://weechat.org/doc/plugin/#_hook_hsignal[hook_hsignal]
-* link:https://weechat.org/doc/plugin/#_hook_config[hook_config]
-* link:https://weechat.org/doc/plugin/#_hook_completion[hook_completion]
-* link:https://weechat.org/doc/plugin/#_hook_modifier[hook_modifier]
-* link:https://weechat.org/doc/plugin/#_hook_info[hook_info]
-* link:https://weechat.org/doc/plugin/#_hook_info_hashtable[hook_info_hashtable]
-* link:https://weechat.org/doc/plugin/#_hook_infolist[hook_infolist]
-* link:https://weechat.org/doc/plugin/#_hook_hdata[hook_hdata]
-* link:https://weechat.org/doc/plugin/#_hook_focus[hook_focus]
-* link:https://weechat.org/doc/plugin/#_unhook_all[unhook_all]
-* link:https://weechat.org/doc/plugin/#_buffer_new[buffer_new]
-* link:https://weechat.org/doc/plugin/#_bar_item_new[bar_item_new]
-* link:https://weechat.org/doc/plugin/#_upgrade_new[upgrade_new]
-* link:https://weechat.org/doc/plugin/#_upgrade_read[upgrade_read]
+* link:https://weechat.org/doc/weechat/plugin/#_exec_on_files[exec_on_files]
+* link:https://weechat.org/doc/weechat/plugin/#_config_new[config_new]
+* link:https://weechat.org/doc/weechat/plugin/#_config_new_section[config_new_section]
+* link:https://weechat.org/doc/weechat/plugin/#_config_new_option[config_new_option]
+* link:https://weechat.org/doc/weechat/plugin/#_hook_command[hook_command]
+* link:https://weechat.org/doc/weechat/plugin/#_hook_command_run[hook_command_run]
+* link:https://weechat.org/doc/weechat/plugin/#_hook_timer[hook_timer]
+* link:https://weechat.org/doc/weechat/plugin/#_hook_fd[hook_fd]
+* link:https://weechat.org/doc/weechat/plugin/#_hook_process[hook_process]
+* link:https://weechat.org/doc/weechat/plugin/#_hook_process_hashtable[hook_process_hashtable]
+* link:https://weechat.org/doc/weechat/plugin/#_hook_connect[hook_connect]
+* link:https://weechat.org/doc/weechat/plugin/#_hook_print[hook_print]
+* link:https://weechat.org/doc/weechat/plugin/#_hook_signal[hook_signal]
+* link:https://weechat.org/doc/weechat/plugin/#_hook_hsignal[hook_hsignal]
+* link:https://weechat.org/doc/weechat/plugin/#_hook_config[hook_config]
+* link:https://weechat.org/doc/weechat/plugin/#_hook_completion[hook_completion]
+* link:https://weechat.org/doc/weechat/plugin/#_hook_modifier[hook_modifier]
+* link:https://weechat.org/doc/weechat/plugin/#_hook_info[hook_info]
+* link:https://weechat.org/doc/weechat/plugin/#_hook_info_hashtable[hook_info_hashtable]
+* link:https://weechat.org/doc/weechat/plugin/#_hook_infolist[hook_infolist]
+* link:https://weechat.org/doc/weechat/plugin/#_hook_hdata[hook_hdata]
+* link:https://weechat.org/doc/weechat/plugin/#_hook_focus[hook_focus]
+* link:https://weechat.org/doc/weechat/plugin/#_unhook_all[unhook_all]
+* link:https://weechat.org/doc/weechat/plugin/#_buffer_new[buffer_new]
+* link:https://weechat.org/doc/weechat/plugin/#_bar_item_new[bar_item_new]
+* link:https://weechat.org/doc/weechat/plugin/#_upgrade_new[upgrade_new]
+* link:https://weechat.org/doc/weechat/plugin/#_upgrade_read[upgrade_read]

 The function `unhook_all` has a new argument `const char *subplugin` to remove
 only hooks created by this "subplugin" (script).
@@ -2067,7 +2067,7 @@ You can restore the default "beep" trigger with the following command:
 [[v1.1_commands_return_code]]
 === Return code of commands

-The API function link:https://weechat.org/doc/plugin/#_command[command]
+The API function link:https://weechat.org/doc/weechat/plugin/#_command[command]
 now sends the value returned return by command callback.

 WeeChat does not display any more an error when a command returns
@@ -2130,9 +2130,9 @@ the old behavior in command `/connect`:
 The API functions using timeval are now using or returning microseconds,
 instead of milliseconds:

-* function link:https://weechat.org/doc/plugin/#_util_timeval_diff[util_timeval_diff]:
+* function link:https://weechat.org/doc/weechat/plugin/#_util_timeval_diff[util_timeval_diff]:
  returns microseconds
-* function link:https://weechat.org/doc/plugin/#_util_timeval_add[util_timeval_add]:
+* function link:https://weechat.org/doc/weechat/plugin/#_util_timeval_add[util_timeval_add]:
  the argument "interval" is now expressed in microseconds.

 [[v1.0.1]]
@@ -2636,7 +2636,7 @@ disable IPv6 in relay if you don't plan to use it at all:
 == Version 0.3.9.2 (2012-11-18)

 This version fixes a security vulnerability when a plugin/script gives
-untrusted command to API function link:https://weechat.org/doc/plugin/#_hook_process[hook_process].
+untrusted command to API function link:https://weechat.org/doc/weechat/plugin/#_hook_process[hook_process].

 [[v0.3.9.1]]
 == Version 0.3.9.1 (2012-11-09)
@@ -81,7 +81,7 @@ def print_stub_functions() -> None:
              encoding="utf-8") as api_doc_file:
        api_doc = api_doc_file.read()
        for match in function_pattern.finditer(api_doc):
-            url = f'https://weechat.org/doc/api/#_{match["function"]}'
+            url = f'https://weechat.org/doc/weechat/api/#_{match["function"]}'
            example = (
                f'\n    ::\n\n{indent(match["example"].lstrip(), " " * 8)}'
                if match["example"]
@@ -3018,7 +3018,7 @@ config_file_write_internal (struct t_config_file *config_file,
            "#\n"
            "# Use commands like /set or /fset to change settings in WeeChat.\n"
            "#\n"
-            "# For more info, see: https://weechat.org/doc/quickstart/\n"
+            "# For more info, see: https://weechat.org/doc/weechat/quickstart/\n"
            "#\n",
            version_get_name (),
            config_file->filename))
@@ -175,7 +175,7 @@ debug_sigsegv_cb ()
        "***      then issue command: \"bt full\" and send result to developers.\n"
        "***      See the user's guide for more info about enabling the core files\n"
        "***      and reporting crashes:\n"
-        "***      https://weechat.org/doc/stable/user/#report_crashes\n"
+        "***      https://weechat.org/doc/weechat/stable/user/#report_crashes\n"
        "***\n"
        "***   2. Otherwise send the backtrace (below), only if it is a complete trace.\n"
        "***      Keep the crash log file, just in case developers ask you some info\n"