From 12eb058bb065e9cb85949ec3a66c453ac5e1b883 Mon Sep 17 00:00:00 2001 From: Nils Wallménius Date: Sun, 23 Mar 2008 22:07:09 +0000 Subject: Make more use of the 'features' system in the manuals (committed in r16304), less stuff to keep in sync manually but keep in mind that changes in config-*.h can now affect the manual git-svn-id: svn://svn.rockbox.org/rockbox/trunk@16765 a1c6a512-1295-4272-9138-f99709370657 --- manual/configure_rockbox/display_options.tex | 20 ++++++++++---------- manual/configure_rockbox/main.tex | 2 +- manual/configure_rockbox/playback_options.tex | 12 ++++++------ manual/configure_rockbox/recording_settings.tex | 6 +++--- manual/configure_rockbox/sound_settings.tex | 6 +++--- manual/configure_rockbox/system_options.tex | 14 +++++++------- manual/configure_rockbox/theme_settings.tex | 8 ++++---- manual/configure_rockbox/voice.tex | 2 +- 8 files changed, 35 insertions(+), 35 deletions(-) (limited to 'manual/configure_rockbox') 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 @@ 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{HAVE_BACKLIGHT_PWM_FADING}{ + \opt{backlight_fade}{ \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 @@ -46,7 +46,7 @@ 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{HAVE_LCD_SLEEP}{ + \opt{lcd_sleep}{ \item[Sleep (After Backlight Off):] This setting controls how long rockbox will wait before turning off the display after the backlight is turned off. Turning off the display @@ -54,7 +54,7 @@ noticeably longer than just turning on the backlight. } - \opt{HAVE_BACKLIGHT_BRIGHTNESS}{ + \opt{backlight_brightness}{ \item[Brightness:] Changes the brightness of your LCD display. } @@ -67,12 +67,12 @@ find this menu option again!} } % \opt{archos,h1xx,ipodmini,ipod4g,x5} - \opt{HAVE_LCD_INVERT}{ + \opt{lcd_invert}{ \item[LCD Mode:] This setting lets you invert the colours of the display. } - \opt{HAVE_LCD_FLIP}{ + \opt{lcd_flip}{ \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 @@ -131,7 +131,7 @@ \item[Scroll Start Delay:] Controls how many milliseconds Rockbox should wait before a new text begins scrolling. - \opt{HAVE_LCD_BITMAP}{ + \opt{lcd_bitmap}{ \item[Scroll Step Size:] Controls how many pixels the text scroll should move for each step. } @@ -148,7 +148,7 @@ 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. - \opt{HAVE_LCD_BITMAP}{ + \opt{lcd_bitmap}{ \item[Screen Scrolls Out of View:] On lists with long entries that do not fit on the screen using \opt{recorder,recorderv2fm,h1xx,h300}{\ButtonOn+\ButtonRight/ @@ -175,7 +175,7 @@ can be useful on slow displays. \end{description} % - \opt{HAVE_LCD_BITMAP}{ + \opt{lcd_bitmap}{ \item[Status/Scrollbar:] Settings related to on screen status display and the scrollbar. \begin{description} @@ -194,7 +194,7 @@ \end{description} } % - \opt{HAVE_LCD_BITMAP}{ + \opt{lcd_bitmap}{ \item[Peak Meter:] The peak meter can be configured with a number of parameters. \begin{description} @@ -212,7 +212,7 @@ \item[Clip Hold Time:] The number of seconds that the clipping indicator will be visible after clipping is detected. - \opt{HAVE_RECORDING}{ + \opt{recording}{ \item[Clip Counter:] Show the number of times the clip indicator went active during 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 @@ \label{ref:configure_rockbox_themes} \input{configure_rockbox/theme_settings.tex} -\opt{HAVE_RECORDING}{ +\opt{recording}{ \chapter{Recording Settings} \label{ref:Recordingsettings} \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. The anti-skip buffer can safely be kept at zero. It will eventually be eliminated. }% - \opt{SWCODEC}{The anti-skip buffer can be set to various values between + \opt{swcodec}{The anti-skip buffer can be set to various values between 5 seconds and 10 minutes.}% \note{Having a large anti-skip buffer tends to use more power, and may @@ -138,7 +138,7 @@ related to audio playback. instead of being played immediately. Pausing and stopping playback is disabled as well as skipping songs and launching plugins. - \opt{SWCODEC}{ + \opt{swcodec}{ \item[Crossfade. ] This setting enables a cross-fader. At the end of a song, the song will fade out as the next song fades in, creating a smooth transition between @@ -178,7 +178,7 @@ related to audio playback. set on shuffle.} }% - \opt{SWCODEC}{ + \opt{swcodec}{ \item[Replaygain. ]This allows you to control the replaygain function. The purpose of replaygain is to adjust the volume of the music played so that all songs (or albums, depending on your settings) have the @@ -220,7 +220,7 @@ related to audio playback. decibel (dB) value between -12dB and +12dB, in increments of 0.1{}dB. \end{description} } - \opt{SWCODEC}{ + \opt{swcodec}{ \item[Beep Volume. ]Controls the volume of the beep that is heard when skipping forward or backward between tracks. The beep is disabled when set to \setting{Off}. @@ -267,8 +267,8 @@ related to audio playback. \url{http://www.last.fm}. This service was formely known as \emph{Audioscrobbler}. When you enable this option, you'll have to reboot to start the logging. The log-file is called - \opt{CONFIG_RTC}{\fname{.scrobbler.log},}% - \nopt{CONFIG_RTC}{\fname{.scrobbler-timeless.log},}% + \opt{rtc}{\fname{.scrobbler.log},}% + \nopt{rtc}{\fname{.scrobbler-timeless.log},}% and is to be found in the root directory of your \dap{}. \note{See \wikilink{LastFMLog} for a further description, and for tools you 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 @@ \end{table} } -\opt{SWCODEC}{ +\opt{swcodec}{ \section{Format} Choose which format to save your recording in. The available choices are the two uncompressed formats \setting{PCM Wave} and \setting{AIFF}, the @@ -51,7 +51,7 @@ \opt{x5}{88.2kHz, 44.1kHz, 22.05kHz and 11.025kHz} are available. Higher sample rates use up more disk space, but give better sound quality. - \opt{SWCODEC}{\note{The 11.025kHz setting is not available when using% + \opt{swcodec}{\note{The 11.025kHz setting is not available when using% \setting{MPEG Layer 3} format.} }% \opt{MASCODEC}{ @@ -73,7 +73,7 @@ Choose the source of the recording. This can be \opt{recorder,recorderv2fm,h1xx}{\setting{SPDIF (digital)},}% \setting{Mic} or \setting{Line In}. - \opt{CONFIG_TUNER}{For recording from the radio see \reference{ref:FMradio}.} + \opt{radio}{For recording from the radio see \reference{ref:FMradio}.} \section{Channels} 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. \end{description} } -\opt{SWCODEC}{ +\opt{swcodec}{ \section{Crossfeed} Crossfeed attempts to make the experience of listening to music on headphones more similar to listening to music with stereo speakers. When you @@ -280,7 +280,7 @@ change to customise your listening experience. if you choose settings which result in a too high output level. } -\opt{SWCODEC}{ +\opt{swcodec}{ \section{\label{ref:EQ}Equalizer} \screenshot{configure_rockbox/images/ss-equalizer}{The graphical equalizer}{} Rockbox features a parametric equalizer (EQ). As the name suggests, a @@ -404,7 +404,7 @@ settings. \end{description} } -\opt{SWCODEC}{ +\opt{swcodec}{ \section{Dithering} This setting controls the dithering and noise shaping functionality of Rockbox. 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 @@ is currently used in the \dap{}. The two supported battery types are ``Alkaline'' or ``NiMH''.} - \opt{HAVE_USB_CHARGING}{ + \opt{usb_charging}{ %TODO: check where it is working correctly (except H300) and append the option to the respective platform file \item [Charge During USB Connection: ]This option lets you control whether the \dap{} should charge during the USB connection and hence draw the @@ -52,7 +52,7 @@ \end{description} } -\opt{HAVE_DIRCACHE,HAVE_DISK_STORAGE}{ +\opt{dircache,HAVE_DISK_STORAGE}{ \subsection{Disk} Options relating to the hard disk. @@ -67,7 +67,7 @@ afterwards. } - \opt{HAVE_DIRCACHE}{ + \opt{dircache}{ \item [Directory Cache: ]Rockbox has the ability to cache the contents of your drive in RAM. The \setting{Directory Cache} takes a small amount of memory away from Rockbox that would otherwise be used to buffer music, @@ -82,9 +82,9 @@ background.} } \end{description} -} % \opt{HAVE_DIRCACHE,HAVE_DISK_STORAGE} +} % \opt{dircache,HAVE_DISK_STORAGE} -\opt{CONFIG_RTC}{ +\opt{rtc}{ \subsection{Time and Date} Time related menu options. \begin{description} @@ -101,7 +101,7 @@ recording. Settings are either \setting{Off} or \setting{1} to \setting{10} minutes in 1 minute steps. Then \setting{15,30,45} and \setting{60} minutes are available. -\opt{HAVE_RTC_ALARM}{ +\opt{alarm}{ \subsection{Wake-Up Alarm} % TODO this isn't quite right for all targets, I think This option turns the \dap{} off and then starts it up again at the @@ -113,7 +113,7 @@ available. again before the alarm occurs, the alarm will be cancelled. Using this option disables the \setting{Sleep Timer}. - \opt{HAVE_RECORDING,CONFIG_TUNER}{ + \opt{recording,radio}{ \subsection{Alarm Wake up Screen} This option controls what the \dap{} does when it is woken up by the alarm. } 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. This option allows you to clear the backdrops that you set. }% -\opt{HAVE_LCD_BITMAP}{ +\opt{lcd_bitmap}{ \item[Line Selector Type.] This option allows you to select which type of line selector to use. \begin{description} @@ -74,7 +74,7 @@ customize the visual apperance of Rockbox. A small arrow to the left of the menu text. \item[Bar (inverse):] A bar with inverted foreground and background colour. -\opt{HAVE_LCD_COLOR}{ +\opt{lcd_color}{ \item[Bar (Solid Colour):] A bar with a solid colour, the colour is set in the \setting{Colours} submenu. @@ -85,7 +85,7 @@ customize the visual apperance of Rockbox. \end{description} } -\opt{HAVE_LCD_COLOR}{ +\opt{lcd_color}{ \item[Colours.] The options in this menu sets the colours for visual elements in Rockbox. \begin{description} @@ -109,5 +109,5 @@ customize the visual apperance of Rockbox. \item[Reset Colours:] Resets the LCD display to Rockbox's default colours. \end{description} -}% HAVE_LCD_COLOR +}% lcd_color \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 @@ \begin{itemize} \item Setting the Sound Option \setting{Channels} to \setting{Karaoke} may disable voice menus. - \item Plugins \opt{CONFIG_RTC}{and the wake up alarm} do not support + \item Plugins \opt{rtc}{and the wake up alarm} do not support voice features. \end{itemize} -- cgit v1.2.3