1
0
mirror of https://github.com/profanity-im/profanity.git synced 2024-07-14 18:14:15 -04:00
profanity/docs/profanity.1

78 lines
2.1 KiB
Groff
Raw Normal View History

2015-02-10 18:16:09 -05:00
.TH Profanity 1 "February 2015" "Profanity XMPP client"
2012-08-19 15:34:05 -04:00
.SH NAME
Profanity \- a simple console based XMPP chat client.
2012-08-19 15:34:05 -04:00
.SH SYNOPSIS
.B profanity
2015-02-10 18:30:21 -05:00
[\-vhd] [\-l level] [\-a account]
2012-08-19 15:34:05 -04:00
.SH DESCRIPTION
.B Profanity
2015-01-12 17:56:24 -05:00
is a simple lightweight console based XMPP chat client. Its emphasis is
on having a simple and configurable command driven UI, see the homepage
2012-08-21 19:33:22 -04:00
at:
.br
.PP
<http://www.profanity.im>
2012-08-19 15:34:05 -04:00
.SH OPTIONS
.TP
.BI "\-v, \-\-version"
2015-02-10 18:30:21 -05:00
Show version and build information.
2012-08-19 15:34:05 -04:00
.TP
.BI "\-h, \-\-help"
Show help on command line arguments.
.TP
2015-02-10 18:30:21 -05:00
.BI "\-a, \-\-account "ACCOUNT
Auto connect to an account on startup,
.I ACCOUNT
must be an existing account.
.TP
.BI "\-d, \-\-disable\-tls"
2012-08-19 15:34:05 -04:00
Disable TLS for servers that either don't support it, or claim to but do not
complete the handshake.
.TP
2015-02-10 18:30:21 -05:00
.BI "\-l, \-\-log "LEVEL
2012-08-19 15:34:05 -04:00
Set the logging level,
.I LEVEL
may be set to DEBUG, INFO (the default), WARN or ERROR.
2012-08-19 16:14:13 -04:00
.SH USING PROFANITY
2012-12-30 17:40:49 -05:00
The user guide can be found at <http://www.profanity.im/userguide.html>.
2012-08-19 15:34:05 -04:00
.SH SEE ALSO
.B Profanity
itself has a lot of built\-in help. Check the /help command for more information.
2012-08-19 15:35:53 -04:00
Type "/help help" for information on how to use help itself.
2012-08-19 15:34:05 -04:00
.SH CONFIGURATION
Configuration for
.B Profanity
is stored in
2012-11-25 17:05:00 -05:00
.I $XDG_CONFIG_HOME/profanity/profrc
2012-12-30 17:40:49 -05:00
, details on configuring Profanity can be found at <http://www.profanity.im/configuration.html>.
2012-08-19 15:34:05 -04:00
.PP
.SH BUGS
2015-02-10 18:30:21 -05:00
Bugs can either be reported by raising an issue at the Github issue tracker:
.br
.PP
2015-02-10 18:30:21 -05:00
<https://github.com/boothj5/profanity/issues>
.br
.PP
or to the mailing list at:
.br
.PP
<https://groups.google.com/forum/#!forum/profanitydev>
.br
.PP
2015-02-10 18:30:21 -05:00
or by sending a mail directly to:
.br
.PP
<boothj5web@gmail.com>
.br
.PP
.SH LICENSE
2015-02-10 18:16:09 -05:00
Copyright (C) 2012 \- 2015 James Booth <boothj5web@gmail.com>.
License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>
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 15:34:05 -04:00
.SH AUTHORS/CREDITS
.B Profanity
was written by James Booth
.B <boothj5web@gmail.com>
2014-03-08 19:54:41 -05:00
with many contributions from others, see the full list at: <https://github.com/boothj5/profanity/graphs/contributors>