diff options
Diffstat (limited to 'doc/en')
| -rw-r--r-- | doc/en/autogen/user/irc_commands.asciidoc | 3 | ||||
| -rw-r--r-- | doc/en/autogen/user/irc_options.asciidoc | 5 | ||||
| -rw-r--r-- | doc/en/weechat_faq.en.asciidoc | 15 | ||||
| -rw-r--r-- | doc/en/weechat_user.en.asciidoc | 24 |
4 files changed, 37 insertions, 10 deletions
diff --git a/doc/en/autogen/user/irc_commands.asciidoc b/doc/en/autogen/user/irc_commands.asciidoc index 739ecd474..804ac5fab 100644 --- a/doc/en/autogen/user/irc_commands.asciidoc +++ b/doc/en/autogen/user/irc_commands.asciidoc @@ -89,8 +89,9 @@ Without argument, this command display ban list for current channel. server: server name, which can be: - internal server name (created by /server add, recommended usage) - - hostname/port or IP/port (this will create a TEMPORARY server), port is 6667 by default + - hostname/port or IP/port, port is 6667 by default - URL with format: irc[6][s]://[nickname[:password]@]irc.example.org[:port][/#channel1][,#channel2[...]] + Note: for an address/IP/URL, a temporary server is created (NOT SAVED), see /help irc.look.temporary_servers option: set option for server (for boolean option, value can be omitted) nooption: set boolean option to 'off' (for example: -nossl) -all: connect to all servers defined in configuration diff --git a/doc/en/autogen/user/irc_options.asciidoc b/doc/en/autogen/user/irc_options.asciidoc index f376a6612..a98d627bb 100644 --- a/doc/en/autogen/user/irc_options.asciidoc +++ b/doc/en/autogen/user/irc_options.asciidoc @@ -343,6 +343,11 @@ ** type: boolean ** values: on, off (default value: `on`) +* [[option_irc.look.temporary_servers]] *irc.look.temporary_servers* +** description: `enable creation of temporary servers with command /connect` +** type: boolean +** values: on, off (default value: `off`) + * [[option_irc.look.topic_strip_colors]] *irc.look.topic_strip_colors* ** description: `strip colors in topic (used only when displaying buffer title)` ** type: boolean diff --git a/doc/en/weechat_faq.en.asciidoc b/doc/en/weechat_faq.en.asciidoc index e5b9dbe2c..c34a824fa 100644 --- a/doc/en/weechat_faq.en.asciidoc +++ b/doc/en/weechat_faq.en.asciidoc @@ -51,6 +51,21 @@ This package is built almost every day using git repository. Note that this package may not correspond exactly to git base and that it's less convenient than git cloning for installing updates. +[[compile_osx]] +=== How can I install WeeChat on OS X? + +It is recommended to use http://brew.sh/[Homebrew], you can get help with: + +---- +brew info weechat +---- + +You can install WeeChat with this command: + +---- +brew install weechat --with-python --with-perl +---- + [[lost]] === I've launched WeeChat, but I'm lost, what can I do? diff --git a/doc/en/weechat_user.en.asciidoc b/doc/en/weechat_user.en.asciidoc index 98566bbc7..0e0144392 100644 --- a/doc/en/weechat_user.en.asciidoc +++ b/doc/en/weechat_user.en.asciidoc @@ -43,9 +43,9 @@ WeeChat homepage is here: http://weechat.org/ In order to install WeeChat, you need: * a running GNU/Linux system (with compiler tools for source - package), or compatible OS + package), or a compatible OS * 'root' privileges (to install WeeChat in a system directory) -* ncurses library +* some libraries (see <<dependencies,dependencies>>). [[install]] == Installation @@ -74,6 +74,11 @@ instructions. WeeChat can be compiled with cmake or autotools (cmake is recommended way). +[NOTE] +On OS X, you can use http://brew.sh/[Homebrew]: +`brew install weechat --with-python --with-perl` +(for help: `brew info weechat`). + [[dependencies]] ==== Dependencies @@ -84,18 +89,19 @@ compile WeeChat. |=== | Package ^(1)^ | Version | Required | Feature | cmake | | *yes* | Build (autotools still possible, but cmake is recommended) +| pkg-config | | *yes* | Detect installed libraries | libncursesw5-dev ^(2)^ | | *yes* | Ncurses interface | libcurl4-gnutls-dev | | *yes* | URL transfer | zlib1g-dev | | *yes* | Compression of packets in relay plugin (weechat protocol), script plugin -| libgcrypt11-dev | | *yes* | Secured data, IRC SASL authentication (DH-BLOWFISH/DH-AES), script plugin -| libgnutls-dev | ≥ 2.2.0 | | SSL connection to IRC server, support of SSL in relay plugin +| libgcrypt20-dev | | *yes* | Secured data, IRC SASL authentication (DH-BLOWFISH/DH-AES), script plugin +| libgnutls28-dev | ≥ 2.2.0 | | SSL connection to IRC server, support of SSL in relay plugin | gettext | | | Internationalization (translation of messages; base language is English) | ca-certificates | | | Certificates for SSL connections | libaspell-dev or libenchant-dev | | | Aspell plugin | python-dev | ≥ 2.5 ^(3)^ | | Python plugin | libperl-dev | | | Perl plugin -| ruby1.9.1-dev | ≥ 1.8 | | Ruby plugin -| liblua5.1-0-dev | | | Lua plugin +| ruby2.1-dev | ≥ 1.8 | | Ruby plugin +| liblua5.2-dev | | | Lua plugin | tcl-dev | ≥ 8.5 | | Tcl plugin | guile-2.0-dev | ≥ 2.0 | | Guile (scheme) plugin | asciidoc | ≥ 8.5.0 | | Build man page and documentation @@ -504,7 +510,7 @@ Bar 'status' has following default items: |=== | Item | Example | Description | time | `[12:55]` | Time -| buffer_count | `[6]` | Number of opened buffers +| buffer_last_number | `[6]` | Number of last buffer in list | buffer_plugin | `[irc/freenode]` | Plugin of current buffer (irc plugin can add IRC server name used by buffer) | buffer_number | `3` | Current buffer number | buffer_name | `#test` | Current buffer name @@ -512,10 +518,10 @@ Bar 'status' has following default items: | buffer_nicklist_count | `{4}` | Number of nicks in nicklist | buffer_zoom | ! | `!` means the merged buffer is zoomed (only this one is displayed), empty value means all merged buffers are displayed | buffer_filter | `*` | Filtering indicator: `*` means some lines are filtered (hidden), empty value means all lines are displayed +| scroll | `-MORE(50)-` | Scroll indicator, with number of lines below last line displayed | lag | `[Lag: 2.5]` | Lag indicator, in seconds (hidden if lag is low) | hotlist | `[H: 4:#abc(2,5), 6]` | List of buffers with activity (unread messages) (in example, 2 highlights and 5 unread messages on '#abc', one unread message on buffer #6) | completion | `abc(2) def(5)` | List of words for completion, with number of possible completions for each word -| scroll | `-MORE(50)-` | Scroll indicator, with number of lines below last line displayed |=== Bar 'input' has following default items: @@ -523,10 +529,10 @@ Bar 'input' has following default items: [width="100%",cols="^3,^6,8",options="header"] |=== | Item | Example | Description -| input_paste | `[Paste 7 lines ? [ctrl-Y] Yes [ctrl-N] No]` | Question to user for pasting lines | input_prompt | `[@Flashy(i)]` | Input prompt, for irc: nick and modes (mode "+i" means invisible on freenode) | away | `(away)` | Away indicator | input_search | `[Search (~ str,msg)]` | Search indicator ("`~`": case insensitive, "`==`": case sensitive, "`str`": search string, "`regex`": search regular expression, "`msg`": search in messages, "`pre`": search in prefixes, "`pre\|msg`": search in prefixes and messages) +| input_paste | `[Paste 7 lines ? [ctrl-Y] Yes [ctrl-N] No]` | Question to user for pasting lines | input_text | `hi peter!` | Input text |=== |