From 5b3b96fb3519f9986c251a16ccea491d1ac7f963 Mon Sep 17 00:00:00 2001 From: Lorenz Stechauner Date: Sun, 14 Jan 2024 12:14:10 +0100 Subject: [PATCH] README: Add Usage --- CreateExe.bat | 3 ++- README.md | 40 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 42 insertions(+), 1 deletion(-) diff --git a/CreateExe.bat b/CreateExe.bat index 83085a4..0d0ede4 100644 --- a/CreateExe.bat +++ b/CreateExe.bat @@ -1,4 +1,5 @@ -pyinstaller --noconfirm ^ +pyinstaller ^ + --noconfirm ^ --onefile ^ --console ^ --icon "NONE" ^ diff --git a/README.md b/README.md index e9f2197..b2a3eb8 100644 --- a/README.md +++ b/README.md @@ -3,3 +3,43 @@ A standalone [WeasyPrint](https://weasyprint.org/) wrapper for Windows. + +# Usage + +Synopsis: +``` +winziprint [-h] [-v] [-d DIR] [ -D | [-p] [-2] [-e ENCODING] [ - | INPUT [INPUT...] OUTPUT ] ] +``` + +Command line options: +* `-h`, `--help` - show help message and exit +* `-V`, `--version` - show version and exit +* `-D`, `--daemon` - run as a daemon and expose a named socket +* `-d`, `--directory` - set the working directory +* `-e`, `--encoding` - encoding of the input files +* `-2`, `-double-sided` - pad documents to an event number of pages +* `-p`, `--progress` - show progress updates + +Command line arguments: +* `-` - use stdin for retrieving input and output file names (semi-colon-seperated) +* `INPUT` - name of a html input file +* `OUTPUT` - name of a pdf output file + + +## Normal mode + +In normal mode all options, input and output files are passed by command line arguments. + + +## Batch mode + +To activate batch mode `-` has to be passed as only input or output file. +In batch mode all options may be passed as command line arguments. These are used as defaults. + + +## Server mode + +To activate server mode the `-D` flag has to be set. +Keep in mind, that not all command line options may be present. +The protocol is the same as in server mode. +