manual/plugins/clock.tex

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