From 06cab2f09871ffe209a00ba1e4e69e5415ce24a0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Patrick=20L=C3=BChne?= Date: Sun, 14 Aug 2016 16:31:23 +0200 Subject: [PATCH] Put command-line interface documentation in a separate documentation file. --- README.md | 14 ++++---------- doc/command-line-interface.md | 14 ++++++++++++++ 2 files changed, 18 insertions(+), 10 deletions(-) create mode 100644 doc/command-line-interface.md diff --git a/README.md b/README.md index cca17ab..7c0729d 100644 --- a/README.md +++ b/README.md @@ -42,25 +42,19 @@ $ plasp domain.pddl problem.pddl > instance.lp $ clingo encodings/pddl-meta-sequential-incremental.lp instance.lp ``` -### Command-Line Interface +## Command-Line Interface ```bash $ plasp [files] [options] ``` -`[files]` may be omitted, in which case the input is read from `std::cin`. -The `[options]` are listed below: - -| **option** | **explanation** | -|-----------------------------------|-----------------------------------------------------------------------------------------------------------------------------------| -| `-l` [ `--language` ] | Specify the input language (`sas` or `pddl`). Omit for automatic detection. | -| `--warning-level` arg (=`normal`) | Specify whether to output warnings normally (`normal`), to treat them as critical errors (`error`), or to ignore them (`ignore`). | -| `--color` arg (=`auto`) | Specify whether to colorize the output (`always`, `never`, or `auto`). | +`plasp` automatically detects the language of the input program. +See the [documentation of `plasp`’s command-line interface](doc/command-line-interface.md) for more detail. ## Output Format `plasp` provides a uniform output format for SAS and PDDL input problems. -See the [documentation of the output format](doc/output-format.md) for more details. +See the [documentation of the output format](doc/output-format.md) for more detail. If you want to write your own meta encoding for `plasp`’s output, the [simple example encoding](encodings/sequential-incremental.lp) gets you started. diff --git a/doc/command-line-interface.md b/doc/command-line-interface.md new file mode 100644 index 0000000..f3a09fe --- /dev/null +++ b/doc/command-line-interface.md @@ -0,0 +1,14 @@ +# Command-Line Interface + +```bash +$ plasp [files] [options] +``` + +`[files]` may be omitted, in which case the input is read from `std::cin`. +The `[options]` are listed below: + +| **option** | **explanation** | +|-----------------------------------|-----------------------------------------------------------------------------------------------------------------------------------| +| `-l` [ `--language` ] | Specify the input language (`sas` or `pddl`). Omit for automatic detection. | +| `--warning-level` arg (=`normal`) | Specify whether to output warnings normally (`normal`), to treat them as critical errors (`error`), or to ignore them (`ignore`). | +| `--color` arg (=`auto`) | Specify whether to colorize the output (`always`, `never`, or `auto`). |