aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorshtrophic <christoph@liebender.dev>2025-01-24 20:38:26 +0100
committershtrophic <christoph@liebender.dev>2025-01-24 20:38:26 +0100
commit85be7f36e12507cff7607df22ca14f8bfc00f6e2 (patch)
treee41bedab3e3b011c16d2ea6180926470cc8586aa /doc
parent13e4a7cda59db29063efc5dad0823fe99ec7b764 (diff)
parent1cb7b37ae6adb01444ea1466d8884aacca10ebd8 (diff)
Merge remote-tracking branch 'upstream/master' into curl-smtp
Diffstat (limited to 'doc')
-rw-r--r--doc/snac.57
-rw-r--r--doc/snac.89
2 files changed, 12 insertions, 4 deletions
diff --git a/doc/snac.5 b/doc/snac.5
index be7bfd7..3550995 100644
--- a/doc/snac.5
+++ b/doc/snac.5
@@ -24,9 +24,11 @@ A special subset of Markdown is allowed, including:
.It bold
**text between two pairs of asterisks**
.It italic
-*text between a pair of asterisks*
+*text between a pair of asterisks* or _between a pair of underscores_
.It strikethrough text
~~text between a pair of tildes~~
+.It underlined text
+__text between two pairs of underscores__
.It code
Text `between backticks` is formatted as code.
.Bd -literal
@@ -53,6 +55,9 @@ Horizonal rules can be inserted by typing three minus symbols
alone in a line.
.It quoted text
Lines starting with >.
+.It headers
+One, two or three # at the beginning of a line plus a space plus
+some text are converted to HTML headers.
.It user mentions
Strings in the format @user@host are requested using the Webfinger
protocol and converted to links and mentions if something reasonable
diff --git a/doc/snac.8 b/doc/snac.8
index c0e1af5..e228495 100644
--- a/doc/snac.8
+++ b/doc/snac.8
@@ -591,17 +591,20 @@ instance can subscribe to LitePub (Pleroma-style) Fediverse Relays. Doing this i
visibility and allows following hashtags. To do this, you must create a special user named
relay and, from it, follow the relay actor(s) like you do with regular actor URLs. This
special user will start receiving boosts from the relay server of posts from other instances
-also following it. It any other user of the same
+also following it. If any other user of the same
.Nm
instance follows any of the hashtags included in these boosted posts coming from the relay,
-they will received as if they were for them.
+they will be received as if they were for them.
.Pp
Example:
.Bd -literal -offset indent
snac adduser $SNAC_BASEDIR relay # only needed once
-snac follow $SNAC_BASEDIR relay https://fedi-relay.gyptazy.com/actor
+snac follow $SNAC_BASEDIR relay https://relay.example.com/actor
.Ed
.Pp
+Users on your instance do NOT need to follow the local relay user to benefit from following
+hashtags.
+.Pp
Please take note that subscribing to relays can increase the traffic towards your instance
significantly. In any case, lowering the "Maximum days to keep posts" value for the relay
special user is recommended (e.g. setting to just 1 day).