Skip to content

Commit eae9558

Browse files
committed
Document missing CLI options
1 parent 30c9b3c commit eae9558

File tree

1 file changed

+88
-16
lines changed

1 file changed

+88
-16
lines changed

doc/reference/configuration/index.rst

Lines changed: 88 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -28,32 +28,31 @@ Command options
2828

2929
.. _index-tarantool_version:
3030

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

3333
Print product name and version, for example:
3434

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

55-
Target is the platform tarantool was built on. Some platform-specific details
56-
may follow this line.
54+
* ``Target`` is the platform Tarantool is built on.
55+
Platform-specific details may follow this line.
5756

5857
.. NOTE::
5958

@@ -63,6 +62,79 @@ Command options
6362
out the corresponding source from our
6463
`git repository <http://github.com/tarantool/tarantool.git>`_.
6564

65+
.. option:: -e EXPR
66+
67+
Execute the 'EXPR' string. See also: `lua man page <https://www.lua.org/manual/5.3/lua.html>`_.
68+
69+
**Example**
70+
71+
.. code-block:: console
72+
73+
% tarantool -e "print('Hello, world!')"
74+
Hello, world!
75+
76+
.. option:: -l NAME
77+
78+
Require the 'NAME' library. See also: `lua man page <https://www.lua.org/manual/5.3/lua.html>`_.
79+
80+
**Example**
81+
82+
.. code-block:: console
83+
84+
% tarantool -l luatest.coverage script.lua
85+
86+
.. option:: -j cmd
87+
88+
Perform a LuaJIT control command. See also: `Command Line Options <https://luajit.org/running.html>`_.
89+
90+
**Example**
91+
92+
.. code-block:: console
93+
94+
% tarantool -j off app.lua
95+
96+
.. option:: -b ...
97+
98+
Save or list bytecode. See also: `Command Line Options <https://luajit.org/running.html>`_.
99+
100+
**Example**
101+
102+
.. code-block:: console
103+
104+
% tarantool -b test.lua test.out
105+
106+
.. option:: -d SCRIPT
107+
108+
Activate a debugging session for 'SCRIPT'. See also: `luadebug.lua <https://github.com/tarantool/tarantool/blob/master/third_party/lua/README-luadebug.md>`_.
109+
110+
**Example**
111+
112+
.. code-block:: console
113+
114+
% tarantool -d app.lua
115+
116+
117+
.. option:: -i [SCRIPT]
118+
119+
Enter an :ref:`interactive mode <interactive_console>` after executing 'SCRIPT'.
120+
121+
**Example**
122+
123+
.. code-block:: console
124+
125+
% tarantool -i
126+
127+
128+
.. option:: --
129+
130+
Stop handling options. See also: `lua man page <https://www.lua.org/manual/5.3/lua.html>`_.
131+
132+
133+
.. option:: -
134+
135+
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>`_.
136+
137+
66138
.. _index-uri:
67139

68140
--------------------------------------------------------------------------------

0 commit comments

Comments
 (0)