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>surfaceless_egl (or short alias 'sl')</member>
  79               <member>wayland</member>
  80               <member>wgl</member>
  81               <member>x11_egl</member>
  82             </simplelist>
  83           </para>
  84         </listitem>
  85       </varlistentry>
  86       <varlistentry>
  87         <term><option>-a</option> <replaceable class="parameter">api</replaceable></term>
  88         <term><option>--api=<replaceable class="parameter">api</replaceable></option></term>
  89         <listitem>
  90           <para>
  91             Where <replaceable class="parameter">api</replaceable> is
  92             <simplelist type="inline">
  93               <?dbchoice choice="or"?>
  94               <member>gl</member>
  95               <member>gles1</member>
  96               <member>gles2</member>
  97               <member>gles3</member>
  98             </simplelist>
  99
 100           </para>
 101         </listitem>
 102       </varlistentry>
 103     </variablelist>
 104   </refsect1>
 105
 106   <refsect1>
 107     <title>Options</title>
 108     <variablelist>
 109       <varlistentry>
 110         <term><option>-V</option> <replaceable class="parameter">MAJOR.MINOR</replaceable></term>
 111         <term><option>--version=<replaceable class="parameter">MAJOR.MINOR</replaceable></option></term>
 112         <listitem>
 113           <para>
 114             For example --api=gl --version=3.2 would request OpenGL 3.2
 115           </para>
 116         </listitem>
 117       </varlistentry>
 118       <varlistentry>
 119         <term><option>--profile=<replaceable class="parameter">profile</replaceable></option></term>
 120         <listitem>
 121           <para>
 122             Where <replaceable class="parameter">profile</replaceable> is core, compat or none
 123           </para>
 124         </listitem>
 125       </varlistentry>
 126       <varlistentry>
 127         <term><option>-v</option></term>
 128         <term><option>--verbose</option></term>
 129         <listitem>
 130           <para>
 131             Print more information
 132           </para>
 133         </listitem>
 134       </varlistentry>
 135       <varlistentry>
 136         <term><option>--forward-compatible</option></term>
 137         <listitem>
 138           <para>
 139             Request a forward compatible context be created
 140           </para>
 141         </listitem>
 142       </varlistentry>
 143       <varlistentry>
 144         <term><option>--debug-context</option></term>
 145         <listitem>
 146           <para>
 147             Request a debug context be created
 148           </para>
 149         </listitem>
 150       </varlistentry>
 151       <varlistentry>
 152         <term><option>-f <replaceable class="parameter">format</replaceable></option></term>
 153         <term><option>--format=<replaceable class="parameter">format</replaceable></option></term>
 154         <listitem>
 155           <para>
 156             Choose the output format. Supported formats are 'original' (the default) and 'json'.
 157           </para>
 158           <para>
 159             The JSON format is backwards-compatible across Waffle versions.
 160             Future Waffle versions may add new entries to the JSON output, but will not remove existing entries.
 161           </para>
 162         </listitem>
 163       </varlistentry>
 164       <varlistentry>
 165         <term><option>-h</option></term>
 166         <term><option>--help</option></term>
 167         <listitem>
 168           <para>
 169             Print wflinfo usage information
 170           </para>
 171         </listitem>
 172       </varlistentry>
 173     </variablelist>
 174   </refsect1>
 175
 176   <refsect1>
 177     <title>Examples</title>
 178
 179     <para>
 180       <simplelist>
 181         <member>wflinfo --platform=glx --api=gl</member>
 182         <member>wflinfo --platform=x11_egl --api=gl --version=3.2 --profile=core</member>
 183         <member>wflinfo --platform=wayland --api=gles3</member>
 184         <member>wflinfo --platform=gbm --api=gl --version=3.2 --verbose</member>
 185         <member>wflinfo -p gbm -a gl -V 3.2 -v</member>
 186       </simplelist>
 187     </para>
 188
 189   </refsect1>
 190
 191   <xi:include href="common/issues.xml"/>
 192
 193   <refsect1>
 194     <title>See Also</title>
 195     <para>
 196       <simplelist>
 197         <member><citerefentry><refentrytitle>waffle</refentrytitle><manvolnum>7</manvolnum></citerefentry></member>
 198       </simplelist>
 199     </para>
 200   </refsect1>
 201
 202 </refentry>
 203
 204 <!--
 205 vim:tw=120 et ts=2 sw=2:
 206 -->