summaryrefslogtreecommitdiff
path: root/doc/en
diff options
context:
space:
mode:
authorSebastien Helleu <flashcode@flashtux.org>2008-11-23 23:04:52 +0100
committerSebastien Helleu <flashcode@flashtux.org>2008-11-23 23:04:52 +0100
commit2e52e54a3afa953e12e1e009b19a66202f0674a6 (patch)
tree08fa64e1c2b89498977ae33004f62c1757288910 /doc/en
parent09bed16dbd39791b43f86a1c00279c7fdb5cbb58 (diff)
downloadweechat-2e52e54a3afa953e12e1e009b19a66202f0674a6.zip
Add support for more than one proxy, with proxy selection for each IRC server (task #6859)
Diffstat (limited to 'doc/en')
-rw-r--r--doc/en/autogen/irc_options.xml10
-rw-r--r--doc/en/autogen/weechat_commands.xml71
-rw-r--r--doc/en/autogen/weechat_options.xml70
3 files changed, 68 insertions, 83 deletions
diff --git a/doc/en/autogen/irc_options.xml b/doc/en/autogen/irc_options.xml
index 9f1c267eb..941df7596 100644
--- a/doc/en/autogen/irc_options.xml
+++ b/doc/en/autogen/irc_options.xml
@@ -376,6 +376,16 @@
</listitem>
</itemizedlist>
+<command>irc.server_default.proxy</command>: proxy used for this server (optional)
+<itemizedlist>
+ <listitem>
+ <para>type: string</para>
+ </listitem>
+ <listitem>
+ <para>values: any string (default value: '')</para>
+ </listitem>
+</itemizedlist>
+
<command>irc.server_default.realname</command>: real name to use on IRC server
<itemizedlist>
<listitem>
diff --git a/doc/en/autogen/weechat_commands.xml b/doc/en/autogen/weechat_commands.xml
index cba63982e..b8a04b624 100644
--- a/doc/en/autogen/weechat_commands.xml
+++ b/doc/en/autogen/weechat_commands.xml
@@ -6,7 +6,7 @@
docgen.pl builds XML doc files to include in many languages
-->
-<command>/bar [add barname type[,cond1,cond2,...] position size separator item1,item2,...] | [default] | [del barname|-all] | [set barname option value] | [hide|show barname] | [scroll barname buffer scroll_value] | [list] | [listitems]</command>
+<command>/bar [add barname type[,cond1,cond2,...] position size separator item1,item2,...] | [default] | [del barname|-all] | [set barname option value] | [hide|show barname] | [scroll barname buffer scroll_value] | [list] | [listfull] | [listitems]</command>
<programlisting>
manage bars
@@ -189,6 +189,35 @@ autoload: autoload plugins in system or user directory
Without argument, this command lists loaded plugins.
</programlisting>
+<command>/proxy [add proxyname type address port [username [password]]] | [del proxyname|-all] | [set proxyname option value] | [list]</command>
+<programlisting>
+manage proxies
+
+ add: add a new proxy
+ proxyname: name of proxy (must be unique)
+ type: http, socks4 or socks5
+ address: IP or hostname
+ port: port
+ username: username (optional)
+ password: password (optional)
+ del: delete a proxy (or all proxies with -all)
+ set: set a value for a proxy property
+ option: option to change (for options list, look at /set weechat.proxy.&lt;proxyname&gt;.*)
+ value: new value for option
+ list: list all proxies
+
+Examples:
+ create a http proxy, running on local host, port 8888:
+ /proxy add local http 127.0.0.1 8888
+ create a http proxy using IPv6 protocol:
+ /proxy add local http 127.0.0.1 8888
+ /proxy set local ipv6 on
+ create a socks5 proxy with username/password:
+ /proxy add myproxy socks5 sample.host.org 3128 myuser mypass
+ delete a proxy:
+ /proxy del myproxy
+</programlisting>
+
<command>/quit</command>
<programlisting>
quit WeeChat
@@ -245,23 +274,39 @@ show WeeChat uptime
-o: send uptime on current channel as an IRC message
</programlisting>
-<command>/window [list | -1 | +1 | b# | up | down | left | right | splith [pct] | splitv [pct] | resize pct | merge [all]]</command>
+<command>/window [list | -1 | +1 | b# | up | down | left | right | splith [pct] | splitv [pct] | resize pct | merge [all] | page_up | page_down | scroll | scroll_up | scroll_down | scroll_top | scroll_bottom | scroll_previous_highlight | scroll_next_highlight ]</command>
<programlisting>
manage windows
list: list open windows (no parameter implies this list)
- -1: jump to previous window
- +1: jump to next window
- b#: jump to next window displaying buffer number #
- up: switch to window above current one
- down: switch to window below current one
- left: switch to window on the left
- right: switch to window on the right
-splith: split current window horizontally
-splitv: split current window vertically
-resize: resize window size, new size is &lt;pct&gt; percentage of parent window
- merge: merge window with another (all = keep only one window)
+ -1: jump to previous window
+ +1: jump to next window
+ b#: jump to next window displaying buffer number #
+ up: switch to window above current one
+ down: switch to window below current one
+ left: switch to window on the left
+ right: switch to window on the right
+ splith: split current window horizontally
+ splitv: split current window vertically
+ resize: resize window size, new size is &lt;pct&gt; percentage of parent window
+ merge: merge window with another (all = keep only one window)
+
+ page_up: scroll one page up
+ page_down: scroll one page down
+ scroll: scroll number of lines (+/-N) or with time: s=seconds, m=minutes, h=hours, d=days, M=months, y=years
+ scroll_up: scroll a few lines up
+ scroll_down: scroll a few lines down
+ scroll_top: scroll to top of buffer
+scroll_bottom: scroll to bottom of buffer
+scroll_previous_highlight: scroll to previous highlight
+scroll_next_highlight: scroll to next highlight
+ refresh: refresh screen
For splith and splitv, pct is a percentage which represents size of new window, computed with current window as size reference. For example 25 means create a new window with size = current_size / 4
+
+Examples:
+ jump to window displaying buffer #1: /window b1 scroll 2 lines up: /window scroll -2
+ scroll 2 days up: /window scroll -2d
+ scroll to beginning of current day: /window scroll -d
</programlisting>
diff --git a/doc/en/autogen/weechat_options.xml b/doc/en/autogen/weechat_options.xml
index d130b5ff2..58e2f98ac 100644
--- a/doc/en/autogen/weechat_options.xml
+++ b/doc/en/autogen/weechat_options.xml
@@ -1076,76 +1076,6 @@
</listitem>
</itemizedlist>
-<command>weechat.proxy.address</command>: proxy server address (IP or hostname)
-<itemizedlist>
- <listitem>
- <para>type: string</para>
- </listitem>
- <listitem>
- <para>values: any string (default value: '')</para>
- </listitem>
-</itemizedlist>
-
-<command>weechat.proxy.ipv6</command>: connect to proxy using ipv6
-<itemizedlist>
- <listitem>
- <para>type: boolean</para>
- </listitem>
- <listitem>
- <para>values: on, off (default value: off)</para>
- </listitem>
-</itemizedlist>
-
-<command>weechat.proxy.password</command>: password for proxy server
-<itemizedlist>
- <listitem>
- <para>type: string</para>
- </listitem>
- <listitem>
- <para>values: any string (default value: '')</para>
- </listitem>
-</itemizedlist>
-
-<command>weechat.proxy.port</command>: port for connecting to proxy server
-<itemizedlist>
- <listitem>
- <para>type: integer</para>
- </listitem>
- <listitem>
- <para>values: 0 .. 65535 (default value: 3128)</para>
- </listitem>
-</itemizedlist>
-
-<command>weechat.proxy.type</command>: proxy type (http (default), socks4, socks5)
-<itemizedlist>
- <listitem>
- <para>type: integer</para>
- </listitem>
- <listitem>
- <para>values: http, socks4, socks5 (default value: http)</para>
- </listitem>
-</itemizedlist>
-
-<command>weechat.proxy.use</command>: use a proxy server
-<itemizedlist>
- <listitem>
- <para>type: boolean</para>
- </listitem>
- <listitem>
- <para>values: on, off (default value: off)</para>
- </listitem>
-</itemizedlist>
-
-<command>weechat.proxy.username</command>: username for proxy server
-<itemizedlist>
- <listitem>
- <para>type: string</para>
- </listitem>
- <listitem>
- <para>values: any string (default value: '')</para>
- </listitem>
-</itemizedlist>
-
<command>weechat.startup.command_after_plugins</command>: command executed when WeeChat starts, after loading plugins
<itemizedlist>
<listitem>