[brlcad-commits] SF.net SVN: brlcad:[38329] brlcad/trunk/doc/docbook/system/mann/en
Open Source Solid Modeling CAD
Brought to you by:
brlcad
Menu
▾
▴
[brlcad-commits] SF.net SVN: brlcad:[38329] brlcad/trunk/doc/docbook/system/mann/en
|
From: <sta...@us...> - 2010-04-05 18:31:52
|
Revision: 38329
http://brlcad.svn.sourceforge.net/brlcad/?rev=38329&view=rev
Author: starseeker
Date: 2010-04-05 18:31:46 +0000 (Mon, 05 Apr 2010)
Log Message:
-----------
Now that we have MGED specific man pages, add back in Janine's work on the db, nirt, rt and rtcheck commands. Clearly a lot of work to do here to make sure these are informative for MGED usage - many of the command line options do in fact function within MGED - but it's a start.
Modified Paths:
--------------
brlcad/trunk/doc/docbook/system/mann/en/Makefile.am
Added Paths:
-----------
brlcad/trunk/doc/docbook/system/mann/en/db.xml
brlcad/trunk/doc/docbook/system/mann/en/nirt.xml
brlcad/trunk/doc/docbook/system/mann/en/rt.xml
brlcad/trunk/doc/docbook/system/mann/en/rtcheck.xml
Modified: brlcad/trunk/doc/docbook/system/mann/en/Makefile.am
===================================================================
--- brlcad/trunk/doc/docbook/system/mann/en/Makefile.am 2010-04-05 18:25:51 UTC (rev 38328)
+++ brlcad/trunk/doc/docbook/system/mann/en/Makefile.am 2010-04-05 18:31:46 UTC (rev 38329)
@@ -48,6 +48,7 @@
system/mann/en/cpi.xml \
system/mann/en/d.xml \
system/mann/en/dall.xml \
+ system/mann/en/db.xml \
system/mann/en/db_glob.xml \
system/mann/en/dbconcat.xml \
system/mann/en/debugbu.xml \
@@ -123,6 +124,7 @@
system/mann/en/mrot.xml \
system/mann/en/mv.xml \
system/mann/en/mvall.xml \
+ system/mann/en/nirt.xml \
system/mann/en/nmg_collapse.xml \
system/mann/en/nmg_simplify.xml \
system/mann/en/oed.xml \
@@ -175,6 +177,8 @@
system/mann/en/rpp-arch.xml \
system/mann/en/rpp-cap.xml \
system/mann/en/rrt.xml \
+ system/mann/en/rt.xml \
+ system/mann/en/rtcheck.xml \
system/mann/en/rtwizard.xml \
system/mann/en/savekey.xml \
system/mann/en/saveview.xml \
Added: brlcad/trunk/doc/docbook/system/mann/en/db.xml
===================================================================
--- brlcad/trunk/doc/docbook/system/mann/en/db.xml (rev 0)
+++ brlcad/trunk/doc/docbook/system/mann/en/db.xml 2010-04-05 18:31:46 UTC (rev 38329)
@@ -0,0 +1,221 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+ "../../../resources/standard/dtd/docbookx.dtd">
+
+<!-- Copyright (c) 2005-2008 United States Government as represented by -->
+<!-- the U.S. Army Research Laboratory. -->
+<!-- -->
+<!-- Redistribution and use in source (Docbook format) and 'compiled' -->
+<!-- forms (PDF, PostScript, HTML, RTF, etc), with or without -->
+<!-- modification, are permitted provided that the following conditions -->
+<!-- are met: -->
+<!-- -->
+<!-- 1. Redistributions of source code (Docbook format) must retain the -->
+<!-- above copyright notice, this list of conditions and the following -->
+<!-- disclaimer. -->
+<!-- -->
+<!-- 2. Redistributions in compiled form (transformed to other DTDs, -->
+<!-- converted to PDF, PostScript, HTML, RTF, and other formats) must -->
+<!-- reproduce the above copyright notice, this list of conditions and -->
+<!-- the following disclaimer in the documentation and/or other -->
+<!-- materials provided with the distribution. -->
+<!-- -->
+<!-- 3. The name of the author may not be used to endorse or promote -->
+<!-- products derived from this documentation without specific prior -->
+<!-- written permission. -->
+<!-- -->
+<!-- THIS DOCUMENTATION IS PROVIDED BY THE AUTHOR "AS IS" AND ANY -->
+<!-- EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -->
+<!-- IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -->
+<!-- PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR -->
+<!-- ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR -->
+<!-- CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT -->
+<!-- OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR -->
+<!-- BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF -->
+<!-- LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT -->
+<!-- (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE -->
+<!-- USE OF THIS DOCUMENTATION, EVEN IF ADVISED OF THE POSSIBILITY OF -->
+<!-- SUCH DAMAGE. -->
+
+<refentry id='db'>
+
+<refmeta>
+ <refentrytitle>db</refentrytitle>
+ <manvolnum>nged</manvolnum>
+ <refmiscinfo class='source'>BRL-CAD</refmiscinfo>
+ <refmiscinfo class='manual'>BRL-CAD MGED Commands</refmiscinfo>
+</refmeta>
+
+<refnamediv id='name'>
+ <refname>db</refname>
+ <refpurpose>Provides an interface to a number of database manipulation
+routines.
+ </refpurpose>
+</refnamediv>
+
+<!-- body begins here -->
+<refsynopsisdiv id='synopsis'>
+ <cmdsynopsis>
+ <command>db</command>
+
+ <arg choice='req'><replaceable>command</replaceable></arg>
+ <arg choice='opt'><replaceable>arguments</replaceable></arg>
+ </cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1 id='description'>
+ <title>DESCRIPTION</title>
+ <para>Provides an interface to a number of database manipulation
+routines. Note that this command always operates in units of millimeters. The
+<emphasis>command</emphasis> must be one of the following with appropriate arguments:
+ </para>
+
+<variablelist>
+<varlistentry>
+<term><emphasis>match [regular_exp]</emphasis></term>
+<listitem>
+<para>Returns a list of all objects in that database that match the list of regular
+expressions.</para>
+</listitem>
+</varlistentry>
+
+<varlistentry>
+<term><emphasis>get shape_or_path [attribute]</emphasis></term>
+<listitem>
+<para>Returns information about the primitive shape at the end of the <emphasis>shape_or_path</emphasis>.
+If a path is specified, the transformation matrices encountered along that path will
+be accumulated and applied to the leaf shape before displaying the information. If
+no <emphasis>attribute</emphasis> is specified, all the details about the shape are returned. If a specific
+<emphasis>attribute</emphasis> is listed, then only that information is returned.
+</para>
+</listitem>
+</varlistentry>
+
+<varlistentry>
+<term><emphasis>put shape_name shape_type attributes</emphasis></term>
+<listitem>
+<para>Creates shape named <emphasis>shape_name</emphasis> of type <emphasis>shape_type</emphasis> with attributes as listed in
+<emphasis>attributes</emphasis>. The arguments to the <emphasis>put</emphasis> command are the same as those returned by
+the <emphasis>get</emphasis> command.
+</para>
+</listitem>
+</varlistentry>
+
+<varlistentry>
+<term><emphasis>adjust shape_name attribute new_value1 [new_value2 new_value3...]</emphasis></term>
+<listitem>
+<para>Modifies the shape named <emphasis>shape_name</emphasis> by adjusting the value of its <emphasis>attribute</emphasis> to
+the <emphasis>new_values</emphasis>.
+</para>
+</listitem>
+</varlistentry>
+
+<varlistentry>
+<term><emphasis>form object_type</emphasis></term>
+<listitem>
+<para>Displays the format used to display objects of type <emphasis>object_type</emphasis>.
+</para>
+</listitem>
+</varlistentry>
+
+<varlistentry>
+<term><emphasis>tops</emphasis></term>
+<listitem>
+<para>Returns all top-level objects.
+</para>
+</listitem>
+</varlistentry>
+
+<varlistentry>
+<term><emphasis>close</emphasis></term>
+<listitem>
+<para>Closes the previously opened database and deletes the associated command.
+</para>
+</listitem>
+</varlistentry>
+</variablelist>
+</refsect1>
+
+<refsect1 id='examples'>
+ <title>EXAMPLES</title>
+ <para>The following examples show the uses of the <command>db</command> command to list various
+objects and attributes from the database, as well as to create new TGC shapes, adjust a vertex attribute,
+and display command formats.
+ </para>
+ <example>
+ <title>List all objects in the database that end with ".s"</title>
+ <variablelist>
+ <varlistentry>
+ <term><prompt>mged></prompt> <userinput>db match *.s</userinput></term>
+ <listitem>
+ <para>Gets a list of all objects in the database that end with \x93.s.\x94
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </example>
+
+ <example>
+ <title>List all attributes and their values for <emphasis>cone.s</emphasis></title>
+ <para>
+ <prompt>mged></prompt><userinput>db get cone.s</userinput>
+ </para>
+ <para>
+ Gets a list of all the attributes and their values for shape <emphasis>cone.s</emphasis>.
+ </para>
+ </example>
+
+ <example>
+ <title>Get the value of the vertex attribute of <emphasis>cone.s</emphasis></title>
+ <para>
+ <prompt>mged></prompt><userinput>db get cone.s V</userinput>
+ </para>
+ <para>
+ Gets the value of the <emphasis>V</emphasis> (vertex) attribute of shape <emphasis>cone.s</emphasis>
+ </para>
+ </example>
+
+ <example>
+ <title>Create a new TGC shape named <emphasis>new_cone.s</emphasis> with specified attributes.</title>
+ <para>
+ <prompt>mged></prompt><userinput>db put new_cone.s tgc V {0 0 0} H {0 0 1} A {1 0 0}
+ B {0 1 0} C {5 0 0} D {0 5 0}</userinput>
+ </para>
+ <para>Creates a new TGC shape named <emphasis>new_cone.s</emphasis> with the specified attributes.
+ </para>
+ </example>
+
+<example>
+ <title>Adjust the vertex attribute of <emphasis>new_cone.s</emphasis> to a given value.</title>
+ <para>
+ <prompt>mged></prompt><userinput>db adjust new_cone.s V {0 0 10}</userinput>
+ </para>
+ <para>Adjusts the <emphasis>V</emphasis> (vertex) attribute of <emphasis>new_cone.s</emphasis> to the value {0 0 10}.
+ </para>
+</example>
+
+<example>
+ <title>Display the format used by the <command>get</command> and <command>put</command> commands for the TGC shape type.</title>
+ <para>
+ <prompt>mged></prompt><userinput>db form tgc</userinput>
+ </para>
+ <para>Displays the format used by the <command>get</command> and <command>put</command> commands for the TGC shape type.
+ </para>
+</example>
+
+</refsect1>
+
+<refsect1 id='author'>
+ <title>AUTHOR</title>
+ <para>BRL-CAD Team</para>
+</refsect1>
+
+<refsect1 id='bug_reports'>
+ <title>BUG REPORTS</title>
+ <para>
+ Reports of bugs or problems should be submitted via electronic
+ mail to <de...@br...>, or via the "cadbug.sh" script.
+ </para>
+</refsect1>
+</refentry>
+
Property changes on: brlcad/trunk/doc/docbook/system/mann/en/db.xml
___________________________________________________________________
Added: svn:mime-type
+ text/xml
Added: svn:eol-style
+ native
Added: brlcad/trunk/doc/docbook/system/mann/en/nirt.xml
===================================================================
--- brlcad/trunk/doc/docbook/system/mann/en/nirt.xml (rev 0)
+++ brlcad/trunk/doc/docbook/system/mann/en/nirt.xml 2010-04-05 18:31:46 UTC (rev 38329)
@@ -0,0 +1,105 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+ "../../../resources/standard/dtd/docbookx.dtd">
+
+<!-- Copyright (c) 2005-2008 United States Government as represented by -->
+<!-- the U.S. Army Research Laboratory. -->
+<!-- -->
+<!-- Redistribution and use in source (Docbook format) and 'compiled' -->
+<!-- forms (PDF, PostScript, HTML, RTF, etc), with or without -->
+<!-- modification, are permitted provided that the following conditions -->
+<!-- are met: -->
+<!-- -->
+<!-- 1. Redistributions of source code (Docbook format) must retain the -->
+<!-- above copyright notice, this list of conditions and the following -->
+<!-- disclaimer. -->
+<!-- -->
+<!-- 2. Redistributions in compiled form (transformed to other DTDs, -->
+<!-- converted to PDF, PostScript, HTML, RTF, and other formats) must -->
+<!-- reproduce the above copyright notice, this list of conditions and -->
+<!-- the following disclaimer in the documentation and/or other -->
+<!-- materials provided with the distribution. -->
+<!-- -->
+<!-- 3. The name of the author may not be used to endorse or promote -->
+<!-- products derived from this documentation without specific prior -->
+<!-- written permission. -->
+<!-- -->
+<!-- THIS DOCUMENTATION IS PROVIDED BY THE AUTHOR "AS IS" AND ANY -->
+<!-- EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -->
+<!-- IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -->
+<!-- PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR -->
+<!-- ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR -->
+<!-- CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT -->
+<!-- OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR -->
+<!-- BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF -->
+<!-- LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT -->
+<!-- (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE -->
+<!-- USE OF THIS DOCUMENTATION, EVEN IF ADVISED OF THE POSSIBILITY OF -->
+<!-- SUCH DAMAGE. -->
+
+<refentry id='nirt'>
+
+<refmeta>
+ <refentrytitle>NIRT</refentrytitle>
+ <manvolnum>nged</manvolnum>
+ <refmiscinfo class='source'>BRL-CAD</refmiscinfo>
+ <refmiscinfo class='manual'>BRL-CAD MGED Commands</refmiscinfo>
+</refmeta>
+
+<refnamediv id='name'>
+ <refname>nirt</refname>
+ <refpurpose>Runs the NIRT program that is distributed with BRL-CAD to
+intersect a single ray with the displayed objects.
+ </refpurpose>
+</refnamediv>
+
+<!-- body begins here -->
+<refsynopsisdiv id='synopsis'>
+ <cmdsynopsis>
+ <command>nirt</command>
+ <arg><replaceable>nirt_args</replaceable></arg>
+ </cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1 id='description'>
+ <title>DESCRIPTION</title>
+ <para>Runs the NIRT program that is distributed with BRL-CAD to
+intersect a single ray with the displayed objects. By default, NIRT is run using the
+current database and the currently displayed objects, and it uses the current eye point
+as the ray start point and the current viewing direction as the ray direction. This
+effectively fires a ray at the center of the MGED display. The resulting collection of
+intersections between the ray and the objects is listed. Additional arguments may be
+supplied on the <command>nirt</command> command line. See the <emphasis>man</emphasis>page
+of <command>nirt</command> for more details.
+ </para>
+</refsect1>
+
+<refsect1 id='examples'>
+ <title>EXAMPLES</title>
+ <para>The example shows the use of the <command>nirt</command> command to fire a single ray through the center of the MGED display.
+ </para>
+ <example>
+ <title>Run the NIRT program to fire a ray through the MGED display.</title>
+ <para>
+ <prompt>mged></prompt><userinput>nirt</userinput>
+ </para>
+ <para>Fires a single ray through the center of the MGED display.
+ </para>
+ </example>
+
+</refsect1>
+
+<refsect1 id='author'>
+ <title>AUTHOR</title>
+ <para>BRL-CAD Team</para>
+</refsect1>
+
+<refsect1 id='bug_reports'>
+ <title>BUG REPORTS</title>
+ <para>
+ Reports of bugs or problems should be submitted via electronic
+ mail to <de...@br...>, or via the "cadbug.sh" script.
+ </para>
+</refsect1>
+</refentry>
+
Property changes on: brlcad/trunk/doc/docbook/system/mann/en/nirt.xml
___________________________________________________________________
Added: svn:mime-type
+ text/xml
Added: svn:eol-style
+ native
Added: brlcad/trunk/doc/docbook/system/mann/en/rt.xml
===================================================================
--- brlcad/trunk/doc/docbook/system/mann/en/rt.xml (rev 0)
+++ brlcad/trunk/doc/docbook/system/mann/en/rt.xml 2010-04-05 18:31:46 UTC (rev 38329)
@@ -0,0 +1,113 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+ "../../../resources/standard/dtd/docbookx.dtd">
+
+<!-- Copyright (c) 2005-2008 United States Government as represented by -->
+<!-- the U.S. Army Research Laboratory. -->
+<!-- -->
+<!-- Redistribution and use in source (Docbook format) and 'compiled' -->
+<!-- forms (PDF, PostScript, HTML, RTF, etc), with or without -->
+<!-- modification, are permitted provided that the following conditions -->
+<!-- are met: -->
+<!-- -->
+<!-- 1. Redistributions of source code (Docbook format) must retain the -->
+<!-- above copyright notice, this list of conditions and the following -->
+<!-- disclaimer. -->
+<!-- -->
+<!-- 2. Redistributions in compiled form (transformed to other DTDs, -->
+<!-- converted to PDF, PostScript, HTML, RTF, and other formats) must -->
+<!-- reproduce the above copyright notice, this list of conditions and -->
+<!-- the following disclaimer in the documentation and/or other -->
+<!-- materials provided with the distribution. -->
+<!-- -->
+<!-- 3. The name of the author may not be used to endorse or promote -->
+<!-- products derived from this documentation without specific prior -->
+<!-- written permission. -->
+<!-- -->
+<!-- THIS DOCUMENTATION IS PROVIDED BY THE AUTHOR "AS IS" AND ANY -->
+<!-- EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -->
+<!-- IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -->
+<!-- PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR -->
+<!-- ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR -->
+<!-- CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT -->
+<!-- OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR -->
+<!-- BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF -->
+<!-- LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT -->
+<!-- (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE -->
+<!-- USE OF THIS DOCUMENTATION, EVEN IF ADVISED OF THE POSSIBILITY OF -->
+<!-- SUCH DAMAGE. -->
+
+<refentry id='rt'>
+
+<refmeta>
+ <refentrytitle>RT</refentrytitle>
+ <manvolnum>nged</manvolnum>
+ <refmiscinfo class='source'>BRL-CAD</refmiscinfo>
+ <refmiscinfo class='manual'>BRL-CAD MGED Commands</refmiscinfo>
+</refmeta>
+
+<refnamediv id='name'>
+ <refname>rt</refname>
+ <refpurpose>Executes the BRL-CAD <emphasis>rt</emphasis> program with the default options of
+ "-s50 M."
+ </refpurpose>
+</refnamediv>
+
+<!-- body begins here -->
+<refsynopsisdiv id='synopsis'>
+ <cmdsynopsis>
+ <command>rt</command>
+
+ <arg><replaceable>options</replaceable></arg>
+ <arg><replaceable>--objects</replaceable></arg>
+ </cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1 id='description'>
+ <title>DESCRIPTION</title>
+ <para>Executes the BRL-CAD <emphasis>rt</emphasis> program with the default options of
+ "-s50 \x96M." 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>rt</command> command line along with either the specified <emphasis> objects</emphasis> or, if none is specified, the list of currently displayed objects. The <emphasis>rt</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 <command>rrt</command> command performs a similar function, but may be used to execute other programs as well. The <emphasis>-M</emphasis> option tells <emphasis>rt</emphasis> to read the viewing parameters from standard input. See the <emphasis>man</emphasis> page on <emphasis>rt</emphasis> for details. A related command is <command>saveview</command>, which can be used to create a shell script (batch job) to raytrace this view in the background.
+
+ </para>
+</refsect1>
+
+<refsect1 id='examples'>
+ <title>EXAMPLES</title>
+ <para>The first example shows the use of the <command>rt</command> command to run the rt program to produce a color-shaded image of the current view. The second example shows the use of the <command>rt</command> command to produce a color-shaded image of an object using MGED's current viewing parameters.
+ </para>
+
+ <example>
+ <title>Run the <emphasis>rt</emphasis> program to produce a color-shaded image of the current view in MGED.</title>
+ <para>
+ <prompt>mged></prompt><userinput>rt -s1024 -F/dev/Xl</userinput>
+ </para>
+ <para>Runs the <emphasis>rt</emphasis> program to produce a color-shaded image of the current view in the MGED display. The image will be 1024 pixels square and will be displayed on a
+ lingering <emphasis>X</emphasis> framebuffer.
+ </para>
+ </example>
+
+ <example>
+ <title>Run the <emphasis>rt</emphasis> program to produce a color-shaded image of an object using MGED's current viewing parameters.</title>
+ <para>
+ <prompt>mged></prompt><userinput>rt -C 200/200/255 -- roof</userinput>
+ </para>
+ <para>Runs the <emphasis>rt</emphasis> program to produce a color-shaded image of the object <emphasis>roof</emphasis> using MGED's current viewing parameters. The image will have a sky-blue background and will be displayed on the framebuffer specified by the FB_FILE shell variable.
+ </para>
+ </example>
+
+</refsect1>
+
+<refsect1 id='author'>
+ <title>AUTHOR</title>
+ <para>BRL-CAD Team</para>
+</refsect1>
+
+<refsect1 id='bug_reports'>
+ <title>BUG REPORTS</title>
+ <para>
+ Reports of bugs or problems should be submitted via electronic
+ mail to <de...@br...>, or via the "cadbug.sh" script.
+ </para>
+</refsect1>
+</refentry>
+
Property changes on: brlcad/trunk/doc/docbook/system/mann/en/rt.xml
___________________________________________________________________
Added: svn:mime-type
+ text/xml
Added: svn:eol-style
+ native
Added: brlcad/trunk/doc/docbook/system/mann/en/rtcheck.xml
===================================================================
--- brlcad/trunk/doc/docbook/system/mann/en/rtcheck.xml (rev 0)
+++ brlcad/trunk/doc/docbook/system/mann/en/rtcheck.xml 2010-04-05 18:31:46 UTC (rev 38329)
@@ -0,0 +1,103 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+ "../../../resources/standard/dtd/docbookx.dtd">
+
+<!-- Copyright (c) 2005-2008 United States Government as represented by -->
+<!-- the U.S. Army Research Laboratory. -->
+<!-- -->
+<!-- Redistribution and use in source (Docbook format) and 'compiled' -->
+<!-- forms (PDF, PostScript, HTML, RTF, etc), with or without -->
+<!-- modification, are permitted provided that the following conditions -->
+<!-- are met: -->
+<!-- -->
+<!-- 1. Redistributions of source code (Docbook format) must retain the -->
+<!-- above copyright notice, this list of conditions and the following -->
+<!-- disclaimer. -->
+<!-- -->
+<!-- 2. Redistributions in compiled form (transformed to other DTDs, -->
+<!-- converted to PDF, PostScript, HTML, RTF, and other formats) must -->
+<!-- reproduce the above copyright notice, this list of conditions and -->
+<!-- the following disclaimer in the documentation and/or other -->
+<!-- materials provided with the distribution. -->
+<!-- -->
+<!-- 3. The name of the author may not be used to endorse or promote -->
+<!-- products derived from this documentation without specific prior -->
+<!-- written permission. -->
+<!-- -->
+<!-- THIS DOCUMENTATION IS PROVIDED BY THE AUTHOR "AS IS" AND ANY -->
+<!-- EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -->
+<!-- IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -->
+<!-- PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR -->
+<!-- ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR -->
+<!-- CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT -->
+<!-- OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR -->
+<!-- BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF -->
+<!-- LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT -->
+<!-- (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE -->
+<!-- USE OF THIS DOCUMENTATION, EVEN IF ADVISED OF THE POSSIBILITY OF -->
+<!-- SUCH DAMAGE. -->
+
+<refentry id='rtcheck'>
+
+<refmeta>
+ <refentrytitle>RTCHECK</refentrytitle>
+ <manvolnum>nged</manvolnum>
+ <refmiscinfo class='source'>BRL-CAD</refmiscinfo>
+ <refmiscinfo class='manual'>BRL-CAD MGED Commands</refmiscinfo>
+</refmeta>
+
+<refnamediv id='name'>
+ <refname>rtcheck</refname>
+ <refpurpose>Executes the BRL-CAD <emphasis>rtcheck</emphasis> program with the default
+options of "-s50 M."</refpurpose>
+</refnamediv>
+
+<!-- body begins here -->
+<refsynopsisdiv id='synopsis'>
+ <cmdsynopsis>
+ <command>rtcheck</command>
+ <arg><replaceable>options</replaceable></arg>
+ </cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1 id='description'>
+ <title>DESCRIPTION</title>
+ <para>Executes the BRL-CAD <emphasis>rtcheck</emphasis> program with the default
+options of "-s50 M." The -M option tells <emphasis>rtcheck</emphasis> to read the viewing parameters from standard input so that rays are only fired from the current view. The current
+database name and the list of currently displayed objects are added to the end of the
+<emphasis>rtcheck</emphasis> command line. The <emphasis>rtcheck</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 <command>rrt</command> command performs a similar function, but may be used to execute other programs as well. The <emphasis>rtcheck</emphasis> program uses raytracing to check for overlapping regions in the list of objects passed on the command line. When invoked from within MGED, any discovered overlaps along a ray are represented as yellow lines that extend only in the areas of overlap. Details and a count of overlaps are also reported. Note that overlaps of less than 0.1 mm are currently ignored by <emphasis>rtcheck</emphasis>. The default option of <emphasis>-s50</emphasis> indicates that the checking rays should be fired from a uniform square grid with 50 rays on a side. This is very coarse and may miss significant overlaps. It is recommended that the user select appropriate options for the <emphasis>rtcheck</emphasis> program and execute it for a variety viewing aspects to perform a thorough check. The granularity of the grid may be controlled with the <emphasis>-s, -w, -n, -g,</emphasis> and <emphasis>-G</emphasis> options. See the <emphasis>man</emphasis> page on <emphasis>rtcheck</emphasis> for details.
+
+ </para>
+</refsect1>
+
+<refsect1 id='examples'>
+ <title>EXAMPLES</title>
+ <para>The example shows the use of the <command>rtcheck</command> command to run the <emphasis> rtcheck</emphasis> program with rays fired from a uniform grid with the rays spaced
+ every 10 mm.
+ </para>
+
+ <example>
+ <title>Run the <emphasis>rtcheck</emphasis> program to fire rays from a uniform grid with the rays spaced a specified distance apart.</title>
+ <para>
+ <prompt>mged></prompt><userinput>rtcheck -g10 -G10</userinput>
+ </para>
+ <para>Runs the <emphasis>rtcheck</emphasis> program with rays fired from a uniform grid with the rays spaced every 10 mm.
+ </para>
+ </example>
+
+</refsect1>
+
+<refsect1 id='author'>
+ <title>AUTHOR</title>
+ <para>BRL-CAD Team</para>
+</refsect1>
+
+<refsect1 id='bug_reports'>
+ <title>BUG REPORTS</title>
+ <para>
+ Reports of bugs or problems should be submitted via electronic
+ mail to <de...@br...>, or via the "cadbug.sh" script.
+ </para>
+</refsect1>
+</refentry>
+
Property changes on: brlcad/trunk/doc/docbook/system/mann/en/rtcheck.xml
___________________________________________________________________
Added: svn:mime-type
+ text/xml
Added: svn:eol-style
+ native
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|