taler-docs

Documentation for GNU Taler components, APIs and protocols
Log | Files | Refs | README | LICENSE

taler-terms-generator.1.rst (2171B)

      1 taler-terms-generator(1)
      2 ########################
      3 
      4 
      5 .. only:: html
      6 
      7    Name
      8    ====
      9 
     10    **taler-terms-generator** - generate legal terms for GNU Taler services
     11 
     12 
     13 Synopsis
     14 ========
     15 
     16 **taler-terms-generator**
     17 [**-a** *AUTHOR*]
     18 [**-C** *COPYRIGHT*]
     19 [**-h**]
     20 [**-i** *INPUT*]
     21 [**-l** *LANGUAGE*]
     22 [**-o** *OUTPUT*]
     23 [**-p** *PAPER*]
     24 [**-t** *TITLE*]
     25 
     26 
     27 Description
     28 ===========
     29 
     30 **taler-terms-generator** is a command-line tool to create terms of service
     31  and privacy policy files in various file formats and languages from a
     32  reStructuredText (".rst") input. It can be used to generate the responses
     33  various GNU Taler services serve under the ``/terms`` and ``/pp`` endpoints.
     34 
     35 **-a** *AUTHOR*
     36    set the author information to the given AUTHOR in the meta-data of various generated outputs.
     37 
     38 **-C** *COPYRIGHT*
     39    set the copyright information to the given COPYRIGHT in the meta-data of various generated outputs.
     40 
     41 **-h** \| **--help**
     42    Prints a compiled-in help text.
     43 
     44 **-i** *INPUT*
     45    Name of the input (.rst) file with the terms of service or privacy policy to convert. If the full path with language code is given, the "-l" option will be derived from it. However, you can also just give the short name (like "taler-exchange-tos-v0") in which case the tool will try to locate the input file and use the language specified with "-l".
     46 
     47 **-l** *LANGUAGE*
     48    Ouput files for the given *LANGUAGE* for the current *INPUT*. *LANGUAGE* must be a two-letter language code (like "de" or "it"). Default is "en".
     49 
     50 **-o** *OUTPUT*
     51    Specifies where to write the output. This should be the directory where the service expects to find the generated resources.  Unless you changed the default configuration, you probably do not have to specify this value.
     52 
     53 **-p** *PAPER*
     54    Specifies the paper format for generated PDF documents. Can be "a4" or "letter".
     55 
     56 **-t** *TITLE*
     57    Overrides the document title. By default, the title will be set to the contents of the first line of the *INPUT* ".rst" file.
     58 
     59 
     60 See Also
     61 ========
     62 
     63 taler-exchange-config(1), taler-exchange.conf(5)
     64 
     65 Bugs
     66 ====
     67 
     68 Report bugs by using https://bugs.taler.net/ or by sending electronic
     69 mail to <taler@gnu.org>.