gbch-vlist - list B<GNUbatch> variables

# NAME

gbch-vlist - list GNUbatch variables

# SYNOPSIS

gbch-vlist [ -options ] [ variable names ]

# DESCRIPTION

gbch-vlist is a program to display GNUbatch variables on the standard output. It can be used in both shell scripts and other programs. Each line of the output corresponds to a single variable, and by default the output is generally similar to the default format of the variables screen of the gbch-q(1) command. The first field on each line is the variable name prefixed by a machine name and colon thus:

            macha:v1
            machb:xyz

if the variable is on a remote machine. This is the required format of the variable name which should be passed to gbch-var(1) and other shell interface commands.

An example of the output of gbch-vlist is as follows:

            CLOAD         0                # Current value of load level
            Dell:CLOAD    0         Export # Current value of load level
            arnie:CLOAD   1000      Export # Current value of load level
            LOADLEVEL     20000            # Maximum value of load level
            LOGJOBS                        # File to save job record in
            LOGVARS                        # File to save variable record in
            MACHINE       sisko            # Name of current host
            Dell:Neterr   0         Export # Exit code from polling
            STARTLIM      5                # Number of jobs to start at once
            STARTWAIT     30               # Wait time in seconds for job start
            Dell:Two      2         Export #
            bar           1                #
            foo           123       Export # Testing

If the user has reveal but not read permission on a variable, the name only is displayed.

Various options allow the user to control the output in various ways as described below. The user can limit the output to specific variables by giving the variable names as arguments following the options.

# 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_VLIST` and the environment variable to specify the help file is `BTRESTCONF`.

-? or +explain

  causes a summary of the other options to be displayed without taking further action.

-B or +bypass-modes

  Disregard all modes etc and print full details. This is provided for dump/restore scripts. It is only available to users with Write Admin File permission, otherwise it is silently ignored. This option is now deprecated as gbch-cvlist(8) is now provided for the purpose for which this option was implemented.

-D or +default-format

  Revert to the default display format, cancelling the -F option.

-F string or +format string

  Change the display format to string as defined below.

-g group or +just-group group

  Restrict the output to variables owned by the group specified. The group name may be a pattern with shell-like wild cards. To cancel this argument, give a single - sign as a group name.

-H or +header

  generate a header for each column of output.

-L or +local-only

  list only variables local to the current host.

-N or +no-header

  cancel the -H option.

-R or +include-remotes

  list all variables, including those on connected remote hosts.

-u user +just-user user

  Restrict the output to variables owned by the user specified. The user name may be a pattern with shell-like wild cards.

  To cancel this argument, give a single - sign as a user name.

+freeze-current

  Save all the current options in a .gnubatch file in the current directory with keyword `GBCH_VLIST`. There is no output if this is specified, the options are just saved.

+freeze-home

  Save all the current options in a .gnubatch file in the user's home directory with keyword `GBCH_VLIST`. There is no output if this is specified, the options are just saved.

## Format codes

The format string consists of a string containing the following character sequences, which are replaced by the following variable parameters. The string may contain various other printing characters or spaces as required.

Each column is padded on the right to the length of the longest entry.

If a header is requested, the appropriate abbreviation is obtained from the message file and inserted.

%%

  Insert a single `%`.

%C

  Comment field.

%E

  `Export` if variable is exported

%G

  Group owner of variable.

%K

  `Cluster` if the variable is marked clustered

%M

  Mode as a string of letters with `U:`, `G:` or `O:` prefixes as in `U:RWSMPUVGHD,G:RSMG,O:SM`.

%N

  Name

%U

  User name of owner.

%V

  Value

Note that the various strings such as `export` etc are read from the message file also, so it is possible to modify them as required by the user.

Only the name, user, group, `export` and `cluster` fields will be non-blank if the user may not read the relevant variable. The mode field will be blank if the user cannot read the modes.

The default format is

            %N %V %E # %C

# FILES

~/.gnubatch configuration file (home directory)

.gnubatch configuration file (current directory)

btrest.help message file

# ENVIRONMENT

GBCH_VLIST

  space-separated options to override defaults.

BTRESTCONF

  location of alternative help file.

# SEE ALSO

gbch-jlist(1), gbch-q(1), gbch-var(1), btsyntax(5), gnubatch.conf(5), (5), gbch-cjlist(8), gbch-cvlist(8).

# DIAGNOSTICS

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

# 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.