aniani
/
profanity
mirror of https://github.com/profanity-im/profanity.git
1
0
Fork 0
Code

Start new cycle

pull/1876/head
Michael Vetter 2023-08-03 08:06:05 +02:00
parent 6b0fddd925
commit b223b7ebac
105 changed files with 1 additions and 6169 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
configure.ac
View File

@ -24,7 +24,7 @@ AS_CASE([$target_os],
AM_INIT_AUTOMAKE([foreign subdir-objects])
PACKAGE_STATUS="release"
PACKAGE_STATUS="development"
## Get git branch and revision if in development
if test "x$PACKAGE_STATUS" = xdevelopment; then

12
docs/profanity-about.1
View File

@ -1,12 +0,0 @@
.TH man 1 "2023-08-03" "0.13.1" "Profanity XMPP client"
.SH NAME
/about
.SH DESCRIPTION
Show version and license information.
.SH SYNOPSIS
/about
.LP

388
docs/profanity-account.1
View File

@ -1,388 +0,0 @@
.TH man 1 "2023-08-03" "0.13.1" "Profanity XMPP client"
.SH NAME
/account
.SH DESCRIPTION
Commands for creating and managing accounts. Calling with no arguments will display information for the current account.
.SH SYNOPSIS
/account
.LP
/account list
.LP
/account show <account>
.LP
/account enable|disable <account>
.LP
/account default set <account>
.LP
/account default off
.LP
/account add <account>
.LP
/account remove <account>
.LP
/account rename <account> <newaccount>
.LP
/account set <account> jid <jid>
.LP
/account set <account> server <server>
.LP
/account set <account> port <port>
.LP
/account set <account> status <presence>
.LP
/account set <account> status last
.LP
/account set <account> <presence> <priority>
.LP
/account set <account> resource <resource>
.LP
/account set <account> password <password>
.LP
/account set <account> eval_password <command>
.LP
/account set <account> muc <service>
.LP
/account set <account> nick <nick>
.LP
/account set <account> otr <policy>
.LP
/account set <account> pgpkeyid <pgpkeyid>
.LP
/account set <account> startscript <script>
.LP
/account set <account> clientid "<name> <version>"
.LP
/account set <account> tls force|allow|trust|legacy|disable
.LP
/account set <account> auth default|legacy
.LP
/account set <account> theme <theme>
.LP
/account set <account> session_alarm <max_sessions>
.LP
/account clear <account> password
.LP
/account clear <account> eval_password
.LP
/account clear <account> server
.LP
/account clear <account> port
.LP
/account clear <account> otr
.LP
/account clear <account> pgpkeyid
.LP
/account clear <account> startscript
.LP
/account clear <account> clientid
.LP
/account clear <account> muc
.LP
/account clear <account> resource
.LP
/account clear <account> session_alarm
.LP
.SH ARGUMENTS
.PP
\fBlist\fR
.RS 4
List all accounts.
.RE
.PP
\fBenable <account>\fR
.RS 4
Enable the account, it will be used for autocompletion.
.RE
.PP
\fBshow <account>\fR
.RS 4
Show details for the specified account.
.RE
.PP
\fBdisable <account>\fR
.RS 4
Disable the account.
.RE
.PP
\fBdefault set <account>\fR
.RS 4
Set the default account, used when no argument passed to the /connect command.
.RE
.PP
\fBdefault off\fR
.RS 4
Clear the default account setting.
.RE
.PP
\fBadd <account>\fR
.RS 4
Create a new account.
.RE
.PP
\fBremove <account>\fR
.RS 4
Remove an account.
.RE
.PP
\fBrename <account> <newaccount>\fR
.RS 4
Rename 'account' to 'newaccount'.
.RE
.PP
\fBset <account> jid <jid>\fR
.RS 4
Set the Jabber ID for the account, account name will be used if not set.
.RE
.PP
\fBset <account> server <server>\fR
.RS 4
The chat server, if different to the domainpart of the JID.
.RE
.PP
\fBset <account> port <port>\fR
.RS 4
The port used for connecting if not the default (5222, or 5223 for SSL).
.RE
.PP
\fBset <account> status <presence>\fR
.RS 4
The presence status to use on login.
.RE
.PP
\fBset <account> status last\fR
.RS 4
Use your last status before logging out, when logging in.
.RE
.PP
\fBset <account> <presence> <priority>\fR
.RS 4
Set the priority (-128..127) to use for the specified presence.
.RE
.PP
\fBset <account> resource <resource>\fR
.RS 4
The resource to be used for this account, defaults to 'profanity'.
.RE
.PP
\fBset <account> password <password>\fR
.RS 4
Password for the account, note this is currently stored in plaintext if set.
.RE
.PP
\fBset <account> eval_password <command>\fR
.RS 4
Shell command evaluated to retrieve password for the account. Can be used to retrieve password from keyring.
.RE
.PP
\fBset <account> muc <service>\fR
.RS 4
The default MUC chat service to use, defaults to the servers disco info response.
.RE
.PP
\fBset <account> nick <nick>\fR
.RS 4
The default nickname to use when joining chat rooms.
.RE
.PP
\fBset <account> otr <policy>\fR
.RS 4
Override global OTR policy for this account, see /otr.
.RE
.PP
\fBset <account> pgpkeyid <pgpkeyid>\fR
.RS 4
Set the ID of the PGP key for this account, see /pgp.
.RE
.PP
\fBset <account> startscript <script>\fR
.RS 4
Set the script to execute after connecting.
.RE
.PP
\fBset <account> clientid "<name> <version>"\fR
.RS 4
Set XMPP client name for discovery according to XEP-0092. For privacy geeks. Recommendation to leave as is.
.RE
.PP
\fBset <account> tls force\fR
.RS 4
Force TLS connection, and fail if one cannot be established, this is default behaviour.
.RE
.PP
\fBset <account> tls allow\fR
.RS 4
Use TLS for the connection if it is available.
.RE
.PP
\fBset <account> tls trust\fR
.RS 4
Force TLS connection and trust server's certificate.
.RE
.PP
\fBset <account> tls legacy\fR
.RS 4
Use legacy TLS for the connection. It means server doesn't support STARTTLS and TLS is forced just after TCP connection is established.
.RE
.PP
\fBset <account> tls disable\fR
.RS 4
Disable TLS for the connection.
.RE
.PP
\fBset <account> auth default\fR
.RS 4
Use default authentication process.
.RE
.PP
\fBset <account> auth legacy\fR
.RS 4
Allow legacy authentication.
.RE
.PP
\fBset <account> theme <theme>\fR
.RS 4
Set the UI theme for the account.
.RE
.PP
\fBset <account> session_alarm <max_sessions>\fR
.RS 4
Alarm about suspicious activity if sessions count exceeds max_sessions.
.RE
.PP
\fBclear <account> server\fR
.RS 4
Remove the server setting for this account.
.RE
.PP
\fBclear <account> port\fR
.RS 4
Remove the port setting for this account.
.RE
.PP
\fBclear <account> password\fR
.RS 4
Remove the password setting for this account.
.RE
.PP
\fBclear <account> eval_password\fR
.RS 4
Remove the eval_password setting for this account.
.RE
.PP
\fBclear <account> otr\fR
.RS 4
Remove the OTR policy setting for this account.
.RE
.PP
\fBclear <account> pgpkeyid\fR
.RS 4
Remove pgpkeyid associated with this account.
.RE
.PP
\fBclear <account> startscript\fR
.RS 4
Remove startscript associated with this account.
.RE
.PP
\fBclear <account> clientid\fR
.RS 4
Reset client's name to default.
.RE
.PP
\fBclear <account> theme\fR
.RS 4
Clear the theme setting for the account, the global theme will be used.
.RE
.PP
\fBclear <account> resource\fR
.RS 4
Remove the resource setting for this account.
.RE
.PP
\fBclear <account> muc\fR
.RS 4
Remove the default MUC service setting.
.RE
.PP
\fBclear <account> session_alarm\fR
.RS 4
Disable the session alarm.
.RE
.SH EXAMPLES
/account add me
.LP
/account set me jid ulfhednar@valhalla.edda
.LP
/account set me server talk.chat.com
.LP
/account set me port 5111
.LP
/account set me muc chatservice.mycompany.com
.LP
/account set me nick dennis
.LP
/account set me status dnd
.LP
/account set me dnd -1
.LP
/account set me clientid "Profanity 0.42 (Dev)"
.LP
/account rename me chattyme
.LP
/account clear me pgpkeyid
.LP

43
docs/profanity-affiliation.1
View File

@ -1,43 +0,0 @@
.TH man 1 "2023-08-03" "0.13.1" "Profanity XMPP client"
.SH NAME
/affiliation
.SH DESCRIPTION
Manage room affiliations. Affiliation may be one of owner, admin, member, outcast or none.
.SH SYNOPSIS
/affiliation set <affiliation> <jid> [<reason>]
.LP
/affiliation list [<affiliation>]
.LP
/affiliation request
.LP
/affiliation register
.LP
.SH ARGUMENTS
.PP
\fBset <affiliation> <jid> [<reason>]\fR
.RS 4
Set the affiliation of user with jid, with an optional reason.
.RE
.PP
\fBlist [<affiliation>]\fR
.RS 4
List all users with the specified affiliation, or all if none specified.
.RE
.PP
\fBrequest\fR
.RS 4
Request voice.
.RE
.PP
\fBregister\fR
.RS 4
Register your nickname with the MUC.
.RE

52
docs/profanity-alias.1
View File

@ -1,52 +0,0 @@
.TH man 1 "2023-08-03" "0.13.1" "Profanity XMPP client"
.SH NAME
/alias
.SH DESCRIPTION
Add, remove or list command aliases.
.SH SYNOPSIS
/alias list
.LP
/alias add <name> <value>
.LP
/alias remove <name>
.LP
.SH ARGUMENTS
.PP
\fBlist\fR
.RS 4
List all aliases.
.RE
.PP
\fBadd <name> <value>\fR
.RS 4
Add a new command alias.
.RE
.PP
\fBremove <name>\fR
.RS 4
Remove a command alias.
.RE
.SH EXAMPLES
/alias add friends /who online friends
.LP
/alias add /q /quit
.LP
/alias add a /away "I'm in a meeting."
.LP
/alias remove q
.LP
/alias list
.LP

93
docs/profanity-autoaway.1
View File

@ -1,93 +0,0 @@
.TH man 1 "2023-08-03" "0.13.1" "Profanity XMPP client"
.SH NAME
/autoaway
.SH DESCRIPTION
Manage autoaway settings for idle time.
.SH SYNOPSIS
/autoaway mode idle|away|off
.LP
/autoaway time away|xa <minutes>
.LP
/autoaway message away|xa <message>|off
.LP
/autoaway check on|off
.LP
.SH ARGUMENTS
.PP
\fBmode idle\fR
.RS 4
Sends idle time, status remains online.
.RE
.PP
\fBmode away\fR
.RS 4
Sends away and xa presence as well as idle time.
.RE
.PP
\fBmode off\fR
.RS 4
Disabled (default).
.RE
.PP
\fBtime away <minutes>\fR
.RS 4
Number of minutes before the away presence is sent, default: 15.
.RE
.PP
\fBtime xa <minutes>\fR
.RS 4
Number of minutes before the xa presence is sent, default: 0 (disabled).
.RE
.PP
\fBmessage away <message>\fR
.RS 4
Optional message to send with the away presence, default: off (disabled).
.RE
.PP
\fBmessage xa <message>\fR
.RS 4
Optional message to send with the xa presence, default: off (disabled).
.RE
.PP
\fBmessage away off\fR
.RS 4
Send no message with away presence.
.RE
.PP
\fBmessage xa off\fR
.RS 4
Send no message with xa presence.
.RE
.PP
\fBcheck on|off\fR
.RS 4
When enabled, checks for activity and sends online presence, default: on.
.RE
.SH EXAMPLES
/autoaway mode away
.LP
/autoaway time away 30
.LP
/autoaway message away Away from computer for a while
.LP
/autoaway time xa 120
.LP
/autoaway message xa Away from computer for a very long time
.LP
/autoaway check off
.LP

35
docs/profanity-autoconnect.1
View File

@ -1,35 +0,0 @@
.TH man 1 "2023-08-03" "0.13.1" "Profanity XMPP client"
.SH NAME
/autoconnect
.SH DESCRIPTION
Enable or disable autoconnect on start up. The setting can be overridden by the -a (--account) command line option.
.SH SYNOPSIS
/autoconnect set <account>
.LP
/autoconnect off
.LP
.SH ARGUMENTS
.PP
\fBset <account>\fR
.RS 4
Connect with account on start up.
.RE
.PP
\fBoff\fR
.RS 4
Disable autoconnect.
.RE
.SH EXAMPLES
/autoconnect set ulfhednar@valhalla.edda
.LP
/autoconnect off
.LP

27
docs/profanity-autoping.1
View File

@ -1,27 +0,0 @@
.TH man 1 "2023-08-03" "0.13.1" "Profanity XMPP client"
.SH NAME
/autoping
.SH DESCRIPTION
Set the interval between sending ping requests to the server to ensure the connection is kept alive.
.SH SYNOPSIS
/autoping set <seconds>
.LP
/autoping timeout <seconds>
.LP
.SH ARGUMENTS
.PP
\fBset <seconds>\fR
.RS 4
Number of seconds between sending pings, a value of 0 disables autoping.
.RE
.PP
\fBtimeout <seconds>\fR
.RS 4
Seconds to wait for autoping responses, after which the connection is considered broken.
.RE

57
docs/profanity-avatar.1
View File

@ -1,57 +0,0 @@
.TH man 1 "2023-08-03" "0.13.1" "Profanity XMPP client"
.SH NAME
/avatar
.SH DESCRIPTION
Upload an avatar for yourself, disable your avatar, or download a contact's avatar (XEP-0084). If nothing happens after using this command, the user either doesn't have an avatar set or doesn't use XEP-0084 to publish it.
.SH SYNOPSIS
/avatar set <path>
.LP
/avatar disable
.LP
/avatar get <barejid>
.LP
/avatar open <barejid>
.LP
.SH ARGUMENTS
.PP
\fBset <path>\fR
.RS 4
Set avatar to the image at <path>.
.RE
.PP
\fBdisable\fR
.RS 4
Disable avatar publishing; your avatar will not display to others.
.RE
.PP
\fBget <barejid>\fR
.RS 4
Download the avatar. barejid is the JID to download avatar from.
.RE
.PP
\fBopen <barejid>\fR
.RS 4
Download avatar and open it with command. See /executable.
.RE
.SH EXAMPLES
/avatar set ~/images/avatar.png
.LP
/avatar disable
.LP
/avatar get thor@valhalla.edda
.LP
/avatar open freyja@vanaheimr.edda
.LP

24
docs/profanity-ban.1
View File

@ -1,24 +0,0 @@
.TH man 1 "2023-08-03" "0.13.1" "Profanity XMPP client"
.SH NAME
/ban
.SH DESCRIPTION
Ban user from chat room.
.SH SYNOPSIS
/ban <jid> [<reason>]
.LP
.SH ARGUMENTS
.PP
\fB<jid>\fR
.RS 4
Bare JID of the user to ban from the room.
.RE
.PP
\fB<reason>\fR
.RS 4
Optional reason for banning the user.
.RE

19
docs/profanity-beep.1
View File

@ -1,19 +0,0 @@
.TH man 1 "2023-08-03" "0.13.1" "Profanity XMPP client"
.SH NAME
/beep
.SH DESCRIPTION
Switch the terminal bell on or off. The bell will sound when incoming messages are received. If the terminal does not support sounds, it may attempt to flash the screen instead.
.SH SYNOPSIS
/beep on|off
.LP
.SH ARGUMENTS
.PP
\fBon|off\fR
.RS 4
Enable or disable terminal bell.
.RE

57
docs/profanity-blocked.1
View File

@ -1,57 +0,0 @@
.TH man 1 "2023-08-03" "0.13.1" "Profanity XMPP client"
.SH NAME
/blocked
.SH DESCRIPTION
Manage blocked users (XEP-0191), calling with no arguments shows the current list of blocked users. To blog a certain user in a MUC use the following as jid: room@conference.example.org/spammy-userIt is also possible to block and report (XEP-0377) a user with the report-abuse and report-spam commands.
.SH SYNOPSIS
/blocked
.LP
/blocked add [<jid>]
.LP
/blocked report-abuse [<jid>] [<message>]
.LP
/blocked report-spam [<jid>] [<message>]
.LP
/blocked remove <jid>
.LP
.SH ARGUMENTS
.PP
\fBadd [<jid>]\fR
.RS 4
Block the specified Jabber ID. If in a chat window and no jid is specified, the current recipient will be blocked.
.RE
.PP
\fBremove <jid>\fR
.RS 4
Remove the specified Jabber ID from the blocked list.
.RE
.PP
\fBreport-abuse <jid> [<message>]\fR
.RS 4
Report the jid as abuse with an optional message to the service operator.
.RE
.PP
\fBreport-spam <jid> [<message>]\fR
.RS 4
Report the jid as spam with an optional message to the service operator.
.RE
.SH EXAMPLES
/blocked add hel@helheim.edda
.LP
/blocked report-spam hel@helheim.edda Very annoying guy
.LP
/blocked add profanity@rooms.dismail.de/spammy-user
.LP

124
docs/profanity-bookmark.1
View File

@ -1,124 +0,0 @@
.TH man 1 "2023-08-03" "0.13.1" "Profanity XMPP client"
.SH NAME
/bookmark
.SH DESCRIPTION
Manage bookmarks and join bookmarked rooms. If you are in a chat room and no arguments are supplied to `/bookmark add`, autojoin is set to "on". There is also an autojoin ignore list in case you want to autojoin in many clients but not on Profanity.
.SH SYNOPSIS
/bookmark
.LP
/bookmark list [<jid>]
.LP
/bookmark add [<room>] [nick <nick>] [password <password>] [name <roomname>] [autojoin on|off]
.LP
/bookmark update <room> [nick <nick>] [password <password>] [name <roomname>] [autojoin on|off]
.LP
/bookmark remove [<room>]
.LP
/bookmark join <room>
.LP
/bookmark invites on|off
.LP
/bookmark ignore
.LP
/bookmark ignore add <jid>
.LP
/bookmark ignore remove <jid>
.LP
.SH ARGUMENTS
.PP
\fBlist [<jid>]\fR
.RS 4
List all bookmarks. Or the details of one.
.RE
.PP
\fBadd [<room>]\fR
.RS 4
Add a bookmark, passing no room will bookmark the current room, setting autojoin to "on".
.RE
.PP
\fBremove [<room>]\fR
.RS 4
Remove a bookmark, passing no room will remove the bookmark for the current room, if one exists.
.RE
.PP
\fBupdate <room>\fR
.RS 4
Update the properties associated with a bookmark.
.RE
.PP
\fBnick <nick>\fR
.RS 4
Nickname used when joining the chat room.
.RE
.PP
\fBpassword <password>\fR
.RS 4
Password if required, may be stored in plaintext on your server.
.RE
.PP
\fBname <roomname>\fR
.RS 4
Optional name for the bookmark. By default localpart of the JID will be used.
.RE
.PP
\fBautojoin on|off\fR
.RS 4
Whether to join the room automatically on login.
.RE
.PP
\fBjoin <room>\fR
.RS 4
Join room using the properties associated with the bookmark.
.RE
.PP
\fBinvites on|off\fR
.RS 4
Whether or not to bookmark accepted room invites, defaults to 'on'.
.RE
.PP
\fBignore add <barejid>\fR
.RS 4
Add a bookmark to the autojoin ignore list.
.RE
.PP
\fBignore remove <barejid>\fR
.RS 4
Remove a bookmark from the autojoin ignore list.
.RE
.SH EXAMPLES
/bookmark add room@example.com nick YOURNICK
.LP
/bookmark join room@example.com
.LP
/bookmark update room@example.com nick NEWNICK autojoin on
.LP
/bookmark ignore room@example.com
.LP
/bookmark list
.LP
/bookmark list room@example.com
.LP
/bookmark remove room@example.com
.LP

38
docs/profanity-caps.1
View File

@ -1,38 +0,0 @@
.TH man 1 "2023-08-03" "0.13.1" "Profanity XMPP client"
.SH NAME
/caps
.SH DESCRIPTION
Find out a contacts, or room members client software capabilities. If in private chat initiated from a chat room, no parameter is required.
.SH SYNOPSIS
/caps
.LP
/caps <fulljid>|<nick>
.LP
.SH ARGUMENTS
.PP
\fB<fulljid>\fR
.RS 4
If in the console or a chat window, the full JID for which you wish to see capabilities.
.RE
.PP
\fB<nick>\fR
.RS 4
If in a chat room, nickname for which you wish to see capabilities.
.RE
.SH EXAMPLES
/caps ran@cold.sea.org/laptop
.LP
/caps ran@cold.sea.org/phone
.LP
/caps aegir
.LP

19
docs/profanity-carbons.1
View File

@ -1,19 +0,0 @@
.TH man 1 "2023-08-03" "0.13.1" "Profanity XMPP client"
.SH NAME
/carbons
.SH DESCRIPTION
Enable or disable message carbons. Message carbons ensure that both sides of all conversations are shared with all the user's clients that implement this protocol.
.SH SYNOPSIS
/carbons on|off
.LP
.SH ARGUMENTS
.PP
\fBon|off\fR
.RS 4
Enable or disable message carbons.
.RE

12
docs/profanity-changepassword.1
View File

@ -1,12 +0,0 @@
.TH man 1 "2023-08-03" "0.13.1" "Profanity XMPP client"
.SH NAME
/changepassword
.SH DESCRIPTION
Change password of logged in account
.SH SYNOPSIS
/changepassword
.LP

12
docs/profanity-charset.1
View File

@ -1,12 +0,0 @@
.TH man 1 "2023-08-03" "0.13.1" "Profanity XMPP client"
.SH NAME
/charset
.SH DESCRIPTION
Display information about the current character set supported by the terminal.
.SH SYNOPSIS
/charset
.LP

33
docs/profanity-clear.1
View File

@ -1,33 +0,0 @@
.TH man 1 "2023-08-03" "0.13.1" "Profanity XMPP client"
.SH NAME
/clear
.SH DESCRIPTION
Clear the current window. If you set persist_history you can still access the history by pressing PAGE UP.
.SH SYNOPSIS
/clear
.LP
/clear persist_history <on|off>
.LP
.SH ARGUMENTS
.PP
\fBpersist_history on|off\fR
.RS 4
Whether or not to clear the screen persistently.
.RE
.SH EXAMPLES
/clear
.LP
/clear persist_history
.LP
/clear persist_history on
.LP

75
docs/profanity-close.1
View File

@ -1,75 +0,0 @@
.TH man 1 "2023-08-03" "0.13.1" "Profanity XMPP client"
.SH NAME
/close
.SH DESCRIPTION
Close windows. Passing no argument closes the current window.
.SH SYNOPSIS
/close
.LP
/close <num>
.LP
/close <barejid>
.LP
/close <nick>
.LP
/close <roomjid>
.LP
/close <roomoccupantjid>
.LP
/close xmlconsole
.LP
/close all|read
.LP
.SH ARGUMENTS
.PP
\fB<num>\fR
.RS 4
Close specified window number.
.RE
.PP
\fB<barejid>\fR
.RS 4
Close chat window with contact by JID if open.
.RE
.PP
\fB<nick>\fR
.RS 4
Close chat window with contact by nickname if open.
.RE
.PP
\fB<roomjid>\fR
.RS 4
Close chat room window with roomjid if open.
.RE
.PP
\fB<roomoccupantjid>\fR
.RS 4
Close private chat roomoccupantjid if open.
.RE
.PP
\fBxmlconsole\fR
.RS 4
Close the XML Console window if open.
.RE
.PP
\fBall\fR
.RS 4
Close all windows.
.RE
.PP
\fBread\fR
.RS 4
Close all windows that have no unread messages.
.RE

35
docs/profanity-cmd.1
View File

@ -1,35 +0,0 @@
.TH man 1 "2023-08-03" "0.13.1" "Profanity XMPP client"
.SH NAME
/cmd
.SH DESCRIPTION
Execute ad hoc commands.
.SH SYNOPSIS
/cmd list [<jid>]
.LP
/cmd exec <command> [<jid>]
.LP
.SH ARGUMENTS
.PP
\fBlist\fR
.RS 4
List supported ad hoc commands.
.RE
.PP
\fBexec <command>\fR
.RS 4
Execute a command.
.RE
.SH EXAMPLES
/cmd list
.LP
/cmd exec ping
.LP

41
docs/profanity-color.1
View File

@ -1,41 +0,0 @@
.TH man 1 "2023-08-03" "0.13.1" "Profanity XMPP client"
.SH NAME
/color
.SH DESCRIPTION
Settings for consistent color generation for nicks (XEP-0392). Including corrections for Color Vision Deficiencies. Your terminal needs to support 256 colors.
.SH SYNOPSIS
/color on|off|redgreen|blue
.LP
/color own on|off
.LP
.SH ARGUMENTS
.PP
\fBon|off|redgreen|blue\fR
.RS 4
Enable or disable nick colorization for MUC nicks. 'redgreen' is for people with red/green blindness and 'blue' for people with blue blindness.
.RE
.PP
\fBown on|off\fR
.RS 4
Enable color generation for own nick. If disabled the color from the color from the theme ('me') will get used.
.RE
.SH EXAMPLES
/color off
.LP
/color on
.LP
/color blue
.LP
/color own off
.LP

98
docs/profanity-connect.1
View File

@ -1,98 +0,0 @@
.TH man 1 "2023-08-03" "0.13.1" "Profanity XMPP client"
.SH NAME
/connect
.SH DESCRIPTION
Login to a chat service. If no account is specified, the default is used if one is configured. A local account is created with the JID as it's name if it doesn't already exist. In case you want to connect to a server via SASL ANONYMOUS (c.f. XEP-0175) you can also do that.
.SH SYNOPSIS
/connect [<account>]
.LP
/connect <account> [server <server>] [port <port>] [tls force|allow|trust|legacy|disable] [auth default|legacy]
.LP
/connect <server>
.LP
.SH ARGUMENTS
.PP
\fB<account>\fR
.RS 4
The local account you wish to connect with, or a JID if connecting for the first time.
.RE
.PP
\fBserver <server>\fR
.RS 4
Supply a server if it is different to the domain part of your JID.
.RE
.PP
\fBport <port>\fR
.RS 4
The port to use if different to the default (5222, or 5223 for SSL).
.RE
.PP
\fB<server>\fR
.RS 4
Connect to said server in an anonymous way. (Be aware: There aren't many servers that support this.)
.RE
.PP
\fBtls force\fR
.RS 4
Force TLS connection, and fail if one cannot be established, this is default behaviour.
.RE
.PP
\fBtls allow\fR
.RS 4
Use TLS for the connection if it is available.
.RE
.PP
\fBtls trust\fR
.RS 4
Force TLS connection and trust server's certificate.
.RE
.PP
\fBtls legacy\fR
.RS 4
Use legacy TLS for the connection. It means server doesn't support STARTTLS and TLS is forced just after TCP connection is established.
.RE
.PP
\fBtls disable\fR
.RS 4
Disable TLS for the connection.
.RE
.PP
\fBauth default\fR
.RS 4
Default authentication process.
.RE
.PP
\fBauth legacy\fR
.RS 4
Allow legacy authentication.
.RE
.SH EXAMPLES
/connect
.LP
/connect odin@valhalla.edda
.LP
/connect odin@valhalla.edda server talk.google.com
.LP
/connect freyr@vanaheimr.edda port 5678
.LP
/connect me@localhost.test.org server 127.0.0.1 tls disable
.LP
/connect me@chatty server chatty.com port 5443
.LP
/connect server.supporting.sasl.anonymous.example
.LP

70
docs/profanity-console.1
View File

@ -1,70 +0,0 @@
.TH man 1 "2023-08-03" "0.13.1" "Profanity XMPP client"
.SH NAME
/console
.SH DESCRIPTION
Configure what is displayed in the console window when messages are received. The default is set to 'all' for all types of messages.
.SH SYNOPSIS
/console chat all|first|none
.LP
/console muc all|first|mention|none
.LP
/console private all|first|none
.LP
.SH ARGUMENTS
.PP
\fBchat all\fR
.RS 4
Indicate all new chat messages in the console.
.RE
.PP
\fBchat first\fR
.RS 4
Indicate only the first new message per chat in the console.
.RE
.PP
\fBchat none\fR
.RS 4
Do not show any new chat messages in the console window.
.RE
.PP
\fBmuc all\fR
.RS 4
Indicate all new chat room messages in the console.
.RE
.PP
\fBmuc first\fR
.RS 4
Indicate only the first new message in each room in the console.
.RE
.PP
\fBmuc mention\fR
.RS 4
Indicate only messages in which you have been mentioned in the console.
.RE
.PP
\fBmuc none\fR
.RS 4
Do not show any new chat room messages in the console window.
.RE
.PP
\fBprivate all\fR
.RS 4
Indicate all new private room messages in the console.
.RE
.PP
\fBprivate first\fR
.RS 4
Indicate only the first private room message in the console.
.RE
.PP
\fBprivate none\fR
.RS 4
Do not show any new private room messages in the console window.
.RE

12
docs/profanity-correct-editor.1
View File

@ -1,12 +0,0 @@
.TH man 1 "2023-08-03" "0.13.1" "Profanity XMPP client"
.SH NAME
/correct-editor
.SH DESCRIPTION
Spawn external editor to correct and resend the last message (XEP-0308). For more information on how to configure corrections, see: /help correction. Use /executable to set your favourite editor.
.SH SYNOPSIS
/correct-editor
.LP

19
docs/profanity-correct.1
View File

@ -1,19 +0,0 @@
.TH man 1 "2023-08-03" "0.13.1" "Profanity XMPP client"
.SH NAME
/correct
.SH DESCRIPTION
Correct and resend the last message (XEP-0308). Use tab completion to get the last sent message. For more information on how to configure corrections, see: /help correction.
.SH SYNOPSIS
/correct <message>
.LP
.SH ARGUMENTS
.PP
\fBmessage\fR
.RS 4
The corrected message.
.RE

27
docs/profanity-correction.1
View File

@ -1,27 +0,0 @@
.TH man 1 "2023-08-03" "0.13.1" "Profanity XMPP client"
.SH NAME
/correction
.SH DESCRIPTION
Settings regarding Last Message Correction (XEP-0308). Corrections will only work in MUC and regular chat windows. MUC PMs won't be allowed. For more information on how to correct messages, see: /help correct.
.SH SYNOPSIS
/correction <on>|<off>
.LP
/correction char <char>
.LP
.SH ARGUMENTS
.PP
\fBon|off\fR
.RS 4
Enable/Disable support for last message correction.
.RE
.PP
\fBchar\fR
.RS 4
Set character that will prefix corrected messages. Default: '+'.
.RE

41
docs/profanity-disco.1
View File

@ -1,41 +0,0 @@
.TH man 1 "2023-08-03" "0.13.1" "Profanity XMPP client"
.SH NAME
/disco
.SH DESCRIPTION
Find out information about an entities supported services. Calling with no arguments will query the server you are currently connected to. This includes discovering contact addresses for XMPP services (XEP-0157).
.SH SYNOPSIS
/disco info [<jid>]
.LP
/disco items [<jid>]
.LP
.SH ARGUMENTS
.PP
\fBinfo [<jid>]\fR
.RS 4
List protocols and features supported by an entity.
.RE
.PP
\fBitems [<jid>]\fR
.RS 4
List items associated with an entity.
.RE
.SH EXAMPLES
/disco info
.LP
/disco items myserver.org
.LP
/disco items conference.jabber.org
.LP
/disco info odin@valhalla.edda/laptop
.LP

12
docs/profanity-disconnect.1
View File

@ -1,12 +0,0 @@
.TH man 1 "2023-08-03" "0.13.1" "Profanity XMPP client"
.SH NAME
/disconnect
.SH DESCRIPTION
Disconnect from the current chat service.
.SH SYNOPSIS
/disconnect
.LP

12
docs/profanity-editor.1
View File

@ -1,12 +0,0 @@
.TH man 1 "2023-08-03" "0.13.1" "Profanity XMPP client"
.SH NAME
/editor
.SH DESCRIPTION
Spawn external editor to edit message. After editing the inputline may appear empty. Press enter to send the text anyways. Use /executable to set your favourite editor.
.SH SYNOPSIS
/editor
.LP

120
docs/profanity-executable.1
View File

@ -1,120 +0,0 @@
.TH man 1 "2023-08-03" "0.13.1" "Profanity XMPP client"
.SH NAME
/executable
.SH DESCRIPTION
Configure executable that should be called upon a certain command.
.SH SYNOPSIS
/executable avatar set <cmdtemplate>
.LP
/executable avatar default
.LP
/executable urlopen set <cmdtemplate>
.LP
/executable urlopen default
.LP
/executable urlsave set <cmdtemplate>
.LP
/executable urlsave default
.LP
/executable editor set <cmdtemplate>
.LP
/executable editor default
.LP
/executable vcard_photo set <cmdtemplate>
.LP
/executable vcard_photo default
.LP
.SH ARGUMENTS
.PP
\fBavatar set\fR
.RS 4
Set executable that is run by /avatar open. Use your favorite image viewer.
.RE
.PP
\fBavatar default\fR
.RS 4
Restore to default settings.
.RE
.PP
\fBurlopen set\fR
.RS 4
Set executable that is run by /url open. Takes a command template that replaces %u and %p with the URL and path respectively.
.RE
.PP
\fBurlopen default\fR
.RS 4
Restore to default settings.
.RE
.PP
\fBurlsave set\fR
.RS 4
Set executable that is run by /url save. Takes a command template that replaces %u and %p with the URL and path respectively.
.RE
.PP
\fBurlsave default\fR
.RS 4
Use the built-in download method for saving.
.RE
.PP
\fBeditor set\fR
.RS 4
Set editor to be used with /editor. Needs a terminal editor or a script to run a graphical editor.
.RE
.PP
\fBeditor default\fR
.RS 4
Restore to default settings.
.RE
.PP
\fBvcard_photo set\fR
.RS 4
Set executable that is run by /vcard photo open. Takes a command template that replaces %p with the path
.RE
.PP
\fBvcard_photo default\fR
.RS 4
Restore to default settings.
.RE
.SH EXAMPLES
/executable avatar xdg-open
.LP
/executable urlopen set "xdg-open %u"
.LP
/executable urlopen set "firefox %u"
.LP
/executable urlopen default
.LP
/executable urlsave set "wget %u -O %p"
.LP
/executable urlsave set "curl %u -o %p"
.LP
/executable urlsave default
.LP
/executable vcard_photo set "feh %p"
.LP
/executable editor set "emacsclient -t"
.LP

27
docs/profanity-export.1
View File

@ -1,27 +0,0 @@
.TH man 1 "2023-08-03" "0.13.1" "Profanity XMPP client"
.SH NAME
/export
.SH DESCRIPTION
Exports contacts to a csv file.
.SH SYNOPSIS
/export <filepath>
.LP
.SH ARGUMENTS
.PP
\fB<filepath>\fR
.RS 4
Path to the output file.
.RE
.SH EXAMPLES
/export /path/to/output.csv
.LP