From 124f76454617a0f297d6fd6634aaa39d4356ccc6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?H=C3=A5vard=20Pettersson?= Date: Sat, 11 Oct 2014 13:16:18 +0200 Subject: [PATCH] Updated README. --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9b3ba94..315f7e8 100644 --- a/README.md +++ b/README.md @@ -11,10 +11,10 @@ Installation Tox-WeeChat requires [WeeChat][1] >= 1.0.1, [SQLite][5] >= 3.6.19 and the latest-ish [libtoxcore][6]. It also requires CMake to be built. Installation is fairly simple; after getting the source, compile and install using CMake: $ mkdir build && cd build - $ cmake -DHOME_FOLDER_INSTALL=ON .. + $ cmake -DPLUGIN_PATH=~/.weechat/plugins .. $ make install -This installs the plugin binary `tox.so` to the recommended location `~/.weechat/plugins`. Without the home folder flag, the binary is placed in `/usr/local/lib/weechat/plugins`. Installing to a custom WeeChat folder or elsewhere is achieved by setting `INSTALL_PATH`. +This installs the plugin binary `tox.so` to the recommended location `~/.weechat/plugins`. The default location is `/usr/local/lib/weechat/plugins`. Usage ----- @@ -26,7 +26,7 @@ Usage - To add friends or respond to friend requests, `/help friend` will get you started. - Message a friend with `/msg `. Get their friend number with `/friend list`. -Run `/help -listfull tox` to get a list of all available commands. +Run `/help -listfull tox` to get a list of all available commands, and `/set tox.*` for a list of options. ### Common issues @@ -36,6 +36,9 @@ Tox allows names up to 128 bytes long. To prevent long names from taking all you - `weechat.look.prefix_align_max` - `buffers.look.name_size_max` (if using buffers.pl) +#### Tox won't connect through my proxy +Make sure the address and port is correct, and that UDP is disabled (`/set tox.profile.*.udp`). + TODO ---- - Tox DNS