manual/configure_rockbox/display_options.tex

   1 % $Id$ %
   2 \section{\label{ref:Displayoptions}Display}
   3
   4   \begin{description}
   5
   6   \item[LCD Settings:]
   7     This sub menu contains settings that relate to the display of the \dap.
   8     \begin{description}
   9     \opt{HAVE_BACKLIGHT}{
  10       \item[Backlight:]
  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
  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.
  16       \item[Backlight (While Plugged In):]
  17       This setting is equivalent to the \setting{Backlight} setting except it
  18       applies when the \dap{} is plugged into the charger.
  19       \item[Backlight on Hold:]
  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.
  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.
  25       \item[Caption Backlight:]
  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
  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.
  31       \opt{backlight_fade_int}{
  32         \item[Backlight Fade In:]
  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
  35         turn on immediately, with no fade in. Can also be set to \setting{500ms},
  36         \setting{1s} or \setting{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. If
  40         set to \setting{Off} the backlight will turn off immediately, with no
  41         fade out. Other valid values: \setting{500ms}, \setting{1s},
  42         \setting{2s}, \setting{3s}, \setting{4s}, \setting{5s} or \setting{10s}.
  43       }
  44       \opt{backlight_fade_bool}{
  45         \item[Backlight Fade In:]
  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
  48         have chosen. If it is turned off, the backlight will turn on immediately.
  49         \item[Backlight Fade Out:]
  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
  52         have chosen. If it is turned off, the backlight will turn off immediately.
  53       }
  54       \item[First Keypress Enables Backlight Only:]
  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
  57       disabled the first keypress will \emph{also} perform its appropriate action.
  58
  59       \opt{lcd_sleep}{
  60         \item[Sleep (After Backlight Off):]
  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
  63         saves a little bit of battery power but turning on the display takes
  64         noticeably longer than just turning on the backlight.
  65       }
  66
  67       \opt{backlight_brightness}{
  68         \item[Brightness:]
  69         Changes the brightness of your LCD display.
  70       }
  71     } % \opt{HAVE_BACKLIGHT}
  72
  73     \opt{archos,h100,ipodmini,ipod3g,ipod4g,x5}{
  74       \item[Contrast:]
  75       Changes the contrast of your LCD display.
  76       \warn{Setting the contrast too dark or too light can make it hard to
  77         find this menu option again!}
  78     } % \opt{archos,h100,ipodmini,ipod4g,x5}
  79
  80     \opt{lcd_invert}{
  81       \item[LCD Mode:]
  82       This setting lets you invert the colours of the display.
  83     }
  84
  85     \opt{lcd_flip}{
  86       \item[Upside Down:]
  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
  89       access to the headphone socket.
  90     }
  91     \end{description}
  92 %
  93   \opt{HAVE_REMOTE_LCD}{
  94     \item[Remote-LCD Settings:]
  95     This sub menu contains settings that relate to the display of the remote.
  96       \begin{description}
  97       \item[Backlight:]
  98         Similar to the main unit backlight this option controls the backlight
  99         timeout for the remote control. The remote backlight is independent
 100         from the main unit backlight.
 101       \item[Backlight on When Plugged:]
 102         This controls the backlight when the \dap\ is plugged into the charger.
 103       \item[Caption Backlight:]
 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
 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
 108         setting, but is no less than 5 seconds.
 109         \item[First Keypress Enables Backlight Only:]
 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
 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},
 114           the first keypress will light up the remote backlight
 115           \emph{and} engage the function of the key that is pressed.
 116        \item[Contrast:]
 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
 119            find this menu option again!}
 120        \item[LCD Mode:]
 121          This setting lets you invert the whole screen, so now you get a
 122          black background and light text and graphics.
 123        \item[Upside Down:]
 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
 126          pocket for easy access to the headphone socket.
 127        \opt{h100,h300}{
 128          \item[Reduce Ticking:]
 129            Enable this option if you can hear a ticking sound in your headphones
 130            when using your remote.
 131        }
 132     \end{description}
 133   }
 134 %
 135   \item[Scrolling]
 136     This feature controls how text will scroll in Rockbox. You can configure
 137     the following parameters:
 138     \begin{description}
 139     \item[Scroll Speed:]
 140       Sets how many times per second the automatic horizontal scrolling text
 141       will move a step.
 142     \item[Scroll Start Delay:]
 143       Controls how many milliseconds Rockbox should wait before a new
 144       text begins automatically scrolling.
 145     \opt{lcd_bitmap}{
 146       \item[Scroll Step Size:]
 147         Defines the number of pixels the text should move for each step, as used
 148         by the Scroll Speed setting.
 149     }
 150     \opt{HAVE_REMOTE_LCD}{
 151       \item[Remote Scrolling Options:]
 152         The options here have the same effect on the remote LCD as the options
 153         mentioned above have on the main LCD.
 154     }
 155     \item[Bidirectional Scroll Limit:]
 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
 158       again at the start, and 2) moving to the left until you can read the end of
 159       the line and then scrolling right until you see the beginning again.
 160       Rockbox chooses which method it should use depending of how much it has to
 161       scroll to the left. This setting lets you tell Rockbox where that limit
 162       is, expressed in percentage of the line length.
 163     \opt{lcd_bitmap}{
 164       \item[Screen Scrolls Out of View:]
 165         Screens can be manually scrolled horizontally by pressing
 166         \opt{recorder,recorderv2fm}{\ButtonOn+\ButtonRight/\ButtonLeft}
 167         \opt{ondio}{\ButtonMenu+\ButtonRight/\ButtonLeft}
 168         \opt{c200,e200,h100,h300,ipod1g2g,ipod3g,ipod4g,ipodcolor,ipodmini,ipodnano,
 169         ipodvideo,x5,mrobe100,gigabeatf,gigabeats}
 170         {Long \ButtonRight/\ButtonLeft}\opt{h10,h10_5gb}{Long \ButtonRew/\ButtonFF}.
 171         Setting this option to \setting{Yes}
 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
 174         which surpass the right margin.
 175       \item[Screen Scroll Step Size:]
 176         Defines the number of pixels the horizontal manual screen scroll should move
 177         for each step.
 178     }
 179     \opt{player}{
 180       \item[Jump Scroll:]
 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
 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
 185         will always scroll in paged mode.
 186       \item[Jump Scroll Delay:]
 187         Controls how long the delay is before a page is scrolled.
 188     }
 189     \item[Paged Scrolling:]
 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
 192       useful on slow displays.
 193     \end{description}
 194 %
 195   \opt{lcd_bitmap}{
 196     \item[Status/Scrollbar:]
 197       Settings related to on screen status display and the scrollbar.
 198       \begin{description}
 199       \item[Scroll Bar:] Allows you to choose where the vertical scroll bar
 200         should appear.
 201       \item[Scroll Bar Width:] Allows you to choose the width of the
 202         scroll bar (in pixels).  Default value is 6.
 203       \item[Status Bar:] Allows you to choose where to display the
 204         statusbar\opt{remote}{ on the main display}.
 205       \opt{remote}{
 206         \item[Remote Status Bar:] Allows you to choose where to display the
 207         statusbar on the remote display.
 208       }
 209       \opt{RECORDER_PAD}{
 210        \item[Button Bar:] Enables or disables the button bar prompts for the
 211          ``F''-keys at the bottom of the screen.
 212       }
 213       \item[Volume Display:] Controls whether the volume is displayed as a
 214         graphic or a numeric value on the Status Bar. If you select a numeric
 215         display, volume is displayed in decibels.  See \reference{ref:volume}
 216         for more on the volume setting.
 217       \item[Battery Display:] Controls whether the battery charge status is
 218         displayed as a graphic or numerical percentage value on the Status Bar.
 219       \end{description}
 220     }
 221 %
 222   \opt{lcd_bitmap}{
 223     \item[Peak Meter:]
 224       The peak meter can be configured with a number of parameters.
 225       \begin{description}
 226       \item[Peak Release:]
 227         This determines how fast the bar shrinks when the music becomes
 228         softer. Lower values make the peak meter look smoother.
 229         Expressed in scale units per 10ms.
 230       \item[Peak Hold Time:]
 231         Specifies the time after which the peak indicator will reset.
 232         For example, if you set this value to 5s, the peak indicator displays
 233         the loudest volume value that occurred within the last 5 seconds.
 234         Larger values are useful if you want to find the peak level of a song,
 235         which might be of interest when copying music from the \dap\ via the
 236         analogue output to some other recording device.
 237       \item[Clip Hold Time:]
 238         The number of seconds that the clipping indicator will be visible
 239         after clipping is detected.
 240       \opt{recording}{
 241         \item[Clip Counter:]
 242           Show the number of times the clip indicator went active during
 243           recording in front of the peak meters.
 244       }
 245       \item[\label{ref:Peakmetersetting}Scale:]
 246         Select whether the peak meter displays linear or logarithmic values.
 247         The human ear perceives loudness on a logarithmic scale. If the Scale
 248         setting is set to \setting{Logarithmic} (dB) scale, the volume values
 249         are scaled logarithmically. The volume meters of digital audio
 250         devices usually are scaled this way. On the other hand, if you
 251         are interested in the power level that is applied to your headphones
 252         you should choose \setting{Linear} display. This setting cannot be
 253         displayed in units like volts or watts because such units depend
 254         on your headphones.
 255       \item[Minimum and maximum range:]
 256         These two options define the full value range that the peak meter
 257         displays. Recommended values for the \setting{Logarithmic} (dB) setting
 258         are {}-40 dB for minimum and 0 dB for maximum. Recommended values
 259         for \setting{Linear} display are 0 and 100\%. Note that {}-40 dB is
 260         approximately 1\% in linear value, but if you change the minimum
 261         setting in linear mode slightly and then change to the dB scale,
 262         there will be a large change. You can use these values for `zooming'
 263         into the peak meter.
 264       \end{description}
 265     }
 266     \item[\label{ref:Defaultcodepage}Default Codepage:]
 267       A codepage describes the way extended characters that are not available
 268       within the ASCII character set are encoded. ID3v1 tags do not have a
 269       codepage encoding contained so Rockbox needs to know what encoding has
 270       been used when generating these tags. This should be ``ISO-8859-1'' but
 271       to support languages outside Western Europe most applications use
 272       the setting of your operating system instead. If your operating system
 273       uses a different codepage and you are getting garbled extended characters
 274       you should adjust this settings. In most cases sticking to
 275       ``ISO-8859-1'' would be sufficient.
 276   \end{description}