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