mirror of
https://github.com/profanity-im/profanity.git
synced 2024-11-03 19:37:16 -05:00
Updated README
This commit is contained in:
parent
50d02eebd4
commit
0736127790
87
README
87
README
@ -1,10 +1,87 @@
|
||||
Ncurses based Irssi inspired Jabber client.
|
||||
Profanity
|
||||
=========
|
||||
|
||||
Requires ncurses, libstrophe and glib.
|
||||
Profanity is a console based jabber client inspired by Irssi,
|
||||
|
||||
Requires head-unit to run tests:
|
||||
Installation
|
||||
------------
|
||||
|
||||
Dependencies: ncurses, libstrophe, glib, expat, xml2 and openssl.
|
||||
|
||||
Libstrophe can be found at:
|
||||
|
||||
https://github.com/metajack/libstrophe
|
||||
|
||||
To run unit tests requires head-unit:
|
||||
|
||||
https://github.com/boothj5/head-unit
|
||||
|
||||
Run with -notls if the Jabber server doesn't
|
||||
properly support it
|
||||
All other dependencies should have packages for your distribution.
|
||||
|
||||
Once depdendencies have been installed, run:
|
||||
|
||||
make
|
||||
|
||||
To build and install in the current directory.
|
||||
|
||||
Running
|
||||
-------
|
||||
|
||||
./profanity
|
||||
|
||||
Some older jabber servers advertise SSL/TLS support but don't respond to the handshake,
|
||||
if you have trouble connecting, run with the -notls option:
|
||||
|
||||
./profanity -notls
|
||||
|
||||
Preferences
|
||||
-----------
|
||||
|
||||
User preferences are stored in
|
||||
|
||||
~/.profanity
|
||||
|
||||
The following example is described below:
|
||||
|
||||
[ui]
|
||||
beep=false
|
||||
flash=true
|
||||
showsplash=true
|
||||
|
||||
[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
|
||||
|
||||
The [ui] section contains preferences for user interface behaviour:
|
||||
|
||||
beep: Try to sound beep on incomming messages if the terminal supports it
|
||||
flash: Try to make the terminal flash on incomming messages if the terminal supports it
|
||||
showsplash: Show the ascii logo on startup
|
||||
|
||||
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 new usernames.
|
||||
|
||||
The [colours] sections allows you to theme profanity. Available colours are
|
||||
|
||||
black, white, red, green, blue, yellow, cyan, magenta
|
||||
|
||||
Setting a colour to default, lets the terminal use whatever default it would use for foreground/background depending on the setting.
|
||||
|
||||
Using
|
||||
-----
|
||||
|
||||
Commands in profanity all start with '/'.
|
||||
|
||||
To get a list of possible commands, and find our how to navigate around try:
|
||||
|
||||
/help
|
||||
|
Loading…
Reference in New Issue
Block a user