Contents
Base Directories
The XDG base directory specification is used for base configuration and data directories.
The environment variables $XDG_CONFIG_HOME and $XDG_DATA_HOME will be used and a directory named profanity will be created in each.
As per the specification, if $XDG_CONFIG_HOME is not present or unset, $HOME/.config will be used. If $XDG_DATA_HOME is not present or unset, $HOME/.local/share will be used.
For the rest of this document the following names will be used:
$CONFIG_HOME = $XDG_CONFIG_HOME/profanity
$DATA_HOME = $XDG_DATA_HOME/profanity
Configuration File
The main configuration file for profanity is stored at:
$CONFIG_HOME/profrc
Profanity Log File
The Profanity log is at:
$DATA_HOME/logs/profanity.log
Chat Logs Directory
If chat logging is enabled, chat logs will be stored in the following directory:
$DATA_HOME/chatlogs
A directory exists per account, and within each of these directories is a directory per contact containing dated logs.
If chat room logging is also enabled, a rooms directory will also be within the account directory.
User Defined Themes Directory
User defined theme files are stored in the following directory:
$CONFIG_HOME/themes
Accounts file
User accounts are stored in the following file:
$DATA_HOME/accounts
Examples
Assuming a user called eddie, and default values for $XDG_CONFIG_HOME and $XDG_DATA_HOME are used, the following example shows where files are stored:
/home/eddie/.config/profanity/profrc |
Configuration file |
/home/eddie/.config/profanity/themes/ |
Theme files |
/home/eddie/.local/share/profanity/logs/profanity.log |
Main log file |
/home/eddie/.local/share/profanity/chatlogs/ |
Chat logs |
/home/eddie/.local/share/profanity/accounts |
Accounts file |