mirror of https://github.com/Tha14/toxic.git synced 2024-07-01 16:27:45 +02:00

A Tox-based instant messaging and video chat client

Go to file

Loui Chang 0a132b0eb5 doc: Unlink docs from the rest of the build process. Since generated man pages are also included, we can't guarantee proper timestamps. This should fix issues that trigger doc building when it isn't needed. Signed-off-by: Loui Chang <louipc.ist@gmail.com>		2014-10-12 23:21:48 -04:00
build	doc: Unlink docs from the rest of the build process.	2014-10-12 23:21:48 -04:00
cfg	doc: Unlink docs from the rest of the build process.	2014-10-12 23:21:48 -04:00
doc	update settings and docs with peerlist-toggle keybinding	2014-10-08 03:08:08 -04:00
misc	update DHTnodes	2014-10-08 14:44:15 -04:00
sounds	replace call sounds	2014-10-01 19:38:09 -04:00
src	prompt: Add version line to startup message.	2014-10-12 23:12:56 -04:00
.gitignore	Update .gitignore: remove autotools	2014-06-24 12:37:43 +02:00
.travis.yml	add asciidoc and libnotify-dev to install script	2014-09-29 01:54:53 -04:00
COPYING	Put back license	2014-06-24 17:48:49 +02:00
README.md	doc: Unlink docs from the rest of the build process.	2014-10-12 23:21:48 -04:00

README.md

Toxic

Toxic is a Tox-based instant messenging client which formerly resided in the Tox core repository, and is now available as a standalone application.

Installation

Dependencies

Base

libtoxcore
ncurses (for Debian based systems, 'libncursesw5-dev')
libconfig (for Debian based systems, 'libconfig-dev')

Audio

libtoxav (libtoxcore compiled with audio support)
openal (for Debian based systems, 'libopenal-dev')

Sound notifications

openal (for Debian based systems, 'libopenal-dev')
openalut (for Debian based systems, 'libalut-dev')

Desktop notifications

libnotify (for Debian based systems, 'libnotify-dev')

Documentation

Asciidoc (only required for regenerating manpages)
- Run make doc in the build directory after editing the asciidoc files to regenerate the manpages.
- NOTE FOR DEVELOPERS: asciidoc files and generated manpages will need to be commited together.

Compiling

cd build/
make PREFIX="/where/to/install"
sudo make install PREFIX="/where/to/install"

Compilation Notes

You can add specific flags to the Makefile with USER_CFLAGS="" and/or USER_LDFLAGS=""
You can pass your own flags to the Makefile with CFLAGS="" and/or LDFLAGS="" (this will supersede the default ones)
Additional features are automatically enabled if all dependencies are found, but you can disable them by using special variables:
- DISABLE_X11=1 → build toxic without X11 support (needed for focus tracking)
- DISABLE_AV=1 → build toxic without audio call support
- DISABLE_SOUND_NOTIFY=1 → build toxic without sound notifications support
- DISABLE_DESKTOP_NOTIFY=1 → build toxic without desktop notifications support

Packaging

For packaging purpose, you can use DESTDIR="" to specify a directory where to store installed files
DESTDIR="" can be used in addition to PREFIX="":
- DESTDIR="" is meant to specify a directory where to store installed files (ex: "/tmp/build/pkg")
- PREFIX="" is meant to specify a prefix directory for binaries and data files (ex: "/usr/local")

Troubleshooting

If your default prefix is "/usr/local" and you receive the following:

error while loading shared libraries: libtoxcore.so.0: cannot open shared object file: No such file or directory

you can attempt to correct it by running sudo ldconfig. If that doesn't work, run:

echo '/usr/local/lib/' | sudo tee -a /etc/ld.so.conf.d/locallib.conf
sudo ldconfig

Precompiled binaries

You can download precompiled binaries from jenkins:

Settings

Running Toxic for the first time creates an empty file called toxic.conf in your home configuration directory ("~/.config/tox" for Linux users). Adding options to this file allows you to enable auto-logging, change the time format (12/24 hour), and much more. You can view our example config file here.