aboutsummaryrefslogtreecommitdiff
path: root/docs/index.rst
diff options
context:
space:
mode:
authorCharles Cabergs <me@cacharle.xyz>2021-02-26 15:55:26 +0100
committerCharles Cabergs <me@cacharle.xyz>2021-02-26 15:58:27 +0100
commit86355a6fd7375f954bf92cb49a14c718610c4d60 (patch)
treec9f10c225fe6cec7439343dbc6dbf0e8c973c71e /docs/index.rst
parentc2ca0d297b8e067c5e315500fb2f35f50ff6af8a (diff)
downloadminishell_test-86355a6fd7375f954bf92cb49a14c718610c4d60.tar.gz
minishell_test-86355a6fd7375f954bf92cb49a14c718610c4d60.tar.bz2
minishell_test-86355a6fd7375f954bf92cb49a14c718610c4d60.zip
Added command line argument documentation draft
Diffstat (limited to 'docs/index.rst')
-rw-r--r--docs/index.rst6
1 files changed, 4 insertions, 2 deletions
diff --git a/docs/index.rst b/docs/index.rst
index 109963f..7726f0a 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,3 +1,5 @@
+.. program:: minishell_test
+
minishell_test
==============
@@ -72,10 +74,10 @@ Environement variables
This test only gives the ``PATH`` and ``TERM`` environment variables to your minishell by default (see :ref:`config env`).
-You can test this quickly with the `-t` option (See :ref:`options try`).
+You can test this quickly with :option:`--try`.
.. warning::
- Please check that your project still work with those settings before creating an issue or messaging me on.
+ Please check that your project still work with this environment before creating an issue or messaging me on Slack.
Bonus
-----