aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/README.md b/README.md
index 5ada7b2..cc45e7d 100644
--- a/README.md
+++ b/README.md
@@ -32,6 +32,23 @@ pput scan.pdf && rm scan.pdf
Paperless rejects re-uploads of identical content, reported as
`duplicate of doc N`.
+## File manager integration
+
+`pput.desktop` adds an "Upload to Paperless" entry to the right-click menu for
+PDFs, for file managers that read the DES-EMA actions format (pcmanfm-qt,
+Caja, Nemo). It runs `pput-gui`, a wrapper that reports the result as a
+desktop notification, since a click has no terminal to print to. One file or a
+whole selection both work.
+
+```bash
+ln -s "$PWD/pput-gui" ~/bin/pput-gui
+ln -s "$PWD/pput.desktop" ~/.local/share/file-manager/actions/pput.desktop
+```
+
+`Exec=` calls `pput-gui` by name, so it must be on the `PATH` your desktop
+session exports; use an absolute path there instead if it is not. Restart the
+file manager to pick up a new action.
+
## Requirements
- `bash`, `curl`, `python3` (stdlib only)