File: curses.docbook

package info (click to toggle)
lcdproc 0.5.9-8
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 5,088 kB
  • sloc: ansic: 59,645; sh: 1,740; perl: 681; makefile: 417
file content (121 lines) | stat: -rw-r--r-- 3,059 bytes parent folder | download | duplicates (7)
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
<sect1 id="curses-howto">
<title>The curses Driver</title>

<para>This section talks about using LCDproc with the (n)curses library.
This diver displays an emulated LCD display of configurable size at a
configurable position of the terminal screen using (n)curses.</para>

<!-- ## Curses driver ## -->
<sect2 id="curses-config">
<title>Configuration in LCDd.conf</title>

<sect3 id="curses-config-section">
<title>[curses]</title>

<variablelist>
<varlistentry>
  <term>
    <property>Foreground</property> =
    <parameter><replaceable>COLOUR</replaceable></parameter>
  </term>
  <listitem>
    <para>
    Set the foreground color.
    If not given, it defaults to <literal>blue</literal>.
    </para>

    <para>
    Legal values for <replaceable>COLOUR</replaceable> are
    <literal>red</literal>, <literal>black</literal>,
    <literal>green</literal>, <literal>yellow</literal>,
    <literal>blue</literal>, <literal>magenta</literal>,
    <literal>cyan</literal> and <literal>white</literal>.
    </para>
  </listitem>
</varlistentry>

<varlistentry>
  <term>
    <property>Background</property> =
    <parameter><replaceable>COLOUR</replaceable></parameter>
  </term>
  <listitem>
    <para>
    Set the background color.
    The default is <literal>cyan</literal>.
    </para>

    <para>
    The legal values for <replaceable>COLOUR</replaceable> are
    the same as for the <property>Foreground</property> setting.
    </para>
  </listitem>
</varlistentry>

<varlistentry>
  <term>
    <property>Backlight</property> =
    <parameter><replaceable>COLOUR</replaceable></parameter>
  </term>
  <listitem>
    <para>
    Set the background color that is to be used when backlight is set on.
    backlight color. If not given, the default is <literal>red</literal>.
    </para>

    <para>
    The legal values for <replaceable>COLOUR</replaceable> are
    the same as for the <property>Foreground</property> setting.
    </para>
  </listitem>
</varlistentry>

<varlistentry>
  <term>
    <property>Size</property> = &parameters.size;
  </term>
  <listitem><para>
    display size [default: <literal>20x4</literal>]
  </para></listitem>
</varlistentry>

<varlistentry>
  <term>
    <property>TopLeftx</property> =
    <parameter><replaceable>X-OFFSET</replaceable></parameter>
  </term>
  <term>
    <property>TopLefty</property> =
    <parameter><replaceable>Y-OFFSET</replaceable></parameter>
  </term>
  <listitem><para>
    What position (X,Y) to start the left top corner at.
    Default: (7,7)
  </para></listitem>
</varlistentry>

<varlistentry>
  <term>
    <property>UseACS</property> = &parameters.yesnodef;
  </term>
  <listitem><para>
  Tell whether to use ACS (alternative character set) symbols for icons and bars
  instead of simple ASCII characters.
  </para></listitem>
</varlistentry>

<varlistentry>
  <term>
    <property>DrawBorder</property> = &parameters.yesdefno;
  </term>
  <listitem><para>
  Tell whether to draw a border around the screen.
  </para></listitem>
</varlistentry>
</variablelist>

</sect3>

</sect2>

</sect1>