rename upstream-man-pages to upstream-doc

[clinton/guile-figl.git] / upstream-doc / man2 / gluQuadricNormals.xml

diff --git a/upstream-doc/man2/gluQuadricNormals.xml b/upstream-doc/man2/gluQuadricNormals.xml
new file mode 100644 (file)
index 0000000..afb8abc
--- /dev/null
+++ b/upstream-doc/man2/gluQuadricNormals.xml
@@ -0,0 +1,101 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook MathML Module V1.1b1//EN"
+              "http://www.oasis-open.org/docbook/xml/mathml/1.1CR1/dbmathml.dtd">
+<refentry id="gluQuadricNormals">
+    <refmeta>
+        <refmetainfo>
+            <copyright>
+                <year>1991-2006</year>
+                <holder>Silicon Graphics, Inc.</holder>
+            </copyright>
+        </refmetainfo>
+        <refentrytitle>gluQuadricNormals</refentrytitle>
+        <manvolnum>3G</manvolnum>
+    </refmeta>
+    <refnamediv>
+        <refname>gluQuadricNormals</refname>
+        <refpurpose>specify what kind of normals are desired for quadrics</refpurpose>
+    </refnamediv>
+    <refsynopsisdiv><title>C Specification</title>
+        <funcsynopsis>
+            <funcprototype>
+                <funcdef>void <function>gluQuadricNormals</function></funcdef>
+                <paramdef>GLUquadric* <parameter>quad</parameter></paramdef>
+                <paramdef>GLenum <parameter>normal</parameter></paramdef>
+            </funcprototype>
+        </funcsynopsis>
+    </refsynopsisdiv>
+    <!-- eqn: ignoring delim $$ -->
+    <refsect1 id="parameters"><title>Parameters</title>
+        <variablelist>
+        <varlistentry>
+            <term><parameter>quad</parameter></term>
+            <listitem>
+                <para>
+                    Specifies the quadrics object (created with <citerefentry><refentrytitle>gluNewQuadric</refentrytitle></citerefentry>).
+                </para>
+            </listitem>
+        </varlistentry>
+        <varlistentry>
+            <term><parameter>normal</parameter></term>
+            <listitem>
+                <para>
+                    Specifies the desired type of normals. Valid values are
+                    <constant>GLU_NONE</constant>,
+                    <constant>GLU_FLAT</constant>, and
+                    <constant>GLU_SMOOTH</constant>.
+                </para>
+            </listitem>
+        </varlistentry>
+        </variablelist>
+    </refsect1>
+    <refsect1 id="description"><title>Description</title>
+        <para>
+            <function>gluQuadricNormals</function> specifies what kind of normals are desired for quadrics rendered with
+            <parameter>quad</parameter>. The legal values are as follows:
+        </para>
+        <variablelist>
+            <varlistentry>
+                <term><constant>GLU_NONE</constant></term>
+                <listitem>
+                    <para>
+                        No normals are generated.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term><constant>GLU_FLAT</constant></term>
+                <listitem>
+                    <para>
+                        One normal is generated for every facet of a quadric.
+                    </para>
+                </listitem>
+            </varlistentry>
+            <varlistentry>
+                <term><constant>GLU_SMOOTH</constant></term>
+                <listitem>
+                    <para>
+                        One normal is generated for every vertex of a quadric. This is the
+                        initial value.
+                    </para>
+                </listitem>
+            </varlistentry>
+        </variablelist>
+    </refsect1>
+    <refsect1 id="seealso"><title>See Also</title>
+        <para>
+            <citerefentry><refentrytitle>gluNewQuadric</refentrytitle></citerefentry>,
+            <citerefentry><refentrytitle>gluQuadricDrawStyle</refentrytitle></citerefentry>,
+            <citerefentry><refentrytitle>gluQuadricOrientation</refentrytitle></citerefentry>,
+            <citerefentry><refentrytitle>gluQuadricTexture</refentrytitle></citerefentry>
+        </para>
+    </refsect1>
+    <refsect1 id="Copyright"><title>Copyright</title>
+        <para>
+            Copyright <trademark class="copyright"></trademark> 1991-2006
+            Silicon Graphics, Inc. This document is licensed under the SGI
+            Free Software B License. For details, see
+            <ulink url="http://oss.sgi.com/projects/FreeB/">http://oss.sgi.com/projects/FreeB/</ulink>.
+        </para>
+    </refsect1>
+</refentry>