Remove two calls backlight_lcd_sleep_countdown() more, this time in backlight.c
[kugel-rb.git] / manual / plugins / clock.tex
blob034004e947cca768a9b2878f5d3ddd9410f852ec
1 \subsection{Clock}
2 \screenshot{plugins/images/ss-clock}{Clock}{img:clock}
4 This is a fully featured analogue and digital clock plugin.
6 \subsubsection{Key configuration}
8 \begin{table}
9 \begin{btnmap}{}{}
10 \ButtonLeft{} / \ButtonRight
11 & Cycle through modes \\
12 \opt{RECORDER_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD,GIGABEAT_PAD%
13 ,MROBE100_PAD}{\ButtonUp{} / \ButtonDown}
14 \opt{IPOD_3G_PAD,IPOD_4G_PAD,SANSA_E200_PAD}{\ButtonScrollFwd{} / \ButtonScrollBack}
15 \opt{SANSA_C200_PAD}{\ButtonVolUp{} / \ButtonVolDown}
16 \opt{IRIVER_H10_PAD}{\ButtonScrollUp{} / \ButtonScrollDown}
17 & Cycle through skins \\
18 \opt{RECORDER_PAD}{\ButtonFOne}
19 \opt{IAUDIO_X5_PAD}{\ButtonRec}
20 \opt{IRIVER_H300_PAD}{\ButtonMode}
21 \opt{IPOD_4G_PAD,IPOD_3G_PAD,GIGABEAT_PAD,MROBE100_PAD}{\ButtonMenu}
22 \opt{SANSA_C200_PAD,SANSA_E200_PAD}{\ButtonDown}
23 \opt{IRIVER_H10_PAD}{\ButtonFF}
24 & Main Menu \\
25 \opt{RECORDER_PAD}{\ButtonPlay}
26 \opt{IRIVER_H10_PAD}{\ButtonRew}
27 \opt{IRIVER_H300_PAD,IAUDIO_X5_PAD,IPOD_4G_PAD,IPOD_3G_PAD,SANSA_C200_PAD%
28 ,SANSA_E200_PAD,MROBE100_PAD,GIGABEAT_PAD}{\ButtonSelect}
29 & Start / Stop Counter \\
30 Long
31 \opt{RECORDER_PAD_PAD}{\ButtonPlay}%
32 \opt{IRIVER_H10_PAD}{\ButtonRew}%
33 \opt{IRIVER_H300_PAD,IAUDIO_X5_PAD,IPOD_4G_PAD,IPOD_3G_PAD,SANSA_C200_PAD%
34 ,SANSA_E200_PAD,MROBE100_PAD,GIGABEAT_PAD}{\ButtonSelect}
35 & Reset Counter \\
36 \opt{RECORDER_PAD,IRIVER_H300_PAD}{\ButtonOff}
37 \opt{IPOD_4G_PAD,IPOD_3G_PAD}{\ButtonMenu + \ButtonSelect}
38 \opt{IAUDIO_X5_PAD,IRIVER_H10_PAD,SANSA_E200_PAD,SANSA_C200_PAD,GIGABEAT_PAD%
39 ,MROBE100_PAD}{\ButtonPower}
40 & Save Settings (if enabled) and Exit \\
41 \end{btnmap}
42 \end{table}
44 \textbf{Clock Menu}
45 \begin{description}
46 \item[View Clock] Exits the menu and returns to the current clock mode display.
47 \item[Mode Selector] Opens a menu from which you can select a clock mode to view.
48 \item[Counter Settings] Opens a menu from which you can adjust settings pertaining to the counter.
49 \item[Mode Settings] Opens a menu from which you can adjust settings pertaining to
50 the current clock mode (analog, digital, binary).
51 \item[General Settings]
52 \begin{description}
53 \item[Reset Settings]
54 Reset all settings to their default values.
55 \item[Save Settings]
56 Save all settings to disk.
57 \item[Show Counter]
58 Toggle Counter display.
59 \item[Save]
60 Choose whether to disable automatic saving, saving to disk on exit, or saving to disk every settings change.
61 \item[Backlight]
62 Choose whether to disable the backlight, use the user's timeout setting, or keep the backlight on.
63 \item[Idle Poweroff]
64 Toggle Idle Poweroff.
65 \note{This setting is not saved to disk.}
66 \end{description}
67 \item[Help] Opens a brief help screen with key mappings and functionality.
68 \item[Credits] Displays a credits roll.
69 \end{description}
71 \subsubsection{Analog mode}
72 Small, round, analog clock is displayed in the middle of the LCD.
73 Time readout, if enabled, is displayed at the upper left.
74 If Time readout is in 12-hour (``12h'') mode, AM or PM will be displayed at the upper right.
75 The Date readout, if enabled, is displayed at the lower left.
76 The Counter, if enabled, is displayed at the lower right.
77 The second hand, if enabled, is displayed along with the hour and minute hands.
78 Digit display, if enabled, places ``12'', ``3'', ``6'', and ``9'' around the face of the clock in their respective positions.
80 \subsubsection{Digital mode}
81 An imitation of an LCD, this mode shows a Clock comprised of digital ``segments''.
82 The Date readout, if enabled, is displayed at the bottom, center.
83 The Second readout, if in ``Text'' mode, is displayed at the top, center; if in ``Bar'' mode, is displayed as a progress bar at the top of the LCD; if in ``Invert'' mode, will invert the LCD left-to-right as the seconds pass (a fully-inverted LCD means the entire minute has passed).
84 The Counter, if displayed, is shown at the upper left.
85 The Blinking Colon, if enabled, blinks the colon once every second.
86 12-hour mode, if enabled, will display the time in a 12-hour format.
88 \subsubsection{LCD mode}
89 Based on the Digital Mode, the LCD mode is another imitation of an LCD.
90 The settings available in this mode are exactly the same as Digital Mode, but they are independent of Digital Mode.
91 For example, you can have the Date Readout enabled in Digital Mode and disabled in LCD Mode.
93 \subsubsection{Fullscreen}
94 A Fullscreen clock is displayed. Show Border, if enabled, will draw a small box at every hour position (1 through 12).
95 Invert Seconds, if enabled, will invert the LCD as the seconds pass.
96 Second Hand, if enabled, will draw a second hand among the hour and minute hands.
98 \subsubsection{Binary mode}
99 This mode shows a Binary clock.
100 The hour is displayed on the top line, the minute is displayed on the middle line, and the seconds are on the last line.
101 Circle mode, if enabled, draws empty and full circles, instead of zeros and ones.
102 For help on reading binary, please visit: \url{http://en.wikipedia.org/wiki/Binary_numeral_system}
104 \subsubsection{Plain mode}
105 This mode shows a ``plain'' clock in large text that takes up nearly the whole LCD.