Skip to content
Snippets Groups Projects
Select Git revision
  • master-martinw-template-parameter-rework
  • master default protected
  • master-martinw-gitlab-ci
  • master-gsl3 protected
  • master-next protected
  • v.0.6.0 protected
  • v.0.5.0 protected
  • done
  • old
  • v.0.4.0 protected
  • v.0.3.1 protected
  • v.0.3.0 protected
  • v.0.2.5-gsl3 protected
  • v.0.2.5 protected
  • v.0.2.4 protected
  • v.0.2.3 protected
  • v.0.2.2 protected
  • v.0.2.1 protected
  • v.0.2.0 protected
  • v.0.0.0 protected
  • v.0.1.0 protected
21 results
Blame History Permalink
doc.md 40.90 KiB

Introduction:

In libClaPP the following Terminology is used:

Terminology:

In this project the following terms are used:

  • Option: An option can be either a short option or a long option. A short option consists of a single - followed by single character (e.g. -h). A long option consists of two -- followed by an arbitrary string (e.g. --help).
  • Parameter: Some options may require additional parameters (.e.g. --file=/path/to/file).
  • Argument: An argument is the short form for positional argument. Thus, arguments higly depend on the position where they occur. Unlinke to options that may occur anywhere else.
  • Sub-Parser: A subparser is always implicitly the last argument of a the current parser. Once this argument is given, a completely new parsing instance is started.

Outlook:

This document provides an overview of the features of libClaPP.

The first section starts with the individual value types (for options and arguments). This includes an introduction to the supported CLI-options and CLI-arguments. Also, a complete collection of shipped types is given. Including a description, how custom types can be used. Finally, additional options for options, arguments or their parameters are described (conaining constraints or additional help information).

The next section concludes with the different parser types: main-parser and sub-parser. This section also contains some complete examples that show, how a ClaPP-based parser looks like.

Examples: