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
  36         \setting{500ms}, \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
  43         \setting{10s}.
  44       }
  45       \opt{backlight_fade_bool}{
  46         \item[Backlight Fade In.]
  47         This options turns on smooth backlight fading when the backlight is
  48         turning on. The fading time is dependent on the brightness level you
  49         have chosen. If it is turned off, the backlight will turn on immediately.
  50         \item[Backlight Fade Out.]
  51         This options turns on smooth backlight fading when the backlight is
  52         turning off. The fading time is dependent on the brightness level you
  53         have chosen. If it is turned off, the backlight will turn off immediately.
  54       }
  55       \item[First Keypress Enables Backlight Only.]
  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
  58       disabled the first keypress will \emph{also} perform its appropriate action.
  59
  60       \opt{lcd_sleep}{
  61         \item[Sleep (After Backlight Off).]
  62         This setting controls how long rockbox will wait before turning off the
  63         display after the backlight is turned off. Turning off the display
  64         saves battery power but turning on the display takes noticeably longer
  65         than just turning on the backlight.
  66       }
  67
  68       \opt{backlight_brightness}{
  69         \item[Brightness.]
  70         Changes the brightness of your LCD display.
  71       }
  72     } % \opt{HAVE_BACKLIGHT}
  73
  74     \opt{archos,h100,ipodmini,ipod3g,ipod4g,x5}{
  75       \item[Contrast.]
  76       Changes the contrast of your LCD display.
  77       \warn{Setting the contrast too dark or too light can make it hard to
  78         find this menu option again!}
  79     } % \opt{archos,h100,ipodmini,ipod4g,x5}
  80
  81     \opt{lcd_invert}{
  82       \item[LCD Mode.]
  83       This setting lets you invert the colours of the display.
  84     }
  85
  86     \opt{lcd_flip}{
  87       \item[Upside Down.]
  88       Displays the screen so that the top of the display is nearest the buttons.
  89       This is sometimes useful when carrying the \dap{} in a pocket for easy
  90       access to the headphone socket.
  91     }
  92     \end{description}
  93 %
  94   \opt{HAVE_REMOTE_LCD}{
  95     \item[Remote-LCD Settings.]
  96     This sub menu contains settings that relate to the display of the remote.
  97       \begin{description}
  98       \item[Backlight.]
  99         Similar to the main unit backlight this option controls the backlight
 100         timeout for the remote control. The remote backlight is independent
 101         from the main unit backlight.
 102       \item[Backlight on When Plugged.]
 103         This controls the backlight when the \dap\ is plugged into the charger.
 104       \item[Caption Backlight.]
 105         This option turns on the backlight a number of seconds before the start
 106         of a new track, and keeps it on for the same number of seconds after the
 107         beginning so that the display can be read to see song information. The
 108         amount of time is determined by the value of the backlight timeout
 109         setting, but is no less than 5 seconds.
 110         \item[First Keypress Enables Backlight Only.]
 111           This controls what happens when you press a button on your remote
 112           while the backlight is turned off. Like for the main unit, if this
 113           setting is set to \setting{Yes}, the first keypress will light up the
 114           remote backlight, but have no other effect. If set to \setting{No},
 115           the first keypress will light up the remote backlight
 116           \emph{and} engage the function of the key that is pressed.
 117        \item[Contrast.]
 118          Changes the contrast of your remote's LCD display.
 119          \warn{Setting the contrast too dark or too light can make it hard to
 120            find this menu option again!}
 121        \item[LCD Mode.]
 122          This setting lets you invert the whole screen, so now you get a
 123          black background and light text and graphics.
 124        \item[Upside Down.]
 125          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
 127          pocket for easy access to the headphone socket.
 128        \opt{h100,h300}{
 129          \item[Reduce Ticking.]
 130            Enable this option if you can hear a ticking sound in your headphones
 131            when using your remote.
 132        }
 133     \end{description}
 134   }
 135 %
 136   \item[Scrolling.]
 137     This feature controls how text will scroll in Rockbox. You can configure
 138     the following parameters:
 139     \begin{description}
 140     \item[Scroll Speed.]
 141       Sets how many times per second the automatic horizontal scrolling text
 142       will move a step.
 143     \item[Scroll Start Delay.]
 144       Controls how many milliseconds Rockbox should wait before a new
 145       text begins automatically scrolling.
 146     \opt{lcd_bitmap}{
 147       \item[Scroll Step Size.]
 148         Defines the number of pixels the text should move for each step, as used
 149         by the Scroll Speed setting.
 150     }
 151     \opt{HAVE_REMOTE_LCD}{
 152       \item[Remote Scrolling Options.]
 153         The options here have the same effect on the remote LCD as the options
 154         mentioned above have on the main LCD.
 155     }
 156     \item[Bidirectional Scroll Limit.]
 157       Rockbox has two different automatic horizontal scrolling methods: 1) always
 158       scrolling the text to the left until the line has ended and then beginning
 159       again at the start, and 2) moving to the left until you can read the end of
 160       the line and then scrolling right until you see the beginning again.
 161       Rockbox chooses which method it should use depending of how much it has to
 162       scroll to the left. This setting lets you tell Rockbox where that limit
 163       is, expressed in percentage of the line length.
 164     \opt{lcd_bitmap}{
 165       \item[Screen Scrolls Out of View.]
 166         Screens can be manually scrolled horizontally by pressing
 167         \opt{recorder,recorderv2fm}{\ButtonOn+\ButtonRight/\ButtonLeft}
 168         \opt{ondio}{\ButtonMenu+\ButtonRight/\ButtonLeft}
 169         \opt{c200,e200,h100,h300,ipod1g2g,ipod3g,ipod4g,ipodcolor,ipodmini,ipodnano,
 170         ipodnano2g,ipodvideo,x5,mrobe100,gigabeatf,gigabeats,e200v2,vibe500}
 171         {Long \ButtonRight/\ButtonLeft}\opt{h10,h10_5gb}{Long \ButtonRew/\ButtonFF}.
 172         Setting this option to \setting{Yes}
 173         will keep the list entries at their fixed positions and allow them to be
 174         scrolled out of view, whereas \setting{No} will only scroll those entries
 175         which surpass the right margin.
 176       \item[Screen Scroll Step Size.]
 177         Defines the number of pixels the horizontal manual screen scroll should move
 178         for each step.
 179     }
 180     \opt{player}{
 181       \item[Jump Scroll.]
 182         This setting makes text scroll a page at a time instead of a character
 183         at a time. If set to \setting{One time}, \setting{2}, \setting{3} or
 184         \setting{4} it will scroll a line in paged mode that many times and
 185         then scroll it a character at a time. If set to \setting{Always} lines
 186         will always scroll in paged mode.
 187       \item[Jump Scroll Delay.]
 188         Controls how long the delay is before a page is scrolled.
 189     }
 190     \item[Paged Scrolling.]
 191       When set to \setting{Yes} scrolling vertically on pages that surpass the
 192       screen size will page up/down instead of simply changing lines. This can be
 193       useful on slow displays.
 194     \end{description}
 195 %
 196   \opt{lcd_bitmap}{
 197     \item[Peak Meter.]
 198       The peak meter can be configured with a number of parameters.
 199       \begin{description}
 200       \item[Peak Release.]
 201         This determines how fast the bar shrinks when the music becomes
 202         softer. Lower values make the peak meter look smoother.
 203         Expressed in scale units per 10~ms.
 204       \item[Peak Hold Time.]
 205         Specifies the time after which the peak indicator will reset.
 206         For example, if you set this value to 5~s, the peak indicator displays
 207         the loudest volume value that occurred within the last 5 seconds.
 208         Larger values are useful if you want to find the peak level of a song,
 209         which might be of interest when copying music from the \dap\ via the
 210         analogue output to some other recording device.
 211       \item[Clip Hold Time.]
 212         The number of seconds that the clipping indicator will be visible
 213         after clipping is detected.
 214       \opt{recording}{
 215         \item[Clip Counter.]
 216           Show the number of times the clip indicator went active during
 217           recording in front of the peak meters.
 218       }
 219       \item[\label{ref:Peakmetersetting}Scale.]
 220         Select whether the peak meter displays linear or logarithmic values.
 221         The human ear perceives loudness on a logarithmic scale. If the Scale
 222         setting is set to \setting{Logarithmic} (dB) scale, the volume values
 223         are scaled logarithmically. The volume meters of digital audio
 224         devices usually are scaled this way. On the other hand, if you
 225         are interested in the power level that is applied to your headphones
 226         you should choose \setting{Linear} display. This setting cannot be
 227         displayed in units like volts or watts because such units depend
 228         on your headphones.
 229       \item[Minimum and maximum range.]
 230         These two options define the full value range that the peak meter
 231         displays. Recommended values for the \setting{Logarithmic} (dB) setting
 232         are {}-40~dB for minimum and 0~dB for maximum. Recommended values
 233         for \setting{Linear} display are 0 and 100\%. Note that {}-40~dB is
 234         approximately 1\% in linear value, but if you change the minimum
 235         setting in linear mode slightly and then change to the dB scale,
 236         there will be a large change. You can use these values for `zooming'
 237         into the peak meter.
 238       \end{description}
 239     }
 240     \item[\label{ref:Defaultcodepage}Default Codepage.]
 241       A codepage describes the way extended characters that are not available
 242       within the ASCII character set are encoded. ID3v1 tags do not have a
 243       codepage encoding contained so Rockbox needs to know what encoding has
 244       been used when generating these tags. This should be ``ISO-8859-1'' but
 245       to support languages outside Western Europe most applications use
 246       the setting of your operating system instead. If your operating system
 247       uses a different codepage and you are getting garbled extended characters
 248       you should adjust this settings. In most cases sticking to
 249       ``ISO-8859-1'' would be sufficient.
 250   \end{description}