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

lots of small tweaks to system options, fix typos, remove extra whitespace, use macros etc.

Browse source 
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@10442 a1c6a512-1295-4272-9138-f99709370657
This commit is contained in:
Nils Wallménius 2006-08-03 19:45:53 +00:00
parent da1e28c17f
commit 9be4423691
1 changed files with 53 additions and 54 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

107
manual/configure_rockbox/system_options.tex
View file

@ -1,3 +1,4 @@
% $Id$ %
\section{\label{ref:SystemOptions}System Options}
\subsection{Battery}
@ -5,15 +6,15 @@
\begin{description}
\item [Battery Capacity: ]This setting can be used to tell Rockbox what
capacity (in mAh) of battery is being used inside it. The default is
\opt{player,recorder}{1500mAh}
\opt{recorderv2fm}{2200mAh}
\opt{ondiosp,ondiofm}{1000mAh}
\opt{h1xx,h300}{1300mAh}
\opt{ipodmini}{400mAh (1G) or 630mAh (2G)}
\opt{ipodcolor}{700mAh}
\opt{ipodnano,ipodvideo,ipod4g}{\fixme{unknown}}
\opt{x5}{950mAh}
which is the capacity value for the standard batteries shipped with the \dap.
\opt{player,recorder}{1500mAh}%
\opt{recorderv2fm}{2200mAh}%
\opt{ondiosp,ondiofm}{1000mAh}%
\opt{h1xx,h300}{1300mAh}%
\opt{ipodmini}{400mAh (1G) or 630mAh (2G)}%
\opt{ipodcolor}{700mAh}%
\opt{ipodnano,ipodvideo,ipod4g}{\fixme{unknown}}%
\opt{x5}{950mAh}%
, which is the capacity value for the standard batteries shipped with the \dap.
Rockbox uses this value to estimate remaining battery life for the status
bar and WPS. Changing this setting has no effect whatsoever on actual battery life.
This setting affects only the the accuracy of the battery life display on screen.
@ -25,7 +26,6 @@
\item [Battery Type: ]This setting tells Rockbox wich type of battery
that is currently used in the \dap.
}
\end{description}
\nopt{ondiosp,ondiofm}{
@ -54,11 +54,11 @@
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
pressed and the time Rockbox responds. Turning this setting \setting{On}
activates the directory cache, and turning it \setting{Off} deactivates the
activates the directory cache, and turning it \setting{Off} deactivates the
directory cache.
\note{The first time you set the directory cache to \setting{On},
\note{The first time you set the directory cache to \setting{On},
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
minutes to scan the drive. Thereafter, the directory cache will work in the
background.}
}
\end{description}
@ -87,13 +87,13 @@
\opt{recorderv2fm}{
\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
with the \setting{resume} setting in the \setting{Playback Options}
with the \setting{resume} setting in the \setting{Playback Options}
menu is set to \setting{Yes}, so that the \dap\ wakes up and immediately
starts playing music. Use \ButtonLeft\ and \ButtonRight\ to adjust the
minutes setting, \ButtonUp\ and \ButtonDown\ to adjust the HOURS.
\ButtonPlay\ confirms the alarm and shuts your \dap\ down, and \ButtonOff
cancels setting an alarm. If the \dap\ is turned on again before the
alarm occurs, the alarm will be canceled. Using this option disables
starts playing music. Use \ButtonLeft\ and \ButtonRight\ to adjust the
minutes setting, \ButtonUp\ and \ButtonDown\ to adjust the HOURS.
\ButtonPlay\ confirms the alarm and shuts your \dap\ down, and \ButtonOff
cancels setting an alarm. If the \dap\ is turned on again before the
alarm occurs, the alarm will be canceled. Using this option disables
the \setting{Sleep Timer}(see above).
}
\end{description}
@ -101,32 +101,32 @@
\subsection{Limits}
This submenu relates to limits in the Rockbox operating system.
\begin{description}
\item [Max files in dir browser: ]This setting controls the limit on
\item [Max files in dir browser: ]This setting controls the limit on
the number of files that you can put in any particular directory in the
file browser. You can configure the size to be between 50 and 10000 files
file browser. You can configure the size to be between 50 and 10,000 files
in steps of 50 files. The default is 400. Higher values will shorten the
music buffer, so you should increase this setting \emph{only} if you have
directories with a large number of files.
\item [Max playlist size: ]This setting controls the maximum size of
a playlist. The playlist size can be between 1,000 and 20,000 files,
in steps of 1000 (default is 10,000). Higher values will shorten the
in steps of 1,000 (default is 10,000). Higher values will shorten the
music buffer, so you should increase this setting \emph{only} if you
have very large playlists.
\end{description}
\opt{player,recorder,recorderv2fm}{
\subsection{Car Adapter Mode}
This option turns \setting{On} and \setting{Off} the car ignition
This option turns \setting{On} and \setting{Off} the car ignition
auto stop function.
\begin{description}
\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
lighter power adapter) to the external DC in jack is turned off. If the Car
Adaptor Mode is set to \setting{On}, Rockbox will pause playback when the
external power off condition is detected. Rockbox will then shutdown the
\dap\ after the length of time set in the \setting{Idle Poweroff} setting
(see above).
\item [Car Adapter Mode: ]When using the \dap\ in a car,
\setting{Car Adapter Mode} 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 \setting{Car Adapter Mode} is set to \setting{On},
Rockbox will pause playback when the external power off condition is
detected. Rockbox will then shutdown the \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}
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
@ -134,20 +134,18 @@ This submenu relates to limits in the Rockbox operating system.
\end{description}
Once the \dap\ is shut off either manually, or automatically with the
\emph{Idle Poweroff} function, it must be powered up manually to resume
\setting{Idle Poweroff} function, it must be powered up manually to resume
playback.
}
\opt{player}{
\begin{description}
\item [Line In (Player only): ] This option activates the line in port
on \dap\ Player, which is off by default. This is useful for such applications as:
\subsection{Line In} This option activates the line in port on \dap, which is
off by default. This is useful for such applications as:
\begin{itemize}
\item Game boy $\rightarrow$ \dap $\rightarrow$ human
\item laptop $\rightarrow$ \dap $\rightarrow$ human
\item LAN party computer $\rightarrow$ \dap $\rightarrow$ human
\end{itemize}
\end{description}
}
\subsection{\label{ref:manage_settings}Manage settings}
@ -157,26 +155,26 @@ firmware versions.}
%
\begin{description}
\item [Browse .cfg Files: ]Opens the file browser in the
\fname{/.rockbox} directory and displays all .cfg (configuration) files.
Selecting a .cfg file will cause Rockbox to load that the settings
\fname{/.rockbox} directory and displays all \fname{.cfg} (configuration) files.
Selecting a \fname{.cfg} file will cause Rockbox to load the settings
contained in that file. Pressing \ButtonLeft\ will exit back to the menu.
See the \setting{Write .cfg files} option on the Manage Settings menu for
See the \setting{Write .cfg files} option on the \setting{Manage Settings} menu for
details of how to save and edit a configuration file.
%
\item [Browse Firmwares: ]This displays a list of firmware file in
the \fname{/.rockbox} system directory. %
\opt{SWCODEC}{This is legacy item, and is depreciated.}
\opt{MASCODEC}{
\opt{recorder,recorderv2fm}{Firmware files have an extension of .ajz.}
\opt{player,ondio}{ Firmware files have an extension of .mod}
Playing a firmware file loads it into memory. Thus, it is possible to
\opt{SWCODEC}{\fixme{This is legacy item, and is depreciated.}}
\opt{MASCODEC}{%
\opt{recorder,recorderv2fm}{Firmware files have an extension of \fname{.ajz}. }%
\opt{player,ondio}{Firmware files have an extension of \fname{.mod}. }%
Playing a firmware file loads it into memory. Thus, it is possible to
run the original Archos firmware or a different version of Rockbox
from here assuming that you have the right files installed on your
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.
}
\item [Reset Settings: ]This wipes the saved settings in the \dap\ and
resets all settings to their default values.
resets all settings to their default values.
\opt{h100, h300}{\note{You can also reset all settings to their default
values by turning off the \dap\, turning it back on, and pressing
the \ButtonRec button immediately after the \dap\ turns on.}
@ -186,15 +184,16 @@ firmware versions.}
extension and is used to store all of the user settings that are described
throughout this manual.
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
jukebox in your car, and a \fname{headphones.cfg} file to store the
jukebox in your car, and a \fname{headphones.cfg} file to store the
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
\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
the following formatting rules:
on your computer using any text editor program. See
\reference{ref:config_file_options} for available settings. Configuration
files use the following formatting rules:
%
\begin{enumerate}
\item Each setting must be on a separate line.
@ -208,16 +207,16 @@ firmware versions.}
Configuration files may be loaded using the \setting{Browse .cfg files}
option on the \setting{Manage Settings} menu.
\note{Configuration files do not need to contain all of the Rockbox
options. You can create configuration files that change only certain
\note{Configuration files do not need to contain all of the Rockbox
options. You can create configuration files that change only certain
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
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.
Create a few different files with different settings, give each file
a different name (such as \fname{car.cfg}, \fname{headphones.cfg},
etc.), and you can then use the \setting{Browse .cfg files} option
etc.), and you can then use the \setting{Browse .cfg files} option
to quickly change settings.}
\end{description}