Browse Source

Updated documentation.

default 3 năm trước cách đây
mục cha
commit
c3e3db84ed
2 tập tin đã thay đổi với 23 bổ sung1 xóa
  1. 9 1
      doc/snac.1
  2. 14 0
      doc/snac.8

+ 9 - 1
doc/snac.1

@@ -77,6 +77,10 @@ around the world.
 .It Bio
 .It Bio
 Enter here a bunch of self-indulgent blurb about yourself.
 Enter here a bunch of self-indulgent blurb about yourself.
 The same markup options available for text notes apply here.
 The same markup options available for text notes apply here.
+.It Email address for notifications
+If this field is not empty, an email message will be sent
+to this address whenever a post written by you is liked,
+boosted or replied to.
 .It Password
 .It Password
 Write the same string in these two fields to change your
 Write the same string in these two fields to change your
 password. Don't write anything if you don't want to do this.
 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
 by the EDITOR environment variable will be invoked to prepare
 by the EDITOR environment variable will be invoked to prepare
 a message.
 a message.
 .El
 .El
+.Ss Migrating from Mastodon
+See 
+.Xr snac 8
+for details.
 .Sh ENVIRONMENT
 .Sh ENVIRONMENT
 .Bl -tag -width Ds
 .Bl -tag -width Ds
 .It Ev DEBUG
 .It Ev DEBUG
@@ -188,6 +196,6 @@ The user-preferred interactive text editor to prepare messages.
 .Sh LICENSE
 .Sh LICENSE
 See the LICENSE file for details.
 See the LICENSE file for details.
 .Sh CAVEATS
 .Sh CAVEATS
-Use the Fediverse sparingly. Don't fear the mute button.
+Use the Fediverse sparingly. Don't fear the MUTE button.
 .Sh BUGS
 .Sh BUGS
 Plenty. Some issues may be documented in the TODO.md file.
 Plenty. Some issues may be documented in the TODO.md file.

+ 14 - 0
doc/snac.8

@@ -218,6 +218,20 @@ is supported. Intentionally, the
 and
 and
 .Pa /following
 .Pa /following
 paths return empty lists.
 paths return empty lists.
+.Ss Migrating from Mastodon
+User migration from different Fediverse instances is a pain in the ass
+that has been implemented everywhere as a kludgy afterthought. There is
+not much that can be done, other than importing the list of people you
+follow to your new
+.Nm
+account.
+.Pp
+To do this, download the user's list of accounts being followed (in CSV
+format) from the Mastodon web interface and execute this:
+.Bd -literal -offset indent
+awk -F, 'NR > 1 { print $1 }' /path/to/following_accounts.csv | \\
+xargs -n 1 snac follow $SNAC_BASEDIR $SNAC_USER
+.Ed
 .Ss Other Considerations
 .Ss Other Considerations
 .Nm
 .Nm
 stores all the messages it receives as JSON files, which are usually
 stores all the messages it receives as JSON files, which are usually