monkee.ch/snac2
1
0
Fork 0
mirror of https://codeberg.org/grunfink/snac2.git synced 2024-11-25 22:45:05 +00:00
Code Issues Projects Releases Packages Wiki Activity

Updated documentation.

Browse source
This commit is contained in:
default 2023-01-25 10:08:35 +01:00
parent b3f2e92033
commit 8cdc8e6ca3
3 changed files with 16 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
doc/snac.1
View file

@ -81,6 +81,11 @@ The same markup options available for text notes apply here.
If this field is not empty, an email message will be sent If this field is not empty, an email message will be sent
to this address whenever a post written by you is liked, to this address whenever a post written by you is liked,
boosted or replied to. boosted or replied to.
.It Always show sensitive content
By default,
.Nm
hides content marked as sensitive by their publishers.
If you check this option, sensitive content is always shown.
.It Password .It Password
Write the same string in these two fields to change your Write the same string in these two fields to change your
password. Don't write anything if you don't want to do this. password. Don't write anything if you don't want to do this.
@ -90,7 +95,7 @@ The rest of the page contains your timeline in reverse
chronological order (i.e., newest interactions first). chronological order (i.e., newest interactions first).
.Nm .Nm
shows the conversations as nested trees, unlike other Fediverse shows the conversations as nested trees, unlike other Fediverse
software; everytime something new is added to a conversation, software; everytime you contribute something to a conversation,
the full thread is bumped up, so new interactions are shown the full thread is bumped up, so new interactions are shown
always at the top of the page while the forgotten ones languish always at the top of the page while the forgotten ones languish
at the bottom. at the bottom.
@ -136,6 +141,11 @@ to read crap from this user again in the forseeable future.
If a conversation is getting long and annoying but not enough If a conversation is getting long and annoying but not enough
to MUTE its author forever, click this button to avoid seeing to MUTE its author forever, click this button to avoid seeing
the post and its children anymore. the post and its children anymore.
.It Edit
Posts written by you on
.Nm
version 2.19 and later can be edited and resent to their
recipients.
.El .El
.Ss Command-line options .Ss Command-line options
The command-line tool provide the following commands: The command-line tool provide the following commands:

2
doc/snac.5
View file

@ -124,7 +124,7 @@ for later retransmission until a maximum number of retries is reached,
then discarded. then discarded.
.It Pa static/ .It Pa static/
Files in this directory are served as-is when requested from the Files in this directory are served as-is when requested from the
.Pa https://HOST/s/... .Pa https://HOST/USER/s/...
URL path. A special file named URL path. A special file named
.Pa style.css .Pa style.css
can contain user-specific CSS code to be inserted into the HTML of the can contain user-specific CSS code to be inserted into the HTML of the

8
doc/snac.8
View file

@ -130,7 +130,7 @@ The URL path prefix.
.It Ic address .It Ic address
The listen network address. The listen network address.
.It Ic port .It Ic port
The list network port. The listen network port.
.It Ic dbglevel .It Ic dbglevel
The debug level. An integer value, being 0 the less verbose (the default). The debug level. An integer value, being 0 the less verbose (the default).
.It Ic layout .It Ic layout
@ -152,7 +152,7 @@ fill up with old crap and finally burst in flames, you can disable
purging by setting this to 0. purging by setting this to 0.
.It Ic local_purge_days .It Ic local_purge_days
Same as before, but for the user-generated entries in the local timeline. Same as before, but for the user-generated entries in the local timeline.
.It Ic css_urls .It Ic cssurls
This is a list of URLs to CSS files that will be inserted, in this order, This is a list of URLs to CSS files that will be inserted, in this order,
in the HTML before the user CSS. Use these files to configure the global in the HTML before the user CSS. Use these files to configure the global
site layout. site layout.
@ -227,9 +227,9 @@ objects, on input and output.
.It Vt Update .It Vt Update
For For
.Vt Person .Vt Person
objects, on input and output. Support for updating and
.Vt Note .Vt Note
objects will probably be added in the future. objects, on input and output.
.It Vt Delete .It Vt Delete
Supported for Supported for
.Vt Note .Vt Note