Nyaaori/rockbox
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Added \setting macro to System Options menu where necessary.

Browse source 
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@10016 a1c6a512-1295-4272-9138-f99709370657
This commit is contained in:
Michael DiFebbo 2006-05-30 00:35:33 +00:00
parent 9a3902f258
commit d9069ef1de
1 changed files with 36 additions and 34 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

70
manual/configure_rockbox/system_options.tex
View file

@ -16,9 +16,8 @@
present, and work is ongoing into finding a better way to determine battery life.}% present, and work is ongoing into finding a better way to determine battery life.}%
\ % \ %
Rockbox uses this value to estimate remaining battery life for the status Rockbox uses this value to estimate remaining battery life for the status
bar and WPS, setting it to the wrong value does not actually change the bar and WPS. Changing this setting has no effect whatsoever on actual battery life.
amount of time the battery will last, it only effects the accuracy of the This setting affects only the the accuracy of the battery life display on screen.
battery life display on screen.
\end{description} \end{description}
@ -36,18 +35,19 @@
\item [Disk Poweroff: ]This setting controls whether the disk is powered \item [Disk Poweroff: ]This setting controls whether the disk is powered
off or only set to ``sleep'' when spun down. If this setting is YES, off or only set to ``sleep'' when spun down. If this setting is YES,
the disk will power off. If set to NO, the disk will enter ``sleep'' the disk will power off. If set to NO, the disk will enter ``sleep''
mode. Power off uses less power but takes longer to spin-up. mode. Power off uses less power but takes slightly longer to spin-up.
} }
\item [Directory cache: ]Rockbox has the ability to scan the contents of \item [Directory cache: ]Rockbox has the ability to scan the contents of
your drive in the background and save those contents to a cache in RAM. your drive in the background and save those contents to a cache in RAM.
The Directory Cache takes a small amount of memory away from Rockbox The Directory Cache takes a small amount of memory away from Rockbox
that would otherwise be used to buffer music, but it speeds up navigation that would otherwise be used to buffer music, but it speeds up navigation
by eliminating the slight pause between the time a navigation button is by eliminating the slight pause between the time a navigation button is
pressed and the time Rockbox responds. Turning this setting ON activates pressed and the time Rockbox responds. Turning this setting \setting{On}
the directory cache, and turning it OFF deactivates the directory cache. activates the directory cache, and turning it OFF deactivates the
\note{The first time you set the directory cache to ON, Rockbox will directory cache.
request a reboot of the \dap\ and upon restarting take a few minutes to \note{The first time you set the directory cache to \setting{On},
scan the drive. Thereafter, the directory cache will work in the Rockbox will request a reboot of the \dap\ and upon restarting take a few
minutes to scan the drive. Thereafter, the directory cache will work in the
background.} background.}
\end{description} \end{description}
@ -70,18 +70,18 @@
\item [Sleep Timer: ]This option lets you power off your \dap\ after \item [Sleep Timer: ]This option lets you power off your \dap\ after
playing for a given time. playing for a given time.
\opt{recorderv2fm}{This setting is reset on boot. Using this option \opt{recorderv2fm}{This setting is reset on boot. Using this option
disables the \emph{Wake up alarm} (see below).} disables the \setting{Wake up alarm} (see below).}
\opt{recorderv2fm}{ \opt{recorderv2fm}{
\item [Wake up alarm: ]This option turns the \dap\ off and then starts \item [Wake up alarm: ]This option turns the \dap\ off and then starts
it up again at the specified time. This is most useful when combined it up again at the specified time. This is most useful when combined
with the ``resume'' setting in the ``Playback options'' menu is set to with the \setting{resume} setting in the \setting{Playback Options}
YES, so that the \dap\ wakes up and immediately starts playing music. menu is set to \setting{Yes}, so that the \dap\ wakes up and immediately
Use \ButtonLeft\ and \ButtonRight\ to adjust the minutes setting, starts playing music. Use \ButtonLeft\ and \ButtonRight\ to adjust the
\ButtonUp\ and \ButtonDown\ to adjust the HOURS. \ButtonPlay\ confirms minutes setting, \ButtonUp\ and \ButtonDown\ to adjust the HOURS.
the alarm and shuts your \dap\ down, and \ButtonOff cancels setting an \ButtonPlay\ confirms the alarm and shuts your \dap\ down, and \ButtonOff
alarm. If the \dap\ is turned on again before the alarm occurs, the alarm cancels setting an alarm. If the \dap\ is turned on again before the
will be canceled. Using this option disables the \emph{Sleep Timer} alarm occurs, the alarm will be canceled. Using this option disables
(see above). the \setting{Sleep Timer}(see above).
} }
\end{description} \end{description}
@ -104,14 +104,16 @@ This submenu relates to limits in the Rockbox operating system.
\opt{player,recorder,recorderv2fm}{ \opt{player,recorder,recorderv2fm}{
\subsection{Car Adapter Mode} \subsection{Car Adapter Mode}
This option turns on and off the car ignition auto stop function. This option turns \setting{On} and \setting{Off} the car ignition
auto stop function.
\begin{description} \begin{description}
\item [Car Adaptor Mode: ]When using the \dap\ in a car, car adapter mode \item [Car Adaptor Mode: ]When using the \dap\ in a car, car adapter mode
automatically stops playback on the \dap\ when power (i.e. from cigarette automatically stops playback on the \dap\ when power (i.e. from cigarette
lighter power adapter) to the external DC in jack is turned off. If the Car lighter power adapter) to the external DC in jack is turned off. If the Car
Adaptor Mode is set to ON, Rockbox will pause playback when the external Adaptor Mode is set to \setting{On}, Rockbox will pause playback when the
power off condition is detected. Rockbox will then shutdown the \dap\ after external power off condition is detected. Rockbox will then shutdown the
the length of time set in the \emph{Idle Poweroff} setting (see above). \dap\ after the length of time set in the \setting{Idle Poweroff} setting
(see above).
If power to the DC in jack is turned back on before the \emph{Idle Poweroff} If power to the DC in jack is turned back on before the \emph{Idle Poweroff}
function has shut the \dap\ off, playback will be resumed 5 seconds after function has shut the \dap\ off, playback will be resumed 5 seconds after
the power is applied. This delay is to allow for the time while the car the power is applied. This delay is to allow for the time while the car
@ -145,7 +147,7 @@ firmware versions.}
\fname{/.rockbox} directory and displays all .cfg (configuration) files. \fname{/.rockbox} directory and displays all .cfg (configuration) files.
Selecting a .cfg file will cause Rockbox to load that the settings Selecting a .cfg file will cause Rockbox to load that the settings
contained in that file. Pressing \ButtonLeft\ will exit back to the menu. contained in that file. Pressing \ButtonLeft\ will exit back to the menu.
See the \emph{Write .cfg files} option on the Manage Settings menu for See the \setting{Write .cfg files} option on the Manage Settings menu for
details of how to save and edit a configuration file. details of how to save and edit a configuration file.
% %
\item [Browse Firmwares: ]This displays a list of firmware file in \item [Browse Firmwares: ]This displays a list of firmware file in
@ -157,7 +159,7 @@ firmware versions.}
Playing a firmware file loads it into memory. Thus, it is possible to Playing a firmware file loads it into memory. Thus, it is possible to
run the original Archos firmware or a different version of Rockbox run the original Archos firmware or a different version of Rockbox
from here assuming that you have the right files installed on your from here assuming that you have the right files installed on your
disk. There's no need of any other file or directory to be installed disk. There is no need for any other file or directory to be installed
to use this option; the firmware is resident in that one file. to use this option; the firmware is resident in that one file.
} }
\item [Reset Settings: ]This wipes the saved settings in the \dap\ and \item [Reset Settings: ]This wipes the saved settings in the \dap\ and
@ -167,17 +169,17 @@ firmware versions.}
the \ButtonRec button immediately after the \dap\ turns on.} the \ButtonRec button immediately after the \dap\ turns on.}
} }
\item [Write .cfg file: ]This option writes a Rockbox configuration file \item [Write .cfg file: ]This option writes a Rockbox configuration file
to your jukebox's hard disk. The configuration file has the \fname{.cfg} to your \daps\ hard disk. The configuration file has the \fname{.cfg}
extension and is used to store all of the user settings that are described extension and is used to store all of the user settings that are described
throughout this manual. throughout this manual.
A configuration file may reside anywhere on the hard disk. Multiple A configuration file may reside anywhere on the hard disk. Multiple
configuration files are permitted. So, for example, you could have configuration files are permitted. So, for example, you could have
a \fname{car.cfg} file for the settings that you use while playing your a \fname{car.cfg} file for the settings that you use while playing your
jukebox in your car, and a headphones.cfg file to store the settings that jukebox in your car, and a \fname{headphones.cfg} file to store the
you use while listening to your jukebox through headphones. settings that you use while listening to your \dap\ through headphones.
The Rockbox configuration file is a plain text file, so once you use the The Rockbox configuration file is a plain text file, so once you use the
\emph{Write .cfg file} option to create the file, you can edit the file \setting{Write .cfg file} option to create the file, you can edit the file
on your computer using any text editor program. Configuration files use on your computer using any text editor program. Configuration files use
the following formatting rules: the following formatting rules:
% %
@ -190,19 +192,19 @@ firmware versions.}
into your configuration files. into your configuration files.
\end{enumerate} \end{enumerate}
Configuration files may be loaded using the Browse .cfg files option Configuration files may be loaded using the \setting{Browse .cfg files}
on the Manage Settings menu. option on the \setting{Manage Settings} menu.
\note{Configuration files do not need to contain all of the Rockbox \note{Configuration files do not need to contain all of the Rockbox
options. You can create configuration files that change only certain options. You can create configuration files that change only certain
settings. So, for example, let's say you typically use the \dap at one settings. So, for example, supppose you typically use the \dap at one
volume in the car, and another when using headphones. Further, volume in the car, and another when using headphones. Further,
suppose you like to use an inverse LCD when you're in the car, and suppose you like to use an inverse LCD when you're in the car, and
a regular LCD setting when you're using headphones. You could create a regular LCD setting when you're using headphones. You could create
configuration files that control only the volume and LCD settings. configuration files that control only the volume and LCD settings.
Create a few different files with different settings, give each file Create a few different files with different settings, give each file
a different name (such as car.cfg, headphones.cfg, etc.), and you a different name (such as \fname{car.cfg}, \fname{headphones.cfg},
can then use the \emph{Browse .cfg files} option to quickly change etc.), and you can then use the \setting{Browse .cfg files} option
settings.} to quickly change settings.}
\end{description} \end{description}