Create rtedge.xml

doc/docbook/system/mann/rtedge.xml

@@ -0,0 +1,83 @@
+<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="rtedge">
+
+<refmeta>
+ <refentrytitle>RTEDGE</refentrytitle>
+ <manvolnum>nged</manvolnum>
+ <refmiscinfo class="source">BRL-CAD</refmiscinfo>
+ <refmiscinfo class="manual">BRL-CAD MGED Commands</refmiscinfo>
+</refmeta>
+
+<refnamediv xml:id="name">
+ <refname>rtedge</refname>
+ <refpurpose>Executes the BRL-CAD <emphasis>rtedge</emphasis> program with the default options of
+ "-s50 -M."
+ </refpurpose>
+</refnamediv>
+
+<!-- body begins here -->
+<refsynopsisdiv xml:id="synopsis">
+ <cmdsynopsis sepchar=" ">
+ <command>rtedge</command>
+ <arg choice="opt" rep="norepeat"><replaceable>options</replaceable></arg>
+ </cmdsynopsis>
+</refsynopsisdiv>
+
+<refsection xml:id="description"><title>DESCRIPTION</title>
+
+ <para>Executes the BRL-CAD <emphasis>rtedge</emphasis> program with the default options of
+ "-s50 -M." If perspective is turned on, then the <emphasis>-p</emphasis> option will be 
+ included with the value of the perspective angle. The current database name is added to the
+ end of the <command>rtedge</command> command line along the list of currently displayed objects. The
+ <emphasis>rtedge</emphasis> program is written such that options may be repeated, and the
+ last occurrence of an option will override any earlier occurrences. This allows the user
+ to specify other <emphasis>size (-s)</emphasis> options. The
+ <emphasis>-M</emphasis> option tells <emphasis>rtedge</emphasis> to read the viewing parameters
+ from standard input. See the <emphasis>man1</emphasis> page on <emphasis>rtedge</emphasis>
+ for details. 
+
+ </para>
+</refsection>
+
+<refsection xml:id="examples"><title>EXAMPLES</title>
+
+ <para>The first example shows the use of the <command>rtedge</command> command to run the <emphasis>rtedge</emphasis>
+ program to produce an edge image of the current view. The second example shows the
+ use of the <command>rtedge</command> command to produce an edge image of an object using
+ MGED's current viewing parameters.
+ </para>
+
+ <example><title>Run the <emphasis>rtedge</emphasis> program to produce an edge image of the current
+ view in MGED.</title>
+
+ <para>
+ <prompt>mged&gt; </prompt><userinput>rtedge -s1024</userinput>
+ </para>
+ <para>Runs the <emphasis>rtedge</emphasis> program to produce an edge image of the current
+ view in the MGED display. The image will be white lines on a black background and will be
+ 1024 pixels square.
+ </para>
+ </example>
+
+ <example><title>Run the <emphasis>rtedge</emphasis> program to produce an edge image with black lines
+ on a white background.</title>
+
+ <para>
+ <prompt>mged&gt; </prompt><userinput>rt -W</userinput>
+ </para>
+ <para>Runs the <emphasis>rtedge</emphasis> program to produce an edge image of the currently drawn objects
+ using MGED's current viewing parameters. The image will have black lines on a white background.
+ </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>devs@brlcad.org</email>
+ </para>
+</refsection>
+</refentry>