Nils Wallménius | cb527ca | 2006-09-10 10:17:47 +0000 | [diff] [blame] | 1 | % $Id$ % |
Martin Arver | 8e8207f | 2006-02-11 00:57:17 +0000 | [diff] [blame] | 2 | \chapter{Advanced Topics} |
Martin Arver | 35dcf90 | 2006-03-08 17:58:11 +0000 | [diff] [blame] | 3 | |
Marc Guay | 85eec85 | 2008-06-24 05:16:23 +0000 | [diff] [blame] | 4 | \section{\label{ref:CustomisingUI}Customising the User Interface} |
Nils Wallménius | 12eb058 | 2008-03-23 22:07:09 +0000 | [diff] [blame] | 5 | \opt{lcd_bitmap}{ |
Marianne Arnold | af78b5f | 2008-07-06 16:10:28 +0000 | [diff] [blame] | 6 | \subsection{\label{ref:GettingExtras}Getting Extras} |
| 7 | |
Martin Arver | 7bdd03a | 2006-08-27 15:00:50 +0000 | [diff] [blame] | 8 | Rockbox supports custom fonts. A collection of fonts is available for download |
Marianne Arnold | af78b5f | 2008-07-06 16:10:28 +0000 | [diff] [blame] | 9 | in the font package at \url{http://www.rockbox.org/daily.shtml}.} |
Martin Arver | 8e8207f | 2006-02-11 00:57:17 +0000 | [diff] [blame] | 10 | |
Nils Wallménius | 12eb058 | 2008-03-23 22:07:09 +0000 | [diff] [blame] | 11 | \opt{lcd_bitmap}{ |
Dominik Riebeling | 85deab1 | 2006-11-20 19:56:55 +0000 | [diff] [blame] | 12 | \subsection{\label{ref:Loadingfonts}Loading Fonts}\index{Fonts} |
Nils Wallménius | cb527ca | 2006-09-10 10:17:47 +0000 | [diff] [blame] | 13 | Rockbox can load fonts dynamically. Simply copy the \fname{.fnt} file to the |
| 14 | \dap{} and ``play'' it in the \setting{File Browser}. If you want a font to |
| 15 | be loaded automatically every time you start up, it must be located in the |
Marianne Arnold | b2f7c61 | 2007-12-14 02:03:58 +0000 | [diff] [blame] | 16 | \fname{/.rockbox/fonts} directory and the filename must be at most 24 characters |
Nils Wallménius | cb527ca | 2006-09-10 10:17:47 +0000 | [diff] [blame] | 17 | long. You can browse the fonts in \fname{/.rockbox/fonts} under |
Jonas Häggqvist | 4b83175 | 2009-06-22 17:37:36 +0000 | [diff] [blame] | 18 | \setting{Settings $\rightarrow$ Theme Settings $\rightarrow$ Font} |
Alex Parker | 5174341 | 2009-08-25 21:51:55 +0000 | [diff] [blame] | 19 | in the \setting{Main Menu}.\\ |
| 20 | |
Nils Wallménius | 01bd736 | 2009-02-04 14:22:35 +0000 | [diff] [blame] | 21 | \note{Advanced Users Only: Any BDF font file up to 16 pixels high should |
Nils Wallménius | cb527ca | 2006-09-10 10:17:47 +0000 | [diff] [blame] | 22 | be usable with Rockbox. To convert from \fname{.bdf} to \fname{.fnt}, use |
| 23 | the \fname{convbdf} tool. This tool can be found in the \fname{tools} |
Martin Arver | 68e4017 | 2006-06-07 16:37:04 +0000 | [diff] [blame] | 24 | directory of the Rockbox source code.} |
Dominik Riebeling | ebb8a22 | 2006-04-04 17:48:10 +0000 | [diff] [blame] | 25 | } |
Martin Arver | 8e8207f | 2006-02-11 00:57:17 +0000 | [diff] [blame] | 26 | |
| 27 | \subsection{\label{ref:Loadinglanguages}Loading Languages} |
Dominik Riebeling | 85deab1 | 2006-11-20 19:56:55 +0000 | [diff] [blame] | 28 | \index{Language files}% |
Martin Arver | 47ea906 | 2006-06-07 12:15:46 +0000 | [diff] [blame] | 29 | Rockbox can load language files at runtime. Simply copy the \fname{.lng} file |
Dominik Riebeling | b7eef89 | 2006-04-10 21:47:09 +0000 | [diff] [blame] | 30 | \emph{(do not use the .lang file)} to the \dap\ and ``play'' it in the |
Nils Wallménius | 15c5d26 | 2007-03-15 02:09:15 +0000 | [diff] [blame] | 31 | Rockbox directory browser or select \setting{Settings $\rightarrow$ |
Alex Parker | 5174341 | 2009-08-25 21:51:55 +0000 | [diff] [blame] | 32 | General Settings $\rightarrow$ Language }from the \setting{Main Menu}.\\ |
Martin Arver | 8e8207f | 2006-02-11 00:57:17 +0000 | [diff] [blame] | 33 | |
Dominik Riebeling | b7eef89 | 2006-04-10 21:47:09 +0000 | [diff] [blame] | 34 | \note{If you want a language to be loaded automatically every time you start |
Marianne Arnold | b2f7c61 | 2007-12-14 02:03:58 +0000 | [diff] [blame] | 35 | up, it must be located in the \fname{/.rockbox/langs} directory and the filename |
Alex Parker | 5174341 | 2009-08-25 21:51:55 +0000 | [diff] [blame] | 36 | must be a maximum of 24 characters long.\\} |
Martin Arver | 8e8207f | 2006-02-11 00:57:17 +0000 | [diff] [blame] | 37 | |
Dominik Riebeling | ebb8a22 | 2006-04-04 17:48:10 +0000 | [diff] [blame] | 38 | If your language is not yet supported and you want to write your own language |
| 39 | file find the instructions on the Rockbox website: |
Dominik Riebeling | b394e18 | 2006-12-29 19:22:56 +0000 | [diff] [blame] | 40 | \wikilink{LangFiles} |
Martin Arver | 8e8207f | 2006-02-11 00:57:17 +0000 | [diff] [blame] | 41 | |
Nils Wallménius | 12eb058 | 2008-03-23 22:07:09 +0000 | [diff] [blame] | 42 | \opt{lcd_color}{ |
Alexander Levin | 71812ca | 2009-03-20 19:33:20 +0000 | [diff] [blame] | 43 | \subsection{\label{ref:ChangingFiletypeColours}Changing Filetype Colours} |
Alex Parker | 6c4661c | 2009-03-18 14:24:28 +0000 | [diff] [blame] | 44 | Rockbox has the capability to modify the \setting{File Browser} to show |
Alexander Levin | 71812ca | 2009-03-20 19:33:20 +0000 | [diff] [blame] | 45 | files of different types in different colours, depending on the file extension. |
Alex Parker | 6c4661c | 2009-03-18 14:24:28 +0000 | [diff] [blame] | 46 | |
Alexander Levin | 71812ca | 2009-03-20 19:33:20 +0000 | [diff] [blame] | 47 | \subsubsection{Set-up} |
Alexander Levin | 277ce9a | 2009-03-21 09:25:49 +0000 | [diff] [blame] | 48 | There are two steps to changing the filetype colours -- creating |
Alexander Levin | 71812ca | 2009-03-20 19:33:20 +0000 | [diff] [blame] | 49 | a file with the extension \fname{.colours} and then activating it using |
| 50 | a config file. The \fname{.colours} files \emph{must} be stored in |
| 51 | the \fname{/.rockbox/themes/} directory. |
| 52 | The \fname{.colours} file is just a text file, and can be edited with |
| 53 | your text editor of choice. |
Alex Parker | 6c4661c | 2009-03-18 14:24:28 +0000 | [diff] [blame] | 54 | |
Alexander Levin | 71812ca | 2009-03-20 19:33:20 +0000 | [diff] [blame] | 55 | \subsubsection{Creating the .colours file} |
| 56 | The \fname{.colours} file consists of the file extension |
| 57 | (or \fname{folder}) followed by a colon and then the colour desired |
| 58 | as an RGB value in hexadecimal, as in the following example:\\* |
| 59 | \\ |
| 60 | \config{folder:808080}\\ |
| 61 | \config{mp3:00FF00}\\ |
| 62 | \config{ogg:00FF00}\\ |
| 63 | \config{txt:FF0000}\\ |
| 64 | \config{???:FFFFFF}\\* |
Alex Parker | 6c4661c | 2009-03-18 14:24:28 +0000 | [diff] [blame] | 65 | |
Alexander Levin | 71812ca | 2009-03-20 19:33:20 +0000 | [diff] [blame] | 66 | The permissible extensions are as follows:\\* |
| 67 | \\ |
| 68 | \config{folder, m3u, m3u8, cfg, wps, lng, rock, bmark, cue, colours, mpa, |
| 69 | \firmwareextension{}, % |
| 70 | \opt{swcodec}{mp1, }mp2, mp3% |
| 71 | \opt{swcodec}{, ogg, oga, wma, wmv, asf, wav, flac, ac3, a52, mpc, |
| 72 | wv, m4a, m4b, mp4, mod, shn, aif, aiff, spx, sid, adx, nsf, nsfe, |
| 73 | spc, ape, mac, sap}% |
| 74 | \opt{lcd_bitmap}{\opt{swcodec}{, mpg, mpeg}}% |
| 75 | \opt{HAVE_REMOTE_LCD}{, rwps}% |
| 76 | \opt{lcd_non-mono}{, bmp}% |
| 77 | \opt{radio}{, fmr}% |
| 78 | \opt{lcd_bitmap}{, fnt, kbd}}\\* |
| 79 | %It'd be ideal to get these from filetypes.c |
Alex Parker | 6c4661c | 2009-03-18 14:24:28 +0000 | [diff] [blame] | 80 | |
Alexander Levin | 71812ca | 2009-03-20 19:33:20 +0000 | [diff] [blame] | 81 | All file extensions that are not either specifically listed in the |
| 82 | \fname{.colours} files or are not in the list above will be |
| 83 | set to the colour given by \config{???}. Extensions that |
| 84 | are in the above list but not in the \fname{.colours} |
| 85 | file will be set to the foreground colour as normal. |
Alex Parker | 6c4661c | 2009-03-18 14:24:28 +0000 | [diff] [blame] | 86 | |
Alexander Levin | 71812ca | 2009-03-20 19:33:20 +0000 | [diff] [blame] | 87 | \subsubsection{Activating} |
| 88 | To activate the filetype colours, the \fname{.colours} file needs to be |
| 89 | invoked from a \fname{.cfg} configuration file. The easiest way to do |
| 90 | this is to create a new text file containing the following single |
| 91 | line:\\* |
| 92 | \\ |
| 93 | \config{filetype colours: /.rockbox/themes/filename.colours}\\* |
Alex Parker | 6c4661c | 2009-03-18 14:24:28 +0000 | [diff] [blame] | 94 | |
Alexander Levin | 71812ca | 2009-03-20 19:33:20 +0000 | [diff] [blame] | 95 | where filename is replaced by the filename you used when creating the |
| 96 | \fname{.colours} file. Save this file as e.g. \fname{colours.cfg} in the |
| 97 | \fname{/.rockbox/themes} directory and then activate the config file |
| 98 | from the menu as normal |
| 99 | (\setting{Settings} $\rightarrow$ \setting{Theme Settings}% |
Jonas Häggqvist | 4b83175 | 2009-06-22 17:37:36 +0000 | [diff] [blame] | 100 | $\rightarrow$ \setting{Browse Theme Files}). |
Alex Parker | 6c4661c | 2009-03-18 14:24:28 +0000 | [diff] [blame] | 101 | |
Alexander Levin | 71812ca | 2009-03-20 19:33:20 +0000 | [diff] [blame] | 102 | \subsubsection{Editing} |
| 103 | The built-in \setting{Text Editor} (see \reference{sec:text_editor}) |
| 104 | automatically understands the |
| 105 | \fname{.colours} file format, but an external text editor can |
| 106 | also be used. To edit the \fname{.colours} file using Rockbox, |
| 107 | ``play'' it in the \setting{File Browser}. The file will open in |
| 108 | the \setting{Text Editor}. Upon selecting a line, the following choices |
| 109 | will appear:\\* |
| 110 | \\ |
| 111 | \config{Extension}\\ |
| 112 | \config{Colour}\\* |
| 113 | |
| 114 | If \config{Extension} is selected, the \setting{virtual keyboard} |
| 115 | (see \reference{sec:virtual_keyboard}) appears, |
| 116 | allowing the file extension to be modified. If \config{Colour} |
| 117 | is selected, the colour selector screen appears. Choose the desired |
| 118 | colour, then save the \fname{.colours} file using the standard |
| 119 | \setting{Text Editor} controls. |
Nils Wallménius | 15c5d26 | 2007-03-15 02:09:15 +0000 | [diff] [blame] | 120 | } |
| 121 | |
Marianne Arnold | 8189246 | 2008-07-15 20:57:05 +0000 | [diff] [blame] | 122 | \opt{lcd_non-mono}{% |
Nils Wallménius | da55588 | 2006-11-13 15:14:28 +0000 | [diff] [blame] | 123 | \subsection{\label{ref:LoadingBackdrops}Loading Backdrops} |
| 124 | Rockbox supports showing an image as a backdrop in the \setting{File Browser} |
| 125 | and the menus. The backdrop image must be a \fname{.bmp} file of the exact |
| 126 | same dimensions as the display in your \dap{} (\genericimg{} with the last |
| 127 | number giving the colour depth in bits). To use an image as a backdrop browse |
Marianne Arnold | 90bcefa | 2008-03-03 23:01:44 +0000 | [diff] [blame] | 128 | to it in the \setting{File Browser} and open the \setting{Context Menu} |
| 129 | (see \reference{ref:Contextmenu}) on it and select the option |
Nils Wallménius | da55588 | 2006-11-13 15:14:28 +0000 | [diff] [blame] | 130 | \setting{Set As Backdrop}. If you want rockbox to remember your |
| 131 | backdrop the next time you start your \dap{} the backdrop must be placed in |
Marianne Arnold | b2f7c61 | 2007-12-14 02:03:58 +0000 | [diff] [blame] | 132 | the \fname{/.rockbox/backdrops} directory. |
Nils Wallménius | da55588 | 2006-11-13 15:14:28 +0000 | [diff] [blame] | 133 | }% |
| 134 | |
Alex Parker | ab563da | 2009-09-20 16:48:45 +0000 | [diff] [blame] | 135 | \nopt{lcd_charcell}{ |
| 136 | \subsection{UI Viewport} |
| 137 | By default, the UI is drawn on the whole screen. This can be changed so that |
| 138 | the UI is confined to a specific area of the screen, by use of a UI |
| 139 | viewport. This is done by adding the following line to the |
| 140 | \fname{.cfg} file for a theme:\\* |
| 141 | |
| 142 | \nopt{lcd_non-mono}{\config{ui viewport: X,Y,[width],[height],[font]}} |
| 143 | \nopt{lcd_color}{\opt{lcd_non-mono}{ |
| 144 | \config{ui viewport: X,Y,[width],[height],[font],[fgshade],[bgshade]}}} |
| 145 | \opt{lcd_color}{ |
| 146 | \config{ui viewport: X,Y,[width],[height],[font],[fgcolour],[bgcolour]}} |
| 147 | \\* |
| 148 | |
| 149 | \opt{HAVE_REMOTE_LCD}{ |
| 150 | The dimensions of the menu that is displayed on the remote control of your |
| 151 | \dap\ can be set in the same way. The line to be added to the theme |
| 152 | \fname{.cfg} is the following:\\* |
| 153 | |
| 154 | \nopt{lcd_non-mono}{\config{remote ui viewport: X,Y,[width],[height],[font]}} |
| 155 | \nopt{lcd_color}{\opt{lcd_non-mono}{ |
| 156 | \config{remote ui viewport: X,Y,[width],[height],[font],[fgshade],[bgshade]}}} |
| 157 | \opt{lcd_color}{ |
| 158 | \config{remote ui viewport: X,Y,[width],[height],[font],[fgcolour],[bgcolour]}} |
| 159 | \\* |
| 160 | } |
| 161 | |
| 162 | Only the first two parameters \emph{have} to be specified, the others can |
Alexander Levin | b57fe48 | 2009-12-23 20:05:29 +0000 | [diff] [blame] | 163 | be omitted using `-' as a placeholder. The syntax is very similar to WPS |
Alex Parker | ab563da | 2009-09-20 16:48:45 +0000 | [diff] [blame] | 164 | viewports (see \reference{ref:Viewports}). Briefly: |
| 165 | |
| 166 | \nopt{lcd_non-mono}{\input{advanced_topics/viewports/mono-uivp-syntax.tex}} |
| 167 | \nopt{lcd_color}{\opt{lcd_non-mono}{\input{advanced_topics/viewports/grayscale-uivp-syntax.tex}}} |
| 168 | \opt{lcd_color}{\input{advanced_topics/viewports/colour-uivp-syntax.tex}} |
| 169 | } |
| 170 | |
Martin Arver | 8e8207f | 2006-02-11 00:57:17 +0000 | [diff] [blame] | 171 | \section{\label{ref:ConfiguringtheWPS}Configuring the WPS} |
| 172 | |
Dominik Riebeling | b7eef89 | 2006-04-10 21:47:09 +0000 | [diff] [blame] | 173 | \subsection{WPS -- General Info} |
Martin Arver | 8e8207f | 2006-02-11 00:57:17 +0000 | [diff] [blame] | 174 | |
Dominik Riebeling | b7eef89 | 2006-04-10 21:47:09 +0000 | [diff] [blame] | 175 | \begin{description} |
Nils Wallménius | 01bd736 | 2009-02-04 14:22:35 +0000 | [diff] [blame] | 176 | \item[Description: ] The WPS or \setting{While Playing Screen} is the name used |
| 177 | to describe the information displayed on the \daps{} screen whilst an audio |
| 178 | track is being played. The default WPS is a relatively simple screen |
| 179 | displaying Track name, Artist, Album etc. in the default font as a purely |
| 180 | text based layout. There are a number of WPS files included in Rockbox, and |
| 181 | you can load one of these at any time by selecting it in |
Jonas Häggqvist | 4b83175 | 2009-06-22 17:37:36 +0000 | [diff] [blame] | 182 | \setting{Settings $\rightarrow$ Theme Settings $\rightarrow$ While Playing Screen}. |
Martin Arver | 6fc30d6 | 2006-08-28 17:44:49 +0000 | [diff] [blame] | 183 | \opt{HAVE_REMOTE_LCD}{There is a related option to browse \fname{.rwps} |
| 184 | files for \daps{} with LCD remote controls installed. This will load a |
Nils Wallménius | 01bd736 | 2009-02-04 14:22:35 +0000 | [diff] [blame] | 185 | similar WPS screen for the remote.} |
Martin Arver | 8e8207f | 2006-02-11 00:57:17 +0000 | [diff] [blame] | 186 | |
Nils Wallménius | 01bd736 | 2009-02-04 14:22:35 +0000 | [diff] [blame] | 187 | \note{``Playing'' a \fname{.wps} from the \setting{File Browser} has the same effect.} |
Dominik Riebeling | b7eef89 | 2006-04-10 21:47:09 +0000 | [diff] [blame] | 188 | |
| 189 | \item [File Location: ]Custom WPS files may be located anywhere on the drive. |
Martin Arver | 09c3961 | 2006-08-18 16:57:56 +0000 | [diff] [blame] | 190 | The only restriction is that they must end in \fname{.wps}. When you ``play'' |
| 191 | a \fname{.wps} file, it will be used for future WPS screens, and if the |
Marianne Arnold | b2f7c61 | 2007-12-14 02:03:58 +0000 | [diff] [blame] | 192 | ``played'' \fname{.wps} file is located in the \fname{/.rockbox/wps} directory, it |
Alexander Levin | 885553f | 2009-03-22 11:59:32 +0000 | [diff] [blame] | 193 | will be remembered and used after reboot. The name of the \fname{.wps} file must be |
Martin Arver | 09c3961 | 2006-08-18 16:57:56 +0000 | [diff] [blame] | 194 | no more than 24 characters long for it to be remembered. |
Dominik Riebeling | b7eef89 | 2006-04-10 21:47:09 +0000 | [diff] [blame] | 195 | \end{description} |
Martin Arver | a245e88 | 2006-03-08 15:04:36 +0000 | [diff] [blame] | 196 | |
Dominik Riebeling | b7eef89 | 2006-04-10 21:47:09 +0000 | [diff] [blame] | 197 | \subsection{\label{ref:CreateYourOwnWPS}WPS -- Build Your Own} |
Dominik Riebeling | ebb8a22 | 2006-04-04 17:48:10 +0000 | [diff] [blame] | 198 | Quite simply, enter the WPS code in your favourite text editor, Notepad on |
Martin Arver | 47ea906 | 2006-06-07 12:15:46 +0000 | [diff] [blame] | 199 | Windows works fine. When you save it, instead of saving it as a \fname{.txt} |
| 200 | file, save it as a \fname{.wps} file. Example: Instead of \fname{Rockbox.txt}, |
| 201 | save the file as \fname{Rockbox.wps}. To make sure non english characters |
| 202 | display correctly in your WPS you must save the .wps file with UTF-8 character |
| 203 | encoding. This can be done in most editors, for example Notepad in Windows 2000 |
Martin Arver | 09c3961 | 2006-08-18 16:57:56 +0000 | [diff] [blame] | 204 | or XP (but not in 9x/ME) can do this. See appendix \reference{ref:wps_tags} for |
| 205 | all the tags that are available. |
Martin Arver | 8e8207f | 2006-02-11 00:57:17 +0000 | [diff] [blame] | 206 | |
Dominik Riebeling | f949c8e | 2006-06-07 17:09:06 +0000 | [diff] [blame] | 207 | \begin{itemize} |
Martin Arver | 09c3961 | 2006-08-18 16:57:56 +0000 | [diff] [blame] | 208 | \item All characters not preceded by \% are displayed as typed. |
| 209 | \item Lines beginning with \# are comments and will be ignored. |
Dominik Riebeling | f949c8e | 2006-06-07 17:09:06 +0000 | [diff] [blame] | 210 | \end{itemize} |
Dominik Riebeling | b7eef89 | 2006-04-10 21:47:09 +0000 | [diff] [blame] | 211 | |
Dominik Riebeling | 5ec3805 | 2006-08-28 18:09:17 +0000 | [diff] [blame] | 212 | \note{Keep in mind that your \dap{} resolution is \genericimg{} (with |
| 213 | the last number giving the colour depth in bits) when |
| 214 | designing your own WPS, or if you use a WPS designed for another target. |
| 215 | \opt{HAVE_REMOTE_LCD}{The resolution of the remote is |
Nils Wallménius | 01bd736 | 2009-02-04 14:22:35 +0000 | [diff] [blame] | 216 | \opt{h100,h300}{128x64x1}\opt{x5,m5}{128x96x2} pixels.}} |
Martin Arver | 6fc30d6 | 2006-08-28 17:44:49 +0000 | [diff] [blame] | 217 | |
Alex Parker | ab563da | 2009-09-20 16:48:45 +0000 | [diff] [blame] | 218 | \nopt{lcd_charcell}{ |
| 219 | \subsubsection{\label{ref:Viewports}Viewports} |
| 220 | |
| 221 | By default, a viewport filling the whole screen contains all the elements |
| 222 | defined in the \fname(.wps) file. The |
| 223 | \opt{lcd_non-mono}{elements in this viewport are displayed |
| 224 | with the same background/foreground |
| 225 | \opt{lcd_color}{colours}\nopt{lcd_color}{shades} and the} |
| 226 | text is rendered in the |
| 227 | same font as in the main menu. To change this behaviour a custom viewport can |
| 228 | be defined. A viewport is a rectangular window on the screen% |
| 229 | \opt{lcd_non-mono}{ with its own foreground/background |
| 230 | \opt{lcd_color}{colours}\nopt{lcd_color}{shades}}. |
| 231 | This window also has variable dimensions. To |
| 232 | define a viewport a line starting \config{{\%V{\textbar}\dots}} has to be |
| 233 | present in the \fname{.wps} file. The full syntax will be explained later in |
| 234 | this section. All elements placed before the |
| 235 | line defining a viewport are displayed in the default viewport. Elements |
| 236 | defined after a viewport declaration are drawn within that viewport. |
| 237 | \opt{lcd_bitmap}{Loading images (see Appendix \reference{ref:wps_images}) |
| 238 | should be done within the default viewport.} |
| 239 | A viewport ends either with the end of the file, or with the next viewport |
| 240 | declaration line. Viewports sharing the same |
| 241 | coordinates and dimensions cannot be displayed at the same time. Viewports |
| 242 | cannot be layered \emph{transparently} over one another. Subsequent viewports |
| 243 | will be drawn over any other viewports already drawn onto that |
| 244 | area of the screen. |
| 245 | |
| 246 | \nopt{lcd_non-mono}{\input{advanced_topics/viewports/mono-vp-syntax.tex}} |
| 247 | \nopt{lcd_color}{\opt{lcd_non-mono}{\input{advanced_topics/viewports/grayscale-vp-syntax.tex}}} |
| 248 | \opt{lcd_color}{\input{advanced_topics/viewports/colour-vp-syntax.tex}} |
| 249 | |
| 250 | |
| 251 | \subsubsection{Conditional Viewports} |
| 252 | |
| 253 | Any viewport can be displayed either permanently or conditionally. |
| 254 | Defining a viewport as \config{{\%V{\textbar}\dots}} |
| 255 | will display it permanently. |
| 256 | |
| 257 | \begin{itemize} |
| 258 | \item {\config{\%Vl{\textbar}'identifier'{\textbar}\dots{\textbar}}} |
| 259 | This tag preloads a viewport for later display. 'identifier' is a single |
| 260 | lowercase letter (a-z) and the '\dots' parameters use the same logic as |
| 261 | the \config{\%V} tag explained above. |
| 262 | \item {\config{\%Vd'identifier'}} Display the 'identifier' viewport. |
| 263 | \end{itemize} |
| 264 | |
| 265 | Viewports can share identifiers so that you can display multiple viewports |
| 266 | with one \%Vd line. |
| 267 | |
| 268 | \nopt{lcd_non-mono}{\input{advanced_topics/viewports/mono-conditional.tex}} |
| 269 | \nopt{lcd_color}{% |
| 270 | \opt{lcd_non-mono}{\input{advanced_topics/viewports/grayscale-conditional.tex}}} |
| 271 | \opt{lcd_color}{\input{advanced_topics/viewports/colour-conditional.tex}} |
| 272 | \\* |
| 273 | |
| 274 | \note{The tag to display conditional viewports must come before the tag to |
| 275 | preload the viewport in the \fname{.wps} file.} |
| 276 | } |
| 277 | |
Martin Arver | a245e88 | 2006-03-08 15:04:36 +0000 | [diff] [blame] | 278 | \subsubsection{Conditional Tags} |
Martin Arver | d3d3e34 | 2006-03-15 10:56:14 +0000 | [diff] [blame] | 279 | |
Martin Arver | 47ea906 | 2006-06-07 12:15:46 +0000 | [diff] [blame] | 280 | \begin{description} |
| 281 | \item[If/else: ] |
Dominik Riebeling | f949c8e | 2006-06-07 17:09:06 +0000 | [diff] [blame] | 282 | Syntax: \config{\%?xx{\textless}true{\textbar}false{\textgreater}} |
Martin Arver | 8e8207f | 2006-02-11 00:57:17 +0000 | [diff] [blame] | 283 | |
Martin Arver | 68e4017 | 2006-06-07 16:37:04 +0000 | [diff] [blame] | 284 | If the tag specified by ``\config{xx}'' has a value, the text between the |
| 285 | ``\config{{\textless}}'' and the ``\config{{\textbar}}'' is displayed (the true |
| 286 | part), else the text between the ``\config{{\textbar}}'' and the |
| 287 | ``\config{{\textgreater}}'' is displayed (the false part). |
| 288 | The else part is optional, so the ``\config{{\textbar}}'' does not have to be |
| 289 | specified if no else part is desired. The conditionals nest, so the text in the |
| 290 | if and else part can contain all \config{\%} commands, including conditionals. |
Martin Arver | d3d3e34 | 2006-03-15 10:56:14 +0000 | [diff] [blame] | 291 | |
Martin Arver | 47ea906 | 2006-06-07 12:15:46 +0000 | [diff] [blame] | 292 | \item[Enumerations: ] |
Dominik Riebeling | f949c8e | 2006-06-07 17:09:06 +0000 | [diff] [blame] | 293 | Syntax: \config{\%?xx{\textless}alt1{\textbar}alt2{\textbar}alt3{\textbar}\dots{\textbar}else{\textgreater}} |
Martin Arver | 8e8207f | 2006-02-11 00:57:17 +0000 | [diff] [blame] | 294 | |
Martin Arver | 68e4017 | 2006-06-07 16:37:04 +0000 | [diff] [blame] | 295 | For tags with multiple values, like Play status, the conditional can hold a |
| 296 | list of alternatives, one for each value the tag can have. |
Martin Arver | 68e4017 | 2006-06-07 16:37:04 +0000 | [diff] [blame] | 297 | Example enumeration: |
| 298 | \begin{example} |
Martin Arver | 0642451 | 2006-10-25 22:12:25 +0000 | [diff] [blame] | 299 | \%?mp{\textless}Stop{\textbar}\%Play{\textbar}Pause{\textbar}Ffwd{\textbar}Rew{\textgreater} |
Martin Arver | 68e4017 | 2006-06-07 16:37:04 +0000 | [diff] [blame] | 300 | \end{example} |
Martin Arver | 8e8207f | 2006-02-11 00:57:17 +0000 | [diff] [blame] | 301 | |
Martin Arver | 68e4017 | 2006-06-07 16:37:04 +0000 | [diff] [blame] | 302 | The last else part is optional, and will be displayed if the tag has no value. |
| 303 | The WPS parser will always display the last part if the tag has no value, or if |
| 304 | the list of alternatives is too short. |
Martin Arver | 47ea906 | 2006-06-07 12:15:46 +0000 | [diff] [blame] | 305 | \end{description} |
Martin Arver | 8e8207f | 2006-02-11 00:57:17 +0000 | [diff] [blame] | 306 | |
Marc Guay | 85eec85 | 2008-06-24 05:16:23 +0000 | [diff] [blame] | 307 | \subsubsection{Next Song Info} |
Dominik Riebeling | b7eef89 | 2006-04-10 21:47:09 +0000 | [diff] [blame] | 308 | You can display information about the next song -- the song that is |
Martin Arver | 8e8207f | 2006-02-11 00:57:17 +0000 | [diff] [blame] | 309 | about to play after the one currently playing (unless you change the |
Martin Arver | a245e88 | 2006-03-08 15:04:36 +0000 | [diff] [blame] | 310 | plan). |
Martin Arver | 8e8207f | 2006-02-11 00:57:17 +0000 | [diff] [blame] | 311 | |
Dominik Riebeling | f949c8e | 2006-06-07 17:09:06 +0000 | [diff] [blame] | 312 | If you use the upper-case versions of the |
Martin Arver | 68e4017 | 2006-06-07 16:37:04 +0000 | [diff] [blame] | 313 | three tags: \config{F}, \config{I} and \config{D}, they will instead refer to |
| 314 | the next song instead of the current one. Example: \config{\%Ig} is the genre |
Alex Parker | 5174341 | 2009-08-25 21:51:55 +0000 | [diff] [blame] | 315 | name used in the next song and \config{\%Ff} is the mp3 frequency.\\ |
Martin Arver | 8e8207f | 2006-02-11 00:57:17 +0000 | [diff] [blame] | 316 | |
Dominik Riebeling | f949c8e | 2006-06-07 17:09:06 +0000 | [diff] [blame] | 317 | \note{The next song information \emph{will not} be available at all |
Martin Arver | 09c3961 | 2006-08-18 16:57:56 +0000 | [diff] [blame] | 318 | times, but will most likely be available at the end of a song. We |
| 319 | suggest you use the conditional display tag a lot when displaying |
| 320 | information about the next song!} |
Martin Arver | a245e88 | 2006-03-08 15:04:36 +0000 | [diff] [blame] | 321 | |
Alex Parker | e56030a | 2009-05-15 21:17:21 +0000 | [diff] [blame] | 322 | \subsubsection{\label{ref:AlternatingSublines}Alternating Sublines} |
Martin Arver | 8e8207f | 2006-02-11 00:57:17 +0000 | [diff] [blame] | 323 | |
Martin Arver | 68e4017 | 2006-06-07 16:37:04 +0000 | [diff] [blame] | 324 | It is possible to group items on each line into 2 or more groups or |
| 325 | ``sublines''. Each subline will be displayed in succession on the line for a |
| 326 | specified time, alternating continuously through each defined subline. |
Martin Arver | 8e8207f | 2006-02-11 00:57:17 +0000 | [diff] [blame] | 327 | |
| 328 | Items on a line are broken into sublines with the semicolon |
Martin Arver | 68e4017 | 2006-06-07 16:37:04 +0000 | [diff] [blame] | 329 | '\config{;}' character. The display time for |
Martin Arver | 8e8207f | 2006-02-11 00:57:17 +0000 | [diff] [blame] | 330 | each subline defaults to 2 seconds unless modified by using the |
Martin Arver | 68e4017 | 2006-06-07 16:37:04 +0000 | [diff] [blame] | 331 | '\config{\%t}' tag to specify an alternate |
Martin Arver | 8e8207f | 2006-02-11 00:57:17 +0000 | [diff] [blame] | 332 | time (in seconds and optional tenths of a second) for the subline to be |
| 333 | displayed. |
| 334 | |
| 335 | Subline related special characters and tags: |
Dominik Riebeling | f949c8e | 2006-06-07 17:09:06 +0000 | [diff] [blame] | 336 | \begin{description} |
| 337 | \item[;] Split items on a line into separate sublines |
| 338 | \item[\%t] Set the subline display time. The |
Martin Arver | 68e4017 | 2006-06-07 16:37:04 +0000 | [diff] [blame] | 339 | '\config{\%t}' is followed by either integer |
| 340 | seconds (\config{\%t5}), or seconds and tenths of a second (\config{\%t3.5}). |
Dominik Riebeling | f949c8e | 2006-06-07 17:09:06 +0000 | [diff] [blame] | 341 | \end{description} |
Martin Arver | 8e8207f | 2006-02-11 00:57:17 +0000 | [diff] [blame] | 342 | |
| 343 | Each alternating subline can still be optionally scrolled while it is |
| 344 | being displayed, and scrollable formats can be displayed on the same |
| 345 | line with non{}-scrollable formats (such as track elapsed time) as long |
Martin Arver | a245e88 | 2006-03-08 15:04:36 +0000 | [diff] [blame] | 346 | as they are separated into different sublines. |
Martin Arver | a245e88 | 2006-03-08 15:04:36 +0000 | [diff] [blame] | 347 | Example subline definition: |
Martin Arver | 47ea906 | 2006-06-07 12:15:46 +0000 | [diff] [blame] | 348 | \begin{example} |
Martin Arver | 49cdd5e | 2006-06-07 13:29:52 +0000 | [diff] [blame] | 349 | %s%t4%ia;%s%it;%t3%pc %pr : Display id3 artist for 4 seconds, |
| 350 | Display id3 title for 2 seconds, |
| 351 | Display current and remaining track time |
| 352 | for 3 seconds, |
| 353 | repeat... |
Martin Arver | 47ea906 | 2006-06-07 12:15:46 +0000 | [diff] [blame] | 354 | \end{example} |
Martin Arver | 8e8207f | 2006-02-11 00:57:17 +0000 | [diff] [blame] | 355 | |
Martin Arver | 68e4017 | 2006-06-07 16:37:04 +0000 | [diff] [blame] | 356 | Conditionals can be used with sublines to display a different set and/or number |
| 357 | of sublines on the line depending on the evaluation of the conditional. |
Martin Arver | a245e88 | 2006-03-08 15:04:36 +0000 | [diff] [blame] | 358 | Example subline with conditionals: |
Martin Arver | 47ea906 | 2006-06-07 12:15:46 +0000 | [diff] [blame] | 359 | \begin{example} |
Martin Arver | 49cdd5e | 2006-06-07 13:29:52 +0000 | [diff] [blame] | 360 | %?it{\textless}%t8%s%it{\textbar}%s%fn{\textgreater};%?ia{\textless}%t3%s%ia{\textbar}%t0{\textgreater}\\ |
Martin Arver | 47ea906 | 2006-06-07 12:15:46 +0000 | [diff] [blame] | 361 | \end{example} |
Martin Arver | 8e8207f | 2006-02-11 00:57:17 +0000 | [diff] [blame] | 362 | |
Martin Arver | 68e4017 | 2006-06-07 16:37:04 +0000 | [diff] [blame] | 363 | The format above will do two different things depending if ID3 tags are |
| 364 | present. If the ID3 artist and title are present: |
Dominik Riebeling | f949c8e | 2006-06-07 17:09:06 +0000 | [diff] [blame] | 365 | \begin{itemize} |
| 366 | \item Display id3 title for 8 seconds, |
| 367 | \item Display id3 artist for 3 seconds, |
| 368 | \item repeat\dots |
| 369 | \end{itemize} |
| 370 | If the ID3 artist and title are not present: |
| 371 | \begin{itemize} |
| 372 | \item Display the filename continuously. |
| 373 | \end{itemize} |
Dominik Riebeling | ebb8a22 | 2006-04-04 17:48:10 +0000 | [diff] [blame] | 374 | Note that by using a subline display time of 0 in one branch of a conditional, |
| 375 | a subline can be skipped (not displayed) when that condition is met. |
Martin Arver | a245e88 | 2006-03-08 15:04:36 +0000 | [diff] [blame] | 376 | |
Martin Arver | a245e88 | 2006-03-08 15:04:36 +0000 | [diff] [blame] | 377 | \subsubsection{Using Images} |
Dominik Riebeling | b7eef89 | 2006-04-10 21:47:09 +0000 | [diff] [blame] | 378 | You can have as many as 52 images in your WPS. There are various ways of |
Dominik Riebeling | ebb8a22 | 2006-04-04 17:48:10 +0000 | [diff] [blame] | 379 | displaying images: |
Martin Arver | a245e88 | 2006-03-08 15:04:36 +0000 | [diff] [blame] | 380 | \begin{enumerate} |
Martin Arver | 68e4017 | 2006-06-07 16:37:04 +0000 | [diff] [blame] | 381 | \item Load and always show the image, using the \config{\%x} tag |
| 382 | \item Preload the image with \config{\%xl} and show it with \config{\%xd}. |
| 383 | This way you can have your images displayed conditionally. |
Nils Wallménius | da55588 | 2006-11-13 15:14:28 +0000 | [diff] [blame] | 384 | \nopt{archos}{% |
Martin Arver | 09c3961 | 2006-08-18 16:57:56 +0000 | [diff] [blame] | 385 | \item Load an image and show as backdrop using the \config{\%X} tag. The |
| 386 | image must be of the same exact dimensions as your display. |
Nils Wallménius | da55588 | 2006-11-13 15:14:28 +0000 | [diff] [blame] | 387 | }% |
Martin Arver | a245e88 | 2006-03-08 15:04:36 +0000 | [diff] [blame] | 388 | \end{enumerate} |
Martin Arver | 959d23e | 2006-06-04 15:03:39 +0000 | [diff] [blame] | 389 | |
Nils Wallménius | 12eb058 | 2008-03-23 22:07:09 +0000 | [diff] [blame] | 390 | \optv{swcodec}{% This doesn't depend on swcodec but we don't have a \noptv |
Nils Wallménius | da55588 | 2006-11-13 15:14:28 +0000 | [diff] [blame] | 391 | % command. |
Martin Arver | 47ea906 | 2006-06-07 12:15:46 +0000 | [diff] [blame] | 392 | Example on background image use: |
| 393 | \begin{example} |
Dominik Riebeling | f949c8e | 2006-06-07 17:09:06 +0000 | [diff] [blame] | 394 | %X|background.bmp| |
Martin Arver | 47ea906 | 2006-06-07 12:15:46 +0000 | [diff] [blame] | 395 | \end{example} |
| 396 | The image with filename \fname{background.bmp} is loaded and used in the WPS. |
Nils Wallménius | da55588 | 2006-11-13 15:14:28 +0000 | [diff] [blame] | 397 | }% |
Martin Arver | 47ea906 | 2006-06-07 12:15:46 +0000 | [diff] [blame] | 398 | |
| 399 | Example on bitmap preloading and use: |
| 400 | \begin{example} |
Dominik Riebeling | f949c8e | 2006-06-07 17:09:06 +0000 | [diff] [blame] | 401 | %x|a|static_icon.bmp|50|50| |
| 402 | %xl|b|rep\_off.bmp|16|64| |
| 403 | %xl|c|rep\_all.bmp|16|64| |
| 404 | %xl|d|rep\_one.bmp|16|64| |
| 405 | %xl|e|rep\_shuffle.bmp|16|64| |
| 406 | %?mm<%xdb|%xdc|%xdd|%xde> |
Martin Arver | 47ea906 | 2006-06-07 12:15:46 +0000 | [diff] [blame] | 407 | \end{example} |
| 408 | Four images at the same x and y position are preloaded in the example. Which |
Martin Arver | 68e4017 | 2006-06-07 16:37:04 +0000 | [diff] [blame] | 409 | image to display is determined by the \config{\%mm} tag (the repeat mode). |
Martin Arver | a245e88 | 2006-03-08 15:04:36 +0000 | [diff] [blame] | 410 | |
| 411 | \subsubsection{Example File} |
Martin Arver | 47ea906 | 2006-06-07 12:15:46 +0000 | [diff] [blame] | 412 | \begin{example} |
Dominik Riebeling | f949c8e | 2006-06-07 17:09:06 +0000 | [diff] [blame] | 413 | %s%?in<%in - >%?it<%it|%fn> %?ia<[%ia%?id<, %id>]> |
| 414 | %pb%pc/%pt |
Martin Arver | 47ea906 | 2006-06-07 12:15:46 +0000 | [diff] [blame] | 415 | \end{example} |
Dominik Riebeling | ebb8a22 | 2006-04-04 17:48:10 +0000 | [diff] [blame] | 416 | That is, ``tracknum -- title [artist, album]'', where most fields are only |
| 417 | displayed if available. Could also be rendered as ``filename'' or ``tracknum -- |
| 418 | title [artist]''. |
Martin Arver | a245e88 | 2006-03-08 15:04:36 +0000 | [diff] [blame] | 419 | |
Nils Wallménius | 12eb058 | 2008-03-23 22:07:09 +0000 | [diff] [blame] | 420 | %\opt{lcd_bitmap}{ |
Martin Arver | a245e88 | 2006-03-08 15:04:36 +0000 | [diff] [blame] | 421 | % \begin{verbatim} |
Martin Arver | 47ea906 | 2006-06-07 12:15:46 +0000 | [diff] [blame] | 422 | % %s%?it<%?in<%in. |>%it|%fn> |
| 423 | % %s%?ia<%ia|%?d2<%d2|(root)>> |
| 424 | % %s%?id<%id|%?d1<%d1|(root)>> %?iy<(%iy)|> |
| 425 | % |
| 426 | % %al%pc/%pt%ar[%pp:%pe] |
| 427 | % %fbkBit %?fv<avg|> %?iv<(id3v%iv)|(no id3)> |
| 428 | % %pb |
| 429 | % %pm |
| 430 | % % \end{verbatim} |
| 431 | %} |
Martin Arver | 8e8207f | 2006-02-11 00:57:17 +0000 | [diff] [blame] | 432 | |
Marc Guay | 85eec85 | 2008-06-24 05:16:23 +0000 | [diff] [blame] | 433 | \section{\label{ref:manage_settings}Managing Rockbox Settings} |
Martin Arver | 8e8207f | 2006-02-11 00:57:17 +0000 | [diff] [blame] | 434 | |
Alexander Levin | 15c850c | 2010-01-22 22:54:05 +0000 | [diff] [blame] | 435 | \subsection{Introduction to \fname{.cfg} Files} |
Marianne Arnold | b24f5ce | 2008-01-17 19:45:22 +0000 | [diff] [blame] | 436 | Rockbox allows users to store and load multiple settings through the use of |
| 437 | configuration files. A configuration file is simply a text file with the |
| 438 | extension \fname{.cfg}. |
Martin Arver | 8e8207f | 2006-02-11 00:57:17 +0000 | [diff] [blame] | 439 | |
Marianne Arnold | a352c62 | 2007-05-19 19:03:39 +0000 | [diff] [blame] | 440 | A configuration file may reside anywhere on the disk. Multiple |
Martin Arver | 09c3961 | 2006-08-18 16:57:56 +0000 | [diff] [blame] | 441 | configuration files are permitted. So, for example, you could have |
| 442 | a \fname{car.cfg} file for the settings that you use while playing your |
| 443 | jukebox in your car, and a \fname{headphones.cfg} file to store the |
Nils Wallménius | 01bd736 | 2009-02-04 14:22:35 +0000 | [diff] [blame] | 444 | settings that you use while listening to your \dap{} through headphones. |
Martin Arver | 8e8207f | 2006-02-11 00:57:17 +0000 | [diff] [blame] | 445 | |
Martin Arver | 09c3961 | 2006-08-18 16:57:56 +0000 | [diff] [blame] | 446 | See \reference{ref:cfg_specs} below for an explanation of the format |
Marianne Arnold | b24f5ce | 2008-01-17 19:45:22 +0000 | [diff] [blame] | 447 | for configuration files. See \reference{ref:manage_settings_menu} for an |
Martin Arver | 09c3961 | 2006-08-18 16:57:56 +0000 | [diff] [blame] | 448 | explanation of how to create, edit and load configuration files. |
Martin Arver | 8e8207f | 2006-02-11 00:57:17 +0000 | [diff] [blame] | 449 | |
Alexander Levin | 15c850c | 2010-01-22 22:54:05 +0000 | [diff] [blame] | 450 | \subsection{\label{ref:cfg_specs}Specifications for \fname{.cfg} Files} |
Michael DiFebbo | 0623841 | 2006-08-12 15:56:33 +0000 | [diff] [blame] | 451 | |
Martin Arver | 09c3961 | 2006-08-18 16:57:56 +0000 | [diff] [blame] | 452 | The Rockbox configuration file is a plain text file, so once you use the |
Nils Wallménius | b659c0c | 2008-03-22 15:26:45 +0000 | [diff] [blame] | 453 | \setting{Save .cfg file} option to create the file, you can edit the file on |
Marianne Arnold | b24f5ce | 2008-01-17 19:45:22 +0000 | [diff] [blame] | 454 | your computer using any text editor program. See |
Martin Arver | 09c3961 | 2006-08-18 16:57:56 +0000 | [diff] [blame] | 455 | Appendix \reference{ref:config_file_options} for available settings. Configuration |
Marianne Arnold | b24f5ce | 2008-01-17 19:45:22 +0000 | [diff] [blame] | 456 | files use the following formatting rules: % |
Martin Arver | 09c3961 | 2006-08-18 16:57:56 +0000 | [diff] [blame] | 457 | |
| 458 | \begin{enumerate} |
| 459 | \item Each setting must be on a separate line. |
| 460 | \item Each line has the format ``setting: value''. |
| 461 | \item Values must be within the ranges specified in this manual for each |
| 462 | setting. |
| 463 | \item Lines starting with \# are ignored. This lets you write comments into |
| 464 | your configuration files. |
| 465 | \end{enumerate} |
| 466 | |
| 467 | Example of a configuration file: |
| 468 | \begin{example} |
Alexander Levin | 005caba | 2009-03-22 12:14:03 +0000 | [diff] [blame] | 469 | volume: 70 |
| 470 | bass: 11 |
| 471 | treble: 12 |
| 472 | balance: 0 |
| 473 | time format: 12hour |
| 474 | volume display: numeric |
| 475 | show files: supported |
| 476 | wps: /.rockbox/car.wps |
| 477 | lang: /.rockbox/afrikaans.lng |
Martin Arver | 09c3961 | 2006-08-18 16:57:56 +0000 | [diff] [blame] | 478 | \end{example} |
| 479 | |
| 480 | \note{As you can see from the example, configuration files do not need to |
| 481 | contain all of the Rockbox options. You can create configuration files |
| 482 | that change only certain settings. So, for example, supppose you |
Martin Arver | 56b339e | 2006-08-27 20:44:23 +0000 | [diff] [blame] | 483 | typically use the \dap{} at one volume in the car, and another when using |
Martin Arver | 09c3961 | 2006-08-18 16:57:56 +0000 | [diff] [blame] | 484 | headphones. Further, suppose you like to use an inverse LCD when you are |
| 485 | in the car, and a regular LCD setting when you are using headphones. You |
| 486 | could create configuration files that control only the volume and LCD |
| 487 | settings. Create a few different files with different settings, give |
| 488 | each file a different name (such as \fname{car.cfg}, |
| 489 | \fname{headphones.cfg}, etc.), and you can then use the \setting{Browse .cfg |
Alex Parker | 5174341 | 2009-08-25 21:51:55 +0000 | [diff] [blame] | 490 | files} option to quickly change settings.\\} |
Nils Wallménius | 01bd736 | 2009-02-04 14:22:35 +0000 | [diff] [blame] | 491 | |
| 492 | A special case configuration file can be used to force a particular setting |
| 493 | or settings every time Rockbox starts up (e.g. to set the volume to a safe |
| 494 | level). Format a new configuration file as above with the required setting(s) |
| 495 | and save it into the \fname{/.rockbox} directory with the filename |
| 496 | \fname{fixed.cfg}. |
Martin Arver | 09c3961 | 2006-08-18 16:57:56 +0000 | [diff] [blame] | 497 | |
| 498 | \subsection{\label{ref:manage_settings_menu}The \setting{Manage Settings} |
| 499 | menu} The \setting{Manage Settings} menu can be found in the \setting{Main |
Martin Arver | 56b339e | 2006-08-27 20:44:23 +0000 | [diff] [blame] | 500 | Menu}. The \setting{Manage Settings} menu allows you to save and load |
Nils Wallménius | 01bd736 | 2009-02-04 14:22:35 +0000 | [diff] [blame] | 501 | \fname{.cfg} files. |
Martin Arver | 09c3961 | 2006-08-18 16:57:56 +0000 | [diff] [blame] | 502 | |
| 503 | \begin{description} |
Michael DiFebbo | 0623841 | 2006-08-12 15:56:33 +0000 | [diff] [blame] | 504 | |
Nils Wallménius | 01bd736 | 2009-02-04 14:22:35 +0000 | [diff] [blame] | 505 | \item [Browse .cfg Files]Opens the \setting{File Browser} in the |
| 506 | \fname{/.rockbox} directory and displays all \fname{.cfg} (configuration) |
| 507 | files. Selecting a \fname{.cfg} file will cause Rockbox to load the settings |
Tomer Shalev | 13c7866 | 2009-12-14 20:18:38 +0000 | [diff] [blame] | 508 | contained in that file. Pressing \nopt{COWON_D2_PAD}{\ButtonLeft} |
Tomer Shalev | c7fee00 | 2009-12-17 17:38:58 +0000 | [diff] [blame] | 509 | \opt{COWON_D2_PAD}{\ButtonPower{} or \TouchTopLeft} will exit back to the |
Nils Wallménius | 01bd736 | 2009-02-04 14:22:35 +0000 | [diff] [blame] | 510 | \setting{Manage Settings} menu. See the \setting{Write .cfg files} option on |
| 511 | the \setting{Manage Settings} menu for details of how to save and edit a |
Martin Arver | 56b339e | 2006-08-27 20:44:23 +0000 | [diff] [blame] | 512 | configuration file. |
Martin Arver | 09c3961 | 2006-08-18 16:57:56 +0000 | [diff] [blame] | 513 | |
Marc Guay | 162a8f2 | 2008-06-28 16:10:02 +0000 | [diff] [blame] | 514 | \item [Reset Settings]This wipes the saved settings |
Nils Wallménius | 01bd736 | 2009-02-04 14:22:35 +0000 | [diff] [blame] | 515 | in the \dap{} and resets all settings to their default values. |
Martin Arver | 09c3961 | 2006-08-18 16:57:56 +0000 | [diff] [blame] | 516 | |
Marianne Arnold | 56b3f92 | 2008-01-20 16:33:12 +0000 | [diff] [blame] | 517 | \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD,SANSA_E200_PAD,SANSA_C200_PAD}{ |
| 518 | \note{You can also reset all settings to their default |
Marc Guay | 162a8f2 | 2008-06-28 16:10:02 +0000 | [diff] [blame] | 519 | values by turning off the \dap, turning it back on, and holding the |
Nils Wallménius | 01bd736 | 2009-02-04 14:22:35 +0000 | [diff] [blame] | 520 | \ButtonRec{} button immediately after the \dap{} turns on.} |
Martin Arver | 09c3961 | 2006-08-18 16:57:56 +0000 | [diff] [blame] | 521 | } |
Marc Guay | 162a8f2 | 2008-06-28 16:10:02 +0000 | [diff] [blame] | 522 | \opt{IRIVER_H10_PAD}{\note{You can also reset all settings to |
Marianne Arnold | 56b3f92 | 2008-01-20 16:33:12 +0000 | [diff] [blame] | 523 | their default values by turning off the \dap, and turning it back on |
Nils Wallménius | 01bd736 | 2009-02-04 14:22:35 +0000 | [diff] [blame] | 524 | with the \ButtonHold{} button on.} |
Marcoen Hirschberg | 1e51477 | 2007-04-27 19:38:16 +0000 | [diff] [blame] | 525 | } |
Marc Guay | 162a8f2 | 2008-06-28 16:10:02 +0000 | [diff] [blame] | 526 | \opt{IPOD_4G_PAD}{\note{You can also reset all settings to their default |
| 527 | values by turning off the \dap, turning it back on, and activating the |
Nils Wallménius | 01bd736 | 2009-02-04 14:22:35 +0000 | [diff] [blame] | 528 | \ButtonHold{} button immediately after the backlight comes on.} |
Marc Guay | 162a8f2 | 2008-06-28 16:10:02 +0000 | [diff] [blame] | 529 | } |
Marianne Arnold | 56b3f92 | 2008-01-20 16:33:12 +0000 | [diff] [blame] | 530 | \opt{GIGABEAT_PAD}{\note{You can also reset all settings to their default |
| 531 | values by turning off the \dap, turning it back on and pressing the |
Nils Wallménius | 01bd736 | 2009-02-04 14:22:35 +0000 | [diff] [blame] | 532 | \ButtonA{} button immediately after the \dap{} turns on.} |
Marianne Arnold | b24f5ce | 2008-01-17 19:45:22 +0000 | [diff] [blame] | 533 | } |
| 534 | |
Marc Guay | 85eec85 | 2008-06-24 05:16:23 +0000 | [diff] [blame] | 535 | \item [Save .cfg File]This option writes a \fname{.cfg} file to |
Nils Wallménius | 01bd736 | 2009-02-04 14:22:35 +0000 | [diff] [blame] | 536 | your \daps{} disk. The configuration file has the \fname{.cfg} |
Martin Arver | 09c3961 | 2006-08-18 16:57:56 +0000 | [diff] [blame] | 537 | extension and is used to store all of the user settings that are described |
| 538 | throughout this manual. |
Nils Wallménius | 01bd736 | 2009-02-04 14:22:35 +0000 | [diff] [blame] | 539 | |
Marc Guay | 85eec85 | 2008-06-24 05:16:23 +0000 | [diff] [blame] | 540 | Hint: Use the \setting{Save .cfg File} feature (\setting{Main Menu |
Nils Wallménius | 01bd736 | 2009-02-04 14:22:35 +0000 | [diff] [blame] | 541 | $\rightarrow$ Manage Settings}) to save the current settings, then |
Martin Arver | 09c3961 | 2006-08-18 16:57:56 +0000 | [diff] [blame] | 542 | use a text editor to customize the settings file. See Appendix |
| 543 | \reference{ref:config_file_options} for the full reference of available |
| 544 | options. |
Dominik Riebeling | d3bf94f | 2008-03-11 18:43:56 +0000 | [diff] [blame] | 545 | |
Marc Guay | 85eec85 | 2008-06-24 05:16:23 +0000 | [diff] [blame] | 546 | \item [Save Sound Settings]This option writes a \fname{.cfg} file to |
Nils Wallménius | 01bd736 | 2009-02-04 14:22:35 +0000 | [diff] [blame] | 547 | your \daps{} disk. The configuration file has the \fname{.cfg} |
Dominik Riebeling | d3bf94f | 2008-03-11 18:43:56 +0000 | [diff] [blame] | 548 | extension and is used to store all of the sound related settings. |
| 549 | |
Marc Guay | 85eec85 | 2008-06-24 05:16:23 +0000 | [diff] [blame] | 550 | \item [Save Theme Settings]This option writes a \fname{.cfg} file to |
Nils Wallménius | 01bd736 | 2009-02-04 14:22:35 +0000 | [diff] [blame] | 551 | your \daps{} disk. The configuration file has the \fname{.cfg} |
Dominik Riebeling | d3bf94f | 2008-03-11 18:43:56 +0000 | [diff] [blame] | 552 | extension and is used to store all of the theme related settings. |
Michael DiFebbo | 0623841 | 2006-08-12 15:56:33 +0000 | [diff] [blame] | 553 | |
Martin Arver | 09c3961 | 2006-08-18 16:57:56 +0000 | [diff] [blame] | 554 | \end{description} |
Martin Arver | 8e8207f | 2006-02-11 00:57:17 +0000 | [diff] [blame] | 555 | |
Martin Arver | 8e8207f | 2006-02-11 00:57:17 +0000 | [diff] [blame] | 556 | \section{\label{ref:FirmwareLoading}Firmware Loading} |
Martin Arver | 96f898e | 2006-03-25 09:22:43 +0000 | [diff] [blame] | 557 | \opt{player,recorder,recorderv2fm,ondio}{ |
Martin Arver | 7bdd03a | 2006-08-27 15:00:50 +0000 | [diff] [blame] | 558 | When your \dap{} powers on, it loads the Archos firmware in ROM, which |
Marianne Arnold | b2f7c61 | 2007-12-14 02:03:58 +0000 | [diff] [blame] | 559 | automatically checks your \daps{} root directory for a file named |
Martin Arver | 47ea906 | 2006-06-07 12:15:46 +0000 | [diff] [blame] | 560 | \firmwarefilename. Note that Archos firmware can only read the first |
Thom Johansen | c479b99 | 2008-02-13 13:32:44 +0000 | [diff] [blame] | 561 | ten characters of each filename in this process, so do not rename your old |
Martin Arver | 47ea906 | 2006-06-07 12:15:46 +0000 | [diff] [blame] | 562 | firmware files with names like \firmwarefilename.\fname{old} and so on, |
Thom Johansen | 10d0344 | 2007-12-13 22:51:27 +0000 | [diff] [blame] | 563 | because it is possible that the \dap{} will load a file other than the one |
Martin Arver | 7bdd03a | 2006-08-27 15:00:50 +0000 | [diff] [blame] | 564 | you intended. |
Martin Arver | d3d3e34 | 2006-03-15 10:56:14 +0000 | [diff] [blame] | 565 | } |
Martin Arver | 8e8207f | 2006-02-11 00:57:17 +0000 | [diff] [blame] | 566 | |
Marc Guay | 85eec85 | 2008-06-24 05:16:23 +0000 | [diff] [blame] | 567 | \subsection{\label{ref:using_rolo}Using ROLO (Rockbox Loader)} |
Dominik Riebeling | ebb8a22 | 2006-04-04 17:48:10 +0000 | [diff] [blame] | 568 | Rockbox is able to load and start another firmware file without rebooting. |
Dominik Riebeling | 2794888 | 2006-07-24 20:53:27 +0000 | [diff] [blame] | 569 | You just ``play'' a file with the extension % |
| 570 | \opt{recorder,recorderv2fm,ondio}{\fname{.ajz}.} % |
| 571 | \opt{player}{\fname{.mod}.} % |
Dominik Riebeling | f498d53 | 2008-12-07 23:00:15 +0000 | [diff] [blame] | 572 | \opt{h100,h300}{\fname{.iriver}.} % |
Dominik Riebeling | 2794888 | 2006-07-24 20:53:27 +0000 | [diff] [blame] | 573 | \opt{ipod}{\fname{.ipod}.} % |
| 574 | \opt{iaudio}{\fname{.iaudio}.} % |
Nils Wallménius | 924c086 | 2007-09-18 21:56:42 +0000 | [diff] [blame] | 575 | \opt{sansa,h10,h10_5gb}{\fname{.mi4}.} % |
Rafaël Carré | e3c9d6a | 2009-05-22 10:44:15 +0000 | [diff] [blame] | 576 | \opt{sansaAMS}{\fname{.sansa}.} % |
Alex Parker | 5174341 | 2009-08-25 21:51:55 +0000 | [diff] [blame] | 577 | \opt{gigabeatf,gigabeats}{\fname{.gigabeat}.} % |
Dominik Riebeling | 2794888 | 2006-07-24 20:53:27 +0000 | [diff] [blame] | 578 | This can be used to test new firmware versions without deleting your |
Dominik Riebeling | ebb8a22 | 2006-04-04 17:48:10 +0000 | [diff] [blame] | 579 | current version. |
Martin Arver | 8e8207f | 2006-02-11 00:57:17 +0000 | [diff] [blame] | 580 | |
Martin Arver | 30b0e66 | 2006-06-15 11:56:50 +0000 | [diff] [blame] | 581 | \opt{archos}{\input{advanced_topics/archos-flashing.tex}} |
Alexander Levin | b57fe48 | 2009-12-23 20:05:29 +0000 | [diff] [blame] | 582 | |