summaryrefslogtreecommitdiffstats
path: root/manual/advanced_topics/main.tex
diff options
context:
space:
mode:
Diffstat (limited to 'manual/advanced_topics/main.tex')
-rw-r--r--manual/advanced_topics/main.tex153
1 files changed, 122 insertions, 31 deletions
diff --git a/manual/advanced_topics/main.tex b/manual/advanced_topics/main.tex
index 2cb5c41544..81a0d4c715 100644
--- a/manual/advanced_topics/main.tex
+++ b/manual/advanced_topics/main.tex
@@ -237,37 +237,128 @@ title [artist]''.
% % \end{verbatim}
%}
-\section{\label{ref:SettingsFile}Making your own settings file}
-A \fname{.cfg} file is used to load settings from a plain text file. A
-\fname{.cfg} file may reside anywhere on the hard disk. The only restriction is
-that the filename must end in \fname{.cfg}
-
-Hint: Use the \setting{Write .cfg file} feature (\setting{Main Menu$\rightarrow$
-General Settings}) to save the current settings, then use a text editor to
-customize the settings file. See appendix \reference{ref:config_file_options}
-for the full reference of available options.
-
-\subsection{Format Rules}
-
-\begin{itemize}
-\item Format: \config{setting: value}
-\item Each setting must be on a separate line.
-\item Lines starting with \config{\#} are ignored.
-\end{itemize}
-
-Example of a configuration file:
-\begin{example}
- # Example configuration file
- volume: 70
- bass: 11
- treble: 12
- balance: 0
- time format: 12hour
- volume display: numeric
- show files: supported
- wps: /.rockbox/car.wps
- lang: /.rockbox/afrikaans.lng
-\end{example}
+\section{\label{ref:manage_settings}Managing Rockbox settings}
+
+ \subsection{Introduction to \fname{.cfg} files.}
+ Rockbox allows users to store and load multiple settings through the use of
+ configuration files. A configuration file is simply a text file with the
+ extension \fname{.cfg}.
+
+ A configuration file may reside anywhere on the hard disk. Multiple
+ 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
+ settings that you use while listening to your \dap\ through headphones.
+
+ See \reference{ref:cfg_specs} below for an explanation of the format
+ for configuration files. See \reference{ref:manage_settings_menu} for an
+ explanation of how to create, edit and load configuration files.
+
+ \subsection{\label{ref:cfg_specs}Specifications for \fname{.cfg}
+ files.}
+
+ 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. See
+ Appendix \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.
+ \item Each line has the format ``setting: value''.
+ \item Values must be within the ranges specified in this manual for each
+ setting.
+ \item Lines starting with \# are ignored. This lets you write comments into
+ your configuration files.
+ \end{enumerate}
+
+ Example of a configuration file:
+ \begin{example}
+ # Example configuration file
+ # volume: 70
+ # bass: 11
+ # treble: 12
+ # balance: 0
+ # time format: 12hour
+ # volume display: numeric
+ # show files: supported
+ # wps: /.rockbox/car.wps
+ # lang: /.rockbox/afrikaans.lng
+ \end{example}
+
+ \note{As you can see from the example, 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, suppose you like to use an inverse LCD when you are
+ in the car, and a regular LCD setting when you are 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 to quickly change settings.}
+
+ \subsection{\label{ref:manage_settings_menu}The \setting{Manage Settings}
+ menu} The \setting{Manage Settings} menu can be found in the \setting{Main
+ Menu}. The \setting{Manage Settings} menu allows you to save and load
+ \fname{.cfg} files. \opt{MASCODEC}{The \setting{Manage Settings} menu also
+ allows you to load or save different firmware versions.}
+
+ \begin{description}
+
+ \item [Browse .cfg Files.]Opens the file browser in the
+ \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 \setting{Manage Settings} menu. 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.]
+ %
+ \opt{SWCODEC}{\fixme{This is a legacy item, and is deprecated.}}
+ %
+ \opt{MASCODEC}{
+ This displays a list of firmware files in the \fname{/.rockbox}
+ system directory.
+ %
+ \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.
+
+ \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.}
+ }
+ \opt{ipod}{\note{You can also reset all settings to their default values
+ by turning off the \dap\, and turning it back on with the hold button
+ on.}
+ }
+
+ \item [Write .cfg file.]This option writes a \fname{.cfg} file 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
+ throughout this manual.
+
+ Hint: Use the \setting{Write .cfg file} feature (\setting{Main
+ Menu $\rightarrow$ General Settings}) to save the current settings, then
+ use a text editor to customize the settings file. See Appendix
+ \reference{ref:config_file_options} for the full reference of available
+ options.
+
+ \end{description}
\section{\label{ref:PartISection1}Differences between binaries}
There are 3 different types of firmware binaries from Rockbox website: