Files
doc-exports/docs/dws/tool/dws_16_0003.html
luhuayi a5e3903f6b DWS TG 910.211 version
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com>
Co-authored-by: luhuayi <luhuayi@huawei.com>
Co-committed-by: luhuayi <luhuayi@huawei.com>
2025-04-23 13:53:01 +00:00

114 lines
12 KiB
HTML

<a name="EN-US_TOPIC_0000001860318473"></a><a name="EN-US_TOPIC_0000001860318473"></a>
<h1 class="topictitle1">Document Conventions</h1>
<div id="body32001227"><p id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_p55822749">This section describes the content, symbol, and command conventions of this document.</p>
<div class="section" id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_section4249163764819"><h4 class="sectiontitle">Symbol Convention</h4><p class="msonormal" id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_p3150302416410">Symbols that may be found in this document are defined as follows:</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_table2622507016410" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_row1530720816410"><th align="left" class="cellrowborder" valign="top" width="20.580000000000002%" id="mcps1.3.2.3.1.3.1.1"><p id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_p6450074116410"><strong id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_b89632102487">Symbol</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="79.42%" id="mcps1.3.2.3.1.3.1.2"><p id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_p5435366816410"><strong id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_b5941558116410">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_row1372280416410"><td class="cellrowborder" valign="top" width="20.580000000000002%" headers="mcps1.3.2.3.1.3.1.1 "><p id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_p3734547016410"><span><img class="imgResize" id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_image2670064316410" height="39.900000000000006" src="figure/en-us_image_0000001382373772.png" width="86.45" title="Click to enlarge"></span></p>
</td>
<td class="cellrowborder" valign="top" width="79.42%" headers="mcps1.3.2.3.1.3.1.2 "><p id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_p1757432116410">Indicates an imminently hazardous situation which, if not avoided, will result in serious injury or death.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_row466863216410"><td class="cellrowborder" valign="top" width="20.580000000000002%" headers="mcps1.3.2.3.1.3.1.1 "><p id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_p1432579516410"><span><img class="imgResize" id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_image4895582316410" height="39.900000000000006" src="figure/en-us_image_0000001432533957.png" width="86.45" title="Click to enlarge"></span></p>
</td>
<td class="cellrowborder" valign="top" width="79.42%" headers="mcps1.3.2.3.1.3.1.2 "><p id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_p959197916410">Indicates a potentially hazardous situation which, if not avoided, will result in death or serious injury.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_row123863216410"><td class="cellrowborder" valign="top" width="20.580000000000002%" headers="mcps1.3.2.3.1.3.1.1 "><p id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_p1232579516410"><span><img class="imgResize" id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_image1235582316410" height="39.900000000000006" src="figure/en-us_image_0000001432453549.png" width="86.45" title="Click to enlarge"></span></p>
</td>
<td class="cellrowborder" valign="top" width="79.42%" headers="mcps1.3.2.3.1.3.1.2 "><p id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_p123197916410">Indicates a potentially hazardous situation which, if not avoided, may result in minor or moderate injury.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_row5786682116410"><td class="cellrowborder" valign="top" width="20.580000000000002%" headers="mcps1.3.2.3.1.3.1.1 "><p id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_p2204984716410"><span><img class="imgResize" id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_image4504446716410" height="39.900000000000006" src="figure/en-us_image_0000001432333769.png" width="86.45" title="Click to enlarge"></span></p>
</td>
<td class="cellrowborder" valign="top" width="79.42%" headers="mcps1.3.2.3.1.3.1.2 "><p id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_p4388861916410">Indicates a potentially hazardous situation which, if not avoided, could result in equipment damage, data loss, performance deterioration, or unanticipated results. </p>
<p id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_p1238861916410">NOTICE is used to address practices not related to personal injury.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_row2856923116410"><td class="cellrowborder" valign="top" width="20.580000000000002%" headers="mcps1.3.2.3.1.3.1.1 "><p id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_p5555360116410"><span><img class="imgResize" id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_image799324016410" height="16.625" src="figure/en-us_image_0000001432613505.png" width="49.875" title="Click to enlarge"></span></p>
</td>
<td class="cellrowborder" valign="top" width="79.42%" headers="mcps1.3.2.3.1.3.1.2 "><p id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_p4612588116410">Provides additional information to emphasize or supplement important points of the main text.</p>
<p id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_p1232588116410"><strong id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_b140425187232417">NOTE </strong>is used to address information not related to personal injury, equipment damage, or environment damage.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_section26813042"><h4 class="sectiontitle">Command Conventions</h4><p id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_p13765499">Commands in this document comply with the following conventions:</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_table56780633" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Command conventions</caption><thead align="left"><tr id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_row55718806"><th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.3.1.1"><p id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_p16929400"><strong id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_b18146878">Format</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.3.3.2.3.1.2"><p id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_p60610990"><strong id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_b8628003">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_row27779643"><td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_p35558624"><strong id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_b51592162">Boldface</strong></p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.3.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_p18215621">The keywords of a command are in <strong id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_b04251146466">Boldface</strong>.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_row29722863"><td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_p58741673"><em id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_i162720156514">Italic</em></p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.3.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_p11581440135319">Command arguments, paths, files, or folders are in italics.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_row65021323"><td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_p32235778">[ ]</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.3.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_p60961246">Square brackets enclose syntax choices (keywords or arguments) that are optional.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_row11780310"><td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_p14681028">{ x | y | ... }</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.3.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_p48312586">Braces enclose a set of required syntax choices separated by vertical bars (|), from which you select one.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_row32160094"><td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_p54830812">[ x | y | ... ]</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.3.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_p12110791">Square brackets enclose a set of optional syntax choices separated by vertical bars, from which you select one or none.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_row41888256"><td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_p37505593">{ x | y | ... }*</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.3.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_p18054162">Asterisk marked braces enclose a set of required syntax choices separated by vertical bars, from which you select at least one.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_row28269730"><td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_p8146766">[ x | y | ... ]*</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.3.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_p55908335">Asterisk marked square brackets enclose optional syntax choices separated by vertical bars, from which you select one choice, multiple choices, or none.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_row33412975"><td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_p22096474">&amp;&lt;1-n&gt;</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.3.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_p44983982">The argument or keyword and argument combination before the ampersand (&amp;) sign can be entered 1 to n times.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_row2202654"><td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.3.1.1 "><p id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_p44197281">#</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.3.3.2.3.1.2 "><p id="EN-US_TOPIC_0000001860318473__en-us_topic_0000001432320721_p23210017">A line that starts with a pound (#) sign is comments.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dws_16_0001.html">About This Document</a></div>
</div>
</div>
<script language="JavaScript">
<!--
image_size('.imgResize');
var msg_imageMax = "view original image";
var msg_imageClose = "close";
//--></script>