ckpath man page on SmartOS

Man page or keyword search:  
man Server   16655 pages
apropos Keyword Search (all sections)
Output format
SmartOS logo
[printable version]

CKPATH(1)							     CKPATH(1)

       ckpath,	errpath,  helppath,  valpath  -	 display  a prompt; verify and
       return a pathname

       ckpath [-Q] [-W width] [-a | l] [-b | c | f | y]
	    [-n [o | z]] [-rtwx] [-d default] [-h help]
	    [-e error] [-p prompt] [-k pid [-s signal]]

       /usr/sadm/bin/errpath [-W width] [-a | l] [-b | c | f | y]
	    [-n [o | z]] [-rtwx] [-e error]

       /usr/sadm/bin/helppath [-W width] [-a | l] [-b | c | f | y]
	    [-n [o | z]] [-rtwx] [-h help]

       /usr/sadm/bin/valpath [-a | l] [-b | c | f | y]
	    [-n [o | z]] [-rtwx] input

       The ckpath utility prompts  a  user  and	 validates  the	 response.  It
       defines,	 among other things, a prompt message whose response should be
       a pathname, text for help and  error  messages,	and  a	default	 value
       (which is returned if the user responds with a RETURN).

       The  pathname  must  obey  the criteria specified by the first group of
       options. If no criteria is defined, the pathname must be for  a	normal
       file that does not yet exist. If neither -a (absolute) or -l (relative)
       is given, then either is assumed to be valid.

       All messages are limited in length to 79 characters and	are  formatted
       automatically. Tabs and newlines are removed after a single white space
       character in a message definition, but spaces are not removed.  When  a
       tilde  is  placed  at the beginning or end of a message definition, the
       default text is 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 mes‐
       sage (as defined under EXAMPLES) is displayed.

       Three visual tool modules are linked to the ckpath  command.  They  are
       errpath	(which	formats	 and displays an error message on the standard
       output), helppath (which formats and displays a	help  message  on  the
       standard output), and valpath (which validates a response).

       The following options are supported:

		     Pathname must be an absolute path.

		     Pathname must be a block special file.

		     Pathname must be a character special file.

       -d default
		     Defines  the default value as default. The default is not
		     validated and so does not have to meet any criteria.

       -e error
		     Defines the error message as  error.

		     Pathname must be a regular file.

       -h help
		     Defines the help message as  help.

       -k pid
		     Specifies that process ID pid is to be sent a  signal  if
		     the user chooses to quit.

		     Pathname must be a relative path.

		     Pathname must not exist (must be new).

		     Pathname must exist (must be old).

       -p prompt
		     Defines the prompt message as prompt.

		     Specifies that quit is not allowed as a valid response.

		     Pathname must be readable.

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

		     Pathname  must be creatable (touchable). Pathname will be
		     created if it does not already exist.

		     Pathname must be writable.

       -W width
		     Specify that prompt, help and error messages be formatted
		     to a line length of width.

		     Pathname must be executable.

		     Pathname must be a directory.

		     Pathname must have a file having a size greater than zero

       The following operand is supported:

		Input to be verified against validation options.

       The text of the default messages for ckpath depends upon	 the  criteria
       options that have been used.

       Example 1 Default prompt

       An example default prompt for ckpath (using the -a option) is:

	 example% ckpath -a
	 Enter an absolute pathname [?,q]

       Example 2 Default error message

       An example default error message (using the -a option) is:

	 example% /usr/sadm/bin/errpath -a
	 ERROR: A pathname is a filename, optionally preceded by parent
		The pathname you enter: - must begin with a slash (/)

       Example 3 Default help message

       An example default help message (using the -a option) is:

	 example% /usr/sadm/bin/helppath -a
	 A pathname is a filename, optionally preceded by parent directories.
	 The pathname you enter: - must begin with a slash (/)

       Example 4 The quit option

       When  the quit option is chosen (and allowed), q is returned along with
       the return code 3. Quit input gets a trailing newline.

       Example 5 Using the valpath module

       The valpath module will produce a usage message on stderr. It returns 0
       for success and non-zero for failure.

	 example% /usr/sadm/bin/valpath
	 usage: valpath [-[a|l][b|c|f|y][n|[o|z]]rtwx] input

       The following exit values are returned:

	    Successful execution.

	    EOF on input, or negative width on -W option, or usage error.

	    Mutually exclusive options.

	    User termination (quit).

	    Mutually exclusive options.

       signal.h(3HEAD), attributes(5)

				  Nov 4, 2005			     CKPATH(1)

List of man pages available for SmartOS

Copyright (c) for man pages and the logo by the respective OS vendor.

For those who want to learn more, the polarhome community provides shell access and support.

[legal] [privacy] [GNU] [policy] [cookies] [netiquette] [sponsors] [FAQ]
Polarhome, production since 1999.
Member of Polarhome portal.
Based on Fawad Halim's script.
Vote for polarhome
Free Shell Accounts :: the biggest list on the net