toxic/INSTALL.md

Installation

• Dependencies
  • OS X Notes
• Compiling
  • Documentation
• Notes
  • Compilation variables
  • Packaging

Dependencies

Name	Needed by	Debian package
Tox Core	BASE	None
NCurses	BASE	libncursesw5-dev
LibConfig	BASE	libconfig-dev
GNUmake	BASE	make
libcurl	BASE	libcurl4-openssl-dev
libqrencode	BASE	libqrencode-dev
Tox Core AV	AUDIO	None
OpenAL	AUDIO, SOUND NOTIFICATIONS	libopenal-dev
OpenALUT	SOUND NOTIFICATIONS	libalut-dev
LibNotify	DESKTOP NOTIFICATIONS	libnotify-dev
Python 3	PYTHON	python3-dev
AsciiDoc	DOCUMENTATION1	asciidoc

¹: see Documentation

OS X Notes

Using Homebrew:

brew install openal-soft freealut libconfig
brew install --HEAD https://raw.githubusercontent.com/Tox/homebrew-tox/master/Formula/libtoxcore.rb
brew install libnotify

You can omit libnotify if you intend to build without desktop notifications enabled.

Compiling

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

Documentation

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.
NOTE FOR EVERYONE: asciidoc (and this step) is only required for regenerating manpages when you modify them.

Notes

Compilation variables

• 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
• Features excluded from the default build must be explicitly enabled using special variables:
  • ENABLE_PYTHON=1 → build toxic with Python scripting 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")