[MOD] Mess with manpage

This commit is contained in:
LDA 2024-08-13 10:21:29 +02:00
commit f6b0d741d5

View file

@ -1,6 +1,5 @@
# Parsee - the jealous XMPP<=>Matrix bridge
Parsee is a Matrix<=>XMPP bridge written in C99, with Cytoplasm, similar to Bifrost,
but it is NOT a drop-in replacment.
Parsee is a Matrix<=>XMPP bridge written in C99, with Cytoplasm, similar to Bifrost, but it is NOT a drop-in replacment.
## Why?
### Naming
@ -24,7 +23,7 @@ $ make # This generates a 'parsee' executable.
$ cd tools # If you want to build more tools
$ make && cd ..
$ make ayadoc # If you want to build HTML documentation
# make [PREFIX=(install path)] install # To install Parsee.
$ make [PREFIX=(install path)] install # To install Parsee.
```
If there are any Cytoplasm-related build failures, you may want to check the Makefile to
change a few variables (you can set `CYTO_INC` and `CYTO_LIB`)
@ -48,14 +47,15 @@ parsee-config \
If everything goes well, it should generate a `parsee.json` file.
To start Parsee, run it in the same directory as the `parsee.json`. It should start properly
and produce a `parsee.yaml` file, which you can chuck into your Matrix homeserver. To test
if the homeserver can talk to Parsee, try reaching it over HTTP at the port 7642. If it returns
with a landing page, then this side works. You can read it for some more information.
To start Parsee, run it in the same directory as the `parsee.json` with the `-g` flag. It should
start properly and produce a `parsee.yaml` file, which you can chuck into your Matrix homeserver.
To test if the homeserver can talk to Parsee, try reaching it over HTTP at the port 7642. If it
returns with a landing page, then this side works. You can read it for some more information.
## DOCS
TODO
Currently, the main sources of documentation are the Ayadocs(for headers) and the manpages
(see `etc/man`)
## TODOS
- Add [libomemo](https://github.com/gkdr/libomemo) as an optional dependency.
@ -64,20 +64,8 @@ TODO
- Matrix's libolm is deprecated. They replaced it with a Rust version that
pulls in *way too many* dependencies, and that lacks a C binding. We may
put in the work of either forking off libolm or making a binding to KappaChat.
~ Mess with Cytoplasm to make it have support for something like LMDB as an
*optional* dependency. This should increase reliability and speed for anyone.
v Work is going on on the Cytoplasm `lmdbwerk` and this branch to get LMDB.
- Nesting might be an issue we'll need to deal with. libdb and Berkley DB
seem to lack support for them. If we can shove entries at specific indices,
we _might_ just manage to get some system that can at least emulate that,
and hopefully be reasonably faster than the filesystem, with some added
reliability.
- You can always concat paths, and search by prefix with LMDB. ~512 bytes
a key is more than enough. I'll just need to write a good abstraction layer.
- Get rid of the '?'-syntax and use another invalid Matrix char/valid XMPP char
('$'?) for escaped
('$'?) for escaped?
- PROPER FUCKING AVATARS
XEP-0084 IS THE WORST PIECE OF SHIT KNOWN TO MAN. If any Jabberbros want to
look at terrible code/XML and suggest things to have *proper* avatar support,
@ -88,6 +76,8 @@ restricted to Parsee admins, with permission from MUC owners, too
only if Parsee admins are good-willed, which we must assume such statment to
be false by default.
- Look at XEPS-TBD.TXT for XEPs to be done
- Add a MUC server to Parsee, such that it may be able to hook onto it and therefore
support XMPP->Matrix bridging.
- Manage MUC DMs in a reasonable manner. Thanks `@freeoffers4u:matrix.org` for being
a fucking annoyance and DMing an old Parsee semi-anon user for no clear reason.
@ -98,6 +88,8 @@ want to suggest a feature, you may open an issue.
Packaging Parsee (and Cytoplasm) for your specific platform might be a nice to have,
to make Parsee easier to setup and manage.
If you want, you may want to give this project some word-of-mouth as advertisment.
**(DON'T FOR NOW, THERE IS LITERALLY NOWHERE THIS GOES TO)**
You may also donate to [the LiberaPay](https://en.liberapay.com/Parsee), alongside
[Telodendria's](https://en.liberapay.com/Telodendria), as it is the project