jdescription, jtool description

jdescription is a command-line tool used to update a Job's description.

If you have run jtool install, you can run it with the command jdescription. You can also run it with the command jtool description.

Note: For installation instructions, see jtool.

Note: This tool cannot be used outside of Job context. The -j or -job-context parameter is implied.

Note: The update of the description is performed asynchronously, so there is no guarantee that the operation has finished when the tool returns.

Syntax

Argument	Default	Description
-h, -?, -help		Shows help.
-l <loglevel>	${JCS_LOGLEVEL:-info}	Sets the logging level. Defaults to the environment variable ${JCS_LOGLEVEL} or info when the environment variable is not set.
-f <logfile>	${JCS_LOGFILE:-stderr}	Log to file instead of stderr; defaults to environment variable ${JCS_LOGFILE} or stderr when the environment variable is not set.
-j, -job-context		Gets the environment from the Job context.
-stderr		Sends the description to stderr as well as Job description.
-stdout		Sends the description to stdout as well as Job description.
-log		Sends the description to stdout or stderr in standard log format at log level info.
-log-with-level <loglevel>	info	Sends the description to stdout or stderr in standard log format at the given log level.
<description>		New description for the Job.

Example

The following Unix shell example shows how to update a Job's description as the Job executes.