mirror of
https://forge.fsky.io/lda/Parsee.git
synced 2026-03-13 14:05:10 +00:00
[MOD] Add manpages
Oops, gitignore didn't track these
This commit is contained in:
parent
8042ccc0cc
commit
27e0b96ecd
5 changed files with 290 additions and 0 deletions
118
etc/man/man1/parsee.1
Normal file
118
etc/man/man1/parsee.1
Normal file
|
|
@ -0,0 +1,118 @@
|
|||
." The last field is the codename, by the way.
|
||||
." ALL MANPAGES FOR PARSEE ARE UNDER PUBLIC DOMAIN
|
||||
.TH parsee 1 "Parsee Utility" "phantasmagoria"
|
||||
|
||||
.SH NAME
|
||||
parsee - the jealous XMPP-Matrix bridge
|
||||
|
||||
.SH SYNOPSIS
|
||||
parsee
|
||||
.B [-J num]
|
||||
.B [-H num]
|
||||
.B [-C file]
|
||||
.B [-g]
|
||||
.B [-v]
|
||||
.B [-h]
|
||||
|
||||
.SH DESCRIPTION
|
||||
Parsee is a
|
||||
.B bridging program
|
||||
, that is, it connects two chat protocols together (here, XMPP/Jabber,
|
||||
and Matrix).
|
||||
.PP
|
||||
As such, a user on XMPP can communicate with Matrix users, and
|
||||
vice-versa with it.
|
||||
.PP
|
||||
Currently, Parsee is under
|
||||
.BI beta .
|
||||
This means that it is still subject to bugs, flaws, and may change in a
|
||||
backwards-incompatible manner at any time.
|
||||
|
||||
.SH FIRST RUN
|
||||
To start with a new install of Parsee(assuming you have a homeserver
|
||||
with AS support and a XMPP server with JCP support, and that you know
|
||||
the shared secret/domain for that component. Guides for that are
|
||||
outside the scope of this manpage.), start by running
|
||||
.B parsee-config(1)
|
||||
with the flags provided in it, according to your configuration.
|
||||
.PP
|
||||
This should generate a
|
||||
.I parsee.json
|
||||
file, which is the configuration files for Parsee, and a directory where
|
||||
the Parsee database may reside. You can then run
|
||||
.I parsee -g
|
||||
in that directory, which should generate a
|
||||
.I parsee.yaml
|
||||
file, this time with the generated AS configuration file, which you can
|
||||
apply to your homeserver(how is implementation-dependent, but it is
|
||||
generally a matter of modifying a configuration file to add the path
|
||||
to such file).
|
||||
|
||||
.SH OPTIONS
|
||||
.TP
|
||||
.BR -J num
|
||||
Set the number of threads used for XMPP stanza processing to
|
||||
.I num\[char46]
|
||||
.TP
|
||||
.BR -H num
|
||||
Set the number of threads used for HTTP request processing to
|
||||
.I num\[char46]
|
||||
.TP
|
||||
.BR -C file
|
||||
Sets the configuration JSON path to
|
||||
.I file\[char46]
|
||||
.PP
|
||||
Defaults to
|
||||
.I parsee.json
|
||||
if none can be found.
|
||||
.TP
|
||||
.BR -g
|
||||
Generates a
|
||||
.I parsee.yaml
|
||||
file to be used as an Application-Service entry within Matrix, and
|
||||
exits.
|
||||
.TP
|
||||
.BR -v
|
||||
Verbose logging of Parsee's behaviour. Recommended when testing Parsee
|
||||
for bugs/hints.
|
||||
.TP
|
||||
.BR -h
|
||||
Prints the command list with descriptions.
|
||||
|
||||
.SH BUGS
|
||||
.PP
|
||||
Sometimes Parsee will not respond to ^C requests properly, which
|
||||
causes a system administrator to have to invoke SIGKILL.
|
||||
.PP
|
||||
Parsee seems to grow slowly in memory usage when messages are bridged
|
||||
which, in the long run, could cause a memory error. All of the memory is
|
||||
tracked, however, which means that this isn't exactly a leak.
|
||||
.PP
|
||||
Some important features still aren't implemented yet(e.g being able to join
|
||||
a MUC from XMPP)
|
||||
|
||||
.SH CHATROOMS
|
||||
You may talk about Parsee on these rooms(on Matrix and XMPP):
|
||||
.RE
|
||||
.IP xmpp:parsee@conference.monocles.eu?join
|
||||
for XMPP, which is bridged along Matrix
|
||||
.IP #parsee:tedomum.net
|
||||
for Matrix, which is bridged along Parsee
|
||||
.RS
|
||||
|
||||
.SH AUTHORS
|
||||
." Contributors, feel free to put your names here in a PR, as long as
|
||||
." it is acceptable
|
||||
. PP
|
||||
.BR LDA:
|
||||
main maintainer of Parsee, accessible over XMPP at lda@freetards.xyz
|
||||
and over Matrix as @fourier:ari.lt.
|
||||
|
||||
.SH LICENSE
|
||||
Parsee is available under the AGPL3, but has some code under CC0/PD, and
|
||||
some from Cytoplasm itself. Please see
|
||||
.I https://git.kappach.at/lda/Parsee
|
||||
for more information.
|
||||
|
||||
.SH SEE ALSO
|
||||
.B parsee-config(1), parsee-adminify(1), parsee-aya(1)
|
||||
Loading…
Add table
Add a link
Reference in a new issue