[Go to CFHT Home Page] Man Pages
Back to Software Index  BORDER=0Manpage Top Level
    ckgid(1) manual page Table of Contents

Name

ckgid, errgid, helpgid, valgid - prompts for and validates a group id

Synopsis

ckgid [ -Q ] [ -W width ] [ -m ] [ -d default ] [ -h help ] [ -e error ] [ -p prompt ]
[ -k pid [ -s signal ]]

/usr/sadm/bin/errgid [ -W width ] [ -e error ]
/usr/sadm/bin/helpgid [ -W width ] [ -m ] [ -h help ]
/usr/sadm/bin/valgid input

Availability

SUNWcsu

Description

ckgid prompts a user and validates the response. It defines, among other things, a prompt message whose response should be an existing group ID, text for help and error messages, and a default value (which will be returned if the user responds with a carriage return).

All messages are limited in length to 70 characters and are formatted automatically. Any white space used in the definition (including newline) is stripped. The -W option cancels the automatic formatting. When a tilde is placed at the beginning or end of a message definition, the default text will be inserted at that point, allowing both custom text and the default text to be displayed.

If the prompt, help or error message is not defined, the default message (as defined under NOTES) will be displayed.

Three visual tool modules are linked to the ckgid command. They are errgid (which formats and displays an error message), helpgid (which formats and displays a help message), and valgid (which validates a response). These modules should be used in conjunction with FML objects. In this instance, the FML object defines the prompt.

Options

-Q
Specifies that quit will not be allowed as a valid response.
-W width
Specifies that prompt, help and error messages will be formatted to a line length of width.
-m
Displays a list of all groups when help is requested or when the user makes an error.
-d default
Defines the default value as default. The default is not validated and so does not have to meet any criteria.
-h help
Defines the help messages as help.
-e error
Defines the error message as error.
-p prompt
Defines the prompt message as prompt.
-k pid
Specifies that process ID pid is to be sent a signal if the user chooses to abort.
-s signal
Specifies that the process ID pid defined with the -k option is to be sent signal signal when quit is chosen. If no signal is specified, SIGTERM is used.
input
Input to be verified against /etc/group.

Exit Codes

  1. Successful execution
  2. EOF on input
    or negative width on -W option,
    or usage error
  3. User termination (quit)

Notes

The default prompt for ckgid is:

Enter the name of an existing group [?,q]:

The default error message is:

ERROR: Please enter one of the following
group names: [List]

If the -m option of ckgid is used, a list of valid groups is displayed here.

The default help message is:

ERROR: Please enter one of the following
group names: [List]

If the -m option of ckgid is used, a list of valid groups is displayed here.

When the quit option is chosen (and allowed), q is returned along with the return code 3. The valgid module will not produce any output. It returns zero for success and non-zero for failure.

Table of Contents