summaryrefslogtreecommitdiff
path: root/doc/en
diff options
context:
space:
mode:
Diffstat (limited to 'doc/en')
-rw-r--r--doc/en/includes/autogen_api_url_options.en.adoc2
-rw-r--r--doc/en/weechat_dev.en.adoc8
-rw-r--r--doc/en/weechat_plugin_api.en.adoc52
-rw-r--r--doc/en/weechat_scripting.en.adoc2
-rw-r--r--doc/en/weechat_user.en.adoc52
5 files changed, 58 insertions, 58 deletions
diff --git a/doc/en/includes/autogen_api_url_options.en.adoc b/doc/en/includes/autogen_api_url_options.en.adoc
index 22e6be580..fbe64650b 100644
--- a/doc/en/includes/autogen_api_url_options.en.adoc
+++ b/doc/en/includes/autogen_api_url_options.en.adoc
@@ -6,7 +6,7 @@
// tag::url_options[]
[width="100%",cols="2,^1,7",options="header"]
|===
-| Option | Type ^(1)^ | Constants ^(2)^
+| Option | Type ^(1)^ | Constants ^(2)^
| verbose | long |
diff --git a/doc/en/weechat_dev.en.adoc b/doc/en/weechat_dev.en.adoc
index eca76f60e..55c2c6f74 100644
--- a/doc/en/weechat_dev.en.adoc
+++ b/doc/en/weechat_dev.en.adoc
@@ -940,10 +940,10 @@ All combinations are summarized in this table:
| [hex]#19# + `B` + `EXT` | [hex]#19# `+B@00124+` | chat + bars | Set background (extended color).
| [hex]#19# + `*` + `(ATTR)STD` | [hex]#19# `+*05+` | chat + bars | Set foreground (WeeChat color).
| [hex]#19# + `*` + `(ATTR)EXT` | [hex]#19# `+*@00214+` | chat + bars | Set foreground (extended color).
-| [hex]#19# + `*` + `(ATTR)STD` + `,` + `STD` ^(1)^ | [hex]#19# `+*08,05+` | chat + bars | Set foreground/background (WeeChat colors).
-| [hex]#19# + `*` + `(ATTR)STD` + `,` + `EXT` ^(1)^ | [hex]#19# `+*01,@00214+` | chat + bars | Set foreground (WeeChat color) and background (extended color).
-| [hex]#19# + `*` + `(ATTR)EXT` + `,` + `STD` ^(1)^ | [hex]#19# `+*@00214,05+` | chat + bars | Set foreground (extended color) and background (WeeChat color).
-| [hex]#19# + `*` + `(ATTR)EXT` + `,` + `EXT` ^(1)^ | [hex]#19# `+*@00214,@00017+` | chat + bars | Set foreground/background (extended colors).
+| [hex]#19# + `*` + `(ATTR)STD` + `,` + `STD` ^(1)^ | [hex]#19# `+*08,05+` | chat + bars | Set foreground/background (WeeChat colors).
+| [hex]#19# + `*` + `(ATTR)STD` + `,` + `EXT` ^(1)^ | [hex]#19# `+*01,@00214+` | chat + bars | Set foreground (WeeChat color) and background (extended color).
+| [hex]#19# + `*` + `(ATTR)EXT` + `,` + `STD` ^(1)^ | [hex]#19# `+*@00214,05+` | chat + bars | Set foreground (extended color) and background (WeeChat color).
+| [hex]#19# + `*` + `(ATTR)EXT` + `,` + `EXT` ^(1)^ | [hex]#19# `+*@00214,@00017+` | chat + bars | Set foreground/background (extended colors).
| [hex]#19# + `*` + `(ATTR)STD` + `~` + `STD` | [hex]#19# `+*08~05+` | chat + bars | Set foreground/background (WeeChat colors).
| [hex]#19# + `*` + `(ATTR)STD` + `~` + `EXT` | [hex]#19# `+*01~@00214+` | chat + bars | Set foreground (WeeChat color) and background (extended color).
| [hex]#19# + `*` + `(ATTR)EXT` + `~` + `STD` | [hex]#19# `+*@00214~05+` | chat + bars | Set foreground (extended color) and background (WeeChat color).
diff --git a/doc/en/weechat_plugin_api.en.adoc b/doc/en/weechat_plugin_api.en.adoc
index 8d857272d..bdf50e3c7 100644
--- a/doc/en/weechat_plugin_api.en.adoc
+++ b/doc/en/weechat_plugin_api.en.adoc
@@ -2631,7 +2631,7 @@ expanded to last):
| `+${eval:xxx}+` | 1.3
| String to evaluate.
| >> `+${eval:${date:${weechat.look.buffer_time_format}}}+` +
- == `+19:02:45+` ^(1)^ +
+ == `+19:02:45+` ^(1)^ +
+
^(1)^ With colors if there are color codes in the option
weechat.look.buffer_time_format
@@ -2698,7 +2698,7 @@ expanded to last):
== `+!dlrow ,olleH+` +
+
>> `+${rev:Hello, ${color:red}world!}+` +
- == `+!dlrow30F ,olleH+` ^(1)^ +
+ == `+!dlrow30F ,olleH+` ^(1)^ +
+
^(1)^ No color, the color code is reversed
@@ -2708,7 +2708,7 @@ expanded to last):
== `+!dlrow ,olleH+` +
+
>> `+${revscr:Hello, ${color:red}world!}+` +
- == `+!dlrow ,olleH+` ^(1)^ +
+ == `+!dlrow ,olleH+` ^(1)^ +
+
^(1)^ `pass:[ ,olleH]` in red
@@ -2821,10 +2821,10 @@ expanded to last):
| WeeChat color code (the name of color has optional attributes),
see function <<_color,color>> for supported formats.
| >> `+${color:red}red text+` +
- == `+red text+` ^(1)^ +
+ == `+red text+` ^(1)^ +
+
>> `+${color:*214}bold orange text+` +
- == `+bold orange text+` ^(2)^ +
+ == `+bold orange text+` ^(2)^ +
+
^(1)^ In red +
^(2)^ In bold orange
@@ -2930,7 +2930,7 @@ expanded to last):
| `+${translate:xxx}+` | 3.2
| Translated string (depends on the language used by WeeChat to display messages).
| >> `+${translate:Plugin}+` +
- == `+Extension+` ^(1)^ +
+ == `+Extension+` ^(1)^ +
+
^(1)^ Example in French
@@ -10362,7 +10362,7 @@ List of signals sent by WeeChat and plugins:
| String: comma-separated list of scripts removed.
| Scheme script(s) removed.
-| irc | [[hook_signal_xxx_irc_in_yyy]] xxx,irc_in_yyy ^(1)^ |
+| irc | [[hook_signal_xxx_irc_in_yyy]] xxx,irc_in_yyy ^(1)^ |
| String: message.
| IRC message from server (before irc plugin uses it,
signal sent only if message is *not* ignored). +
@@ -10370,13 +10370,13 @@ List of signals sent by WeeChat and plugins:
If the return code of a callback is _WEECHAT_RC_OK_EAT_, then the IRC message
is immediately destroyed and not processed _(WeeChat ≥ 3.3)_.
-| irc | [[hook_signal_xxx_irc_in2_yyy]] xxx,irc_in2_yyy ^(1)^ |
+| irc | [[hook_signal_xxx_irc_in2_yyy]] xxx,irc_in2_yyy ^(1)^ |
| String: message.
| IRC message from server (after irc plugin uses it,
signal sent only if message is *not* ignored). +
Since version 2.2, the whole IRC message is sent, including tags.
-| irc | [[hook_signal_xxx_irc_raw_in_yyy]] xxx,irc_raw_in_yyy ^(1)^ | 0.3.2
+| irc | [[hook_signal_xxx_irc_raw_in_yyy]] xxx,irc_raw_in_yyy ^(1)^ | 0.3.2
| String: message.
| IRC message from server (before irc plugin uses it,
signal sent even if message is ignored). +
@@ -10384,25 +10384,25 @@ List of signals sent by WeeChat and plugins:
If the return code of a callback is _WEECHAT_RC_OK_EAT_, then the IRC message
is immediately destroyed and not processed _(WeeChat ≥ 3.3)_.
-| irc | [[hook_signal_xxx_irc_raw_in2_yyy]] xxx,irc_raw_in2_yyy ^(1)^ | 0.3.2
+| irc | [[hook_signal_xxx_irc_raw_in2_yyy]] xxx,irc_raw_in2_yyy ^(1)^ | 0.3.2
| String: message.
| IRC message from server (after irc plugin uses it,
signal sent even if message is ignored). +
Since version 2.2, the whole IRC message is sent, including tags.
-| irc | [[hook_signal_xxx_irc_out1_yyy]] xxx,irc_out1_yyy ^(1)^ | 0.3.7
+| irc | [[hook_signal_xxx_irc_out1_yyy]] xxx,irc_out1_yyy ^(1)^ | 0.3.7
| String: message.
| IRC message sent to server before automatic split
(to fit in 512 bytes by default).
-| irc | [[hook_signal_xxx_irc_out_yyy]] xxx,irc_out_yyy ^(1)^ |
+| irc | [[hook_signal_xxx_irc_out_yyy]] xxx,irc_out_yyy ^(1)^ |
| String: message.
| IRC message sent to server after automatic split
(to fit in 512 bytes by default). +
*Warning:* the string may contain invalid UTF-8 data.
Signal "xxx,irc_out1_yyy" is recommended instead.
-| irc | [[hook_signal_xxx_irc_outtags_yyy]] xxx,irc_outtags_yyy ^(1)^ | 0.3.4
+| irc | [[hook_signal_xxx_irc_outtags_yyy]] xxx,irc_outtags_yyy ^(1)^ | 0.3.4
| String: tags + ";" + message.
| Tags + IRC message sent to server. +
*Warning:* the string may contain invalid UTF-8 data.
@@ -11264,7 +11264,7 @@ List of hsignals:
|===
| Plugin | Signal | Min WeeChat | Arguments | Description
-| irc | [[hook_hsignal_irc_redirection_xxx_yyy]] irc_redirection_xxx_yyy ^(1)^ | 0.3.4
+| irc | [[hook_hsignal_irc_redirection_xxx_yyy]] irc_redirection_xxx_yyy ^(1)^ | 0.3.4
| See <<hsignal_irc_redirect_command,hsignal_irc_redirect_command>>
| Redirection output.
@@ -11694,7 +11694,7 @@ List of modifiers used by WeeChat and plugins:
|===
| Modifier | Min WeeChat | Modifier data | String | Output
-| [[hook_modifier_irc_in_xxx]] irc_in_xxx ^(1)^ |
+| [[hook_modifier_irc_in_xxx]] irc_in_xxx ^(1)^ |
| Server name
| Content of message received from IRC server (before charset decoding). +
*Warning:* the string may contain invalid UTF-8 data; use only for raw
@@ -11702,24 +11702,24 @@ List of modifiers used by WeeChat and plugins:
Modifier <<hook_modifier_irc_in2_xxx,irc_in2_xxx>> is recommended instead.
| New content of message.
-| [[hook_modifier_irc_in2_xxx]] irc_in2_xxx ^(1)^ | 0.3.5
+| [[hook_modifier_irc_in2_xxx]] irc_in2_xxx ^(1)^ | 0.3.5
| Server name
| Content of message received from IRC server (after charset decoding).
| New content of message.
-| [[hook_modifier_irc_out1_xxx]] irc_out1_xxx ^(1)^ | 0.3.7
+| [[hook_modifier_irc_out1_xxx]] irc_out1_xxx ^(1)^ | 0.3.7
| Server name
| Content of message about to be sent to IRC server before automatic split
(to fit in 512 bytes by default).
| New content of message.
-| [[hook_modifier_irc_out_xxx]] irc_out_xxx ^(1)^ |
+| [[hook_modifier_irc_out_xxx]] irc_out_xxx ^(1)^ |
| Server name
| Content of message about to be sent to IRC server after automatic split
(to fit in 512 bytes by default).
| New content of message.
-| [[hook_modifier_bar_condition_yyy]] bar_condition_yyy ^(2)^ |
+| [[hook_modifier_bar_condition_yyy]] bar_condition_yyy ^(2)^ |
| String with window pointer (eg: "0x1234abcd")
| Empty string.
| "1" to display bar, "0" to hide it.
@@ -11750,7 +11750,7 @@ List of modifiers used by WeeChat and plugins:
| New content of command line sent to buffer.
| [[hook_modifier_weechat_print]] weechat_print |
-| buffer pointer (eg: "0x1234abcd") + ";" + tags ^(3)^
+| buffer pointer (eg: "0x1234abcd") + ";" + tags ^(3)^
| Message printed.
| New message printed. +
For more information on the hooks called when a line is printed, see
@@ -12285,7 +12285,7 @@ Content of hashtable sent to callback (keys and values are of type "string"):
[width="100%",cols="5,5,8,3",options="header"]
|===
-| Key ^(1)^ | Description | Value examples | Value if N/A
+| Key ^(1)^ | Description | Value examples | Value if N/A
| _x | Column on screen.
| "0" ... "n" |
@@ -12317,7 +12317,7 @@ Content of hashtable sent to callback (keys and values are of type "string"):
| _buffer_full_name | Full name of buffer.
| "core.weechat", "irc.libera.#weechat", ... | ""
-| _buffer_localvar_XXX ^(2)^ | Local variables of buffer.
+| _buffer_localvar_XXX ^(2)^ | Local variables of buffer.
| any value | not set
| _chat | Chat area indicator.
@@ -12326,16 +12326,16 @@ Content of hashtable sent to callback (keys and values are of type "string"):
| _chat_line | Pointer to line _(WeeChat ≥ 1.2)_.
| "0x1234abcd" | ""
-| _chat_line_x | Column in line ^(3)^.
+| _chat_line_x | Column in line ^(3)^.
| "0" ... "n" | "-1"
-| _chat_line_y | Line number ^(3)^.
+| _chat_line_y | Line number ^(3)^.
| "0" ... "n" | "-1"
| _chat_line_date | Line date/time.
| "1313237175" | "0"
-| _chat_line_date_printed | Line date/time ^(4)^.
+| _chat_line_date_printed | Line date/time ^(4)^.
| "1313237175" | "0"
| _chat_line_time | Time displayed.
@@ -12394,7 +12394,7 @@ Extra info for bar item "buffer_nicklist":
[width="100%",cols="^1,^1,5",options="header"]
|===
-| Plugin ^(1)^ | Key | Description
+| Plugin ^(1)^ | Key | Description
| irc | irc_nick | Pointer to IRC nick _(WeeChat ≥ 3.0)_.
| irc | irc_host | Host for nick (if known).
| weechat | nick | Nick name.
diff --git a/doc/en/weechat_scripting.en.adoc b/doc/en/weechat_scripting.en.adoc
index dde5dcfc8..9056027ea 100644
--- a/doc/en/weechat_scripting.en.adoc
+++ b/doc/en/weechat_scripting.en.adoc
@@ -1307,7 +1307,7 @@ The result is a hashtable with following keys
[width="100%",cols="3,^2,10,7",options="header"]
|===
-| Key | Since WeeChat ^(1)^ | Description | Example
+| Key | Since WeeChat ^(1)^ | Description | Example
| tags | 0.4.0
| The tags in message (can be empty).
diff --git a/doc/en/weechat_user.en.adoc b/doc/en/weechat_user.en.adoc
index 7859f8a8c..e57c889ca 100644
--- a/doc/en/weechat_user.en.adoc
+++ b/doc/en/weechat_user.en.adoc
@@ -108,14 +108,14 @@ WeeChat:
[width="100%",cols="5,^3,.^15",options="header"]
|===
-| Package ^(1)^ | Version | Feature
+| Package ^(1)^ | Version | Feature
| C compiler (gcc / clang) | | Build.
| cmake | ≥ 3.0 | Build (autotools still possible, but CMake is recommended).
| pkg-config | | Detect installed libraries.
-| libncursesw5-dev ^(2)^ | | Ncurses interface.
+| libncursesw5-dev ^(2)^ | | Ncurses interface.
| libcurl4-gnutls-dev | | URL transfer.
| libgcrypt20-dev | | Secured data, IRC SASL authentication.
-| libgnutls28-dev | ≥ 2.2.0 ^(3)^ | SSL connection to IRC server, support of SSL in relay plugin, IRC SASL authentication (ECDSA-NIST256P-CHALLENGE).
+| libgnutls28-dev | ≥ 2.2.0 ^(3)^ | SSL connection to IRC server, support of SSL in relay plugin, IRC SASL authentication (ECDSA-NIST256P-CHALLENGE).
| zlib1g-dev | | Compression of messages (WeeChat -> client) with https://zlib.net/[zlib ^↗^,window=_blank] in relay plugin (weechat protocol), script plugin.
| libzstd-dev | | Compression of messages (WeeChat -> client) with https://facebook.github.io/zstd/[Zstandard ^↗^,window=_blank] in relay plugin (weechat protocol).
|===
@@ -134,12 +134,12 @@ WeeChat:
[width="100%",cols="5,^3,.^15",options="header"]
|===
-| Package ^(1)^ | Version | Feature
+| Package ^(1)^ | Version | Feature
| {cpp} compiler (pass:[g++ / clang++]) | | Build and run tests, JavaScript plugin.
| gettext | | Internationalization (translation of messages; base language is English).
| ca-certificates | | Certificates for SSL connections.
| libaspell-dev / libenchant-dev | | Spell plugin.
-| python3-dev ^(2)^ | | Python plugin.
+| python3-dev ^(2)^ | | Python plugin.
| libperl-dev | | Perl plugin.
| ruby2.7, ruby2.7-dev | ≥ 1.9.1 | Ruby plugin.
| liblua5.4-dev | | Lua plugin.
@@ -728,26 +728,26 @@ The WeeChat directories are:
[width="100%",cols="1m,3",options="header"]
|===
-| Path ^(1)^ | Description
+| Path ^(1)^ | Description
| ~/.config/weechat/ | WeeChat configuration files: `*.conf`, certificates, etc.
| ~/.local/share/weechat/ | WeeChat data files: logs, scripts, scripts data, xfer files, etc.
|    logs/ | Log files (one file per buffer).
|    python/ | Python scripts.
-|       autoload/ | Python scripts auto-loaded on startup ^(2)^.
+|       autoload/ | Python scripts auto-loaded on startup ^(2)^.
|    perl/ | Perl scripts.
-|       autoload/ | Perl scripts auto-loaded on startup ^(2)^.
+|       autoload/ | Perl scripts auto-loaded on startup ^(2)^.
|    ruby/ | Ruby scripts.
-|       autoload/ | Ruby scripts auto-loaded on startup ^(2)^.
+|       autoload/ | Ruby scripts auto-loaded on startup ^(2)^.
|    lua/ | Lua scripts.
-|       autoload/ | Lua scripts auto-loaded on startup ^(2)^.
+|       autoload/ | Lua scripts auto-loaded on startup ^(2)^.
|    tcl/ | Tcl scripts.
-|       autoload/ | Tcl scripts auto-loaded on startup ^(2)^.
+|       autoload/ | Tcl scripts auto-loaded on startup ^(2)^.
|    guile/ | Guile scripts.
-|       autoload/ | Guile scripts auto-loaded on startup ^(2)^.
+|       autoload/ | Guile scripts auto-loaded on startup ^(2)^.
|    javascript/ | JavaScript scripts.
-|       autoload/ | JavaScript scripts auto-loaded on startup ^(2)^.
+|       autoload/ | JavaScript scripts auto-loaded on startup ^(2)^.
|    php/ | PHP scripts.
-|       autoload/ | PHP scripts auto-loaded on startup ^(2)^.
+|       autoload/ | PHP scripts auto-loaded on startup ^(2)^.
| ~/.cache/weechat/ | WeeChat cache files: scripts cache.
| /run/user/1000/weechat/ | WeeChat runtime files: FIFO pipe, Relay UNIX sockets.
|===
@@ -1274,10 +1274,10 @@ Tags commonly used (non-exhaustive list):
| no_highlight | No highlight is possible on line.
| no_log | Line is not written in log file.
| log0 … log9 | Level of log for line (see `/help logger`).
-| notify_none | The line must not be added to hotlist. ^(1)^
-| notify_message | The line is a user message. ^(1)^
-| notify_private | The line is a private message. ^(1)^
-| notify_highlight | The line is a message with highlight. ^(1)^
+| notify_none | The line must not be added to hotlist. ^(1)^
+| notify_message | The line is a user message. ^(1)^
+| notify_private | The line is a private message. ^(1)^
+| notify_highlight | The line is a message with highlight. ^(1)^
| self_msg | Self message.
| nick_xxx | Message is from nick "xxx".
| prefix_nick_ccc | Prefix is a nick with color "ccc".
@@ -1707,7 +1707,7 @@ These mouse actions are possible only if mouse is enabled with key kbd:[Alt+m]
[width="100%",cols="^.^3,^.^3,^.^3,.^8,.^8",options="header"]
|===
-| Button/Wheel ^(1)^ | Gesture | Area | Description | Command
+| 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+`
@@ -1759,7 +1759,7 @@ These keys and actions are used on the fset buffer (see <<fset,Fset plugin>>).
[width="100%",cols="^.^3,^.^2,.^8,.^5",options="header"]
|===
-| Key | Action ^(1)^ | Description | Command
+| 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+`
@@ -1805,7 +1805,7 @@ These keys and actions are used on the script buffer (see <<script_manager,scrip
[width="100%",cols="^.^3,^.^2,.^8,.^5",options="header"]
|===
-| Key | Action ^(1)^ | Description | Command
+| 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+`
@@ -3885,8 +3885,8 @@ when replying to CTCP:
| Code | Description | Value/example
| $clientinfo | List of supported CTCP | `+ACTION DCC CLIENTINFO FINGER PING SOURCE TIME USERINFO VERSION+`
| $version | WeeChat version | `+0.4.0-dev+`
-| $versiongit | WeeChat version + Git version ^(1)^ | `+0.4.0-dev (git: v0.3.9-104-g7eb5cc4)+`
-| $git | Git version ^(1)^ | `+v0.3.9-104-g7eb5cc4+`
+| $versiongit | WeeChat version + Git version ^(1)^ | `+0.4.0-dev (git: v0.3.9-104-g7eb5cc4)+`
+| $git | Git version ^(1)^ | `+v0.3.9-104-g7eb5cc4+`
| $compilation | WeeChat compilation date | `+Dec 16 2012+`
| $osinfo | Info about OS | `+Linux 2.6.32-5-amd64 / x86_64+`
| $site | WeeChat site | `+https://weechat.org/+`
@@ -4755,7 +4755,7 @@ type:
[width="100%",cols="2,3,7",options="header"]
|===
-| Hook | Default variable | Update allowed ^(1)^
+| Hook | Default variable | Update allowed ^(1)^
| signal | tg_signal_data |
| hsignal | |
| modifier | tg_string | tg_string
@@ -4971,7 +4971,7 @@ Variables set using tags in message:
| tg_tag_prefix_nick | string | Color of nick in prefix (from tag "prefix_nick_ccc").
| tg_tag_host | string | User name and host, format: username@host (from tag "host_xxx").
| tg_tag_notify | string | Notify level (_none_, _message_, _private_, _highlight_).
-| tg_tag_irc_xxx | string | IRC message tag (key "xxx"). ^(1)^
+| tg_tag_irc_xxx | string | IRC message tag (key "xxx"). ^(1)^
| tg_notify | string | Notify level, if different from _none_.
| tg_msg_pv | string | "1" for a private message, otherwise "0".
|===
@@ -5013,7 +5013,7 @@ Variables set using tags in message:
| tg_tag_prefix_nick | string | Color of nick in prefix (from tag "prefix_nick_ccc").
| tg_tag_host | string | User name and host, format: username@host (from tag "host_xxx").
| tg_tag_notify | string | Notify level (_none_, _message_, _private_, _highlight_).
-| tg_tag_irc_xxx | string | IRC message tag (key "xxx"). ^(1)^
+| tg_tag_irc_xxx | string | IRC message tag (key "xxx"). ^(1)^
| tg_notify | string | Notify level, if different from _none_.
| tg_msg_pv | string | "1" for a private message, otherwise "0".
|===