2012-06-19 00:02:18 +00:00
Profanity
=========
2012-02-09 00:51:41 +00:00
2012-06-19 00:02:21 +00:00
Profanity is a console based jabber client inspired by [Irssi ](http://www.irssi.org/ ),
2012-05-20 13:14:38 +00:00
2012-06-19 00:02:18 +00:00
Installation
------------
2012-07-09 23:56:57 +00:00
For a full install guide from scratch, including how to install dependencies see [the wiki install guide ](https://github.com/boothj5/profanity/wiki/Installation-guide ).
2012-06-19 00:02:18 +00:00
Dependencies: ncurses, libstrophe, glib, expat, xml2 and openssl.
2012-07-04 22:20:25 +00:00
Optional Dependencies: libnotify
2012-06-19 00:02:21 +00:00
Libstrophe can be found at: https://github.com/metajack/libstrophe
2012-06-19 00:02:18 +00:00
2012-06-19 00:02:21 +00:00
To run unit tests requires head-unit: https://github.com/boothj5/head-unit
2012-02-03 01:36:57 +00:00
2012-06-19 00:02:18 +00:00
All other dependencies should have packages for your distribution.
Once depdendencies have been installed, run:
2012-07-04 22:20:25 +00:00
./bootstrap.sh
./configure
2012-06-19 00:02:18 +00:00
make
To build and install in the current directory.
2012-07-04 22:20:25 +00:00
If you wish to install on the system, switch to root, or sudo and:
make install
2012-07-08 21:57:53 +00:00
To run tests:
make check
2012-06-19 00:02:18 +00:00
Running
-------
2012-07-19 23:43:17 +00:00
Usage:
profanity [OPTION...]
2012-06-19 00:02:18 +00:00
2012-07-19 23:43:17 +00:00
Help Options:
-h, --help Show help options
Application Options:
-v, --version Show version information
-d, --disable-tls Disable TLS
2012-06-19 00:02:18 +00:00
2012-07-19 23:43:17 +00:00
Some older jabber servers advertise SSL/TLS support but don't respond to the handshake,
if you have trouble connecting, run with the `--disable-tls` option:
2012-06-19 00:02:18 +00:00
Preferences
-----------
User preferences are stored in
2012-07-19 21:28:48 +00:00
~/.profanity/config
2012-06-19 00:02:18 +00:00
The following example is described below:
[ui]
beep=false
flash=true
showsplash=true
2012-07-04 22:00:03 +00:00
notify=true
2012-06-19 00:02:18 +00:00
[connections]
logins=mylogin@jabber.org;otherlogin@gmail.com
[colours]
bkgnd=default
text=white
online=green
offline=red
err=red
inc=yellow
bar=green
bar_draw=black
bar_text=black
2012-06-19 00:02:21 +00:00
The `[ui]` section contains preferences for user interface behaviour:
2012-06-19 00:02:18 +00:00
2012-06-19 00:02:21 +00:00
beep: Try to sound beep on incoming messages if the terminal supports it
flash: Try to make the terminal flash on incoming messages if the terminal supports it
2012-07-04 22:00:03 +00:00
notify: Send a desktop notification on incoming messages
2012-06-19 00:02:18 +00:00
showsplash: Show the ascii logo on startup
2012-06-19 00:02:21 +00:00
The `[connections]` section contains a history of logins you've used already, so profanity can autocomplete them for you.
This section is populated automatically when you login with a new username.
2012-06-19 00:02:18 +00:00
2012-06-19 00:02:21 +00:00
The `[colours]` sections allows you to theme profanity. Available colours are
2012-06-19 00:02:18 +00:00
black, white, red, green, blue, yellow, cyan, magenta
2012-06-19 00:02:21 +00:00
Setting a colour to `default` , lets the terminal use whatever default it would use for foreground/background depending on the setting.
2012-06-19 00:02:18 +00:00
Using
-----
2012-06-19 00:02:21 +00:00
Commands in profanity all start with `/` .
2012-06-19 00:02:18 +00:00
2012-06-19 00:02:21 +00:00
To get a list of possible commands, and find out how to navigate around try:
2012-06-19 00:02:18 +00:00
/help
2012-08-16 23:19:58 +00:00
Links
-----
Homepage: http://www.boothj5.com/profanity.shtml
Mailing List: https://groups.google.com/forum/#!forum/profanitydev
