Changes between Version 7 and Version 8 of Documentation/T3Q/Usage


Ignore:
Timestamp:
11/13/25 22:01:46 (2 months ago)
Author:
phdmakk
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • Documentation/T3Q/Usage

    v7 v8  
    3939 
    4040{{{ 
    41     --generate-config <FILE NAME>   Generate a new default configuration 
    42                                     file at the specified location 
    43     --config <FILE NAME>            Configuration file location 
    44     --profile <PROFILE NAME>        Configuration profile 
    45  
    46     --format                        Apply code formatting 
    47     --verbosity <LOG LEVEL>         Verbosity level (currently supports ERROR, 
    48                                     WARNING and INFORMATION values) 
    49  
    50     --local-dependencies            Generate local dependencies 
    51  
    52     --output-path <PATH>            Destination path for the output (if  
    53                                     applicable, otherwise ignored).  
    54                                     Overrides the profile setting.  
    55     --help                          Show this usage information screen 
    56  
     41--generate-config <FILE NAME>   Generate a new default configuration 
     42                                file at the specified file location 
     43--config <FILE NAME>            Configuration file location 
     44                                 
     45--profile <PROFILE NAME>        Configuration profile 
     46                                 
     47--verbosity <LOG LEVEL>         Verbosity level (currently supports 
     48                                ERROR, WARNING and INFORMATION values) 
     49--output-path <PATH>            Destination path for the output (if 
     50                                applicable, otherwise ignored), 
     51                                overrides the profile setting 
     52--help                          Show this usage information screen 
     53                                 
     54--local-dependencies            Generate local dependencies 
     55                                 
     56--single-core                   Use single core only (no parallel 
     57                                processing) 
     58--batch-resolve                 Use batch resolution of references 
     59                                 
     60--analyze-usage                 Collect language usage information 
     61                                 
     62--convert-asn1-to-schema        Convert ASN.1 files to JSON schema 
     63                                 
     64--serve-asn1-compiler           Start a server for converting ASN.1 
     65                                files to JSON schema 
     66--convert-schemas               Convert JSON schemas to TTCN-3 
    5767}}} 
    5868 * `--help` will provide brief usage information listing the expected syntax and the available options. T3Q will stop and analyze no files when the help screen is called. 
    … …  
    7787 
    7888 * The `--output-path` option (newly introduced in v1.0.1) makes it possible to supply the output path at the command line interface (overriding the profile setting). If affects only the code formatting feature and if it is not used, this optionr is simply ignored. It is added purely for convenience in case the same profile has to be used on different projects with different destination paths. 
     89 
     90 * The options `--convert-asn1-to-schema`, `--serve-asn1-compiler`, `--convert-schemas` are related to the support for ASN.1 definitions which is described in the respective section on ASN.1 Support. 
     91 
     92 * The options `--single-core` , `--batch-resolve`, and `--analyze-usage` are mostly for development, testing, and research purposes. 
     93 
    7994 
    8095The native binary executable for Windows supplied with v1.0.1 is discarded again as of v1.0.2, due to the fact that it does not grant the desired advantages. Thus, the basic usage is reverted to the batch scripts. Starting with v1.0.2, the batch scripts include a "hidden" `--echo` option, which simply outputs the deployment specific call to the Java virtual machine, '''without''' any command line arguments, meaning that it makes no sense to provide any further command line parameters besides the `--echo` option. The sole purpose of this option is to output the full command line necessary for starting the tool, which may be necessary for embedding into third party tools. This is why this option is considered hidden (it also does not show in the standard help screen). It should not affect the general usage of the tool. If, for whatever reason, other command line arguments are supplied together with the `--echo` option, then the `--echo` option needs to be the first command line argument.