Document infer command

atextor · Jan 22, 2022 · 07366ea · 07366ea
1 parent e13a72d
commit 07366ea
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -9,6 +9,7 @@ Language](https://en.wikipedia.org/wiki/Web_Ontology_Language) (OWL 2) and
 
 * generate a diagram for an OWL ontology with the `diagram command`
 * read any RDF document in [RDF/Turtle](https://www.w3.org/TR/turtle/), [RDF/XML](https://www.w3.org/TR/rdf-syntax-grammar/), [RDF N-Triples](https://www.w3.org/TR/n-triples/) or [N3](https://www.w3.org/TeamSubmission/n3/) format and write it in configurable, pretty-printed RDF/Turtle or one of the other formats using the `write command`
+* perform OWL DL reasoning on an input ontology using the `infer command`
 
 <img src="docs/modules/ROOT/assets/images/splash.svg" alt="owl diagram splash image" width="50%"/>
 

diff --git a/docs/modules/ROOT/pages/index.adoc b/docs/modules/ROOT/pages/index.adoc
@@ -13,6 +13,7 @@ https://www.w3.org/TR/rdf-syntax-grammar/[RDF/XML],
 https://www.w3.org/TR/n-triples/[RDF N-Triples] or
 https://www.w3.org/TeamSubmission/n3/[N3] format and write it in configurable, pretty-printed
 RDF/Turtle or one of the other formats using the xref:usage.adoc#write-command[write command]
+* perform OWL DL reasoning on an input ontology using the xref:usage.adoc#infer-command[infer command]
 
 You can find the source code on https://github.com/atextor/owl-cli[Github].
 

diff --git a/docs/modules/ROOT/pages/usage.adoc b/docs/modules/ROOT/pages/usage.adoc
@@ -362,3 +362,28 @@ Read a remote ontology in RDF/XML format and print it in formatted Turtle format
 ----
 owl write -i rdfxml 'http://www.ontologydesignpatterns.org/cp/owl/partof.owl'
 ----
+
+[#infer-command]
+== `infer` Command
+
+
+[#infer-usage]
+=== General Usage
+
+The `infer` command takes an OWL ontology as input and performs OWL 2 DL reasoning on it. Reasoning
+is done using the https://github.com/Galigator/openllet[Openllet] reasoner.
+
+General usage: `owl infer input [output]`, where `input` can be either an ontology file, an URL or
+`-` (which means: read from standard in) and `output` can be either an ontology file or `-` (which
+means: write to standard out). If `input` is a file and `output` is not given, the input file is
+overwritten with the inferenced result. If `input` is `-` and `output` is not given, the output is
+set to standard out.
+
+[#infer-example-usage]
+=== Example Usage
+
+Perform reasoning on the input ontology and write results to stdout:
+[source,shell]
+----
+owl infer ontology.ttl -
+----