GBCH-ULIST(1)

NAME
gbch-ulist - list permissions for users

SYNOPSIS
gbch-ulist [ -options ] [ user ... ]

DESCRIPTION
gbch-ulist lists the permissions of users known to the GNUbatch batch scheduler system. All users are listed if no users are specified, otherwise the named users are listed. The report is similar to the main display of gbch-user(1).

The invoking user must have read admin file permission to use gbch-ulist.

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_ULIST" 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.

-D or +default-format
    Cancel the -F option and revert to the default format.

-d or +default-line
    Display an initial line giving the default options (included by default).

-F format or +format format
    Format the output according to the format string given.

-g or +group-name-sort
    Sort the list of users by the group name in ascending order, then by users within that group as primary group.

-H or +header
    Generate a header for each column of the output.

-N or +no-header
    Cancel the -H option.

-n or +numeric-user-sort
    Sort the list of users by the numeric user id (default).

-S or +no-user-lines
    Suppress the user lines. It is an error to invoke this and the -s option as well.

-s or +no-default-line
    Suppress the initial line giving the default options.

-U or +user-lines
    Display the user lines (default).

-u or +user-name-sort
    Sort the list of users by the user name.

+freeze-current
    Save all the current options in a .gnubatch file in the current directory.

+freeze-home
    Save all the current options in a .gnubatch file in the user's home directory.

Format argument.
The format string consists of a string containing the following character sequences, which are replaced by various user permission 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 "%" character.

%d  Default priority

%g  Group name

%j  Job mode

%l  Minimum priority

%m  Maximum priority

%p  Privileges

%s  Special create load level

%t  Total load level

%u  User name.

%v  Variable mode

%x  Maximum load level

The string "DEFAULT" replaces the user name in the default values line, or the group name if the user name is not printed. If the group name is not printed as well, then this will be omitted and will be indistinguishable from the rest of the output.

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

The default format is

        %u %g %d %l %m %x %t %s %p

  Privileges format
The following are output via the %p format. Note that the actual strings are read from the message file, and are the same ones as are used by gbch-uchange(1).

RA  read admin file

WA  write admin file

CR  create

SPC special create

ST  stop scheduler

Cdft
    change default

UG  or user and group modes

UO  or user and other modes

GO  or group and other modes.

"ALL" is printed if all privileges are set.

  Modes
Modes printed by the %j and %v options are as follows:

R   read permission

W   write permission

S   reveal permission

M   read mode

P   set mode

U   give away owner

V   assume owner

G   give away group

H   assume group

D   delete

K   kill (only valid for jobs)

Each section of the mode (job, group, others) is represented by the prefixes "U:", "G:" and "O:" and separated by commas.

For example:

        U:RWSMPDK,G:RWSDK,O:RS

This is exactly the same format as is expected by gbch-uchange(1) etc.

FILES
~/.gnubatch configuration file (home directory)

.gnubatch configuration file (current directory)

btrest.help message file

btufile user control file

ENVIRONMENT

GBCH_ULIST
    space-separated options to override defaults.

BTRESTCONF
    location of alternative help file.

SEE ALSO
gbch-uchange(1), gbch-user(1), btsyntax(5), gnubatch.conf(5), gnubatch.hosts(5).

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.