man/wflinfo.1.xml

   1 <?xml version='1.0'?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   3   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   4
   5 <!--
   6   Copyright Intel 2012 - 2013
   7
   8   This manual page is licensed under the Creative Commons Attribution-ShareAlike 3.0 United States License (CC BY-SA 3.0
   9   US). To view a copy of this license, visit http://creativecommons.org.license/by-sa/3.0/us.
  10 -->
  11
  12 <refentry
  13     id="wflinfo"
  14     xmlns:xi="http://www.w3.org/2001/XInclude">
  15
  16   <!-- See http://www.docbook.org/tdg/en/html/refentry.html. -->
  17
  18   <refmeta>
  19     <refentrytitle>wflinfo</refentrytitle>
  20     <manvolnum>1</manvolnum>
  21   </refmeta>
  22
  23   <refnamediv>
  24     <refname>wflinfo</refname>
  25     <refpurpose>a utility for printing OpenGL or OpenGL ES driver information</refpurpose>
  26   </refnamediv>
  27
  28   <refentryinfo>
  29     <title>wflinfo Manual</title>
  30     <productname>waffle</productname>
  31     <xi:include href="common/author-chad.versace.xml"/>
  32     <xi:include href="common/author-jordan.l.justen.xml"/>
  33     <xi:include href="common/copyright.xml"/>
  34     <xi:include href="common/legalnotice.xml"/>
  35   </refentryinfo>
  36
  37   <refsynopsisdiv>
  38     <cmdsynopsis>
  39       <command>wflinfo</command>
  40       <arg choice="plain">
  41         <option>--platform=<replaceable class="parameter">platform</replaceable></option>
  42       </arg>
  43       <arg choice="plain">
  44         <option>--api=<replaceable class="parameter">api</replaceable></option>
  45       </arg>
  46       <arg choice="opt">
  47         <option><replaceable class="parameter">OPTIONS</replaceable></option>
  48       </arg>
  49     </cmdsynopsis>
  50   </refsynopsisdiv>
  51
  52   <refsect1>
  53     <title>Description</title>
  54
  55     <para>
  56       wflinfo is utility which creates an OpenGL or OpenGL ES context using the waffle library and
  57       prints information about the context.
  58     </para>
  59
  60   </refsect1>
  61
  62   <refsect1>
  63     <title>Required Parameters</title>
  64
  65     <variablelist>
  66       <varlistentry>
  67         <term><option>-p</option> <replaceable class="parameter">platform</replaceable></term>
  68         <term><option>--platform=<replaceable class="parameter">platform</replaceable></option></term>
  69         <listitem>
  70           <para>
  71             Where <replaceable class="parameter">platform</replaceable> is
  72             <simplelist type="inline">
  73               <?dbchoice choice="or"?>
  74               <member>android</member>
  75               <member>cgl</member>
  76               <member>gbm</member>
  77               <member>glx</member>
  78               <member>wayland</member>
  79               <member>wgl</member>
  80               <member>x11_egl</member>
  81             </simplelist>
  82           </para>
  83         </listitem>
  84       </varlistentry>
  85       <varlistentry>
  86         <term><option>-a</option> <replaceable class="parameter">api</replaceable></term>
  87         <term><option>--api=<replaceable class="parameter">api</replaceable></option></term>
  88         <listitem>
  89           <para>
  90             Where <replaceable class="parameter">api</replaceable> is
  91             <simplelist type="inline">
  92               <?dbchoice choice="or"?>
  93               <member>gl</member>
  94               <member>gles1</member>
  95               <member>gles2</member>
  96               <member>gles3</member>
  97             </simplelist>
  98
  99           </para>
 100         </listitem>
 101       </varlistentry>
 102     </variablelist>
 103   </refsect1>
 104
 105   <refsect1>
 106     <title>Options</title>
 107     <variablelist>
 108       <varlistentry>
 109         <term><option>-V</option> <replaceable class="parameter">MAJOR.MINOR</replaceable></term>
 110         <term><option>--version=<replaceable class="parameter">MAJOR.MINOR</replaceable></option></term>
 111         <listitem>
 112           <para>
 113             For example --api=gl --version=3.2 would request OpenGL 3.2
 114           </para>
 115         </listitem>
 116       </varlistentry>
 117       <varlistentry>
 118         <term><option>--profile=<replaceable class="parameter">profile</replaceable></option></term>
 119         <listitem>
 120           <para>
 121             Where <replaceable class="parameter">profile</replaceable> is core, compat or none
 122           </para>
 123         </listitem>
 124       </varlistentry>
 125       <varlistentry>
 126         <term><option>-v</option></term>
 127         <term><option>--verbose</option></term>
 128         <listitem>
 129           <para>
 130             Print more information
 131           </para>
 132         </listitem>
 133       </varlistentry>
 134       <varlistentry>
 135         <term><option>--forward-compatible</option></term>
 136         <listitem>
 137           <para>
 138             Request a forward compatible context be created
 139           </para>
 140         </listitem>
 141       </varlistentry>
 142       <varlistentry>
 143         <term><option>--debug-context</option></term>
 144         <listitem>
 145           <para>
 146             Request a debug context be created
 147           </para>
 148         </listitem>
 149       </varlistentry>
 150       <varlistentry>
 151         <term><option>-h</option></term>
 152         <term><option>--help</option></term>
 153         <listitem>
 154           <para>
 155             Print wflinfo usage information
 156           </para>
 157         </listitem>
 158       </varlistentry>
 159     </variablelist>
 160   </refsect1>
 161
 162   <refsect1>
 163     <title>Examples</title>
 164
 165     <para>
 166       <simplelist>
 167         <member>wflinfo --platform=glx --api=gl</member>
 168         <member>wflinfo --platform=x11_egl --api=gl --version=3.2 --profile=core</member>
 169         <member>wflinfo --platform=wayland --api=gles3</member>
 170         <member>wflinfo --platform=gbm --api=gl --version=3.2 --verbose</member>
 171         <member>wflinfo -p gbm -a gl -V 3.2 -v</member>
 172       </simplelist>
 173     </para>
 174
 175   </refsect1>
 176
 177   <xi:include href="common/issues.xml"/>
 178
 179   <refsect1>
 180     <title>See Also</title>
 181     <para>
 182       <simplelist>
 183         <member><citerefentry><refentrytitle>waffle</refentrytitle><manvolnum>7</manvolnum></citerefentry></member>
 184       </simplelist>
 185     </para>
 186   </refsect1>
 187
 188 </refentry>
 189
 190 <!--
 191 vim:tw=120 et ts=2 sw=2:
 192 -->