diff options
Diffstat (limited to 'docs')
99 files changed, 5389 insertions, 1 deletions
diff --git a/docs/profanity-about.1 b/docs/profanity-about.1 new file mode 100644 index 00000000..56bcf3b0 --- /dev/null +++ b/docs/profanity-about.1 @@ -0,0 +1,12 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/about + +.SH DESCRIPTION +Show version and license information. + +.SH SYNOPSIS +/about + +.LP diff --git a/docs/profanity-account.1 b/docs/profanity-account.1 new file mode 100644 index 00000000..023651ac --- /dev/null +++ b/docs/profanity-account.1 @@ -0,0 +1,353 @@ +.TH man 1 "2021-09-28" "0.11.0" "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> tls force|allow|trust|legacy|disable + +.LP +/account set <account> auth default|legacy + +.LP +/account set <account> theme <theme> + +.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> muc + +.LP +/account clear <account> resource + +.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> 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>\fR +.RS 4 +Set the UI theme for the account. +.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> 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 + +.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 rename me chattyme + +.LP +/account clear me pgpkeyid + +.LP diff --git a/docs/profanity-affiliation.1 b/docs/profanity-affiliation.1 new file mode 100644 index 00000000..014b09a6 --- /dev/null +++ b/docs/profanity-affiliation.1 @@ -0,0 +1,43 @@ +.TH man 1 "2021-09-28" "0.11.0" "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 diff --git a/docs/profanity-alias.1 b/docs/profanity-alias.1 new file mode 100644 index 00000000..9ba19617 --- /dev/null +++ b/docs/profanity-alias.1 @@ -0,0 +1,52 @@ +.TH man 1 "2021-09-28" "0.11.0" "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 diff --git a/docs/profanity-autoaway.1 b/docs/profanity-autoaway.1 new file mode 100644 index 00000000..1e6be859 --- /dev/null +++ b/docs/profanity-autoaway.1 @@ -0,0 +1,93 @@ +.TH man 1 "2021-09-28" "0.11.0" "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 diff --git a/docs/profanity-autoconnect.1 b/docs/profanity-autoconnect.1 new file mode 100644 index 00000000..829333e4 --- /dev/null +++ b/docs/profanity-autoconnect.1 @@ -0,0 +1,35 @@ +.TH man 1 "2021-09-28" "0.11.0" "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 diff --git a/docs/profanity-autoping.1 b/docs/profanity-autoping.1 new file mode 100644 index 00000000..0e76afdf --- /dev/null +++ b/docs/profanity-autoping.1 @@ -0,0 +1,27 @@ +.TH man 1 "2021-09-28" "0.11.0" "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 diff --git a/docs/profanity-avatar.1 b/docs/profanity-avatar.1 new file mode 100644 index 00000000..67fd7c2f --- /dev/null +++ b/docs/profanity-avatar.1 @@ -0,0 +1,35 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/avatar + +.SH DESCRIPTION +Download avatar (XEP-0084) for a certain contact. If nothing happens after using this command the user either doesn't have an avatar set at all or doesn't use XEP-0084 to publish it. + +.SH SYNOPSIS +/avatar get <barejid> + +.LP +/avatar open <barejid> + +.LP + +.SH ARGUMENTS +.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. +.RE + +.SH EXAMPLES +/avatar get thor@valhalla.edda + +.LP +/avatar open freyja@vanaheimr.edda + +.LP diff --git a/docs/profanity-ban.1 b/docs/profanity-ban.1 new file mode 100644 index 00000000..09af2a42 --- /dev/null +++ b/docs/profanity-ban.1 @@ -0,0 +1,24 @@ +.TH man 1 "2021-09-28" "0.11.0" "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 diff --git a/docs/profanity-beep.1 b/docs/profanity-beep.1 new file mode 100644 index 00000000..3b677172 --- /dev/null +++ b/docs/profanity-beep.1 @@ -0,0 +1,19 @@ +.TH man 1 "2021-09-28" "0.11.0" "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 diff --git a/docs/profanity-blocked.1 b/docs/profanity-blocked.1 new file mode 100644 index 00000000..ad8175a8 --- /dev/null +++ b/docs/profanity-blocked.1 @@ -0,0 +1,57 @@ +.TH man 1 "2021-09-28" "0.11.0" "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 diff --git a/docs/profanity-bookmark.1 b/docs/profanity-bookmark.1 new file mode 100644 index 00000000..3c10639a --- /dev/null +++ b/docs/profanity-bookmark.1 @@ -0,0 +1,124 @@ +.TH man 1 "2021-09-28" "0.11.0" "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 diff --git a/docs/profanity-caps.1 b/docs/profanity-caps.1 new file mode 100644 index 00000000..10f3c20d --- /dev/null +++ b/docs/profanity-caps.1 @@ -0,0 +1,38 @@ +.TH man 1 "2021-09-28" "0.11.0" "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 diff --git a/docs/profanity-carbons.1 b/docs/profanity-carbons.1 new file mode 100644 index 00000000..53c380da --- /dev/null +++ b/docs/profanity-carbons.1 @@ -0,0 +1,19 @@ +.TH man 1 "2021-09-28" "0.11.0" "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 diff --git a/docs/profanity-changepassword.1 b/docs/profanity-changepassword.1 new file mode 100644 index 00000000..ffbaffa5 --- /dev/null +++ b/docs/profanity-changepassword.1 @@ -0,0 +1,12 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/changepassword + +.SH DESCRIPTION +Change password of logged in account + +.SH SYNOPSIS +/changepassword + +.LP diff --git a/docs/profanity-charset.1 b/docs/profanity-charset.1 new file mode 100644 index 00000000..681a0558 --- /dev/null +++ b/docs/profanity-charset.1 @@ -0,0 +1,12 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/charset + +.SH DESCRIPTION +Display information about the current character set supported by the terminal. + +.SH SYNOPSIS +/charset + +.LP diff --git a/docs/profanity-clear.1 b/docs/profanity-clear.1 new file mode 100644 index 00000000..57629e93 --- /dev/null +++ b/docs/profanity-clear.1 @@ -0,0 +1,33 @@ +.TH man 1 "2021-09-28" "0.11.0" "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 diff --git a/docs/profanity-close.1 b/docs/profanity-close.1 new file mode 100644 index 00000000..ce7735cd --- /dev/null +++ b/docs/profanity-close.1 @@ -0,0 +1,75 @@ +.TH man 1 "2021-09-28" "0.11.0" "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 diff --git a/docs/profanity-cmd.1 b/docs/profanity-cmd.1 new file mode 100644 index 00000000..b7b63c23 --- /dev/null +++ b/docs/profanity-cmd.1 @@ -0,0 +1,35 @@ +.TH man 1 "2021-09-28" "0.11.0" "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 diff --git a/docs/profanity-color.1 b/docs/profanity-color.1 new file mode 100644 index 00000000..01c80064 --- /dev/null +++ b/docs/profanity-color.1 @@ -0,0 +1,41 @@ +.TH man 1 "2021-09-28" "0.11.0" "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 diff --git a/docs/profanity-connect.1 b/docs/profanity-connect.1 new file mode 100644 index 00000000..d51d2b06 --- /dev/null +++ b/docs/profanity-connect.1 @@ -0,0 +1,87 @@ +.TH man 1 "2021-09-28" "0.11.0" "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. + +.SH SYNOPSIS +/connect [<account>] + +.LP +/connect <account> [server <server>] [port <port>] [tls force|allow|trust|legacy|disable] [auth default|legacy] + +.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 +\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 diff --git a/docs/profanity-console.1 b/docs/profanity-console.1 new file mode 100644 index 00000000..841ac11d --- /dev/null +++ b/docs/profanity-console.1 @@ -0,0 +1,70 @@ +.TH man 1 "2021-09-28" "0.11.0" "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 beeen 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 diff --git a/docs/profanity-correct.1 b/docs/profanity-correct.1 new file mode 100644 index 00000000..69a9cc61 --- /dev/null +++ b/docs/profanity-correct.1 @@ -0,0 +1,19 @@ +.TH man 1 "2021-09-28" "0.11.0" "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 diff --git a/docs/profanity-correction.1 b/docs/profanity-correction.1 new file mode 100644 index 00000000..cc882e7f --- /dev/null +++ b/docs/profanity-correction.1 @@ -0,0 +1,27 @@ +.TH man 1 "2021-09-28" "0.11.0" "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 diff --git a/docs/profanity-disco.1 b/docs/profanity-disco.1 new file mode 100644 index 00000000..3eb51534 --- /dev/null +++ b/docs/profanity-disco.1 @@ -0,0 +1,41 @@ +.TH man 1 "2021-09-28" "0.11.0" "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 diff --git a/docs/profanity-disconnect.1 b/docs/profanity-disconnect.1 new file mode 100644 index 00000000..cc0a92a8 --- /dev/null +++ b/docs/profanity-disconnect.1 @@ -0,0 +1,12 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/disconnect + +.SH DESCRIPTION +Disconnect from the current chat service. + +.SH SYNOPSIS +/disconnect + +.LP diff --git a/docs/profanity-editor.1 b/docs/profanity-editor.1 new file mode 100644 index 00000000..6cf830b7 --- /dev/null +++ b/docs/profanity-editor.1 @@ -0,0 +1,12 @@ +.TH man 1 "2021-09-28" "0.11.0" "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 diff --git a/docs/profanity-executable.1 b/docs/profanity-executable.1 new file mode 100644 index 00000000..ae529dfe --- /dev/null +++ b/docs/profanity-executable.1 @@ -0,0 +1,82 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/executable + +.SH DESCRIPTION +Configure executable that should be called upon a certain command. + +.SH SYNOPSIS +/executable avatar <cmd> + +.LP +/executable urlopen set <cmdtemplate> + +.LP +/executable urlopen default + +.LP +/executable urlsave set <cmdtemplate> + +.LP +/executable urlsave default + +.LP + +.SH ARGUMENTS +.PP +\fBavatar\fR +.RS 4 +Set executable that is run by /avatar open. Use your favorite image viewer. +.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 + +.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 editor set vim + +.LP diff --git a/docs/profanity-export.1 b/docs/profanity-export.1 new file mode 100644 index 00000000..fac16afc --- /dev/null +++ b/docs/profanity-export.1 @@ -0,0 +1,27 @@ +.TH man 1 "2021-09-28" "0.11.0" "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 +/export ~/contacts.csv + +.LP diff --git a/docs/profanity-flash.1 b/docs/profanity-flash.1 new file mode 100644 index 00000000..37e4102d --- /dev/null +++ b/docs/profanity-flash.1 @@ -0,0 +1,19 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/flash + +.SH DESCRIPTION +Make the terminal flash when incoming messages are received in another window. If the terminal doesn't support flashing, it may attempt to beep. + +.SH SYNOPSIS +/flash on|off + +.LP + +.SH ARGUMENTS +.PP +\fBon|off\fR +.RS 4 +Enable or disable terminal flash. +.RE diff --git a/docs/profanity-form.1 b/docs/profanity-form.1 new file mode 100644 index 00000000..547ed425 --- /dev/null +++ b/docs/profanity-form.1 @@ -0,0 +1,43 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/form + +.SH DESCRIPTION +Form configuration. + +.SH SYNOPSIS +/form show + +.LP +/form submit + +.LP +/form cancel + +.LP +/form help [<tag>] + +.LP + +.SH ARGUMENTS +.PP +\fBshow\fR +.RS 4 +Show the current form. +.RE +.PP +\fBsubmit\fR +.RS 4 +Submit the current form. +.RE +.PP +\fBcancel\fR +.RS 4 +Cancel changes to the current form. +.RE +.PP +\fBhelp [<tag>]\fR +.RS 4 +Display help for form, or a specific field. +.RE diff --git a/docs/profanity-gone.1 b/docs/profanity-gone.1 new file mode 100644 index 00000000..23f75089 --- /dev/null +++ b/docs/profanity-gone.1 @@ -0,0 +1,19 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/gone + +.SH DESCRIPTION +Send a 'gone' state to the recipient after the specified number of minutes. Chat states (/states) will be enabled if this setting is set. + +.SH SYNOPSIS +/gone <minutes> + +.LP + +.SH ARGUMENTS +.PP +\fB<minutes>\fR +.RS 4 +Number of minutes of inactivity before sending the 'gone' state, a value of 0 will disable sending this state. +.RE diff --git a/docs/profanity-help.1 b/docs/profanity-help.1 new file mode 100644 index 00000000..8cf69272 --- /dev/null +++ b/docs/profanity-help.1 @@ -0,0 +1,48 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/help + +.SH DESCRIPTION +Help on using Profanity. Passing no arguments list help areas. For command help, optional arguments are shown using square brackets, arguments representing variables rather than a literal name are surrounded by angle brackets. Arguments that may be one of a number of values are separated by a pipe e.g. val1|val2|val3. + +.SH SYNOPSIS +/help [<area>|<command>|search_all|search_any] [<search_terms>] + +.LP + +.SH ARGUMENTS +.PP +\fB<area>\fR +.RS 4 +Summary help for commands in a certain area of functionality. +.RE +.PP +\fB<command>\fR +.RS 4 +Full help for a specific command, for example '/help connect'. +.RE +.PP +\fBsearch_all <search_terms>\fR +.RS 4 +Search commands for returning matches that contain all of the search terms. +.RE +.PP +\fBsearch_any <search_terms>\fR +.RS 4 +Search commands for returning matches that contain any of the search terms. +.RE + +.SH EXAMPLES +/help search_all presence online + +.LP +/help commands + +.LP +/help presence + +.LP +/help who + +.LP diff --git a/docs/profanity-history.1 b/docs/profanity-history.1 new file mode 100644 index 00000000..58471d0c --- /dev/null +++ b/docs/profanity-history.1 @@ -0,0 +1,19 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/history + +.SH DESCRIPTION +Switch chat history on or off, /logging chat will automatically be enabled when this setting is on. When history is enabled, previous messages are shown in chat windows. + +.SH SYNOPSIS +/history on|off + +.LP + +.SH ARGUMENTS +.PP +\fBon|off\fR +.RS 4 +Enable or disable showing chat history. +.RE diff --git a/docs/profanity-info.1 b/docs/profanity-info.1 new file mode 100644 index 00000000..811f8cc4 --- /dev/null +++ b/docs/profanity-info.1 @@ -0,0 +1,35 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/info + +.SH DESCRIPTION +Show information about a contact, room, or room member. Passing no argument in a chat window will use the current recipient. Passing no argument in a chat room will display information about the room. + +.SH SYNOPSIS +/info + +.LP +/info <contact>|<nick> + +.LP + +.SH ARGUMENTS +.PP +\fB<contact>\fR +.RS 4 +The contact you wish to view information about. +.RE +.PP +\fB<nick>\fR +.RS 4 +When in a chat room, the occupant you wish to view information about. +.RE + +.SH EXAMPLES +/info thor@aasgard.server.org + +.LP +/info heimdall + +.LP diff --git a/docs/profanity-inpblock.1 b/docs/profanity-inpblock.1 new file mode 100644 index 00000000..8138334f --- /dev/null +++ b/docs/profanity-inpblock.1 @@ -0,0 +1,27 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/inpblock + +.SH DESCRIPTION +How long to wait for keyboard input before checking for new messages or checking for state changes such as 'idle'. + +.SH SYNOPSIS +/inpblock timeout <millis> + +.LP +/inpblock dynamic on|off + +.LP + +.SH ARGUMENTS +.PP +\fBtimeout <millis>\fR +.RS 4 +Time to wait (1-1000) in milliseconds before reading input from the terminal buffer, default: 1000. +.RE +.PP +\fBdynamic on|off\fR +.RS 4 +Start with 0 millis and dynamically increase up to timeout when no activity, default: on. +.RE diff --git a/docs/profanity-inputwin.1 b/docs/profanity-inputwin.1 new file mode 100644 index 00000000..7463626d --- /dev/null +++ b/docs/profanity-inputwin.1 @@ -0,0 +1,27 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/inputwin + +.SH DESCRIPTION +Move the input window. + +.SH SYNOPSIS +/inputwin up + +.LP +/inputwin down + +.LP + +.SH ARGUMENTS +.PP +\fBup\fR +.RS 4 +Move the input window up the screen. +.RE +.PP +\fBdown\fR +.RS 4 +Move the input window down the screen. +.RE diff --git a/docs/profanity-intype.1 b/docs/profanity-intype.1 new file mode 100644 index 00000000..c54f3b6f --- /dev/null +++ b/docs/profanity-intype.1 @@ -0,0 +1,24 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/intype + +.SH DESCRIPTION +Show when a contact is typing in the console, and in active message window. + +.SH SYNOPSIS +/intype console|titlebar on|off + +.LP + +.SH ARGUMENTS +.PP +\fBtitlebar on|off\fR +.RS 4 +Enable or disable contact typing messages notification in titlebar. +.RE +.PP +\fBconsole on|off\fR +.RS 4 +Enable or disable contact typing messages notification in console window. +.RE diff --git a/docs/profanity-invite.1 b/docs/profanity-invite.1 new file mode 100644 index 00000000..150436ca --- /dev/null +++ b/docs/profanity-invite.1 @@ -0,0 +1,46 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/invite + +.SH DESCRIPTION +Manage room invites. Send an invite to a contact for the current chat room. List received invites. Decline them using /invite decline and accept them using /join. + +.SH SYNOPSIS +/invite send <contact> [<message>] + +.LP +/invite list + +.LP +/invite decline + +.LP + +.SH ARGUMENTS +.PP +\fBsend <contact> [<message>]\fR +.RS 4 +The contact you wish to invite. And an optional message. +.RE +.PP +\fBlist\fR +.RS 4 +Show all rooms that you have been invited to, and not accepted or declined. +.RE +.PP +\fBdecline <room>\fR +.RS 4 +Decline a chat room invitation. +.RE + +.SH EXAMPLES +/invite send gustavo@pollos.tx + +.LP +/invite decline profanity@rooms.dismail.de + +.LP +/invite list + +.LP diff --git a/docs/profanity-join.1 b/docs/profanity-join.1 new file mode 100644 index 00000000..64d1b549 --- /dev/null +++ b/docs/profanity-join.1 @@ -0,0 +1,49 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/join + +.SH DESCRIPTION +Join a chat room at the conference server. If no room is supplied, a generated name will be used with the format private-chat-[UUID]. If the domain part is not included in the room name, the account preference 'muc.service' will be used. If no nickname is specified the account preference 'muc.nick' will be used which by default is the localpart of your JID. If the room doesn't exist, and the server allows it, a new one will be created. If you join to a room often, you might also want to add a bookmark (see `/help bookmark`), which also allows to set a default nickname. In this case, you should use `/bookmark join`. + +.SH SYNOPSIS +/join + +.LP +/join <room> [nick <nick>] [password <password>] + +.LP + +.SH ARGUMENTS +.PP +\fB<room>\fR +.RS 4 +The chat room to join. +.RE +.PP +\fBnick <nick>\fR +.RS 4 +Nickname to use in the room. +.RE +.PP +\fBpassword <password>\fR +.RS 4 +Password if the room requires one. +.RE + +.SH EXAMPLES +/join + +.LP +/join profanity@rooms.dismail.de + +.LP +/join profanity@rooms.dismail.de nick mynick + +.LP +/join private@conference.jabber.org nick mynick password mypassword + +.LP +/join mychannel + +.LP diff --git a/docs/profanity-kick.1 b/docs/profanity-kick.1 new file mode 100644 index 00000000..be49ebb7 --- /dev/null +++ b/docs/profanity-kick.1 @@ -0,0 +1,24 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/kick + +.SH DESCRIPTION +Kick occupant from chat room. + +.SH SYNOPSIS +/kick <nick> [<reason>] + +.LP + +.SH ARGUMENTS +.PP +\fB<nick>\fR +.RS 4 +Nickname of the occupant to kick from the room. +.RE +.PP +\fB<reason>\fR +.RS 4 +Optional reason for kicking the occupant. +.RE diff --git a/docs/profanity-lastactivity.1 b/docs/profanity-lastactivity.1 new file mode 100644 index 00000000..26ac2517 --- /dev/null +++ b/docs/profanity-lastactivity.1 @@ -0,0 +1,44 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/lastactivity + +.SH DESCRIPTION +Enable/disable sending last activity, and send last activity requests. + +.SH SYNOPSIS +/lastactivity set on|off + +.LP +/lastactivity get [<jid>] + +.LP + +.SH ARGUMENTS +.PP +\fBon|off\fR +.RS 4 +Enable or disable sending of last activity. +.RE +.PP +\fB<jid>\fR +.RS 4 +The JID of the entity to query. Omitting the JID will query your server for its uptime. +.RE + +.SH EXAMPLES +/lastactivity get + +.LP +/lastactivity set off + +.LP +/lastactivity get freyja@asgaard.edda + +.LP +/lastactivity get freyja@asgaard.edda/laptop + +.LP +/lastactivity get someserver.com + +.LP diff --git a/docs/profanity-log.1 b/docs/profanity-log.1 new file mode 100644 index 00000000..89524fb7 --- /dev/null +++ b/docs/profanity-log.1 @@ -0,0 +1,43 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/log + +.SH DESCRIPTION +Manage profanity log settings. + +.SH SYNOPSIS +/log where + +.LP +/log rotate on|off + +.LP +/log maxsize <bytes> + +.LP +/log shared on|off + +.LP + +.SH ARGUMENTS +.PP +\fBwhere\fR +.RS 4 +Show the current log file location. +.RE +.PP +\fBrotate on|off\fR +.RS 4 +Rotate log, default on. Does not take effect if you specified a filename yourself when starting Profanity. +.RE +.PP +\fBmaxsize <bytes>\fR +.RS 4 +With rotate enabled, specifies the max log size, defaults to 1048580 (1MB). +.RE +.PP +\fBshared on|off\fR +.RS 4 +Share logs between all instances, default: on. When off, the process id will be included in the log filename. Does not take effect if you specified a filename yourself when starting Profanity. +.RE diff --git a/docs/profanity-logging.1 b/docs/profanity-logging.1 new file mode 100644 index 00000000..ad207b43 --- /dev/null +++ b/docs/profanity-logging.1 @@ -0,0 +1,32 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/logging + +.SH DESCRIPTION +Configure chat logging. Switch logging on or off. Chat logging will be enabled if /history is set to on. When disabling this option, /history will also be disabled. + +.SH SYNOPSIS +/logging chat|group on|off + +.LP + +.SH ARGUMENTS +.PP +\fBchat on|off\fR +.RS 4 +Enable/Disable regular chat logging. +.RE +.PP +\fBgroup on|off\fR +.RS 4 +Enable/Disable groupchat (room) logging. +.RE + +.SH EXAMPLES +/logging chat on + +.LP +/logging group off + +.LP diff --git a/docs/profanity-mainwin.1 b/docs/profanity-mainwin.1 new file mode 100644 index 00000000..fd89187d --- /dev/null +++ b/docs/profanity-mainwin.1 @@ -0,0 +1,27 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/mainwin + +.SH DESCRIPTION +Move the main window. + +.SH SYNOPSIS +/mainwin up + +.LP +/mainwin down + +.LP + +.SH ARGUMENTS +.PP +\fBup\fR +.RS 4 +Move the main window up the screen. +.RE +.PP +\fBdown\fR +.RS 4 +Move the main window down the screen. +.RE diff --git a/docs/profanity-mam.1 b/docs/profanity-mam.1 new file mode 100644 index 00000000..15f10e4a --- /dev/null +++ b/docs/profanity-mam.1 @@ -0,0 +1,19 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/mam + +.SH DESCRIPTION +Enable/Disable Message Archive Management (XEP-0313) MAM is in experimental state. For regular users there are still many confusing things when enabling this feature. We are going to work on this in future releases. So far this setting is mostly here for developers. + +.SH SYNOPSIS +/mam <on>|<off> + +.LP + +.SH ARGUMENTS +.PP +\fBon|off\fR +.RS 4 +Enable or disable MAM +.RE diff --git a/docs/profanity-msg.1 b/docs/profanity-msg.1 new file mode 100644 index 00000000..e5926f36 --- /dev/null +++ b/docs/profanity-msg.1 @@ -0,0 +1,51 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/msg + +.SH DESCRIPTION +Send a one to one chat message, or a private message to a chat room occupant. If the message is omitted, a new chat window will be opened without sending a message. Use quotes if the nickname includes spaces. + +.SH SYNOPSIS +/msg <contact> [<message>] + +.LP +/msg <nick> [<message>] + +.LP + +.SH ARGUMENTS +.PP +\fB<contact>\fR +.RS 4 +Open chat window with contact, by JID or nickname. +.RE +.PP +\fB<contact> [<message>]\fR +.RS 4 +Send message to contact, by JID or nickname. +.RE +.PP +\fB<nick>\fR +.RS 4 +Open private chat window with chat room occupant. +.RE +.PP +\fB<nick> [<message>]\fR +.RS 4 +Send a private message to a chat room occupant. +.RE + +.SH EXAMPLES +/msg thor@valhalla.edda Hey, here's a message! + +.LP +/msg heimdall@valhalla.edda + +.LP +/msg Thor Here is a private message + +.LP +/msg "My Friend" Hi, how are you? + +.LP diff --git a/docs/profanity-nick.1 b/docs/profanity-nick.1 new file mode 100644 index 00000000..22d20777 --- /dev/null +++ b/docs/profanity-nick.1 @@ -0,0 +1,19 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/nick + +.SH DESCRIPTION +Change your nickname in the current chat room. + +.SH SYNOPSIS +/nick <nickname> + +.LP + +.SH ARGUMENTS +.PP +\fB<nickname>\fR +.RS 4 +Your new nickname. +.RE diff --git a/docs/profanity-notify.1 b/docs/profanity-notify.1 new file mode 100644 index 00000000..e43405c8 --- /dev/null +++ b/docs/profanity-notify.1 @@ -0,0 +1,229 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/notify + +.SH DESCRIPTION +Configure desktop notifications. To configure presence update messages in the console, chat and chat room windows, see '/help presence'. + +.SH SYNOPSIS +/notify chat on|off + +.LP +/notify chat current on|off + +.LP +/notify chat text on|off + +.LP +/notify room on|off + +.LP +/notify room mention on|off + +.LP +/notify room mention case_sensitive|case_insensitive + +.LP +/notify room mention word_whole|word_part + +.LP +/notify room current on|off + +.LP +/notify room text on|off + +.LP +/notify room trigger add <text> + +.LP +/notify room trigger remove <text> + +.LP +/notify room trigger list + +.LP +/notify room trigger on|off + +.LP +/notify on|off + +.LP +/notify mention on|off + +.LP +/notify trigger on|off + +.LP +/notify reset + +.LP +/notify remind <seconds> + +.LP +/notify typing on|off + +.LP +/notify typing current on|off + +.LP +/notify invite on|off + +.LP +/notify sub on|off + +.LP + +.SH ARGUMENTS +.PP +\fBchat on|off\fR +.RS 4 +Notifications for regular chat messages. +.RE +.PP +\fBchat current on|off\fR +.RS 4 +Whether to show regular chat message notifications when the window is focused. +.RE +.PP +\fBchat text on|off\fR +.RS 4 +Show message text in regular message notifications. +.RE +.PP +\fBroom on|off\fR +.RS 4 +Notifications for all chat room messages. +.RE +.PP +\fBroom mention on|off\fR +.RS 4 +Notifications for chat room messages when your nick is mentioned. +.RE +.PP +\fBroom mention case_sensitive\fR +.RS 4 +Set room mention notifications as case sensitive. +.RE +.PP +\fBroom mention case_insensitive\fR +.RS 4 +Set room mention notifications as case insensitive. +.RE +.PP +\fBroom mention word_whole\fR +.RS 4 +Set room mention notifications only on whole word match, i.e. when nickname is not part of a larger word. +.RE +.PP +\fBroom mention word_part\fR +.RS 4 +Set room mention notifications on partial word match, i.e. nickname may be part of a larger word. +.RE +.PP +\fBroom current on|off\fR +.RS 4 +Whether to show all chat room messages notifications when the window is focused. +.RE +.PP +\fBroom text on|off\fR +.RS 4 +Show message text in chat room message notifications. +.RE +.PP +\fBroom trigger add <text>\fR +.RS 4 +Notify when specified text included in all chat room messages. +.RE +.PP +\fBroom trigger remove <text>\fR +.RS 4 +Remove chat room notification trigger. +.RE +.PP +\fBroom trigger list\fR +.RS 4 +List all chat room highlight triggers. +.RE +.PP +\fBroom trigger on|off\fR +.RS 4 +Enable or disable all chat room notification triggers. +.RE +.PP +\fBon|off\fR +.RS 4 +Override the global message setting for the current chat room. +.RE +.PP +\fBmention on|off\fR +.RS 4 +Override the global 'mention' setting for the current chat room. +.RE +.PP +\fBtrigger on|off\fR +.RS 4 +Override the global 'trigger' setting for the current chat room. +.RE +.PP +\fBreset\fR +.RS 4 +Reset to global notification settings for the current chat room. +.RE +.PP +\fBremind <seconds>\fR +.RS 4 +Notification reminder period for unread messages, use 0 to disable. +.RE +.PP +\fBtyping on|off\fR +.RS 4 +Notifications when contacts are typing. +.RE +.PP +\fBtyping current on|off\fR +.RS 4 +Whether typing notifications are triggered for the current window. +.RE +.PP +\fBinvite on|off\fR +.RS 4 +Notifications for chat room invites. +.RE +.PP +\fBsub on|off\fR +.RS 4 +Notifications for subscription requests. +.RE + +.SH EXAMPLES +/notify chat on + +.LP +/notify chat text on + +.LP +/notify room mention on + +.LP +/notify room trigger add beer + +.LP +/notify room trigger on + +.LP +/notify room current off + +.LP +/notify room text off + +.LP +/notify remind 60 + +.LP +/notify typing on + +.LP +/notify invite on + +.LP diff --git a/docs/profanity-occupants.1 b/docs/profanity-occupants.1 new file mode 100644 index 00000000..1104727d --- /dev/null +++ b/docs/profanity-occupants.1 @@ -0,0 +1,125 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/occupants + +.SH DESCRIPTION +Show or hide room occupants, and occupants panel display settings. + +.SH SYNOPSIS +/occupants show|hide [jid|offline] + +.LP +/occupants char <char>|none + +.LP +/occupants color on|off + +.LP +/occupants default show|hide [jid|offline] + +.LP +/occupants size [<percent>] + +.LP +/occupants indent <indent> + +.LP +/occupants header char <char>|none + +.LP +/occupants wrap on|off + +.LP + +.SH ARGUMENTS +.PP +\fBshow\fR +.RS 4 +Show the occupants panel in current room. +.RE +.PP +\fBchar <char>\fR +.RS 4 +Prefix occupants with specified character. +.RE +.PP +\fBchar none\fR +.RS 4 +Remove occupants character prefix. +.RE +.PP +\fBcolor on\fR +.RS 4 +Enable generated color names (XEP-0392) for occupants +.RE +.PP +\fBcolor off\fR +.RS 4 +Disable generated color names (XEP-0392) for occupants +.RE +.PP +\fBhide\fR +.RS 4 +Hide the occupants panel in current room. +.RE +.PP +\fBshow jid\fR +.RS 4 +Show jid in the occupants panel in current room. +.RE +.PP +\fBhide jid\fR +.RS 4 +Hide jid in the occupants panel in current room. +.RE +.PP +\fBshow offline\fR +.RS 4 +Show offline occupants panel in current room. +.RE +.PP +\fBhide offline\fR +.RS 4 +Hide offline occupants panel in current room. +.RE +.PP +\fBdefault show|hide\fR +.RS 4 +Whether occupants are shown by default in new rooms. +.RE +.PP +\fBdefault show|hide jid\fR +.RS 4 +Whether occupants jids are shown by default in new rooms. +.RE +.PP +\fBdefault show|hide offline\fR +.RS 4 +Whether offline occupants are shown by default in new rooms. +.RE +.PP +\fBsize <percent>\fR +.RS 4 +Percentage of the screen taken by the occupants list in rooms (1-99). +.RE +.PP +\fBindent <indent>\fR +.RS 4 +Indent contact line by <indent> spaces (0 to 10). +.RE +.PP +\fBheader char <char>\fR +.RS 4 +Prefix occupants headers with specified character. +.RE +.PP +\fBheader char none\fR +.RS 4 +Remove occupants header character prefix. +.RE +.PP +\fBwrap on|off\fR +.RS 4 +Enable or disable line wrapping in occupants panel. +.RE diff --git a/docs/profanity-omemo.1 b/docs/profanity-omemo.1 new file mode 100644 index 00000000..d733776f --- /dev/null +++ b/docs/profanity-omemo.1 @@ -0,0 +1,128 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/omemo + +.SH DESCRIPTION +OMEMO commands to manage keys, and perform encryption during chat sessions. + +.SH SYNOPSIS +/omemo gen + +.LP +/omemo log on|off|redact + +.LP +/omemo start [<contact>] + +.LP +/omemo trust [<contact>] <fingerprint> + +.LP +/omemo end + +.LP +/omemo fingerprint [<contact>] + +.LP +/omemo char <char> + +.LP +/omemo trustmode manual|firstusage|blind + +.LP +/omemo policy manual|automatic|always + +.LP +/omemo clear_device_list + +.LP + +.SH ARGUMENTS +.PP +\fBgen\fR +.RS 4 +Generate OMEMO crytographic materials for current account. +.RE +.PP +\fBstart [<contact>]\fR +.RS 4 +Start an OMEMO session with contact, or current recipient if omitted. +.RE +.PP +\fBend\fR +.RS 4 +End the current OMEMO session. +.RE +.PP +\fBlog on|off\fR +.RS 4 +Enable or disable plaintext logging of OMEMO encrypted messages. +.RE +.PP +\fBlog redact\fR +.RS 4 +Log OMEMO encrypted messages, but replace the contents with [redacted]. This is the default. +.RE +.PP +\fBfingerprint [<contact>]\fR +.RS 4 +Show contact fingerprints, or current recipient if omitted. +.RE +.PP +\fBchar <char>\fR +.RS 4 +Set the character to be displayed next to OMEMO encrypted messages. +.RE +.PP +\fBtrustmode manual\fR +.RS 4 +Set the global OMEMO trust mode to manual, OMEMO keys has to be trusted manually. +.RE +.PP +\fBtrustmode firstusage\fR +.RS 4 +Set the global OMEMO trust mode to ToFu, first OMEMO keys trusted automatically. +.RE +.PP +\fBtrustmode blind\fR +.RS 4 +Set the global OMEMO trust mode to blind, ALL OMEMO keys trusted automatically. +.RE +.PP +\fBpolicy manual\fR +.RS 4 +Set the global OMEMO policy to manual, OMEMO sessions must be started manually. +.RE +.PP +\fBpolicy automatic\fR +.RS 4 +Set the global OMEMO policy to opportunistic, an OMEMO session will be attempted upon starting a conversation. +.RE +.PP +\fBpolicy always\fR +.RS 4 +Set the global OMEMO policy to always, an error will be displayed if an OMEMO session cannot be initiated upon starting a conversation. +.RE +.PP +\fBclear_device_list\fR +.RS 4 +Clear your own device list on server side. Each client will reannounce itself when connected back. +.RE + +.SH EXAMPLES +/omemo gen + +.LP +/omemo start odin@valhalla.edda + +.LP +/omemo trust c4f9c875-144d7a3b-0c4a05b6-ca3be51a-a037f329-0bd3ae62-07f99719-55559d2a + +.LP +/omemo untrust loki@valhalla.edda c4f9c875-144d7a3b-0c4a05b6-ca3be51a-a037f329-0bd3ae62-07f99719-55559d2a + +.LP +/omemo char * + +.LP diff --git a/docs/profanity-os.1 b/docs/profanity-os.1 new file mode 100644 index 00000000..bc9126fe --- /dev/null +++ b/docs/profanity-os.1 @@ -0,0 +1,19 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/os + +.SH DESCRIPTION +Choose whether to include the OS name if a user asks for software information (XEP-0092). + +.SH SYNOPSIS +/os <on>|<off> + +.LP + +.SH ARGUMENTS +.PP +\fBon|off\fR +.RS 4 + +.RE diff --git a/docs/profanity-otr.1 b/docs/profanity-otr.1 new file mode 100644 index 00000000..0c26852e --- /dev/null +++ b/docs/profanity-otr.1 @@ -0,0 +1,182 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/otr + +.SH DESCRIPTION +Off The Record (OTR) commands to manage keys, and perform OTR encryption during chat sessions. + +.SH SYNOPSIS +/otr libver + +.LP +/otr gen + +.LP +/otr myfp|theirfp + +.LP +/otr start [<contact>] + +.LP +/otr end + +.LP +/otr trust|untrust + +.LP +/otr secret <secret> + +.LP +/otr question <question> <answer> + +.LP +/otr answer <answer> + +.LP +/otr policy manual|opportunistic|always [<contact>] + +.LP +/otr log on|off|redact + +.LP +/otr char <char> + +.LP +/otr sendfile on|off + +.LP + +.SH ARGUMENTS +.PP +\fBlibver\fR +.RS 4 +Show which version of the libotr library is being used. +.RE +.PP +\fBgen\fR +.RS 4 +Generate your private key. +.RE +.PP +\fBmyfp\fR +.RS 4 +Show your fingerprint. +.RE +.PP +\fBtheirfp\fR +.RS 4 +Show contacts fingerprint. +.RE +.PP +\fBstart [<contact>]\fR +.RS 4 +Start an OTR session with contact, or current recipient if omitted. +.RE +.PP +\fBend\fR +.RS 4 +End the current OTR session. +.RE +.PP +\fBtrust|untrust\fR +.RS 4 +Indicate whether or not you trust the contact's fingerprint. +.RE +.PP +\fBsecret <secret>\fR +.RS 4 +Verify a contact's identity using a shared secret. +.RE +.PP +\fBquestion <question> <answer>\fR +.RS 4 +Verify a contact's identity using a question and expected answer. +.RE +.PP +\fBanswer <answer>\fR +.RS 4 +Respond to a question answer verification request with your answer. +.RE +.PP +\fBpolicy manual\fR +.RS 4 +Set the global OTR policy to manual, OTR sessions must be started manually. +.RE +.PP +\fBpolicy manual <contact>\fR +.RS 4 +Set the OTR policy to manual for a specific contact. +.RE +.PP +\fBpolicy opportunistic\fR +.RS 4 +Set the global OTR policy to opportunistic, an OTR session will be attempted upon starting a conversation. +.RE +.PP +\fBpolicy opportunistic <contact>\fR +.RS 4 +Set the OTR policy to opportunistic for a specific contact. +.RE +.PP +\fBpolicy always\fR +.RS 4 +Set the global OTR policy to always, an error will be displayed if an OTR session cannot be initiated upon starting a conversation. +.RE +.PP +\fBpolicy always <contact>\fR +.RS 4 +Set the OTR policy to always for a specific contact. +.RE +.PP +\fBlog on|off\fR +.RS 4 +Enable or disable plaintext logging of OTR encrypted messages. +.RE +.PP +\fBlog redact\fR +.RS 4 +Log OTR encrypted messages, but replace the contents with [redacted]. This is the default. +.RE +.PP +\fBchar <char>\fR +.RS 4 +Set the character to be displayed next to OTR encrypted messages. +.RE +.PP +\fBsendfile on|off\fR +.RS 4 +Allow /sendfile to send unencrypted files while in an OTR session. +.RE + +.SH EXAMPLES +/otr log off + +.LP +/otr policy manual + +.LP +/otr policy opportunistic odin@valhalla.edda + +.LP +/otr gen + +.LP +/otr start odin@valhalla.edda + +.LP +/otr myfp + +.LP +/otr theirfp + +.LP +/otr question "What is the name of my rabbit?" fiffi + +.LP +/otr end + +.LP +/otr char * + +.LP diff --git a/docs/profanity-outtype.1 b/docs/profanity-outtype.1 new file mode 100644 index 00000000..f1624faf --- /dev/null +++ b/docs/profanity-outtype.1 @@ -0,0 +1,19 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/outtype + +.SH DESCRIPTION +Send typing notifications, chat states (/states) will be enabled if this setting is enabled. + +.SH SYNOPSIS +/outtype on|off + +.LP + +.SH ARGUMENTS +.PP +\fBon|off\fR +.RS 4 +Enable or disable sending typing notifications. +.RE diff --git a/docs/profanity-ox.1 b/docs/profanity-ox.1 new file mode 100644 index 00000000..af94b9ab --- /dev/null +++ b/docs/profanity-ox.1 @@ -0,0 +1,110 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/ox + +.SH DESCRIPTION +OpenPGP (OX) commands to manage keys, and perform OpenPGP encryption during chat sessions. Your OpenPGP key needs a user-id with your JID URI (xmpp:local@domain.tld). A key can be generated with "gpg --quick-gen-key xmpp:local@domain.tld future-default default 3y". + +.SH SYNOPSIS +/ox keys + +.LP +/ox contacts + +.LP +/ox start [<contact>] + +.LP +/ox end + +.LP +/ox log on|off|redact + +.LP +/ox char <char> + +.LP +/ox sendfile on|off + +.LP +/ox announce <file> + +.LP +/ox discover <jid> + +.LP +/ox request <jid> <keyid> + +.LP + +.SH ARGUMENTS +.PP +\fBkeys\fR +.RS 4 +List all keys known to the system. +.RE +.PP +\fBcontacts\fR +.RS 4 +Show contacts with assigned public keys. +.RE +.PP +\fBstart [<contact>]\fR +.RS 4 +Start PGP encrypted chat, current contact will be used if not specified. +.RE +.PP +\fBend\fR +.RS 4 +End PGP encrypted chat with the current recipient. +.RE +.PP +\fBlog on|off\fR +.RS 4 +Enable or disable plaintext logging of PGP encrypted messages. +.RE +.PP +\fBlog redact\fR +.RS 4 +Log PGP encrypted messages, but replace the contents with [redacted]. This is the default. +.RE +.PP +\fBchar <char>\fR +.RS 4 +Set the character to be displayed next to PGP encrypted messages. +.RE +.PP +\fBannounce <file>\fR +.RS 4 +Announce a public key by pushing it on the XMPP Server +.RE +.PP +\fBdiscover <jid>\fR +.RS 4 +Discover public keys of a jid. The OpenPGP Key IDs will be displayed +.RE +.PP +\fBrequest <jid>\fR +.RS 4 +Request public keys +.RE +.PP +\fBsendfile on|off\fR +.RS 4 +Allow /sendfile to send unencrypted files while otherwise using PGP. +.RE + +.SH EXAMPLES +/ox log off + +.LP +/ox start odin@valhalla.edda + +.LP +/ox end + +.LP +/ox char X + +.LP diff --git a/docs/profanity-paste.1 b/docs/profanity-paste.1 new file mode 100644 index 00000000..32271990 --- /dev/null +++ b/docs/profanity-paste.1 @@ -0,0 +1,12 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/paste + +.SH DESCRIPTION +Paste clipboard. + +.SH SYNOPSIS +/paste + +.LP diff --git a/docs/profanity-pgp.1 b/docs/profanity-pgp.1 new file mode 100644 index 00000000..e4dcbd77 --- /dev/null +++ b/docs/profanity-pgp.1 @@ -0,0 +1,105 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/pgp + +.SH DESCRIPTION +Open PGP commands to manage keys, and perform PGP encryption during chat sessions. See the /account command to set your own PGP key. + +.SH SYNOPSIS +/pgp libver + +.LP +/pgp keys + +.LP +/pgp contacts + +.LP +/pgp setkey <contact> <keyid> + +.LP +/pgp start [<contact>] + +.LP +/pgp end + +.LP +/pgp log on|off|redact + +.LP +/pgp char <char> + +.LP +/pgp sendfile on|off + +.LP + +.SH ARGUMENTS +.PP +\fBlibver\fR +.RS 4 +Show which version of the libgpgme library is being used. +.RE +.PP +\fBkeys\fR +.RS 4 +List all keys known to the system. +.RE +.PP +\fBcontacts\fR +.RS 4 +Show contacts with assigned public keys. +.RE +.PP +\fBsetkey <contact> <keyid>\fR +.RS 4 +Manually associate a contact with a public key. +.RE +.PP +\fBstart [<contact>]\fR +.RS 4 +Start PGP encrypted chat, current contact will be used if not specified. +.RE +.PP +\fBend\fR +.RS 4 +End PGP encrypted chat with the current recipient. +.RE +.PP +\fBlog on|off\fR +.RS 4 +Enable or disable plaintext logging of PGP encrypted messages. +.RE +.PP +\fBlog redact\fR +.RS 4 +Log PGP encrypted messages, but replace the contents with [redacted]. This is the default. +.RE +.PP +\fBchar <char>\fR +.RS 4 +Set the character to be displayed next to PGP encrypted messages. +.RE +.PP +\fBsendfile on|off\fR +.RS 4 +Allow /sendfile to send unencrypted files while otherwise using PGP. +.RE + +.SH EXAMPLES +/pgp log off + +.LP +/pgp setkey odin@valhalla.edda BA19CACE5A9592C5 + +.LP +/pgp start odin@valhalla.edda + +.LP +/pgp end + +.LP +/pgp char P + +.LP diff --git a/docs/profanity-ping.1 b/docs/profanity-ping.1 new file mode 100644 index 00000000..3b5a8733 --- /dev/null +++ b/docs/profanity-ping.1 @@ -0,0 +1,19 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/ping + +.SH DESCRIPTION +Sends an IQ ping stanza to the specified JID. If no JID is supplied, your chat server will be pinged. + +.SH SYNOPSIS +/ping [<jid>] + +.LP + +.SH ARGUMENTS +.PP +\fB<jid>\fR +.RS 4 +The Jabber ID to send the ping request to. +.RE diff --git a/docs/profanity-plugins.1 b/docs/profanity-plugins.1 new file mode 100644 index 00000000..ba46c9bd --- /dev/null +++ b/docs/profanity-plugins.1 @@ -0,0 +1,112 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/plugins + +.SH DESCRIPTION +Manage plugins. Passing no arguments lists currently loaded plugins. + +.SH SYNOPSIS +/plugins + +.LP +/plugins sourcepath set <path> + +.LP +/plugins sourcepath clear + +.LP +/plugins install [<path>] + +.LP +/plugins uninstall [<plugin>] + +.LP +/plugins update [<path>] + +.LP +/plugins unload [<plugin>] + +.LP +/plugins load [<plugin>] + +.LP +/plugins reload [<plugin>] + +.LP +/plugins python_version + +.LP + +.SH ARGUMENTS +.PP +\fBsourcepath set <path>\fR +.RS 4 +Set the default path to install plugins from, will be used if no arg is passed to /plugins install. +.RE +.PP +\fBsourcepath clear\fR +.RS 4 +Clear the default plugins source path. +.RE +.PP +\fBinstall [<path>]\fR +.RS 4 +Install a plugin, or all plugins found in a directory (recursive). Passing no argument will use the sourcepath if one is set. +.RE +.PP +\fBuninstall [<plugin>]\fR +.RS 4 +Uninstall a plugin. +.RE +.PP +\fBupdate [<path>]\fR +.RS 4 +Updates an installed plugin +.RE +.PP +\fBload [<plugin>]\fR +.RS 4 +Load a plugin that already exists in the plugin directory, passing no argument loads all found plugins. +.RE +.PP +\fBunload [<plugin>]\fR +.RS 4 +Unload a loaded plugin, passing no argument will unload all plugins. +.RE +.PP +\fBreload [<plugin>]\fR +.RS 4 +Reload a plugin, passing no argument will reload all plugins. +.RE +.PP +\fBpython_version\fR +.RS 4 +Show the Python interpreter version. +.RE + +.SH EXAMPLES +/plugins sourcepath set /home/meee/projects/profanity-plugins + +.LP +/plugins install + +.LP +/plugins install /home/steveharris/Downloads/metal.py + +.LP +/plugins update /home/steveharris/Downloads/metal.py + +.LP +/plugins uninstall browser.py + +.LP +/plugins load browser.py + +.LP +/plugins unload say.py + +.LP +/plugins reload wikipedia.py + +.LP diff --git a/docs/profanity-prefs.1 b/docs/profanity-prefs.1 new file mode 100644 index 00000000..9e2ed295 --- /dev/null +++ b/docs/profanity-prefs.1 @@ -0,0 +1,59 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/prefs + +.SH DESCRIPTION +Show preferences for different areas of functionality. Passing no arguments shows all preferences. + +.SH SYNOPSIS +/prefs [ui|desktop|chat|log|conn|presence|otr|pgp|omemo] + +.LP + +.SH ARGUMENTS +.PP +\fBui\fR +.RS 4 +User interface preferences. +.RE +.PP +\fBdesktop\fR +.RS 4 +Desktop notification preferences. +.RE +.PP +\fBchat\fR +.RS 4 +Chat state preferences. +.RE +.PP +\fBlog\fR +.RS 4 +Logging preferences. +.RE +.PP +\fBconn\fR +.RS 4 +Connection handling preferences. +.RE +.PP +\fBpresence\fR +.RS 4 +Chat presence preferences. +.RE +.PP +\fBotr\fR +.RS 4 +Off The Record preferences. +.RE +.PP +\fBpgp\fR +.RS 4 +OpenPGP preferences. +.RE +.PP +\fBomemo\fR +.RS 4 +OMEMO preferences. +.RE diff --git a/docs/profanity-presence.1 b/docs/profanity-presence.1 new file mode 100644 index 00000000..63a3f6bc --- /dev/null +++ b/docs/profanity-presence.1 @@ -0,0 +1,87 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/presence + +.SH DESCRIPTION +Show the contacts presence in the titlebar and configure presence messages in different window types. + +.SH SYNOPSIS +/presence titlebar on|off + +.LP +/presence console all|online|none + +.LP +/presence chat all|online|none + +.LP +/presence room all|online|none + +.LP + +.SH ARGUMENTS +.PP +\fBtitlebar on|off\fR +.RS 4 +Switch display of the contacts presence in the titlebar on or off. +.RE +.PP +\fBconsole all\fR +.RS 4 +Show all presence changes in the console window. +.RE +.PP +\fBconsole online\fR +.RS 4 +Show only online/offline presence changes in the console window. +.RE +.PP +\fBconsole none\fR +.RS 4 +Don't show any presence changes in the console window. +.RE +.PP +\fBchat all\fR +.RS 4 +Show all presence changes in the chat windows. +.RE +.PP +\fBchat online\fR +.RS 4 +Show only online/offline presence changes in chat windows. +.RE +.PP +\fBchat none\fR +.RS 4 +Don't show any presence changes in chat windows. +.RE +.PP +\fBroom all\fR +.RS 4 +Show all presence changes in chat room windows. +.RE +.PP +\fBroom online\fR +.RS 4 +Show only online/offline presence changes in chat room windows. +.RE +.PP +\fBroom none\fR +.RS 4 +Don't show any presence changes in chat room windows. +.RE + +.SH EXAMPLES +/presence titlebar off + +.LP +/presence console none + +.LP +/presence chat online + +.LP +/presence room all + +.LP diff --git a/docs/profanity-priority.1 b/docs/profanity-priority.1 new file mode 100644 index 00000000..6a3f2ec2 --- /dev/null +++ b/docs/profanity-priority.1 @@ -0,0 +1,19 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/priority + +.SH DESCRIPTION +Set priority for the current account. See the /account command for specific priority settings per presence status. + +.SH SYNOPSIS +/priority <priority> + +.LP + +.SH ARGUMENTS +.PP +\fB<priority>\fR +.RS 4 +Number between -128 and 127, default: 0. +.RE diff --git a/docs/profanity-privileges.1 b/docs/profanity-privileges.1 new file mode 100644 index 00000000..6f159196 --- /dev/null +++ b/docs/profanity-privileges.1 @@ -0,0 +1,19 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/privileges + +.SH DESCRIPTION +Group occupants panel by role, and show role information in chat rooms. + +.SH SYNOPSIS +/privileges on|off + +.LP + +.SH ARGUMENTS +.PP +\fBon|off\fR +.RS 4 +Enable or disable privilege information. +.RE diff --git a/docs/profanity-quit.1 b/docs/profanity-quit.1 new file mode 100644 index 00000000..3ba24e0c --- /dev/null +++ b/docs/profanity-quit.1 @@ -0,0 +1,12 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/quit + +.SH DESCRIPTION +Logout of any current session, and quit Profanity. + +.SH SYNOPSIS +/quit + +.LP diff --git a/docs/profanity-receipts.1 b/docs/profanity-receipts.1 new file mode 100644 index 00000000..f56f467d --- /dev/null +++ b/docs/profanity-receipts.1 @@ -0,0 +1,27 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/receipts + +.SH DESCRIPTION +Enable or disable message delivery receipts. The interface will indicate when a message has been received. + +.SH SYNOPSIS +/receipts request on|off + +.LP +/receipts send on|off + +.LP + +.SH ARGUMENTS +.PP +\fBrequest on|off\fR +.RS 4 +Whether or not to request a receipt upon sending a message. +.RE +.PP +\fBsend on|off\fR +.RS 4 +Whether or not to send a receipt if one has been requested with a received message. +.RE diff --git a/docs/profanity-reconnect.1 b/docs/profanity-reconnect.1 new file mode 100644 index 00000000..f71c9a4a --- /dev/null +++ b/docs/profanity-reconnect.1 @@ -0,0 +1,19 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/reconnect + +.SH DESCRIPTION +Set the reconnect attempt interval for when the connection is lost. + +.SH SYNOPSIS +/reconnect <seconds> + +.LP + +.SH ARGUMENTS +.PP +\fB<seconds>\fR +.RS 4 +Number of seconds before attempting to reconnect, a value of 0 disables reconnect. +.RE diff --git a/docs/profanity-reload.1 b/docs/profanity-reload.1 new file mode 100644 index 00000000..5b0e0729 --- /dev/null +++ b/docs/profanity-reload.1 @@ -0,0 +1,12 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/reload + +.SH DESCRIPTION +Reload preferences from configuration file. + +.SH SYNOPSIS +/reload + +.LP diff --git a/docs/profanity-resource.1 b/docs/profanity-resource.1 new file mode 100644 index 00000000..ea34a102 --- /dev/null +++ b/docs/profanity-resource.1 @@ -0,0 +1,43 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/resource + +.SH DESCRIPTION +Override chat session resource, and manage resource display settings. + +.SH SYNOPSIS +/resource set <resource> + +.LP +/resource off + +.LP +/resource title on|off + +.LP +/resource message on|off + +.LP + +.SH ARGUMENTS +.PP +\fBset <resource>\fR +.RS 4 +Set the resource to which messages will be sent. +.RE +.PP +\fBoff\fR +.RS 4 +Let the server choose which resource to route messages to. +.RE +.PP +\fBtitle on|off\fR +.RS 4 +Show or hide the current resource in the titlebar. +.RE +.PP +\fBmessage on|off\fR +.RS 4 +Show or hide the resource when showing an incoming message. +.RE diff --git a/docs/profanity-role.1 b/docs/profanity-role.1 new file mode 100644 index 00000000..227eca82 --- /dev/null +++ b/docs/profanity-role.1 @@ -0,0 +1,27 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/role + +.SH DESCRIPTION +Manage room roles. Role may be one of moderator, participant, visitor or none. + +.SH SYNOPSIS +/role set <role> <nick> [<reason>] + +.LP +/role list [<role>] + +.LP + +.SH ARGUMENTS +.PP +\fBset <role> <nick> [<reason>]\fR +.RS 4 +Set the role of occupant with nick, with an optional reason. +.RE +.PP +\fBlist [<role>]\fR +.RS 4 +List all occupants with the specified role, or all if none specified. +.RE diff --git a/docs/profanity-room.1 b/docs/profanity-room.1 new file mode 100644 index 00000000..2d2a00c8 --- /dev/null +++ b/docs/profanity-room.1 @@ -0,0 +1,29 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/room + +.SH DESCRIPTION +Chat room configuration. + +.SH SYNOPSIS +/room accept|destroy|config + +.LP + +.SH ARGUMENTS +.PP +\fBaccept\fR +.RS 4 +Accept default room configuration. +.RE +.PP +\fBdestroy\fR +.RS 4 +Reject default room configuration, and destroy the room. +.RE +.PP +\fBconfig\fR +.RS 4 +Edit room configuration. +.RE diff --git a/docs/profanity-rooms.1 b/docs/profanity-rooms.1 new file mode 100644 index 00000000..de83675d --- /dev/null +++ b/docs/profanity-rooms.1 @@ -0,0 +1,60 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/rooms + +.SH DESCRIPTION +List the chat rooms available at the specified conference service. If no argument is supplied, the account preference 'muc.service' is used, 'conference.<domain-part>' by default. The filter argument only shows rooms that contain the provided text, case insensitive. + +.SH SYNOPSIS +/rooms + +.LP +/rooms filter <text> + +.LP +/rooms service <service> + +.LP +/rooms service <service> filter <text> + +.LP +/rooms cache on|off|clear + +.LP + +.SH ARGUMENTS +.PP +\fBservice <service>\fR +.RS 4 +The conference service to query. +.RE +.PP +\fBfilter <text>\fR +.RS 4 +The text to filter results by. +.RE +.PP +\fBcache on|off\fR +.RS 4 +Enable or disable caching of rooms list response, enabled by default. +.RE +.PP +\fBcache clear\fR +.RS 4 +Clear the rooms response cache if enabled. +.RE + +.SH EXAMPLES +/rooms + +.LP +/rooms filter development + +.LP +/rooms service conference.jabber.org + +.LP +/rooms service conference.jabber.org filter "News Room" + +.LP diff --git a/docs/profanity-roster.1 b/docs/profanity-roster.1 new file mode 100644 index 00000000..2027e4bf --- /dev/null +++ b/docs/profanity-roster.1 @@ -0,0 +1,546 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/roster + +.SH DESCRIPTION +Manage your roster, and roster display settings. Passing no arguments lists all contacts in your roster. + +.SH SYNOPSIS +/roster + +.LP +/roster online + +.LP +/roster show [offline|resource|presence|status|empty|priority|contacts|rooms] + +.LP +/roster hide [offline|resource|presence|status|empty|priority|contacts|rooms] + +.LP +/roster by group|presence|none + +.LP +/roster count unread|items|off + +.LP +/roster count zero on|off + +.LP +/roster color on|off + +.LP +/roster order name|presence + +.LP +/roster unread before|after|off + +.LP +/roster room char <char>|none + +.LP +/roster room private char <char>|none + +.LP +/roster room position first|last + +.LP +/roster room by service|none + +.LP +/roster room order name|unread + +.LP +/roster room unread before|after|off + +.LP +/roster room show server + +.LP +/roster room hide server + +.LP +/roster room use name|jid + +.LP +/roster private room|group|off + +.LP +/roster private char <char>|none + +.LP +/roster header char <char>|none + +.LP +/roster presence indent <indent> + +.LP +/roster contact char <char>|none + +.LP +/roster contact indent <indent> + +.LP +/roster resource char <char>|none + +.LP +/roster resource indent <indent> + +.LP +/roster resource join on|off + +.LP +/roster size <percent> + +.LP +/roster wrap on|off + +.LP +/roster add <jid> [<nick>] + +.LP +/roster remove <jid> + +.LP +/roster remove_all contacts + +.LP +/roster nick <jid> <nick> + +.LP +/roster clearnick <jid> + +.LP +/roster group + +.LP +/roster group show <group> + +.LP +/roster group add <group> <contat> + +.LP +/roster group remove <group> <contact> + +.LP + +.SH ARGUMENTS +.PP +\fBonline\fR +.RS 4 +Show all online contacts in console. +.RE +.PP +\fBshow\fR +.RS 4 +Show the roster panel. +.RE +.PP +\fBshow offline\fR +.RS 4 +Show offline contacts in roster panel. +.RE +.PP +\fBshow resource\fR +.RS 4 +Show contact's connected resources in roster panel. +.RE +.PP +\fBshow presence\fR +.RS 4 +Show contact's presence in roster panel. +.RE +.PP +\fBshow status\fR +.RS 4 +Show contact's status message in roster panel. +.RE +.PP +\fBshow empty\fR +.RS 4 +Show empty groups in roster panel. +.RE +.PP +\fBshow priority\fR +.RS 4 +Show resource priority in roster panel. +.RE +.PP +\fBshow contacts\fR +.RS 4 +Show contacts in roster panel. +.RE +.PP +\fBshow rooms\fR +.RS 4 +Show chat rooms in roster panel. +.RE +.PP +\fBhide\fR +.RS 4 +Hide the roster panel. +.RE +.PP +\fBhide offline\fR +.RS 4 +Hide offline contacts in roster panel. +.RE +.PP +\fBhide resource\fR +.RS 4 +Hide contact's connected resources in roster panel. +.RE +.PP +\fBhide presence\fR +.RS 4 +Hide contact's presence in roster panel. +.RE +.PP +\fBhide status\fR +.RS 4 +Hide contact's status message in roster panel. +.RE +.PP +\fBhide empty\fR +.RS 4 +Hide empty groups in roster panel. +.RE +.PP +\fBhide priority\fR +.RS 4 +Hide resource priority in roster panel. +.RE +.PP +\fBhide contacts\fR +.RS 4 +Hide contacts in roster panel. +.RE +.PP +\fBhide rooms\fR +.RS 4 +Hide chat rooms in roster panel. +.RE +.PP +\fBby group\fR +.RS 4 +Group contacts in roster panel by roster group. +.RE +.PP +\fBby presence\fR +.RS 4 +Group contacts in roster panel by presence. +.RE +.PP +\fBby none\fR +.RS 4 +No grouping in roster panel. +.RE +.PP +\fBcount unread\fR +.RS 4 +Show unread message count with roster headers. +.RE +.PP +\fBcount items\fR +.RS 4 +Show item count with roster headers. +.RE +.PP +\fBcount off\fR +.RS 4 +Do not show any count with roster headers. +.RE +.PP +\fBcount zero on\fR +.RS 4 +Show roster header count when 0. +.RE +.PP +\fBcount zero off\fR +.RS 4 +Hide roster header count when 0. +.RE +.PP +\fBcolor on\fR +.RS 4 +Enable generated color names (XEP-0392) +.RE +.PP +\fBcolor off\fR +.RS 4 +Disable generated color names (XEP-0392) +.RE +.PP +\fBorder name\fR +.RS 4 +Order roster contacts by name only. +.RE +.PP +\fBorder presence\fR +.RS 4 +Order roster contacts by presence, and then by name. +.RE +.PP +\fBunread before\fR +.RS 4 +Show unread message count before contact. +.RE +.PP +\fBunread after\fR +.RS 4 +Show unread message count after contact. +.RE +.PP +\fBunread off\fR +.RS 4 +Do not show unread message count for contacts. +.RE +.PP +\fBroom char <char>\fR +.RS 4 +Prefix rooms with specified character. +.RE +.PP +\fBroom char none\fR +.RS 4 +Remove room character prefix. +.RE +.PP +\fBroom private char <char>\fR +.RS 4 +Prefix private room chat with specified character when displayed with room. +.RE +.PP +\fBroom private char none\fR +.RS 4 +Remove private room chat character prefix when displayed with room. +.RE +.PP +\fBroom position first\fR +.RS 4 +Show rooms first in roster. +.RE +.PP +\fBroom position last\fR +.RS 4 +Show rooms last in roster. +.RE +.PP +\fBroom by service\fR +.RS 4 +Group rooms by chat service. +.RE +.PP +\fBroom by none\fR +.RS 4 +Do not group rooms. +.RE +.PP +\fBroom order name\fR +.RS 4 +Order rooms by name. +.RE +.PP +\fBroom order unread\fR +.RS 4 +Order rooms by unread messages, and then by name. +.RE +.PP +\fBroom unread before\fR +.RS 4 +Show unread message count before room. +.RE +.PP +\fBroom unread after\fR +.RS 4 +Show unread message count after room. +.RE +.PP +\fBroom unread off\fR +.RS 4 +Do not show unread message count for rooms. +.RE +.PP +\fBroom show server\fR +.RS 4 +Show the conference server with room JIDs. +.RE +.PP +\fBroom hide server\fR +.RS 4 +Do not show the conference server with room JIDs. +.RE +.PP +\fBroom use name\fR +.RS 4 +Use the MUC name as room name. +.RE +.PP +\fBroom use jid\fR +.RS 4 +Use the JID as room name. +.RE +.PP +\fBprivate room\fR +.RS 4 +Show room private chats with the room. +.RE +.PP +\fBprivate group\fR +.RS 4 +Show room private chats as a separate roster group. +.RE +.PP +\fBprivate off\fR +.RS 4 +Do not show room private chats. +.RE +.PP +\fBprivate char <char>\fR +.RS 4 +Prefix private room chats with specified character when displayed in separate group. +.RE +.PP +\fBprivate char none\fR +.RS 4 +Remove private room chat character prefix. +.RE +.PP +\fBheader char <char>\fR +.RS 4 +Prefix roster headers with specified character. +.RE +.PP +\fBheader char none\fR +.RS 4 +Remove roster header character prefix. +.RE +.PP +\fBcontact char <char>\fR +.RS 4 +Prefix roster contacts with specified character. +.RE +.PP +\fBcontact char none\fR +.RS 4 +Remove roster contact character prefix. +.RE +.PP +\fBcontact indent <indent>\fR +.RS 4 +Indent contact line by <indent> spaces (0 to 10). +.RE +.PP +\fBresource char <char>\fR +.RS 4 +Prefix roster resources with specified character. +.RE +.PP +\fBresource char none\fR +.RS 4 +Remove roster resource character prefix. +.RE +.PP +\fBresource indent <indent>\fR +.RS 4 +Indent resource line by <indent> spaces (0 to 10). +.RE +.PP +\fBresource join on|off\fR +.RS 4 +Join resource with previous line when only one available resource. +.RE +.PP +\fBpresence indent <indent>\fR +.RS 4 +Indent presence line by <indent> spaces (-1 to 10), a value of -1 will show presence on the previous line. +.RE +.PP +\fBsize <percent>\fR +.RS 4 +Percentage of the screen taken up by the roster (1-99). +.RE +.PP +\fBwrap on|off\fR +.RS 4 +Enable or disable line wrapping in roster panel. +.RE +.PP +\fBadd <jid> [<nick>]\fR +.RS 4 +Add a new item to the roster. +.RE +.PP +\fBremove <jid>\fR +.RS 4 +Removes an item from the roster. +.RE +.PP +\fBremove_all contacts\fR +.RS 4 +Remove all items from roster. +.RE +.PP +\fBnick <jid> <nick>\fR +.RS 4 +Change a contacts nickname. +.RE +.PP +\fBclearnick <jid>\fR +.RS 4 +Removes the current nickname. +.RE +.PP +\fBgroup show <group>\fR +.RS 4 +List all roster items in a group. +.RE +.PP +\fBgroup add <group> <contact>\fR +.RS 4 +Add a contact to a group. +.RE +.PP +\fBgroup remove <group> <contact>\fR +.RS 4 +Remove a contact from a group. +.RE + +.SH EXAMPLES +/roster + +.LP +/roster add odin@valhalla.edda + +.LP +/roster add odin@valhalla.edda Allfather + +.LP +/roster remove loki@ownserver.org + +.LP +/roster nick odin@valhalla.edda "All Father" + +.LP +/roster clearnick thor@valhalla.edda + +.LP +/roster size 15 + +.LP +/roster group + +.LP +/roster group show friends + +.LP +/roster group add friends fenris@ownserver.org + +.LP +/roster group add family Brother + +.LP +/roster group remove colleagues boss@work.com + +.LP diff --git a/docs/profanity-save.1 b/docs/profanity-save.1 new file mode 100644 index 00000000..a9ee4017 --- /dev/null +++ b/docs/profanity-save.1 @@ -0,0 +1,12 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/save + +.SH DESCRIPTION +Save preferences to configuration file. + +.SH SYNOPSIS +/save + +.LP diff --git a/docs/profanity-script.1 b/docs/profanity-script.1 new file mode 100644 index 00000000..9d4d6860 --- /dev/null +++ b/docs/profanity-script.1 @@ -0,0 +1,46 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/script + +.SH DESCRIPTION +Run command scripts. Scripts are stored in $XDG_DATA_HOME/profanity/scripts/ which is usually $HOME/.local/share/profanity/scripts/. + +.SH SYNOPSIS +/script run <script> + +.LP +/script list + +.LP +/script show <script> + +.LP + +.SH ARGUMENTS +.PP +\fBscript run <script>\fR +.RS 4 +Execute a script. +.RE +.PP +\fBscript list\fR +.RS 4 +List all scripts TODO. +.RE +.PP +\fBscript show <script>\fR +.RS 4 +Show the commands in script TODO. +.RE + +.SH EXAMPLES +/script list + +.LP +/script run myscript + +.LP +/script show somescript + +.LP diff --git a/docs/profanity-sendfile.1 b/docs/profanity-sendfile.1 new file mode 100644 index 00000000..7cc9de15 --- /dev/null +++ b/docs/profanity-sendfile.1 @@ -0,0 +1,27 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/sendfile + +.SH DESCRIPTION +Send a file using XEP-0363 HTTP file transfer. + +.SH SYNOPSIS +/sendfile <file> + +.LP + +.SH ARGUMENTS +.PP +\fB<file>\fR +.RS 4 +Path to the file. +.RE + +.SH EXAMPLES +/sendfile /etc/hosts + +.LP +/sendfile ~/images/sweet_cat.jpg + +.LP diff --git a/docs/profanity-serversoftware.1 b/docs/profanity-serversoftware.1 new file mode 100644 index 00000000..4e9bcb62 --- /dev/null +++ b/docs/profanity-serversoftware.1 @@ -0,0 +1,27 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/serversoftware + +.SH DESCRIPTION +Find server or component software version information. + +.SH SYNOPSIS +/serversoftware <domain> + +.LP + +.SH ARGUMENTS +.PP +\fB<domain>\fR +.RS 4 +The jid of your server or component. +.RE + +.SH EXAMPLES +/serversoftware valhalla.edda + +.LP +/serversoftware xmpp.vanaheimr.edda + +.LP diff --git a/docs/profanity-silence.1 b/docs/profanity-silence.1 new file mode 100644 index 00000000..23fd3c70 --- /dev/null +++ b/docs/profanity-silence.1 @@ -0,0 +1,12 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/silence + +.SH DESCRIPTION +Let's you silence all message attempts from people who are not in your roster. + +.SH SYNOPSIS +/silence on|off + +.LP diff --git a/docs/profanity-slashguard.1 b/docs/profanity-slashguard.1 new file mode 100644 index 00000000..3a57fb3d --- /dev/null +++ b/docs/profanity-slashguard.1 @@ -0,0 +1,19 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/slashguard + +.SH DESCRIPTION +Slashguard won't accept a slash in the first 4 characters of your input field. It tries to protect you from typing ' /quit' and similar things in chats. + +.SH SYNOPSIS +/slashguard on|off + +.LP + +.SH ARGUMENTS +.PP +\fBon|off\fR +.RS 4 +Enable or disable slashguard. +.RE diff --git a/docs/profanity-software.1 b/docs/profanity-software.1 new file mode 100644 index 00000000..816379e9 --- /dev/null +++ b/docs/profanity-software.1 @@ -0,0 +1,38 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/software + +.SH DESCRIPTION +Find out a contact, or room members software version information. If in private chat initiated from a chat room, no parameter is required. If the contact's software does not support software version requests, nothing will be displayed. + +.SH SYNOPSIS +/software + +.LP +/software <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 software information. +.RE +.PP +\fB<nick>\fR +.RS 4 +If in a chat room, nickname for which you wish to see software information. +.RE + +.SH EXAMPLES +/software odin@valhalla.edda/laptop + +.LP +/software odin@valhalla.edda/phone + +.LP +/software thor + +.LP diff --git a/docs/profanity-splash.1 b/docs/profanity-splash.1 new file mode 100644 index 00000000..0b9d4ee6 --- /dev/null +++ b/docs/profanity-splash.1 @@ -0,0 +1,19 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/splash + +.SH DESCRIPTION +Switch on or off the ascii logo on start up and when the /about command is called. + +.SH SYNOPSIS +/splash on|off + +.LP + +.SH ARGUMENTS +.PP +\fBon|off\fR +.RS 4 +Enable or disable splash logo. +.RE diff --git a/docs/profanity-states.1 b/docs/profanity-states.1 new file mode 100644 index 00000000..e1d826e5 --- /dev/null +++ b/docs/profanity-states.1 @@ -0,0 +1,19 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/states + +.SH DESCRIPTION +Send chat state notifications to recipient during chat sessions, such as typing, paused, active, gone. + +.SH SYNOPSIS +/states on|off + +.LP + +.SH ARGUMENTS +.PP +\fBon|off\fR +.RS 4 +Enable or disable sending of chat state notifications. +.RE diff --git a/docs/profanity-status.1 b/docs/profanity-status.1 new file mode 100644 index 00000000..5edfec2c --- /dev/null +++ b/docs/profanity-status.1 @@ -0,0 +1,48 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/status + +.SH DESCRIPTION +/status get: Find out a contact, or room members presence information. /status set: set own status. + +.SH SYNOPSIS +/status set <state> ["<message>"] + +.LP +/status get <contact>|<nick> + +.LP + +.SH ARGUMENTS +.PP +\fB<state>\fR +.RS 4 +Own status. Possible values: chat, online, away, dnd, xa +.RE +.PP +\fB<message>\fR +.RS 4 +Optional message to use with the status. Needs quotation marks if it's more than one word. +.RE +.PP +\fB<contact>\fR +.RS 4 +The contact who's presence you which to see. +.RE +.PP +\fB<nick>\fR +.RS 4 +If in a chat room, the occupant who's presence you wish to see. +.RE + +.SH EXAMPLES +/status get odin@valhalla.edda + +.LP +/status get jon + +.LP +/status set online + +.LP diff --git a/docs/profanity-statusbar.1 b/docs/profanity-statusbar.1 new file mode 100644 index 00000000..879917c2 --- /dev/null +++ b/docs/profanity-statusbar.1 @@ -0,0 +1,113 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/statusbar + +.SH DESCRIPTION +Manage statusbar display preferences. + +.SH SYNOPSIS +/statusbar show name|number|read + +.LP +/statusbar hide name|number|read + +.LP +/statusbar maxtabs <value> + +.LP +/statusbar tablen <value> + +.LP +/statusbar self user|barejid|fulljid|off + +.LP +/statusbar chat user|jid + +.LP +/statusbar room room|jid + +.LP +/statusbar up + +.LP +/statusbar down + +.LP + +.SH ARGUMENTS +.PP +\fBmaxtabs <value>\fR +.RS 4 +Set the maximum number of tabs to display, <value> must be between 0 and 10. +.RE +.PP +\fBtablen <value>\fR +.RS 4 +Set the maximum number of characters to show as the tab name, 0 sets to unlimited. +.RE +.PP +\fBshow|hide name\fR +.RS 4 +Show or hide names in tabs. +.RE +.PP +\fBshow|hide number\fR +.RS 4 +Show or hide numbers in tabs. +.RE +.PP +\fBshow|hide read\fR +.RS 4 +Show or hide inactive tabs. +.RE +.PP +\fBself user|barejid|fulljid\fR +.RS 4 +Show account user name, barejid, fulljid as status bar title. +.RE +.PP +\fBself off\fR +.RS 4 +Disable showing self as status bar title. +.RE +.PP +\fBchat user|jid\fR +.RS 4 +Show users name, or the fulljid if no nick is present for chat tabs. +.RE +.PP +\fBroom room|jid\fR +.RS 4 +Show room name, or the fulljid for room tabs. +.RE +.PP +\fBup\fR +.RS 4 +Move the status bar up the screen. +.RE +.PP +\fBdown\fR +.RS 4 +Move the status bar down the screen. +.RE + +.SH EXAMPLES +/statusbar maxtabs 8 + +.LP +/statusbar tablen 5 + +.LP +/statusbar self user + +.LP +/statusbar chat jid + +.LP +/statusbar hide read + +.LP +/statusbar hide name + +.LP diff --git a/docs/profanity-sub.1 b/docs/profanity-sub.1 new file mode 100644 index 00000000..2e3f7e8d --- /dev/null +++ b/docs/profanity-sub.1 @@ -0,0 +1,73 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/sub + +.SH DESCRIPTION +Manage subscriptions to contact presence. If jid is omitted, the contact of the current window is used. + +.SH SYNOPSIS +/sub request [<jid>] + +.LP +/sub allow [<jid>] + +.LP +/sub deny [<jid>] + +.LP +/sub show [<jid>] + +.LP +/sub sent + +.LP +/sub received + +.LP + +.SH ARGUMENTS +.PP +\fBrequest [<jid>]\fR +.RS 4 +Send a subscription request to the user. +.RE +.PP +\fBallow [<jid>]\fR +.RS 4 +Approve a contact's subscription request. +.RE +.PP +\fBdeny [<jid>]\fR +.RS 4 +Remove subscription for a contact, or deny a request. +.RE +.PP +\fBshow [<jid>]\fR +.RS 4 +Show subscription status for a contact. +.RE +.PP +\fBsent\fR +.RS 4 +Show all sent subscription requests pending a response. +.RE +.PP +\fBreceived\fR +.RS 4 +Show all received subscription requests awaiting your response. +.RE + +.SH EXAMPLES +/sub request odin@valhalla.edda + +.LP +/sub allow odin@valhalla.edda + +.LP +/sub request + +.LP +/sub sent + +.LP diff --git a/docs/profanity-subject.1 b/docs/profanity-subject.1 new file mode 100644 index 00000000..2bef7611 --- /dev/null +++ b/docs/profanity-subject.1 @@ -0,0 +1,51 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/subject + +.SH DESCRIPTION +Set, modify, or clear room subject. + +.SH SYNOPSIS +/subject set <subject> + +.LP +/subject edit <subject> + +.LP +/subject prepend <text> + +.LP +/subject append <text> + +.LP +/subject clear + +.LP + +.SH ARGUMENTS +.PP +\fBset <subject>\fR +.RS 4 +Set the room subject. +.RE +.PP +\fBedit <subject>\fR +.RS 4 +Edit the current room subject, tab autocompletion will display the subject to edit. +.RE +.PP +\fBprepend <text>\fR +.RS 4 +Prepend text to the current room subject, use double quotes if a trailing space is needed. +.RE +.PP +\fBappend <text>\fR +.RS 4 +Append text to the current room subject, use double quotes if a preceding space is needed. +.RE +.PP +\fBclear\fR +.RS 4 +Clear the room subject. +.RE diff --git a/docs/profanity-theme.1 b/docs/profanity-theme.1 new file mode 100644 index 00000000..153e464f --- /dev/null +++ b/docs/profanity-theme.1 @@ -0,0 +1,59 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/theme + +.SH DESCRIPTION +Load a theme, includes colours and UI options. + +.SH SYNOPSIS +/theme list + +.LP +/theme load <theme> + +.LP +/theme full-load <theme> + +.LP +/theme colours + +.LP +/theme properties + +.LP + +.SH ARGUMENTS +.PP +\fBlist\fR +.RS 4 +List all available themes. +.RE +.PP +\fBload <theme>\fR +.RS 4 +Load colours from specified theme. 'default' will reset to the default theme. +.RE +.PP +\fBfull-load <theme>\fR +.RS 4 +Same as 'load' but will also load preferences set in the theme, not just colours. +.RE +.PP +\fBcolours\fR +.RS 4 +Show colour values as rendered by the terminal. +.RE +.PP +\fBproperties\fR +.RS 4 +Show colour settings for current theme. +.RE + +.SH EXAMPLES +/theme list + +.LP +/theme load forest + +.LP diff --git a/docs/profanity-time.1 b/docs/profanity-time.1 new file mode 100644 index 00000000..24dd8b0f --- /dev/null +++ b/docs/profanity-time.1 @@ -0,0 +1,131 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/time + +.SH DESCRIPTION +Configure time display preferences. Time formats are strings supported by g_date_time_format. See https://developer.gnome.org/glib/stable/glib-GDateTime.html#g-date-time-format for more details. Setting the format to an unsupported string, will display the string. If the format contains spaces, it must be surrounded with double quotes. + +.SH SYNOPSIS +/time all|console|chat|muc|config|private|xml set <format> + +.LP +/time all|console|chat|muc|config|private|xml off + +.LP +/time statusbar set <format> + +.LP +/time statusbar off + +.LP +/time lastactivity set <format> + +.LP + +.SH ARGUMENTS +.PP +\fBconsole set <format>\fR +.RS 4 +Set time format for console window. +.RE +.PP +\fBconsole off\fR +.RS 4 +Do not show time in console window. +.RE +.PP +\fBchat set <format>\fR +.RS 4 +Set time format for chat windows. +.RE +.PP +\fBchat off\fR +.RS 4 +Do not show time in chat windows. +.RE +.PP +\fBmuc set <format>\fR +.RS 4 +Set time format for chat room windows. +.RE +.PP +\fBmuc off\fR +.RS 4 +Do not show time in chat room windows. +.RE +.PP +\fBconfig set <format>\fR +.RS 4 +Set time format for config windows. +.RE +.PP +\fBconfig off\fR +.RS 4 +Do not show time in config windows. +.RE +.PP +\fBprivate set <format>\fR +.RS 4 +Set time format for private chat windows. +.RE +.PP +\fBprivate off\fR +.RS 4 +Do not show time in private chat windows. +.RE +.PP +\fBxml set <format>\fR +.RS 4 +Set time format for XML console window. +.RE +.PP +\fBxml off\fR +.RS 4 +Do not show time in XML console window. +.RE +.PP +\fBstatusbar set <format>\fR +.RS 4 +Change time format in statusbar. +.RE +.PP +\fBstatusbar off\fR +.RS 4 +Do not show time in status bar. +.RE +.PP +\fBlastactivity set <format>\fR +.RS 4 +Change time format for last activity. +.RE +.PP +\fBall set <format>\fR +.RS 4 +Set time for: console, chat, muc, config, private and xml windows. +.RE +.PP +\fBall off\fR +.RS 4 +Do not show time for: console, chat, muc, config, private and xml windows. +.RE + +.SH EXAMPLES +/time console set %H:%M:%S + +.LP +/time chat set "%d-%m-%y %H:%M:%S" + +.LP +/time xml off + +.LP +/time statusbar set %H:%M + +.LP +/time lastactivity set "%d-%m-%y %H:%M:%S" + +.LP +/time all set "%d-%m-%y %H:%M:%S" + +.LP diff --git a/docs/profanity-titlebar.1 b/docs/profanity-titlebar.1 new file mode 100644 index 00000000..6c921fbe --- /dev/null +++ b/docs/profanity-titlebar.1 @@ -0,0 +1,66 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/titlebar + +.SH DESCRIPTION +Titlebar settings. + +.SH SYNOPSIS +/titlebar up + +.LP +/titlebar down + +.LP +/titlebar show|hide [encwarn|resource|tls] + +.LP + +.SH ARGUMENTS +.PP +\fBup\fR +.RS 4 +Move the title bar up the screen. +.RE +.PP +\fBdown\fR +.RS 4 +Move the title bar down the screen. +.RE +.PP +\fBshow tls\fR +.RS 4 +Show or hide TLS indicator in the titlebar. +.RE +.PP +\fBshow encwarn\fR +.RS 4 +Enable or disable the unencrypted warning message in the titlebar. +.RE +.PP +\fBshow resource\fR +.RS 4 +Show or hide the current resource in the titlebar. +.RE +.PP +\fBshow name\fR +.RS 4 +In case of a MUC. Show the MUC name in the titlebar. +.RE +.PP +\fBshow jid\fR +.RS 4 +In case of a MUC. Show the JID in the titlebar. +.RE + +.SH EXAMPLES +/titlebar up + +.LP +/titlebar show tls + +.LP +/titlebar hide encwarn + +.LP diff --git a/docs/profanity-tls.1 b/docs/profanity-tls.1 new file mode 100644 index 00000000..4757aaf7 --- /dev/null +++ b/docs/profanity-tls.1 @@ -0,0 +1,104 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/tls + +.SH DESCRIPTION +Handle TLS certificates. + +.SH SYNOPSIS +/tls allow + +.LP +/tls always + +.LP +/tls deny + +.LP +/tls cert [<fingerprint>] + +.LP +/tls trust + +.LP +/tls trusted + +.LP +/tls revoke <fingerprint> + +.LP +/tls certpath + +.LP +/tls certpath set <path> + +.LP +/tls certpath clear + +.LP +/tls certpath default + +.LP + +.SH ARGUMENTS +.PP +\fBallow\fR +.RS 4 +Allow connection to continue with TLS certificate. +.RE +.PP +\fBalways\fR +.RS 4 +Always allow connections with TLS certificate. +.RE +.PP +\fBdeny\fR +.RS 4 +Abort connection. +.RE +.PP +\fBcert\fR +.RS 4 +Show the current TLS certificate. +.RE +.PP +\fBcert <fingerprint>\fR +.RS 4 +Show details of trusted certificate. +.RE +.PP +\fBtrust\fR +.RS 4 +Add the current TLS certificate to manually trusted certificates. +.RE +.PP +\fBtrusted\fR +.RS 4 +List summary of manually trusted certificates (with '/tls always' or '/tls trust'). +.RE +.PP +\fBrevoke <fingerprint>\fR +.RS 4 +Remove a manually trusted certificate. +.RE +.PP +\fBcertpath\fR +.RS 4 +Show the trusted certificate path. +.RE +.PP +\fBcertpath set <path>\fR +.RS 4 +Specify filesystem path containing trusted certificates. +.RE +.PP +\fBcertpath clear\fR +.RS 4 +Clear the trusted certificate path. +.RE +.PP +\fBcertpath default\fR +.RS 4 +Use default system certificate path, if it can be found. +.RE diff --git a/docs/profanity-tray.1 b/docs/profanity-tray.1 new file mode 100644 index 00000000..9cbe782c --- /dev/null +++ b/docs/profanity-tray.1 @@ -0,0 +1,35 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/tray + +.SH DESCRIPTION +Display an icon in the tray that will indicate new messages. + +.SH SYNOPSIS +/tray on|off + +.LP +/tray read on|off + +.LP +/tray timer <seconds> + +.LP + +.SH ARGUMENTS +.PP +\fBon|off\fR +.RS 4 +Show tray icon. +.RE +.PP +\fBread on|off\fR +.RS 4 +Show tray icon when no unread messages. +.RE +.PP +\fBtimer <seconds>\fR +.RS 4 +Set tray icon timer, seconds must be between 1-10. +.RE diff --git a/docs/profanity-url.1 b/docs/profanity-url.1 new file mode 100644 index 00000000..e0c645c6 --- /dev/null +++ b/docs/profanity-url.1 @@ -0,0 +1,35 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/url + +.SH DESCRIPTION +Deal with URLs + +.SH SYNOPSIS +/url open <url> + +.LP +/url save <url> [<path>] + +.LP + +.SH ARGUMENTS +.PP +\fBopen\fR +.RS 4 +Open URL with predefined executable. +.RE +.PP +\fBsave\fR +.RS 4 +Save URL to optional path, default path is current directory +.RE + +.SH EXAMPLES +/url open https://profanity-im.github.io + +.LP +/url save https://profanity-im.github.io/guide/latest/userguide.html /home/user/Download/ + +.LP diff --git a/docs/profanity-vercheck.1 b/docs/profanity-vercheck.1 new file mode 100644 index 00000000..0293334d --- /dev/null +++ b/docs/profanity-vercheck.1 @@ -0,0 +1,19 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/vercheck + +.SH DESCRIPTION +Check for new versions when Profanity starts, and when the /about command is run. + +.SH SYNOPSIS +/vercheck on|off + +.LP + +.SH ARGUMENTS +.PP +\fBon|off\fR +.RS 4 +Enable or disable the version check. +.RE diff --git a/docs/profanity-who.1 b/docs/profanity-who.1 new file mode 100644 index 00000000..43013ead --- /dev/null +++ b/docs/profanity-who.1 @@ -0,0 +1,83 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/who + +.SH DESCRIPTION +Show contacts or room occupants with chosen status, role or affiliation. + +.SH SYNOPSIS +/who + +.LP +/who online|offline|away|dnd|xa|chat|available|unavailable|any [<group>] + +.LP +/who moderator|participant|visitor + +.LP +/who owner|admin|member + +.LP + +.SH ARGUMENTS +.PP +\fBoffline|away|dnd|xa|chat\fR +.RS 4 +Show contacts or room occupants with specified presence. +.RE +.PP +\fBonline\fR +.RS 4 +Contacts that are online, chat, away, xa, dnd. +.RE +.PP +\fBavailable\fR +.RS 4 +Contacts that are available for chat - online, chat. +.RE +.PP +\fBunavailable\fR +.RS 4 +Contacts that are not available for chat - offline, away, xa, dnd. +.RE +.PP +\fBany\fR +.RS 4 +Contacts with any status (same as calling with no argument). +.RE +.PP +\fB<group>\fR +.RS 4 +Filter the results by the specified roster group, not applicable in chat rooms. +.RE +.PP +\fBmoderator|participant|visitor\fR +.RS 4 +Room occupants with the specified role. +.RE +.PP +\fBowner|admin|member\fR +.RS 4 +Room occupants with the specified affiliation. +.RE + +.SH EXAMPLES +/who + +.LP +/who xa + +.LP +/who online friends + +.LP +/who any family + +.LP +/who participant + +.LP +/who admin + +.LP diff --git a/docs/profanity-win.1 b/docs/profanity-win.1 new file mode 100644 index 00000000..eecfea8c --- /dev/null +++ b/docs/profanity-win.1 @@ -0,0 +1,98 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/win + +.SH DESCRIPTION +Move to the specified window. + +.SH SYNOPSIS +/win console + +.LP +/win <num> + +.LP +/win <barejid> + +.LP +/win <nick> + +.LP +/win <roomjid> + +.LP +/win <roomoccupantjid> + +.LP +/win xmlconsole + +.LP +/win <plugin> + +.LP + +.SH ARGUMENTS +.PP +\fBconsole\fR +.RS 4 +Focus the Console window. +.RE +.PP +\fB<num>\fR +.RS 4 +Focus specified window number. +.RE +.PP +\fB<barejid>\fR +.RS 4 +Focus chat window with contact by JID if open. +.RE +.PP +\fB<nick>\fR +.RS 4 +Focus chat window with contact by nickname if open. +.RE +.PP +\fB<roomjid>\fR +.RS 4 +Focus chat room window with roomjid if open. +.RE +.PP +\fB<roomoccupantjid>\fR +.RS 4 +Focus private chat roomoccupantjid if open. +.RE +.PP +\fBxmlconsole\fR +.RS 4 +Focus the XML Console window if open. +.RE +.PP +\fB<plugin>\fR +.RS 4 +Focus the plugin window. +.RE + +.SH EXAMPLES +/win console + +.LP +/win 4 + +.LP +/win odin@valhalla.edda + +.LP +/win Eddie + +.LP +/win bigroom@conference.chat.org + +.LP +/win bigroom@conference.chat.org/thor + +.LP +/win wikipedia + +.LP diff --git a/docs/profanity-wins.1 b/docs/profanity-wins.1 new file mode 100644 index 00000000..0ee53080 --- /dev/null +++ b/docs/profanity-wins.1 @@ -0,0 +1,46 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/wins + +.SH DESCRIPTION +Manage windows. Passing no argument will list all currently active windows and information about their usage. + +.SH SYNOPSIS +/wins + +.LP +/wins unread + +.LP +/wins attention + +.LP +/wins prune + +.LP +/wins swap <source> <target> + +.LP + +.SH ARGUMENTS +.PP +\fBunread\fR +.RS 4 +List windows with unread messages. +.RE +.PP +\fBattention\fR +.RS 4 +List windows that have been marked with the attention flag (alt+v). You can toggle between marked windows with alt+m. +.RE +.PP +\fBprune\fR +.RS 4 +Close all windows with no unread messages. +.RE +.PP +\fBswap <source> <target>\fR +.RS 4 +Swap windows, target may be an empty position. +.RE diff --git a/docs/profanity-wintitle.1 b/docs/profanity-wintitle.1 new file mode 100644 index 00000000..951099bc --- /dev/null +++ b/docs/profanity-wintitle.1 @@ -0,0 +1,27 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/wintitle + +.SH DESCRIPTION +Allow Profanity to modify the window title bar. + +.SH SYNOPSIS +/wintitle show on|off + +.LP +/wintitle goodbye on|off + +.LP + +.SH ARGUMENTS +.PP +\fBshow on|off\fR +.RS 4 +Show current logged in user, and unread messages as the window title. +.RE +.PP +\fBgoodbye on|off\fR +.RS 4 +Show a message in the title when exiting profanity. +.RE diff --git a/docs/profanity-wrap.1 b/docs/profanity-wrap.1 new file mode 100644 index 00000000..d835353a --- /dev/null +++ b/docs/profanity-wrap.1 @@ -0,0 +1,19 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/wrap + +.SH DESCRIPTION +Word wrapping. + +.SH SYNOPSIS +/wrap on|off + +.LP + +.SH ARGUMENTS +.PP +\fBon|off\fR +.RS 4 +Enable or disable word wrapping in the main window. +.RE diff --git a/docs/profanity-xmlconsole.1 b/docs/profanity-xmlconsole.1 new file mode 100644 index 00000000..8a6a174f --- /dev/null +++ b/docs/profanity-xmlconsole.1 @@ -0,0 +1,12 @@ +.TH man 1 "2021-09-28" "0.11.0" "Profanity XMPP client" + +.SH NAME +/xmlconsole + +.SH DESCRIPTION +Open the XML console to view incoming and outgoing XMPP traffic. + +.SH SYNOPSIS +/xmlconsole + +.LP diff --git a/docs/profanity.1 b/docs/profanity.1 index 39e7a386..6f44b297 100644 --- a/docs/profanity.1 +++ b/docs/profanity.1 @@ -1,4 +1,4 @@ -.TH man 1 "2021-01-09" "0.10.0" "Profanity XMPP client" +.TH man 1 "2021-09-28" "0.11.1" "Profanity XMPP client" .SH NAME Profanity \- a simple console based XMPP chat client. .SH SYNOPSIS |