devs/foxbox
1
0
Fork 0
forked from len0rd/rockbox
Code Pull requests Activity

Corrected opts to include the right options for each target. Added missing settings. Made more use of setting macro.

Browse source 
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@10325 a1c6a512-1295-4272-9138-f99709370657
This commit is contained in:
Nils Wallménius 2006-07-25 20:16:12 +00:00
parent b40eb3d662
commit 6f74f69b69
1 changed files with 198 additions and 153 deletions
Download patch file Download diff file Expand all files Collapse all files

261
manual/configure_rockbox/display_options.tex
View file

@ -2,92 +2,116 @@
\section{\label{ref:Displayoptions}Display Options}
\begin{description}
\item[Browse fonts:]
\nopt{player}{
\item[Browse fonts:]
Browse the fonts that reside in your \fname{/.rockbox/fonts} directory.
Selecting one will activate it. See page \pageref{ref:Loadingfonts}
for further details about fonts.
} % \nopt{player}
\item[Browse WPS files:]
Opens the File Browser in the \fname{/.rockbox/wps} directory and displays
all \fname{.wps} files. Selecting one will activate it, stop will exit
back to the menu. For further information about the WPS see page
Opens the \setting{File Browser} in the \fname{/.rockbox/wps} directory and
displays all \fname{.wps} files. Selecting one will activate it, stop will
exit back to the menu. For further information about the WPS see page
\pageref{ref:WPS}. For information about editing a .wps file see
page \pageref{ref:ConfiguringtheWPS}.
\opt{h1xx,h300,x5}{
\item[Browse RWPS files:]
Opens the \setting{File Browser} in the \fname{/.rockbox/wps} directory and
displays all \fname{.rwps} files. Selecting one will activate it, stop will
exit back to the menu.
\note{
A \fname{.rwps} file is a special \fname{.wps} file for the remote
display.
}
}
\item[LCD Settings:]
This submenu contains settings that relate to the display of the \dap.
\begin{description}
\item[Backlight:]
The amount of time the backlight shines after a key press. If set to
``Off'', the backlight will not light when a button is pressed. If
set to ``On'', the backlight will never shut off. If set to a time
(1 to 90 seconds), the backlight will stay lit for that amount of time
after a button press.
\item[Backlight on When Plugged:]
This setting is equivalent to the Backlight setting except it applies when
the \dap\ is plugged into the charger.
\item[Caption Backlight:]
This option turns on the backlight a number of seconds before the start
of a new track, and keeps it on for the same number of seconds after the
beginning so that the display can be read to see song information. The
amount of time is determined by the value of the backlight timeout
setting, but is no less than 5 seconds.
\opt{h1xx,ipodnano,ipodcolour,ipodvideo}{
\item[Backlight fade in:]
The amount of time that the backlight will take to fade from off to on
after a button is pressed. If set to ``Off'' the backlight will turn on
immediately, with no fade in. Can also be set to 500ms, 1s or 2s.
\item[Backlight fade out:]
Like Backlight fade in, this controls the amount of time that the
backlight will take to fade from on to off after a button is pressed.
If set to ``Off'' the backlight will turn off immediately, with no fade
out. Other valid values: 500ms, 1s, 2s, 3s, 4s, 5s or 10s.
}
\item[First Keypress Enables Backlight Only:]
With this option enabled the first keypress while the backlight is turned
off will only turn the backlight on without having any other effect. When
disabled the first keypress will \emph{also} perform its appropriate action.
\opt{h300}{
\item[Brightness:]
\nopt{ondiofm,ondiosp}{
\item[Backlight:]
The amount of time the backlight shines after a key press. If set to
\setting{Off}, the backlight will not light when a button is pressed. If
set to \setting{On}, the backlight will never shut off. If set to a time
(1 to 90 seconds), the backlight will stay lit for that amount of time
after a button press.
\item[Backlight on When Plugged:]
This setting is equivalent to the Backlight setting except it applies when
the \dap\ is plugged into the charger.
\item[Caption Backlight:]
This option turns on the backlight a number of seconds before the start
of a new track, and keeps it on for the same number of seconds after the
beginning so that the display can be read to see song information. The
amount of time is determined by the value of the backlight timeout
setting, but is no less than 5 seconds.
\opt{h1xx,ipodmini,ipodnano,ipodvideo}{
\item[Backlight fade in:]
The amount of time that the backlight will take to fade from off to on
after a button is pressed. If set to \setting{Off} the backlight will
turn on immediately, with no fade in. Can also be set to \setting{500ms},
\setting{1s} or \setting{2s}.
\item[Backlight fade out:]
Like Backlight fade in, this controls the amount of time that the
backlight will take to fade from on to off after a button is pressed. If
set to \setting{Off} the backlight will turn off immediately, with no
fade out. Other valid values: \setting{500ms}, \setting{1s},
\setting{2s}, \setting{3s}, \setting{4s}, \setting{5s} or \setting{10s}.
}
\item[First Keypress Enables Backlight Only:]
With this option enabled the first keypress while the backlight is turned
off will only turn the backlight on without having any other effect. When
disabled the first keypress will \emph{also} perform its appropriate action.
\opt{h300,x5}{
\item[Brightness:]
Changes the brightness of your LCD display.
}
\item[Contrast:]
Changes the contrast of your LCD display.
\warn{Setting the contrast too dark or too light can make it hard to
find this menu option again!}
\opt{recorder,recorderv2fm,ondio,h1xx,h300,ipodnano,ipodcolour,ipodvideo}{
\item[LCD Mode:]
This setting lets you invert the whole screen, so now you get a
black background and light text and graphics.
}
\item[Upside Down:]
Displays the screen so that the top of the display is nearest the buttons.
This is sometimes useful when carrying the \dap\ in a pocket for easy
access to the headphone socket.
\item[Line Selector:]
This option allows you to select whether the line selector is a bar
of inverted text (``Bar (inverse)'' option) or a small arrow to the
left of the menu text (``Pointer'' option). The default is
``Bar (inverse)''.
\opt{h300,ipodcolor,ipodvideo,x5}{
\item[Clear Backdrop:]
Rockbox allows you to select bitmap pictures to use as backdrops.
These backdrops are set in the File Context Menu. \fixme{reference!}
This option allows you to clear the backdrops that you set.
}
\opt{h300,ipodnano,ipodcolour,ipodvideo}{
\item[Set Background Colour:]
Sets the background colour for the LCD display.
\item[Set Foreground Colour:]
Sets the foreground colour for the LCD display.
\item[Reset Colours:]
Resets the LCD display to Rockbox's default colours.
}
}
} % \nopt{ondiofm,ondiosp}
\opt{archos,h1xx,ipodmini,ipod4g,x5}{
\item[Contrast:]
Changes the contrast of your LCD display.
\warn{Setting the contrast too dark or too light can make it hard to
find this menu option again!}
\nopt{HAVE_LCD_COLOR,player}{
\item[LCD Mode:]
This setting lets you invert the whole screen, so now you get a
black background and light text and graphics.
} % \opt{HAVE_LCD_BITMAP}
} % \opt{archos,h1xx,ipodmini,ipod4g,x5}
\opt{HAVE_LCD_BITMAP}{
\nopt{ipodcolor,ipodnano,ipodvideo}{
\item[Upside Down:]
Displays the screen so that the top of the display is nearest the buttons.
This is sometimes useful when carrying the \dap\ in a pocket for easy
access to the headphone socket.
} % \nopt{ipodcolor,ipodnano.ipodvideo}
\item[Line Selector:]
This option allows you to select whether the line selector is a bar
of inverted text (\setting{Bar (inverse)} option) or a small arrow to the
left of the menu text (\setting{Pointer} option).
\opt{HAVE_LCD_COLOR}{
\item[Clear Backdrop:]
Rockbox allows you to select bitmap pictures to use as backdrops.
These backdrops are set in the File Context Menu. \fixme{reference!}
This option allows you to clear the backdrops that you set.
\item[Set Background Colour:]
Sets the background colour for the LCD display.
\item[Set Foreground Colour:]
Sets the foreground colour for the LCD display.
\item[Reset Colours:]
Resets the LCD display to Rockbox's default colours.
}
} % \opt{HAVE_LCD_BITMAP}
\end{description}
%
\opt{h1xx,h300,x5}{
\item[Remote-LCD Settings:]
This submenu contains settings that relate to the display of the \dap.
This submenu contains settings that relate to the display of the remote.
\begin{description}
\item[Backlight:]
Similar to the main unit backlight this option controls the backlight
@ -96,17 +120,16 @@
\item[Backlight on When Plugged:]
This controls the backlight when the \dap\ is plugged into the charger.
\item[Caption Backlight:]
This option turns on the backlight a number of seconds before the start
of a new track, and keeps it on for the same number of seconds after the
beginning so that the display can be read to see song information. The
amount of time is determined by the value of the backlight timeout
setting, but is no less than 5 seconds.
\opt{h1xx,ipodnano,ipodcolour,ipodvideo}{
This option turns on the backlight a number of seconds before the start
of a new track, and keeps it on for the same number of seconds after the
beginning so that the display can be read to see song information. The
amount of time is determined by the value of the backlight timeout
setting, but is no less than 5 seconds.
\item[First Keypress Enables Backlight Only:]
This controls what happens when you press a button on your remote
while the backlight is turned off. Like for the main unit, if this
setting is set to ``Yes'', the first keypress will light up the
remote backlight, but have no other effect. If set to ``No'',
while the backlight is turned off. Like for the main unit, if this
setting is set to \setting{Yes}, the first keypress will light up the
remote backlight, but have no other effect. If set to \setting{No},
the first keypress will light up the remote backlight
\emph{and} engage the function of the key that is pressed.
\item[Contrast:]
@ -118,24 +141,34 @@
black background and light text and graphics.
\item[Upside Down:]
Displays the screen so that the top of the display is nearest
the buttons. This is sometimes useful when carrying the \dap\ in a
the buttons. This is sometimes useful when carrying the \dap\ in a
pocket for easy access to the headphone socket.
}
\opt{h1xx,h300}{
\item[Reduce Ticking:]
Enable this option if you can hear a ticking sound in your headphones
when using your remote.
}
\end{description}
}
}
%
\item[Scrolling]
This feature controls how text will scroll in Rockbox. You can configure
the following parameters:
\begin{description}
\item[Scroll Speed:]
Controls how many times per second the scrolling text moves a step.
\item[Scroll StartDelay:]
\item[Scroll Start Delay:]
Controls how many milliseconds Rockbox should wait before a new
text begins scrolling.
\opt{recorder,recorderv2fm,ondio,h1xx,h300,ipodnano,ipodcolour,ipodvideo}{
\opt{HAVE_LCD_BITMAP}{
\item[Scroll Step Size:]
Controls how many pixels the text scroll should move for each step.
}
}
\opt{h1xx,h300,x5}{
\item[Remote Scrolling Options:]
The options here have the same effect on the remote LCD as the options
mentioned above have on the main LCD.
}
\item[Bidirectional Scroll Limit:]
Rockbox has two different scroll methods: always scrolling the text
to the left and when the line has ended beginning again at the start,
@ -144,22 +177,34 @@
it should use depending of how much it has to scroll left. This setting
lets you tell Rockbox where that limit is, expressed in percentage of
line length.
\item[Screen Scrolls Out of View:]
On lists with long entries that don't fit on the screen using
\opt{recorder,recorderv2fm,h1xx,h300}{\ButtonOn+\ButtonRight/
\ButtonLeft}\opt{ondio}{\ButtonMenu+\ButtonRight/\ButtonLeft}
the complete content will be scrolled right/left. With this option set to
\setting{Yes} the lines can scroll out of view. Otherwise the entries
will only scroll as far as they align to the margins.
\item[Screen Scroll Step Size:]
Determines how many pixels the text should advance in every click when
scrolling the screen.
\opt{HAVE_LCD_BITMAP}{
\item[Screen Scrolls Out of View:]
On lists with long entries that don't fit on the screen using
\opt{recorder,recorderv2fm,h1xx,h300}{\ButtonOn+\ButtonRight/
\ButtonLeft}\opt{ondio}{\ButtonMenu+\ButtonRight/\ButtonLeft}
the complete content will be scrolled right/left. With this option set to
\setting{Yes} the lines can scroll out of view. Otherwise the entries
will only scroll as far as they align to the margins.
\item[Screen Scroll Step Size:]
Determines how many pixels the text should advance in every click when
scrolling the screen.
}
\opt{player}{
\item[Jump Scroll:]
This setting makes text scroll a page at a time instead of a character
at a time. If set to \setting{One time}, \setting{2}, \setting{3} or
\setting{4} it will scroll a line in paged mode that many times and
then scroll it a character at a time. If set to \setting{Always} lines
will always scroll in paged mode.
\item[Jump Scroll Delay:]
Controls how long the delay is before a page is scrolled.
}
\item[Paged Scrolling:]
When enabled scrolling will page up/down instead of changing lines. This
can be useful on slow displays.
\end{description}
%
\opt{recorder,recorderv2fm,ondio,h1xx,h300,ipodnano,ipodcolour,ipodvideo}{
%
\opt{HAVE_LCD_BITMAP}{
\item[Status/Scrollbar:]
Settings related to on screen status display and the scrollbar.
\begin{description}
@ -170,15 +215,15 @@
``F''-keys at the bottom of the screen.
}
\item[Volume Display:] Controls whether the volume is displayed as a
graphic or a numeric value on the Status Bar. If you select a numeric
graphic or a numeric value on the Status Bar. If you select a numeric
display, volume is displayed in decibels.
\fixme{cross-reference to volume setting.}
\item[Battery Display:] Controls whether the battery charge status is
displayed as a graphic or numerical percentage value on the Status Bar.
\end{description}
}
%
\opt{recorder,recorderv2fm,ondio,h1xx,h300,ipodnano,ipodcolour,ipodvideo}{
%
\opt{HAVE_LCD_BITMAP}{
\item[Peak Meter:]
The peak meter can be configured with a number of parameters.
(For a description of the peak meter see page \pageref{sec:peakmeter}.)
@ -191,7 +236,7 @@
For example, if you set this value to 5s, the peak indicator displays
the loudest volume value that occurred within the last 5 seconds.
Larger values are useful if you want to find the peak level of a song,
which might be of interest when copying music from the \dap via the
which might be of interest when copying music from the \dap\ via the
analogue output to some other recording device.
\item[Clip Hold Time:]
The number of seconds that the clipping indicator will be visible
@ -209,19 +254,19 @@
\fixme{TODO: determine which platforms support this feature.}
\item[Scale:]
Select whether the peak meter displays linear or logarithmic values.
The human ear perceives loudness on a logarithmic scale. If the
Scale setting is set to ``Logarithmic (dB)'' scale, the volume values
are scaled logarithmically. The volume meters of digital audio
devices usually are scaled this way. On the other hand, if you
The human ear perceives loudness on a logarithmic scale. If the Scale
setting is set to \setting{Logarithmic} (dB) scale, the volume values
are scaled logarithmically. The volume meters of digital audio
devices usually are scaled this way. On the other hand, if you
are interested in the power level that is applied to your headphones
you should choose ``linear'' display. This setting cannot be
you should choose \setting{Linear} display. This setting cannot be
displayed in units like volts or watts because such units depend
on your headphones.
\item[Minimum and maximum range:]
These two options define the full value range that the peak meter
displays. Recommended values for the ``Logarithmic (dB)'' setting
displays. Recommended values for the \setting{Logarithmic} (dB) setting
are {}-40 dB for minimum and 0 dB for maximum. Recommended values
for ``linear'' display are 0 and 100\%. Note that {}-40 dB is
for \setting{Linear} display are 0 and 100\%. Note that {}-40 dB is
approximately 1\% in linear value, but if you change the minimum
setting in linear mode slightly and then change to the dB scale,
there will be a large change. You can use these values for `zooming'