summaryrefslogtreecommitdiff
path: root/manual/configure_rockbox/display_options.tex
diff options
context:
space:
mode:
Diffstat (limited to 'manual/configure_rockbox/display_options.tex')
-rwxr-xr-xmanual/configure_rockbox/display_options.tex297
1 files changed, 201 insertions, 96 deletions
diff --git a/manual/configure_rockbox/display_options.tex b/manual/configure_rockbox/display_options.tex
index 234b83ae73..3e7dea1cf2 100755
--- a/manual/configure_rockbox/display_options.tex
+++ b/manual/configure_rockbox/display_options.tex
@@ -1,119 +1,224 @@
1% $Id$ %
1\section{\label{ref:Displayoptions}Display Options} 2\section{\label{ref:Displayoptions}Display Options}
2 3
3 \begin{itemize} 4 \begin{description}
4 \item \textbf{Browse fonts: } 5 \item[Browse fonts:]
5 Browse the fonts that reside in your \fname{/.rockbox} directory. Selecting one will activate it. See page \pageref{ref:Loadingfonts} for further details about fonts. 6 Browse the fonts that reside in your \fname{/.rockbox/fonts} directory.
7 Selecting one will activate it. See page \pageref{ref:Loadingfonts}
8 for further details about fonts.
6 9
7 \item \textbf{Browse WPS files: } 10 \item[Browse WPS files:]
8 Opens the File Browser in the \fname{/.rockbox} directory and displays all .wps files. Selecting one will activate it, stop will exit back to the menu. For further information about the WPS see page \pageref{ref:WPS}. For information about editing a .wps file see page \pageref{ref:ConfiguringtheWPS}. 11 Opens the File Browser in the \fname{/.rockbox/wps} directory and displays
12 all \fname{.wps} files. Selecting one will activate it, stop will exit
13 back to the menu. For further information about the WPS see page
14 \pageref{ref:WPS}. For information about editing a .wps file see
15 page \pageref{ref:ConfiguringtheWPS}.
9 16
10 \item \textbf{LCD Settings: } 17 \item[LCD Settings:]
11 This submenu contains settings that relate to the display of the \dap. 18 This submenu contains settings that relate to the display of the \dap.
12 \begin{itemize} 19 \begin{description}
13 \item \textbf{Backlight: } 20 \item[Backlight:]
14 The amount of time the backlight shines after a key press. If set to OFF, the backlight will not light when a button is pressed. If set to ON, the backlight will never shut off. If set to a time (1 to 90 seconds), the backlight will stay lit for that amount of time after a button press. 21 The amount of time the backlight shines after a key press. If set to
15 \item \textbf{Backlight on When Plugged: } 22 ``Off'', the backlight will not light when a button is pressed. If
16 The amount of time the backlight shines after a key press when the \dap\ is plugged into the charger. If set to OFF, the backlight will not light when a button is pressed. If set to ON, the backlight will never shut off. If set to a time (1 to 90 seconds), the backlight will stay lit for that amount of time after a button press. 23 set to ``On'', the backlight will never shut off. If set to a time
17 \item \textbf{Caption Backlight:} This option turns the backlight on for 25 seconds either side of the start of a new track so that the display can be read to see song information. 24 (1 to 90 seconds), the backlight will stay lit for that amount of time
25 after a button press.
26 \item[Backlight on When Plugged:]
27 This setting is equivalent to the Backlight setting except it applies when
28 the \dap\ is plugged into the charger.
29 \item[Caption Backlight:]
30 This option turns the backlight on for 25 seconds either side of the
31 start of a new track so that the display can be read to see song information.
18 \opt{h1xx,ipodnano,ipodcolour,ipodvideo}{ 32 \opt{h1xx,ipodnano,ipodcolour,ipodvideo}{
19 \item \textbf{Backlight fade in:} 33 \item[Backlight fade in:]
20 The amount of time that the backlight will take to fade from off to on after a button is pressed. If set to OFF the backlight will turn on immediately, with no fade in. Can also be set to 500ms, 1s or 2s. 34 The amount of time that the backlight will take to fade from off to on
21 \item \textbf{Backlight fade out:} 35 after a button is pressed. If set to ``Off'' the backlight will turn on
22 The amount of time that the backlight will take to fade from on to off after a button is pressed. If set to "Off" the backlight will turn off immediately, with no fade out. Can also be set to 500kms, 1s, 2s, 3s, 4s, 5s or 10s. 36 immediately, with no fade in. Can also be set to 500ms, 1s or 2s.
37 \item[Backlight fade out:]
38 Like Backlight fade in, this controls the amount of time that the
39 backlight will take to fade from on to off after a button is pressed.
40 If set to ``Off'' the backlight will turn off immediately, with no fade
41 out. Other valid values: 500ms, 1s, 2s, 3s, 4s, 5s or 10s.
23 } 42 }
24 \item \textbf{Brightness:} 43 \item[First Keypress Enables Backlight Only:]
25 Changes the contrast of your LCD display. 44 With this option enabled the first keypress while the backlight is turned
26 \item \textbf{First keypress enables backlight on:} 45 off will only turn the backlight on without having any other effect. When
27 This controls what happens when you press a button while the backlight is turned off. If this setting is set to YES, the first keypress will light up the backlight, but have no other effect. If this setting is set to NO, the first keypress will light up the backlight \textbf{and} engage the function of the key that is pressed. 46 disabled the first keypress will \emph{also} perform its appropriate action.
28 \item \textbf{Contrast:} Changes the contrast of your LCD display. \textbf{Warning:} Setting the contrast too dark or too light can make it hard to find this menu option again! 47 \item[Brightness:]
48 Changes the brightness of your LCD display.
49 \item[Contrast:]
50 Changes the contrast of your LCD display.
51 \warn{Setting the contrast too dark or too light can make it hard to
52 find this menu option again!}
29 \opt{recorder,recorderv2fm,ondio,h1xx,h300,ipodnano,ipodcolour,ipodvideo}{ 53 \opt{recorder,recorderv2fm,ondio,h1xx,h300,ipodnano,ipodcolour,ipodvideo}{
30 \item \textbf{LCD Mode}: This setting lets you invert the whole screen, so now you get a black background and light text and graphics. 54 \item[LCD Mode:]
31 } 55 This setting lets you invert the whole screen, so now you get a
32 \item \textbf{Upside Down: }Displays the screen so that the top of the display is nearest the buttons. This is sometimes useful when carrying the \dap\ in a pocket for easy access to the headphone socket. 56 black background and light text and graphics.
33 \item \textbf{Line Selector: }This option allows you to select whether the line selector is a bar of inverted text (``Bar (inverse)'' option) or a small arrow to the left of the menu text (``Pointer'' option). The default is Bar (inverse). 57 }
34 \opt{SWCODEC}{ 58 \item[Upside Down:]
35 \item \textbf{Clear Backdrop: }Rockbox allows you to select bitmap pictures to use as backdrops. These backdrops are set in the File Context Menu. (TODO: find reference). This option allows you to clear the backdrops that you set. 59 Displays the screen so that the top of the display is nearest the buttons.
36 } 60 This is sometimes useful when carrying the \dap\ in a pocket for easy
61 access to the headphone socket.
62 \item[Line Selector:]
63 This option allows you to select whether the line selector is a bar
64 of inverted text (``Bar (inverse)'' option) or a small arrow to the
65 left of the menu text (``Pointer'' option). The default is
66 ``Bar (inverse)''.
67 \opt{h300,ipodcolor,ipodvideo,x5}{
68 \item[Clear Backdrop:]
69 Rockbox allows you to select bitmap pictures to use as backdrops.
70 These backdrops are set in the File Context Menu. \fixme{reference!}
71 This option allows you to clear the backdrops that you set.
72 }
37 \opt{h300,ipodnano,ipodcolour,ipodvideo}{ 73 \opt{h300,ipodnano,ipodcolour,ipodvideo}{
38 \item \textbf{Set Background Colour: }Sets the background colour for the LCD display. 74 \item[Set Background Colour:]
39 \item \textbf{Set Foreground Colour: }Sets the foreground colour for the LCD display. 75 Sets the background colour for the LCD display.
40 \item \textbf{Reset Colours: }Resets the LCD display to Rockbox's default colours. 76 \item[Set Foreground Colour:]
41 } 77 Sets the foreground colour for the LCD display.
42 \end{itemize} 78 \item[Reset Colours:]
43 79 Resets the LCD display to Rockbox's default colours.
80 }
81 \end{description}
82%
44 \opt{h1xx,h300,x5}{ 83 \opt{h1xx,h300,x5}{
45 \item \textbf{Remote-LCD Settings} 84 \item[Remote-LCD Settings:]
46 This submenu contains settings that relate to the display of the \dap. 85 This submenu contains settings that relate to the display of the \dap.
47 \begin{itemize} 86 \begin{description}
48 \item \textbf{Backlight: } 87 \item[Backlight:]
49 The amount of time the remote backlight shines after a key press. If set to OFF, the remote backlight will not light when a button is pressed. If set to ON, the remote backlight will never shut off. If set to a time (1 to 90 seconds), the remote backlight will stay lit for that amount of time after a button press. 88 Similar to the main unit backlight this option controls the backlight
50 \item \textbf{Backlight on When Plugged: } 89 timeout for the remote control. The remote backlight is independent
51 The amount of time the remote backlight shines after a key press when the \dap\ is plugged into the charger. If set to OFF, the remote backlight will not light when a button is pressed. If set to ON, the remote backlight will never shut off. If set to a time (1 to 90 seconds), the remote backlight will stay lit for that amount of time after a button press. 90 from the main unit backlight.
52 \item \textbf{Caption Backlight: } 91 \item[Backlight on When Plugged:]
53 This option turns the backlight on for 25 seconds either side of the start of a new track so that the display can be read to see song information. 92 This controls the backlight when the \dap\ is plugged into the charger.
54 \opt{h1xx,ipodnano,ipodcolour,ipodvideo}{ 93 \item[Caption Backlight:]
55 \item \textbf{First keypress enables backlight on:} 94 This option turns the backlight on for 25 seconds either side of the
56 This controls what happens when you press a button on your remote while the backlight is turned off. If this setting is set to YES, the first keypress will light up the remote backlight, but have no other effect. If this setting is set to NO, the first keypress will light up the remote backlight \textbf{and} engage the function of the key that is pressed. 95 start of a new track so that the display can be read to see song
57 \item \textbf{Contrast:} 96 information.
58 Changes the contrast of your remote's LCD display. \textbf{Warning:} Setting the contrast too dark or too light can make it hard to find this menu option again! 97 \opt{h1xx,ipodnano,ipodcolour,ipodvideo}{
59 \item \textbf{LCD Mode}: 98 \item[First Keypress Enables Backlight Only:]
60 This setting lets you invert the whole screen, so now you get a black background and light text and graphics. 99 This controls what happens when you press a button on your remote
61 \item \textbf{Upside Down: } 100 while the backlight is turned off. Like for the main unit, if this
62 Displays the screen so that the top of the display is nearest the buttons. This is sometimes useful when carrying the \dap\ in a pocket for easy access to the headphone socket. 101 setting is set to ``Yes'', the first keypress will light up the
63 } 102 remote backlight, but have no other effect. If set to ``No'',
64 \end{itemize} 103 the first keypress will light up the remote backlight
104 \emph{and} engage the function of the key that is pressed.
105 \item[Contrast:]
106 Changes the contrast of your remote's LCD display.
107 \warn{Setting the contrast too dark or too light can make it hard to
108 find this menu option again!}
109 \item[LCD Mode:]
110 This setting lets you invert the whole screen, so now you get a
111 black background and light text and graphics.
112 \item[Upside Down:]
113 Displays the screen so that the top of the display is nearest
114 the buttons. This is sometimes useful when carrying the \dap\ in a
115 pocket for easy access to the headphone socket.
116 }
117 \end{description}
65 } 118 }
66 \item \textbf{Scrolling} 119 \item[Scrolling]
67 This feature controls how text will scroll in Rockbox. You can configure the following parameters: 120 This feature controls how text will scroll in Rockbox. You can configure
68 \begin{itemize} 121 the following parameters:
69 \item \textbf{Scroll Speed: } 122 \begin{description}
123 \item[Scroll Speed:]
70 Controls how many times per second the scrolling text moves a step. 124 Controls how many times per second the scrolling text moves a step.
71 \item \textbf{Scroll StartDelay: } 125 \item[Scroll StartDelay:]
72 Controls how many milliseconds Rockbox should wait before a new text begins scrolling. 126 Controls how many milliseconds Rockbox should wait before a new
127 text begins scrolling.
73 \opt{recorder,recorderv2fm,ondio,h1xx,h300,ipodnano,ipodcolour,ipodvideo}{ 128 \opt{recorder,recorderv2fm,ondio,h1xx,h300,ipodnano,ipodcolour,ipodvideo}{
74 \item \textbf{Scroll Step Size:} 129 \item[Scroll Step Size:]
75 Controls how many pixels the text scroll should move for each step. 130 Controls how many pixels the text scroll should move for each step.
76 } 131 }
77 \item \textbf{Bidirectional Scroll Limit: } 132 \item[Bidirectional Scroll Limit:]
78 Rockbox has two different scroll methods, always scrolling the text to the left, and when the line has ended, beginning again at the start, or moving to the left until you can read the end of the line, and scroll right until you see the beginning again. Rockbox chooses which method it should use, depending of how much it has to scroll left. This setting lets you tell Rockbox where that limit is, expressed in percentage of line length. 133 Rockbox has two different scroll methods: always scrolling the text
79 \item \textbf{Screen Scrolls Out of View: }TODO 134 to the left and when the line has ended beginning again at the start,
80 \item \textbf{Screen Scroll Step Size: }TODO 135 or moving to the left until you can read the end of the line and scroll
81 \item \textbf{Paged Scrolling: }TODO 136 right until you see the beginning again. Rockbox chooses which method
82 \end{itemize} 137 it should use depending of how much it has to scroll left. This setting
83 138 lets you tell Rockbox where that limit is, expressed in percentage of
139 line length.
140 \item[Screen Scrolls Out of View:] \fixme{tbd}
141 \item[Screen Scroll Step Size:] \fixme{tbd}
142 \item[Paged Scrolling:] \fixme{tbd}
143 \end{description}
144 %
84 \opt{recorder,recorderv2fm,ondio,h1xx,h300,ipodnano,ipodcolour,ipodvideo}{ 145 \opt{recorder,recorderv2fm,ondio,h1xx,h300,ipodnano,ipodcolour,ipodvideo}{
85 \item \textbf{Status/Scrollbar} 146 \item[Status/Scrollbar:]
86 Settings related to on screen status display and the scrollbar. 147 Settings related to on screen status display and the scrollbar.
87 \begin{itemize} 148 \begin{description}
88 \item \textbf{Scroll Bar: }Enables or disables the scroll bar at the left. 149 \item[Scroll Bar:] Enables or disables the scroll bar at the left.
89 \item \textbf{Status Bar: }Enables or disables the status bar at the upper side. 150 \item[Status Bar:] Enables or disables the status bar at the upper side.
90 \opt{RECORDER_PAD}{ 151 \opt{RECORDER_PAD}{
91 \item \textbf{Button Bar:} Enables or disables the button bar prompts for the F keys at the bottom of the screen. 152 \item[Button Bar:] Enables or disables the button bar prompts for the
153 ``F''-keys at the bottom of the screen.
92 } 154 }
93 \item \textbf{Volume Display: }Controls whether the volume is displayed as a graphic or a numeric value on the Status Bar. If you select a numeric display, volume is displayed in decibels. (TODO cross-reference to volume setting.) 155 \item[Volume Display:] Controls whether the volume is displayed as a
94 \item \textbf{Battery Display: }Controls whether the battery charge status is displayed as a graphic or numerical percentage value on the Status Bar. 156 graphic or a numeric value on the Status Bar. If you select a numeric
95 \end{itemize} 157 display, volume is displayed in decibels.
158 \fixme{cross-reference to volume setting.}
159 \item[Battery Display:] Controls whether the battery charge status is
160 displayed as a graphic or numerical percentage value on the Status Bar.
161 \end{description}
96 } 162 }
97 163 %
98 \opt{recorder,recorderv2fm,ondio,h1xx,h300,ipodnano,ipodcolour,ipodvideo}{ 164 \opt{recorder,recorderv2fm,ondio,h1xx,h300,ipodnano,ipodcolour,ipodvideo}{
99 \item \textbf{Peak Meter} 165 \item[Peak Meter:]
100 The peak meter can be configured with a number of parameters. (For a description of the peak meter see page \pageref{ref:Peakmeter}.) 166 The peak meter can be configured with a number of parameters.
101 167 (For a description of the peak meter see page \pageref{ref:Peakmeter}.)
102 \begin{itemize} 168 \begin{description}
103 \item \textbf{Peak Release: } 169 \item[Peak Release:]
104 This determines how fast the bar shrinks when the music becomes softer. Lower values make the peak meter look smoother. 170 This determines how fast the bar shrinks when the music becomes
105 \item \textbf{Peak Hold Time: } 171 softer. Lower values make the peak meter look smoother.
106 Specifies the time after which the peak indicator will reset. For example, if you set this value to 5s, the peak indicator displays the loudest volume value that occurred within the last 5 seconds. Larger values are useful if you want to find the peak level of a song, which might be of interest when copying music from the \dap via the analogue output to some other recording device. 172 \item[Peak Hold Time:]
107 \item \textbf{Clip Hold Time: } 173 Specifies the time after which the peak indicator will reset.
108 The number of seconds that the clipping indicator will be visible after clipping is detected. 174 For example, if you set this value to 5s, the peak indicator displays
109 \item \textbf{Performance: } 175 the loudest volume value that occurred within the last 5 seconds.
110 In high performance mode, the peak meter is updated as often as possible. This reduces the chance of missing a peak value, making the peak meter more precise. In energy save mode, the peak meter is updated just often enough to look fluid. This reduces the load on the CPU and thus saves a little bit of energy. If you crave every second of runtime for your \dap\ or simply use the peak meter as a screen effect, the use of energy save mode is recommended. If you want to use the peak meter as a measuring instrument you'll want to use high performance mode. (TODO: determine which platforms support this feature.) 176 Larger values are useful if you want to find the peak level of a song,
111 \item \textbf{Scale: } 177 which might be of interest when copying music from the \dap via the
112 Select whether the peak meter displays linear or logarithmic values. The human ear perceives loudness on a logarithmic scale. If the Scale setting is set to ``Logarithmic(dB)'' scale, the volume values are scaled logarithmically. The volume meters of digital audio devices usually are scaled this way. On the other hand, if you are interested in the power level that is applied to your headphones you should choose ``linear'' display. This setting cannot be displayed in units like volts or watts because such units depend on your headphones. 178 analogue output to some other recording device.
113 \item \textbf{Minimum and maximum range: } 179 \item[Clip Hold Time:]
114 These two options define the full value range that the peak meter displays. Recommended values for the ``Logarithmic(dB)'' setting are {}-40 dB for minimum and 0 dB for maximum. Recommended values for ``linear'' display are 0 and 100\%. Note that {}-40 dB is approximately 1\% in linear value, but if you change the minimum setting in linear mode slightly and then change to the dB scale, there will be a large change. You can use these values for 'zooming' into the peak meter. 180 The number of seconds that the clipping indicator will be visible
115 \end{itemize} 181 after clipping is detected.
182 \item[Performance:]
183 In high performance mode, the peak meter is updated as often as
184 possible. This reduces the chance of missing a peak value, making
185 the peak meter more precise. In energy save mode, the peak meter is
186 updated just often enough to look fluid. This reduces the load on
187 the CPU and thus saves a little bit of energy. If you crave every
188 second of runtime for your \dap\ or simply use the peak meter as a
189 screen effect, the use of energy save mode is recommended. If you
190 want to use the peak meter as a measuring instrument you'll want to
191 use high performance mode.
192 \fixme{TODO: determine which platforms support this feature.}
193 \item[Scale:]
194 Select whether the peak meter displays linear or logarithmic values.
195 The human ear perceives loudness on a logarithmic scale. If the
196 Scale setting is set to ``Logarithmic (dB)'' scale, the volume values
197 are scaled logarithmically. The volume meters of digital audio
198 devices usually are scaled this way. On the other hand, if you
199 are interested in the power level that is applied to your headphones
200 you should choose ``linear'' display. This setting cannot be
201 displayed in units like volts or watts because such units depend
202 on your headphones.
203 \item[Minimum and maximum range:]
204 These two options define the full value range that the peak meter
205 displays. Recommended values for the ``Logarithmic (dB)'' setting
206 are {}-40 dB for minimum and 0 dB for maximum. Recommended values
207 for ``linear'' display are 0 and 100\%. Note that {}-40 dB is
208 approximately 1\% in linear value, but if you change the minimum
209 setting in linear mode slightly and then change to the dB scale,
210 there will be a large change. You can use these values for `zooming'
211 into the peak meter.
212 \end{description}
116 } 213 }
117 \item \textbf{Default Codepage: }(TODO). 214 \item[Default Codepage:]
118 \end{itemize} 215 A codepage describes the way extended characters that aren't available
119 \ No newline at end of file 216 within the ASCII character set are encoded. ID3v1 tags don't have a
217 codepage encoding contained so Rockbox needs to know what encoding has
218 been used when generating these tags. This should be ``ISO-8859-1'' but
219 to support languages outside Western Europe most applications use
220 the setting of your operating system instead. If your operating system
221 uses a different codepage and you're getting garbled extended characters
222 you should adjust this settings. In most cases sticking to
223 ``ISO-8859-1'' would be sufficient.
224 \end{description}