Create mirror.xml

doc/docbook/system/mann/mirror.xml

@@ -0,0 +1,87 @@
+<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="mirror">
+
+<refmeta>
+  <refentrytitle>MIRROR</refentrytitle>
+  <manvolnum>nged</manvolnum>
+  <refmiscinfo class="source">BRL-CAD</refmiscinfo>
+  <refmiscinfo class="manual">BRL-CAD User Commands</refmiscinfo>
+</refmeta>
+
+<refnamediv xml:id="name">
+  <refname>mirror</refname>
+  <refpurpose>Mirrors a shape or combination across a given axis.
+   </refpurpose>
+</refnamediv>
+
+<!-- body begins here -->
+<refsynopsisdiv xml:id="synopsis">
+  <cmdsynopsis sepchar=" ">
+    <command>mirror</command>
+    <arg choice="opt" rep="norepeat"><replaceable>-p "point"</replaceable></arg>
+    <arg choice="opt" rep="norepeat"><replaceable>-d "dir"</replaceable></arg>
+    <arg choice="opt" rep="norepeat"><replaceable>-x|-y-|-z</replaceable></arg>
+    <arg choice="opt" rep="norepeat"><replaceable>-o offset</replaceable></arg>
+    <arg choice="req" rep="norepeat"><replaceable>from_object to_object</replaceable></arg>
+  </cmdsynopsis>
+</refsynopsisdiv>
+
+<refsection xml:id="description"><title>DESCRIPTION</title>
+
+  <para>Mirrors an object (shape or combination) across a given axis (<emphasis>x</emphasis> by default).
+      If <emphasis>from_object</emphasis> is a shape, then it is copied to a new shape named
+      <emphasis>to_object</emphasis> that is mirrored across the given axis. If <emphasis>from_object</emphasis>
+      is a combination, then a new combination is created that contains exactly the same members naned <emphasis>to_object</emphasis>.
+      Transformation matrices are added to mirror it across the requested axis. The <emphasis>-x, -y, & -z</emphasis> options tell the
+      command which axis to mirror the object. The <emphasis>-p</emphasis> can be used to specify a point to mirror about, and
+      the <emphasis>-d</emphasis> can be used to specify a direction vector to mirror about.
+  </para>
+</refsection>
+
+<refsection xml:id="examples"><title>EXAMPLES</title>
+
+  <para>The example shows the use of the <command>mirror</command> command to mirror an object across the <emphasis>y</emphasis> axis.
+   </para>
+  <example><title>Mirror an object across an axis.</title>
+
+    <para>
+      <prompt>mged&gt; </prompt><userinput>mirror -y solid.s mir_solid.s</userinput>
+    </para>
+    <para>Creates a copy of solid.s that is mirrored across the <emphasis>y</emphasis> axis and named mir_solid.s
+    </para>
+  </example>
+
+    <para>The example shows the use of the <command>mirror</command> command to mirror an object across a plane of x=100.
+   </para>
+  <example><title>Mirror an object across an plane parallel to an axis.</title>
+
+    <para>
+      <prompt>mged&gt; </prompt><userinput>mirror -x -o 100 solid.s mir_solid.s</userinput>
+    </para>
+    <para>Creates a copy of solid.s that is mirrored across a plane parallel to the <emphasis>x</emphasis> axis at x=100 and named mir_solid.s
+    </para>
+  </example>
+
+      <para>The example shows the use of the <command>mirror</command> command to mirror an object about a given point.
+   </para>
+  <example><title>Mirror an object about a given point.</title>
+
+    <para>
+      <prompt>mged&gt; </prompt><userinput>mirror -p "0 1000 0" -y solid.s mir_solid.s</userinput>
+    </para>
+    <para>Creates a copy of solid.s that is mirrored across a plane parallel to the <emphasis>y</emphasis> axis at the point 0, 1000, 0 and named mir_solid.s
+    </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>