File: wflinfo.1.xml

package info (click to toggle)
waffle 1.6.1-3
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 3,092 kB
  • sloc: ansic: 19,173; xml: 2,906; cpp: 489; objc: 465; sh: 100; makefile: 20
file content (206 lines) | stat: -rw-r--r-- 6,528 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
<?xml version='1.0'?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
  "file:///usr/share/xml/docbook/schema/dtd/4.2/docbookx.dtd">

<!--
  Copyright Intel 2012 - 2013

  This manual page is licensed under the Creative Commons Attribution-ShareAlike 3.0 United States License (CC BY-SA 3.0
  US). To view a copy of this license, visit http://creativecommons.org.license/by-sa/3.0/us.
-->

<refentry
    id="wflinfo"
    xmlns:xi="http://www.w3.org/2001/XInclude">

  <!-- See http://www.docbook.org/tdg/en/html/refentry.html. -->

  <refmeta>
    <refentrytitle>wflinfo</refentrytitle>
    <manvolnum>1</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>wflinfo</refname>
    <refpurpose>a utility for printing OpenGL or OpenGL ES driver information</refpurpose>
  </refnamediv>

  <refentryinfo>
    <title>wflinfo Manual</title>
    <productname>waffle</productname>
    <xi:include href="common/author-chad.versace.xml"/>
    <xi:include href="common/author-jordan.l.justen.xml"/>
    <xi:include href="common/copyright.xml"/>
    <xi:include href="common/legalnotice.xml"/>
  </refentryinfo>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>wflinfo</command>
      <arg choice="plain">
        <option>--platform=<replaceable class="parameter">platform</replaceable></option>
      </arg>
      <arg choice="plain">
        <option>--api=<replaceable class="parameter">api</replaceable></option>
      </arg>
      <arg choice="opt">
        <option><replaceable class="parameter">OPTIONS</replaceable></option>
      </arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>Description</title>

    <para>
      wflinfo is utility which creates an OpenGL or OpenGL ES context using the waffle library and
      prints information about the context.
    </para>

  </refsect1>

  <refsect1>
    <title>Required Parameters</title>

    <variablelist>
      <varlistentry>
        <term><option>-p</option> <replaceable class="parameter">platform</replaceable></term>
        <term><option>--platform=<replaceable class="parameter">platform</replaceable></option></term>
        <listitem>
          <para>
            Where <replaceable class="parameter">platform</replaceable> is
            <simplelist type="inline">
              <?dbchoice choice="or"?>
              <member>android</member>
              <member>cgl</member>
              <member>gbm</member>
              <member>glx</member>
              <member>surfaceless_egl (or short alias 'sl')</member>
              <member>wayland</member>
              <member>wgl</member>
              <member>x11_egl</member>
            </simplelist>
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-a</option> <replaceable class="parameter">api</replaceable></term>
        <term><option>--api=<replaceable class="parameter">api</replaceable></option></term>
        <listitem>
          <para>
            Where <replaceable class="parameter">api</replaceable> is
            <simplelist type="inline">
              <?dbchoice choice="or"?>
              <member>gl</member>
              <member>gles1</member>
              <member>gles2</member>
              <member>gles3</member>
            </simplelist>

          </para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1>
    <title>Options</title>
    <variablelist>
      <varlistentry>
        <term><option>-V</option> <replaceable class="parameter">MAJOR.MINOR</replaceable></term>
        <term><option>--version=<replaceable class="parameter">MAJOR.MINOR</replaceable></option></term>
        <listitem>
          <para>
            For example --api=gl --version=3.2 would request OpenGL 3.2
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--profile=<replaceable class="parameter">profile</replaceable></option></term>
        <listitem>
          <para>
            Where <replaceable class="parameter">profile</replaceable> is core, compat or none
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-v</option></term>
        <term><option>--verbose</option></term>
        <listitem>
          <para>
            Print more information
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--forward-compatible</option></term>
        <listitem>
          <para>
            Request a forward compatible context be created
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--debug-context</option></term>
        <listitem>
          <para>
            Request a debug context be created
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-f <replaceable class="parameter">format</replaceable></option></term>
        <term><option>--format=<replaceable class="parameter">format</replaceable></option></term>
        <listitem>
          <para>
            Choose the output format. Supported formats are 'original' (the default) and 'json'.
          </para>
          <para>
            The JSON format is backwards-compatible across Waffle versions.
            Future Waffle versions may add new entries to the JSON output, but will not remove existing entries.
          </para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-h</option></term>
        <term><option>--help</option></term>
        <listitem>
          <para>
            Print wflinfo usage information
          </para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1>
    <title>Examples</title>

    <para>
      <simplelist>
        <member>wflinfo --platform=glx --api=gl</member>
        <member>wflinfo --platform=x11_egl --api=gl --version=3.2 --profile=core</member>
        <member>wflinfo --platform=wayland --api=gles3</member>
        <member>wflinfo --platform=gbm --api=gl --version=3.2 --verbose</member>
        <member>wflinfo -p gbm -a gl -V 3.2 -v</member>
      </simplelist>
    </para>

  </refsect1>

  <xi:include href="common/issues.xml"/>

  <refsect1>
    <title>See Also</title>
    <para>
      <simplelist>
        <member><citerefentry><refentrytitle>waffle</refentrytitle><manvolnum>7</manvolnum></citerefentry></member>
      </simplelist>
    </para>
  </refsect1>

</refentry>

<!--
vim:tw=120 et ts=2 sw=2:
-->