summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorGravatar default2025-01-04 18:55:48 +0100
committerGravatar default2025-01-04 18:55:48 +0100
commitd1a850acdd75c190df2aae9552882ef06b04e70a (patch)
tree13290c250a88ce1a013d94cfd2dd680480f076b5 /doc
parentThe 'export_csv' operation exports into the user subdirectory. (diff)
downloadpenes-snac2-d1a850acdd75c190df2aae9552882ef06b04e70a.tar.gz
penes-snac2-d1a850acdd75c190df2aae9552882ef06b04e70a.tar.xz
penes-snac2-d1a850acdd75c190df2aae9552882ef06b04e70a.zip
Updated documentation.
Diffstat (limited to 'doc')
-rw-r--r--doc/snac.14
-rw-r--r--doc/snac.53
-rw-r--r--doc/snac.812
3 files changed, 9 insertions, 10 deletions
diff --git a/doc/snac.1 b/doc/snac.1
index efba67e..6ce0912 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
diff --git a/doc/snac.5 b/doc/snac.5
index 0168430..41e86b8 100644
--- a/doc/snac.5
+++ b/doc/snac.5
@@ -209,6 +209,9 @@ 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.
212.It Pa server.pid 215.It Pa server.pid
213This file stores the server PID in a single text line. 216This file stores the server PID in a single text line.
214.El 217.El
diff --git a/doc/snac.8 b/doc/snac.8
index d004c48..d4bf23b 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
@@ -481,14 +483,6 @@ account 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.
483.Pp 485.Pp
484NOTE: If you run
485.Nm
486on OpenBSD, please take note that the pledge()/unveil() security system disallows
487opening or creating files in the current directory; to do this operation, please
488temporarily set the disable_openbsd_security option to true in the
489.Pa server.json
490file and restart before migrating. You can restore the option back to the default false
491value afterwards.
492.Ss Migrating from Mastodon to snac 486.Ss Migrating from Mastodon to snac
493Since 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
494.Nm 488.Nm