2017-01-28 17:24:22 +00:00
|
|
|
.TH Profanity 1 "January 2017" "Profanity XMPP client"
|
2012-08-19 19:34:05 +00:00
|
|
|
.SH NAME
|
2012-11-21 22:33:07 +00:00
|
|
|
Profanity \- a simple console based XMPP chat client.
|
2012-08-19 19:34:05 +00:00
|
|
|
.SH SYNOPSIS
|
|
|
|
|
.B profanity
|
2015-10-17 23:17:45 +00:00
|
|
|
[\-vh] [\-l level] [\-a account]
|
2012-08-19 19:34:05 +00:00
|
|
|
.SH DESCRIPTION
|
|
|
|
|
.B Profanity
|
2015-01-12 22:56:24 +00:00
|
|
|
is a simple lightweight console based XMPP chat client. Its emphasis is
|
2012-11-21 22:33:07 +00:00
|
|
|
on having a simple and configurable command driven UI, see the homepage
|
2012-08-21 23:33:22 +00:00
|
|
|
at:
|
|
|
|
|
.br
|
|
|
|
|
.PP
|
2012-11-21 22:33:07 +00:00
|
|
|
<http://www.profanity.im>
|
2012-08-19 19:34:05 +00:00
|
|
|
.SH OPTIONS
|
|
|
|
|
.TP
|
|
|
|
|
.BI "\-v, \-\-version"
|
2015-02-10 23:30:21 +00:00
|
|
|
Show version and build information.
|
2012-08-19 19:34:05 +00:00
|
|
|
.TP
|
|
|
|
|
.BI "\-h, \-\-help"
|
|
|
|
|
Show help on command line arguments.
|
|
|
|
|
.TP
|
2015-02-10 23:30:21 +00:00
|
|
|
.BI "\-a, \-\-account "ACCOUNT
|
|
|
|
|
Auto connect to an account on startup,
|
|
|
|
|
.I ACCOUNT
|
|
|
|
|
must be an existing account.
|
2014-04-23 21:43:05 +00:00
|
|
|
.TP
|
2015-02-10 23:30:21 +00:00
|
|
|
.BI "\-l, \-\-log "LEVEL
|
2012-08-19 19:34:05 +00:00
|
|
|
Set the logging level,
|
|
|
|
|
.I LEVEL
|
|
|
|
|
may be set to DEBUG, INFO (the default), WARN or ERROR.
|
2012-08-19 20:14:13 +00:00
|
|
|
.SH USING PROFANITY
|
2012-12-30 22:40:49 +00:00
|
|
|
The user guide can be found at <http://www.profanity.im/userguide.html>.
|
2012-08-19 19:34:05 +00:00
|
|
|
.SH SEE ALSO
|
|
|
|
|
.B Profanity
|
|
|
|
|
itself has a lot of built\-in help. Check the /help command for more information.
|
2012-08-19 19:35:53 +00:00
|
|
|
Type "/help help" for information on how to use help itself.
|
2012-08-19 19:34:05 +00:00
|
|
|
.SH CONFIGURATION
|
|
|
|
|
Configuration for
|
|
|
|
|
.B Profanity
|
|
|
|
|
is stored in
|
2012-11-25 22:05:00 +00:00
|
|
|
.I $XDG_CONFIG_HOME/profanity/profrc
|
2016-05-10 17:51:17 +00:00
|
|
|
, details on commands for configuring Profanity can be found at <http://www.profanity.im/reference.html>.
|
2012-08-19 19:34:05 +00:00
|
|
|
.PP
|
2012-08-21 23:30:24 +00:00
|
|
|
.SH BUGS
|
2015-02-10 23:30:21 +00:00
|
|
|
Bugs can either be reported by raising an issue at the Github issue tracker:
|
2012-08-21 23:30:24 +00:00
|
|
|
.br
|
|
|
|
|
.PP
|
2015-02-10 23:30:21 +00:00
|
|
|
<https://github.com/boothj5/profanity/issues>
|
2012-08-21 23:30:24 +00:00
|
|
|
.br
|
|
|
|
|
.PP
|
|
|
|
|
or to the mailing list at:
|
|
|
|
|
.br
|
|
|
|
|
.PP
|
|
|
|
|
<https://groups.google.com/forum/#!forum/profanitydev>
|
|
|
|
|
.br
|
|
|
|
|
.PP
|
2015-02-10 23:30:21 +00:00
|
|
|
or by sending a mail directly to:
|
|
|
|
|
.br
|
|
|
|
|
.PP
|
|
|
|
|
<boothj5web@gmail.com>
|
2012-08-21 23:30:24 +00:00
|
|
|
.br
|
|
|
|
|
.PP
|
|
|
|
|
.SH LICENSE
|
2017-01-28 17:24:22 +00:00
|
|
|
Copyright (C) 2012 \- 2017 James Booth <boothj5web@gmail.com>.
|
2016-07-21 10:49:52 +00:00
|
|
|
License GPLv3+: GNU GPL version 3 or later <https://www.gnu.org/licenses/gpl.html>
|
2012-08-21 23:30:24 +00:00
|
|
|
This is free software; you are free to change and redistribute it.
|
|
|
|
|
There is NO WARRANTY, to the extent permitted by law.
|
2012-08-19 19:34:05 +00:00
|
|
|
.SH AUTHORS/CREDITS
|
|
|
|
|
.B Profanity
|
|
|
|
|
was written by James Booth
|
2012-08-21 23:30:24 +00:00
|
|
|
.B <boothj5web@gmail.com>
|
2014-03-09 00:54:41 +00:00
|
|
|
with many contributions from others, see the full list at: <https://github.com/boothj5/profanity/graphs/contributors>
|
