
\section{Cylc Gscan Config File Reference}
\label{GscanRCReference}

\lstset{language=bash}

This section defines all legal items and values for the gscan config
file which should be located in \lstinline=$HOME/.cylc/gscan.rc=. Some items
also affect the gpanel panel app.

The main menubar and toolbar appear when the mouse pointer is moved toward the
top of the gscan window.  The View menu allows you to change which columns are
displayed, which hosts to scan for running suites, and the task state icon
theme.

At startup, the task state icon theme and icon size are taken from the gcylc
config file \lstinline=$HOME/.cylc/gcylc.rc=.


\subsection{Top Level Items}

\subsubsection{activate on startup}

Set whether \lstinline=cylc gpanel= will activate automatically when the gui is
loaded or not.

\begin{myitemize}
    \item {\em type:} boolean (True or False)
\item {\em legal values:} ``True'', ``False''
\item {\em default:} ``False''
\item {\em example:} \lstinline@activate on startup = True@
\end{myitemize}

\subsubsection{columns}

Set the columns to display when the \lstinline=cylc gscan= GUI starts. This can
be changed later with the View menu.  The order in which the columns are
specified here does not affect the display order.

\begin{myitemize}
\item {\em type:} string (a list of one or more view names)
\item {\em legal values:} ``host'', ``owner'', ``status'', ``suite'',
  ``title'', ``updated''
\item {\em default:} ``status'', ``suite''
\item {\em example:} \lstinline@columns = suite, title, status@
\end{myitemize}

\subsubsection{window size}

Sets the size in pixels of the \lstinline=cylc gscan= GUI at startup.

\begin{myitemize}
    \item {\em type:} integer list: x, y
    \item {\em legal values:} positive integers
    \item {\em default:} 300, 200
    \item {\em example:} \lstinline@window size = 1000, 700@
\end{myitemize}
