diff options
Diffstat (limited to 'manual/plugins/clock.tex')
-rw-r--r-- | manual/plugins/clock.tex | 105 |
1 files changed, 75 insertions, 30 deletions
diff --git a/manual/plugins/clock.tex b/manual/plugins/clock.tex index 733d057d07..0c7795d253 100644 --- a/manual/plugins/clock.tex +++ b/manual/plugins/clock.tex | |||
@@ -6,41 +6,86 @@ | |||
6 | Clock | 6 | Clock |
7 | \par} | 7 | \par} |
8 | 8 | ||
9 | This is a fully featured analogue and digital clock program. | 9 | This is a fully featured analogue and digital clock plugin. |
10 | 10 | ||
11 | \subsubsection{Key configuration} | 11 | \subsubsection{Key configuration} |
12 | 12 | ||
13 | \begin{table} | 13 | \begin{table} |
14 | \begin{btnmap}{}{} | 14 | \begin{btnmap}{}{} |
15 | F1 & Help \\ | 15 | \opt{RECORDER_PAD,IRIVER_H300_PAD}{\ButtonOn} |
16 | F2 & Start / Stop stopwatch \\ | 16 | \opt{IPOD_4G_PAD,IAUDIO_X5_PAD}{\ButtonPlay} |
17 | F2 (Hold) & Reset stopwatch \\ | 17 | & Start / Stop Counter \\ |
18 | F3 & Options \\ | 18 | \opt{RECORDER_PAD,IRIVER_H300_PAD}{\ButtonOn} |
19 | Play & Select clock mode \\ | 19 | \opt{IPOD_4G_PAD,IAUDIO_X5_PAD}{\ButtonPlay} |
20 | UP & Enable idle power off \\ | 20 | (Hold) & Reset Counter \\ |
21 | DOWN & Disable idle power off \\ | 21 | \opt{RECORDER_PAD}{\ButtonPlay} |
22 | RIGHT & Enable backlight \\ | 22 | \opt{IPOD_4G_PAD,IAUDIO_X5_PAD,IRIVER_H300_PAD}{\ButtonSelect} |
23 | LEFT & Disable backlight \\ | 23 | & Main Menu \\ |
24 | OFF & Save settings to disk and exit \\ | 24 | \opt{RECORDER_PAD,IRIVER_H300_PAD}{\ButtonOff} |
25 | \opt{IPOD_4G_PAD}{\ButtonMenu} | ||
26 | \opt{IAUDIO_X5_PAD}{\ButtonPower} | ||
27 | & Save Settings (if enabled) and Exit \\ | ||
25 | \end{btnmap} | 28 | \end{btnmap} |
26 | \end{table} | 29 | \end{table} |
27 | 30 | ||
28 | \subsubsection{Backlight configuration} | 31 | \textbf{Clock Menu} |
29 | If RIGHT or LEFT is not pressed during clock operation (with the | 32 | \begin{description} |
30 | exception of at the Help/Options/Mode Selector/Credit screens) then the | 33 | \item[View Clock] Exits the menu and returns to the current clock mode display. |
31 | backlight timeout will remain your Rockbox default setting (example, 15 | 34 | \item[Mode Selector] Opens a menu from which you can select a clock mode to view. |
32 | seconds). If RIGHT or LEFT is pressed, Clock will set the backlight to | 35 | \item[Counter Settings] Opens a menu from which you can adjust settings pertaining to the counter. |
33 | ON or OFF, respectively. When Clock is exited, your default Rockbox | 36 | \item[Mode Settings] Opens a menu from which you can adjust settings pertaining to the current clock mode. |
34 | setting for Backlight will be restored. | 37 | \item[General Settings] |
35 | 38 | \begin{description} | |
36 | \subsubsection{Saving Settings} | 39 | \item[Reset Settings] |
37 | Settings are saved to disk when Clock is exited. They are saved to | 40 | Reset all settings to their default values. |
38 | \fname{/.rockbox/rocks/.clock\_settings}. To reset your settings | 41 | \item[Save Settings] |
39 | back to the defaults, simply navigate to this file using Rockbox, | 42 | Save all settings to disk. |
40 | highlight it, and press the ON+PLAY keys to get the Delete option. This way you can feel free to experiment with the settings {}- and you could even load | 43 | \item[Show Counter] |
41 | separate settings, say, one for your desk at home and one for in the car {}- by keeping two files in your \fname{/.rockbox/rocks} folder such as | 44 | Toggle Counter display. |
42 | ``h.clock\_settings'' and ``c.clock\_settings''. Simply remove the | 45 | \item[Save] |
43 | ``h'' for your home settings to go into effect, or add the ``h'' back and take off the ``c'' for your car settings. | 46 | Choose whether to disable automatic saving, saving to disk on exit, or saving to disk every settings change. |
44 | 47 | \item[Backlight] | |
45 | In the future, loading different settings will probably be made easier | 48 | Choose whether to disable the backlight, use the user's timeout setting, or keep the backlight on. |
46 | through a built{}-in settings file loader in Clock. | 49 | \item[Idle Poweroff] |
50 | Toggle Idle Poweroff. | ||
51 | \note{This setting is not saved to disk.} | ||
52 | \end{description} | ||
53 | \item[Help] Opens a brief help screen with key mappings and functionality. | ||
54 | \item[Credits] Displays a credits roll. | ||
55 | \end{description} | ||
56 | |||
57 | \subsubsection{Analog mode} | ||
58 | Small, round, analog clock is displayed in the middle of the LCD. | ||
59 | Time readout, if enabled, is displayed at the upper left. | ||
60 | If Time readout is in 12-hour (``12h'') mode, AM or PM will be displayed at the upper right. | ||
61 | The Date readout, if enabled, is displayed at the lower left. | ||
62 | The Counter, if enabled, is displayed at the lower right. | ||
63 | The second hand, if enabled, is displayed along with the hour and minute hands. | ||
64 | Digit display, if enabled, places ``12'', ``3'', ``6'', and ``9'' around the face of the clock in their respective positions. | ||
65 | |||
66 | \subsubsection{Digital mode} | ||
67 | An imitation of an LCD, this mode shows a Clock comprised of digital ``segments''. | ||
68 | The Date readout, if enabled, is displayed at the bottom, center. | ||
69 | 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). | ||
70 | The Counter, if displayed, is shown at the upper left. | ||
71 | The Blinking Colon, if enabled, blinks the colon once every second. | ||
72 | 12-hour mode, if enabled, will display the time in a 12-hour format. | ||
73 | |||
74 | \subsubsection{LCD mode} | ||
75 | Based on the Digital Mode, the LCD mode is another imitation of an LCD. | ||
76 | The settings available in this mode are exactly the same as Digital Mode, but they are independent of Digital Mode. | ||
77 | For example, you can have the Date Readout enabled in Digital Mode and disabled in LCD Mode. | ||
78 | |||
79 | \subsubsection{Fullscreen} | ||
80 | A Fullscreen clock is displayed. Show Border, if enabled, will draw a small box at every hour position (1 through 12). | ||
81 | Invert Seconds, if enabled, will invert the LCD as the seconds pass. | ||
82 | Second Hand, if enabled, will draw a second hand among the hour and minute hands. | ||
83 | |||
84 | \subsubsection{Binary mode} | ||
85 | This mode shows a Binary clock. | ||
86 | The hour is displayed on the top line, the minute is displayed on the middle line, and the seconds are on the last line. | ||
87 | Circle mode, if enabled, draws empty and full circles, instead of zeros and ones. | ||
88 | For help on reading binary, please visit: \url{http://en.wikipedia.org/wiki/Binary_numeral_system} | ||
89 | |||
90 | \subsubsection{Plain mode} | ||
91 | This mode shows a ``plain'' clock in large text that takes up nearly the whole LCD. | ||