summaryrefslogtreecommitdiff
path: root/manual/configure_rockbox
diff options
context:
space:
mode:
Diffstat (limited to 'manual/configure_rockbox')
-rw-r--r--manual/configure_rockbox/display_options.tex20
-rw-r--r--manual/configure_rockbox/main.tex2
-rw-r--r--manual/configure_rockbox/playback_options.tex12
-rw-r--r--manual/configure_rockbox/recording_settings.tex6
-rw-r--r--manual/configure_rockbox/sound_settings.tex6
-rw-r--r--manual/configure_rockbox/system_options.tex14
-rw-r--r--manual/configure_rockbox/theme_settings.tex8
-rw-r--r--manual/configure_rockbox/voice.tex2
8 files changed, 35 insertions, 35 deletions
diff --git a/manual/configure_rockbox/display_options.tex b/manual/configure_rockbox/display_options.tex
index 7906d05581..dc95534fff 100644
--- a/manual/configure_rockbox/display_options.tex
+++ b/manual/configure_rockbox/display_options.tex
@@ -28,7 +28,7 @@
28 beginning so that the display can be read to see song information. 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 29 amount of time is determined by the value of the backlight timeout
30 setting, but is no less than 5 seconds. 30 setting, but is no less than 5 seconds.
31 \opt{HAVE_BACKLIGHT_PWM_FADING}{ 31 \opt{backlight_fade}{
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
@@ -46,7 +46,7 @@
46 off will only turn the backlight on without having any other effect. When 46 off will only turn the backlight on without having any other effect. When
47 disabled the first keypress will \emph{also} perform its appropriate action. 47 disabled the first keypress will \emph{also} perform its appropriate action.
48 48
49 \opt{HAVE_LCD_SLEEP}{ 49 \opt{lcd_sleep}{
50 \item[Sleep (After Backlight Off):] 50 \item[Sleep (After Backlight Off):]
51 This setting controls how long rockbox will wait before turning off the 51 This setting controls how long rockbox will wait before turning off the
52 display after the backlight is turned off. Turning off the display 52 display after the backlight is turned off. Turning off the display
@@ -54,7 +54,7 @@
54 noticeably longer than just turning on the backlight. 54 noticeably longer than just turning on the backlight.
55 } 55 }
56 56
57 \opt{HAVE_BACKLIGHT_BRIGHTNESS}{ 57 \opt{backlight_brightness}{
58 \item[Brightness:] 58 \item[Brightness:]
59 Changes the brightness of your LCD display. 59 Changes the brightness of your LCD display.
60 } 60 }
@@ -67,12 +67,12 @@
67 find this menu option again!} 67 find this menu option again!}
68 } % \opt{archos,h1xx,ipodmini,ipod4g,x5} 68 } % \opt{archos,h1xx,ipodmini,ipod4g,x5}
69 69
70 \opt{HAVE_LCD_INVERT}{ 70 \opt{lcd_invert}{
71 \item[LCD Mode:] 71 \item[LCD Mode:]
72 This setting lets you invert the colours of the display. 72 This setting lets you invert the colours of the display.
73 } 73 }
74 74
75 \opt{HAVE_LCD_FLIP}{ 75 \opt{lcd_flip}{
76 \item[Upside Down:] 76 \item[Upside Down:]
77 Displays the screen so that the top of the display is nearest the buttons. 77 Displays the screen so that the top of the display is nearest the buttons.
78 This is sometimes useful when carrying the \dap{} in a pocket for easy 78 This is sometimes useful when carrying the \dap{} in a pocket for easy
@@ -131,7 +131,7 @@
131 \item[Scroll Start Delay:] 131 \item[Scroll Start Delay:]
132 Controls how many milliseconds Rockbox should wait before a new 132 Controls how many milliseconds Rockbox should wait before a new
133 text begins scrolling. 133 text begins scrolling.
134 \opt{HAVE_LCD_BITMAP}{ 134 \opt{lcd_bitmap}{
135 \item[Scroll Step Size:] 135 \item[Scroll Step Size:]
136 Controls how many pixels the text scroll should move for each step. 136 Controls how many pixels the text scroll should move for each step.
137 } 137 }
@@ -148,7 +148,7 @@
148 it should use depending of how much it has to scroll left. This setting 148 it should use depending of how much it has to scroll left. This setting
149 lets you tell Rockbox where that limit is, expressed in percentage of 149 lets you tell Rockbox where that limit is, expressed in percentage of
150 line length. 150 line length.
151 \opt{HAVE_LCD_BITMAP}{ 151 \opt{lcd_bitmap}{
152 \item[Screen Scrolls Out of View:] 152 \item[Screen Scrolls Out of View:]
153 On lists with long entries that do not fit on the screen using 153 On lists with long entries that do not fit on the screen using
154 \opt{recorder,recorderv2fm,h1xx,h300}{\ButtonOn+\ButtonRight/ 154 \opt{recorder,recorderv2fm,h1xx,h300}{\ButtonOn+\ButtonRight/
@@ -175,7 +175,7 @@
175 can be useful on slow displays. 175 can be useful on slow displays.
176 \end{description} 176 \end{description}
177% 177%
178 \opt{HAVE_LCD_BITMAP}{ 178 \opt{lcd_bitmap}{
179 \item[Status/Scrollbar:] 179 \item[Status/Scrollbar:]
180 Settings related to on screen status display and the scrollbar. 180 Settings related to on screen status display and the scrollbar.
181 \begin{description} 181 \begin{description}
@@ -194,7 +194,7 @@
194 \end{description} 194 \end{description}
195 } 195 }
196% 196%
197 \opt{HAVE_LCD_BITMAP}{ 197 \opt{lcd_bitmap}{
198 \item[Peak Meter:] 198 \item[Peak Meter:]
199 The peak meter can be configured with a number of parameters. 199 The peak meter can be configured with a number of parameters.
200 \begin{description} 200 \begin{description}
@@ -212,7 +212,7 @@
212 \item[Clip Hold Time:] 212 \item[Clip Hold Time:]
213 The number of seconds that the clipping indicator will be visible 213 The number of seconds that the clipping indicator will be visible
214 after clipping is detected. 214 after clipping is detected.
215 \opt{HAVE_RECORDING}{ 215 \opt{recording}{
216 \item[Clip Counter:] 216 \item[Clip Counter:]
217 Show the number of times the clip indicator went active during 217 Show the number of times the clip indicator went active during
218 recording in front of the peakmeters. 218 recording in front of the peakmeters.
diff --git a/manual/configure_rockbox/main.tex b/manual/configure_rockbox/main.tex
index aedd622fe3..52888f2159 100644
--- a/manual/configure_rockbox/main.tex
+++ b/manual/configure_rockbox/main.tex
@@ -19,7 +19,7 @@
19\label{ref:configure_rockbox_themes} 19\label{ref:configure_rockbox_themes}
20 \input{configure_rockbox/theme_settings.tex} 20 \input{configure_rockbox/theme_settings.tex}
21 21
22\opt{HAVE_RECORDING}{ 22\opt{recording}{
23\chapter{Recording Settings} 23\chapter{Recording Settings}
24\label{ref:Recordingsettings} 24\label{ref:Recordingsettings}
25 \input{configure_rockbox/recording_settings.tex} 25 \input{configure_rockbox/recording_settings.tex}
diff --git a/manual/configure_rockbox/playback_options.tex b/manual/configure_rockbox/playback_options.tex
index 3794efbb37..b4991f2919 100644
--- a/manual/configure_rockbox/playback_options.tex
+++ b/manual/configure_rockbox/playback_options.tex
@@ -121,7 +121,7 @@ related to audio playback.
121 The anti-skip buffer can safely be kept at zero. It will eventually be 121 The anti-skip buffer can safely be kept at zero. It will eventually be
122 eliminated. 122 eliminated.
123 }% 123 }%
124 \opt{SWCODEC}{The anti-skip buffer can be set to various values between 124 \opt{swcodec}{The anti-skip buffer can be set to various values between
125 5 seconds and 10 minutes.}% 125 5 seconds and 10 minutes.}%
126 126
127 \note{Having a large anti-skip buffer tends to use more power, and may 127 \note{Having a large anti-skip buffer tends to use more power, and may
@@ -138,7 +138,7 @@ related to audio playback.
138 instead of being played immediately. Pausing and stopping playback is 138 instead of being played immediately. Pausing and stopping playback is
139 disabled as well as skipping songs and launching plugins. 139 disabled as well as skipping songs and launching plugins.
140 140
141 \opt{SWCODEC}{ 141 \opt{swcodec}{
142 \item[Crossfade. ] 142 \item[Crossfade. ]
143 This setting enables a cross-fader. At the end of a song, the song will 143 This setting enables a cross-fader. At the end of a song, the song will
144 fade out as the next song fades in, creating a smooth transition between 144 fade out as the next song fades in, creating a smooth transition between
@@ -178,7 +178,7 @@ related to audio playback.
178 set on shuffle.} 178 set on shuffle.}
179 }% 179 }%
180 180
181 \opt{SWCODEC}{ 181 \opt{swcodec}{
182 \item[Replaygain. ]This allows you to control the replaygain function. 182 \item[Replaygain. ]This allows you to control the replaygain function.
183 The purpose of replaygain is to adjust the volume of the music played 183 The purpose of replaygain is to adjust the volume of the music played
184 so that all songs (or albums, depending on your settings) have the 184 so that all songs (or albums, depending on your settings) have the
@@ -220,7 +220,7 @@ related to audio playback.
220 decibel (dB) value between -12dB and +12dB, in increments of 0.1{}dB. 220 decibel (dB) value between -12dB and +12dB, in increments of 0.1{}dB.
221 \end{description} 221 \end{description}
222 } 222 }
223 \opt{SWCODEC}{ 223 \opt{swcodec}{
224 \item[Beep Volume. ]Controls the volume of the beep that is heard when 224 \item[Beep Volume. ]Controls the volume of the beep that is heard when
225 skipping forward or backward between tracks. The beep is disabled when 225 skipping forward or backward between tracks. The beep is disabled when
226 set to \setting{Off}. 226 set to \setting{Off}.
@@ -267,8 +267,8 @@ related to audio playback.
267 \url{http://www.last.fm}. This service was formely known as 267 \url{http://www.last.fm}. This service was formely known as
268 \emph{Audioscrobbler}. When you enable this option, you'll have to reboot to 268 \emph{Audioscrobbler}. When you enable this option, you'll have to reboot to
269 start the logging. The log-file is called 269 start the logging. The log-file is called
270 \opt{CONFIG_RTC}{\fname{.scrobbler.log},}% 270 \opt{rtc}{\fname{.scrobbler.log},}%
271 \nopt{CONFIG_RTC}{\fname{.scrobbler-timeless.log},}% 271 \nopt{rtc}{\fname{.scrobbler-timeless.log},}%
272 and is to be found in the root directory of your \dap{}. 272 and is to be found in the root directory of your \dap{}.
273 \note{See \wikilink{LastFMLog} for a further description, and for tools you 273 \note{See \wikilink{LastFMLog} for a further description, and for tools you
274 can use to submit your Last.fm log.} 274 can use to submit your Last.fm log.}
diff --git a/manual/configure_rockbox/recording_settings.tex b/manual/configure_rockbox/recording_settings.tex
index b12f5cc80d..ed2c234e77 100644
--- a/manual/configure_rockbox/recording_settings.tex
+++ b/manual/configure_rockbox/recording_settings.tex
@@ -31,7 +31,7 @@
31 \end{table} 31 \end{table}
32} 32}
33 33
34\opt{SWCODEC}{ 34\opt{swcodec}{
35 \section{Format} 35 \section{Format}
36 Choose which format to save your recording in. The available choices are 36 Choose which format to save your recording in. The available choices are
37 the two uncompressed formats \setting{PCM Wave} and \setting{AIFF}, the 37 the two uncompressed formats \setting{PCM Wave} and \setting{AIFF}, the
@@ -51,7 +51,7 @@
51 \opt{x5}{88.2kHz, 44.1kHz, 22.05kHz and 11.025kHz} 51 \opt{x5}{88.2kHz, 44.1kHz, 22.05kHz and 11.025kHz}
52 are available. Higher sample rates use up more disk space, but give better 52 are available. Higher sample rates use up more disk space, but give better
53 sound quality. 53 sound quality.
54 \opt{SWCODEC}{\note{The 11.025kHz setting is not available when using% 54 \opt{swcodec}{\note{The 11.025kHz setting is not available when using%
55 \setting{MPEG Layer 3} format.} 55 \setting{MPEG Layer 3} format.}
56 }% 56 }%
57 \opt{MASCODEC}{ 57 \opt{MASCODEC}{
@@ -73,7 +73,7 @@
73 Choose the source of the recording. This can be 73 Choose the source of the recording. This can be
74 \opt{recorder,recorderv2fm,h1xx}{\setting{SPDIF (digital)},}% 74 \opt{recorder,recorderv2fm,h1xx}{\setting{SPDIF (digital)},}%
75 \setting{Mic} or \setting{Line In}. 75 \setting{Mic} or \setting{Line In}.
76 \opt{CONFIG_TUNER}{For recording from the radio see \reference{ref:FMradio}.} 76 \opt{radio}{For recording from the radio see \reference{ref:FMradio}.}
77 77
78\section{Channels} 78\section{Channels}
79 This allows you to select mono or stereo recording. Please note that 79 This allows you to select mono or stereo recording. Please note that
diff --git a/manual/configure_rockbox/sound_settings.tex b/manual/configure_rockbox/sound_settings.tex
index ec201f93d3..43976d2067 100644
--- a/manual/configure_rockbox/sound_settings.tex
+++ b/manual/configure_rockbox/sound_settings.tex
@@ -224,7 +224,7 @@ change to customise your listening experience.
224 \end{description} 224 \end{description}
225} 225}
226 226
227\opt{SWCODEC}{ 227\opt{swcodec}{
228\section{Crossfeed} 228\section{Crossfeed}
229 Crossfeed attempts to make the experience of listening to music on 229 Crossfeed attempts to make the experience of listening to music on
230 headphones more similar to listening to music with stereo speakers. When you 230 headphones more similar to listening to music with stereo speakers. When you
@@ -280,7 +280,7 @@ change to customise your listening experience.
280 if you choose settings which result in a too high output level. 280 if you choose settings which result in a too high output level.
281} 281}
282 282
283\opt{SWCODEC}{ 283\opt{swcodec}{
284\section{\label{ref:EQ}Equalizer} 284\section{\label{ref:EQ}Equalizer}
285 \screenshot{configure_rockbox/images/ss-equalizer}{The graphical equalizer}{} 285 \screenshot{configure_rockbox/images/ss-equalizer}{The graphical equalizer}{}
286 Rockbox features a parametric equalizer (EQ). As the name suggests, a 286 Rockbox features a parametric equalizer (EQ). As the name suggests, a
@@ -404,7 +404,7 @@ settings.
404\end{description} 404\end{description}
405} 405}
406 406
407\opt{SWCODEC}{ 407\opt{swcodec}{
408\section{Dithering} 408\section{Dithering}
409This setting controls the dithering and noise shaping functionality of Rockbox. 409This setting controls the dithering and noise shaping functionality of Rockbox.
410 410
diff --git a/manual/configure_rockbox/system_options.tex b/manual/configure_rockbox/system_options.tex
index 4a75f22fe1..5b7dc8e1f3 100644
--- a/manual/configure_rockbox/system_options.tex
+++ b/manual/configure_rockbox/system_options.tex
@@ -42,7 +42,7 @@
42 is currently used in the \dap{}. The two supported battery types are 42 is currently used in the \dap{}. The two supported battery types are
43 ``Alkaline'' or ``NiMH''.} 43 ``Alkaline'' or ``NiMH''.}
44 44
45 \opt{HAVE_USB_CHARGING}{ 45 \opt{usb_charging}{
46%TODO: check where it is working correctly (except H300) and append the option to the respective platform file 46%TODO: check where it is working correctly (except H300) and append the option to the respective platform file
47 \item [Charge During USB Connection: ]This option lets you control whether 47 \item [Charge During USB Connection: ]This option lets you control whether
48 the \dap{} should charge during the USB connection and hence draw the 48 the \dap{} should charge during the USB connection and hence draw the
@@ -52,7 +52,7 @@
52 52
53 \end{description} 53 \end{description}
54} 54}
55\opt{HAVE_DIRCACHE,HAVE_DISK_STORAGE}{ 55\opt{dircache,HAVE_DISK_STORAGE}{
56\subsection{Disk} 56\subsection{Disk}
57 Options relating to the hard disk. 57 Options relating to the hard disk.
58 58
@@ -67,7 +67,7 @@
67 afterwards. 67 afterwards.
68 } 68 }
69 69
70 \opt{HAVE_DIRCACHE}{ 70 \opt{dircache}{
71 \item [Directory Cache: ]Rockbox has the ability to cache the contents of 71 \item [Directory Cache: ]Rockbox has the ability to cache the contents of
72 your drive in RAM. The \setting{Directory Cache} takes a small amount of 72 your drive in RAM. The \setting{Directory Cache} takes a small amount of
73 memory away from Rockbox that would otherwise be used to buffer music, 73 memory away from Rockbox that would otherwise be used to buffer music,
@@ -82,9 +82,9 @@
82 background.} 82 background.}
83 } 83 }
84 \end{description} 84 \end{description}
85} % \opt{HAVE_DIRCACHE,HAVE_DISK_STORAGE} 85} % \opt{dircache,HAVE_DISK_STORAGE}
86 86
87\opt{CONFIG_RTC}{ 87\opt{rtc}{
88 \subsection{Time and Date} 88 \subsection{Time and Date}
89 Time related menu options. 89 Time related menu options.
90 \begin{description} 90 \begin{description}
@@ -101,7 +101,7 @@ recording. Settings are either \setting{Off} or \setting{1} to \setting{10}
101minutes in 1 minute steps. Then \setting{15,30,45} and \setting{60} minutes are 101minutes in 1 minute steps. Then \setting{15,30,45} and \setting{60} minutes are
102available. 102available.
103 103
104\opt{HAVE_RTC_ALARM}{ 104\opt{alarm}{
105\subsection{Wake-Up Alarm} 105\subsection{Wake-Up Alarm}
106% TODO this isn't quite right for all targets, I think 106% TODO this isn't quite right for all targets, I think
107 This option turns the \dap{} off and then starts it up again at the 107 This option turns the \dap{} off and then starts it up again at the
@@ -113,7 +113,7 @@ available.
113 again before the alarm occurs, the alarm will be cancelled. Using this 113 again before the alarm occurs, the alarm will be cancelled. Using this
114 option disables the \setting{Sleep Timer}. 114 option disables the \setting{Sleep Timer}.
115 115
116 \opt{HAVE_RECORDING,CONFIG_TUNER}{ 116 \opt{recording,radio}{
117 \subsection{Alarm Wake up Screen} 117 \subsection{Alarm Wake up Screen}
118 This option controls what the \dap{} does when it is woken up by the alarm. 118 This option controls what the \dap{} does when it is woken up by the alarm.
119 } 119 }
diff --git a/manual/configure_rockbox/theme_settings.tex b/manual/configure_rockbox/theme_settings.tex
index 4b0639bbd2..c6c3fab279 100644
--- a/manual/configure_rockbox/theme_settings.tex
+++ b/manual/configure_rockbox/theme_settings.tex
@@ -66,7 +66,7 @@ customize the visual apperance of Rockbox.
66 This option allows you to clear the backdrops that you set. 66 This option allows you to clear the backdrops that you set.
67}% 67}%
68 68
69\opt{HAVE_LCD_BITMAP}{ 69\opt{lcd_bitmap}{
70\item[Line Selector Type.] 70\item[Line Selector Type.]
71 This option allows you to select which type of line selector to use. 71 This option allows you to select which type of line selector to use.
72 \begin{description} 72 \begin{description}
@@ -74,7 +74,7 @@ customize the visual apperance of Rockbox.
74 A small arrow to the left of the menu text. 74 A small arrow to the left of the menu text.
75 \item[Bar (inverse):] 75 \item[Bar (inverse):]
76 A bar with inverted foreground and background colour. 76 A bar with inverted foreground and background colour.
77\opt{HAVE_LCD_COLOR}{ 77\opt{lcd_color}{
78 \item[Bar (Solid Colour):] 78 \item[Bar (Solid Colour):]
79 A bar with a solid colour, the colour is set in the \setting{Colours} 79 A bar with a solid colour, the colour is set in the \setting{Colours}
80 submenu. 80 submenu.
@@ -85,7 +85,7 @@ customize the visual apperance of Rockbox.
85 \end{description} 85 \end{description}
86} 86}
87 87
88\opt{HAVE_LCD_COLOR}{ 88\opt{lcd_color}{
89 \item[Colours.] 89 \item[Colours.]
90 The options in this menu sets the colours for visual elements in Rockbox. 90 The options in this menu sets the colours for visual elements in Rockbox.
91 \begin{description} 91 \begin{description}
@@ -109,5 +109,5 @@ customize the visual apperance of Rockbox.
109 \item[Reset Colours:] 109 \item[Reset Colours:]
110 Resets the LCD display to Rockbox's default colours. 110 Resets the LCD display to Rockbox's default colours.
111 \end{description} 111 \end{description}
112}% HAVE_LCD_COLOR 112}% lcd_color
113\end{description} 113\end{description}
diff --git a/manual/configure_rockbox/voice.tex b/manual/configure_rockbox/voice.tex
index 905736fd98..5f1183c625 100644
--- a/manual/configure_rockbox/voice.tex
+++ b/manual/configure_rockbox/voice.tex
@@ -16,7 +16,7 @@
16 \begin{itemize} 16 \begin{itemize}
17 \item Setting the Sound Option \setting{Channels} to \setting{Karaoke} may 17 \item Setting the Sound Option \setting{Channels} to \setting{Karaoke} may
18 disable voice menus. 18 disable voice menus.
19 \item Plugins \opt{CONFIG_RTC}{and the wake up alarm} do not support 19 \item Plugins \opt{rtc}{and the wake up alarm} do not support
20 voice features. 20 voice features.
21 \end{itemize} 21 \end{itemize}
22 22