← Back to branch summary

~ubuntu-branches/ubuntu/trusty/libconfig-model-perl/trusty

« back to all changes in this revision

Viewing changes to lib/Config/Model/models/LCDd/server.pod

  • Committer: Package Import Robot
  • Author(s): Dominique Dumont, gregor herrmann, Dominique Dumont
  • Date: 2013-05-26 12:40:30 UTC
  • mfrom: (1.3.61)
  • Revision ID: package-import@ubuntu.com-20130526124030-nfmm6ejhjubovp7v
Tags: 2.036-1
http://bugs.debian.org/709784
http://bugs.debian.org/709785
[ gregor herrmann ]
* Add =encoding to POD in dh_config_model_upgrade.

[ Dominique Dumont ]
* Imported Upstream version 2.036
  * config-edit: added deprecation warning
  * Value: fix pod doc error in L<> (Closes: #709784)
  * Node::load_data: use a predictable order to accept elements.
    This change fixes the test failure in t/backend_ini.t
    (Closes: #709785)
  * make t/pod.t run only when AUTHOR_TESTING is set

Show diffs side-by-side

added added

removed removed

Lines of Context:
lib/Config/Model/models/LCDd/server.pod
4
4
 
5
5
=head1 VERSION
6
6
 
7
 
version 2.035
 
7
version 2.036
8
8
 
9
9
=head1 DESCRIPTION
10
10
 
14
14
 
15
15
=head1 Elements
16
16
 
17
 
=head2 ReportToSyslog
18
 
 
19
 
Should we report to syslog instead of stderr ? I<< Optional. Type enum. choice: 'yes', 'no'. upstream_default: 'no'.  >>
20
 
 
21
 
=head2 ScrollDownKey
22
 
 
23
 
I<< Optional. Type uniline. default: 'Down'.  >>
24
 
 
25
17
=head2 AutoRotate
26
18
 
27
19
If set to no, LCDd will start with screen rotation disabled. This has the
29
21
if the ToggleRotateKey is pressed. Note that this setting does not turn off
30
22
priority sorting of screens. I<< Optional. Type enum. choice: 'on', 'off'. upstream_default: 'on'.  >>
31
23
 
32
 
=head2 User
33
 
 
34
 
User to run as.  LCDd will drop its root privileges, if any,
35
 
and run as this user instead.I<< Optional. Type uniline. default: 'nobody'.  >>
36
 
 
37
 
=head2 ServerScreen
38
 
 
39
 
If yes, the the serverscreen will be rotated as a usual info screen. If no,
40
 
it will be a background screen, only visible when no other screens are
41
 
active. The special value 'blank' is similar to no, but only a blank screen
42
 
is displayed. I<< Optional. Type enum. choice: 'on', 'off', 'blank'. upstream_default: 'on'.  >>
43
 
 
44
 
=head2 WaitTime
45
 
 
46
 
Sets the default time in seconds to displays a screen.I<< Optional. Type integer. default: '5'.  >>
47
 
 
48
 
=head2 ToggleRotateKey
49
 
 
50
 
The "...Key=" lines define what the server does with keypresses that
51
 
don't go to any client. The ToggleRotateKey stops rotation of screens, while
52
 
the PrevScreenKey and NextScreenKey go back / forward one screen (even if
53
 
rotation is disabled.
54
 
Assign the key string returned by the driver to the ...Key setting. These
55
 
are the defaults:I<< Optional. Type uniline. default: 'Enter'.  >>
56
 
 
57
 
=head2 Foreground
58
 
 
59
 
The server will stay in the foreground if set to true.I<< Optional. Type uniline. default: 'no'.  >>
60
 
 
61
 
=head2 Hello
62
 
 
63
 
I<< Optional. Type list of uniline.  >>
64
 
 
65
 
=head2 PrevScreenKey
66
 
 
67
 
I<< Optional. Type uniline. default: 'Left'.  >>
68
 
 
69
 
=head2 NextScreenKey
70
 
 
71
 
I<< Optional. Type uniline. default: 'Right'.  >>
72
 
 
73
 
=head2 Bind
74
 
 
75
 
Tells the driver to bind to the given interface. I<< Optional. Type uniline. default: '127.0.0.1'.  >>
76
 
 
77
 
=head2 ScrollUpKey
78
 
 
79
 
I<< Optional. Type uniline. default: 'Up'.  >>
80
 
 
81
 
=head2 GoodBye
82
 
 
83
 
I<< Optional. Type list of uniline.  >>
84
 
 
85
 
=head2 Port
86
 
 
87
 
Listen on this specified port; defaults to 13666.I<< Optional. Type integer. default: '13666'.  >>
88
 
 
89
 
=head2 DriverPath
90
 
 
91
 
Where can we find the driver modules ?
92
 
IMPORTANT: Make sure to change this setting to reflect your
93
 
           specific setup! Otherwise LCDd won't be able to find
94
 
           the driver modules and will thus not be able to
95
 
           function properly.
96
 
NOTE: Always place a slash as last character !I<< Optional. Type uniline. default: 'server/drivers/'.  >>
97
 
 
98
24
=head2 Backlight
99
25
 
100
26
Set master backlight setting. If set to 'open' a client may control the
101
27
backlight for its own screens (only). I<< Optional. Type enum. choice: 'off', 'open', 'on'. upstream_default: 'open'.  >>
102
28
 
103
 
=head2 Heartbeat
104
 
 
105
 
Set master heartbeat setting. If set to 'open' a client may control the
106
 
heartbeat for its own screens (only). I<< Optional. Type enum. choice: 'off', 'open', 'on'. upstream_default: 'open'.  >>
107
 
 
108
 
=head2 ReportLevel
109
 
 
110
 
Sets the reporting level; defaults to 2 (warnings and errors only).I<< Optional. Type integer. default: '3'.  >>
 
29
=head2 Bind
 
30
 
 
31
Tells the driver to bind to the given interface. I<< Optional. Type uniline. default: '127.0.0.1'.  >>
111
32
 
112
33
=head2 Driver
113
34
 
126
47
  pyramid, sed1330, sed1520, serialPOS, serialVFD, shuttleVFD, sli,
127
48
  stv5730, svga, t6963, text, tyan, ula200, vlsys_m428, xosd. I<< Optional. Type enum. choice: 'bayrad', 'CFontz', 'CFontzPacket', 'curses', 'CwLnx', 'ea65', 'EyeboxOne', 'g15', 'glcdlib', 'glk', 'hd44780', 'icp_a106', 'imon', 'imonlcd', 'IOWarrior', 'irman', 'joy', 'lb216', 'lcdm001', 'lcterm', 'lirc', 'lis', 'MD8800', 'mdm166a', 'ms6931', 'mtc_s16209x', 'MtxOrb', 'mx5000', 'NoritakeVFD', 'picolcd', 'pyramid', 'sed1330', 'sed1520', 'serialPOS', 'serialVFD', 'shuttleVFD', 'sli', 'stv5730', 'svga', 't6963', 'text', 'tyan', 'ula200', 'vlsys_m428', 'xosd'.  >>
128
49
 
 
50
=head2 DriverPath
 
51
 
 
52
Where can we find the driver modules ?
 
53
IMPORTANT: Make sure to change this setting to reflect your
 
54
           specific setup! Otherwise LCDd won't be able to find
 
55
           the driver modules and will thus not be able to
 
56
           function properly.
 
57
NOTE: Always place a slash as last character !I<< Optional. Type uniline. default: 'server/drivers/'.  >>
 
58
 
 
59
=head2 Foreground
 
60
 
 
61
The server will stay in the foreground if set to true.I<< Optional. Type uniline. default: 'no'.  >>
 
62
 
 
63
=head2 GoodBye
 
64
 
 
65
I<< Optional. Type list of uniline.  >>
 
66
 
 
67
=head2 Heartbeat
 
68
 
 
69
Set master heartbeat setting. If set to 'open' a client may control the
 
70
heartbeat for its own screens (only). I<< Optional. Type enum. choice: 'off', 'open', 'on'. upstream_default: 'open'.  >>
 
71
 
 
72
=head2 Hello
 
73
 
 
74
I<< Optional. Type list of uniline.  >>
 
75
 
 
76
=head2 NextScreenKey
 
77
 
 
78
I<< Optional. Type uniline. default: 'Right'.  >>
 
79
 
 
80
=head2 Port
 
81
 
 
82
Listen on this specified port; defaults to 13666.I<< Optional. Type integer. default: '13666'.  >>
 
83
 
 
84
=head2 PrevScreenKey
 
85
 
 
86
I<< Optional. Type uniline. default: 'Left'.  >>
 
87
 
 
88
=head2 ReportLevel
 
89
 
 
90
Sets the reporting level; defaults to 2 (warnings and errors only).I<< Optional. Type integer. default: '3'.  >>
 
91
 
 
92
=head2 ReportToSyslog
 
93
 
 
94
Should we report to syslog instead of stderr ? I<< Optional. Type enum. choice: 'yes', 'no'. upstream_default: 'no'.  >>
 
95
 
 
96
=head2 ScrollDownKey
 
97
 
 
98
I<< Optional. Type uniline. default: 'Down'.  >>
 
99
 
 
100
=head2 ScrollUpKey
 
101
 
 
102
I<< Optional. Type uniline. default: 'Up'.  >>
 
103
 
 
104
=head2 ServerScreen
 
105
 
 
106
If yes, the the serverscreen will be rotated as a usual info screen. If no,
 
107
it will be a background screen, only visible when no other screens are
 
108
active. The special value 'blank' is similar to no, but only a blank screen
 
109
is displayed. I<< Optional. Type enum. choice: 'on', 'off', 'blank'. upstream_default: 'on'.  >>
 
110
 
129
111
=head2 TitleSpeed
130
112
 
131
113
set title scrolling speed I<< Optional. Type integer. upstream_default: '10'.  >>
132
114
 
 
115
=head2 ToggleRotateKey
 
116
 
 
117
The "...Key=" lines define what the server does with keypresses that
 
118
don't go to any client. The ToggleRotateKey stops rotation of screens, while
 
119
the PrevScreenKey and NextScreenKey go back / forward one screen (even if
 
120
rotation is disabled.
 
121
Assign the key string returned by the driver to the ...Key setting. These
 
122
are the defaults:I<< Optional. Type uniline. default: 'Enter'.  >>
 
123
 
 
124
=head2 User
 
125
 
 
126
User to run as.  LCDd will drop its root privileges, if any,
 
127
and run as this user instead.I<< Optional. Type uniline. default: 'nobody'.  >>
 
128
 
 
129
=head2 WaitTime
 
130
 
 
131
Sets the default time in seconds to displays a screen.I<< Optional. Type integer. default: '5'.  >>
 
132
 
133
133
=head1 SEE ALSO
134
134
 
135
135
=over