Tha_14/toxic
1
0
Fork 0
mirror of https://github.com/Tha14/toxic.git synced 2024-11-16 06:53:03 +01:00
Code Issues Projects Releases Wiki Activity
76c21c8b34
toxic/README.md
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

3.6 KiB
Raw Blame History

Toxic Build Status

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

Toxic Screenshot

Installation

Dependencies

Base
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

  1. cd build/
  2. make PREFIX="/where/to/install"
  3. 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.