From: pcarana <pc.moreno2099@gmail.com>
Date: Wed, 28 Aug 2019 21:46:57 +0000 (-0500)
Subject: Add usage/run examples
X-Git-Tag: v1.1.0~2
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=298c8f9ab0147159e70e47fb7f0766a5bc1b8b31;p=thirdparty%2FFORT-validator.git

Add usage/run examples
---

diff --git a/README.md b/README.md
index 32ee19f3..1b31e298 100644
--- a/README.md
+++ b/README.md
@@ -25,12 +25,35 @@ More documentation at [https://nicmx.github.io/FORT-validator/](https://nicmx.gi
 
 ## Usage
 
+Use the following command to run an RTR server that will serve the ROAs resulting from a validation rooted at the trust anchors defined by the TALs contained at directory `--tal`:
+
+```
+fort \
+	--tal <path to your TAL files> \
+	--local-repository <path where you want to keep your local cache> \
+	--server.address <your intended RTR server address> \
+	--server.port <your intended RTR server port>
+```
+
+Run Fort validator as standalone (perform validation and exit) and print ROAs to CSV file:
+
+```
+fort \
+	--mode standalone \
+	--output.roa <path to output file in CSV format> \
+	--tal <path to your TAL files> \
+	--local-repository <path where you want to keep your local cache>
+```
+
+Run Fort validator using a [SLURM file](https://tools.ietf.org/html/rfc8416):
+
 ```
 fort \
+	--slurm <path to a SLURM file> \
 	--tal <path to your TAL files> \
 	--local-repository <path where you want to keep your local cache> \
 	--server.address <your intended RTR server address> \
 	--server.port <your intended RTR server port>
 ```
 
-An RTR server will serve the ROAs resulting from a validation rooted at the trust anchors defined by the TALs contained at directory `--tal`.
+Visit the [Usage](https://nicmx.github.io/FORT-validator/doc/usage.html) section at the docs to know all the possible Fort configurations, these are some usage examples.
\ No newline at end of file
diff --git a/docs/doc/run.md b/docs/doc/run.md
index b04adede..8a9889c8 100644
--- a/docs/doc/run.md
+++ b/docs/doc/run.md
@@ -6,7 +6,7 @@ title: Running Fort
 
 # {{ page.title }}
 
-This is probably all you need:
+This is probably all you need, an RTR server will serve the ROAs resulting from a validation rooted at the trust anchors defined by the TALs contained at directory `--tal`:
 
 {% highlight bash %}
 fort \
@@ -16,4 +16,25 @@ fort \
 	--server.port <your intended RTR server port>
 {% endhighlight %}
 
-See [usage](usage.html) for more details.
+This will run Fort validator as standalone (perform validation and exit) and print ROAs to CSV file:
+
+{% highlight bash %}
+fort \
+	--mode standalone \
+	--output.roa <path to output file in CSV format> \
+	--tal <path to your TAL files> \
+	--local-repository <path where you want to keep your local cache>
+{% endhighlight %}
+
+This will run Fort validator using a [SLURM file](https://tools.ietf.org/html/rfc8416):
+
+{% highlight bash %}
+fort \
+	--slurm <path to a SLURM file> \
+	--tal <path to your TAL files> \
+	--local-repository <path where you want to keep your local cache> \
+	--server.address <your intended RTR server address> \
+	--server.port <your intended RTR server port>
+{% endhighlight %}
+
+These are some examples to run Fort with distinct configurations; see [usage](usage.html) for more details.
\ No newline at end of file