documentation

This commit is contained in:
Wolfgang Hottgenroth 2021-01-23 22:11:52 +01:00
parent f9acbf07c9
commit ce1092c5ee
Signed by: wn
GPG Key ID: E49AF3B9EF6DD469

View File

@ -15,9 +15,9 @@ The script will generate one output file for each row from the result of the dat
## Usage
usage: serienbrief.py [-h] [--config CONFIG] [--query QUERY]
[--template TEMPLATE] [--outputPrefix OUTPUTPREFIX]
[--outputSuffix OUTPUTSUFFIX] [--verbose]
usage: serienbrief [-h] [--config CONFIG] [--queryFile QUERYFILE]
[--templateFile TEMPLATEFILE] [--outputPrefix OUTPUTPREFIX]
[--outputSuffix OUTPUTSUFFIX] [--verbose]
Serienbrief
@ -25,9 +25,9 @@ The script will generate one output file for each row from the result of the dat
-h, --help show this help message and exit
--config CONFIG, -f CONFIG
Config file, default is $pwd/serienbrief.ini
--queryFile QUERY, -q QUERY
--queryFile QUERYFILE, -q QUERYFILE
query file, default is $pwd/serienbrief.sql
--templateFile TEMPLATE, -t TEMPLATE
--templateFile TEMPLATEFILE, -t TEMPLATEFILE
template file, default is $pwd/serienbrief.tmpl
--outputPrefix OUTPUTPREFIX, -p OUTPUTPREFIX
prefix for the output file, will be extended by an
@ -37,6 +37,7 @@ The script will generate one output file for each row from the result of the dat
--verbose, -v verbose output
## Config file
The configuration file at least requires the database section. However, the options