Skip to content

Commit

Permalink
Create shaded_mode.xml man page
Browse files Browse the repository at this point in the history
  • Loading branch information
joshbaker22 authored Aug 15, 2023
1 parent d3e4dab commit d0388c3
Showing 1 changed file with 59 additions and 0 deletions.
59 changes: 59 additions & 0 deletions doc/docbook/system/mann/shaded_mode.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
<refentry xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="shaded_mode">

<refmeta>
<refentrytitle>SHADED_MODE</refentrytitle>
<manvolnum>nged</manvolnum>
<refmiscinfo class="source">BRL-CAD</refmiscinfo>
<refmiscinfo class="manual">BRL-CAD MGED Commands</refmiscinfo>
</refmeta>

<refnamediv xml:id="name">
<refname>shaded_mode</refname>
<refpurpose>
Changes the default behavior of <command>draw</command>, <command>e</command>, and <command>B</command> to use the
<emphasis>-m1</emphais> or <emphasis>-m2</emphasis> options.
</refpurpose>
</refnamediv>

<!-- body begins here -->
<refsynopsisdiv xml:id="synopsis">
<cmdsynopsis sepchar=" ">
<command>shaded_mode</command>
<arg choice="req" rep="norepeat"><replaceable>0|1|2</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>

<refsection xml:id="description"><title>DESCRIPTION</title>

<para>
The <command>shaded_mode</command> command changes the default behavior for the <command>draw</command>, <command>e</command>,
and <command>B</command> commands. An input of 1 makes <emphasis>-m1</emphasis> the default and an input of 2 makes
<emphasis>-m2</emphasis> the default. An input of 0 returns those commands to their default behavior. Lighting must be turned on
under the Misc dropdown for options 1 or 2 to work.
</para>
</refsection>

<refsection xml:id="examples"><title>EXAMPLES</title>

<example><title>Change the default draw option to -m1</title>

<para>
<prompt>mged&gt; </prompt><userinput>shaded_mode 1</userinput>
</para>
<para>The shaded mode is now set to 1 and any draw commands will use -m1 as a default option.
</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>

0 comments on commit d0388c3

Please sign in to comment.