diff options
| author | 2023-01-25 10:08:35 +0100 | |
|---|---|---|
| committer | 2023-01-25 10:08:35 +0100 | |
| commit | 8cdc8e6ca3d92d5ff1e2529f8fe3ccb8795c808e (patch) | |
| tree | 513e0a3d1490ea3d5a045b759c7345215e73a4e0 | |
| parent | Updated RELEASE_NOTES. (diff) | |
| download | penes-snac2-8cdc8e6ca3d92d5ff1e2529f8fe3ccb8795c808e.tar.gz penes-snac2-8cdc8e6ca3d92d5ff1e2529f8fe3ccb8795c808e.tar.xz penes-snac2-8cdc8e6ca3d92d5ff1e2529f8fe3ccb8795c808e.zip | |
Updated documentation.
| -rw-r--r-- | doc/snac.1 | 12 | ||||
| -rw-r--r-- | doc/snac.5 | 2 | ||||
| -rw-r--r-- | doc/snac.8 | 8 |
3 files changed, 16 insertions, 6 deletions
| @@ -81,6 +81,11 @@ The same markup options available for text notes apply here. | |||
| 81 | If this field is not empty, an email message will be sent | 81 | If this field is not empty, an email message will be sent |
| 82 | to this address whenever a post written by you is liked, | 82 | to this address whenever a post written by you is liked, |
| 83 | boosted or replied to. | 83 | boosted or replied to. |
| 84 | .It Always show sensitive content | ||
| 85 | By default, | ||
| 86 | .Nm | ||
| 87 | hides content marked as sensitive by their publishers. | ||
| 88 | If you check this option, sensitive content is always shown. | ||
| 84 | .It Password | 89 | .It Password |
| 85 | Write the same string in these two fields to change your | 90 | Write the same string in these two fields to change your |
| 86 | password. Don't write anything if you don't want to do this. | 91 | 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 | |||
| 90 | chronological order (i.e., newest interactions first). | 95 | chronological order (i.e., newest interactions first). |
| 91 | .Nm | 96 | .Nm |
| 92 | shows the conversations as nested trees, unlike other Fediverse | 97 | shows the conversations as nested trees, unlike other Fediverse |
| 93 | software; everytime something new is added to a conversation, | 98 | software; everytime you contribute something to a conversation, |
| 94 | the full thread is bumped up, so new interactions are shown | 99 | the full thread is bumped up, so new interactions are shown |
| 95 | always at the top of the page while the forgotten ones languish | 100 | always at the top of the page while the forgotten ones languish |
| 96 | at the bottom. | 101 | at the bottom. |
| @@ -136,6 +141,11 @@ to read crap from this user again in the forseeable future. | |||
| 136 | If a conversation is getting long and annoying but not enough | 141 | If a conversation is getting long and annoying but not enough |
| 137 | to MUTE its author forever, click this button to avoid seeing | 142 | to MUTE its author forever, click this button to avoid seeing |
| 138 | the post and its children anymore. | 143 | the post and its children anymore. |
| 144 | .It Edit | ||
| 145 | Posts written by you on | ||
| 146 | .Nm | ||
| 147 | version 2.19 and later can be edited and resent to their | ||
| 148 | recipients. | ||
| 139 | .El | 149 | .El |
| 140 | .Ss Command-line options | 150 | .Ss Command-line options |
| 141 | The command-line tool provide the following commands: | 151 | The command-line tool provide the following commands: |
| @@ -124,7 +124,7 @@ for later retransmission until a maximum number of retries is reached, | |||
| 124 | then discarded. | 124 | then discarded. |
| 125 | .It Pa static/ | 125 | .It Pa static/ |
| 126 | Files in this directory are served as-is when requested from the | 126 | Files in this directory are served as-is when requested from the |
| 127 | .Pa https://HOST/s/... | 127 | .Pa https://HOST/USER/s/... |
| 128 | URL path. A special file named | 128 | URL path. A special file named |
| 129 | .Pa style.css | 129 | .Pa style.css |
| 130 | can contain user-specific CSS code to be inserted into the HTML of the | 130 | can contain user-specific CSS code to be inserted into the HTML of the |
| @@ -130,7 +130,7 @@ The URL path prefix. | |||
| 130 | .It Ic address | 130 | .It Ic address |
| 131 | The listen network address. | 131 | The listen network address. |
| 132 | .It Ic port | 132 | .It Ic port |
| 133 | The list network port. | 133 | The listen network port. |
| 134 | .It Ic dbglevel | 134 | .It Ic dbglevel |
| 135 | The debug level. An integer value, being 0 the less verbose (the default). | 135 | The debug level. An integer value, being 0 the less verbose (the default). |
| 136 | .It Ic layout | 136 | .It Ic layout |
| @@ -152,7 +152,7 @@ fill up with old crap and finally burst in flames, you can disable | |||
| 152 | purging by setting this to 0. | 152 | purging by setting this to 0. |
| 153 | .It Ic local_purge_days | 153 | .It Ic local_purge_days |
| 154 | Same as before, but for the user-generated entries in the local timeline. | 154 | Same as before, but for the user-generated entries in the local timeline. |
| 155 | .It Ic css_urls | 155 | .It Ic cssurls |
| 156 | This is a list of URLs to CSS files that will be inserted, in this order, | 156 | This is a list of URLs to CSS files that will be inserted, in this order, |
| 157 | in the HTML before the user CSS. Use these files to configure the global | 157 | in the HTML before the user CSS. Use these files to configure the global |
| 158 | site layout. | 158 | site layout. |
| @@ -227,9 +227,9 @@ objects, on input and output. | |||
| 227 | .It Vt Update | 227 | .It Vt Update |
| 228 | For | 228 | For |
| 229 | .Vt Person | 229 | .Vt Person |
| 230 | objects, on input and output. Support for updating | 230 | and |
| 231 | .Vt Note | 231 | .Vt Note |
| 232 | objects will probably be added in the future. | 232 | objects, on input and output. |
| 233 | .It Vt Delete | 233 | .It Vt Delete |
| 234 | Supported for | 234 | Supported for |
| 235 | .Vt Note | 235 | .Vt Note |