summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNils Wallménius <nils@rockbox.org>2009-02-04 14:22:35 +0000
committerNils Wallménius <nils@rockbox.org>2009-02-04 14:22:35 +0000
commit01bd736e000856ded49023ccdd4ed62b96f300ff (patch)
treeaaabadc803a69be6b6578f87f6a4136f03a6e245
parent3f879eb6aeaed5dfec24f2b0cc022518be7f7739 (diff)
downloadrockbox-01bd736e000856ded49023ccdd4ed62b96f300ff.tar.gz
rockbox-01bd736e000856ded49023ccdd4ed62b96f300ff.zip
Fixes and tweaks for the 'Advanced topics' chapter of the manual, closes FS#9806
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@19919 a1c6a512-1295-4272-9138-f99709370657
-rw-r--r--manual/advanced_topics/main.tex89
1 files changed, 46 insertions, 43 deletions
diff --git a/manual/advanced_topics/main.tex b/manual/advanced_topics/main.tex
index a567e82926..4cea04eb46 100644
--- a/manual/advanced_topics/main.tex
+++ b/manual/advanced_topics/main.tex
@@ -15,9 +15,9 @@ in the font package at \url{http://www.rockbox.org/daily.shtml}.}
15 be loaded automatically every time you start up, it must be located in the 15 be loaded automatically every time you start up, it must be located in the
16 \fname{/.rockbox/fonts} directory and the filename must be at most 24 characters 16 \fname{/.rockbox/fonts} directory and the filename must be at most 24 characters
17 long. You can browse the fonts in \fname{/.rockbox/fonts} under 17 long. You can browse the fonts in \fname{/.rockbox/fonts} under
18 \setting{Settings $\rightarrow$ General Settings $\rightarrow$ Display 18 \setting{Settings $\rightarrow$ Theme Settings $\rightarrow$ Browse Fonts}
19 $\rightarrow$ Browse Fonts} in the \setting{Main Menu}. 19 in the \setting{Main Menu}.
20 \warn{Advanced Users Only: Any BDF font file up to 16 pixels high should 20 \note{Advanced Users Only: Any BDF font file up to 16 pixels high should
21 be usable with Rockbox. To convert from \fname{.bdf} to \fname{.fnt}, use 21 be usable with Rockbox. To convert from \fname{.bdf} to \fname{.fnt}, use
22 the \fname{convbdf} tool. This tool can be found in the \fname{tools} 22 the \fname{convbdf} tool. This tool can be found in the \fname{tools}
23 directory of the Rockbox source code.} 23 directory of the Rockbox source code.}
@@ -28,7 +28,7 @@ in the font package at \url{http://www.rockbox.org/daily.shtml}.}
28Rockbox can load language files at runtime. Simply copy the \fname{.lng} file 28Rockbox can load language files at runtime. Simply copy the \fname{.lng} file
29\emph{(do not use the .lang file)} to the \dap\ and ``play'' it in the 29\emph{(do not use the .lang file)} to the \dap\ and ``play'' it in the
30Rockbox directory browser or select \setting{Settings $\rightarrow$ 30Rockbox directory browser or select \setting{Settings $\rightarrow$
31General Settings $\rightarrow$ Languages }from the \setting{Main Menu}. 31General Settings $\rightarrow$ Language }from the \setting{Main Menu}.
32 32
33\note{If you want a language to be loaded automatically every time you start 33\note{If you want a language to be loaded automatically every time you start
34up, it must be located in the \fname{/.rockbox/langs} directory and the filename 34up, it must be located in the \fname{/.rockbox/langs} directory and the filename
@@ -41,15 +41,15 @@ file find the instructions on the Rockbox website:
41\opt{lcd_color}{ 41\opt{lcd_color}{
42 \subsection{Changing Colours} 42 \subsection{Changing Colours}
43 The colours used in the Rockbox interface can be changed to any combination 43 The colours used in the Rockbox interface can be changed to any combination
44 of background and foreground colour you like. To do this go to the 44 you like. To do this, go to
45 \setting{Settings $\rightarrow$ General Settings $\rightarrow$ Display} 45 \setting{Settings $\rightarrow$ Theme Settings $\rightarrow$ Colours}.
46 and select \setting{Background Colour} or \setting{Foreground Colour}.
47 The colours set here are used in all menus, browsers and in the 46 The colours set here are used in all menus, browsers and in the
48 \setting{While Playing Screen}. 47 \setting{While Playing Screen}.
49 \subsection{Changing Filetype Colours} 48 \subsection{Changing Filetype Colours}
50 Rockbox has the capability to modify the File Browser to show different 49 Rockbox has the capability to modify the \setting{File Browser}
51 filetypes in different colours depending upon the file extension. 50 to show different filetypes in different colours depending upon
52 See the \wikilink{CustomFiletypeColours} Wiki page for details. 51 the file extension. See the \wikilink{CustomFiletypeColours} Wiki
52 page for details.
53} 53}
54 54
55\opt{lcd_non-mono}{% 55\opt{lcd_non-mono}{%
@@ -70,19 +70,18 @@ file find the instructions on the Rockbox website:
70\subsection{WPS -- General Info} 70\subsection{WPS -- General Info}
71 71
72\begin{description} 72\begin{description}
73\item[Description: ] The WPS or While Playing Screen is the name used to 73\item[Description: ] The WPS or \setting{While Playing Screen} is the name used
74 describe the information displayed on the \daps\ screen whilst an audio track 74 to describe the information displayed on the \daps{} screen whilst an audio
75 is being played. The default WPS is a relatively simple screen displaying 75 track is being played. The default WPS is a relatively simple screen
76 Track name, Artist, Album etc. in the default font as a purely text based 76 displaying Track name, Artist, Album etc. in the default font as a purely
77 layout. There are a number of WPS files included in Rockbox, and you can 77 text based layout. There are a number of WPS files included in Rockbox, and
78 load one of these at anytime by selecting it in 78 you can load one of these at any time by selecting it in
79 \setting{General Settings $\rightarrow$ Display $\rightarrow$ Browse .wps files}. 79 \setting{Settings $\rightarrow$ Theme Settings $\rightarrow$ Browse .wps files}.
80 \opt{HAVE_REMOTE_LCD}{There is a related option to browse \fname{.rwps} 80 \opt{HAVE_REMOTE_LCD}{There is a related option to browse \fname{.rwps}
81 files for \daps{} with LCD remote controls installed. This will load a 81 files for \daps{} with LCD remote controls installed. This will load a
82 similar WPS screen for the remote but with usually a simpler and more 82 similar WPS screen for the remote.}
83 concise layout.}
84 83
85\note{``Playing'' a \fname{.wps} from the file browser has the same effect.} 84\note{``Playing'' a \fname{.wps} from the \setting{File Browser} has the same effect.}
86 85
87\item [File Location: ]Custom WPS files may be located anywhere on the drive. 86\item [File Location: ]Custom WPS files may be located anywhere on the drive.
88 The only restriction is that they must end in \fname{.wps}. When you ``play'' 87 The only restriction is that they must end in \fname{.wps}. When you ``play''
@@ -116,7 +115,7 @@ all the tags that are available.
116 the last number giving the colour depth in bits) when 115 the last number giving the colour depth in bits) when
117 designing your own WPS, or if you use a WPS designed for another target. 116 designing your own WPS, or if you use a WPS designed for another target.
118 \opt{HAVE_REMOTE_LCD}{The resolution of the remote is 117 \opt{HAVE_REMOTE_LCD}{The resolution of the remote is
119 \opt{h100,h300}{128x64x1}\opt{x5}{128x96x2} pixels.}} 118 \opt{h100,h300}{128x64x1}\opt{x5,m5}{128x96x2} pixels.}}
120 119
121\subsubsection{Conditional Tags} 120\subsubsection{Conditional Tags}
122 121
@@ -284,7 +283,7 @@ A configuration file may reside anywhere on the disk. Multiple
284configuration files are permitted. So, for example, you could have 283configuration files are permitted. So, for example, you could have
285a \fname{car.cfg} file for the settings that you use while playing your 284a \fname{car.cfg} file for the settings that you use while playing your
286jukebox in your car, and a \fname{headphones.cfg} file to store the 285jukebox in your car, and a \fname{headphones.cfg} file to store the
287settings that you use while listening to your \dap\ through headphones. 286settings that you use while listening to your \dap{} through headphones.
288 287
289See \reference{ref:cfg_specs} below for an explanation of the format 288See \reference{ref:cfg_specs} below for an explanation of the format
290for configuration files. See \reference{ref:manage_settings_menu} for an 289for configuration files. See \reference{ref:manage_settings_menu} for an
@@ -333,64 +332,68 @@ Example of a configuration file:
333 each file a different name (such as \fname{car.cfg}, 332 each file a different name (such as \fname{car.cfg},
334 \fname{headphones.cfg}, etc.), and you can then use the \setting{Browse .cfg 333 \fname{headphones.cfg}, etc.), and you can then use the \setting{Browse .cfg
335 files} option to quickly change settings.} 334 files} option to quickly change settings.}
336 335
337 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 level). 336 A special case configuration file can be used to force a particular setting
338Format a new configuration file as above with the required setting(s) and save it into the \fname{/.rockbox} directory with the filename \fname{fixed.cfg}. 337 or settings every time Rockbox starts up (e.g. to set the volume to a safe
338 level). Format a new configuration file as above with the required setting(s)
339 and save it into the \fname{/.rockbox} directory with the filename
340 \fname{fixed.cfg}.
339 341
340\subsection{\label{ref:manage_settings_menu}The \setting{Manage Settings} 342\subsection{\label{ref:manage_settings_menu}The \setting{Manage Settings}
341 menu} The \setting{Manage Settings} menu can be found in the \setting{Main 343 menu} The \setting{Manage Settings} menu can be found in the \setting{Main
342 Menu}. The \setting{Manage Settings} menu allows you to save and load 344 Menu}. The \setting{Manage Settings} menu allows you to save and load
343\fname{.cfg} files. \opt{MASCODEC}{The \setting{Manage Settings} menu also 345 \fname{.cfg} files.
344 allows you to load or save different firmware versions.} 346 \opt{MASCODEC}{The \setting{Manage Settings} menu also
347 allows you to load or save different firmware versions.}
345 348
346\begin{description} 349\begin{description}
347 350
348\item [Browse .cfg Files]Opens the file browser in the \fname{/.rockbox} 351\item [Browse .cfg Files]Opens the \setting{File Browser} in the
349 directory and displays all \fname{.cfg} (configuration) files. Selecting a 352 \fname{/.rockbox} directory and displays all \fname{.cfg} (configuration)
350 \fname{.cfg} file will cause Rockbox to load the settings contained in that 353 files. Selecting a \fname{.cfg} file will cause Rockbox to load the settings
351 file. Pressing \ButtonLeft\ will exit back to the \setting{Manage Settings} 354 contained in that file. Pressing \ButtonLeft{} will exit back to the
352 menu. See the \setting{Write .cfg files} option on the 355 \setting{Manage Settings} menu. See the \setting{Write .cfg files} option on
353 \setting{Manage Settings} menu for details of how to save and edit a 356 the \setting{Manage Settings} menu for details of how to save and edit a
354 configuration file. 357 configuration file.
355 358
356\item [Reset Settings]This wipes the saved settings 359\item [Reset Settings]This wipes the saved settings
357 in the \dap\ and resets all settings to their default values. 360 in the \dap{} and resets all settings to their default values.
358 361
359 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD,SANSA_E200_PAD,SANSA_C200_PAD}{ 362 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD,SANSA_E200_PAD,SANSA_C200_PAD}{
360 \note{You can also reset all settings to their default 363 \note{You can also reset all settings to their default
361 values by turning off the \dap, turning it back on, and holding the 364 values by turning off the \dap, turning it back on, and holding the
362 \ButtonRec\ button immediately after the \dap\ turns on.} 365 \ButtonRec{} button immediately after the \dap{} turns on.}
363 } 366 }
364 \opt{IRIVER_H10_PAD}{\note{You can also reset all settings to 367 \opt{IRIVER_H10_PAD}{\note{You can also reset all settings to
365 their default values by turning off the \dap, and turning it back on 368 their default values by turning off the \dap, and turning it back on
366 with the \ButtonHold\ button on.} 369 with the \ButtonHold{} button on.}
367 } 370 }
368 \opt{IPOD_4G_PAD}{\note{You can also reset all settings to their default 371 \opt{IPOD_4G_PAD}{\note{You can also reset all settings to their default
369 values by turning off the \dap, turning it back on, and activating the 372 values by turning off the \dap, turning it back on, and activating the
370 \ButtonHold\ button immediately after the backlight comes on.} 373 \ButtonHold{} button immediately after the backlight comes on.}
371 } 374 }
372 \opt{GIGABEAT_PAD}{\note{You can also reset all settings to their default 375 \opt{GIGABEAT_PAD}{\note{You can also reset all settings to their default
373 values by turning off the \dap, turning it back on and pressing the 376 values by turning off the \dap, turning it back on and pressing the
374 \ButtonA\ button immediately after the \dap\ turns on.} 377 \ButtonA{} button immediately after the \dap{} turns on.}
375 } 378 }
376 379
377\item [Save .cfg File]This option writes a \fname{.cfg} file to 380\item [Save .cfg File]This option writes a \fname{.cfg} file to
378 your \daps{} disk. The configuration file has the \fname{.cfg} 381 your \daps{} disk. The configuration file has the \fname{.cfg}
379 extension and is used to store all of the user settings that are described 382 extension and is used to store all of the user settings that are described
380 throughout this manual. 383 throughout this manual.
381 384
382 Hint: Use the \setting{Save .cfg File} feature (\setting{Main Menu 385 Hint: Use the \setting{Save .cfg File} feature (\setting{Main Menu
383 $\rightarrow$ General Settings}) to save the current settings, then 386 $\rightarrow$ Manage Settings}) to save the current settings, then
384 use a text editor to customize the settings file. See Appendix 387 use a text editor to customize the settings file. See Appendix
385 \reference{ref:config_file_options} for the full reference of available 388 \reference{ref:config_file_options} for the full reference of available
386 options. 389 options.
387 390
388\item [Save Sound Settings]This option writes a \fname{.cfg} file to 391\item [Save Sound Settings]This option writes a \fname{.cfg} file to
389 your \daps\ disk. The configuration file has the \fname{.cfg} 392 your \daps{} disk. The configuration file has the \fname{.cfg}
390 extension and is used to store all of the sound related settings. 393 extension and is used to store all of the sound related settings.
391 394
392\item [Save Theme Settings]This option writes a \fname{.cfg} file to 395\item [Save Theme Settings]This option writes a \fname{.cfg} file to
393 your \daps\ disk. The configuration file has the \fname{.cfg} 396 your \daps{} disk. The configuration file has the \fname{.cfg}
394 extension and is used to store all of the theme related settings. 397 extension and is used to store all of the theme related settings.
395 398
396\end{description} 399\end{description}