diff options
Diffstat (limited to 'manual/configure_rockbox')
-rwxr-xr-x[-rw-r--r--] | manual/configure_rockbox/display_options.tex | 66 | ||||
-rwxr-xr-x[-rw-r--r--] | manual/configure_rockbox/system_options.tex | 71 |
2 files changed, 111 insertions, 26 deletions
diff --git a/manual/configure_rockbox/display_options.tex b/manual/configure_rockbox/display_options.tex index c872f08031..163b1e884c 100644..100755 --- a/manual/configure_rockbox/display_options.tex +++ b/manual/configure_rockbox/display_options.tex | |||
@@ -1,6 +1,6 @@ | |||
1 | % $Id$ % | 1 | % $Id$ % |
2 | \section{\label{ref:Displayoptions}Display} | 2 | \section{\label{ref:Displayoptions}Display} |
3 | 3 | ||
4 | \begin{description} | 4 | \begin{description} |
5 | 5 | ||
6 | \item[LCD Settings.] | 6 | \item[LCD Settings.] |
@@ -32,14 +32,14 @@ | |||
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 | 35 | turn on immediately, with no fade in. Can also be set to |
36 | \setting{500ms}, \setting{1s} or \setting{2s}. | 36 | \setting{500ms}, \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 |
41 | fade out. Other valid values: \setting{500ms}, \setting{1s}, | 41 | fade out. Other valid values: \setting{500ms}, \setting{1s}, |
42 | \setting{2s}, \setting{3s}, \setting{4s}, \setting{5s} or | 42 | \setting{2s}, \setting{3s}, \setting{4s}, \setting{5s} or |
43 | \setting{10s}. | 43 | \setting{10s}. |
44 | } | 44 | } |
45 | \opt{backlight_fade_bool}{ | 45 | \opt{backlight_fade_bool}{ |
@@ -56,21 +56,51 @@ | |||
56 | With this option enabled the first keypress while the backlight is turned | 56 | With this option enabled the first keypress while the backlight is turned |
57 | off will only turn the backlight on without having any other effect. When | 57 | off will only turn the backlight on without having any other effect. When |
58 | disabled the first keypress will \emph{also} perform its appropriate action. | 58 | disabled the first keypress will \emph{also} perform its appropriate action. |
59 | 59 | ||
60 | \item[\label{ref:selectivebacklight}Selective Backlight] | ||
61 | This option allows some selected actions in While Playing Screen and | ||
62 | FM screen to \emph{not} turn on the backlight in order to save power. | ||
63 | \begin{description} | ||
64 | \item[Enabled.] | ||
65 | Enables/disables the feature. | ||
66 | |||
67 | \item[Settings.] | ||
68 | Allows to select actions that will \emph{not} activate backlight. | ||
69 | \begin{itemize} | ||
70 | \item[Volume.] | ||
71 | Volume up/down. | ||
72 | \item[Play.] | ||
73 | Toggling Play/Pause. | ||
74 | \item[Seek.] | ||
75 | Seeking in a track. | ||
76 | \item[Skip.] | ||
77 | Skipping of a track. | ||
78 | \item[Disable Unmapped Keys.] | ||
79 | Buttons that have no action assigned and accidental button | ||
80 | combinations don't turn on backlight. | ||
81 | \item[Disable on External Power.] | ||
82 | When plugged goes back to regular behavior. | ||
83 | \end{itemize} | ||
84 | Selected actions are indicated by a leading +. | ||
85 | Note: If all options get de-selected, the entire feature is disabled. | ||
86 | \end{description} | ||
87 | |||
88 | |||
89 | |||
60 | \opt{lcd_sleep}{ | 90 | \opt{lcd_sleep}{ |
61 | \item[Sleep (After Backlight Off).] | 91 | \item[Sleep (After Backlight Off).] |
62 | This setting controls how long rockbox will wait before turning off the | 92 | This setting controls how long rockbox will wait before turning off the |
63 | display after the backlight is turned off. Turning off the display | 93 | display after the backlight is turned off. Turning off the display |
64 | saves battery power but turning on the display takes noticeably longer | 94 | saves battery power but turning on the display takes noticeably longer |
65 | than just turning on the backlight. | 95 | than just turning on the backlight. |
66 | } | 96 | } |
67 | 97 | ||
68 | \opt{backlight_brightness}{ | 98 | \opt{backlight_brightness}{ |
69 | \item[Brightness.] | 99 | \item[Brightness.] |
70 | Changes the brightness of your LCD display. | 100 | Changes the brightness of your LCD display. |
71 | } | 101 | } |
72 | } % \opt{HAVE_BACKLIGHT} | 102 | } % \opt{HAVE_BACKLIGHT} |
73 | 103 | ||
74 | \opt{lcd_contrast}{ | 104 | \opt{lcd_contrast}{ |
75 | \item[Contrast.] | 105 | \item[Contrast.] |
76 | Changes the contrast of your LCD display. | 106 | Changes the contrast of your LCD display. |
@@ -122,7 +152,7 @@ | |||
122 | This setting lets you invert the whole screen, so now you get a | 152 | This setting lets you invert the whole screen, so now you get a |
123 | black background and light text and graphics. | 153 | black background and light text and graphics. |
124 | \item[Upside Down.] | 154 | \item[Upside Down.] |
125 | Displays the screen so that the top of the display is nearest | 155 | Displays the screen so that the top of the display is nearest |
126 | the buttons. This is sometimes useful when carrying the \dap\ in a | 156 | the buttons. This is sometimes useful when carrying the \dap\ in a |
127 | pocket for easy access to the headphone socket. | 157 | pocket for easy access to the headphone socket. |
128 | \opt{remote_ticking}{ | 158 | \opt{remote_ticking}{ |
@@ -138,7 +168,7 @@ | |||
138 | the following parameters: | 168 | the following parameters: |
139 | \begin{description} | 169 | \begin{description} |
140 | \item[Scroll Speed.] | 170 | \item[Scroll Speed.] |
141 | Sets how many times per second the automatic horizontal scrolling text | 171 | Sets how many times per second the automatic horizontal scrolling text |
142 | will move a step. | 172 | will move a step. |
143 | \item[Scroll Start Delay.] | 173 | \item[Scroll Start Delay.] |
144 | Controls how many milliseconds Rockbox should wait before a new | 174 | Controls how many milliseconds Rockbox should wait before a new |
@@ -184,23 +214,23 @@ | |||
184 | useful on slow displays. | 214 | useful on slow displays. |
185 | \nopt{scrollwheel}{ | 215 | \nopt{scrollwheel}{ |
186 | \item[List Acceleration Start Delay.] | 216 | \item[List Acceleration Start Delay.] |
187 | This setting enables the acceleration of scroll speed in lists when | 217 | This setting enables the acceleration of scroll speed in lists when |
188 | holding \ActionStdPrev{} or \ActionStdNext{}. When set to | 218 | holding \ActionStdPrev{} or \ActionStdNext{}. When set to |
189 | \setting{Off} the acceleration is disabled. When any other value is set | 219 | \setting{Off} the acceleration is disabled. When any other value is set |
190 | the acceleration will start to accelerate after holding | 220 | the acceleration will start to accelerate after holding |
191 | \ActionStdPrev{} or \ActionStdNext{} for the chosen time (in | 221 | \ActionStdPrev{} or \ActionStdNext{} for the chosen time (in |
192 | seconds). | 222 | seconds). |
193 | \item[List Acceleration Speed.] | 223 | \item[List Acceleration Speed.] |
194 | This setting controls how fast the scroll speed accelerates. The scroll | 224 | This setting controls how fast the scroll speed accelerates. The scroll |
195 | speed will increase every N seconds. For example, selecting | 225 | speed will increase every N seconds. For example, selecting |
196 | \setting{Speed up every 3s} will increase the scroll speed every 3 | 226 | \setting{Speed up every 3s} will increase the scroll speed every 3 |
197 | seconds while \ActionStdPrev{} or \ActionStdNext{} is held. | 227 | seconds while \ActionStdPrev{} or \ActionStdNext{} is held. |
198 | } | 228 | } |
199 | \end{description} | 229 | \end{description} |
200 | % | 230 | % |
201 | \opt{lcd_bitmap}{ | 231 | \opt{lcd_bitmap}{ |
202 | \item[Peak Meter.] | 232 | \item[Peak Meter.] |
203 | The peak meter can be configured with a number of parameters. | 233 | The peak meter can be configured with a number of parameters. |
204 | \begin{description} | 234 | \begin{description} |
205 | \item[Peak Release.] | 235 | \item[Peak Release.] |
206 | This determines how fast the bar shrinks when the music becomes | 236 | This determines how fast the bar shrinks when the music becomes |
@@ -216,7 +246,7 @@ | |||
216 | \item[Clip Hold Time.] | 246 | \item[Clip Hold Time.] |
217 | The number of seconds that the clipping indicator will be visible | 247 | The number of seconds that the clipping indicator will be visible |
218 | after clipping is detected. | 248 | after clipping is detected. |
219 | \opt{recording}{ | 249 | \opt{recording}{ |
220 | \item[Clip Counter.] | 250 | \item[Clip Counter.] |
221 | Show the number of times the clip indicator went active during | 251 | Show the number of times the clip indicator went active during |
222 | recording in front of the peak meters. | 252 | recording in front of the peak meters. |
diff --git a/manual/configure_rockbox/system_options.tex b/manual/configure_rockbox/system_options.tex index b505175a68..ff2967cec7 100644..100755 --- a/manual/configure_rockbox/system_options.tex +++ b/manual/configure_rockbox/system_options.tex | |||
@@ -167,11 +167,11 @@ this option \setting{On}. If it is not required, then turning this setting | |||
167 | 167 | ||
168 | \opt{lineout_poweroff}{ | 168 | \opt{lineout_poweroff}{ |
169 | \subsection{\label{ref:LineoutOnOff}Line Out} | 169 | \subsection{\label{ref:LineoutOnOff}Line Out} |
170 | This option turns the \dap{}'s line-out \setting{On} and \setting{Off}. On some | 170 | This option turns the \dap{}'s line-out \setting{On} and \setting{Off}. On some |
171 | devices an enabled line-out will consume some power even if not used. If it is | 171 | devices an enabled line-out will consume some power even if not used. If it is |
172 | not required, then turning this setting \setting{Off} will save battery and | 172 | not required, then turning this setting \setting{Off} will save battery and |
173 | therefore result in better runtime. | 173 | therefore result in better runtime. |
174 | } | 174 | } |
175 | 175 | ||
176 | \opt{HAVE_BUTTON_LIGHTS}{ | 176 | \opt{HAVE_BUTTON_LIGHTS}{ |
177 | \opt{e200,e200v2}{ | 177 | \opt{e200,e200v2}{ |
@@ -243,6 +243,61 @@ therefore result in better runtime. | |||
243 | 243 | ||
244 | 244 | ||
245 | 245 | ||
246 | |||
247 | \nopt{HAS_BUTTON_HOLD}{ | ||
248 | \subsection{Advanced Key Lock} | ||
249 | This option allows users to select actions that when within WPS or FMS will \emph{not} be | ||
250 | blocked by the key lock (software hold switch). | ||
251 | |||
252 | |||
253 | \begin{description} | ||
254 | \item[Enabled.] | ||
255 | Enables/disables the feature. | ||
256 | |||
257 | \item[Settings.] | ||
258 | Allows to select actions that will \emph{not} be blocked by the key lock. | ||
259 | \begin{itemize} | ||
260 | \item[Volume.] | ||
261 | Volume up/down. | ||
262 | \item[Play.] | ||
263 | Toggling Play/Pause. | ||
264 | \item[Seek.] | ||
265 | Seeking in a track. | ||
266 | \item[Skip.] | ||
267 | Skipping of a track. | ||
268 | \opt{HAVE_BACKLIGHT}{ | ||
269 | \item[Autolock On.] | ||
270 | When the backlight turns off, softlock will lock the screen, | ||
271 | activates when you press the lock key and if you manually lock | ||
272 | again, while active it then disables autolock. | ||
273 | \begin{itemize} | ||
274 | \item | ||
275 | (Lock Button Pressed \#1) >Auto Lock On | ||
276 | (device still unlocked till backlight timeout). | ||
277 | \item | ||
278 | (Lock Button Pressed \#2) >Auto Lock Off (device locked). | ||
279 | \item | ||
280 | (Lock Button Pressed \#3) >(device unlocked). | ||
281 | \end{itemize} | ||
282 | } %\opt{HAVE_BACKLIGHT} | ||
283 | \opt{touchpad}{ | ||
284 | \item[Disable Touch.] | ||
285 | Blocks touch screen buttons like the original. | ||
286 | } | ||
287 | \item[Disable Notify.] | ||
288 | Suppresses the notification 'Buttons Locked' | ||
289 | (still will if power button is pressed). | ||
290 | \note{This is a pre-requisite for \setting{selectivebacklight} | ||
291 | \reference{ref:selectivebacklight} to work also during key lock.} | ||
292 | |||
293 | \end{itemize} | ||
294 | Selected actions are indicated by a leading +. | ||
295 | Note: If all options get de-selected, the entire feature is disabled. | ||
296 | |||
297 | \end{description} | ||
298 | } %\nopt{HAS_BUTTON_HOLD} | ||
299 | |||
300 | |||
246 | \opt{usb_hid}{ | 301 | \opt{usb_hid}{ |
247 | \subsection{\label{ref:USB_HID}USB HID} | 302 | \subsection{\label{ref:USB_HID}USB HID} |
248 | This option turns the USB HID feature \setting{On} and \setting{Off}. | 303 | This option turns the USB HID feature \setting{On} and \setting{Off}. |
@@ -550,7 +605,7 @@ therefore result in better runtime. | |||
550 | \\ | 605 | \\ |
551 | \end{btnmap} | 606 | \end{btnmap} |
552 | 607 | ||
553 | \item [Browser.] This mode lets you control a web browser (e.g. | 608 | \item [Browser.] This mode lets you control a web browser (e.g. |
554 | Firefox). It uses the \dap{}'s keys to navigate through the web page | 609 | Firefox). It uses the \dap{}'s keys to navigate through the web page |
555 | and different tabs, navigate through history, and to control zoom. | 610 | and different tabs, navigate through history, and to control zoom. |
556 | 611 | ||
@@ -592,7 +647,7 @@ therefore result in better runtime. | |||
592 | \\ | 647 | \\ |
593 | } | 648 | } |
594 | 649 | ||
595 | % Zoom in / out | 650 | % Zoom in / out |
596 | \opt{SANSA_FUZEPLUS_PAD}{Long \ButtonBottomRight} | 651 | \opt{SANSA_FUZEPLUS_PAD}{Long \ButtonBottomRight} |
597 | \opt{SANSA_E200_PAD,SANSA_C200_PAD,SANSA_CLIP_PAD} | 652 | \opt{SANSA_E200_PAD,SANSA_C200_PAD,SANSA_CLIP_PAD} |
598 | {Long \ButtonUp / Long \ButtonDown} | 653 | {Long \ButtonUp / Long \ButtonDown} |
@@ -707,13 +762,13 @@ therefore result in better runtime. | |||
707 | ,SANSA_CLIP_PAD,MROBE100_PAD,PBELL_VIBE500_PAD,SANSA_FUZEPLUS_PAD% | 762 | ,SANSA_CLIP_PAD,MROBE100_PAD,PBELL_VIBE500_PAD,SANSA_FUZEPLUS_PAD% |
708 | ,SAMSUNG_YH92X_PAD,SAMSUNG_YH820_PAD} | 763 | ,SAMSUNG_YH92X_PAD,SAMSUNG_YH820_PAD} |
709 | {\ButtonUp / \ButtonDown / \ButtonLeft / \ButtonRight} | 764 | {\ButtonUp / \ButtonDown / \ButtonLeft / \ButtonRight} |
710 | \opt{IRIVER_H10_PAD}{\ButtonScrollUp / \ButtonScrollDown / | 765 | \opt{IRIVER_H10_PAD}{\ButtonScrollUp / \ButtonScrollDown / |
711 | \ButtonLeft / \ButtonRight} | 766 | \ButtonLeft / \ButtonRight} |
712 | \opt{IPOD_4G_PAD,IPOD_3G_PAD,IPOD_1G2G_PAD} | 767 | \opt{IPOD_4G_PAD,IPOD_3G_PAD,IPOD_1G2G_PAD} |
713 | {\ButtonMenu / \ButtonPlay / \ButtonLeft / \ButtonRight} | 768 | {\ButtonMenu / \ButtonPlay / \ButtonLeft / \ButtonRight} |
714 | & | 769 | & |
715 | \opt{HAVEREMOTEKEYMAP}{ | 770 | \opt{HAVEREMOTEKEYMAP}{ |
716 | \opt{MROBE100_RC_PAD}{\ButtonRCPlay / \ButtonRCDisplay / | 771 | \opt{MROBE100_RC_PAD}{\ButtonRCPlay / \ButtonRCDisplay / |
717 | \ButtonRCRew / \ButtonRCFF}% | 772 | \ButtonRCRew / \ButtonRCFF}% |
718 | &} | 773 | &} |
719 | Cursor move up / down / left / right, respectively | 774 | Cursor move up / down / left / right, respectively |