summaryrefslogtreecommitdiff
path: root/manual/configure_rockbox/display_options.tex
diff options
context:
space:
mode:
Diffstat (limited to 'manual/configure_rockbox/display_options.tex')
-rw-r--r--manual/configure_rockbox/display_options.tex86
1 files changed, 43 insertions, 43 deletions
diff --git a/manual/configure_rockbox/display_options.tex b/manual/configure_rockbox/display_options.tex
index d06ab81bbd..95455df7ba 100644
--- a/manual/configure_rockbox/display_options.tex
+++ b/manual/configure_rockbox/display_options.tex
@@ -3,38 +3,38 @@
3 3
4 \begin{description} 4 \begin{description}
5 5
6 \item[LCD Settings:] 6 \item[LCD Settings.]
7 This sub menu contains settings that relate to the display of the \dap. 7 This sub menu contains settings that relate to the display of the \dap.
8 \begin{description} 8 \begin{description}
9 \opt{HAVE_BACKLIGHT}{ 9 \opt{HAVE_BACKLIGHT}{
10 \item[Backlight:] 10 \item[Backlight.]
11 The amount of time the backlight shines after a key press. If set to 11 The amount of time the backlight shines after a key press. If set to
12 \setting{Off}, the backlight will not light when a button is pressed. If 12 \setting{Off}, the backlight will not light when a button is pressed. If
13 set to \setting{On}, the backlight will never shut off. If set to a time 13 set to \setting{On}, the backlight will never shut off. If set to a time
14 (1 to 90 seconds), the backlight will stay lit for that amount of time 14 (1 to 90 seconds), the backlight will stay lit for that amount of time
15 after a button press. 15 after a button press.
16 \item[Backlight (While Plugged In):] 16 \item[Backlight (While Plugged In).]
17 This setting is equivalent to the \setting{Backlight} setting except it 17 This setting is equivalent to the \setting{Backlight} setting except it
18 applies when the \dap{} is plugged into the charger. 18 applies when the \dap{} is plugged into the charger.
19 \item[Backlight on Hold:] 19 \item[Backlight on Hold.]
20 This setting controls the behavior of the backlight when the Hold switch 20 This setting controls the behavior of the backlight when the Hold switch
21 is toggled. If set to \setting{Normal} the backlight will behave as usual. 21 is toggled. If set to \setting{Normal} the backlight will behave as usual.
22 If set to \setting{Off} the backlight will be turned off immediately when 22 If set to \setting{Off} the backlight will be turned off immediately when
23 the Hold switch is engaged and if set to \setting{On} the backlight will 23 the Hold switch is engaged and if set to \setting{On} the backlight will
24 be turned on and stay on while the Hold switch is engaged. 24 be turned on and stay on while the Hold switch is engaged.
25 \item[Caption Backlight:] 25 \item[Caption Backlight.]
26 This option turns on the backlight a number of seconds before the start 26 This option turns on the backlight a number of seconds before the start
27 of a new track, and keeps it on for the same number of seconds after the 27 of a new track, and keeps it on for the same number of seconds after the
28 beginning so that the display can be read to see song information. The 28 beginning so that the display can be read to see song information. The
29 amount of time is determined by the value of the backlight timeout 29 amount of time is determined by the value of the backlight timeout
30 setting, but is no less than 5 seconds. 30 setting, but is no less than 5 seconds.
31 \opt{backlight_fade_int}{ 31 \opt{backlight_fade_int}{
32 \item[Backlight Fade In:] 32 \item[Backlight Fade In.]
33 The amount of time that the backlight will take to fade from off to on 33 The amount of time that the backlight will take to fade from off to on
34 after a button is pressed. If set to \setting{Off} the backlight will 34 after a button is pressed. If set to \setting{Off} the backlight will
35 turn on immediately, with no fade in. Can also be set to \setting{500ms}, 35 turn on immediately, with no fade in. Can also be set to \setting{500ms},
36 \setting{1s} or \setting{2s}. 36 \setting{1s} or \setting{2s}.
37 \item[Backlight Fade Out:] 37 \item[Backlight Fade Out.]
38 Like Backlight fade in, this controls the amount of time that the 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. If 39 backlight will take to fade from on to off after a button is pressed. If
40 set to \setting{Off} the backlight will turn off immediately, with no 40 set to \setting{Off} the backlight will turn off immediately, with no
@@ -42,22 +42,22 @@
42 \setting{2s}, \setting{3s}, \setting{4s}, \setting{5s} or \setting{10s}. 42 \setting{2s}, \setting{3s}, \setting{4s}, \setting{5s} or \setting{10s}.
43 } 43 }
44 \opt{backlight_fade_bool}{ 44 \opt{backlight_fade_bool}{
45 \item[Backlight Fade In:] 45 \item[Backlight Fade In.]
46 This options turns on smooth backlight fading when the backlight is 46 This options turns on smooth backlight fading when the backlight is
47 turning on. The fading time may dependent on the brightness level you 47 turning on. The fading time may dependent on the brightness level you
48 have chosen. If it is turned off, the backlight will turn on immediately. 48 have chosen. If it is turned off, the backlight will turn on immediately.
49 \item[Backlight Fade Out:] 49 \item[Backlight Fade Out.]
50 This options turns on smooth backlight fading when the backlight is 50 This options turns on smooth backlight fading when the backlight is
51 turning off. The fading time may dependent on the brightness level you 51 turning off. The fading time may dependent on the brightness level you
52 have chosen. If it is turned off, the backlight will turn off immediately. 52 have chosen. If it is turned off, the backlight will turn off immediately.
53 } 53 }
54 \item[First Keypress Enables Backlight Only:] 54 \item[First Keypress Enables Backlight Only.]
55 With this option enabled the first keypress while the backlight is turned 55 With this option enabled the first keypress while the backlight is turned
56 off will only turn the backlight on without having any other effect. When 56 off will only turn the backlight on without having any other effect. When
57 disabled the first keypress will \emph{also} perform its appropriate action. 57 disabled the first keypress will \emph{also} perform its appropriate action.
58 58
59 \opt{lcd_sleep}{ 59 \opt{lcd_sleep}{
60 \item[Sleep (After Backlight Off):] 60 \item[Sleep (After Backlight Off).]
61 This setting controls how long rockbox will wait before turning off the 61 This setting controls how long rockbox will wait before turning off the
62 display after the backlight is turned off. Turning off the display 62 display after the backlight is turned off. Turning off the display
63 saves a little bit of battery power but turning on the display takes 63 saves a little bit of battery power but turning on the display takes
@@ -65,25 +65,25 @@
65 } 65 }
66 66
67 \opt{backlight_brightness}{ 67 \opt{backlight_brightness}{
68 \item[Brightness:] 68 \item[Brightness.]
69 Changes the brightness of your LCD display. 69 Changes the brightness of your LCD display.
70 } 70 }
71 } % \opt{HAVE_BACKLIGHT} 71 } % \opt{HAVE_BACKLIGHT}
72 72
73 \opt{archos,h100,ipodmini,ipod3g,ipod4g,x5}{ 73 \opt{archos,h100,ipodmini,ipod3g,ipod4g,x5}{
74 \item[Contrast:] 74 \item[Contrast.]
75 Changes the contrast of your LCD display. 75 Changes the contrast of your LCD display.
76 \warn{Setting the contrast too dark or too light can make it hard to 76 \warn{Setting the contrast too dark or too light can make it hard to
77 find this menu option again!} 77 find this menu option again!}
78 } % \opt{archos,h100,ipodmini,ipod4g,x5} 78 } % \opt{archos,h100,ipodmini,ipod4g,x5}
79 79
80 \opt{lcd_invert}{ 80 \opt{lcd_invert}{
81 \item[LCD Mode:] 81 \item[LCD Mode.]
82 This setting lets you invert the colours of the display. 82 This setting lets you invert the colours of the display.
83 } 83 }
84 84
85 \opt{lcd_flip}{ 85 \opt{lcd_flip}{
86 \item[Upside Down:] 86 \item[Upside Down.]
87 Displays the screen so that the top of the display is nearest the buttons. 87 Displays the screen so that the top of the display is nearest the buttons.
88 This is sometimes useful when carrying the \dap{} in a pocket for easy 88 This is sometimes useful when carrying the \dap{} in a pocket for easy
89 access to the headphone socket. 89 access to the headphone socket.
@@ -91,68 +91,68 @@
91 \end{description} 91 \end{description}
92% 92%
93 \opt{HAVE_REMOTE_LCD}{ 93 \opt{HAVE_REMOTE_LCD}{
94 \item[Remote-LCD Settings:] 94 \item[Remote-LCD Settings.]
95 This sub menu contains settings that relate to the display of the remote. 95 This sub menu contains settings that relate to the display of the remote.
96 \begin{description} 96 \begin{description}
97 \item[Backlight:] 97 \item[Backlight.]
98 Similar to the main unit backlight this option controls the backlight 98 Similar to the main unit backlight this option controls the backlight
99 timeout for the remote control. The remote backlight is independent 99 timeout for the remote control. The remote backlight is independent
100 from the main unit backlight. 100 from the main unit backlight.
101 \item[Backlight on When Plugged:] 101 \item[Backlight on When Plugged.]
102 This controls the backlight when the \dap\ is plugged into the charger. 102 This controls the backlight when the \dap\ is plugged into the charger.
103 \item[Caption Backlight:] 103 \item[Caption Backlight.]
104 This option turns on the backlight a number of seconds before the start 104 This option turns on the backlight a number of seconds before the start
105 of a new track, and keeps it on for the same number of seconds after the 105 of a new track, and keeps it on for the same number of seconds after the
106 beginning so that the display can be read to see song information. The 106 beginning so that the display can be read to see song information. The
107 amount of time is determined by the value of the backlight timeout 107 amount of time is determined by the value of the backlight timeout
108 setting, but is no less than 5 seconds. 108 setting, but is no less than 5 seconds.
109 \item[First Keypress Enables Backlight Only:] 109 \item[First Keypress Enables Backlight Only.]
110 This controls what happens when you press a button on your remote 110 This controls what happens when you press a button on your remote
111 while the backlight is turned off. Like for the main unit, if this 111 while the backlight is turned off. Like for the main unit, if this
112 setting is set to \setting{Yes}, the first keypress will light up the 112 setting is set to \setting{Yes}, the first keypress will light up the
113 remote backlight, but have no other effect. If set to \setting{No}, 113 remote backlight, but have no other effect. If set to \setting{No},
114 the first keypress will light up the remote backlight 114 the first keypress will light up the remote backlight
115 \emph{and} engage the function of the key that is pressed. 115 \emph{and} engage the function of the key that is pressed.
116 \item[Contrast:] 116 \item[Contrast.]
117 Changes the contrast of your remote's LCD display. 117 Changes the contrast of your remote's LCD display.
118 \warn{Setting the contrast too dark or too light can make it hard to 118 \warn{Setting the contrast too dark or too light can make it hard to
119 find this menu option again!} 119 find this menu option again!}
120 \item[LCD Mode:] 120 \item[LCD Mode.]
121 This setting lets you invert the whole screen, so now you get a 121 This setting lets you invert the whole screen, so now you get a
122 black background and light text and graphics. 122 black background and light text and graphics.
123 \item[Upside Down:] 123 \item[Upside Down.]
124 Displays the screen so that the top of the display is nearest 124 Displays the screen so that the top of the display is nearest
125 the buttons. This is sometimes useful when carrying the \dap\ in a 125 the buttons. This is sometimes useful when carrying the \dap\ in a
126 pocket for easy access to the headphone socket. 126 pocket for easy access to the headphone socket.
127 \opt{h100,h300}{ 127 \opt{h100,h300}{
128 \item[Reduce Ticking:] 128 \item[Reduce Ticking.]
129 Enable this option if you can hear a ticking sound in your headphones 129 Enable this option if you can hear a ticking sound in your headphones
130 when using your remote. 130 when using your remote.
131 } 131 }
132 \end{description} 132 \end{description}
133 } 133 }
134% 134%
135 \item[Scrolling] 135 \item[Scrolling.]
136 This feature controls how text will scroll in Rockbox. You can configure 136 This feature controls how text will scroll in Rockbox. You can configure
137 the following parameters: 137 the following parameters:
138 \begin{description} 138 \begin{description}
139 \item[Scroll Speed:] 139 \item[Scroll Speed.]
140 Sets how many times per second the automatic horizontal scrolling text 140 Sets how many times per second the automatic horizontal scrolling text
141 will move a step. 141 will move a step.
142 \item[Scroll Start Delay:] 142 \item[Scroll Start Delay.]
143 Controls how many milliseconds Rockbox should wait before a new 143 Controls how many milliseconds Rockbox should wait before a new
144 text begins automatically scrolling. 144 text begins automatically scrolling.
145 \opt{lcd_bitmap}{ 145 \opt{lcd_bitmap}{
146 \item[Scroll Step Size:] 146 \item[Scroll Step Size.]
147 Defines the number of pixels the text should move for each step, as used 147 Defines the number of pixels the text should move for each step, as used
148 by the Scroll Speed setting. 148 by the Scroll Speed setting.
149 } 149 }
150 \opt{HAVE_REMOTE_LCD}{ 150 \opt{HAVE_REMOTE_LCD}{
151 \item[Remote Scrolling Options:] 151 \item[Remote Scrolling Options.]
152 The options here have the same effect on the remote LCD as the options 152 The options here have the same effect on the remote LCD as the options
153 mentioned above have on the main LCD. 153 mentioned above have on the main LCD.
154 } 154 }
155 \item[Bidirectional Scroll Limit:] 155 \item[Bidirectional Scroll Limit.]
156 Rockbox has two different automatic horizontal scrolling methods: 1) always 156 Rockbox has two different automatic horizontal scrolling methods: 1) always
157 scrolling the text to the left until the line has ended and then beginning 157 scrolling the text to the left until the line has ended and then beginning
158 again at the start, and 2) moving to the left until you can read the end of 158 again at the start, and 2) moving to the left until you can read the end of
@@ -161,7 +161,7 @@
161 scroll to the left. This setting lets you tell Rockbox where that limit 161 scroll to the left. This setting lets you tell Rockbox where that limit
162 is, expressed in percentage of the line length. 162 is, expressed in percentage of the line length.
163 \opt{lcd_bitmap}{ 163 \opt{lcd_bitmap}{
164 \item[Screen Scrolls Out of View:] 164 \item[Screen Scrolls Out of View.]
165 Screens can be manually scrolled horizontally by pressing 165 Screens can be manually scrolled horizontally by pressing
166 \opt{recorder,recorderv2fm}{\ButtonOn+\ButtonRight/\ButtonLeft} 166 \opt{recorder,recorderv2fm}{\ButtonOn+\ButtonRight/\ButtonLeft}
167 \opt{ondio}{\ButtonMenu+\ButtonRight/\ButtonLeft} 167 \opt{ondio}{\ButtonMenu+\ButtonRight/\ButtonLeft}
@@ -172,50 +172,50 @@
172 will keep the list entries at their fixed positions and allow them to be 172 will keep the list entries at their fixed positions and allow them to be
173 scrolled out of view, whereas \setting{No} will only scroll those entries 173 scrolled out of view, whereas \setting{No} will only scroll those entries
174 which surpass the right margin. 174 which surpass the right margin.
175 \item[Screen Scroll Step Size:] 175 \item[Screen Scroll Step Size.]
176 Defines the number of pixels the horizontal manual screen scroll should move 176 Defines the number of pixels the horizontal manual screen scroll should move
177 for each step. 177 for each step.
178 } 178 }
179 \opt{player}{ 179 \opt{player}{
180 \item[Jump Scroll:] 180 \item[Jump Scroll.]
181 This setting makes text scroll a page at a time instead of a character 181 This setting makes text scroll a page at a time instead of a character
182 at a time. If set to \setting{One time}, \setting{2}, \setting{3} or 182 at a time. If set to \setting{One time}, \setting{2}, \setting{3} or
183 \setting{4} it will scroll a line in paged mode that many times and 183 \setting{4} it will scroll a line in paged mode that many times and
184 then scroll it a character at a time. If set to \setting{Always} lines 184 then scroll it a character at a time. If set to \setting{Always} lines
185 will always scroll in paged mode. 185 will always scroll in paged mode.
186 \item[Jump Scroll Delay:] 186 \item[Jump Scroll Delay.]
187 Controls how long the delay is before a page is scrolled. 187 Controls how long the delay is before a page is scrolled.
188 } 188 }
189 \item[Paged Scrolling:] 189 \item[Paged Scrolling.]
190 When set to \setting{Yes} scrolling vertically on pages that surpass the 190 When set to \setting{Yes} scrolling vertically on pages that surpass the
191 screen size will page up/down instead of simply changing lines. This can be 191 screen size will page up/down instead of simply changing lines. This can be
192 useful on slow displays. 192 useful on slow displays.
193 \end{description} 193 \end{description}
194% 194%
195 \opt{lcd_bitmap}{ 195 \opt{lcd_bitmap}{
196 \item[Peak Meter:] 196 \item[Peak Meter.]
197 The peak meter can be configured with a number of parameters. 197 The peak meter can be configured with a number of parameters.
198 \begin{description} 198 \begin{description}
199 \item[Peak Release:] 199 \item[Peak Release.]
200 This determines how fast the bar shrinks when the music becomes 200 This determines how fast the bar shrinks when the music becomes
201 softer. Lower values make the peak meter look smoother. 201 softer. Lower values make the peak meter look smoother.
202 Expressed in scale units per 10ms. 202 Expressed in scale units per 10ms.
203 \item[Peak Hold Time:] 203 \item[Peak Hold Time.]
204 Specifies the time after which the peak indicator will reset. 204 Specifies the time after which the peak indicator will reset.
205 For example, if you set this value to 5s, the peak indicator displays 205 For example, if you set this value to 5s, the peak indicator displays
206 the loudest volume value that occurred within the last 5 seconds. 206 the loudest volume value that occurred within the last 5 seconds.
207 Larger values are useful if you want to find the peak level of a song, 207 Larger values are useful if you want to find the peak level of a song,
208 which might be of interest when copying music from the \dap\ via the 208 which might be of interest when copying music from the \dap\ via the
209 analogue output to some other recording device. 209 analogue output to some other recording device.
210 \item[Clip Hold Time:] 210 \item[Clip Hold Time.]
211 The number of seconds that the clipping indicator will be visible 211 The number of seconds that the clipping indicator will be visible
212 after clipping is detected. 212 after clipping is detected.
213 \opt{recording}{ 213 \opt{recording}{
214 \item[Clip Counter:] 214 \item[Clip Counter.]
215 Show the number of times the clip indicator went active during 215 Show the number of times the clip indicator went active during
216 recording in front of the peak meters. 216 recording in front of the peak meters.
217 } 217 }
218 \item[\label{ref:Peakmetersetting}Scale:] 218 \item[\label{ref:Peakmetersetting}Scale.]
219 Select whether the peak meter displays linear or logarithmic values. 219 Select whether the peak meter displays linear or logarithmic values.
220 The human ear perceives loudness on a logarithmic scale. If the Scale 220 The human ear perceives loudness on a logarithmic scale. If the Scale
221 setting is set to \setting{Logarithmic} (dB) scale, the volume values 221 setting is set to \setting{Logarithmic} (dB) scale, the volume values
@@ -225,7 +225,7 @@
225 you should choose \setting{Linear} display. This setting cannot be 225 you should choose \setting{Linear} display. This setting cannot be
226 displayed in units like volts or watts because such units depend 226 displayed in units like volts or watts because such units depend
227 on your headphones. 227 on your headphones.
228 \item[Minimum and maximum range:] 228 \item[Minimum and maximum range.]
229 These two options define the full value range that the peak meter 229 These two options define the full value range that the peak meter
230 displays. Recommended values for the \setting{Logarithmic} (dB) setting 230 displays. Recommended values for the \setting{Logarithmic} (dB) setting
231 are {}-40 dB for minimum and 0 dB for maximum. Recommended values 231 are {}-40 dB for minimum and 0 dB for maximum. Recommended values
@@ -236,7 +236,7 @@
236 into the peak meter. 236 into the peak meter.
237 \end{description} 237 \end{description}
238 } 238 }
239 \item[\label{ref:Defaultcodepage}Default Codepage:] 239 \item[\label{ref:Defaultcodepage}Default Codepage.]
240 A codepage describes the way extended characters that are not available 240 A codepage describes the way extended characters that are not available
241 within the ASCII character set are encoded. ID3v1 tags do not have a 241 within the ASCII character set are encoded. ID3v1 tags do not have a
242 codepage encoding contained so Rockbox needs to know what encoding has 242 codepage encoding contained so Rockbox needs to know what encoding has