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