Skip to content

Commit

Permalink
Create e_id.xml
Browse files Browse the repository at this point in the history
  • Loading branch information
joshbaker22 committed Aug 16, 2023
1 parent 3991518 commit 918ea8c
Showing 1 changed file with 75 additions and 0 deletions.
75 changes: 75 additions & 0 deletions doc/docbook/system/mann/e_id.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="e_id">

<refmeta>
<refentrytitle>E_ID</refentrytitle>
<manvolnum>nged</manvolnum>
<refmiscinfo class="source">BRL-CAD</refmiscinfo>
<refmiscinfo class="manual">BRL-CAD User Commands</refmiscinfo>
</refmeta>

<refnamediv xml:id="name">
<refname>e_id</refname>
<refpurpose>
Draws objects whose region IDs are in the given range.
</refpurpose>
</refnamediv>

<!-- body begins here -->
<refsynopsisdiv xml:id="synopsis">
<cmdsynopsis sepchar=" ">
<command>e_id</command>
<arg choice="req" rep="norepeat">lower_bound</arg>
<arg choice="opt" rep="norepeat">upper_bound</arg>
</cmdsynopsis>
</refsynopsisdiv>

<refsection xml:id="description"><title>DESCRIPTION</title>

<para>
Draws all objects whose region IDs fall wihtin the given bounds. If only one input is given, <command>e_id</command>
will draw objects with that region ID.
</para>
</refsection>

<refsection xml:id="examples"><title>EXAMPLES</title>

<para>
Draw all regions with a single region ID.
</para>
<example><title>Draw all regions with regionID 1000</title>

<variablelist>
<varlistentry>
<term><prompt>mged&gt; </prompt><userinput>e_id 1000</userinput></term>
<listitem>
<para>
Draws all regions whose region ID is 1000.
</para>
</listitem>
</varlistentry>
</variablelist>
</example>

<example><title>Draw all regions whose region IDs are in the 2000s</title>

<para>
<prompt>mged&gt; </prompt><userinput>e_id 2000-2999</userinput>
</para>
<para>
Draws all regions who regions IDs fall between 2000 and 2999 inclusively.
</para>
</example>
</refsection>

<refsection xml:id="author"><title>AUTHOR</title>
<para>BRL-CAD Team</para>
</refsection>

<refsection xml:id="bug_reports"><title>BUG REPORTS</title>

<para>
Reports of bugs or problems should be submitted via electronic
mail to <email>[email protected]</email>
</para>
</refsection>
</refentry>

0 comments on commit 918ea8c

Please sign in to comment.