STScI Logo

xapropos xray


NAME · USAGE · PARAMETERS · DESCRIPTION · EXAMPLE · BUGS · SEE_ALSO

NAME

xapropos -- List all the tasks related with a given subject

USAGE

xapropos subject

PARAMETERS

subject
Subject string to search. This string should be enclosed in double quotes if the string contains any character that have special meaning for the CL.
ignore_case = yes
Ignore the case of letters in the subject string, i.e., upper and lower case are considered identical.
aproposdb = "aproposdb"
It can be either the names of database files build by mkapropos , or the name of the environment variable aproposdb , which in turn contains the names of the database files to use.
verbose = no
Print the name of the database files, as they are searched, along with the output ?.

DESCRIPTION

This task will list all IRAF tasks that have the subject string in their name, description, or the name of the package where they belong. This task uses the CTIO apropos task and resets the database list to use xray,iraf,stsdas,tables, and noao. Only the tasks that are mentioned in a package menu file will be listed. The following metacharacters are allowed inside the subject string:


	^	matches the beginning of the line
	$	matches the end of the line
	?	matches any character
	#	matches whitespace (space or tab)
	{	turn off case sensivity
	}	turn on case sensivity
	\	escape next character

ignore_case=no works in the same way as if the turn off case sensivity metacharacter were prepended to the subject string.
The user can specify the list of databases to search either explicitely, or by using the environment variable aproposdb . In the latter case this environment variable should contain the list of database files to search. Databases should be created by using the mkapropos task.
The output will contain the task name followed by the task description and the name of the package where the task belongs.

EXAMPLE

List all the task that are related to directories:


cl> xapropos directory
back          - Return to the previous directory (after a chdir) (language)
cd            - Change directory (language)
chdir         - Change directory (language)
directory     - List the files in a directory (system)
gkidir        - Directory listing of metacode file (plot)
mkdir         - Create a new directory (system)
movefiles     - Move files to a directory (system)

BUGS

The task does not restict a search to complete words.
The match at beginning of line metacharacter does not work if ignore_case=yes . The sequence "^{subject}" with ignore_case=no must be used instead.

SEE ALSO

help, match, apropos, mkapropos


Source Code · Search Form · STSDAS