blob: e482417f0bb3db139bcf5001c5ff889aa31d5b64 [file] [log] [blame]
Dominik Riebeling3817a3e2006-04-08 22:46:22 +00001% $Id$ %
Nils Wallménius909b9462007-03-03 00:07:31 +00002\section{\label{ref:Displayoptions}Display}
William Wilgusdc87e9e2016-11-22 06:21:31 +01003
Dominik Riebeling3817a3e2006-04-08 22:46:22 +00004 \begin{description}
Marianne Arnold01601da2006-12-02 09:47:05 +00005
Tomer Shaleve04acd82009-10-05 16:40:27 +00006 \item[LCD Settings.]
Martin Arverf8e2f3e2006-10-17 12:18:51 +00007 This sub menu contains settings that relate to the display of the \dap.
Dominik Riebeling3817a3e2006-04-08 22:46:22 +00008 \begin{description}
Nils Wallméniuscd5d9502007-11-05 14:36:31 +00009 \opt{HAVE_BACKLIGHT}{
Tomer Shaleve04acd82009-10-05 16:40:27 +000010 \item[Backlight.]
Nils Wallménius6f74f692006-07-25 20:16:12 +000011 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
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
15 after a button press.
Tomer Shaleve04acd82009-10-05 16:40:27 +000016 \item[Backlight (While Plugged In).]
Nils Wallméniuscd5d9502007-11-05 14:36:31 +000017 This setting is equivalent to the \setting{Backlight} setting except it
18 applies when the \dap{} is plugged into the charger.
Tomer Shaleve04acd82009-10-05 16:40:27 +000019 \item[Backlight on Hold.]
Nils Wallméniuscd5d9502007-11-05 14:36:31 +000020 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.
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
24 be turned on and stay on while the Hold switch is engaged.
Tomer Shaleve04acd82009-10-05 16:40:27 +000025 \item[Caption Backlight.]
Nils Wallménius6f74f692006-07-25 20:16:12 +000026 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
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
30 setting, but is no less than 5 seconds.
Thomas Martitz12a0ed32009-01-26 23:21:49 +000031 \opt{backlight_fade_int}{
Tomer Shaleve04acd82009-10-05 16:40:27 +000032 \item[Backlight Fade In.]
Nils Wallménius6f74f692006-07-25 20:16:12 +000033 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
William Wilgusdc87e9e2016-11-22 06:21:31 +010035 turn on immediately, with no fade in. Can also be set to
Andree Buschmann1248e9c2010-04-14 20:38:21 +000036 \setting{500ms}, \setting{1s} or \setting{2s}.
Tomer Shaleve04acd82009-10-05 16:40:27 +000037 \item[Backlight Fade Out.]
Nils Wallménius6f74f692006-07-25 20:16:12 +000038 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
40 set to \setting{Off} the backlight will turn off immediately, with no
Andree Buschmann1248e9c2010-04-14 20:38:21 +000041 fade out. Other valid values: \setting{500ms}, \setting{1s},
William Wilgusdc87e9e2016-11-22 06:21:31 +010042 \setting{2s}, \setting{3s}, \setting{4s}, \setting{5s} or
Andree Buschmann1248e9c2010-04-14 20:38:21 +000043 \setting{10s}.
Nils Wallménius6f74f692006-07-25 20:16:12 +000044 }
Thomas Martitz12a0ed32009-01-26 23:21:49 +000045 \opt{backlight_fade_bool}{
Tomer Shaleve04acd82009-10-05 16:40:27 +000046 \item[Backlight Fade In.]
Nils Wallméniuse73383e2008-11-26 13:17:18 +000047 This options turns on smooth backlight fading when the backlight is
Michael Chicoine2bfcb6e2009-11-29 20:50:54 +000048 turning on. The fading time is dependent on the brightness level you
Nils Wallméniuse73383e2008-11-26 13:17:18 +000049 have chosen. If it is turned off, the backlight will turn on immediately.
Tomer Shaleve04acd82009-10-05 16:40:27 +000050 \item[Backlight Fade Out.]
Nils Wallméniuse73383e2008-11-26 13:17:18 +000051 This options turns on smooth backlight fading when the backlight is
Michael Chicoine2bfcb6e2009-11-29 20:50:54 +000052 turning off. The fading time is dependent on the brightness level you
Nils Wallméniuse73383e2008-11-26 13:17:18 +000053 have chosen. If it is turned off, the backlight will turn off immediately.
54 }
Tomer Shaleve04acd82009-10-05 16:40:27 +000055 \item[First Keypress Enables Backlight Only.]
Nils Wallménius6f74f692006-07-25 20:16:12 +000056 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
58 disabled the first keypress will \emph{also} perform its appropriate action.
William Wilgusdc87e9e2016-11-22 06:21:31 +010059
Johannes Rauhc1097cc2017-04-30 18:23:42 +020060 \item[\label{ref:selectivebacklight}Backlight Exemptions]
William Wilgusdc87e9e2016-11-22 06:21:31 +010061 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
Nils Wallménius12eb0582008-03-23 22:07:09 +000090 \opt{lcd_sleep}{
Tomer Shaleve04acd82009-10-05 16:40:27 +000091 \item[Sleep (After Backlight Off).]
Nils Wallméniuscd5d9502007-11-05 14:36:31 +000092 This setting controls how long rockbox will wait before turning off the
93 display after the backlight is turned off. Turning off the display
William Wilgusdc87e9e2016-11-22 06:21:31 +010094 saves battery power but turning on the display takes noticeably longer
Andree Buschmann10023ad2010-03-29 17:58:17 +000095 than just turning on the backlight.
Nils Wallméniuscd5d9502007-11-05 14:36:31 +000096 }
William Wilgusdc87e9e2016-11-22 06:21:31 +010097
Nils Wallménius12eb0582008-03-23 22:07:09 +000098 \opt{backlight_brightness}{
Tomer Shaleve04acd82009-10-05 16:40:27 +000099 \item[Brightness.]
Michael DiFebbo8fdf5aa2006-06-04 12:46:13 +0000100 Changes the brightness of your LCD display.
Nils Wallménius6f74f692006-07-25 20:16:12 +0000101 }
Nils Wallméniuscd5d9502007-11-05 14:36:31 +0000102 } % \opt{HAVE_BACKLIGHT}
William Wilgusdc87e9e2016-11-22 06:21:31 +0100103
Rafaël Carré895e1042010-07-14 06:48:41 +0000104 \opt{lcd_contrast}{
Tomer Shaleve04acd82009-10-05 16:40:27 +0000105 \item[Contrast.]
Nils Wallménius6f74f692006-07-25 20:16:12 +0000106 Changes the contrast of your LCD display.
107 \warn{Setting the contrast too dark or too light can make it hard to
108 find this menu option again!}
Rafaël Carré895e1042010-07-14 06:48:41 +0000109 }
Nils Wallménius8b782092007-10-13 07:59:32 +0000110
Nils Wallménius12eb0582008-03-23 22:07:09 +0000111 \opt{lcd_invert}{
Tomer Shaleve04acd82009-10-05 16:40:27 +0000112 \item[LCD Mode.]
Nils Wallméniuscd5d9502007-11-05 14:36:31 +0000113 This setting lets you invert the colours of the display.
114 }
115
Nils Wallménius12eb0582008-03-23 22:07:09 +0000116 \opt{lcd_flip}{
Tomer Shaleve04acd82009-10-05 16:40:27 +0000117 \item[Upside Down.]
Nils Wallméniuscd5d9502007-11-05 14:36:31 +0000118 Displays the screen so that the top of the display is nearest the buttons.
119 This is sometimes useful when carrying the \dap{} in a pocket for easy
120 access to the headphone socket.
121 }
Dominik Riebeling3817a3e2006-04-08 22:46:22 +0000122 \end{description}
123%
Marianne Arnoldb43b4932011-01-17 18:30:18 +0000124 \opt{remote}{
Tomer Shaleve04acd82009-10-05 16:40:27 +0000125 \item[Remote-LCD Settings.]
Martin Arverf8e2f3e2006-10-17 12:18:51 +0000126 This sub menu contains settings that relate to the display of the remote.
Dominik Riebeling3817a3e2006-04-08 22:46:22 +0000127 \begin{description}
Tomer Shaleve04acd82009-10-05 16:40:27 +0000128 \item[Backlight.]
Dominik Riebeling3817a3e2006-04-08 22:46:22 +0000129 Similar to the main unit backlight this option controls the backlight
130 timeout for the remote control. The remote backlight is independent
131 from the main unit backlight.
Tomer Shaleve04acd82009-10-05 16:40:27 +0000132 \item[Backlight on When Plugged.]
Dominik Riebeling3817a3e2006-04-08 22:46:22 +0000133 This controls the backlight when the \dap\ is plugged into the charger.
Tomer Shaleve04acd82009-10-05 16:40:27 +0000134 \item[Caption Backlight.]
Nils Wallménius6f74f692006-07-25 20:16:12 +0000135 This option turns on the backlight a number of seconds before the start
136 of a new track, and keeps it on for the same number of seconds after the
137 beginning so that the display can be read to see song information. The
138 amount of time is determined by the value of the backlight timeout
139 setting, but is no less than 5 seconds.
Tomer Shaleve04acd82009-10-05 16:40:27 +0000140 \item[First Keypress Enables Backlight Only.]
Nils Wallménius6f74f692006-07-25 20:16:12 +0000141 This controls what happens when you press a button on your remote
142 while the backlight is turned off. Like for the main unit, if this
143 setting is set to \setting{Yes}, the first keypress will light up the
144 remote backlight, but have no other effect. If set to \setting{No},
145 the first keypress will light up the remote backlight
Dominik Riebeling3817a3e2006-04-08 22:46:22 +0000146 \emph{and} engage the function of the key that is pressed.
Tomer Shaleve04acd82009-10-05 16:40:27 +0000147 \item[Contrast.]
Nils Wallménius6f74f692006-07-25 20:16:12 +0000148 Changes the contrast of your remote's LCD display.
149 \warn{Setting the contrast too dark or too light can make it hard to
Dominik Riebeling3817a3e2006-04-08 22:46:22 +0000150 find this menu option again!}
Tomer Shaleve04acd82009-10-05 16:40:27 +0000151 \item[LCD Mode.]
Nils Wallménius6f74f692006-07-25 20:16:12 +0000152 This setting lets you invert the whole screen, so now you get a
Dominik Riebeling3817a3e2006-04-08 22:46:22 +0000153 black background and light text and graphics.
Tomer Shaleve04acd82009-10-05 16:40:27 +0000154 \item[Upside Down.]
William Wilgusdc87e9e2016-11-22 06:21:31 +0100155 Displays the screen so that the top of the display is nearest
Nils Wallménius6f74f692006-07-25 20:16:12 +0000156 the buttons. This is sometimes useful when carrying the \dap\ in a
Dominik Riebeling3817a3e2006-04-08 22:46:22 +0000157 pocket for easy access to the headphone socket.
Marianne Arnoldb43b4932011-01-17 18:30:18 +0000158 \opt{remote_ticking}{
Tomer Shaleve04acd82009-10-05 16:40:27 +0000159 \item[Reduce Ticking.]
Nils Wallménius6f74f692006-07-25 20:16:12 +0000160 Enable this option if you can hear a ticking sound in your headphones
161 when using your remote.
162 }
Dominik Riebeling3817a3e2006-04-08 22:46:22 +0000163 \end{description}
Nils Wallménius6f74f692006-07-25 20:16:12 +0000164 }
165%
Tomer Shaleve04acd82009-10-05 16:40:27 +0000166 \item[Scrolling.]
Nils Wallménius6f74f692006-07-25 20:16:12 +0000167 This feature controls how text will scroll in Rockbox. You can configure
Dominik Riebeling3817a3e2006-04-08 22:46:22 +0000168 the following parameters:
169 \begin{description}
Tomer Shaleve04acd82009-10-05 16:40:27 +0000170 \item[Scroll Speed.]
William Wilgusdc87e9e2016-11-22 06:21:31 +0100171 Sets how many times per second the automatic horizontal scrolling text
Marc Guaye028cff2008-06-21 19:06:52 +0000172 will move a step.
Tomer Shaleve04acd82009-10-05 16:40:27 +0000173 \item[Scroll Start Delay.]
Nils Wallménius6f74f692006-07-25 20:16:12 +0000174 Controls how many milliseconds Rockbox should wait before a new
Marc Guaye028cff2008-06-21 19:06:52 +0000175 text begins automatically scrolling.
Nils Wallménius12eb0582008-03-23 22:07:09 +0000176 \opt{lcd_bitmap}{
Tomer Shaleve04acd82009-10-05 16:40:27 +0000177 \item[Scroll Step Size.]
Marc Guaye028cff2008-06-21 19:06:52 +0000178 Defines the number of pixels the text should move for each step, as used
179 by the Scroll Speed setting.
Nils Wallménius6f74f692006-07-25 20:16:12 +0000180 }
Marianne Arnoldb43b4932011-01-17 18:30:18 +0000181 \opt{remote}{
Tomer Shaleve04acd82009-10-05 16:40:27 +0000182 \item[Remote Scrolling Options.]
Nils Wallménius6f74f692006-07-25 20:16:12 +0000183 The options here have the same effect on the remote LCD as the options
184 mentioned above have on the main LCD.
185 }
Tomer Shaleve04acd82009-10-05 16:40:27 +0000186 \item[Bidirectional Scroll Limit.]
Marc Guaye028cff2008-06-21 19:06:52 +0000187 Rockbox has two different automatic horizontal scrolling methods: 1) always
188 scrolling the text to the left until the line has ended and then beginning
189 again at the start, and 2) moving to the left until you can read the end of
190 the line and then scrolling right until you see the beginning again.
191 Rockbox chooses which method it should use depending of how much it has to
192 scroll to the left. This setting lets you tell Rockbox where that limit
193 is, expressed in percentage of the line length.
Nils Wallménius12eb0582008-03-23 22:07:09 +0000194 \opt{lcd_bitmap}{
Tomer Shaleve04acd82009-10-05 16:40:27 +0000195 \item[Screen Scrolls Out of View.]
Marc Guaye028cff2008-06-21 19:06:52 +0000196 Screens can be manually scrolled horizontally by pressing
Marianne Arnold792ccc12010-08-16 10:03:00 +0000197 \opt{RECORDER_PAD}{\ButtonOn+\ButtonRight/\ButtonLeft}%
198 \opt{ONDIO_PAD}{\ButtonMenu+\ButtonRight/\ButtonLeft}%
199 \opt{IRIVER_H10_PAD}{Long \ButtonRew/\ButtonFF}%
Marcin Bukat4bbc9f62012-01-26 10:11:18 +0100200 \nopt{RECORDER_PAD,ONDIO_PAD,IRIVER_H10_PAD,MPIO_HD200_PAD,MPIO_HD300_PAD%
201 ,touchscreen}{%
Marianne Arnold792ccc12010-08-16 10:03:00 +0000202 Long \ButtonRight/\ButtonLeft}.
Marc Guaye028cff2008-06-21 19:06:52 +0000203 Setting this option to \setting{Yes}
204 will keep the list entries at their fixed positions and allow them to be
205 scrolled out of view, whereas \setting{No} will only scroll those entries
206 which surpass the right margin.
Tomer Shaleve04acd82009-10-05 16:40:27 +0000207 \item[Screen Scroll Step Size.]
Marc Guaye028cff2008-06-21 19:06:52 +0000208 Defines the number of pixels the horizontal manual screen scroll should move
209 for each step.
Nils Wallménius6f74f692006-07-25 20:16:12 +0000210 }
Tomer Shaleve04acd82009-10-05 16:40:27 +0000211 \item[Paged Scrolling.]
Marc Guaye028cff2008-06-21 19:06:52 +0000212 When set to \setting{Yes} scrolling vertically on pages that surpass the
Marianne Arnold63283d22009-02-12 11:32:19 +0000213 screen size will page up/down instead of simply changing lines. This can be
214 useful on slow displays.
Andree Buschmann08977532011-03-22 21:15:22 +0000215 \nopt{scrollwheel}{
216 \item[List Acceleration Start Delay.]
William Wilgusdc87e9e2016-11-22 06:21:31 +0100217 This setting enables the acceleration of scroll speed in lists when
218 holding \ActionStdPrev{} or \ActionStdNext{}. When set to
219 \setting{Off} the acceleration is disabled. When any other value is set
Andree Buschmann08977532011-03-22 21:15:22 +0000220 the acceleration will start to accelerate after holding
William Wilgusdc87e9e2016-11-22 06:21:31 +0100221 \ActionStdPrev{} or \ActionStdNext{} for the chosen time (in
Andree Buschmann08977532011-03-22 21:15:22 +0000222 seconds).
223 \item[List Acceleration Speed.]
William Wilgusdc87e9e2016-11-22 06:21:31 +0100224 This setting controls how fast the scroll speed accelerates. The scroll
225 speed will increase every N seconds. For example, selecting
226 \setting{Speed up every 3s} will increase the scroll speed every 3
Alex Parkere4da0c82011-03-23 21:22:55 +0000227 seconds while \ActionStdPrev{} or \ActionStdNext{} is held.
Andree Buschmann08977532011-03-22 21:15:22 +0000228 }
Dominik Riebeling3817a3e2006-04-08 22:46:22 +0000229 \end{description}
Nils Wallménius6f74f692006-07-25 20:16:12 +0000230%
Nils Wallménius12eb0582008-03-23 22:07:09 +0000231 \opt{lcd_bitmap}{
Tomer Shaleve04acd82009-10-05 16:40:27 +0000232 \item[Peak Meter.]
William Wilgusdc87e9e2016-11-22 06:21:31 +0100233 The peak meter can be configured with a number of parameters.
Dominik Riebeling3817a3e2006-04-08 22:46:22 +0000234 \begin{description}
Tomer Shaleve04acd82009-10-05 16:40:27 +0000235 \item[Peak Release.]
Nils Wallménius6f74f692006-07-25 20:16:12 +0000236 This determines how fast the bar shrinks when the music becomes
Dominik Riebeling3817a3e2006-04-08 22:46:22 +0000237 softer. Lower values make the peak meter look smoother.
Andree Buschmann1248e9c2010-04-14 20:38:21 +0000238 Expressed in scale units per 10~ms.
Tomer Shaleve04acd82009-10-05 16:40:27 +0000239 \item[Peak Hold Time.]
Nils Wallménius6f74f692006-07-25 20:16:12 +0000240 Specifies the time after which the peak indicator will reset.
Andree Buschmann1248e9c2010-04-14 20:38:21 +0000241 For example, if you set this value to 5~s, the peak indicator displays
Nils Wallménius6f74f692006-07-25 20:16:12 +0000242 the loudest volume value that occurred within the last 5 seconds.
243 Larger values are useful if you want to find the peak level of a song,
244 which might be of interest when copying music from the \dap\ via the
Dominik Riebeling3817a3e2006-04-08 22:46:22 +0000245 analogue output to some other recording device.
Tomer Shaleve04acd82009-10-05 16:40:27 +0000246 \item[Clip Hold Time.]
Nils Wallménius6f74f692006-07-25 20:16:12 +0000247 The number of seconds that the clipping indicator will be visible
Dominik Riebeling3817a3e2006-04-08 22:46:22 +0000248 after clipping is detected.
William Wilgusdc87e9e2016-11-22 06:21:31 +0100249 \opt{recording}{
Tomer Shaleve04acd82009-10-05 16:40:27 +0000250 \item[Clip Counter.]
Peter D'Hoyefacc7862007-08-26 22:02:09 +0000251 Show the number of times the clip indicator went active during
Bertrik Sikkenbb8bc322008-07-03 14:21:01 +0000252 recording in front of the peak meters.
Peter D'Hoyefacc7862007-08-26 22:02:09 +0000253 }
Tomer Shaleve04acd82009-10-05 16:40:27 +0000254 \item[\label{ref:Peakmetersetting}Scale.]
Nils Wallménius6f74f692006-07-25 20:16:12 +0000255 Select whether the peak meter displays linear or logarithmic values.
256 The human ear perceives loudness on a logarithmic scale. If the Scale
257 setting is set to \setting{Logarithmic} (dB) scale, the volume values
258 are scaled logarithmically. The volume meters of digital audio
259 devices usually are scaled this way. On the other hand, if you
260 are interested in the power level that is applied to your headphones
261 you should choose \setting{Linear} display. This setting cannot be
262 displayed in units like volts or watts because such units depend
Dominik Riebeling3817a3e2006-04-08 22:46:22 +0000263 on your headphones.
Tomer Shaleve04acd82009-10-05 16:40:27 +0000264 \item[Minimum and maximum range.]
Nils Wallménius6f74f692006-07-25 20:16:12 +0000265 These two options define the full value range that the peak meter
266 displays. Recommended values for the \setting{Logarithmic} (dB) setting
Andree Buschmann1248e9c2010-04-14 20:38:21 +0000267 are {}-40~dB for minimum and 0~dB for maximum. Recommended values
268 for \setting{Linear} display are 0 and 100\%. Note that {}-40~dB is
Nils Wallménius6f74f692006-07-25 20:16:12 +0000269 approximately 1\% in linear value, but if you change the minimum
270 setting in linear mode slightly and then change to the dB scale,
271 there will be a large change. You can use these values for `zooming'
Dominik Riebeling3817a3e2006-04-08 22:46:22 +0000272 into the peak meter.
273 \end{description}
Michael DiFebbo25f9cec2006-03-27 19:30:05 +0000274 }
Tomer Shaleve04acd82009-10-05 16:40:27 +0000275 \item[\label{ref:Defaultcodepage}Default Codepage.]
Thom Johansenc479b992008-02-13 13:32:44 +0000276 A codepage describes the way extended characters that are not available
277 within the ASCII character set are encoded. ID3v1 tags do not have a
Dominik Riebeling3817a3e2006-04-08 22:46:22 +0000278 codepage encoding contained so Rockbox needs to know what encoding has
279 been used when generating these tags. This should be ``ISO-8859-1'' but
280 to support languages outside Western Europe most applications use
281 the setting of your operating system instead. If your operating system
Thom Johansenc479b992008-02-13 13:32:44 +0000282 uses a different codepage and you are getting garbled extended characters
Nils Wallménius6f74f692006-07-25 20:16:12 +0000283 you should adjust this settings. In most cases sticking to
Dominik Riebeling3817a3e2006-04-08 22:46:22 +0000284 ``ISO-8859-1'' would be sufficient.
285 \end{description}