diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/snac.5 | 7 | ||||
| -rw-r--r-- | doc/snac.8 | 9 |
2 files changed, 12 insertions, 4 deletions
| @@ -24,9 +24,11 @@ A special subset of Markdown is allowed, including: | |||
| 24 | .It bold | 24 | .It bold |
| 25 | **text between two pairs of asterisks** | 25 | **text between two pairs of asterisks** |
| 26 | .It italic | 26 | .It italic |
| 27 | *text between a pair of asterisks* | 27 | *text between a pair of asterisks* or _between a pair of underscores_ |
| 28 | .It strikethrough text | 28 | .It strikethrough text |
| 29 | ~~text between a pair of tildes~~ | 29 | ~~text between a pair of tildes~~ |
| 30 | .It underlined text | ||
| 31 | __text between two pairs of underscores__ | ||
| 30 | .It code | 32 | .It code |
| 31 | Text `between backticks` is formatted as code. | 33 | Text `between backticks` is formatted as code. |
| 32 | .Bd -literal | 34 | .Bd -literal |
| @@ -53,6 +55,9 @@ Horizonal rules can be inserted by typing three minus symbols | |||
| 53 | alone in a line. | 55 | alone in a line. |
| 54 | .It quoted text | 56 | .It quoted text |
| 55 | Lines starting with >. | 57 | Lines starting with >. |
| 58 | .It headers | ||
| 59 | One, two or three # at the beginning of a line plus a space plus | ||
| 60 | some text are converted to HTML headers. | ||
| 56 | .It user mentions | 61 | .It user mentions |
| 57 | Strings in the format @user@host are requested using the Webfinger | 62 | Strings in the format @user@host are requested using the Webfinger |
| 58 | protocol and converted to links and mentions if something reasonable | 63 | protocol and converted to links and mentions if something reasonable |
| @@ -591,17 +591,20 @@ instance can subscribe to LitePub (Pleroma-style) Fediverse Relays. Doing this i | |||
| 591 | visibility and allows following hashtags. To do this, you must create a special user named | 591 | visibility and allows following hashtags. To do this, you must create a special user named |
| 592 | relay and, from it, follow the relay actor(s) like you do with regular actor URLs. This | 592 | relay and, from it, follow the relay actor(s) like you do with regular actor URLs. This |
| 593 | special user will start receiving boosts from the relay server of posts from other instances | 593 | special user will start receiving boosts from the relay server of posts from other instances |
| 594 | also following it. It any other user of the same | 594 | also following it. If any other user of the same |
| 595 | .Nm | 595 | .Nm |
| 596 | instance follows any of the hashtags included in these boosted posts coming from the relay, | 596 | instance follows any of the hashtags included in these boosted posts coming from the relay, |
| 597 | they will received as if they were for them. | 597 | they will be received as if they were for them. |
| 598 | .Pp | 598 | .Pp |
| 599 | Example: | 599 | Example: |
| 600 | .Bd -literal -offset indent | 600 | .Bd -literal -offset indent |
| 601 | snac adduser $SNAC_BASEDIR relay # only needed once | 601 | snac adduser $SNAC_BASEDIR relay # only needed once |
| 602 | snac follow $SNAC_BASEDIR relay https://fedi-relay.gyptazy.com/actor | 602 | snac follow $SNAC_BASEDIR relay https://relay.example.com/actor |
| 603 | .Ed | 603 | .Ed |
| 604 | .Pp | 604 | .Pp |
| 605 | Users on your instance do NOT need to follow the local relay user to benefit from following | ||
| 606 | hashtags. | ||
| 607 | .Pp | ||
| 605 | Please take note that subscribing to relays can increase the traffic towards your instance | 608 | Please take note that subscribing to relays can increase the traffic towards your instance |
| 606 | significantly. In any case, lowering the "Maximum days to keep posts" value for the relay | 609 | significantly. In any case, lowering the "Maximum days to keep posts" value for the relay |
| 607 | special user is recommended (e.g. setting to just 1 day). | 610 | special user is recommended (e.g. setting to just 1 day). |