diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst index 7d91e152..21d25d41 100644 --- a/docs/userguide/index.rst +++ b/docs/userguide/index.rst @@ -3,7 +3,33 @@ User Guide ========== -To print all available commands and options use: +.. contents:: + +Usage +----- + +.. code-block:: bash + + platformio [OPTIONS] COMMAND + +Options +------- + +.. option:: + --force, - f + +Force to accept any confirmation prompts. This option allows to avoid an issue +with :ref:`faq_troubleshooting_pioblocksprompt` + +.. option:: + --version + +Show the version of PlatformIO + +.. option:: + --help + +Show help for the available options and commands .. code-block:: bash @@ -11,6 +37,9 @@ To print all available commands and options use: $ platformio COMMAND --help +Commands +-------- + .. toctree:: :maxdepth: 2