summaryrefslogtreecommitdiff
path: root/doc/en
diff options
context:
space:
mode:
Diffstat (limited to 'doc/en')
-rw-r--r--doc/en/autogen/plugin_api/infos.txt2
-rw-r--r--doc/en/autogen/user/irc_commands.txt3
-rw-r--r--doc/en/autogen/user/irc_options.txt10
-rw-r--r--doc/en/autogen/user/weechat_commands.txt21
-rw-r--r--doc/en/autogen/user/weechat_options.txt10
-rw-r--r--doc/en/weechat_plugin_api.en.txt83
-rw-r--r--doc/en/weechat_user.en.txt206
7 files changed, 244 insertions, 91 deletions
diff --git a/doc/en/autogen/plugin_api/infos.txt b/doc/en/autogen/plugin_api/infos.txt
index 1e113b0be..47f6bbbf6 100644
--- a/doc/en/autogen/plugin_api/infos.txt
+++ b/doc/en/autogen/plugin_api/infos.txt
@@ -5,8 +5,6 @@
| irc | irc_buffer | get buffer pointer for an IRC server/channel
-| irc | irc_current_server | currently selected server (only if one buffer is used for all servers)
-
| irc | irc_is_channel | 1 if string is an IRC channel
| irc | irc_nick | get current nick on a server
diff --git a/doc/en/autogen/user/irc_commands.txt b/doc/en/autogen/user/irc_commands.txt
index 7234fd5ff..39cefd0eb 100644
--- a/doc/en/autogen/user/irc_commands.txt
+++ b/doc/en/autogen/user/irc_commands.txt
@@ -397,7 +397,7 @@
tell the server to restart itself
........................................
-• *`/server`* `[list [servername]] | [listfull [servername]] | [add servername hostname[/port] [-auto | -noauto] [-ipv6] [-ssl]] | [copy servername newservername] | [rename servername newservername] | [keep servername] | [del servername] | [deloutq] | [raw] | [switch]`::
+• *`/server`* `[list [servername]] | [listfull [servername]] | [add servername hostname[/port] [-auto | -noauto] [-ipv6] [-ssl]] | [copy servername newservername] | [rename servername newservername] | [keep servername] | [del servername] | [deloutq] | [raw]`::
........................................
list, add or remove IRC servers
@@ -417,7 +417,6 @@
del: delete a server
deloutq: delete messages out queue for all servers (all messages WeeChat is currently sending)
raw: open buffer with raw IRC data
- switch: switch active server (when one buffer is used for all servers, default key: alt-s on server buffer)
Examples:
/server listfull
diff --git a/doc/en/autogen/user/irc_options.txt b/doc/en/autogen/user/irc_options.txt
index fe40c0356..28959c8ff 100644
--- a/doc/en/autogen/user/irc_options.txt
+++ b/doc/en/autogen/user/irc_options.txt
@@ -73,11 +73,6 @@
** type: boolean
** values: on, off (default value: off)
-* *irc.look.one_server_buffer*
-** description: use same buffer for all servers
-** type: boolean
-** values: on, off (default value: off)
-
* *irc.look.open_near_server*
** description: open new channels/privates near server
** type: boolean
@@ -88,6 +83,11 @@
** type: integer
** values: 0 .. 65535 (default value: 256)
+* *irc.look.server_buffer*
+** description: merge server buffers
+** type: integer
+** values: merge_with_core, merge_without_core, independent (default value: merge_with_core)
+
* *irc.look.show_away_once*
** description: show remote away message only once in private
** type: boolean
diff --git a/doc/en/autogen/user/weechat_commands.txt b/doc/en/autogen/user/weechat_commands.txt
index 2c354e750..c43d35087 100644
--- a/doc/en/autogen/user/weechat_commands.txt
+++ b/doc/en/autogen/user/weechat_commands.txt
@@ -45,13 +45,16 @@
/bar scroll nicklist * ye
........................................
-• *`/buffer`* `[clear [number | -all] | move number | close [n1[-n2]]| list | notify level | localvar | set property value | number | name]`::
+• *`/buffer`* `[clear [number | -all] | move number | merge number | unmerge [number] | close [n1[-n2]]| list | notify level | localvar | set property value | number | name]`::
........................................
manage buffers
clear: clear buffer content (-all for all buffers, number for a buffer, or nothing for current buffer)
move: move buffer in the list (may be relative, for example -1)
+ merge: merge current buffer to another buffer (chat area will be mix of both buffers)
+ (by default ctrl-x switches between merged buffers)
+ unmerge: unmerge buffer from other buffers which have same number
close: close buffer (number/range is optional)
list: list buffers (no parameter implies this list)
notify: set notify level for current buffer: this level determines whether buffer will be added to hotlist or not:
@@ -69,13 +72,15 @@
name: jump to buffer by (partial) name
Examples:
- clear current buffer: /buffer clear
- clear all buffers: /buffer clear -all
- move buffer: /buffer move 5
- close current buffer: /buffer close
- close buffers 5 to 7: /buffer close 5-7
- jump to #weechat: /buffer #weechat
- jump to next buffer: /buffer +1
+ clear current buffer: /buffer clear
+ clear all buffers: /buffer clear -all
+ move buffer: /buffer move 5
+ merge with core buffer: /buffer merge 1
+ unmerge buffer: /buffer unmerge
+ close current buffer: /buffer close
+ close buffers 5 to 7: /buffer close 5-7
+ jump to #weechat: /buffer #weechat
+ jump to next buffer: /buffer +1
........................................
• *`/command`* `plugin command`::
diff --git a/doc/en/autogen/user/weechat_options.txt b/doc/en/autogen/user/weechat_options.txt
index 021e54d44..971039330 100644
--- a/doc/en/autogen/user/weechat_options.txt
+++ b/doc/en/autogen/user/weechat_options.txt
@@ -113,6 +113,11 @@
** type: color
** values: a color name (default value: white)
+* *weechat.color.chat_prefix_buffer*
+** description: text color for buffer name (before prefix, when many buffers are merged with same number)
+** type: color
+** values: a color name (default value: brown)
+
* *weechat.color.chat_prefix_error*
** description: text color for error prefix
** type: color
@@ -463,6 +468,11 @@
** type: integer
** values: 0 .. 64 (default value: 0)
+* *weechat.look.prefix_buffer_align*
+** description: prefix alignment for buffer name, when many buffers are merged with same number (none, left, right (default))
+** type: integer
+** values: none, left, right (default value: right)
+
* *weechat.look.prefix_error*
** description: prefix for error messages
** type: string
diff --git a/doc/en/weechat_plugin_api.en.txt b/doc/en/weechat_plugin_api.en.txt
index b40e91b95..546a74616 100644
--- a/doc/en/weechat_plugin_api.en.txt
+++ b/doc/en/weechat_plugin_api.en.txt
@@ -968,8 +968,8 @@ char *str = weechat_string_format_size (2097152); /* str == "2 MB" */
free (str);
----------------------------------------
-weechat_string_reove_color
-^^^^^^^^^^^^^^^^^^^^^^^^^^
+weechat_string_remove_color
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
Remove WeeChat colors from a string.
@@ -5066,10 +5066,33 @@ Example:
[source,C]
----------------------------------------
-struct t_gui_buffer *weechat_buffer = weechat_buffer_search ("core", "weechat");
struct t_gui_buffer *my_buffer = weechat_buffer_search ("myplugin", "my_buffer");
----------------------------------------
+weechat_buffer_search_main
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Search WeeChat main buffer ('core' buffer, first buffer displayed when WeeChat
+is starting).
+
+Prototype:
+
+[source,C]
+----------------------------------------
+struct t_gui_buffer *weechat_buffer_search_main ();
+----------------------------------------
+
+Return value:
+
+* pointer to main buffer
+
+Example:
+
+[source,C]
+----------------------------------------
+struct t_gui_buffer *weechat_buffer = weechat_buffer_search_main ();
+----------------------------------------
+
weechat_buffer_clear
^^^^^^^^^^^^^^^^^^^^
@@ -5124,6 +5147,60 @@ struct t_gui_buffer *my_buffer = weechat_buffer_new ("my_buffer",
weechat_buffer_close (my_buffer);
----------------------------------------
+weechat_buffer_merge
+^^^^^^^^^^^^^^^^^^^^
+
+Merge buffer into another buffer.
+
+Prototype:
+
+[source,C]
+----------------------------------------
+void weechat_buffer_merge (struct t_gui_buffer *buffer,
+ struct t_gui_buffer *target_buffer);
+----------------------------------------
+
+Arguments:
+
+* 'buffer': buffer pointer
+* 'target_buffer': target buffer, where buffer will be merged
+
+Example:
+
+[source,C]
+----------------------------------------
+/* merge current buffer with weechat core buffer */
+weechat_buffer_merge (weechat_current_buffer (),
+ weechat_buffer_search ("core", "weechat"));
+----------------------------------------
+
+weechat_buffer_unmerge
+^^^^^^^^^^^^^^^^^^^^^^
+
+Unmerge buffer from a group of merged buffers.
+
+Prototype:
+
+[source,C]
+----------------------------------------
+void weechat_buffer_unmerge (struct t_gui_buffer *buffer,
+ int number);
+----------------------------------------
+
+Arguments:
+
+* 'buffer': buffer pointer
+* 'number': target number for detached buffer, if it is < 1, then buffer will
+ be moved to number of 'buffer' + 1
+
+Example:
+
+[source,C]
+----------------------------------------
+/* unmerge current buffer (to number 1 in list) */
+weechat_buffer_unmerge (weechat_current_buffer (), 1);
+----------------------------------------
+
weechat_buffer_get_integer
^^^^^^^^^^^^^^^^^^^^^^^^^^
diff --git a/doc/en/weechat_user.en.txt b/doc/en/weechat_user.en.txt
index 242dff163..5236e71ad 100644
--- a/doc/en/weechat_user.en.txt
+++ b/doc/en/weechat_user.en.txt
@@ -306,84 +306,106 @@ Keys for command line
[width="100%",cols="^.^4,.^15",options="header"]
|========================================
-| Keys | Description
+| Keys | Description and command
| Left arrow +
Ctrl + B |
- Go to previous char in command line
+ Go to previous char in command line +
+ `/input move_previous_char`
| Right arrow +
Ctrl + F |
- Go to next char in command line
+ Go to next char in command line +
+ `/input move_next_char`
| Ctrl + left arrow +
Alt + B |
- Go to previous word in command line
+ Go to previous word in command line +
+ `/input move_previous_word`
| Ctrl + right arrow +
Alt + F |
- Go to next word in command line
+ Go to next word in command line +
+ `/input move_next_word`
| Home +
Ctrl + A |
- Go to the beginning of command line
+ Go to the beginning of command line +
+ `/input move_beginning_of_line`
| End +
Ctrl + E |
- Go to the end of command line
+ Go to the end of command line +
+ `/input move_end_of_line`
| Ctrl + C then B |
- Insert code for bold text
+ Insert code for bold text +
+ `/input insert \x02`
| Ctrl + C then C |
- Insert code for colored text
+ Insert code for colored text +
+ `/input insert \x03`
| Ctrl + C then I |
- Insert code for italic text
+ Insert code for italic text +
+ `/input insert \x1D`
| Ctrl + C then O |
- Insert code for color reset
+ Insert code for color reset +
+ `/input insert \x0F`
| Ctrl + C then R |
- Insert code for reverse color
+ Insert code for reverse color +
+ `/input insert \x12`
| Ctrl + C then U |
- Insert code for underlined text
+ Insert code for underlined text +
+ `/input insert \x15`
| Delete +
Ctrl + D |
- Delete next char in command line
+ Delete next char in command line +
+ `/input delete_next_char`
| Backspace +
Ctrl + H |
- Delete previous char in command line
+ Delete previous char in command line +
+ `/input delete_previous_char`
| Ctrl + K |
Delete from cursor until end of command line (deleted string is copied to
- clipboard)
+ clipboard) +
+ `/input delete_end_of_line`
| Ctrl + R |
- Search for text in buffer history (two times: search exact text)
+ Search for text in buffer history (two times: search exact text) +
+ `/input search_text`
| Ctrl + T |
- Transpose chars
+ Transpose chars +
+ `/input transpose_chars`
| Ctrl + U |
Delete from cursor until beginning of command line (deleted string is copied
- to clipboard)
+ to clipboard) +
+ `/input delete_beginning_of_line`
| Ctrl + W |
- Delete previous word of command line (deleted string is copied to clipboard)
+ Delete previous word of command line (deleted string is copied to clipboard) +
+ `/input delete_previous_word`
| Ctrl + Y |
- Paste clipboard content
+ Paste clipboard content +
+ `/input clipboard_paste`
| Tab |
- Complete command or nick (Tab again: find next completion)
+ Complete command or nick (Tab again: find next completion) +
+ `/input complete_next`
| Shift + Tab |
Without completion: do a partial completion, with pending completion:
- complete with previous completion
+ complete with previous completion +
+ `/input complete_previous`
| Any char |
Insert char at cursor position in command line
@@ -391,28 +413,36 @@ Keys for command line
| Enter +
Ctrl + J +
Ctrl + M |
- Execute command or send message (in search mode: stop search)
+ Execute command or send message (in search mode: stop search) +
+ `/input return`
| Up arrow |
- Call previous command/message (in search mode: search up)
+ Call previous command/message (in search mode: search up) +
+ `/input history_previous`
| Down arrow |
- Call next command/message (in search mode: search down)
+ Call next command/message (in search mode: search down) +
+ `/input history_next`
| Ctrl + up arrow |
- Call previous command/message in global history (common for all buffers)
+ Call previous command/message in global history (common for all buffers) +
+ `/input history_global_previous`
| Ctrl + down arrow |
- Call next command/message in global history (common for all buffers)
+ Call next command/message in global history (common for all buffers) +
+ `/input history_global_next`
| Alt + D |
- Delete next word in command line (deleted string is copied to clipboard)
+ Delete next word in command line (deleted string is copied to clipboard) +
+ `/input delete_next_word`
| Alt + K |
- Grab a key and insert its code in command line
+ Grab a key and insert its code in command line +
+ `/input grab_key`
-| Alt + R |
- Delete entire command line
+| Alt + R` +
+ Delete entire command line +
+ `/input delete_line`
|========================================
Keys for buffers / windows
@@ -420,105 +450,141 @@ Keys for buffers / windows
[width="100%",cols="^.^4,.^15",options="header"]
|========================================
-| Keys | Description
+| Keys | Description and command
| Ctrl + L |
- Redraw whole window
+ Redraw whole window +
+ `/window refresh`
| Ctrl + S then Ctrl + U |
- Set unread marker on all buffers
+ Set unread marker on all buffers +
+ `/input set_unread`
+
+| Ctrl + X |
+ Switch current buffer if buffers are attached with same number +
+ `/input switch_active_buffer`
| Page up |
- Scroll up one page in buffer history
+ Scroll up one page in buffer history +
+ `/window page_up`
| Page down |
- Scroll down one page in buffer history
+ Scroll down one page in buffer history +
+ `/window page_down`
| Alt + Page up |
- Scroll up a few lines in buffer history
+ Scroll up a few lines in buffer history +
+ `/window scroll_up`
| Alt + Page down |
- Scroll down a few lines in buffer history
+ Scroll down a few lines in buffer history +
+ `/window scroll_down`
| Alt + Home |
- Scroll to top of buffer
+ Scroll to top of buffer +
+ `/window scroll_top`
| Alt + End |
- Scroll to bottom of buffer
+ Scroll to bottom of buffer +
+ `/window scroll_bottom`
| Alt + left arrow +
Alt + up arrow +
Ctrl + P +
F5 |
- Switch to previous buffer
+ Switch to previous buffer +
+ `/buffer -1`
| Alt + right arrow +
Alt + down arrow +
Ctrl + N +
F6 |
- Switch to next buffer
+ Switch to next buffer +
+ `/buffer +1`
| F7 |
- Switch to previous window
-
+ Switch to previous window +
+ `/window -1`
| F8 |
- Switch to next window
+ Switch to next window +
+ `/window +1`
| F9 |
- Scroll buffer's title on the left
+ Scroll buffer's title on the left +
+ `/bar scroll title * x-50%`
| F10 |
- Scroll buffer's title on the right
+ Scroll buffer's title on the right +
+ `/bar scroll title * x+50%`
| F11 |
- Scroll up one page in nicklist
+ Scroll up one page in nicklist +
+ `/bar scroll nicklist * y-100%`
| F12 |
- Scroll down one page in nicklist
+ Scroll down one page in nicklist +
+ `/bar scroll nicklist * y+100%`
| Alt + F11 |
- Go to the beginning of nicklist
+ Go to the beginning of nicklist +
+ `/bar scroll nicklist * yb`
| Alt + F12 |
- Go to the end of nicklist
+ Go to the end of nicklist +
+ `/bar scroll nicklist * ye`
| Alt + A |
Switch to next buffer with activity (with priority: highlight, message,
- other)
+ other) +
+ `/input jump_smart`
| Alt + J then Alt + L |
- Switch to last buffer
+ Switch to last buffer +
+ `/input jump_last_buffer`
| Alt + J then Alt + R |
- Switch to IRC raw buffer
+ Switch to IRC raw buffer +
+ `/server raw`
| Alt + digit (0-9) |
- Switch to buffer by number (0 = 10)
+ Switch to buffer by number (0 = 10) +
+ `/buffer *N`
| Alt + J then number (01-99) |
- Switch to buffer by number
+ Switch to buffer by number +
+ `/buffer NN`
| Alt + N |
- Scroll to next highlight
+ Scroll to next highlight +
+ `/window scroll_next_highlight`
| Alt + P |
- Scroll to previous highlight
+ Scroll to previous highlight +
+ `/window scroll_previous_highlight`
| Alt + U |
- Scroll to first unread line in buffer
+ Scroll to first unread line in buffer +
+ `/input scroll_unread`
| Alt + W then Alt + arrow |
- Switch to window with direction
+ Switch to window with direction +
+ `/window up` +
+ `/window down` +
+ `/window left` +
+ `/window right`
| Alt + Z |
Zoom on current window (Alt + Z again: restore initial windows state, before
- zoom)
+ zoom) +
+ `/window zoom`
| Alt + < |
- Switch to previous buffer in list of visited buffers
+ Switch to previous buffer in list of visited buffers +
+ `/input jump_previously_visited_buffer`
| Alt + > |
- Switch to next buffer in list of visited buffers
+ Switch to next buffer in list of visited buffers +
+ `/input jump_next_visited_buffer`
|========================================
Other keys
@@ -526,17 +592,15 @@ Other keys
[width="100%",cols="^.^4,.^15",options="header"]
|========================================
-| Keys | Description
+| Keys | Description and command
| Alt + H |
- Clear hotlist (activity notification on other buffers)
-
-| Alt + S |
- Switch current IRC server on servers buffer (if option
- "irc.look.one_server_buffer" is enabled)
+ Clear hotlist (activity notification on other buffers) +
+ `/input hotlist_clear` +
| Alt + = |
- Toggle filters on/off
+ Toggle filters on/off +
+ `/filter toggle` +
|========================================
[[command_line]]
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-01 11:23:33 +0000