summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/snac.119
-rw-r--r--doc/snac.56
-rw-r--r--doc/snac.813
3 files changed, 30 insertions, 8 deletions
diff --git a/doc/snac.1 b/doc/snac.1
index efba67e..999c594 100644
--- a/doc/snac.1
+++ b/doc/snac.1
@@ -270,7 +270,9 @@ user url that also contains a rel="me" attribute. These links are specially
270marked as verified in the user's public timeline and also via the Mastodon API. 270marked as verified in the user's public timeline and also via the Mastodon API.
271.It Cm export_csv Ar basedir Ar uid 271.It Cm export_csv Ar basedir Ar uid
272Exports some account data as Mastodon-compatible CSV files. After executing 272Exports some account data as Mastodon-compatible CSV files. After executing
273this command, the following files will be written to the current directory: 273this command, the following files will be written to the
274.Pa export/
275subdirectory inside the user directory:
274.Pa bookmarks.csv , 276.Pa bookmarks.csv ,
275.Pa blocked_accounts.csv , 277.Pa blocked_accounts.csv ,
276.Pa lists.csv , and 278.Pa lists.csv , and
@@ -286,7 +288,9 @@ Starts a migration from this account to the one set as an alias (see
286section 'Migrating from snac to Mastodon'). 288section 'Migrating from snac to Mastodon').
287.It Cm import_csv Ar basedir Ar uid 289.It Cm import_csv Ar basedir Ar uid
288Imports CSV data files from a Mastodon export. This command expects the 290Imports CSV data files from a Mastodon export. This command expects the
289following files to be in the current directory: 291following files to be inside the
292.Pa import/
293subdirectory of a user's directory inside the server base directory:
290.Pa bookmarks.csv , 294.Pa bookmarks.csv ,
291.Pa blocked_accounts.csv , 295.Pa blocked_accounts.csv ,
292.Pa lists.csv , and 296.Pa lists.csv , and
@@ -314,10 +318,15 @@ for a job to be assigned), input or output (processing I/O packets)
314or stopped (not running, only to be seen while starting or stopping 318or stopped (not running, only to be seen while starting or stopping
315the server). 319the server).
316.It Cm import_list Ar basedir Ar uid Ar file 320.It Cm import_list Ar basedir Ar uid Ar file
317Imports a Mastodon list in CSV format. This option can be used to 321Imports a Mastodon list in CSV format. The file must be stored inside the
318import "Mastodon Follow Packs". 322.Pa import/
323subdirectory of a user's directory inside the server base directory.
324This option can be used to import "Mastodon Follow Packs".
319.It Cm import_block_list Ar basedir Ar uid Ar file 325.It Cm import_block_list Ar basedir Ar uid Ar file
320Imports a Mastodon list of accounts to be blocked in CSV format. 326Imports a Mastodon list of accounts to be blocked in CSV format. The
327file must be stored inside the
328.Pa import/
329subdirectory of a user's directory inside the server base directory.
321.El 330.El
322.Ss Migrating an account to/from Mastodon 331.Ss Migrating an account to/from Mastodon
323See 332See
diff --git a/doc/snac.5 b/doc/snac.5
index 0168430..be7bfd7 100644
--- a/doc/snac.5
+++ b/doc/snac.5
@@ -209,6 +209,12 @@ web interface.
209.It Pa history/ 209.It Pa history/
210This directory contains generated HTML files. They may be snapshots of the 210This directory contains generated HTML files. They may be snapshots of the
211local timeline in previous months or other cached data. 211local timeline in previous months or other cached data.
212.It Pa export/
213This directory will contain exported data in Mastodon-compatible CSV format
214after executing the 'export_csv' command-line operation.
215.It Pa import/
216Mastodon-compatible CSV files must be copied into this directory to use
217any of the importing functions.
212.It Pa server.pid 218.It Pa server.pid
213This file stores the server PID in a single text line. 219This file stores the server PID in a single text line.
214.El 220.El
diff --git a/doc/snac.8 b/doc/snac.8
index f5e4bd5..f94d53f 100644
--- a/doc/snac.8
+++ b/doc/snac.8
@@ -421,7 +421,9 @@ server, first export your data to CSV by running:
421snac export_csv $SNAC_BASEDIR origin 421snac export_csv $SNAC_BASEDIR origin
422.Ed 422.Ed
423.Pp 423.Pp
424You'll find the following CSV files in the current directory: 424You'll find the following CSV files in the
425.Pa export/
426subdirectory inside the user directory:
425.Pa bookmarks.csv , 427.Pa bookmarks.csv ,
426.Pa blocked_accounts.csv , 428.Pa blocked_accounts.csv ,
427.Pa lists.csv , and 429.Pa lists.csv , and
@@ -480,6 +482,7 @@ Also, please take note that the
480account you migrated from is not disabled nor changed in any way, so can still 482account you migrated from is not disabled nor changed in any way, so can still
481use it as it no migration was done. This behaviour may or may not match what other 483use it as it no migration was done. This behaviour may or may not match what other
482ActivityPub implementations do. 484ActivityPub implementations do.
485.Pp
483.Ss Migrating from Mastodon to snac 486.Ss Migrating from Mastodon to snac
484Since version 2.61, you can migrate accounts on other ActivityPub instances to your 487Since version 2.61, you can migrate accounts on other ActivityPub instances to your
485.Nm 488.Nm
@@ -508,7 +511,9 @@ directory:
508.Pa lists.csv , and 511.Pa lists.csv , and
509.Pa following_accounts.csv . 512.Pa following_accounts.csv .
510.Pp 513.Pp
5112. From the directory where those files are stored, run 5142. Copy all those files to the
515.Pa import/
516subdirectory of the user's directory inside the server base directory, and run
512.Bd -literal -offset indent 517.Bd -literal -offset indent
513snac import_csv $SNAC_BASEDIR destination 518snac import_csv $SNAC_BASEDIR destination
514.Ed 519.Ed
@@ -518,7 +523,9 @@ of all the ActivityPub servers involved (webfinger, accounts, posts, etc.). Some
518may be transient and retried later. Also, if 523may be transient and retried later. Also, if
519.Nm 524.Nm
520complains that it can't find any of these files, please check that they are really 525complains that it can't find any of these files, please check that they are really
521stored in the current directory and that their names match exactly. Some of them may be 526stored in the
527.Pa import/
528subdirectory and that their names match exactly. Some of them may be
522empty (for example, if you didn't create any list) and that's fine. 529empty (for example, if you didn't create any list) and that's fine.
523.Pp 530.Pp
5243. Again on your 5313. Again on your