refgen.html

vxworks相关论文

<td align=left></tr>
</tr>

</table>

</blockQuote><h4>Notes on Markup</h4><blockQuote>
<table>
</tr>
<tr valign=top><td>
[1]
<td>The escape sequence \\ is easier to remember for backslash,
but \/ is sometimes required if the literal backslash is to appear
among other text that might be confused with escape sequences.
\/ is always safe.
<p>
</tr>
<tr valign=top><td>
[2]
<td>&lt; and &gt; must be escaped to distinguish from embedded
HTML tags.   must be escaped to distinguish from HTML character 
entities.  Single quotes must be escaped to distinguish from the refgen
automatic bolding convention.
<p>
</tr>
<tr valign=top><td>
[3]
<td>Newlines and whitespace are preserved between \ss and \se, but
formatting is not otherwise disabled.  These are useful for including
references to text variables in examples.
<p>
</tr>
<tr valign=top><td>
[4]
<td>\is and \ie mark the beginning and end of a list of items.
\i is only supported between \ls and \le.  It marks the start
of an item: that is, it forces a paragraph break, and exempts the
remainder of the line where it appears from an increased indentation
otherwise applied to paragraphs between \is and \ie.
<p>
Thus, the following:
<pre>\is
\i Boojum
A boojum is a rare
tree found in Baja
California.
\i Snark
A snark is a different
matter altogether.
\ie
</pre>

Yields output approximately like the following:
<p>
<dl>
<dt>
Boojum
<dd>
A boojum is a rare tree found in Baja California.
<p>
<dt>
Snark
<dd>
A snark is a different matter altogether.
</dl>

</tr>
<tr valign=top><td>
[5]
<td>\ml and \me delimit marker lists; they differ from itemized lists
in the output format--the marker beside \m appears on the same
line as the start of the following paragraph, rather than above.
<p>
</tr>
<tr valign=top><td>
[6]
<td>Between \ts and \te, a whole region of special syntax reigns,
though it is somewhat simplified from the original mangen's table syntax.
<p>
Three conventions are central:
<p>
(a) Tables have a heading section, and a body section; these
are delimited by a line containing only the characters <b>-</b> (hyphen), 
<b>+</b> (plus) and <b>|</b> (stile or bar), and horizontal whitespace.
<p>
(b) Cells in a table, whether in the heading or the body,
are delimited by the | character.  \| may be used to represent
the | character.
<p>
(c) Newline marks the end of a row in either heading or body.
<p>
Thus, for example, the following specifies a three-column table
with a single heading row:
<pre>\ts
Key | Name       | Meaning
----|------------|------------
| ampersand  | bitwise AND
\| | stile      | bitwise OR
#  | octothorpe | bitwise NAND
\te
</pre>

<table>
<tr valign=top>
<th align=left>Key </th><th align=left> Name       </th><th align=left> Meaning</tr>
<tr><td colspan="3"><hr></tr>
<tr valign=top>
<td align=left></td><td align=left> ampersand </td><td align=left> bitwise AND</tr>
<tr valign=top>
<td align=left>| </td><td align=left> stile </td><td align=left> bitwise OR</tr>
<tr valign=top>
<td align=left>#  </td><td align=left> octothorpe </td><td align=left> bitwise NAND</tr>
<tr valign=top>
<td align=left></tr>
</tr>

</table>

The cells need not align in the source, though it is easier to
read it (and easier to avoid errors while editing) if they do.
</table>

</blockquote><h4>PARAMETERS</h4><blockquote><p>
<table>
<tr valign=top>
<td align=left><b>-book</b> </td><td align=left> - </td><td align=left> This option allow to define which book the documented routine / library will belong to. The default value is "Wind River Systems Reference Manual"</tr>
<tr valign=top>
<td align=left><b>-chapter</b> </td><td align=left> - </td><td align=left> Related to the <b>-book</b> option, this option allows to set the documented routine / library chapter. The default value is set to "Wind River Systems Reference Libraries"</tr>
<tr valign=top>
<td align=left><b>-category</b> </td><td align=left> - </td><td align=left> Related to the <b>-book</b> option, this option allows to set the documented routine / library category. It can be used for example to differentiate routines available for different host platforms</tr>
<tr valign=top>
<td align=left><b>-config <i>configname</i></b> </td><td align=left> - </td><td align=left> Read configuration information from the file <i>configname</i> if this optional parameter is present, the default configuration is C2html</tr>
<tr valign=top>
<td align=left><b>-cpp</b> </td><td align=left> - </td><td align=left> This option specifies that the list of given files is to be treated as C++ files. A special processing is then done to recover from all the class members</tr>
<tr valign=top>
<td align=left><b>-expath <i>pathList</i></b> </td><td align=left> - </td><td align=left> Preempt <b>EXPANDPATH</b> settings recorded within files with the explicitly-supplied colon-delimited path list</tr>
<tr valign=top>
<td align=left><b>-exbase <i>basedir</i></b> </td><td align=left> - </td><td align=left> To simplify working under incomplete trees, use <i>basedir</i> rather than <b>WIND_BASE</b> as the root for expand-file searching</tr>
<tr valign=top>
<td align=left><b>-int</b> </td><td align=left> - </td><td align=left> If this optional parameter is present, format all available documentation, even if marked <b>INTERNAL</b> or <b>NOMANUAL</b>, and even for local routines</tr>
<tr valign=top>
<td align=left><b>-l <i>logFile</i></b> </td><td align=left> - </td><td align=left> specifies that <i>logFile</i> is to be used to log refgen errors, if <b>-l</b> option is not specified, the stdandard output is used</tr>
<tr valign=top>
<td align=left><b>-mg</b> </td><td align=left> - </td><td align=left> Convert from mangen markup "on the fly" (in memory, without saving the converted source file)</tr>
<tr valign=top>
<td align=left><b>-out <i>outputDirectoryName</i></b> </td><td align=left> - </td><td align=left> Save output documentation file in <i>outputDirectoryName</i></tr>
<tr valign=top>
<td align=left><b>-verbose</b> </td><td align=left> - </td><td align=left> Print reassuring messages to indicate something is happening</tr>
<tr valign=top>
<td align=left><b><i>sourceFileList</i></b> </td><td align=left> - </td><td align=left> Any other parameters are taken as names of source files from which to extract and format documentation.  </tr>
<tr valign=top>
<td align=left></tr>
</tr>

</table>

<p>
</blockquote><h4>EXAMPLE</h4><blockquote><p>
<p>
Generate HTML manual pages for a BSP <b>sysLib.c</b> file:
<p>
<pre>% cd $WIND_BASE/target/config/myBsp
% refgen -mg  -book BSP_Reference -chapter &lt;myBsp&gt; -category &lt;myBsp&gt; \
-out $WIND_BASE/vxworks/bsp/myBsp sysLib.c
</pre>

</blockquote><h4>INCLUDES</h4><blockquote><p>
<b>refLib.tcl</b>
<p>
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./refgen.html#top">refgen</a></b>, <i>VxWorks Programmer's Guide: Coding Conventions</i>, <b><a href="./htmlLink.html#top">htmlLink</a></b>, <b><a href="./htmlBook.html#top">htmlBook</a></b>, <b><a href="../../tornado-api/guitcl-unix/windHelpLib.html#top" >windHelpLib</a></b>
<p>

<p>


</body>
</html>