Adds documentation

This commit is contained in:
Trenton Holmes
2022-12-04 16:50:11 -08:00
parent a6b7beaf6b
commit 538249b26c
2 changed files with 23 additions and 1 deletions

View File

@@ -233,6 +233,7 @@ optional arguments:
-c, --compare-checksums
-f, --use-filename-format
-d, --delete
-z --zip
```
`target` is a folder to which the data gets written. This includes
@@ -258,6 +259,9 @@ current export such as files from deleted documents, specify `--delete`.
Be careful when pointing paperless to a directory that already contains
other files.
If `-z` or `--zip` is provided, the export will be a zipfile
in the target directory, named according to the current date.
The filenames generated by this command follow the format
`[date created] [correspondent] [title].[extension]`. If you want
paperless to use `PAPERLESS_FILENAME_FORMAT` for exported filenames