Commit ca686380 authored by Nicolas Vuaille's avatar Nicolas Vuaille

Adding documentation for multiclients and update pvserver --help doc

parent 41230c5f
......@@ -21,7 +21,9 @@ The following is a list of options available when running \ParaView from the com
\item \texttt{--data-server-port}, \texttt{-dsp}: Specify the port to use in establishing a connection between the client and the data server. The default is \texttt{--data-server-port=11111}. If used, this argument must be specified on both the client and the data server command lines, and the port numbers must match.
\item \texttt{--render-server-port}, \texttt{-rsp}: Specify the port to use in establishing a connection between the client and the render server. The default is \texttt{--render-server-port=22221}. If used, this argument must be specified on both the client and the render server command lines, and the port numbers must match.
\item \texttt{--reverse-connection}, \texttt{-rc}: Cause the data and render servers to connect to the client. When using this option, the client, data server, and render server (if used) must be started with this command-line argument, and you should start the client before starting either server.
\item \texttt{--connect-id}: Using a connect ID is a security feature in client-server mode. To use this feature, pass this command-line argument with the same ID number to the client and server(s). If you do not pass the same ID number, the server(s) will be shut down.
\item \texttt{--connect-id}: Using a connect ID is a security feature in client-server mode. To use this feature, pass this command-line argument with the same ID number to the client and server. If a client does not have the same connect-id as the server it will be prompted for a connect-id. In case of multi-clients mode, the master client is able to modify the server connect-id.
\item \texttt{--multi-clients}: Tell the server to accept connections from multiple clients at the same time. This command-line option is used on the server(s).
\item \texttt{--disable-further-connections}: Tell the server to block further connections once a client is connected. The master client is able to enable/disable this feature at runtime. Does nothing without \texttt{--multi-clients}. This command-line option is used on the server(s).
\item \texttt{--machines}, \texttt{-m}: Use this command-line argument to pass in the network configuration file for the render server. See section Error: Reference source not found for a description of this file.
\item \texttt{--servers-file}: Use this option to specify the file that contains the configurations of the servers. This option replaces the default server configuration file. Any changes to the server list are saved to this file instead of the default server configuration file.
\end{itemize}
......@@ -157,47 +159,70 @@ The following is a list of options available when running \ParaView from the com
\begin{shell}
--client-host=opt
-ch=opt Tell the data|render server the host name of the client, use with -rc.
-ch=opt Tell the data|render server the host name of the client, use with -rc.
--connect-id=opt Set the ID of the server and client to make sure they match.
--connect-id=opt Set the ID of the server and client to make sure they match. 0 is reserved to imply none specified.
--cslog=opt ClientServerStream log file.
--cslog=opt ClientServerStream log file.
--disable-further-connections Disable further connections after the first client connects.Does nothing without --multi-clients enabled.
--disable-registry
-dr Do not use registry when running ParaView (for testing).
--disable-xdisplay-test When specified, all X-display tests and OpenGL version checks are skipped. Use this option if you are getting remote-rendering disabled errors and you are positive that the X environment is set up properly and your OpenGL support is adequate (experimental).
--disable-composite
-dc Use this option when rendering resources are not available on the server.
--enable-bt Enable stack trace signal handler.
--enable-satellite-message-ids
-satellite When specified, server side messages shown on client show rank of originating process
--enable-streaming EXPERIMENTAL: When specified, view-based streaming is enabled for certain views and representation types.
--force-offscreen-rendering If supported by the build and platform, create headless (offscreen) render windows for rendering results.
--force-onscreen-rendering If supported by the build and platform, create on-screen render windows for rendering results.
--help
/? Displays available command line arguments.
/? Displays available command line arguments.
--machines=opt
-m=opt Specify the network configurations file for the render server.
--hostname=opt Override the hostname to be used to connect to this process. By default, the hostname is determined using appropriate system calls.
--multi-clients Allow server to keep listening for several clients toconnect to it and share the same visualization session.
--multi-clients Allow server to keep listening for serveral client toconnect to it and share the same visualization session.
--multi-clients-debug Allow server to keep listening for several clients toconnect to it and share the same visualization session.While keeping the error macro on the server session for debug.
--print-monitors Print detected monitors and exit (Windows only).
--reverse-connection
-rc Have the server connect to the client.
-rc Have the server connect to the client.
--server-port=opt
-sp=opt What port should the combined server use to connect to the client. (default 11111).
-sp=opt What port should the combined server use to connect to the client. (default 11111).
--test-plugin=opt Specify the name of the plugin to load for testing
--test-plugin-path=opt Specify the path where more plugins can be found.This is typically used when testing plugins.
--tile-dimensions-x=opt
-tdx=opt Size of tile display in the number of displays in each row of the display.
-tdx=opt Size of tile display in the number of displays in each row of the display.
--tile-dimensions-y=opt
-tdy=opt Size of tile display in the number of displays in each column of the display.
-tdy=opt Size of tile display in the number of displays in each column of the display.
--tile-mullion-x=opt
-tmx=opt Size of the gap between columns in the tile display, in Pixels.
-tmx=opt Size of the gap between columns in the tile display, in pixels.
--tile-mullion-y=opt
-tmy=opt Size of the gap between rows in the tile display, in Pixels.
-tmy=opt Size of the gap between rows in the tile display, in pixels.
--timeout=opt Time (in minutes) since connecting with a client after which the server may timeout. The client typically shows warning messages before the server times out.
--timeout=opt Time (in minutes) since connecting with a client after which the server may timeout. The client typically shows warning messages before the server times out.
--use-offscreen-rendering Render offscreen on the satellite processes. This option only works with software rendering or mangled mesa on Unix.
--use-offscreen-rendering Render offscreen on the satellite processes. This option only works with software rendering or mangled Mesa on Unix.
--version
-V Give the version number and exit.
-V Give the version number and exit.
\end{shell}
\texttt{pvdataserver --help}
......
......@@ -229,6 +229,35 @@ security measures have been taken. The typical approach is to use an
SSH tunnel.
\end{commonerrors}
\subsection{Managing multiple clients}
\pvserver can be configured to accept connections from multiple clients at the same time.
In this case only one, called the master, can interact with the pipeline.
Others clients are only allowed to visualize the data. The \ui{Collaboration Panel}
shares information between connected clients.
To enable this mode, \pvserver must be started with the \texttt{--multi-clients} flag:
\begin{shell}
pvserver --multi-clients
\end{shell}
If your remote server is accessible from many users, you may want to restrict the access.
This can be done with a connect id.
If your client does not have the same connect-id as the server you want to connect to,
you will be prompted for a connect-id.
Then, if you are the master, you can change the connect-id in the \ui{Collaboration Panel}.
Note that initial value for connect-id can be set by starting the \pvserver
(and respectively \paraview) with the \texttt{--connect-id} flag, for instance:
\begin{shell}
pvserver --connect-id=147
\end{shell}
The master client can also disable the further connections in the \ui{Collaboration Panel}.
So you can work alone and once you are ready, you may allow other people to connect
to the \pvserver to share a visualization. This is the default feature when \pvserver is
started with \texttt{--multi-clients --disable-further-connections}.
\subsection{Setting up a client/server visualization pipeline}
Using \paraview when connected to a remote server is not any different than when
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment