Sfoglia il codice sorgente

Updated documentation.

default 1 anno fa
parent
commit
d1a850acdd
3 ha cambiato i file con 9 aggiunte e 10 eliminazioni
  1. 3 1
      doc/snac.1
  2. 3 0
      doc/snac.5
  3. 3 9
      doc/snac.8

+ 3 - 1
doc/snac.1

@@ -270,7 +270,9 @@ user url that also contains a rel="me" attribute. These links are specially
 marked as verified in the user's public timeline and also via the Mastodon API.
 marked as verified in the user's public timeline and also via the Mastodon API.
 .It Cm export_csv Ar basedir Ar uid
 .It Cm export_csv Ar basedir Ar uid
 Exports some account data as Mastodon-compatible CSV files. After executing
 Exports some account data as Mastodon-compatible CSV files. After executing
-this command, the following files will be written to the current directory:
+this command, the following files will be written to the
+.Pa export/
+subdirectory inside the user directory:
 .Pa bookmarks.csv ,
 .Pa bookmarks.csv ,
 .Pa blocked_accounts.csv ,
 .Pa blocked_accounts.csv ,
 .Pa lists.csv , and
 .Pa lists.csv , and

+ 3 - 0
doc/snac.5

@@ -209,6 +209,9 @@ web interface.
 .It Pa history/
 .It Pa history/
 This directory contains generated HTML files. They may be snapshots of the
 This directory contains generated HTML files. They may be snapshots of the
 local timeline in previous months or other cached data.
 local timeline in previous months or other cached data.
+.It Pa export/
+This directory will contain exported data in Mastodon-compatible CSV format
+after executing the 'export_csv' command-line operation.
 .It Pa server.pid
 .It Pa server.pid
 This file stores the server PID in a single text line.
 This file stores the server PID in a single text line.
 .El
 .El

+ 3 - 9
doc/snac.8

@@ -421,7 +421,9 @@ server, first export your data to CSV by running:
 snac export_csv $SNAC_BASEDIR origin
 snac export_csv $SNAC_BASEDIR origin
 .Ed
 .Ed
 .Pp
 .Pp
-You'll find the following CSV files in the current directory:
+You'll find the following CSV files in the
+.Pa export/
+subdirectory inside the user directory:
 .Pa bookmarks.csv ,
 .Pa bookmarks.csv ,
 .Pa blocked_accounts.csv ,
 .Pa blocked_accounts.csv ,
 .Pa lists.csv , and
 .Pa lists.csv , and
@@ -481,14 +483,6 @@ account you migrated from is not disabled nor changed in any way, so can still
 use it as it no migration was done. This behaviour may or may not match what other
 use it as it no migration was done. This behaviour may or may not match what other
 ActivityPub implementations do.
 ActivityPub implementations do.
 .Pp
 .Pp
-NOTE: If you run
-.Nm
-on OpenBSD, please take note that the pledge()/unveil() security system disallows
-opening or creating files in the current directory; to do this operation, please
-temporarily set the disable_openbsd_security option to true in the
-.Pa server.json
-file and restart before migrating. You can restore the option back to the default false
-value afterwards.
 .Ss Migrating from Mastodon to snac
 .Ss Migrating from Mastodon to snac
 Since version 2.61, you can migrate accounts on other ActivityPub instances to your
 Since version 2.61, you can migrate accounts on other ActivityPub instances to your
 .Nm
 .Nm