summaryrefslogtreecommitdiffstats
path: root/manual
diff options
context:
space:
mode:
authorMartin Arver <martin.arver@gmail.com>2006-08-18 16:57:56 +0000
committerMartin Arver <martin.arver@gmail.com>2006-08-18 16:57:56 +0000
commit09c3961a4964ed5e31d9a5e5d09302f4ae03ecf6 (patch)
tree4b9e8c5735d179d33fb6529afcd9b60ecae71766 /manual
parent89e411b34ce434f4f0906d1e3c575e79107157ab (diff)
downloadrockbox-09c3961a4964ed5e31d9a5e5d09302f4ae03ecf6.tar.gz
rockbox-09c3961a4964ed5e31d9a5e5d09302f4ae03ecf6.zip
Fix for commas and periods eaten up by our macros. Do not use \ after a macro if followed by a , or a . Use nothing or {} instead. Thanks to Mikachu for noticing.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@10649 a1c6a512-1295-4272-9138-f99709370657
Diffstat (limited to 'manual')
-rw-r--r--manual/advanced_topics/main.tex288
-rw-r--r--manual/getting_started/iriver_install.tex2
-rw-r--r--manual/plugins/solitaire.tex2
-rw-r--r--manual/rockbox_interface/main.tex16
4 files changed, 154 insertions, 154 deletions
diff --git a/manual/advanced_topics/main.tex b/manual/advanced_topics/main.tex
index a65d50f1e7..57007e34f8 100644
--- a/manual/advanced_topics/main.tex
+++ b/manual/advanced_topics/main.tex
@@ -41,13 +41,13 @@ file find the instructions on the Rockbox website:
\subsection{WPS -- General Info}
\begin{description}
-\item[Description: ] The WPS or While Playing Screen is the name used to describe
-the information displayed on the \daps\ screen whilst an audio track is
-being played. The default WPS is a relatively simple screen displaying
-Track name, Artist, Album etc. in the default font as a purely text based
-layout. There are a number of WPS files included in Rockbox, and you can
-load one of these at anytime by selecting it in
-\setting{General Settings $\rightarrow$ Display $\rightarrow$ Browse .wps files}.
+\item[Description: ] The WPS or While Playing Screen is the name used to
+ describe the information displayed on the \daps\ screen whilst an audio track
+ is being played. The default WPS is a relatively simple screen displaying
+ Track name, Artist, Album etc. in the default font as a purely text based
+ layout. There are a number of WPS files included in Rockbox, and you can
+ load one of these at anytime by selecting it in
+ \setting{General Settings $\rightarrow$ Display $\rightarrow$ Browse .wps files}.
\opt{h1xx,h300}{There is a related option to browse \fname{.rwps} files for
\daps\ with LCD remote controls installed. This will load a similar WPS
@@ -56,11 +56,11 @@ load one of these at anytime by selecting it in
\note{``Playing'' a \fname{.wps} from the file browser has the same effect.}
\item [File Location: ]Custom WPS files may be located anywhere on the drive.
-The only restriction is that they must end in \fname{.wps}. When you ``play''
-a \fname{.wps} file, it will be used for future WPS screens, and if the
-``played'' \fname{.wps} file is located in the \fname{/.rockbox} folder, it
-will be remembered and used after reboot. The \fname{.wps} filename must be no
-more than 24 characters long for it to be remembered.
+ The only restriction is that they must end in \fname{.wps}. When you ``play''
+ a \fname{.wps} file, it will be used for future WPS screens, and if the
+ ``played'' \fname{.wps} file is located in the \fname{/.rockbox} folder, it
+ will be remembered and used after reboot. The \fname{.wps} filename must be
+ no more than 24 characters long for it to be remembered.
\end{description}
\subsection{\label{ref:CreateYourOwnWPS}WPS -- Build Your Own}
@@ -70,17 +70,17 @@ file, save it as a \fname{.wps} file. Example: Instead of \fname{Rockbox.txt},
save the file as \fname{Rockbox.wps}. To make sure non english characters
display correctly in your WPS you must save the .wps file with UTF-8 character
encoding. This can be done in most editors, for example Notepad in Windows 2000
-or XP (but not in 9x/ME) can do this. See appendix \reference{ref:wps_tags} for all
-the tags that are available.
+or XP (but not in 9x/ME) can do this. See appendix \reference{ref:wps_tags} for
+all the tags that are available.
\begin{itemize}
- \item All characters not preceded by \% are displayed as typed.
- \item Lines beginning with \# are comments and will be ignored.
- \item Maximum file size used is
- \opt{recorder,recorderv2fm,ondio,h1xx,h300,ipodcolor,ipodnano}{1600}
- \opt{player}{400} bytes.
- If you have a bigger WPS file, only the first part of it will be
- loaded and used.
+\item All characters not preceded by \% are displayed as typed.
+\item Lines beginning with \# are comments and will be ignored.
+\item Maximum file size used is
+ \opt{recorder,recorderv2fm,ondio,h1xx,h300,ipodcolor,ipodnano}{1600}
+ \opt{player}{400} bytes.
+ If you have a bigger WPS file, only the first part of it will be
+ loaded and used.
\end{itemize}
\subsubsection{Conditional Tags}
@@ -104,7 +104,7 @@ For tags with multiple values, like Play status, the conditional can hold a
list of alternatives, one for each value the tag can have.
Example enumeration:
\begin{example}
- \%?mp{\textless}Stop{\textbar}Play{\textbar}Pause{\textbar}Ffwd{\textbar}Rew{\textgreater}
+ \%?mp{\textless}Stop{\textbar}Play{\textbar}Pause{\textbar}Ffwd{\textbar}Rew{\textgreater}
\end{example}
The last else part is optional, and will be displayed if the tag has no value.
@@ -123,9 +123,9 @@ the next song instead of the current one. Example: \config{\%Ig} is the genre
name used in the next song and \config{\%Ff} is the mp3 frequency.
\note{The next song information \emph{will not} be available at all
-times, but will most likely be available at the end of a song. We
-suggest you use the conditional display tag a lot when displaying
-information about the next song!}
+ times, but will most likely be available at the end of a song. We
+ suggest you use the conditional display tag a lot when displaying
+ information about the next song!}
\subsubsection{Alternating sublines}
@@ -189,10 +189,10 @@ displaying images:
\item Load and always show the image, using the \config{\%x} tag
\item Preload the image with \config{\%xl} and show it with \config{\%xd}.
This way you can have your images displayed conditionally.
- \opt{HAVE_LCD_COLOR}{
- \item Load an image and show as backdrop using the \config{\%X} tag. The
- image must be of the same exact dimensions as your display.
- }
+ \opt{HAVE_LCD_COLOR}{
+ \item Load an image and show as backdrop using the \config{\%X} tag. The
+ image must be of the same exact dimensions as your display.
+ }
\end{enumerate}
\optv{HAVE_LCD_COLOR}{
@@ -239,126 +239,126 @@ title [artist]''.
\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
+\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.
- \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.}
- }
+ \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.
+\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.
+ 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}
+\end{description}
\section{\label{ref:FirmwareLoading}Firmware Loading}
\opt{player,recorder,recorderv2fm,ondio}{
diff --git a/manual/getting_started/iriver_install.tex b/manual/getting_started/iriver_install.tex
index 1b0e0a7db0..5d8e6b440e 100644
--- a/manual/getting_started/iriver_install.tex
+++ b/manual/getting_started/iriver_install.tex
@@ -23,7 +23,7 @@
\opt{IRIVER_H300_PAD}{1.28K, 1.28EU, 1.28J, 1.29K, 1.29J and 1.30EU.
\note{The US H3xx firmware is not currently supported and cannot be
patched to be used with the bootloader. If you wish to install Rockbox
- on a US \playername\, you must use an international firmware, which will
+ on a US \playername, you must use an international firmware, which will
permanently remove DRM support from the player.}
}%
If the file that you downloaded is a \fname{.zip} file, use an unzip
diff --git a/manual/plugins/solitaire.tex b/manual/plugins/solitaire.tex
index 41ca0946fc..7ddf7cc1a8 100644
--- a/manual/plugins/solitaire.tex
+++ b/manual/plugins/solitaire.tex
@@ -16,7 +16,7 @@ visit\\
\begin{table}
\begin{btnmap}{}{}
\opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD}
- {\ButtonLeft, \ButtonRight, \ButtonUp\, \ButtonDown}
+ {\ButtonLeft, \ButtonRight, \ButtonUp, \ButtonDown}
\opt{IPOD_4G_PAD}{\ButtonLeft, \ButtonRight, \ButtonMenu, \ButtonPlay}
& Move Cursor around.\\
%
diff --git a/manual/rockbox_interface/main.tex b/manual/rockbox_interface/main.tex
index 009c05d754..4ebc6b71ef 100644
--- a/manual/rockbox_interface/main.tex
+++ b/manual/rockbox_interface/main.tex
@@ -74,21 +74,21 @@ picture above.
}
%
\opt{ipodnano}{
- The main controls on the \dap\ are a slightly indented wheel with a
- flat round button in the center. Hold the \dap\ with these controls on the
+ The main controls on the \dap{} are a slightly indented wheel with a
+ flat round button in the center. Hold the \dap{} with these controls on the
top surface. There is a Hold switch at one end, and headphone and USB jacks
at the other; be sure the end with the switch is facing away from you.
- The button in the middle of the wheel is called \ButtonSelect\. You can
+ The button in the middle of the wheel is called \ButtonSelect. You can
operate the wheel by pressing the top, bottom, left or right sections,
- or by sliding your finger around it. The top is \ButtonMenu\, the bottom is
- \ButtonPlay\, the left is \ButtonLeft\, and the right is \ButtonRight\.
- When the manual says to \ButtonScrollFwd\, it means to slide your finger
- clockwise around the wheel. \ButtonScrollBack\ means to slide your finger
+ or by sliding your finger around it. The top is \ButtonMenu, the bottom is
+ \ButtonPlay, the left is \ButtonLeft, and the right is \ButtonRight.
+ When the manual says to \ButtonScrollFwd, it means to slide your finger
+ clockwise around the wheel. \ButtonScrollBack{} means to slide your finger
counterclockwise. Note that the wheel is sensitive, so you will need to move
slowly at first and get a feel for how it works.
- Note that when the Hold switch is pushed toward the center of the \dap\,
+ Note that when the Hold switch is pushed toward the center of the \dap,
Hold is on, and none of the other controls do anything; be sure Hold is
off before trying to use your player.
}