summaryrefslogtreecommitdiff
path: root/manual/appendix
diff options
context:
space:
mode:
Diffstat (limited to 'manual/appendix')
-rw-r--r--manual/appendix/appendix.tex2
-rw-r--r--manual/appendix/config_file_options.tex11
-rw-r--r--manual/appendix/file_formats.tex8
-rw-r--r--manual/appendix/wps_tags.tex19
4 files changed, 8 insertions, 32 deletions
diff --git a/manual/appendix/appendix.tex b/manual/appendix/appendix.tex
index f1d6ccca16..1ce4eef7c9 100644
--- a/manual/appendix/appendix.tex
+++ b/manual/appendix/appendix.tex
@@ -3,7 +3,7 @@
3 3
4\input{appendix/file_formats.tex} 4\input{appendix/file_formats.tex}
5 5
6\opt{lcd_bitmap}{\input{appendix/album_art_info.tex}} 6\input{appendix/album_art_info.tex}
7 7
8\input{appendix/wps_tags.tex} 8\input{appendix/wps_tags.tex}
9 9
diff --git a/manual/appendix/config_file_options.tex b/manual/appendix/config_file_options.tex
index 74607b4507..117d6f90fe 100644
--- a/manual/appendix/config_file_options.tex
+++ b/manual/appendix/config_file_options.tex
@@ -64,9 +64,7 @@
64 bidir limit & 0 to 200 & \% screen\\ 64 bidir limit & 0 to 200 & \% screen\\
65 scroll paginated & on, off & N/A\\ 65 scroll paginated & on, off & N/A\\
66 hold\_lr\_for\_scroll\_in\_list & on, off & N/A\\ 66 hold\_lr\_for\_scroll\_in\_list & on, off & N/A\\
67 \opt{lcd_bitmap}{ 67 show path in browser & off, current directory, full path & N/A\\
68 show path in browser & off, current directory, full path & N/A\\
69 }
70 contrast & 0 to 63 & N/A\\ 68 contrast & 0 to 63 & N/A\\
71 backlight timeout 69 backlight timeout
72 & off, on, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25, 30, 70 & off, on, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25, 30,
@@ -167,7 +165,6 @@
167 list\_accel\_wait & 1 to 10 & s\\ 165 list\_accel\_wait & 1 to 10 & s\\
168 } 166 }
169% 167%
170 \opt{swcodec}{
171 replaygain type 168 replaygain type
172 & track, album, track shuffle, off 169 & track, album, track shuffle, off
173 & N/A\\ 170 & N/A\\
@@ -232,7 +229,6 @@
232 keyclick repeats & on, off & N/A\\ 229 keyclick repeats & on, off & N/A\\
233 dircache & on, off & N/A\\ 230 dircache & on, off & N/A\\
234 tagcache\_ram & on, off & N/A\\ 231 tagcache\_ram & on, off & N/A\\
235 }%
236 232
237 \opt{touchpad}{ 233 \opt{touchpad}{
238 \opt{GIGABEAT_PAD}{ 234 \opt{GIGABEAT_PAD}{
@@ -244,7 +240,6 @@
244 } 240 }
245 }% 241 }%
246 242
247 \opt{lcd_bitmap}{
248 peak meter release 243 peak meter release
249 & 1 to 126 & ?\\ 244 & 1 to 126 & ?\\
250 peak meter hold 245 peak meter hold
@@ -284,12 +279,8 @@
284 show icons & on, off & N/A\\ 279 show icons & on, off & N/A\\
285 iconset & /path/filename.bmp & N/A\\ 280 iconset & /path/filename.bmp & N/A\\
286 viewers iconset & /path/filename.bmp & N/A\\ 281 viewers iconset & /path/filename.bmp & N/A\\
287 }%
288 282
289 \opt{swcodec}{% This doesn't depend on swcodec but using a \nopt here
290 % causes ondiosp not to build for mysterious reasons.
291 backdrop & /path/filename.bmp & N/A\\ 283 backdrop & /path/filename.bmp & N/A\\
292 }%
293 284
294 \opt{lcd_color}{ 285 \opt{lcd_color}{
295 foreground colour & 000000 to FFFFFF & RRGGBB\\ 286 foreground colour & 000000 to FFFFFF & RRGGBB\\
diff --git a/manual/appendix/file_formats.tex b/manual/appendix/file_formats.tex
index bfba184ade..4d64cf6bc6 100644
--- a/manual/appendix/file_formats.tex
+++ b/manual/appendix/file_formats.tex
@@ -6,18 +6,14 @@
6 & \textbf{Action when selected}}{}{} 6 & \textbf{Action when selected}}{}{}
7\includegraphics[width=0.37cm]{appendix/images/icon-directory.png} 7\includegraphics[width=0.37cm]{appendix/images/icon-directory.png}
8 & Directory & \emph{none} & Enter the directory \tabularnewline 8 & Directory & \emph{none} & Enter the directory \tabularnewline
9\opt{swcodec}{
10 \includegraphics[width=0.37cm]{appendix/images/icon-audio-file.png} 9 \includegraphics[width=0.37cm]{appendix/images/icon-audio-file.png}
11 & Audio file & \emph{various}\newline% 10 & Audio file & \emph{various}\newline%
12 (see \ref{ref:Supportedaudioformats})% 11 (see \ref{ref:Supportedaudioformats})%
13 % do NOT use \reference{} here as that will break the table. 12 % do NOT use \reference{} here as that will break the table.
14 & Start playing the file and show the WPS\tabularnewline 13 & Start playing the file and show the WPS\tabularnewline
15}
16 & Bookmark & \fname{.bmark} & Display all bookmarks for an audio file\tabularnewline 14 & Bookmark & \fname{.bmark} & Display all bookmarks for an audio file\tabularnewline
17\opt{lcd_bitmap}{
18 & Game of Life & \fname{.cells} & Show the configuration with the 15 & Game of Life & \fname{.cells} & Show the configuration with the
19 ``Rocklife'' plugin\tabularnewline 16 ``Rocklife'' plugin\tabularnewline
20}
21\includegraphics[width=0.37cm]{appendix/images/icon-config.png} 17\includegraphics[width=0.37cm]{appendix/images/icon-config.png}
22 & Configuration File & \fname{.cfg} & Load the settings file\tabularnewline 18 & Configuration File & \fname{.cfg} & Load the settings file\tabularnewline
23\includegraphics[width=0.37cm]{appendix/images/icon-chip8.png} 19\includegraphics[width=0.37cm]{appendix/images/icon-chip8.png}
@@ -62,10 +58,8 @@
62 \includegraphics[width=0.37cm]{appendix/images/icon-rolo.png} 58 \includegraphics[width=0.37cm]{appendix/images/icon-rolo.png}
63 & Rockbox firmware & \fname{.mi4} & Load the new firmware with ROLO \tabularnewline 59 & Rockbox firmware & \fname{.mi4} & Load the new firmware with ROLO \tabularnewline
64} 60}
65\opt{swcodec}{
66 \includegraphics[width=0.37cm]{appendix/images/icon-movie-file.png} 61 \includegraphics[width=0.37cm]{appendix/images/icon-movie-file.png}
67 & Video & \fname{.mpg}, \fname{.mpeg}, \fname{.mpv}, \fname{.m2v} & Play the MPEG1/2 video \tabularnewline 62 & Video & \fname{.mpg}, \fname{.mpeg}, \fname{.mpv}, \fname{.m2v} & Play the MPEG1/2 video \tabularnewline
68}
69\includegraphics[width=0.37cm]{appendix/images/icon-rock.png} 63\includegraphics[width=0.37cm]{appendix/images/icon-rock.png}
70 & Plugin & \fname{.rock} & Start the plugin\tabularnewline 64 & Plugin & \fname{.rock} & Start the plugin\tabularnewline
71\opt{sansaAMS}{ 65\opt{sansaAMS}{
@@ -79,7 +73,6 @@
79 & While Playing Screen & \fname{.wps} & Load the new WPS display configuration\tabularnewline 73 & While Playing Screen & \fname{.wps} & Load the new WPS display configuration\tabularnewline
80\end{rbtabular} 74\end{rbtabular}
81 75
82\opt{swcodec}{
83 \chapter{Audio and metadata formats} 76 \chapter{Audio and metadata formats}
84 \section{\label{ref:Supportedaudioformats}Supported audio formats} 77 \section{\label{ref:Supportedaudioformats}Supported audio formats}
85 \subsection{Lossy Codecs} 78 \subsection{Lossy Codecs}
@@ -375,4 +368,3 @@
375 to 90 bytes. 368 to 90 bytes.
376 } 369 }
377 \end{enumerate} 370 \end{enumerate}
378}
diff --git a/manual/appendix/wps_tags.tex b/manual/appendix/wps_tags.tex
index 1a0661c008..70fef71015 100644
--- a/manual/appendix/wps_tags.tex
+++ b/manual/appendix/wps_tags.tex
@@ -159,11 +159,10 @@ or \config{\%D(2)}), produce the information for the next file to be played.
159\section{Playlist/Song Info} 159\section{Playlist/Song Info}
160 \begin{tagmap} 160 \begin{tagmap}
161 \config{\%pb} & Progress Bar. 161 \config{\%pb} & Progress Bar.
162 \opt{lcd_bitmap}{ 162 This will replace the entire line with a progress bar.
163 This will replace the entire line with a progress bar. 163 You can set the position, width and height of the progressbar
164 You can set the position, width and height of the progressbar 164 (in pixels) and load a custom image for it:
165 (in pixels) and load a custom image for it: 165 \config{\%pb(x,y,[width],[height],image.bmp)} \\
166 \config{\%pb(x,y,[width],[height],image.bmp)}} \\
167 \config{\%px} & Percentage played in song\\ 166 \config{\%px} & Percentage played in song\\
168 \config{\%pc} & Current time in song\\ 167 \config{\%pc} & Current time in song\\
169 \config{\%pe} & Total number of playlist entries\\ 168 \config{\%pe} & Total number of playlist entries\\
@@ -181,8 +180,8 @@ or \config{\%D(2)}), produce the information for the next file to be played.
181 \config{\%pv} & Current volume (in dB). Can also be used in a conditional: 180 \config{\%pv} & Current volume (in dB). Can also be used in a conditional:
182 \config{\%?pv<Mute|\ldots|0 dB|Above 0 dB>}\newline 181 \config{\%?pv<Mute|\ldots|0 dB|Above 0 dB>}\newline
183 Mute is 0\% volume, \ldots is the values between Mute and max, 0 dB is max volume, and Above 0 dB is amplified volume 182 Mute is 0\% volume, \ldots is the values between Mute and max, 0 dB is max volume, and Above 0 dB is amplified volume
184 \opt{lcd_bitmap}{This can also be used like \%pb to provide a continuous scale: 183 This can also be used like \%pb to provide a continuous scale:
185 \config{\%pv(x,y,[width],[height],image.bmp)}} \\ 184 \config{\%pv(x,y,[width],[height],image.bmp)} \\
186 \config{\%pS} & Track is starting. An optional number gives how many seconds 185 \config{\%pS} & Track is starting. An optional number gives how many seconds
187 the tag remains true for after the start of the track. The default is 186 the tag remains true for after the start of the track. The default is
188 10 seconds if no number is specified. 187 10 seconds if no number is specified.
@@ -227,20 +226,16 @@ or \config{\%D(2)}), produce the information for the next file to be played.
227 \config{\%ra} & Autoscore for the song\\ 226 \config{\%ra} & Autoscore for the song\\
228 \end{tagmap} 227 \end{tagmap}
229 228
230\opt{swcodec}{
231\section{Sound (DSP) settings} 229\section{Sound (DSP) settings}
232 \begin{tagmap} 230 \begin{tagmap}
233 \config{\%Sp} & Current playback pitch \\ 231 \config{\%Sp} & Current playback pitch \\
234 \opt{swcodec}{
235 \config{\%xf} & Crossfade setting, in the order: Off, Auto Skip, Man Skip, 232 \config{\%xf} & Crossfade setting, in the order: Off, Auto Skip, Man Skip,
236 Shuffle, Shuffle and Man Skip, Always\\ 233 Shuffle, Shuffle and Man Skip, Always\\
237 \config{\%rg} & ReplayGain value in use (x.y~dB). If used as a conditional, 234 \config{\%rg} & ReplayGain value in use (x.y~dB). If used as a conditional,
238 Replaygain type in use: \config{\%?rg<Off|Track% 235 Replaygain type in use: \config{\%?rg<Off|Track%
239 |Album|TrackShuffle|AlbumShuffle% 236 |Album|TrackShuffle|AlbumShuffle%
240 |No tag>}\\ 237 |No tag>}\\
241 }
242 \end{tagmap} 238 \end{tagmap}
243}
244 239
245\section{Hold} 240\section{Hold}
246 \begin{tagmap} 241 \begin{tagmap}
@@ -360,13 +355,11 @@ Examples:
360\end{enumerate} 355\end{enumerate}
361 356
362 357
363\opt{lcd_bitmap}{
364\section{\label{ref:wps_images}Images} 358\section{\label{ref:wps_images}Images}
365 \begin{tagmap} 359 \begin{tagmap}
366 \config{\%X(filename.bmp)} 360 \config{\%X(filename.bmp)}
367 & Load and set a backdrop image for the WPS. 361 & Load and set a backdrop image for the WPS.
368 This image must be exactly the same size as your LCD.\\ 362 This image must be exactly the same size as your LCD.\\
369 }%
370 \config{\%x(n,filename[,x,y])} 363 \config{\%x(n,filename[,x,y])}
371 & Load and display an image\newline 364 & Load and display an image\newline
372 \config{n}: image ID for later referencing in \config{\%xd}\newline 365 \config{n}: image ID for later referencing in \config{\%xd}\newline