Tornado

5
Shell
you. If there are multiple options, it prints them for you and then reprints your
entry. For example, entering an ambiguous request generates the following result:
-> /usr/Tor [CTRL+D]
Tornado/ TorClass/
-> /usr/Tor
You can add one or more letters and then type CTRL+D again until the path or
symbol is complete.
5
Synopsis Printing
Once you have typed the complete function name, typing CTRL+D again prints the
function synopsis and then reprints the function name ready for your input:
-> _taskIdDefault [CTRL+D]
taskIdDefault() - set the default task ID (WindSh)
int taskIdDefault
(
int tid /* user-supplied task ID; if 0, return default */
)
-> _taskIdDefault
If the routine exists on both host and target, the WindSh synopsis is printed. To
print the target synopsis of a function add the meta character @ before the function
name.
You can extend the synopsis printing function to include your own routines. To do
this, follow these steps:
1. Create the files that include the new routines following WRS Coding
Conventions. (See VxWorks Programmer’s Guide: Coding Conventions.)
2. Include these files in your project. (See Creating, Adding, and Removing
Application Files, p.102.)
3. Add the file names to the DOC_FILES macro in your makefile.
4. Go to the top of your project tree and run “make synopsis”:
-> cd $WIND_BASE/target/src/projectX
-> make synopsis
This adds a file projectX to the host/resource/synopsis directory.
153