Revision: 77125
http://sourceforge.net/p/brlcad/code/77125
Author: starseeker
Date: 2020-09-13 14:34:09 +0000 (Sun, 13 Sep 2020)
Log Message:
-----------
Update whichair man page for new capabilities.
Modified Paths:
--------------
brlcad/trunk/doc/docbook/system/mann/whichair.xml
Modified: brlcad/trunk/doc/docbook/system/mann/whichair.xml
===================================================================
--- brlcad/trunk/doc/docbook/system/mann/whichair.xml 2020-09-13 14:04:59 UTC
(rev 77124)
+++ brlcad/trunk/doc/docbook/system/mann/whichair.xml 2020-09-13 14:34:09 UTC
(rev 77125)
@@ -9,7 +9,7 @@
<refnamediv xml:id="name">
<refname>whichair</refname>
- <refpurpose>Lists all the regions that use one of the air codes
specified.</refpurpose>
+ <refpurpose>Reports information relating to usag of air codes on
regions.</refpurpose>
</refnamediv>
<!-- body begins here -->
@@ -16,36 +16,93 @@
<refsynopsisdiv xml:id="synopsis">
<cmdsynopsis sepchar=" ">
<command>whichair</command>
-
+ <arg choice="opt" rep="norepeat"><replaceable>options
...</replaceable></arg>
<arg choice="req" rep="norepeat"><replaceable>air_codes</replaceable></arg>
-
</cmdsynopsis>
</refsynopsisdiv>
<refsection xml:id="description"><title>DESCRIPTION</title>
- <para>Lists all the regions that use one of the air codes specified.
-The <command>eac</command> command will perform a similar search, but will
draw the qualifying regions
-in the MGED display rather than listing them. Regions that have nonzero ident
-numbers will not be listed by this command.
+<para>
- </para>
+ Reports information about the usage of the <emphasis>air_codes</emphasis>
property
+ by regions in a .g file. Its default mode is to report which regions in a
.g file
+ are using one or a range of region_id values. If a root object is
specified, it
+ will report that result only for the regions in the tree of the root object.
+
+ If the <option>U</option> is specified, the reporting is inverted and the
command
+ will report the ranges of <emphasis>unused</emphasis> aircodes rather than
the regions
+ using various aircodes.
+</para>
+<para>
+ The <command>eac</command> command will perform a similar search, but will
draw
+ the qualifying regions in the MGED display rather than listing them.
+</para>
</refsection>
+<refsection xml:id="search_options"><title>OPTIONS</title>
+
+<variablelist remap="TP">
+ <varlistentry>
+ <term><emphasis remap="B" role="bold">-U</emphasis></term>
+ <listitem>
+ <para>
+ Report unused aircode ranges.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis remap="B" role="bold">--root objname</emphasis></term>
+ <listitem>
+ <para>
+ Limit reporting to regions in the CSG tree below
<emphasis>objname</emphasis>.
+ </para>
+ </listitem>
+ </varlistentry>
+</variablelist>
+
+</refsection>
+
<refsection xml:id="examples"><title>EXAMPLES</title>
- <para>The example shows the use of the <command>whichair</command> command
to list all the regions that use one of the air codes specified.
+<para>
+ For these examples the geometry file used is the standard
<emphasis>m35.g</emphasis>
+ included with BRL-CAD.
+</para>
+
+<example>
+ <title>Report all regions using air codes between 7 and 10.</title>
+ <para>
+ <prompt>mged></prompt><userinput>whichair 7-10</userinput>
+ <literallayout class="normal">
+Region[s] with air code 7:
+ r11
+ r13
+ r15
+Region[s] with air code 8:
+ r25
+ r27
+ r29
+ r31
+ r33
+ r35
+ </literallayout>
</para>
+</example>
- <example><title>List all regions that use the specified air codes.</title>
+<example>
+ <title>Report all unused aircode ranges in the database between 1 and
10.</title>
+ <para>
+ <prompt>mged></prompt><userinput>whichair -U 1-10</userinput>
+ <literallayout class="normal">
+Unused air codes:
+ 1-3
+ 5
+ 9-10
+ </literallayout>
+ </para>
+</example>
- <para>
- <prompt>mged></prompt><userinput>whichair 2 3</userinput>
- </para>
- <para>Lists all regions in the current database that have <emphasis>air
codes</emphasis> of 2 or 3.
- </para>
- </example>
-
</refsection>
<refsection xml:id="author"><title>AUTHOR</title><para>BRL-CAD
Team</para></refsection>
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
