← Back to branch summary

~benklop/+junk/lcdproc

« back to all changes in this revision

Viewing changes to docs/lcdproc-user/drivers/glcdlib.docbook

  • Committer: Bazaar Package Importer
  • Author(s): Jeremy Yoder (Launchpad)
  • Date: 2009-10-11 18:21:07 UTC
  • mfrom: (1.1.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20091011182107-twnkyhv1f63lzq3o
Tags: 0.5.3-0ubuntu1
https://launchpad.net/bugs/432669
* New upstream version 0.5.3 (LP: #432669)
* Merge source patches from 0.5.2-3 
  - LCDd.conf: Change driver path
  - clients/lcdproc/machine_Linux.c: Change ifdef
* Add clients/examples/lcdident.pl to debian files 
* Updated debian/rules:
  - Cleaned up whitespace
  - Changed config.guess/config.sub lines 
* Added a delay to server/drivers/imonlcd.c for slower models
* Added dependency on autotools-dev to fix launchpad build issue 

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/lcdproc-user/drivers/glcdlib.docbook
1
1
<sect1 id="glcdlib-howto">
 
2
<sect1info>
 
3
  <author>
 
4
    <firstname>Lucian</firstname>
 
5
    <surname>Muresan</surname>
 
6
  </author>
 
7
</sect1info>
2
8
<title>The glcdlib Driver</title>
3
9
 
4
10
<para>
5
 
This section talks about using LCDproc with LCD displays that use the
6
 
glcdlib chipset.
 
11
This section talks about using LCDproc with LCD displays supported by
 
12
graphlcd-base.
7
13
</para>
8
14
 
9
15
<sect2 id="glcdlib-connections">
20
26
before configuring the LCDproc build process --enable-drivers=glcdlib.
21
27
</para>
22
28
 
23
 
Author
24
 
<author>
25
 
<firstname>Lucian</firstname>
26
 
<surname>Muresan</surname>
27
 
</author>
28
 
 
29
29
</sect2>
30
30
 
31
31
<!-- ## glcdlib meta driver for graphical LCDs ## -->
35
35
<sect3 id="glcdlib-config-section">
36
36
<title>[glcdlib]</title>
37
37
 
38
 
## mandatory:
39
 
 
40
38
<variablelist>
 
39
<title>Mandatory settings</title>
41
40
<varlistentry>
42
41
  <term>
43
 
    <command>Driver=</command>
44
 
    <arg choice="plain"><replaceable>GRAPHLCD-DRIVER</replaceable></arg>
 
42
    <property>Driver</property> =
 
43
    <parameter><replaceable>GRAPHLCD-DRIVER</replaceable></parameter>
45
44
  </term>
46
45
  <listitem><para>
47
46
    Specify which graphical display supported by graphlcd-base to use.
58
57
 
59
58
<varlistentry>
60
59
  <term>
61
 
    <command>UseFT2=</command>
62
 
    <arg choice="plain">
63
 
    <group choice="req">
64
 
      <arg choice="plain"><literal>yes</literal></arg>
65
 
      <arg choice="plain"><literal><emphasis>no</emphasis></literal></arg>
66
 
    </group>
67
 
    </arg>
 
60
    <property>UseFT2</property> = &parameters.yesdefno;
68
61
  </term>
69
62
  <listitem><para>
70
63
    Tell whether to use FreeType2 or not.
79
72
 
80
73
<varlistentry>
81
74
  <term>
82
 
    <command>TextResolution=</command>
83
 
    <arg choice="plain">
84
 
      <replaceable>WIDTH</replaceable>
85
 
      <literal>x</literal>
86
 
      <replaceable>HEIGHT</replaceable>
87
 
    </arg>
 
75
    <property>TextResolution</property> = &parameters.size;
88
76
  </term>
89
77
  <listitem><para>
90
78
    Give text resolution in fixed width characters. If it won't fit according
96
84
 
97
85
<varlistentry>
98
86
  <term>
99
 
    <command>FontFile=</command>
100
 
    <arg choice="plain"><replaceable>FILENAME</replaceable></arg>
 
87
    <property>FontFile</property> =
 
88
    <parameter><replaceable>FILENAME</replaceable></parameter>
101
89
  </term>
102
90
  <listitem><para>
103
91
    Set path to font file to use, e.g. <filename>/usr/share/fonts/corefonts/courbd.ttf</filename>.
105
93
</varlistentry>
106
94
</variablelist>
107
95
 
108
 
 
109
 
The following parameters only apply if <command>UseFT2=</command><literal>yes</literal>:
110
 
 
111
96
<variablelist>
 
97
<title>Availalble parameters if <property>UseFT2</property> = <literal>yes</literal></title>
112
98
<varlistentry>
113
99
  <term>
114
 
    <command>CharEncoding=</command>
115
 
    <arg choice="plain"><replaceable>CHARSET</replaceable></arg>
 
100
    <property>CharEncoding</property> =
 
101
    <parameter><replaceable>CHARSET</replaceable></parameter>
116
102
  </term>
117
103
  <listitem><para>
118
104
    Specify character encoding to use, e.g. <literal>iso8859-2</literal>.
122
108
 
123
109
<varlistentry>
124
110
  <term>
125
 
    <command>MinFontFaceSize=</command>
126
 
    <arg choice="plain">
 
111
    <property>MinFontFaceSize</property> =
 
112
    <parameter>
127
113
      <replaceable>COLUMNS</replaceable>
128
114
      <literal>x</literal>
129
115
      <replaceable>ROWS</replaceable>
130
 
    </arg>
 
116
    </parameter>
131
117
  </term>
132
118
  <listitem><para>
133
 
    minumum size in pixels in which fonts should be rendered
 
119
    minimum size in pixels in which fonts should be rendered
134
120
  </para></listitem>
135
121
</varlistentry>
136
 
 
137
 
 
138
 
## optional:
 
122
</variablelist>
 
123
 
 
124
<variablelist>
 
125
<title>Optional settings</title>
139
126
<varlistentry>
140
127
  <term>
141
 
    <command>Brightness=</command>
142
 
    <arg choice="plain"><replaceable>BRIGHTNESS</replaceable></arg>
 
128
    <property>Brightness</property> =
 
129
    <parameter><replaceable>BRIGHTNESS</replaceable></parameter>
143
130
  </term>
144
131
  <listitem><para>
145
132
    Brightness (in %) if applicable
150
137
 
151
138
<varlistentry>
152
139
  <term>
153
 
    <command>Contrast=</command>
154
 
    <arg choice="plain"><replaceable>CONTRAST</replaceable></arg>
 
140
    <property>Contrast</property> =
 
141
    <parameter><replaceable>CONTRAST</replaceable></parameter>
155
142
  </term>
156
143
  <listitem><para>
157
144
    Set the contrast (in %) if applicable.
162
149
 
163
150
<varlistentry>
164
151
  <term>
165
 
    <command>Backlight=</command>
166
 
    <arg choice="plain">
167
 
    <group choice="req">
168
 
      <arg choice="plain"><literal>yes</literal></arg>
169
 
      <arg choice="plain"><literal><emphasis>no</emphasis></literal></arg>
170
 
    </group>
171
 
    </arg>
 
152
    <property>Backlight</property> = &parameters.yesnodef;
172
153
  </term>
173
154
  <listitem><para>
174
155
    Backlight if applicable
177
158
 
178
159
<varlistentry>
179
160
  <term>
180
 
    <command>UpsideDown=</command>
181
 
    <arg choice="plain">
182
 
    <group choice="req">
183
 
      <arg choice="plain"><literal>yes</literal></arg>
184
 
      <arg choice="plain"><literal><emphasis>no</emphasis></literal></arg>
185
 
    </group>
186
 
    </arg>
 
161
    <property>UpsideDown</property> = &parameters.yesnodef;
187
162
  </term>
188
163
  <listitem><para>
189
164
    flip image upside down
192
167
 
193
168
<varlistentry>
194
169
  <term>
195
 
    <command>Invert=</command>
196
 
    <arg choice="plain">
197
 
    <group choice="req">
198
 
      <arg choice="plain"><literal>yes</literal></arg>
199
 
      <arg choice="plain"><literal><emphasis>no</emphasis></literal></arg>
200
 
    </group>
201
 
    </arg>
 
170
    <property>Invert</property> = &parameters.yesnodef;
202
171
  </term>
203
172
  <listitem><para>
204
173
    invert light/dark pixels
207
176
 
208
177
<varlistentry>
209
178
  <term>
210
 
    <command>ShowDebugFrame=</command>
211
 
    <arg choice="plain">
212
 
    <group choice="req">
213
 
      <arg choice="plain"><literal>yes</literal></arg>
214
 
      <arg choice="plain"><literal><emphasis>no</emphasis></literal></arg>
215
 
    </group>
216
 
    </arg>
 
179
    <property>ShowDebugFrame</property> = &parameters.yesnodef;
217
180
  </term>
218
181
  <listitem><para>
219
182
    turns on/off 1 pixel thick debugging
225
188
 
226
189
<varlistentry>
227
190
  <term>
228
 
    <command>ShowBigBorder=</command>
229
 
    <arg choice="plain">
230
 
    <group choice="req">
231
 
      <arg choice="plain"><literal>yes</literal></arg>
232
 
      <arg choice="plain"><literal><emphasis>no</emphasis></literal></arg>
233
 
    </group>
234
 
    </arg>
235
 
  </term>
236
 
  <listitem><para>
237
 
    border around the unused area
238
 
  </para></listitem>
239
 
</varlistentry>
240
 
 
241
 
<varlistentry>
242
 
  <term>
243
 
    <command>ShowThinBorder=</command>
244
 
    <arg choice="plain">
245
 
    <group choice="req">
246
 
      <arg choice="plain"><literal>yes</literal></arg>
247
 
      <arg choice="plain"><literal><emphasis>no</emphasis></literal></arg>
248
 
    </group>
249
 
    </arg>
250
 
  </term>
251
 
  <listitem><para>
252
 
    border around the unused area
253
 
  </para></listitem>
254
 
</varlistentry>
255
 
 
256
 
<varlistentry>
257
 
  <term>
258
 
    <command>PixelShiftX=<replaceable>0</replaceable></command>
259
 
  </term>
260
 
  <term>
261
 
    <command>PixelShiftY=<replaceable>2</replaceable></command>
262
 
  </term>
263
 
  <listitem><para>
 
191
    <property>ShowBigBorder</property> = &parameters.yesnodef;
 
192
  </term>
 
193
  <listitem><para>
 
194
    border around the unused area
 
195
  </para></listitem>
 
196
</varlistentry>
 
197
 
 
198
<varlistentry>
 
199
  <term>
 
200
    <property>ShowThinBorder</property> = &parameters.yesnodef;
 
201
  </term>
 
202
  <listitem><para>
 
203
    border around the unused area
 
204
  </para></listitem>
 
205
</varlistentry>
 
206
 
 
207
<varlistentry>
 
208
  <term>
 
209
    <property>PixelShiftX</property> =
 
210
    <parameter><replaceable>SHIFTX</replaceable></parameter>
 
211
  </term>
 
212
  <term>
 
213
    <property>PixelShiftY</property> =
 
214
    <parameter><replaceable>SHIFTY</replaceable></parameter>
 
215
  </term>
 
216
  <listitem><para>
 
217
    Shifts the content of the display by <replaceable>SHIFTX</replaceable>
 
218
    (default: <literal>0</literal>) and <replaceable>SHIFTY</replaceable>
 
219
    (default: <literal>0</literal>) pixels.
264
220
  </para></listitem>
265
221
</varlistentry>
266
222
</variablelist>