aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorGertjan van den Burg <gertjanvandenburg@gmail.com>2019-03-04 18:28:25 -0500
committerGertjan van den Burg <gertjanvandenburg@gmail.com>2019-03-04 18:28:25 -0500
commit209256ce514f417a010b56285255409d4280209c (patch)
tree7bbd12a35823864a682c7ea0f424ae0c49a48cc2 /README.md
parentMerge branch 'master' of https://github.com/GjjvdBurg/arxiv2remarkable (diff)
downloadpaper2remarkable-209256ce514f417a010b56285255409d4280209c.tar.gz
paper2remarkable-209256ce514f417a010b56285255409d4280209c.zip
Update script help
Diffstat (limited to 'README.md')
-rw-r--r--README.md34
1 files changed, 19 insertions, 15 deletions
diff --git a/README.md b/README.md
index 00c45c4..c8ff0fe 100644
--- a/README.md
+++ b/README.md
@@ -25,26 +25,30 @@ Here's the full help of the script:
```bash
usage: arxiv2remarkable.py [-h] [-v] [-n] [-d] [--filename FILENAME]
- [--rmapi RMAPI] [--pdfcrop PDFCROP] [--pdftk PDFTK]
- [--gs GS]
+ [-p REMARKABLE_DIR] [--rmapi RMAPI]
+ [--pdfcrop PDFCROP] [--pdftk PDFTK] [--gs GS]
input
positional arguments:
- input url to an arxiv paper, url to pdf, or existing pdf file
+ input url to an arxiv paper, url to pdf, or existing pdf
+ file
optional arguments:
- -h, --help show this help message and exit
- -v, --verbose be verbose (default: False)
- -n, --no-upload don't upload to the reMarkable, save the output in
- current working dir (default: False)
- -d, --debug debug mode, doesn't upload to reMarkable (default:
- False)
- --filename FILENAME Filename to use for the file on reMarkable (default:
- None)
- --rmapi RMAPI path to rmapi executable (default: rmapi)
- --pdfcrop PDFCROP path to pdfcrop executable (default: pdfcrop)
- --pdftk PDFTK path to pdftk executable (default: pdftk)
- --gs GS path to gs executable (default: gs)
+ -h, --help show this help message and exit
+ -v, --verbose be verbose (default: False)
+ -n, --no-upload don't upload to the reMarkable, save the output in
+ current working dir (default: False)
+ -d, --debug debug mode, doesn't upload to reMarkable (default:
+ False)
+ --filename FILENAME Filename to use for the file on reMarkable (default:
+ None)
+ -p REMARKABLE_DIR, --remarkable-path REMARKABLE_DIR
+ directory on reMarkable to put the file (created if
+ missing) (default: /)
+ --rmapi RMAPI path to rmapi executable (default: rmapi)
+ --pdfcrop PDFCROP path to pdfcrop executable (default: pdfcrop)
+ --pdftk PDFTK path to pdftk executable (default: pdftk)
+ --gs GS path to gs executable (default: gs)
```
And here's an example with verbose mode enabled that shows everything the