📄 docguide.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN"><html><head><link rel="STYLESHEET" type="text/css" href="wrs.css"><title> Documentation Guide </title></head><body bgcolor="FFFFFF"><p class="navbar" align="right"><a href="index.html"><img border="0" alt="[Contents]" src="icons/contents.gif"></a><a href="GuideIX.html"><img border="0" alt="[Index]" src="icons/index.gif"></a><img border="0" src="icons/blank.gif"><a href="Title.html"><img border="0" alt="[Prev]" src="icons/prev.gif"></a><a href="c-overview.html"><img border="0" alt="[Next]" src="icons/next.gif"></a></p><font face="Helvetica, sans-serif" class="sans"><h1 class="H1name" align="right"><i><a name="85132"> Documentation Guide</a></i></h1></font><dl class="margin"></dl><h4 class="Subtitle" align="right"><font face="Helvetica, sans-serif" size="-1" class="sans"><i></i></font></h4><h4 class="Subtitle" align="right"><font face="Helvetica, sans-serif" size="-1" class="sans"><i></i></font></h4><font face="Helvetica, sans-serif" class="sans"><h4 class="H4"><i><a name="85135">Overview</a></i></h4></font><dl class="margin"><dl class="margin"><dd><p class="Body"><a name="85137"> </a>Documentation for Tornado falls into the following general categories:</p><b class="BulletHead-run"><li type="disc"><a name="85138"> </a><font face="Helvetica, sans-serif" size="-1" class="sans">Release Information. </font></b><dl class="margin"><dd><div class="Indent"><a name="85139"> </a>The <i class="title">Tornado Release Notes</i> describe changes in the current release, and supported platforms. The files <b class="file">README.TXT</b> and <b class="symbol_UC">README.HTML</b> at the root of the CD-ROM, contain last-minute information about the current Tornado release. In addition, the <i class="title">Release Bulletin</i> at URL <a href="http://www.wrs.com/corporate/support/prodbullet/T2.0"><b class="symbol_lc">http://www.wrs.com/corporate/support/prodbullet/T2.0</a></b> contains several text files that contain pertinent information. <b class="file">PROBLEMS.TXT </b>lists known problems for this release and <b class="file">FIXED.TXT </b>lists problems fixed since the last release.</div><br></dl><b class="BulletHead-run"><li type="disc"><a name="85140"> </a><font face="Helvetica, sans-serif" size="-1" class="sans">Tornado Host-Tool Documentation. </font></b><dl class="margin"><dd><div class="Indent"><a name="85142"> </a>These manuals focus principally on the interactive cross-development tools in Tornado. The <i class="title">Tornado Getting Started</i> <i class="title">Guide</i> provides instructions on installing Tornado, and a tutorial introduction. The <i class="title"><a href="./index.html">Tornado User's Guide</a></i> (this manual) describes the Tornado development tools and how they are used with the target system. The <i class="title">Tornado API Programmer's Guide</i> and <i class="title">the Tornado API Reference</i> describe the interfaces available to extend this development environment.</div><br></dl><b class="BulletHead-run"><li type="disc"><a name="85143"> </a><font face="Helvetica, sans-serif" size="-1" class="sans">VxWorks Target-OS Documentation. </font></b><dl class="margin"><dd><div class="Indent"><a name="85145"> </a>These manuals describe the VxWorks operating system and associated run-time facilities. The <i class="title">VxWorks Programmer's Guide</i> is a comprehensive introduction to VxWorks, with the exception of networking, which is covered separately in the <i class="title">VxWorks Network Programmer's Guide</i>. The <i class="title">VxWorks Reference Manual</i> contains reference entries for all VxWorks modules and subroutines.</div><br></dl><b class="BulletHead-run"><li type="disc"><a name="85146"> </a><font face="Helvetica, sans-serif" size="-1" class="sans">Online Documentation. </font></b><dl class="margin"><dd><div class="Indent"><a name="85147"> </a>All Tornado manuals are available online in HTML format, including Board Support Package (BSP)<sup><a href="#foot"><b class="FootnoteMarker">1</b></a></sup> setup information for VxWorks on that target. The Tornado IDE also includes context-sensitive online help. </div><br></dl><b class="BulletHead-run"><li type="disc"><a name="85151"> </a><font face="Helvetica, sans-serif" size="-1" class="sans">Free Software Foundation Documentation. </font></b><dl class="margin"><dd><div class="Indent"><a name="85152"> </a>These supporting manuals are redistributed by Wind River Systems to provide auxiliary reference information on the compiler, debugger, and associated utilities supplied with Tornado. The <i class="title">GNU ToolKit User's Guide</i> contains detailed information about the compiler, and its supporting tools. <i class="title">GNU Make</i> describes makefiles and <b class="command">make</b> usage. <i class="title">Debugging with GDB</i> describes the command-line interface to the Tornado debugger. </div><br></dl></dl></dl><font face="Helvetica, sans-serif" class="sans"><h4 class="H4"><i><a name="85153">Release Information</a></i></h4></font><dl class="margin"><dd><font face="Helvetica, sans-serif" size="-1" class="sans"><h5 class="HU"><i><a name="85154">Tornado Release Notes</a></i></h5></font><dl class="margin"><dd><p class="Body"><a name="85156"> </a>The <i class="title">Tornado Release Notes</i> is a brief document primarily meant for developers who are already using Tornado and VxWorks. It contains the latest list of supported hosts and targets, as well as information on compatibility with older releases and an outline of new features.</p></dl><dd><font face="Helvetica, sans-serif" size="-1" class="sans"><h5 class="HU"><i><a name="85157">Readme File</a></i></h5></font><dl class="margin"><dd><p class="Body"><a name="85158"> </a>The <b class="file">README.TXT</b> and <b class="file">README.HTML </b>files, found at the root of the CD-ROM, contain information about the current Tornado release that was developed after the <i class="title">Tornado Release Notes</i> were completed.</p></dl><dd><font face="Helvetica, sans-serif" size="-1" class="sans"><h5 class="HU"><i><a name="85159">Problem Lists</a></i></h5></font><dl class="margin"><dd><p class="Body"><a name="85849"> </a><b class="symbol_lc"><a href="http://www.wrs.com/corporate/support/prodbullet/T2.0">http://www.wrs.com/corporate/support/prodbullet/T2.0</a></b> contains two files of problem lists, <b class="file">FIXED.TXT </b>and <b class="file">PROBLEMS.TXT</b>. </p></dl><dl class="margin"><dd><div class="Item"><a name="85850"> </a><b class="file">FIXED.TXT</b> </div><dl class="margin"><dd><div class="Indent"><a name="85163"> </a>For each WRS product on the CD-ROM, describes the problems fixed since that product's previous release.</div><br></dl><dd><div class="Item"><a name="85164"> </a><b class="file">PROBLEMS.TXT</b></div><dl class="margin"><dd><div class="Indent"><a name="85165"> </a>Describes all known problems with WRS products on the CD-ROM at the time of release.</div><br></dl></dl></dl><font face="Helvetica, sans-serif" class="sans"><h4 class="H4"><i><a name="85166">Tornado Host-Tool Documentation</a></i></h4></font><dl class="margin"><dd><font face="Helvetica, sans-serif" size="-1" class="sans"><h5 class="HU"><i><a name="85167">Tornado Getting Started Guide</a></i></h5></font><dl class="margin"><dd><p class="Body"><a name="85168"> </a>The <i class="title">Tornado Getting Started</i> <i class="title">Guide</i> provides instructions on installing Tornado (and other Tornado products), as well as a tutorial introduction to Tornado.</p></dl><dd><font face="Helvetica, sans-serif" size="-1" class="sans"><h5 class="HU"><i><a name="85169">Tornado User's Guide </a></i></h5></font><dl class="margin"><dd><p class="Body"><a name="85170"> </a>This manual, the <i class="title"><a href="./index.html">Tornado User's Guide</a></i>, is the central document for the Tornado IDE. It includes:</p></dl><dl class="margin"><p class="listspace"><ul class="Bullet" type="disc"><li><a name="85171"> </a>A global overview of Tornado and its capabilities. </li></ul></p><p class="listspace"><ul class="Bullet" type="disc"><li><a name="85172"> </a>Instructions on how to configure your environment and set up communications with a target system.</li></ul></p><p class="listspace"><ul class="Bullet" type="disc"><li><a name="85173"> </a>Chapters on the Tornado development environment and its major interactive features-- editor, project facility, target server management, shell, browser, and the debugger.</li></ul></p><p class="listspace"><ul class="Bullet" type="disc"><li><a name="85174"> </a>A chapter on customizing Tornado.</li></ul></p><p class="listspace"><ul class="Bullet" type="disc"><li><a name="85175"> </a>Appendices on Tornado directories and files, the use of Tcl (Tool Command Language) in Tornado, and reference information for host tools. </li></ul></p></dl><dd><font face="Helvetica, sans-serif" size="-1" class="sans"><h5 class="HU"><i><a name="85176">Tornado API Guide </a></i></h5></font><dl class="margin"><dd><p class="Body"><a name="85178"> </a>The <i class="title">Tornado API Programmer's Guide</i> is for developers who wish to extend the Tornado development environment. It discusses the Tornado architecture from the perspective of software application program interfaces (APIs) and protocols, and describes how to extend and modify the Tornado tools and integrate them with custom software. It contains descriptive information about the run-time target agent; on its host-system counterpart, the target server; and on the WTX protocol used by the Tornado tools to communicate with the target server.</p></dl><dd><font face="Helvetica, sans-serif" size="-1" class="sans"><h5 class="HU"><i><a name="85179">Tornado API Reference </a></i></h5></font><dl class="margin"><dd><p class="Body"><a name="85180"> </a>The <i class="title">Tornado API Reference</i> is the reference companion to the <i class="title">Tornado API Programmer's Guide.</i> It is available online only (in HTML format).</p></dl></dl><font face="Helvetica, sans-serif" class="sans"><h4 class="H4"><i><a name="85181">VxWorks Target-OS Documentation</a></i></h4></font><dl class="margin"><dd><font face="Helvetica, sans-serif" size="-1" class="sans"><h5 class="HU"><i><a name="85182">VxWorks Programmer's Guide </a></i></h5></font><dl class="margin"><dd><p class="Body"><a name="85184"> </a>The <i class="title">VxWorks Programmer's Guide</i> describes the VxWorks operating system and associated run-time facilities. The <i class="title">Programmer's Guide</i> is the best starting point to learn about VxWorks from a problem-solving perspective, because it is organized by the function of VxWorks components. It includes the following topics:</p></dl><dl class="margin"><p class="listspace"><ul class="Bullet" type="disc"><li><a name="85185"> </a>Basic OS: the fundamentals of the VxWorks kernel and run-time environment.</li></ul></p><p class="listspace"><ul class="Bullet" type="disc"><li><a name="85186"> </a>I/O System: the VxWorks I/O system and the device drivers that underlie it.</li></ul></p><p class="listspace"><ul class="Bullet" type="disc"><li><a name="85187"> </a>Local File Systems: VxWorks file systems, including a DOS-compatible file system, the "raw" file system, and the RT-11 file system.</li></ul></p><p class="listspace"><ul class="Bullet" type="disc"><li><a name="85188"> </a>Optional Products: VxWorks optional products VxMP (shared memory objects), VxVMI (virtual memory interface), and the Wind Foundation Classes (C++ libraries). </li></ul></p><p class="listspace"><ul class="Bullet" type="disc"><li><a name="85189"> </a>Configuration and build: how to configure VxWorks for your application by editing configuration files and how to build it from the command line. (The <i class="title">Tornado User's Guide: Projects </i>discusses the automated features provided by the project facility GUI.)</li></ul></p><p class="listspace"><ul class="Bullet" type="disc"><li><a name="85190"> </a>Architecture Appendices: special considerations for each supported target-CPU architecture.</li></ul></p></dl><dd><font face="Helvetica, sans-serif" size="-1" class="sans"><h5 class="HU"><i><a name="85191">VxWorks Network Programmer's Guide </a></i></h5></font><dl class="margin"><dd><p class="Body"><a name="85193"> </a>The <i class="title">VxWorks Network Programmer's Guide</i> describes the networking facilities available with VxWorks. It includes the following topics:</p></dl><dl class="margin"><p class="listspace"><ul class="Bullet" type="disc"><li><a name="85194"> </a>Configuring the network stack.</li></ul></p><p class="listspace"><ul class="Bullet" type="disc"><li><a name="85195"> </a>Booting over the network.</li></ul></p><p class="listspace"><ul class="Bullet" type="disc"><li><a name="85196"> </a>Using the MUX interface.</li></ul></p><p class="listspace"><ul class="Bullet" type="disc"><li><a name="85197"> </a>Upgrading 4.3 BSD drivers.</li></ul></p></dl><dd><font face="Helvetica, sans-serif" size="-1" class="sans"><h5 class="HU"><i><a name="85199">VxWorks Reference Manual </a></i></h5></font><dl class="margin"><dd><p class="Body"><a name="85200"> </a>The <i class="title">VxWorks Reference Manual</i> consists of reference entries divided into the following sections:</p><b class="BulletHead-run"><li type="disc"><a name="85201"> </a><font face="Helvetica, sans-serif" size="-1" class="sans">Libraries (1). </font></b><dl class="margin"><dd><div class="Indent"><a name="85202"> </a>Reference descriptions of all VxWorks libraries that apply to all targets. Each entry lists the routines found in a given library, including a one-line synopsis of each, along with a general description of their use. This section also contains entries for the serial, Ethernet, and SCSI drivers available with VxWorks Board Support Packages (BSPs).</div><br></dl><b class="BulletHead-run"><li type="disc"><a name="85203"> </a><font face="Helvetica, sans-serif" size="-1" class="sans">Subroutines (2). </font></b><dl class="margin"><dd><div class="Indent"><a name="85204"> </a>Reference descriptions for each of the subroutines found in the libraries in <i class="title">Libraries (1)</i>. </div><br></dl></dl></dl><font face="Helvetica, sans-serif" class="sans"><h4 class="H4"><i><a name="85208">Online Documentation</a></i></h4></font><dl class="margin"><dd><font face="Helvetica, sans-serif" size="-1" class="sans"><h5 class="HU"><i><a name="85209">Online Manuals</a></i></h5></font><dl class="margin"><dd><p class="Body"><a name="85473"> </a>The Tornado software suite includes a hypertext collection of all Tornado and VxWorks manuals (in HTML format). You can open the online manuals from the <b class="guiLabel"><font face="Helvetica, sans-serif" size="-1" class="sans">Help</font></b>><b class="guiLabel"><font face="Helvetica, sans-serif" size="-1" class="sans">Manuals Contents </font></b>menu in the Tornado IDE. A search tool is available from the <b class="guiLabel"><font face="Helvetica, sans-serif" size="-1" class="sans">Help</font></b>><b class="guiLabel"><font face="Helvetica, sans-serif" size="-1" class="sans">Manuals Index</font></b> menu option.</p></dl><dd><font face="Helvetica, sans-serif" size="-1" class="sans"><h5 class="HU"><i><a name="85651">Board Support Package (BSP) Documentation</a></i></h5></font><dl class="margin"><dd><p class="Body"><a name="85652"> </a>The online manuals contain reference entries for the libraries and subroutines specific to each BSP. These entries include a target information entry, which covers such topics as: what drivers the board uses; how the board should be jumpered for use with VxWorks; the board layout, indicating the location of board jumpers (if applicable) and ROM sockets; and any other board-specific considerations. See <b class="guiLabel"><font face="Helvetica, sans-serif" size="-1" class="sans">Help</font></b>><b class="guiLabel"><font face="Helvetica, sans-serif" size="-1" class="sans">Manuals Contents</font></b>><b class="guiLabel"><font face="Helvetica, sans-serif" size="-1" class="sans">BSP Reference</font></b> (<b class="file">wind/docs/BSP_Reference.html</b>).</p><dd><p class="Body"><a name="85653"> </a>Check with your sales representative for a current list of supported BSPs.</p></dl><dd><font face="Helvetica, sans-serif" size="-1" class="sans"><h5 class="HU"><i><a name="85475">Context-Sensitive Help</a></i></h5></font><dl class="margin"><dd><p class="Body"><a name="85214"> </a>Help buttons in every Tornado dialog box (and the <b class="guiLabel"><font face="Helvetica, sans-serif" size="-1" class="sans">Help</font></b> menu in the menu bar) provide information on the Tornado component you are currently executing.</p></dl></dl><font face="Helvetica, sans-serif" class="sans"><h4 class="H4"><i><a name="85218">Free Software Foundation Documentation</a></i></h4></font><dl class="margin"><dl class="margin"><dd><p class="Body"><a name="85666"> </a>These manuals are Free Software Foundation (FSF) manuals formatted and edited by Cygnus Support. They have been further edited to remove information that is not relevant to Wind River Systems' products, and assembled into a the three volumes, by Wind River Systems.</p></dl></dl><dl class="margin"><dd><font face="Helvetica, sans-serif" size="-1" class="sans"><h5 class="HU"><i><a name="85219">GNU ToolKit User's Guide </a></i></h5></font><dl class="margin"><dd><p class="Body"><a name="85221"> </a>The <i class="title">Gnu ToolKit User's Guide</i> is a convenient collection of the manuals for the GNU C and C++ compiler and its supporting tools: the C preprocessor, assembler, static linker and binary utilities. </p></dl><dd><font face="Helvetica, sans-serif" size="-1" class="sans"><h5 class="HU"><i><a name="85594">GNU Make</a></i></h5></font><dl class="margin"><dd><p class="Body"><a name="85595"> </a>The Free Software Foundation's manual for the <b class="command">make</b> utility.</p></dl><dd><font face="Helvetica, sans-serif" size="-1" class="sans"><h5 class="HU"><i><a name="85222">Debugging with GDB </a></i></h5></font><dl class="margin"><dd><p class="Body"><a name="85223"> </a><i class="title">Debugging with GDB</i> is the FSF manual for the command-line interface to the GNU debugger GDB, which is the foundation for the Tornado graphical debugger, CrossWind.</p></dl></dl><dl class="margin"><dd><p class="table" callout><table border="0" cellpadding="0" cellspacing="0"><tr valign="top"><td valign="top" width="40"><br><img border="0" alt="*" src="icons/note.gif"></td><td><hr><div class="CalloutCell"><a name="85734"><b class="symbol_UC"><font face="Helvetica, sans-serif" size="-1" class="sans">NOTE: </font></b></a>The FSF develops software under UNIX, and examples in their manuals reflect this. Nevertheless, the GNU tools operate reliably under Windows.</div></td></tr><tr valign="top"><td></td><td><hr></td></tr><tr valign="middle"><td colspan="20"></td></tr></table></p callout></dl><font face="Helvetica, sans-serif" class="sans"><h4 class="H4"><i><a name="85234">Documentation Conventions</a></i></h4></font><dl class="margin">⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -