summaryrefslogtreecommitdiff
path: root/doc/en
diff options
context:
space:
mode:
authorSébastien Helleu <flashcode@flashtux.org>2020-02-06 21:17:54 +0100
committerSébastien Helleu <flashcode@flashtux.org>2020-02-06 21:17:54 +0100
commitb8d7af54e3df0e47ebba2fea8cfb8ee6ab2e7653 (patch)
tree68df2220c0b02c3beb5a81105e701d209884767f /doc/en
parent60f2734184b4caf1c1d0673742fdd7d08736e165 (diff)
downloadweechat-b8d7af54e3df0e47ebba2fea8cfb8ee6ab2e7653.zip
doc: add keys and actions on fset and script buffers in user's guide
Diffstat (limited to 'doc/en')
-rw-r--r--doc/en/weechat_user.en.adoc147
1 files changed, 114 insertions, 33 deletions
diff --git a/doc/en/weechat_user.en.adoc b/doc/en/weechat_user.en.adoc
index 00d070798..d6de9c32d 100644
--- a/doc/en/weechat_user.en.adoc
+++ b/doc/en/weechat_user.en.adoc
@@ -1777,44 +1777,125 @@ These keys are used in context "mouse", namely when a mouse event occurs.
[width="100%",cols="^.^3,^.^3,^.^3,.^8,.^8",options="header"]
|===
-| Button/Wheel ^(1)^ | Gesture | Area | Description | Command
-| ◾◽◽ | - | chat | Switch to window. | `/window ${_window_number}`
-| ◾◽◽ | left | chat | Switch to previous buffer. | `/window ${_window_number};/buffer +1`
-| ◾◽◽ | right | chat | Switch to next buffer. | `/window ${_window_number};/buffer +1`
-| ◾◽◽ | left (long) | chat | Switch to first buffer. | `/window ${_window_number};/buffer 1`
-| ◾◽◽ | right (long) | chat | Switch to last buffer. | `/window ${_window_number};/input jump_last_buffer`
-| ◾◽◽ | - | chat (script buffer) | Select line in script buffer. | `/script go ${_chat_line_y}`
-| ◽◽◾ | - | chat (script buffer) | Install/remove script. | `/script go ${_chat_line_y};/script installremove -q ${script_name_with_extension}`
-| kbd:[▲] | - | chat | Scroll up a few lines in buffer history. | `/window scroll_up -window ${_window_number}`
-| kbd:[▼] | - | chat | Scroll down a few lines in buffer history. | `/window scroll_down -window ${_window_number}`
-| kbd:[▲] | - | chat (script buffer) | Move 5 lines up in script buffer. | `/script up 5`
-| kbd:[▼] | - | chat (script buffer) | Move 5 lines down in script buffer. | `/script down 5`
-| kbd:[Ctrl+▲] | - | chat | Scroll horizontally to the left. | `/window scroll_horiz -window ${_window_number} -10%`
-| kbd:[Ctrl+▼] | - | chat | Scroll horizontally to the right. | `/window scroll_horiz -window ${_window_number} +10%`
-| ◾◽◽ | up / left | buflist | Move buffer to a lower number. | Signal `buflist_mouse`.
-| ◾◽◽ | down / right | buflist | Move buffer to a higher number. | Signal `buflist_mouse`.
-| ◾◽◽ | - | buflist | Switch to buffer (previously visited buffer if the buffer is the current one). | Signal `buflist_mouse`.
-| ◽◽◾ | - | buflist | Switch to next visited buffer if the buffer is the current one. | Signal `buflist_mouse`.
-| kbd:[Ctrl+▲] | - | buflist | Switch to previous buffer. | Signal `buflist_mouse`.
-| kbd:[Ctrl+▼] | - | buflist | Switch to next buffer. | Signal `buflist_mouse`.
-| ◾◽◽ | up | nicklist | Scroll up one page in nicklist. | `/bar scroll nicklist ${_window_number} -100%`
-| ◾◽◽ | down | nicklist | Scroll down one page in nicklist. | `/bar scroll nicklist ${_window_number} +100%`
-| ◾◽◽ | up (long) | nicklist | Go to the beginning of nicklist. | `/bar scroll nicklist ${_window_number} b`
-| ◾◽◽ | down (long) | nicklist | Go to the end of nicklist. | `/bar scroll nicklist ${_window_number} e`
-| ◾◽◽ | - | nicklist | Open query with nick. | `/window ${_window_number};/query ${nick}`
-| ◽◽◾ | - | nicklist | Do a whois on nick. | `/window ${_window_number};/whois ${nick}`
-| ◾◽◽ | left | nicklist | Kick nick. | `/window ${_window_number};/kick ${nick}`
-| ◾◽◽ | left (long) | nicklist | Kick and ban nick. | `/window ${_window_number};/kickban ${nick}`
-| ◽◽◾ | left | nicklist | Ban nick. | `/window ${_window_number};/ban ${nick}`
-| ◽◽◾ | - | input | Grab a mouse event and insert its code in command line. | `/input grab_mouse_area`
-| kbd:[▲] | - | any bar | Scroll bar by -20%. | `/bar scroll ${_bar_name} ${_window_number} -20%`
-| kbd:[▼] | - | any bar | Scroll bar by +20%. | `/bar scroll ${_bar_name} ${_window_number} +20%`
-| ◽◾◽ | - | anywhere | Start cursor mode at this point. | `/cursor go ${_x},${_y}`
+| Button/Wheel ^(1)^ | Gesture | Area | Description | Command
+| ◾◽◽ | - | chat | Switch to window. | `/window ${_window_number}`
+| ◾◽◽ | left | chat | Switch to previous buffer. | `/window ${_window_number};/buffer +1`
+| ◾◽◽ | right | chat | Switch to next buffer. | `/window ${_window_number};/buffer +1`
+| ◾◽◽ | left (long) | chat | Switch to first buffer. | `/window ${_window_number};/buffer 1`
+| ◾◽◽ | right (long) | chat | Switch to last buffer. | `/window ${_window_number};/input jump_last_buffer`
+| kbd:[▲] | - | chat | Scroll up a few lines in buffer history. | `/window scroll_up -window ${_window_number}`
+| kbd:[▼] | - | chat | Scroll down a few lines in buffer history. | `/window scroll_down -window ${_window_number}`
+| kbd:[Ctrl+▲] | - | chat | Scroll horizontally to the left. | `/window scroll_horiz -window ${_window_number} -10%`
+| kbd:[Ctrl+▼] | - | chat | Scroll horizontally to the right. | `/window scroll_horiz -window ${_window_number} +10%`
+| kbd:[▲] | - | chat: fset buffer | Move five lines up in fset buffer. | `/fset -up 5`
+| kbd:[▼] | - | chat: fset buffer | Move five lines down in fset buffer. | `/fset -down 5`
+| ◾◽◽ | - | chat: fset buffer | Select line in fset buffer. | `/window ${_window_number};/fset -go ${_chat_line_y}`
+| ◽◽◾ | - | chat: fset buffer | Toggle boolean (on/off) or edit the option value. | `hsignal:fset_mouse`
+| ◽◽◾ | left | chat: fset buffer | Decrease value for integer/color, set/append to value for other types. | `hsignal:fset_mouse`
+| ◽◽◾ | right | chat: fset buffer | Increase value for integer/color, set/append to value for other types. | `hsignal:fset_mouse`
+| ◽◽◾ | up / down | chat: fset buffer | Mark/unmark multiple options. | `hsignal:fset_mouse`
+| kbd:[▲] | - | chat: script buffer | Move five lines up in script buffer. | `/script up 5`
+| kbd:[▼] | - | chat: script buffer | Move five lines down in script buffer. | `/script down 5`
+| ◾◽◽ | - | chat: script buffer | Select line in script buffer. | `/script go ${_chat_line_y}`
+| ◽◽◾ | - | chat: script buffer | Install/remove script. | `/script go ${_chat_line_y};/script installremove -q ${script_name_with_extension}`
+| ◾◽◽ | up / left | buflist | Move buffer to a lower number. | Signal `buflist_mouse`.
+| ◾◽◽ | down / right | buflist | Move buffer to a higher number. | Signal `buflist_mouse`.
+| ◾◽◽ | - | buflist | Switch to buffer (previously visited buffer if the buffer is the current one). | Signal `buflist_mouse`.
+| ◽◽◾ | - | buflist | Switch to next visited buffer if the buffer is the current one. | Signal `buflist_mouse`.
+| kbd:[Ctrl+▲] | - | buflist | Switch to previous buffer. | Signal `buflist_mouse`.
+| kbd:[Ctrl+▼] | - | buflist | Switch to next buffer. | Signal `buflist_mouse`.
+| ◾◽◽ | up | nicklist | Scroll up one page in nicklist. | `/bar scroll nicklist ${_window_number} -100%`
+| ◾◽◽ | down | nicklist | Scroll down one page in nicklist. | `/bar scroll nicklist ${_window_number} +100%`
+| ◾◽◽ | up (long) | nicklist | Go to the beginning of nicklist. | `/bar scroll nicklist ${_window_number} b`
+| ◾◽◽ | down (long) | nicklist | Go to the end of nicklist. | `/bar scroll nicklist ${_window_number} e`
+| ◾◽◽ | - | nicklist | Open query with nick. | `/window ${_window_number};/query ${nick}`
+| ◽◽◾ | - | nicklist | Do a whois on nick. | `/window ${_window_number};/whois ${nick}`
+| ◾◽◽ | left | nicklist | Kick nick. | `/window ${_window_number};/kick ${nick}`
+| ◾◽◽ | left (long) | nicklist | Kick and ban nick. | `/window ${_window_number};/kickban ${nick}`
+| ◽◽◾ | left | nicklist | Ban nick. | `/window ${_window_number};/ban ${nick}`
+| ◽◽◾ | - | input | Grab a mouse event and insert its code in command line. | `/input grab_mouse_area`
+| kbd:[▲] | - | any bar | Scroll bar by -20%. | `/bar scroll ${_bar_name} ${_window_number} -20%`
+| kbd:[▼] | - | any bar | Scroll bar by +20%. | `/bar scroll ${_bar_name} ${_window_number} +20%`
+| ◽◾◽ | - | anywhere | Start cursor mode at this point. | `/cursor go ${_x},${_y}`
|===
[NOTE]
^(1)^ kbd:[▲] and kbd:[▼] are wheel up and down.
+[[key_bindings_fset_buffer]]
+==== Keys for fset buffer
+
+These keys and actions are used on the fset buffer (see <<fset_plugin,Fset plugin>>).
+
+[width="100%",cols="^.^3,^.^2,.^8,.^5",options="header"]
+|===
+| Key | Action ^(1)^ | Description | Command
+| kbd:[↑] | | Move one line up. | `/fset -up`
+| kbd:[↓] | | Move one line down. | `/fset -down`
+| kbd:[PgUp] | | Move one page up. | `/window page_up`
+| kbd:[PgDn] | | Move one page down. | `/window page_down`
+| kbd:[Alt+Home] | `pass:[<<]` | Move to first line. | `/fset -go 0`
+| kbd:[Alt+End] | `pass:[>>]` | Move to last line. | `/fset -go end`
+| kbd:[F11] | `pass:[<]` | Scroll horizontally on the left. | `/fset -left`
+| kbd:[F12] | `pass:[>]` | Scroll horizontally on the right. | `/fset -right`
+| kbd:[Alt+Space] | `t` | Toggle boolean value. | `/fset -toggle`
+| kbd:[Alt+-] | `-` | Subtract 1 from value for integer/color, set value for other types. | `/fset -add -1`
+| kbd:[Alt++] | `+` | Add 1 to value for integer/color, append to value for other types. | `/fset -add 1`
+| kbd:[Alt+f],
+ kbd:[Alt+r] | `r` | Reset value. | `/fset -reset`
+| kbd:[Alt+f],
+ kbd:[Alt+u] | `u` | Unset value. | `/fset -unset`
+| kbd:[Alt+Enter] | `s` | Set value. | `/fset -set`
+| kbd:[Alt+f],
+ kbd:[Alt+n] | `n` | Set new value. | `/fset -setnew`
+| kbd:[Alt+f],
+ kbd:[Alt+a] | `a` | Append to value. | `/fset -append`
+| kbd:[Alt+,] | `,` | Mark/unmark option. | `/fset -mark 1`
+| kbd:[Shift+↑] | | Move one line up and mark/unmark option. | `/fset -up; /fset -mark`
+| kbd:[Shift+↓] | | Mark/unmark option and move one line down. | `/fset -mark; /fset -down`
+| | `m:xxx` | Mark options displayed that are matching filter "xxx" (any filter on option or value is allowed, see <<command_fset_fset,fset command>>). |
+| | `u:xxx` | Unmark options displayed that are matching filter "xxx" (any filter on option or value is allowed, see <<command_fset_fset,fset command>>). |
+| kbd:[Ctrl+l] (`L`) | | Refresh options and whole screen. | `/fset -refresh`
+| | `$` | Refresh options (keep marked options). |
+| | `$$` | Refresh options (unmark all options). |
+| kbd:[Alt+p] | | Toggle plugin description options (`pass:[plugins.desc.*]`). | `/mute /set fset.look.show_plugins_desc toggle`
+| kbd:[Alt+v] | | Toggle help bar. | `/bar toggle fset`
+| | `s:x,y` | Sort options by fields x,y (see option <<option_fset.look.sort,fset.look.sort>>). | `/mute /set fset.look.sort x,y`
+| | `s:` | Reset sort to its default value (see option <<option_fset.look.sort,fset.look.sort>>). | `/mute /unset fset.look.sort`
+| | `w:xxx` | Export options in file "xxx". | `/fset -export xxx`
+| | `w-:xxx` | Export options in file "xxx" without help. | `/fset -export -nohelp xxx`
+| | `w+:xxx` | Export options in file "xxx" with help. | `/fset -export -help xxx`
+| kbd:[Ctrl+x] | `x` | Switch the format used to display options. | `/fset -format`
+| | `q` | Close fset buffer. | `/buffer close`
+|===
+
+[NOTE]
+^(1)^ The action must be entered as input on the command line, followed by kbd:[Enter].
+
+[[key_bindings_script_buffer]]
+==== Keys for script buffer
+
+These keys and actions are used on the script buffer (see <<scripts_plugins,Script plugin>>).
+
+[width="100%",cols="^.^3,^.^2,.^8,.^5",options="header"]
+|===
+| Key | Action ^(1)^ | Description | Command
+| kbd:[↑] | | Move one line up. | `/script up`
+| kbd:[↓] | | Move one line down. | `/script down`
+| kbd:[PgUp] | | Move one page up. | `/window page_up`
+| kbd:[PgDn] | | Move one page down. | `/window page_down`
+| kbd:[Alt+i] | `i` | Install script. | `/script install`
+| kbd:[Alt+r] | `r` | Remove script. | `/script remove`
+| kbd:[Alt+l] (`L`) | `l` | Load script. | `/script load`
+| kbd:[Alt+u] | `u` | Unload script. | `/script unload`
+| kbd:[Alt+Shift+A] | `A` | Autoload script. | `/script toggleautoload`
+| kbd:[Alt+h] | `h` | Hold/unhold script. | `/script hold`
+| kbd:[Alt+v] | `v` | View script. | `/script show`
+|===
+
+[NOTE]
+^(1)^ The action must be entered as input on the command line, followed by kbd:[Enter].
+
[[mouse]]
=== Mouse support