Merge pull request #2919 from nekomatata/command-line-reference

Full list of command line options in command line doc

development/compiling/introduction_to_the_buildsystem.rst

@@ -122,6 +122,8 @@ you can build them yourself).
 Aside from that, there are a few standard options that can be set in all
 build targets, and which will be explained below.
 
+.. _doc_introduction_to_the_buildsystem_tools:
+
 Tools
 -----
 
@@ -134,6 +136,8 @@ manager.
 
     scons platform=<platform> tools=yes/no
 
+.. _doc_introduction_to_the_buildsystem_target:
+
 Target
 ------
 

getting_started/editor/command_line_tutorial.rst

@@ -11,6 +11,133 @@ entirely from the command line. Given the engine relies on almost no
 external libraries, initialization times are pretty fast, making it
 suitable for this workflow.
 
+Command line reference
+----------------------
+
+**General options**
+
++----------------------------+----------------------------------------------------------------------+
+| Command                    | Description                                                          |
++----------------------------+----------------------------------------------------------------------+
+| ``-h``, ``--help``, ``/?`` | Display the list of command line options.                            |
++----------------------------+----------------------------------------------------------------------+
+| ``--version``              | Display the version string.                                          |
++----------------------------+----------------------------------------------------------------------+
+| ``-v``, ``--verbose``      | Use verbose stdout mode.                                             |
++----------------------------+----------------------------------------------------------------------+
+| ``--quiet``                | Quiet mode, silences stdout messages. Errors are still displayed.    |
++----------------------------+----------------------------------------------------------------------+
+
+**Run options**
+
++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Command                                  | Description                                                                                                                                                  |
++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| ``-e``, ``--editor``                     | Start the editor instead of running the scene (:ref:`tools <doc_introduction_to_the_buildsystem_tools>` must be enabled).                                    |
++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| ``-p``, ``--project-manager``            | Start the project manager, even if a project is auto-detected (:ref:`tools <doc_introduction_to_the_buildsystem_tools>` must be enabled).                    |
++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| ``-q``, ``--quit``                       | Quit after the first iteration.                                                                                                                              |
++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| ``-l <locale>``, ``--language <locale>`` | Use a specific locale (<locale> being a two-letter code). See :ref:`doc_locales` for more details.                                                           |
++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| ``--path <directory>``                   | Path to a project (<directory> must contain a 'project.godot' file).                                                                                         |
++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| ``-u``, ``--upwards``                    | Scan folders upwards for 'project.godot' file.                                                                                                               |
++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| ``--main-pack <file>``                   | Path to a pack (.pck) file to load.                                                                                                                          |
++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| ``--render-thread <mode>``               | Render thread mode ('unsafe', 'safe', 'separate'). See :ref:`Thread Model <class_ProjectSettings_property_rendering/threads/thread_model>` for more details. |
++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| ``--remote-fs <address>``                | Remote filesystem (``<host/IP>[:<port>]`` address).                                                                                                          |
++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| ``--audio-driver <driver>``              | Audio driver. Use ``--help`` first to display the list of available drivers.                                                                                 |
++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| ``--video-driver <driver>``              | Video driver. Use ``--help`` first to display the list of available drivers.                                                                                 |
++------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
+
+**Display options**
+
++-----------------------------+----------------------------------------------------------------------------+
+| Command                     | Description                                                                |
++-----------------------------+----------------------------------------------------------------------------+
+| ``-f``, ``--fullscreen``    | Request fullscreen mode.                                                   |
++-----------------------------+----------------------------------------------------------------------------+
+| ``-m``, ``--maximized``     | Request a maximized window.                                                |
++-----------------------------+----------------------------------------------------------------------------+
+| ``-w``, ``--windowed``      | Request windowed mode.                                                     |
++-----------------------------+----------------------------------------------------------------------------+
+| ``-t``, ``--always-on-top`` | Request an always-on-top window.                                           |
++-----------------------------+----------------------------------------------------------------------------+
+| ``--resolution <W>x<H>``    | Request window resolution.                                                 |
++-----------------------------+----------------------------------------------------------------------------+
+| ``--position <X>,<Y>``      | Request window position.                                                   |
++-----------------------------+----------------------------------------------------------------------------+
+| ``--low-dpi``               | Force low-DPI mode (macOS and Windows only).                               |
++-----------------------------+----------------------------------------------------------------------------+
+| ``--no-window``             | Disable window creation (Windows only). Useful together with ``--script``. |
++-----------------------------+----------------------------------------------------------------------------+
+
+**Debug options**
+
+.. note::
+
+    Debug options are only available in the editor and debug export templates
+    (they require ``debug`` or ``release_debug`` build targets, see
+    :ref:`doc_introduction_to_the_buildsystem_target` for more details).
+
++------------------------------+---------------------------------------------------------------------------------------------+
+| Command                      | Description                                                                                 |
++------------------------------+---------------------------------------------------------------------------------------------+
+| ``-d``, ``--debug``          | Debug (local stdout debugger).                                                              |
++------------------------------+---------------------------------------------------------------------------------------------+
+| ``-b``, ``--breakpoints``    | Breakpoint list as source::line comma-separated pairs, no spaces (use %%20 instead).        |
++------------------------------+---------------------------------------------------------------------------------------------+
+| ``--profiling``              | Enable profiling in the script debugger.                                                    |
++------------------------------+---------------------------------------------------------------------------------------------+
+| ``--remote-debug <address>`` | Remote debug (``<host/IP>:<port>`` address).                                                |
++------------------------------+---------------------------------------------------------------------------------------------+
+| ``--debug-collisions``       | Show collision shapes when running the scene.                                               |
++------------------------------+---------------------------------------------------------------------------------------------+
+| ``--debug-navigation``       | Show navigation polygons when running the scene.                                            |
++------------------------------+---------------------------------------------------------------------------------------------+
+| ``--frame-delay <ms>``       | Simulate high CPU load (delay each frame by <ms> milliseconds).                             |
++------------------------------+---------------------------------------------------------------------------------------------+
+| ``--time-scale <scale>``     | Force time scale (higher values are faster, 1.0 is normal speed).                           |
++------------------------------+---------------------------------------------------------------------------------------------+
+| ``--disable-render-loop``    | Disable render loop so rendering only occurs when called explicitly from script.            |
++------------------------------+---------------------------------------------------------------------------------------------+
+| ``--disable-crash-handler``  | Disable crash handler when supported by the platform code.                                  |
++------------------------------+---------------------------------------------------------------------------------------------+
+| ``--fixed-fps <fps>``        | Force a fixed number of frames per second. This setting disables real-time synchronization. |
++------------------------------+---------------------------------------------------------------------------------------------+
+| ``--print-fps``              | Print the frames per second to the stdout.                                                  |
++------------------------------+---------------------------------------------------------------------------------------------+
+
+**Standalone tools**
+
++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Command                                | Description                                                                                                                                                                        |
++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| ``-s <script>``, ``--script <script>`` | Run a script.                                                                                                                                                                      |
++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| ``--check-only``                       | Only parse for errors and quit (use with ``--script``).                                                                                                                            |
++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| ``--export <target>``                  | Export the project using the given export target. Export only main pack if path ends with .pck or .zip (:ref:`tools <doc_introduction_to_the_buildsystem_tools>` must be enabled). |
++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| ``--export-debug <target>``            | Like ``--export``, but use debug template (:ref:`tools <doc_introduction_to_the_buildsystem_tools>` must be enabled).                                                              |
++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| ``--doctool <path>``                   | Dump the engine API reference to the given <path> in XML format, merging if existing files are found (:ref:`tools <doc_introduction_to_the_buildsystem_tools>` must be enabled).   |
++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| ``--no-docbase``                       | Disallow dumping the base types (used with ``--doctool``, :ref:`tools <doc_introduction_to_the_buildsystem_tools>` must be enabled).                                               |
++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| ``--build-solutions``                  | Build the scripting solutions (e.g. for C# projects, :ref:`tools <doc_introduction_to_the_buildsystem_tools>` must be enabled).                                                    |
++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| ``--gdnative-generate-json-api``       | Generate JSON dump of the Godot API for GDNative bindings (:ref:`tools <doc_introduction_to_the_buildsystem_tools>` must be enabled).                                              |
++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| ``--test <test>``                      | Run a unit test. Use ``--help`` first to display the list of tests. (:ref:`tools <doc_introduction_to_the_buildsystem_tools>` must be enabled).                                    |
++----------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+
 Path
 ----