Skip to content

Commit eff9273

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

File tree

1 file changed

+89
-18
lines changed

1 file changed

+89
-18
lines changed

doc/reference/configuration/index.rst

Lines changed: 89 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -28,41 +28,112 @@ Command options
2828

2929
.. _index-tarantool_version:
3030

31-
.. option:: -V, --version
31+
.. option:: -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.
4648

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.
49+
For non-released versions, there may be a
50+
commit number and commit SHA1 to indicate how much this particular build has
51+
diverged from the last release.
5452

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

5856
.. NOTE::
5957

6058
Tarantool uses
6159
`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
60+
to produce its version id. This id can be used to check
61+
out the corresponding source from the
6462
`git repository <http://github.com/tarantool/tarantool.git>`_.
6563

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

68139
--------------------------------------------------------------------------------

0 commit comments

Comments
 (0)