diff options
| author | 2022-11-08 09:07:51 +0100 | |
|---|---|---|
| committer | 2022-11-08 09:07:51 +0100 | |
| commit | c3e3db84ed5c8fa8da87479c63f1066204f0d495 (patch) | |
| tree | 07c13c075860066264c2f77a42ff39aa27ab5ff4 /doc | |
| parent | Fixed memory leak. (diff) | |
| download | snac2-c3e3db84ed5c8fa8da87479c63f1066204f0d495.tar.gz snac2-c3e3db84ed5c8fa8da87479c63f1066204f0d495.tar.xz snac2-c3e3db84ed5c8fa8da87479c63f1066204f0d495.zip | |
Updated documentation.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/snac.1 | 10 | ||||
| -rw-r--r-- | doc/snac.8 | 14 |
2 files changed, 23 insertions, 1 deletions
| @@ -77,6 +77,10 @@ around the world. | |||
| 77 | .It Bio | 77 | .It Bio |
| 78 | Enter here a bunch of self-indulgent blurb about yourself. | 78 | Enter here a bunch of self-indulgent blurb about yourself. |
| 79 | The same markup options available for text notes apply here. | 79 | The same markup options available for text notes apply here. |
| 80 | .It Email address for notifications | ||
| 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, | ||
| 83 | boosted or replied to. | ||
| 80 | .It Password | 84 | .It Password |
| 81 | Write the same string in these two fields to change your | 85 | Write the same string in these two fields to change your |
| 82 | password. Don't write anything if you don't want to do this. | 86 | password. Don't write anything if you don't want to do this. |
| @@ -171,6 +175,10 @@ argument is - (a lonely hyphen), the external editor defined | |||
| 171 | by the EDITOR environment variable will be invoked to prepare | 175 | by the EDITOR environment variable will be invoked to prepare |
| 172 | a message. | 176 | a message. |
| 173 | .El | 177 | .El |
| 178 | .Ss Migrating from Mastodon | ||
| 179 | See | ||
| 180 | .Xr snac 8 | ||
| 181 | for details. | ||
| 174 | .Sh ENVIRONMENT | 182 | .Sh ENVIRONMENT |
| 175 | .Bl -tag -width Ds | 183 | .Bl -tag -width Ds |
| 176 | .It Ev DEBUG | 184 | .It Ev DEBUG |
| @@ -188,6 +196,6 @@ The user-preferred interactive text editor to prepare messages. | |||
| 188 | .Sh LICENSE | 196 | .Sh LICENSE |
| 189 | See the LICENSE file for details. | 197 | See the LICENSE file for details. |
| 190 | .Sh CAVEATS | 198 | .Sh CAVEATS |
| 191 | Use the Fediverse sparingly. Don't fear the mute button. | 199 | Use the Fediverse sparingly. Don't fear the MUTE button. |
| 192 | .Sh BUGS | 200 | .Sh BUGS |
| 193 | Plenty. Some issues may be documented in the TODO.md file. | 201 | Plenty. Some issues may be documented in the TODO.md file. |
| @@ -218,6 +218,20 @@ is supported. Intentionally, the | |||
| 218 | and | 218 | and |
| 219 | .Pa /following | 219 | .Pa /following |
| 220 | paths return empty lists. | 220 | paths return empty lists. |
| 221 | .Ss Migrating from Mastodon | ||
| 222 | User migration from different Fediverse instances is a pain in the ass | ||
| 223 | that has been implemented everywhere as a kludgy afterthought. There is | ||
| 224 | not much that can be done, other than importing the list of people you | ||
| 225 | follow to your new | ||
| 226 | .Nm | ||
| 227 | account. | ||
| 228 | .Pp | ||
| 229 | To do this, download the user's list of accounts being followed (in CSV | ||
| 230 | format) from the Mastodon web interface and execute this: | ||
| 231 | .Bd -literal -offset indent | ||
| 232 | awk -F, 'NR > 1 { print $1 }' /path/to/following_accounts.csv | \\ | ||
| 233 | xargs -n 1 snac follow $SNAC_BASEDIR $SNAC_USER | ||
| 234 | .Ed | ||
| 221 | .Ss Other Considerations | 235 | .Ss Other Considerations |
| 222 | .Nm | 236 | .Nm |
| 223 | stores all the messages it receives as JSON files, which are usually | 237 | stores all the messages it receives as JSON files, which are usually |