Syntax:
Unix:
listnote -model model_name [-config config_file]
[-output file_name] [-errorfile file_name]
[-prefix [pattern...] | -suffix [pattern...]
| -pattern [pattern...]]...
[-insensitive] [-allmatch | -somematch | -nonematch]
[-twk_images | -unmatched | -normal] [-width num_chars]
[-help [help_dir] | -syntax [help_dir] | -version]
[-options] [-arg_input path_name] [-noheader]
[-quiet] [-ask] [-unix] [-vms] [-os2]
VMS:
listnote /model=model_name [/config=config_file]
[/output=file_name] [/errorfile=file_name]
[/prefix=(pattern,...) | /suffix=(pattern,...)
| /pattern=(pattern,...)]...
[/insensitive] [/allmatch | /somematch | /nonematch]
[/twk_images | /unmatched | /normal] [/width=num_chars]
[/help [=help_dir] | /syntax [=help_dir] | /version]
[/options] [/arg_input=path_name] [/noheader]
[/quiet] [/ask] [/unix] [/vms] [/os2]
OS/2:
listnote /model:model_name [/config:config_file]
[/output:file_name] [/errorfile:file_name]
[/prefix:(pattern,...) | /suffix:(pattern,...)
| /pattern:(pattern,...)]...
[/insensitive] [/allmatch | /somematch | /nonematch]
[/twk_images | /unmatched | /normal] [/width:num_chars]
[/help [:help_dir] | /syntax [:help_dir] | /version]
[/options] [/arg_input:path_name] [/noheader]
[/quiet] [/ask] [/unix] [/vms] [/os2]
Program Description:
The listnote command is a global note facility that lists
the text and picture notes within a model. You can list notes that
match predefined search patterns or list all of the notes within a
model. There is also an option to list all objects that do not
have a matching note.
Options:
model <model_name> Specifies a model name.
config <config_file> Specifies a Teamwork configuration file.
output <output_file> Specifies the file name of the output
report (default: standard output).
errorfile <error_file> Specifies an error file
(default: standard error).
prefix <pattern> Specifies a pattern that must start
the note title.
pattern <pattern> Specifies a pattern that must be in
the note title.
suffix <pattern> Specifies a pattern that must
end the note title.
insensitive Specifies that pattern comparisons
should be case-insensitive.
allmatch Specifies that note titles must match all
the patterns.
somematch Specifies that note titles must match
one pattern (default).
nonematch Specifies that note titles must not match
any of the patterns.
twk_images Specifies that the output should be in
twk_images input format.
unmatched Specifies that the output should include
generation numbers.
normal Specifies that output should be in
normal format (default).
width Specifies the width of the output report.
(default: 132)
help <help_dir> Shows the full help screen (this information)
and quits. The optional argument
specifies the directory containing
the help file.
syntax <help_dir> Shows the short help screen (syntax lines
only) and quits. The optional argument
specifies the directory containing
the help file.
version Shows the program header with the version
and quits.
options Shows the command line options chosen
before program execution.
arg_input <path_name> Indicates more command line options are
in the file 'filename'.
noheader Suppresses display of the program header
before program execution.
quiet Suppresses status messages during
program execution.
ask Prompts the user for the entry of command
line options not provided.
unix Allows entry of options in Unix format
(-example_option).
vms Allows entry of options in VMS format
(/example_option).
os2 Allows entry of options in OS2 format
(/example_option).
Examples (Unix format):
1) List all notes in a model
listnote -model mymodel
2) Print all notes in a model
listnote -twk_images -model mymodel | twk_images -postscript > outputfile
3) List all notes beginning with RQT or rqt.
listnote -model mymodel -prefix RQT -insensitive
4) List all notes beginning with RQT that include the word elevator.
listnote -model mymodel -prefix RQT -pattern elevator
or
listnote -model mymodel -pattern "^RQT*elevator"