GBCH-Q(1)

NAME
gbch-q - view batch jobs and variables interactively

SYNOPSIS
gbch-q [ -options ]

DESCRIPTION
gbch-q is an interactive program that allows the user to display in real-time state and details of GNUbatch jobs and variables on local or remote machines, refreshing the screen automatically as the queue changes or variables are updated, and allowing the status of jobs and variables on the queue to be altered according to each user's permissions and privileges.

For more information about the details of the interactive commands, please see the on-line help information, obtained by pressing ? (although this may be changed on your site). This section focuses on the command-line options which may be used to control the initial display.

OPTIONS
Note that the order of treatment, letters and keywords described below may be modified by editing the file btrest.help - see btsyntax(5).

The environment variable on which options are supplied is "GBCH_Q" and the environment variable to specify the help file is "BTQCONF".

Certain commands available on-screen enable many of these options to be changed and saved in configuration files.

-? or +explain
    Causes a summary of the other options to be displayed without taking further action or entering the interactive display.

-A or +no-confirm-delete
    Suppress confirmation request for delete operations.

-a or +confirm-delete
    Ask confirmation of delete operations (this is the default).

-B or +no-help-box
    Put help messages in inverse video rather than in a box (this is the default).

-b or +help-box
    Put help messages in a box rather than displaying inverse video.

-E or +no-error-box
    Put error messages in inverse video rather than in a box.

-e or +error-box
    Put error messages in a box rather than displaying inverse video.

-g group or +just-group group
    Restrict the output to jobs owned by the group specified. Cancel this argument by giving a single "-" sign as an argument. The group name may be a pattern with shell-like wild cards.

    The wild card options are as described in the documentation of gbch-jlist(1).

-H or +keep-char-help
    When displaying a help screen, interpret the next key press as a command as well as clearing the help screen. This is the default.

-h or +lose-char-help
    Discard whatever key press is made to clear a help screen.

-j or +jobs-screen
    Commence display in jobs screen. This is the default unless there are no jobs to be viewed.

-l or +local-only
    Only display jobs local to the machine.

-N or +follow-job
    If a job or variable moves on the screen, try to follow it and do not try to retain relative screen positions.

-q name or +job-queue name
    Restricts attention to jobs with the queue prefix name. Cancel this argument by giving a single "-" sign as an argument. The queue name may be a pattern with shell-like wild cards.

    The wild card options are as described in the documentation of gbch-jlist(1).

    The queue prefix is deleted from the titles of jobs which are displayed.

-r or +network-wide
    Display jobs on all connected hosts.

-s or +keep-cursor
    If a job or variable moves on the screen, try to preserve the relative position of the cursor on the screen rather than following the job or variable.

-u user or +just-user user
    Restrict the output to jobs owned by the user specified. Cancel this argument by giving a "-" parameter.

    The user name may be a pattern with shell-like wild cards.

    The wild card options are as described in the documentation of gbch-jlist(1).

-v or +vars-screen
    Commence display in variables screen.

-Z or +no-null-queues
    In conjunction with the -q parameter, do not include jobs with no queue prefix in the list.

-z or +null-queues
    In conjunction with the -q parameter, include jobs with no queue prefix in the list.

FILES
~/.gnubatch configuration file (home directory)

.gnubatch configuration file (current directory)

btq.help message file

ENVIRONMENT

GBCH_Q
    space-separated options to override defaults.

BTQCONF
    location of alternative help file.

SEE ALSO
gbch-jlist(1), gbch-vlist(1), btsyntax(5),

DIAGNOSTICS
Various diagnostics are read and printed as required from the message file btqq.help.

Messages about key conflicts are probably because entries in your terminfo file contain duplications. Please see the GNUbatch Administration Guide.

COPYRIGHT
Copyright (c) 2009 Free Software Foundation, Inc. This is free software. You may redistribute copies of it under the terms of the GNU General Public License <http://www.gnu.org/licenses/gpl.html>. There is NO WARRANTY, to the extent permitted by law.

AUTHOR
John M Collins, Xi Software Ltd.