forked from BRL-CAD/brlcad
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add reair man page. modeled on reid - commented out references to the -n flag (which is currently a proposed addition to the command)
- Loading branch information
1 parent
34c8a63
commit 7a5adee
Showing
1 changed file
with
79 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,79 @@ | ||
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="reair"> | ||
|
||
<refmeta> | ||
<refentrytitle>REAIR</refentrytitle> | ||
<manvolnum>nged</manvolnum> | ||
<refmiscinfo class="source">BRL-CAD</refmiscinfo> | ||
<refmiscinfo class="manual">BRL-CAD User Commands</refmiscinfo> | ||
</refmeta> | ||
|
||
<refnamediv xml:id="name"> | ||
<refname>reair</refname> | ||
<refpurpose>Set the 'aircode' attribute of all regions within a group. | ||
</refpurpose> | ||
</refnamediv> | ||
|
||
<!-- body begins here --> | ||
<refsynopsisdiv xml:id="synopsis"> | ||
<cmdsynopsis sepchar=" "> | ||
<command>reair</command> | ||
# this part commented out - proposed addition of -n flag | ||
# <group choice="opt" rep="norepeat"> | ||
# <arg choice="plain" rep="norepeat">-n</arg> | ||
# <group choice="req" rep="norepeat"> | ||
# <arg choice="plain" rep="norepeat"><replaceable>num</replaceable></arg> | ||
# </group> | ||
# </group> | ||
<arg choice="req" rep="norepeat">comb</arg> | ||
<arg choice="req" rep="norepeat">aircode</arg> | ||
</cmdsynopsis> | ||
</refsynopsisdiv> | ||
|
||
<refsection xml:id="description"><title>DESCRIPTION</title> | ||
<para>The 'reair' command assigns the 'aircode' | ||
attribute value for all regions within a specified combination. | ||
# commented out for proposed -n addition | ||
# Optionally, the increment between consecutive 'aircode' can be | ||
# specified. Once the command is complete, the highest 'aircode' set | ||
# is reported. | ||
</para> | ||
</refsection> | ||
|
||
# commented out for proposed -n addition | ||
# <refsection xml:id="options"><title>OPTIONS</title> | ||
# <variablelist remap="TP"> | ||
# <varlistentry> | ||
# <term><option>-n num</option></term> | ||
# <listitem> | ||
# <para> | ||
# Increment to use between consecutive aircodes. | ||
# The default is 1. | ||
# </para> | ||
# </listitem> | ||
# </varlistentry> | ||
# </refsection> | ||
|
||
<refsection xml:id="examples"><title>EXAMPLES</title> | ||
|
||
<para> | ||
Set the aircode | ||
</para> | ||
<example><title>Set the aircode to 2. | ||
</title> | ||
<para><prompt>mged> </prompt><userinput>reair example.c 2</userinput> | ||
</para> | ||
<para>All regions under example.c will have their aircode reset to 2. | ||
</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> |