-
Notifications
You must be signed in to change notification settings - Fork 145
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add man pages for ae2dir and viewdir
- Loading branch information
1 parent
b7235fa
commit 3181090
Showing
4 changed files
with
122 additions
and
1 deletion.
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
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,60 @@ | ||
| <refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="viewdir"> | ||
|
|
||
| <refmeta> | ||
| <refentrytitle>VIEWDIR</refentrytitle> | ||
| <manvolnum>nged</manvolnum> | ||
| <refmiscinfo class="source">BRL-CAD</refmiscinfo> | ||
| <refmiscinfo class="manual">BRL-CAD MGED Commands</refmiscinfo> | ||
| </refmeta> | ||
|
|
||
| <refnamediv xml:id="name"> | ||
| <refname>viewdir</refname> | ||
| <refpurpose>Returns the direction vector using the provided azimuth and elevation (AE). | ||
| </refpurpose> | ||
| </refnamediv> | ||
|
|
||
| <!-- body begins here --> | ||
| <refsynopsisdiv xml:id="synopsis"> | ||
| <cmdsynopsis sepchar=" "> | ||
| <command>viewdir</command> | ||
| <arg choice="opt" rep="norepeat">-i</arg> | ||
| <arg choice="req" rep="norepeat"><replaceable>azimuth</replaceable></arg> | ||
| <arg choice="req" rep="norepeat"><replaceable>elevation</replaceable></arg> | ||
| </cmdsynopsis> | ||
| </refsynopsisdiv> | ||
|
|
||
| <refsection xml:id="description"><title>DESCRIPTION</title> | ||
|
|
||
| <para>Returns the direction vector using the provided azimuth and elevation as input. The | ||
| <emphasis>-i</emphasis> option results in the angles supplied being interpreted as increments. | ||
| See also the <command>viewdir</command> and <command>qvrot</command> commands. | ||
|
|
||
| </para> | ||
| </refsection> | ||
|
|
||
| <refsection xml:id="examples"><title>EXAMPLES</title> | ||
|
|
||
| <para>The example shows the use of the <command>ae2dir</command> command to get the direction vector. | ||
|
|
||
| </para> | ||
| <example><title>Find the direction vector using the provided azimuth and elevation.</title> | ||
|
|
||
| <para> | ||
| <prompt>mged> </prompt><userinput>ae2dir 35 25</userinput> | ||
| </para> | ||
| <para>Returns the direction vector using an azimuth of 35 and elevation of 25. | ||
| </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> |
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
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,56 @@ | ||
| <refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="viewdir"> | ||
|
|
||
| <refmeta> | ||
| <refentrytitle>VIEWDIR</refentrytitle> | ||
| <manvolnum>nged</manvolnum> | ||
| <refmiscinfo class="source">BRL-CAD</refmiscinfo> | ||
| <refmiscinfo class="manual">BRL-CAD MGED Commands</refmiscinfo> | ||
| </refmeta> | ||
|
|
||
| <refnamediv xml:id="name"> | ||
| <refname>viewdir</refname> | ||
| <refpurpose>Returns the direction vector using the current azimuth and elevation (AE). | ||
| </refpurpose> | ||
| </refnamediv> | ||
|
|
||
| <!-- body begins here --> | ||
| <refsynopsisdiv xml:id="synopsis"> | ||
| <cmdsynopsis sepchar=" "> | ||
| <command>viewdir</command> | ||
| </cmdsynopsis> | ||
| </refsynopsisdiv> | ||
|
|
||
| <refsection xml:id="description"><title>DESCRIPTION</title> | ||
|
|
||
| <para>Returns the direction vector using the current azimuth and elevation as input. See also the | ||
| <command>ae2dir</command> and <command>qvrot</command> commands. | ||
|
|
||
| </para> | ||
| </refsection> | ||
|
|
||
| <refsection xml:id="examples"><title>EXAMPLES</title> | ||
|
|
||
| <para>The example shows the use of the <command>viewdir</command> command to get the direction vector. | ||
|
|
||
| </para> | ||
| <example><title>Find the current direction vector.</title> | ||
|
|
||
| <para> | ||
| <prompt>mged> </prompt><userinput>viewdir</userinput> | ||
| </para> | ||
| <para>Returns the direction vector using the current azimuth and elevation. | ||
| </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> |