patrick/plasp
Archived
1
0
Fork 0
Code Issues 12 Releases 8 Activity

Put command-line interface documentation in a separate documentation file.

Browse Source
This commit is contained in:
Patrick Lühne 2016-08-14 16:31:23 +02:00
parent 9d67ae800d
commit 06cab2f098
2 changed files with 18 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -42,25 +42,19 @@ $ plasp domain.pddl problem.pddl > instance.lp
$ clingo encodings/pddl-meta-sequential-incremental.lp instance.lp $ clingo encodings/pddl-meta-sequential-incremental.lp instance.lp
``` ```
### Command-Line Interface ## Command-Line Interface
```bash ```bash
$ plasp [files] [options] $ plasp [files] [options]
``` ```
`[files]` may be omitted, in which case the input is read from `std::cin`. `plasp` automatically detects the language of the input program.
The `[options]` are listed below: See the [documentation of `plasp`’s command-line interface](doc/command-line-interface.md) for more detail.
| **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`). |
## Output Format ## Output Format
`plasp` provides a uniform output format for SAS and PDDL input problems. `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. If you want to write your own meta encoding for `plasp`’s output, the [simple example encoding](encodings/sequential-incremental.lp) gets you started.

14
doc/command-line-interface.md Normal file
View File

@ -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`). |