Profanity Illustration

User Guide

Installation Guide

Contents

Linux/FreeBSD

ALT packages.altlinux.org
Arch archlinux.org
aur.archlinux.org
Debian packages.debian.org
Exherbo git.exherbo.org
Funtoo funtoo.org
Gentoo gpo.zugaina.org
github.com maxrp
OpenSUSE software.opensuse.org
Slackware slackbuilds.org
Ubuntu packages.ubuntu.org
FreeBSD www.freebsd.org

To add to this list, submit a pull request to the website source, or email the Mailing list with details.

Mac OS X

Homebrew

To install profanity using homebrew:

brew install profanity

Desktop notifications are an optional (disabled by default) dependency since terminal-notifier is not available on all versions of OSX. To attempt to install the formula with desktop notification support:

brew install profanity --with-terminal-notifier

To ensure you have all features supported profanity -v should show the following:

Desktop notification support: Enabled
OTR support: Enabled
PGP support: Enabled
C plugins: Enabled
Python plugins: Enabled

To install the latest development version, use the tap supplied by robsalasco at Github available here:

brew tap robsalasco/homebrew-profanity
brew install profanity --HEAD

Macports

A howto using macports has also been written by louiecaulfield at Github available here.

Windows

Install Cygwin

Install Cygwin by downloading and running:

64Bit: http://cygwin.com/setup-x86_64.exe

32bit: http://cygwin.com/setup-x86.exe

Dependencies

wget and unzip are required to install Profanity. When running setup.exe, search for and add them when asked to select packages.

Note: To make use of OTR support on Cygwin, the libotr-devel package is requirted which is not currently in the official repositories. libotr-devel can be found in the Cygwin Ports project.

Download and Install

Download the zip archive from the homepage and extract, then download the install script and run it in the project directory:

wget http://www.profanity.im/profanity-0.5.1.zip
unzip profanity-0.5.1.zip
cd profanity-0.5.1
wget http://www.profanity.im/install-all.sh
chmod u+x install-all.sh
./install-all.sh

Android

Profanity is included as a Termux package on Android. Install Termux from the Google Play App store.

Update the package list and install Profanity:

apt update
apt install profanity

Helper script

A helper script has been written to install all required and optional dependencies and run the above steps. This script currently supports Ubuntu, Fedora, Centos, OpenSuse and Cygwin.

Download the script into the project directory and run it:

wget http://www.profanity.im/install-all.sh
chmod u+x install-all.sh
./install-all.sh

Manual install

Profanity uses the autotools for installation from source.

After downloading the archive from the homepage, and extracting it, use the following commands to install:

./configure
make
make install

The final step requires root privileges.

If you cloned the git repository rather than downloading a released version, an additional step is required to generate the ./configure script:

./bootstrap.sh
./configure
make
make install

Various dependencies are required to install Profanity, the ./configure script will fail if the minimum dependencies cannot be found.

The latest code in master is also kept up to date with development changes to libmesode/libstrophe, so a manual build of this library may also be needed, see the README at libmesode.

Dependencies

The package names below are from Ubuntu and may differ per distribution.

Build dependencies:

automake
autoconf
autoconf-archive
libtool
pkg-config

Required dependencies:

Profanity can be built against either libstrophe, or libmesode. Libmesode has a few extra features around manual TLS certificate verification. Version 0.5.1 of Profanity requires version 0.9.x of libstrophe or libmesode.

Profanity also requires:

libncursesw5-dev
libglib2.0-dev
libcurl3-dev
libreadline-dev

Optional dependencies:

libnotify-dev  # Desktop notification support
libxss-dev     # Desktop idle time autoaway support
libotr5-dev    # OTR support
libgpgme11-dev # PGP support
libgtk2.0-dev  # Desktop tray icon support
python-dev     # Python plugin support
libcmocka-dev  # To run tests