tmt*: add option placeholders (#19121)

pages/linux/tmt-run.md

@@ -1,7 +1,7 @@
 # tmt run
 
-> Execute tmt test steps. By default, all steps are run.
-> More information: <https://tmt.readthedocs.io/en/stable/overview.html#run>.
+> Execute `tmt` test steps. By default, all steps are run.
+> More information: <https://tmt.readthedocs.io/en/stable/stories/cli.html#run>.
 
 - Run all test steps for each plan:
 
@@ -9,28 +9,28 @@
 
 - Run only the discover step to show what tests would be run:
 
-`tmt run discover -v`
+`tmt run discover {{[-v|--verbose]}}`
 
 - Run all steps and adjust the provision step options:
 
-`tmt run --all provision --how {{container}} --image {{fedora:rawhide}}`
+`tmt run {{[-a|--all]}} provision {{[-h|--how]}} {{container}} {{[-i|--image]}} {{fedora:rawhide}}`
 
 - Run only selected plans and tests:
 
-`tmt run plan --name {{/plan/name}} test --name {{/test/name}}`
+`tmt run plan {{[-n|--name]}} {{/plan/name}} test {{[-n|--name]}} {{/test/name}}`
 
 - Show results from the last run in a web browser:
 
-`tmt run --last report --how {{html}} --open`
+`tmt run {{[-l|--last]}} report {{[-h|--how]}} {{html}} {{[-o|--open]}}`
 
 - Run tests with the provided context:
 
-`tmt run --context {{key=value}} -c {{distro=fedora}}`
+`tmt run {{[-c|--context]}} {{key=value}} {{[-c|--context]}} {{distro=fedora}}`
 
 - Run tests interactively (debug test code in the middle of a test):
 
-`tmt run --all execute --how {{tmt}} --interactive`
+`tmt run {{[-a|--all]}} execute {{[-h|--how]}} {{tmt}} --interactive`
 
 - Use dry mode to see what actions would happen and use the highest verbosity:
 
-`tmt run --dry -vvv`
+`tmt run {{[-n|--dry]}} {{[-vvv|--verbose --verbose --verbose]}}`

pages/linux/tmt-try.md

@@ -9,7 +9,7 @@
 
 - Run a test in the current working directory:
 
-`cd {{path/to/test}} && tmt try`
+`cd {{path/to/test_directory}} && tmt try`
 
 - Use a specific operating system:
 
@@ -21,15 +21,15 @@
 
 - Select tests with custom filter:
 
-`tmt try --test {{feature}}`
+`tmt try {{[-t|--test]}} {{feature}}`
 
 - Provision guest and wait for instructions:
 
-`tmt try --ask`
+`tmt try {{[-a|--ask]}}`
 
 - Directly log into the guest without asking:
 
-`tmt try --login`
+`tmt try {{[-l|--login]}}`
 
 - Display help:
 

pages/linux/tmt.md

@@ -2,7 +2,7 @@
 
 > Test Management Tool for creating, running, and debugging tests.
 > Some subcommands such as `run`, `try`, etc. have their own usage documentation.
-> More information: <https://tmt.readthedocs.io>.
+> More information: <https://tmt.readthedocs.io/en/stable/examples.html>.
 
 - List available tests, plans, and stories:
 
@@ -14,7 +14,7 @@
 
 - Create a new test with a template and a link:
 
-`tmt test create --template {{beakerlib}} --link {{verifies:issue#1234}}`
+`tmt test create {{[-t|--template]}} {{beakerlib}} --link {{verifies:issue#1234}}`
 
 - List available tests, plans, or stories:
 
@@ -22,7 +22,7 @@
 
 - Show detailed test metadata in the given context:
 
-`tmt --context {{arch=aarch64}} test show`
+`tmt {{[-c|--context]}} {{arch=aarch64}} test show`
 
 - Validate tmt files against the specification:
 
@@ -30,7 +30,7 @@
 
 - Use filter:
 
-`tmt tests ls --filter {{tag:foo}} --filter {{tier:0}}`
+`tmt tests ls {{[-f|--filter]}} {{tag:foo}} {{[-f|--filter]}} {{tier:0}}`
 
 - Display help: