aboutsummaryrefslogtreecommitdiff
path: root/docs/man.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/man.md')
-rw-r--r--docs/man.md150
1 files changed, 150 insertions, 0 deletions
diff --git a/docs/man.md b/docs/man.md
new file mode 100644
index 0000000..dcaf594
--- /dev/null
+++ b/docs/man.md
@@ -0,0 +1,150 @@
+# paper2remarkable
+
+## SYNOPSIS
+
+```
+p2r [OPTION]... [INPUT]...
+```
+
+## DESCRIPTION
+
+Fetch an academic paper, local pdf file, or any web article and send it to the
+reMarkable tablet. The input to the script can be a URL to a PDF file or
+article on a website, or a local file. For supported scientific outlets, the
+program will collect the metadata for the paper and create a nice filename
+(unless ``--filename`` is specified). See [SUPPORTED
+SOURCES](#supported-sources) for an overview of supported scientific outlets.
+
+By default, paper2remarkable crops the unnecessary whitespace from a PDF file
+to make the paper fit better on the reMarkable. The default setting yields a
+left-aligned document on the reMarkable which can be useful for taking margin
+notes. Alternatively, the program supports the ``--center``, ``--right``, and
+``--no-crop`` options to change this crop setting.
+
+## OPTIONS
+
+Basic options:
+
+-b, --blank
+ Add a blank page after every page of the PDF document. This can be
+ useful for taking notes on papers.
+
+-e, --experimental
+ Enable the experimental features of paper2remarkable. See below under
+ [EXPERIMENTAL FEATURES](#experimental-features) for an overview.
+
+-f, --filename=FILENAME
+ Filename to use for the file on reMarkable. If you specify multiple
+ ``INPUT`` files and want to use a specific filename for each, you can
+ specify ``--filename`` for each ``INPUT`` source by repeating it.
+
+-h, --help
+ Show help message and exit.
+
+-v, --verbose
+ Enable verbose mode of paper2remarkable. By default the program prints
+ no output.
+
+-V, --version
+ Show the version and exit.
+
+Crop options:
+
+-c, --center
+ Center the PDF on the page.
+
+-k, --no-crop
+ Don't crop the document at all.
+
+-r, --right
+ Right-align the document on the reMarkable so the menu doesn't cover it.
+
+reMarkable options:
+
+-n, --no-upload
+ Don't upload the document to the reMarkable, save the output in the
+ current working dir.
+
+-p, --remarkable-path=DIR
+ The directory on the reMarkable where the document will be uploaded to.
+ If the target directory does not exist it will be created. If not
+ specified, the root directory will be used.
+
+System settings:
+
+You'll only need to specify these options if the programs are not available on
+the PATH variable.
+
+--gs=GS
+ Path to the GhostScript executable.
+
+--pdftoppm=PDFTOPPM
+ Path to pdftoppm executable (default: pdftoppm)
+
+--pdftk=PDFTK
+ Path to PDFtk executable (default: pdftk)
+
+--qpdf=QPDF
+ Path to qpdf executable (default: qpdf)
+
+--rmapi=RMAPI
+ Path to rmapi executable (default: rmapi)
+
+Developer options:
+
+-d, --debug
+ Debug mode, when used the program doesn't upload the document to the
+ reMarkable by default and leaves the temporary directory with
+ intermediate files.
+
+## SUPPORTED SOURCES
+
+The following scientific sources are currently supported and paper2remarkable
+will create a filename based on the authors, title, and publication year of
+the work. For the sources below the program is generally flexible with regards
+to whether a URL to the PDF or to the abstract page is provided.
+
+- arXiv
+- ACM Digital Library
+- CiteSeerX
+- CVF
+- JMLR
+- Nature
+- NBER
+- NeurIPS
+- OpenReview
+- PMLR
+- PubMed Central
+- SagePub
+- SemanticScholar
+- SpringerLink
+- Taylor & Francis
+
+paper2remarkable also supports a generic URL to a PDF file or a local file, in
+which case no "nice" filename will be generated.
+
+- A generic URL to a PDF file. This can be considered a fallback option for
+ when a PDF source is not supported (yet).
+- A local PDF file
+
+Finally, paper2remarkable supports extracting articles from websites. In this
+case an effort is done to detect the main content of the article and clean up
+the HTML before sending the file to the reMarkable.
+
+## EXPERIMENTAL FEATURES
+
+Occassionally, experimental (beta) features will be included in
+paper2remarkable and they will be listed here. You can enable the experimental
+features using the ``-e`` flag to paper2remarkable.
+
+- The HTML provider currently has an experimental feature to handle lazy
+ loading of images. Certain websites use a small placeholder image and
+ subsequently load the main image, which is often stored in a ``data-src``
+ attribute in the ``img`` tag. The experimental feature uses the ``data-src``
+ attribute as the image source instead of the ``src``.
+
+## BUGS
+
+Please report bugs to:
+
+https://www.github.com/GjjvdBurg/paper2remarkable