From 171299f416e43e6ae80e340aaa8ac1319635bc5e Mon Sep 17 00:00:00 2001 From: Zachary Vance Date: Mon, 31 May 2021 18:31:20 -0700 Subject: [PATCH] Add new USAGE page --- README.md | 2 +- USAGE.md | 31 +++++++++++++++++++++++++++++++ 2 files changed, 32 insertions(+), 1 deletion(-) create mode 100644 USAGE.md diff --git a/README.md b/README.md index 9847cbb..42fdf32 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ Takes any file, and outputs a "paper backup": a printable black-and-white pdf fu Following the directions in the pdf, the QR codes can be re-scanned or photographed using a webcam to restore the original file. -For a full list of options, run `qr-backup --help`. For more questions, see the [FAQ](FAQ.md). +For a full list of options, run `qr-backup --help` or read the [USAGE](usage.md) doc online. For more questions, see the [FAQ](FAQ.md). This is alpha software--I use it for my own backups, but I offer no guarantees. Test your restore when you make it, not when you need it! diff --git a/USAGE.md b/USAGE.md new file mode 100644 index 0000000..8b0a0a9 --- /dev/null +++ b/USAGE.md @@ -0,0 +1,31 @@ +Output of `qr-backup --help`: + +``` +Usage: qr-codes.py [OPTIONS] FILE +Convert a binary file to a paper .pdf backup of QR codes. + +The QR codes can be read back with a scanner or webcam to re-create the original file. Directions are included in the PDF. Make sure to test that you can actually read the QR size you select. + + --dpi DPI + Sets the print resolution of your printer. Default: 600 + --compress, --no-compress + This gives a more compact backup, but partial recovery is impossible. Turns base-64 encoding on. Default: compressed + --error-correction CORRECTION + Sets the error correction level. Options are L, M, Q, and H. Default: M (25%) + --filename FILENAME + Set the restored filename. Max 32 chars. Default: same as + --page WIDTH_POINTS HEIGHT_POINTS + Sets the usable size of the paper on your printer. This should NOT be 8.5 x 11 -- make sure to include margins. Default: 500x600 + --qr-version VERSION + Uses QR codes, version VERSION. Versions range from 1-40. The bigger the version, the harder to scan but the more data per code. Default: 10 + --scale SCALE + Scale QR codes so that each small square in the QR code is SCALE x SCALE pixels. Default: 8 + --base64 + Force base64 encoding. Default: turned on if needed + --verbose, -v + Print more detailed information during run + +The QR mode is always binary with no QR compression. + +The output is named .qr.pdf +```