To start Profanity, run the following at the command line:
To see options available to the command:
$ profanity -h
The user interface is split into four main areas:
Shows the title for the current window (usually the contact you are chatting with, or the chat room you have joined), and your current presence.
Main window area
Used to show the current active window. The first window (1) is reserved for the 'console' where system messages and command responses are shown.
Shows the time, the user you are logged in as, and status of each window. If a window is used, its number will appear, if it has new messages of any kind, the number will be highlighted. The current window is shown as -1-.
Where commands and messages are entered. Commands and command arguments can be autocompleted with the tab key.
All commands start with a
/ character e.g.:
To make a window visible in the main window area, use any of the following:
/win command may also be used. Either the window number may be passed, or the window title:
To close the current window:
To connect to an XMPP chat service:
You will be prompted by the status bar to enter your password.
/connect command for additional arguments that may be used when connecting.
One to one chat
To open a new window and send a message use the
/msg firstname.lastname@example.org Hello there!
Profanity uses the contact's nickname by default, if one exists. For example:
/msg Bob Are you there bob?
Once a window is opened with the contact, messages can be sent by just typing them in the input window:
Hows it going?
To join a chat room, use the
Once a window is opened for the room, messages can be sent by just typing them in the input window:
See the chat Chat room guide for more detail.
To add someone to your roster:
/roster add email@example.com
To subscribe to a contacts presence (to be notified when they are online/offline etc):
/sub request firstname.lastname@example.org
To approve a contact's request to subscribe to your presence:
/sub allow email@example.com
/sub commands for more detail.
Changing your presence
To change your presence, use the following commands:
/away /xa /chat /online /dnd
Each of these commands accepts a message as a parameter, so to show the message "I'm very busy" to your contacts when setting status to Do Not Disturb:
/dnd I'm very busy
To log out from the current chat service:
To quit profanity: