Skip to content

Commit 72d51b2

Browse files
Document missing CLI options (#3709)
1 parent ac65bce commit 72d51b2

File tree

1 file changed

+82
-22
lines changed

1 file changed

+82
-22
lines changed

doc/reference/configuration/index.rst

Lines changed: 82 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -28,40 +28,100 @@ Command options
2828

2929
.. _index-tarantool_version:
3030

31-
.. option:: -V, --version
31+
.. option:: -v, -V, --version
3232

33-
Print product name and version, for example:
33+
Print the product name and version.
34+
35+
**Example**
3436

3537
.. code-block:: console
3638
37-
$ ./tarantool --version
38-
Tarantool 2.10.4-0-g816000e
39-
Target: Darwin-x86_64-Release
39+
% tarantool --version
40+
Tarantool 2.11.1-0-g96877bd
41+
Target: Darwin-arm64-Release
4042
...
4143
4244
In this example:
4345

44-
“Tarantool” is the name of the reusable asynchronous networking
45-
programming framework.
46+
* ``2.11.1`` is a Tarantool version.
47+
Tarantool follows semantic versioning, which is described in the :ref:`Tarantool release policy <release-policy>` section.
48+
49+
* ``Target`` is the platform Tarantool is built on.
50+
Platform-specific details may follow this line.
51+
52+
53+
.. option:: -e EXPR
54+
55+
Execute the 'EXPR' string. See also: `lua man page <https://www.lua.org/manual/5.3/lua.html>`_.
56+
57+
**Example**
58+
59+
.. code-block:: console
60+
61+
% tarantool -e "print('Hello, world!')"
62+
Hello, world!
63+
64+
.. option:: -l NAME
65+
66+
Require the 'NAME' library. See also: `lua man page <https://www.lua.org/manual/5.3/lua.html>`_.
67+
68+
**Example**
69+
70+
.. code-block:: console
71+
72+
% tarantool -l luatest.coverage script.lua
73+
74+
.. option:: -j cmd
75+
76+
Perform a LuaJIT control command. See also: `Command Line Options <https://luajit.org/running.html>`_.
77+
78+
**Example**
79+
80+
.. code-block:: console
81+
82+
% tarantool -j off app.lua
83+
84+
.. option:: -b ...
85+
86+
Save or list bytecode. See also: `Command Line Options <https://luajit.org/running.html>`_.
87+
88+
**Example**
89+
90+
.. code-block:: console
91+
92+
% tarantool -b test.lua test.out
93+
94+
.. option:: -d SCRIPT
95+
96+
Activate a debugging session for 'SCRIPT'. See also: `luadebug.lua <https://github.com/tarantool/tarantool/blob/master/third_party/lua/README-luadebug.md>`_.
97+
98+
**Example**
99+
100+
.. code-block:: console
101+
102+
% tarantool -d app.lua
103+
104+
105+
.. option:: -i [SCRIPT]
106+
107+
Enter an :ref:`interactive mode <interactive_console>` after executing 'SCRIPT'.
108+
109+
**Example**
110+
111+
.. code-block:: console
112+
113+
% tarantool -i
114+
115+
116+
.. option:: --
117+
118+
Stop handling options. See also: `lua man page <https://www.lua.org/manual/5.3/lua.html>`_.
46119

47-
:ref:`The 3-number version <release-policy>` follows the standard ``<major>-<minor>-<patch>``
48-
scheme, in which ``<major>`` number is changed only rarely, ``<minor>`` is
49-
incremented for each new milestone and indicates possible incompatible
50-
changes, and ``<patch>`` stands for the number of bug fix releases made after
51-
the start of the milestone. For non-released versions only, there may be a
52-
commit number and commit SHA1 to indicate how much this particular build has
53-
diverged from the last release.
54120

55-
“Target” is the platform tarantool was built on. Some platform-specific details
56-
may follow this line.
121+
.. option:: -
57122

58-
.. NOTE::
123+
Stop handling options and execute the standard input as a file. See also: `lua man page <https://www.lua.org/manual/5.3/lua.html>`_.
59124

60-
Tarantool uses
61-
`git describe <http://www.kernel.org/pub/software/scm/git/docs/git-describe.html>`_
62-
to produce its version id, and this id can be used at any time to check
63-
out the corresponding source from our
64-
`git repository <http://github.com/tarantool/tarantool.git>`_.
65125

66126
.. _index-uri:
67127

0 commit comments

Comments
 (0)