]> git.ipfire.org Git - thirdparty/paperless-ngx.git/commitdiff
Tweaks the wording and note about usage of the -no options
authorTrenton Holmes <797416+stumpylog@users.noreply.github.com>
Sat, 21 Jan 2023 16:29:12 +0000 (08:29 -0800)
committerTrenton H <797416+stumpylog@users.noreply.github.com>
Tue, 24 Jan 2023 19:06:49 +0000 (11:06 -0800)
docs/administration.md

index fdc078d24733b3760093bf5c2803c81f8773d2f3..4e35d67fbc66aad1cbb1af54c60c517da283edf8 100644 (file)
@@ -268,27 +268,27 @@ The filenames generated by this command follow the format
 paperless to use `PAPERLESS_FILENAME_FORMAT` for exported filenames
 instead, specify `-f` or `--use-filename-format`.
 
-Paperless will not export archive files if you use `-na` or `--no-archive`. After
-importing, the sanity checker will warn about missing files until these files
-are generated again by using `document_archiver`.
-It can make sense to omit these files from backup as their content and checksum
-can change (new archiver algorithm) and may then cause additional used space in
-a deduplicated backup.
-
-Paperless will not export thumbnails if you use `-nt` or `--no-thumbnail`. After
-importing, the sanity checker will warn about missing files and the documents
-view will not have thumbnails until these files are generated again by using
-`document_thumbnails`.
-It can make sense to omit these files from backup as their content and checksum
-can change (new thumbnail generation algorithm) and may then cause additional
-used space in a deduplicated backup.
-
-If `-p` or `--use-filename-prefix` is provided, Files will be exported
+If `-na` or `--no-archive` is provided, no archive files will be exported,
+only the original files.
+
+If `-nt` or `--no-thumbnail` is provided, thumbnail files will not be exported.
+
+!!! note
+
+    When using the `-na`/`--no-archive` or `-nt`/`--no-thumbnail` options
+    the exporter will not output these files for backup.  After importing,
+    the [sanity checker](#sanity-checker) will warn about missing thumbnails and archive files
+    until they are regenerated with `document_thumbnails` or [`document_archiver`](#archiver).
+    It can make sense to omit these files from backup as their content and checksum
+    can change (new archiver algorithm) and may then cause additional used space in
+    a deduplicated backup.
+
+If `-p` or `--use-filename-prefix` is provided, files will be exported
 in dedicated folders according to their nature: `archive`, `originals`,
 `thumbnails` or `json`
 
 If `-sm` or `--split-manifest` is provided, information about document
-will be placed in individual json files.
+will be placed in individual json files, instead of a single JSON file.
 
 If `-z` or `--zip` is provided, the export will be a zipfile
 in the target directory, named according to the current date.