summaryrefslogtreecommitdiffstats
path: root/manual
diff options
context:
space:
mode:
authorAlex Parker <rockbox@aeparker.com>2009-08-25 21:51:55 +0000
committerAlex Parker <rockbox@aeparker.com>2009-08-25 21:51:55 +0000
commit51743419993ca23bb78d00b195eb2773743aed39 (patch)
tree0c7a8f0cd430d5bb68d42852155d7e8ed59d300e /manual
parentb26656410a81cb1ea703e3741e8b8fb193bff235 (diff)
downloadrockbox-51743419993ca23bb78d00b195eb2773743aed39.tar.gz
rockbox-51743419993ca23bb78d00b195eb2773743aed39.tar.bz2
rockbox-51743419993ca23bb78d00b195eb2773743aed39.zip
Add gigabeat F/S volume limits to the manual, and a few minor formatting changes.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@22513 a1c6a512-1295-4272-9138-f99709370657
Diffstat (limited to 'manual')
-rw-r--r--manual/advanced_topics/main.tex12
-rw-r--r--manual/configure_rockbox/playback_options.tex20
-rw-r--r--manual/configure_rockbox/sound_settings.tex25
-rw-r--r--manual/plugins/goban.tex15
-rw-r--r--manual/plugins/main.tex2
-rw-r--r--manual/plugins/pngviewer.tex4
-rw-r--r--manual/plugins/ppmviewer.tex13
-rw-r--r--manual/rockbox_interface/browsing_and_playing.tex4
-rw-r--r--manual/working_with_playlists/main.tex10
9 files changed, 52 insertions, 53 deletions
diff --git a/manual/advanced_topics/main.tex b/manual/advanced_topics/main.tex
index f6ba4ae52a..f95692267b 100644
--- a/manual/advanced_topics/main.tex
+++ b/manual/advanced_topics/main.tex
@@ -16,7 +16,8 @@ in the font package at \url{http://www.rockbox.org/daily.shtml}.}
\fname{/.rockbox/fonts} directory and the filename must be at most 24 characters
long. You can browse the fonts in \fname{/.rockbox/fonts} under
\setting{Settings $\rightarrow$ Theme Settings $\rightarrow$ Font}
- in the \setting{Main Menu}.
+ in the \setting{Main Menu}.\\
+
\note{Advanced Users Only: Any BDF font file up to 16 pixels high should
be usable with Rockbox. To convert from \fname{.bdf} to \fname{.fnt}, use
the \fname{convbdf} tool. This tool can be found in the \fname{tools}
@@ -28,11 +29,11 @@ in the font package at \url{http://www.rockbox.org/daily.shtml}.}
Rockbox can load language files at runtime. Simply copy the \fname{.lng} file
\emph{(do not use the .lang file)} to the \dap\ and ``play'' it in the
Rockbox directory browser or select \setting{Settings $\rightarrow$
-General Settings $\rightarrow$ Language }from the \setting{Main Menu}.
+General Settings $\rightarrow$ Language }from the \setting{Main Menu}.\\
\note{If you want a language to be loaded automatically every time you start
up, it must be located in the \fname{/.rockbox/langs} directory and the filename
-must be a maximum of 24 characters long.}
+must be a maximum of 24 characters long.\\}
If your language is not yet supported and you want to write your own language
file find the instructions on the Rockbox website:
@@ -220,7 +221,7 @@ plan).
If you use the upper-case versions of the
three tags: \config{F}, \config{I} and \config{D}, they will instead refer to
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.
+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
@@ -396,7 +397,7 @@ Example of a configuration file:
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.}
+ files} option to quickly change settings.\\}
A special case configuration file can be used to force a particular setting
or settings every time Rockbox starts up (e.g. to set the volume to a safe
@@ -482,6 +483,7 @@ You just ``play'' a file with the extension %
\opt{iaudio}{\fname{.iaudio}.} %
\opt{sansa,h10,h10_5gb}{\fname{.mi4}.} %
\opt{sansaAMS}{\fname{.sansa}.} %
+\opt{gigabeatf,gigabeats}{\fname{.gigabeat}.} %
This can be used to test new firmware versions without deleting your
current version.
diff --git a/manual/configure_rockbox/playback_options.tex b/manual/configure_rockbox/playback_options.tex
index fef0af2c4b..e34fc8734d 100644
--- a/manual/configure_rockbox/playback_options.tex
+++ b/manual/configure_rockbox/playback_options.tex
@@ -71,12 +71,12 @@ you to configure settings related to audio playback.
\opt{masd,masf}{
The anti-skip buffer can be set to a value between 0 and 7
- seconds.
+ seconds.\\
}
\opt{swcodec}{
The anti-skip buffer can be set to various values between
- 5 seconds and 10 minutes.
+ 5 seconds and 10 minutes.\\
}
\note{Having a large anti-skip buffer tends to use more power, and may
@@ -139,7 +139,7 @@ you to configure settings related to audio playback.
\note{The rules above apply except in the instance where
\setting{Fade Out Delay} plus \setting{Fade Out Duration} is less then
\setting{Fade In Delay} (which would create a gap in the audio). In this case,
- the \setting{Fade In Delay} is reduced to eliminate the gap.}
+ the \setting{Fade In Delay} is reduced to eliminate the gap.\\}
The graphic below illustrates how the different settings work in practice.
@@ -152,8 +152,9 @@ you to configure settings related to audio playback.
same apparent volume. This prevents sudden changes in volume when
changing between songs recorded at different volume levels.
For replaygain to work, the songs must have been processed by a program
- that adds replaygain information to the ID3 tags (or Vorbis tags).
- \note{APEv2 tags are not currently supported.}
+ that adds replaygain information to the ID3 tags (or Vorbis tags).\\
+
+ \note{APEv2 tags are not currently supported.\\}
Options for replaygain are:
\begin{description}
@@ -208,9 +209,11 @@ you to configure settings related to audio playback.
\setting{Auto-Change Directory} is set to \setting{No}, playback will stop at
the end of the current playlist. Using the \setting{Random} feature requires
you to first generate a folder list via the Random Folder Advance Configuration
- plugin (see \reference{ref:random_folder_advance_config}).
+ plugin (see \reference{ref:random_folder_advance_config}).\\
+
\note{You must have the \setting{Repeat} option set to \setting{No} for
- \setting{Auto-Change Directory} to function properly.}
+ \setting{Auto-Change Directory} to function properly.\\}
+
\note{This feature only works when songs have been played from the file
browser. Using it with the database may cause unexpected behavior.}
@@ -249,7 +252,8 @@ you to configure settings related to audio playback.
start the logging. The log-file is called
\opt{rtc}{\fname{.scrobbler.log},}%
\nopt{rtc}{\fname{.scrobbler-timeless.log},}%
- and is to be found in the root directory of your \dap{}.
+ 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/sound_settings.tex b/manual/configure_rockbox/sound_settings.tex
index e8e4f8aeee..6a7d423113 100644
--- a/manual/configure_rockbox/sound_settings.tex
+++ b/manual/configure_rockbox/sound_settings.tex
@@ -11,7 +11,7 @@ change to customise your listening experience.
can produce without possible distortion (clipping). All values lower than
this reference will be negative and yield a progressively softer volume.
\opt{player,recorder,recorderv2fm,ondio,x5,m5,ipodnano,ipodvideo,
- ipodcolor,ipod1g2g,h10,h10_5gb,sansa,sansaAMS}{
+ ipodcolor,ipod1g2g,h10,h10_5gb,sansa,sansaAMS,gigabeats,gigabeatf}{
Values higher than 0 dB are available and can be used to raise the
volume more than would otherwise be possible. These volume levels will
ordinarily lead to distorted sound, but might work nicely for music that has
@@ -25,6 +25,8 @@ change to customise your listening experience.
\opt{ipodvideo}{minimum of -57 dB to a maximum of +6 dB.}%
\opt{ipodcolor,ipod1g2g,h10,h10_5gb,sansa,sansaAMS}{minimum of -74 dB to a maximum
of +6 db.}%
+ \opt{gigabeats}{minimum of -90 dB to a maximum of +6 dB.}%
+ \opt{gigabeatf}{minimum of -74 dB to a maximum of +6 dB.}%
\section{Bass}
This setting emphasises
@@ -211,7 +213,7 @@ change to customise your listening experience.
headphones more similar to listening to music with stereo speakers. When you
listen to music through speakers, each ear will hear sound originating from
both speakers. However, the sound from the left speaker reaches your right
- ear slightly later than it does your left ear, and vice versa.
+ ear slightly later than it does your left ear, and vice versa.\\
The human ear and brain together are very good at interpreting the time
differences between direct sounds and reflected sounds and using that
@@ -220,7 +222,7 @@ change to customise your listening experience.
channel corresponding to it. The left ear hears only the left channel and
the right ear hears only the right channel. The result is that sound from
headphones does not provide the same spatial cues to your ear and brain as
- speakers, and might for that reason sound unnatural to some listeners.
+ speakers, and might for that reason sound unnatural to some listeners.\\
The crossfeed function uses an algorithm to feed a delayed and filtered
portion of the signal from the right channel into the left channel and vice
@@ -229,7 +231,7 @@ change to customise your listening experience.
result is a more natural stereo image that can be especially appreciated in
older rock and jazz records, where one instrument is often hard-panned to
just one of the speakers. Many people will find such records tiring to listen
- to using earphones and no crossfeed effect.
+ to using earphones and no crossfeed effect.\\
Crossfeed has the following settings:
\begin{description}
@@ -256,7 +258,6 @@ change to customise your listening experience.
virtual speaker placement suited to ones preference.
% TODO: adapt the guidelines for crossfeed settings found here?
% http://www.ohl.to/interests-in-audio/crossfeed-and-eq-for-headphones/
-
Beware that the crossfeed function is capable of making the audio distort
if you choose settings which result in a too high output level.
}
@@ -268,7 +269,7 @@ change to customise your listening experience.
parametric EQ lets you control several different parameters for each
band of the EQ. In some ways the EQ is similar to the \setting{Bass}
and \setting{Treble} settings described earlier, but the EQ allows you to
- control the sound much more carefully.
+ control the sound much more carefully.\\
Rockbox's parametric EQ is composed of five different bands:
\begin{description}
@@ -436,10 +437,8 @@ source, and a third order noise shaper.
\opt{swcodec}{
\section{Timestretch}
-Enabling \setting{Timestretch} allows you to change the playback speed without it
-affecting the pitch of the recording.
-
-After enabling this feature and rebooting, you can access this via the \setting{Pitch Screen}.
-This function is intended for speech playback and may significantly dilute your listening
-experience with more complex audio.
-}
+Enabling \setting{Timestretch} allows you to change the playback speed without
+it affecting the pitch of the recording. After enabling this feature and
+rebooting, you can access this via the \setting{Pitch Screen}. This function is
+intended for speech playback and may significantly dilute your listening
+experience with more complex audio.}
diff --git a/manual/plugins/goban.tex b/manual/plugins/goban.tex
index 815eec559f..385ee28ac4 100644
--- a/manual/plugins/goban.tex
+++ b/manual/plugins/goban.tex
@@ -2,13 +2,10 @@
\screenshot{plugins/images/ss-goban}{Goban}{The Rockbox Goban plugin}
Goban is a a plugin for playing, viewing and recording games of Go (also known
as Weiqi, Baduk, Igo and Goe). It uses standard Smart Game Format (SGF) files
-for saving and loading games.
-
-You can find a short introduction to Go at
+for saving and loading games. You can find a short introduction to Go at
\url{http://senseis.xmp.net/?WhatIsGo} and more information about SGF files
can be read at \url{http://senseis.xmp.net/?SmartGameFormat} or the SGF
-specification at
-\url{http://www.red-bean.com/sgf/}.
+specification at \url{http://www.red-bean.com/sgf/}.\\
This plugin can load all modern SGF files (file format 3 or 4) with few problems.
It attempts to preserve SGF properties which it doesn't understand, and most common
@@ -17,18 +14,18 @@ Kogo's Joseki Dictionary (\url{http://waterfire.us/joseki.htm}) with this plugin
although the load and save times can be on the order of a minute or two on
particularly slow devices. Large SGF files may stop audio playback for the duration
of the plugin's run in order to free up more memory and some very large SGF files will
-not even load on devices with little available memory.
+not even load on devices with little available memory.\\
-\emph{Note: } The plugin does \emph{NOT} support SGF files with multiple games in
+\note{The plugin does \emph{NOT} support SGF files with multiple games in
one file. These are rare, but if you have one don't even try it (the file will most
-likely be corrupted if you save over it). You have been warned.
+likely be corrupted if you save over it). You have been warned.\\}
The file \fname {"/sgf/gbn\_def.sgf"} is used by the plugin to store any unsaved
changes in the most recently loaded game. This means that if you forget to save your
changes, you should load \fname {"/sgf/gbn\_def.sgf"} immediately to offload the changes
to another file. If you load another file first then your changes will be lost
permanently. The \fname {"/sgf/gbn\_def.sgf"} file is also the file loaded if another
-is not selected.
+is not selected.\\
The information panel which displays the current move number may also contain
these markers: \\
diff --git a/manual/plugins/main.tex b/manual/plugins/main.tex
index 1a57fc96ef..a737598059 100644
--- a/manual/plugins/main.tex
+++ b/manual/plugins/main.tex
@@ -6,7 +6,7 @@ This means you cannot switch back and forth between a plugin and Rockbox. When
a plugin is loaded, you need to exit it to return to the Rockbox interface.
Most plugins will not interfere with music playback but some of them will stop
playback while running. Plugins have the file extension \fname{.rock}. Most of
-them can be started from \setting{Browse Plugins} in the \setting{Main Menu}.
+them can be started from \setting{Browse Plugins} in the \setting{Main Menu}.\\
Viewer plugins get started automatically by opening an associated file (i.e.
text files%
diff --git a/manual/plugins/pngviewer.tex b/manual/plugins/pngviewer.tex
index c205ac0666..40e91977de 100644
--- a/manual/plugins/pngviewer.tex
+++ b/manual/plugins/pngviewer.tex
@@ -1,10 +1,10 @@
% $Id: $id$ %
\subsection{PNG viewer}
-Open a PNG file in the \setting{File Browser} to view it%
+Open a PNG file in the \setting{File Browser} to view it.\\%
\opt{swcodec}{
\note{When an audio file is playing the size of the image is limited as
the decoding process needs to share memory with audio tracks. To be able to
- view a bigger file you may need to stop playback.}
+ view a bigger file you may need to stop playback.\\}
}
\nopt{large_plugin_buffer}{%
\note{This plugin will cause playback to stop.}%
diff --git a/manual/plugins/ppmviewer.tex b/manual/plugins/ppmviewer.tex
index 7de2b8ca0f..7594fafe69 100644
--- a/manual/plugins/ppmviewer.tex
+++ b/manual/plugins/ppmviewer.tex
@@ -1,11 +1,8 @@
% $Id$ %
\subsection{PPM viewer}
-Open a PPM file in the \setting{File Browser} to view it.
+Open a PPM file in the \setting{File Browser} to view it. PPM viewer exits
+when any button is pressed.\\
-ppmviewer exits when any button is pressed.
-
-\note{
-Both ASCII PPM (P3) and raw PPM (P6) files are supported.
-
-For more information about PPM files, see \url{http://netpbm.sourceforge.net/doc/ppm.html}
-}
+\note{Both ASCII PPM (P3) and raw PPM (P6) files are supported.
+For more information about PPM files, see
+\url{http://netpbm.sourceforge.net/doc/ppm.html}}
diff --git a/manual/rockbox_interface/browsing_and_playing.tex b/manual/rockbox_interface/browsing_and_playing.tex
index f6054524b7..bdbb97ef5c 100644
--- a/manual/rockbox_interface/browsing_and_playing.tex
+++ b/manual/rockbox_interface/browsing_and_playing.tex
@@ -121,12 +121,12 @@ the \setting{Show Files} setting to all.
The \setting{Context Menu} allows you to perform certain operations on files or
directories. To access the \setting{Context Menu}, position the selector over a file
-or directory and access the context menu with \ActionStdContext{}.
+or directory and access the context menu with \ActionStdContext{}.\\
\note{The \setting{Context Menu} is a context sensitive menu. If the
\setting{Context Menu} is invoked on a file, it will display options available
for files. If the \setting{Context Menu} is invoked on a directory,
-it will display options for directories.}
+it will display options for directories.\\}
The \setting{Context Menu} contains the following options (unless otherwise noted,
each option pertains both to files and directories):
diff --git a/manual/working_with_playlists/main.tex b/manual/working_with_playlists/main.tex
index bdc82c02cd..96781e0324 100644
--- a/manual/working_with_playlists/main.tex
+++ b/manual/working_with_playlists/main.tex
@@ -40,7 +40,7 @@ Rockbox can create playlists in four different ways.
Whenever a song is selected from the \setting{File Browser} with
\ActionTreeEnter, Rockbox will automatically create a playlist containing
all of the songs in that directory and start playback with the selected
-song.
+song.\\
\note{If you already have created a dynamic playlist, playing a new
song will \emph{erase} the current dynamic playlist and create a new one.
@@ -60,7 +60,7 @@ that are not currently playing. To do this select \setting{Playlist catalog}
in the \setting{Context Menu}. There you will have two choices,
\setting{Add to playlist} adds the selected track or directory to an existing
playlist and \setting{Add to a new playlist} creates a new playlist containing
-the selected track or directory.
+the selected track or directory.\\
\note{All playlists in the \setting{Playlist catalog} are stored by default
in the \fname{/Playlists} directory in the root of your \daps{} disk and
@@ -121,17 +121,17 @@ entire directories to a playlist. If the \setting{Playlist Submenu} is
invoked on a single track, it will put only that track into the playlist.
On the other hand, if the \setting{Playlist Submenu} is invoked on a
directory, Rockbox adds all of the tracks in that directory to the
-playlist.
+playlist.\\
\note{You can control whether or not Rockbox includes the contents of
subdirectories when adding an entire directory to a playlists. Set the
\setting{Settings $\rightarrow$ General Settings $\rightarrow$ Playlist
$\rightarrow$ Recursively Insert Directories} setting to \setting{Yes} if
you would like Rockbox to include tracks in subdirectories as well as tracks
- in the currently-selected directory.}
+ in the currently-selected directory.\\}
Dynamic playlists are saved so resume will restore them exactly as they
-were before shutdown.
+were before shutdown.\\
\note{To view, save or reshuffle the current dynamic playlist use the
\setting{Playlist} sub menu in the WPS context menu or in the