mirror of
https://forge.fsky.io/lda/Parsee.git
synced 2026-03-13 17:05:11 +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
90
etc/man/man1/parsee-config.1
Normal file
90
etc/man/man1/parsee-config.1
Normal file
|
|
@ -0,0 +1,90 @@
|
|||
." The last field is the codename, by the way.
|
||||
." ALL MANPAGES FOR PARSEE ARE UNDER PUBLIC DOMAIN
|
||||
.TH parsee-config 1 "Parsee Utility" "phantasmagoria"
|
||||
|
||||
.SH NAME
|
||||
parsee-config - generate a basic configuration file
|
||||
|
||||
.SH SYNOPSIS
|
||||
parsee-config
|
||||
.B [-H HOMESERVER_NAME]
|
||||
.B [-s SHARED_SECRET]
|
||||
.B [-m MEDIA_URL]
|
||||
.B [-J JABBER_HOST]
|
||||
.B [-p JABBER_PORT]
|
||||
.B [-d DATABASE]
|
||||
.B [-S DATABASE size]
|
||||
|
||||
.SH DESCRIPTION
|
||||
.I parsee-config
|
||||
creates a basic configuration file to initialise a Parsee instance with the
|
||||
given input flags, and makes a basic database. A basic example of
|
||||
.I parsee-config
|
||||
would be this(for a blow.hole server, with a xmpp.blow.hole JCP on Prosody,
|
||||
and a 128MB LMDB backend)
|
||||
.sp
|
||||
.if n \{\
|
||||
.RS 4
|
||||
.\}
|
||||
.nf
|
||||
$ parsee-config \\
|
||||
-d '/var/lib/parsee' \\
|
||||
-m 'https://pmedia.blow.hole' \\
|
||||
-H 'blow.hole' \\
|
||||
-s 'The Dark Shared Secret' \\
|
||||
-J 'xmpp.blow.hole' \\
|
||||
-S 128
|
||||
.fi
|
||||
.if n \{\
|
||||
.RE
|
||||
.\}
|
||||
.sp
|
||||
|
||||
.SH OPTIONS
|
||||
.TP
|
||||
.BR -H HOMESERVER_NAME
|
||||
.I HOMESERVER_NAME
|
||||
points to the homeserver name, without delegation (which is autosensed).
|
||||
For example, if you except Parsee users to be on
|
||||
.IR @something:blow.hole
|
||||
, then it should be set to
|
||||
.IR blow.hole .
|
||||
.TP
|
||||
.BR -s SHARED_SECRET
|
||||
.I SHARED_SECRET
|
||||
is a shared secret known by Parsee and the XMPP component to authenticate.
|
||||
.TP
|
||||
.BR -m MEDIA_URL
|
||||
.I MEDIA_URL
|
||||
is an optional field used by Parsee as an address that points to Matrix
|
||||
media. It must be publicly accessible (behind a reverse proxy to HTTP:7642)
|
||||
.TP
|
||||
.BR -J JABBER_HOST
|
||||
.I JABBER_HOST
|
||||
is used as the component host for Parsee.
|
||||
.TP
|
||||
.BR -p JABBER_PORT
|
||||
.I JABBER_PORT
|
||||
is used as the component post for Parsee. Parsee uses it alongside
|
||||
.I JABBER_HOST
|
||||
to connect to
|
||||
.I JABBER_HOST:JABBER_PORT
|
||||
over TCP.
|
||||
.TP
|
||||
.BR -d DATABASE
|
||||
The directory inwhich Parsee stores its database(LMDB/flat-file). Whenever the
|
||||
database is flat or LMDB is dictated by the presence of the -S flag, and
|
||||
whenever Cytoplasm has LMDB enabled.
|
||||
.TP
|
||||
.BR -S SIZE
|
||||
If set, enables LMDB in Parsee, and sets its max DB size to
|
||||
.BR SIZE MiB .
|
||||
|
||||
|
||||
.SH LICENSE
|
||||
Unlike Parsee,
|
||||
.B parsee-config
|
||||
is under the CC0/PD.
|
||||
|
||||
.SH SEE ALSO
|
||||
.B parsee-aya(1), parsee-adminify(1), parsee(1)
|
||||
Loading…
Add table
Add a link
Reference in a new issue