Skip to content

Commit e8e18f0

Browse files
committed
update documentation
1 parent 94146e7 commit e8e18f0

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

doc/users/config_file.rst

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -69,12 +69,17 @@ Execution
6969
``false``; default value: ``true``)
7070

7171
*display_variable*
72-
What ``DISPLAY`` variable should all command line interfaces be
73-
run with. This is useful if you are using `xnest
74-
<http://www.x.org/archive/X11R7.5/doc/man/man1/Xnest.1.html>`_
72+
What ``$DISPLAY`` environment variable should utilize those interfaces
73+
that require an X server. These interfaces should have the attribute
74+
``_redirect_x = True``. This option is very useful when the system has
75+
an X server listening in the default port 6000, but ``$DISPLAY`` is
76+
not defined. In that case, set ``display_variable = :0``. Similarly,
77+
it can be used to point X-based interfaces to other servers, like VNC,
78+
`xnest <http://www.x.org/archive/X11R7.5/doc/man/man1/Xnest.1.html>`_
7579
or `Xvfb <http://www.x.org/archive/X11R6.8.1/doc/Xvfb.1.html>`_
7680
and you would like to redirect all spawned windows to
77-
it. (possible values: any X server address; default value: not
81+
it. If not set, nipype will try to configure a new virtual server using
82+
Xvfb. (possible values: any X server address; default value: not
7883
set)
7984

8085
*remove_unnecessary_outputs*

0 commit comments

Comments
 (0)