Revision: 76302
http://sourceforge.net/p/brlcad/code/76302
Author: brlcad
Date: 2020-07-10 07:07:43 +0000 (Fri, 10 Jul 2020)
Log Message:
-----------
update the manual pages to be more consistent with the usage statements
Modified Paths:
--------------
brlcad/trunk/doc/docbook/system/mann/eac.xml
brlcad/trunk/doc/docbook/system/mann/edcomb.xml
brlcad/trunk/doc/docbook/system/mann/item.xml
brlcad/trunk/doc/docbook/system/mann/regdef.xml
brlcad/trunk/doc/docbook/system/mann/reid.xml
Modified: brlcad/trunk/doc/docbook/system/mann/eac.xml
===================================================================
--- brlcad/trunk/doc/docbook/system/mann/eac.xml 2020-07-10 05:46:34 UTC
(rev 76301)
+++ brlcad/trunk/doc/docbook/system/mann/eac.xml 2020-07-10 07:07:43 UTC
(rev 76302)
@@ -18,21 +18,23 @@
<refsynopsisdiv xml:id="synopsis">
<cmdsynopsis sepchar=" ">
<command>eac</command>
- <arg choice="opt" rep="norepeat">aircodes</arg>
- <arg choice="req" rep="norepeat"><replaceable>aircodes</replaceable></arg>
+ <arg choice="req"
rep="norepeat"><replaceable>air_code(s)</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsection xml:id="description"><title>DESCRIPTION</title>
- <para>Adds all the regions in the current model that have one of the
aircodes in the argument list to the display list so that they will appear
on the <emphasis>MGED</emphasis> display. Regions that have nonzero ident
numbers will not be listed by this command. The <command>whichair</command>
command will perform the same search, but just lists the results.
+ <para>Adds all the regions in the current model that have any of the
+ specified aircodes to the display list so that they will appear on
+ the <emphasis>MGED</emphasis> display. Regions that have nonzero
+ region identifiers will not be listed by this command. The
+ <command>whichair</command> command performs a similarsearch, but
+ just lists the results.
</para>
</refsection>
<refsection xml:id="examples"><title>EXAMPLES</title>
- <para>The example shows the use of the <command>eac</command> command to
draw all regions having particular air codes.
- </para>
<example><title>Draw all regions having particular air codes.</title>
<variablelist>
@@ -39,7 +41,9 @@
<varlistentry>
<term><prompt>mged></prompt> <userinput>eac 1 2
3</userinput></term>
<listitem>
- <para>Draws all regions with <emphasis>aircodes</emphasis> 1, 2,
or 3 in the <emphasis>MGED</emphasis> display.</para>
+ <para>Draws all regions with
+ <emphasis>aircodes</emphasis> 1, 2, or 3 in the
+ <emphasis>MGED</emphasis> display.</para>
</listitem>
</varlistentry>
</variablelist>
Modified: brlcad/trunk/doc/docbook/system/mann/edcomb.xml
===================================================================
--- brlcad/trunk/doc/docbook/system/mann/edcomb.xml 2020-07-10 05:46:34 UTC
(rev 76301)
+++ brlcad/trunk/doc/docbook/system/mann/edcomb.xml 2020-07-10 07:07:43 UTC
(rev 76302)
@@ -19,7 +19,7 @@
<command>edcomb</command>
<arg choice="req" rep="norepeat"><replaceable>combname</replaceable></arg>
- <arg choice="opt" rep="norepeat"><replaceable>regionflag region_id
air_code los material_id</replaceable></arg>
+ <arg choice="opt" rep="norepeat"><replaceable>regionflag regionID airID
los% materialID</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
Modified: brlcad/trunk/doc/docbook/system/mann/item.xml
===================================================================
--- brlcad/trunk/doc/docbook/system/mann/item.xml 2020-07-10 05:46:34 UTC
(rev 76301)
+++ brlcad/trunk/doc/docbook/system/mann/item.xml 2020-07-10 07:07:43 UTC
(rev 76302)
@@ -17,10 +17,19 @@
<refsynopsisdiv xml:id="synopsis">
<cmdsynopsis sepchar=" ">
<command>item</command>
- <arg choice="req" rep="norepeat"><replaceable>region_name
ident_number</replaceable></arg>
- <arg choice="opt"
rep="norepeat"><replaceable>air_code</replaceable></arg>
- <arg choice="opt"
rep="norepeat"><replaceable>material_code</replaceable></arg>
- <arg choice="opt" rep="norepeat"><replaceable>LOS</replaceable></arg>
+ <arg choice="req"
rep="norepeat"><replaceable>region_name</replaceable></arg>
+ <arg choice="req" rep="norepeat">
+ <replaceable>regionID</replaceable>
+ <arg choice="opt" rep="norepeat">
+ <replaceable>airID</replaceable>
+ <arg choice="opt" rep="norepeat">
+ <replaceable>materialID</replaceable>
+ <arg choice="opt" rep="norepeat">
+ <replaceable>los%</replaceable>
+ </arg>
+ </arg>
+ </arg>
+ </arg>
</cmdsynopsis>
</refsynopsisdiv>
Modified: brlcad/trunk/doc/docbook/system/mann/regdef.xml
===================================================================
--- brlcad/trunk/doc/docbook/system/mann/regdef.xml 2020-07-10 05:46:34 UTC
(rev 76301)
+++ brlcad/trunk/doc/docbook/system/mann/regdef.xml 2020-07-10 07:07:43 UTC
(rev 76302)
@@ -17,13 +17,13 @@
<refsynopsisdiv xml:id="synopsis">
<cmdsynopsis sepchar=" ">
<command>regdef</command>
- <arg choice="req" rep="norepeat"><replaceable>item</replaceable></arg>
+ <arg choice="req" rep="norepeat"><replaceable>regionID</replaceable></arg>
<arg choice="opt" rep="norepeat">
- <replaceable>air </replaceable>
+ <replaceable>airID</replaceable>
<arg choice="opt" rep="norepeat">
- <replaceable>los</replaceable>
+ <replaceable>los%</replaceable>
<arg choice="opt" rep="norepeat">
- <replaceable>material_code</replaceable>
+ <replaceable>materialID</replaceable>
</arg>
</arg>
</arg>
Modified: brlcad/trunk/doc/docbook/system/mann/reid.xml
===================================================================
--- brlcad/trunk/doc/docbook/system/mann/reid.xml 2020-07-10 05:46:34 UTC
(rev 76301)
+++ brlcad/trunk/doc/docbook/system/mann/reid.xml 2020-07-10 07:07:43 UTC
(rev 76302)
@@ -23,16 +23,17 @@
<arg choice="plain"
rep="norepeat"><replaceable>num</replaceable></arg>
</group>
</group>
- <arg choice="req" rep="norepeat">assembly</arg>
+ <arg choice="req" rep="norepeat">comb</arg>
<arg choice="req" rep="norepeat">regionID</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsection xml:id="description"><title>DESCRIPTION</title>
- <para>The 'reid' command sequentially renumbers the 'region_id' attribute
- of all regions within a group. Optionally the increment between consecutive
- 'region_id' can be specified. Once the command is complete, the highest
- 'region_id' set is reported.</para>
+ <para>The 'reid' command sequentially assigns the 'region_id'
+ attribute value for all regions within a specified combination.
+ Optionally, the increment between consecutive 'region_id' can be
+ specified. Once the command is complete, the highest 'region_id' set
+ is reported.</para>
</refsection>
<refsection xml:id="options"><title>OPTIONS</title>
@@ -41,15 +42,16 @@
<term><option>-n num</option></term>
<listitem>
<para>
- Increment between consecutive 'region_id'. The default is one.
+ Increment to use between consecutive region identifiers.
+ The default is 1.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>assembly</option></term>
+ <term><option>comb</option></term>
<listitem>
<para>
- Group name
+ Name of the combination to search for regions.
</para>
</listitem>
</varlistentry>
@@ -57,7 +59,7 @@
<term><option>regionID</option></term>
<listitem>
<para>
- Renumber start number
+ Region ID to start re-numbering with.
</para>
</listitem>
</varlistentry>
This was sent by the SourceForge.net collaborative development platform, the
world's largest Open Source development site.
_______________________________________________
BRL-CAD Source Commits mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/brlcad-commits
