Skip to content

Commit 69395c5

Browse files
authored
Update CommandLineInterface.rst
1 parent 4ba947c commit 69395c5

File tree

1 file changed

+16
-8
lines changed

1 file changed

+16
-8
lines changed

CommandLineInterface.rst

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,21 @@ Usage
1111

1212
::
1313
14-
expyriment [-h] [-0] [-1] [-2] [-3] [-a] [-d] [-f] [-i] [-t] [-w]
15-
[--display INDEX] [--display-resolution WIDTHxHEIGHT]
16-
[--opengl MODE] [--window-size WIDTHxHEIGHT] [-A] [-B] [-C] [-D]
17-
[-I] [-J] [-S] [-T] [SCRIPT]
18-
14+
usage: cli.py [-h] [-0] [-1] [-2] [-3] [-a] [-d] [-f] [-i] [-t] [-w]
15+
[--display INDEX] [--display-resolution WIDTHxHEIGHT]
16+
[--opengl MODE] [--text-size SIZE] [--window-size WIDTHxHEIGHT]
17+
[-A] [-B] [-C] [-D] [-I] [-J] [-S] [-T]
18+
[SCRIPT]
19+
20+
The Expyriment command line interface provides a convenient way to run
21+
experiment scripts and apply default settings, as well as access to a
22+
selection of other common functionality. Note: non-capitalized letter
23+
arguments are (chainable) options, capitalized letter arguments run single
24+
commands
25+
1926
positional arguments:
2027
SCRIPT the experiment script to be executed
21-
28+
2229
options:
2330
-h, --help show this help message and exit
2431
-0, -g, --no-opengl DEPRECATED: no OpenGL (no vsync / no blocking)
@@ -39,8 +46,9 @@ Usage
3946
--display-resolution WIDTHxHEIGHT
4047
set the display resolution (only in fullscreen mode)
4148
--opengl MODE set the OpenGL mode: 0 = No OpenGL (no vsync / no
42-
blocking), 1 = OpenGL (vsync / no blocking), 2 = OpenGL
43-
(vsync / blocking)
49+
blocking), 1 = OpenGL (vsync / no blocking), 2 =
50+
OpenGL (vsync / blocking)
51+
--text-size SIZE set the default text size
4452
--window-size WIDTHxHEIGHT
4553
set the window size (only in window mode)
4654
-A, --Api start the API reference tool

0 commit comments

Comments
 (0)