aniani/profanity
1
0
Fork 0
mirror of https://github.com/profanity-im/profanity.git synced 2024-06-09 21:30:42 +00:00
Code

doscs: Add terminology section to man page

Browse Source 
Let's just define some basic terminology.

In many sections of the /help we actually use these terms.
This should help new users understand what they mean.
This commit is contained in:
Michael Vetter 2023-04-17 11:24:26 +02:00
parent 46cba28292
commit 1b679498b6
1 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/profanity.1
View File

@ -123,10 +123,22 @@ OpenPGP (/pgp) is defined in XEP-0027. Is uses a public and secret key. It is al
.TP
.BR OX
OX (/ox) is defined in XEP-0373 and XEP-0374. It's a more modern way to use OpenPGP on XMPP and tries to fix the shortcomings of legacy XEP-0027. Servers need to support PEP (XEP-0163). MUCs and file transfer via HTTP upload are not specified and thus not supported.
.TP
.BR DETAILS
For more details read the relevant XEPs and look at the overview at <https://wiki.xmpp.org/web/XMPP_E2E_Security>
.SH TERMINOLOGY
There is some XMPP specific terminology that might be unknown for fresh users. We will try to describe them here since they are often references in the help and man pages.
.TP
.BR JID
Stands for Jabber ID. It refers to an XMPP address. Historically XMPP was also known as Jabber.
.BR MAM
Stands for Message Archive Management (XEP-0313) and describes the ability to store messages on the server and retrieve them later.
.BR MUC
Stands for Mutli-User Chats (XEP-0045) and are also called, groups, group chats, chatrooms or conferences.
.BR Roster
The roster is your contact list. By default displayed at the right side on the console window. See RFC6121.
.BR XEP
XMPP is aa extendable protocol. There are core features and optional features described in XMPP Extension Protocols, short XEPs.
.SH SEE ALSO
.B Profanity
itself has a lot of built\-in help. Check the