diff options
author | Michael DiFebbo <medifebbo@rockbox.org> | 2006-08-12 15:56:33 +0000 |
---|---|---|
committer | Michael DiFebbo <medifebbo@rockbox.org> | 2006-08-12 15:56:33 +0000 |
commit | 062384109190f4f05ef88ab17ec51cd8d49ed5c4 (patch) | |
tree | 8024ca3a90066216b1012af908db22e2668560fb /manual | |
parent | ae8f25c6a78aeea0df0c35bd3845a427dead0b3b (diff) | |
download | rockbox-062384109190f4f05ef88ab17ec51cd8d49ed5c4.tar.gz rockbox-062384109190f4f05ef88ab17ec51cd8d49ed5c4.zip |
Revamped 'Managing Settings' sections. Merged the duplicative 'Manage settings' sections in chapter 5 and chapter 7 (the 'Manage settings' section in chapter 5 was in the wrong place anyway, as 'Manage settings' is not in the system submenu). Improved the organization of 7.3. Updated cross-references so that the description in chapter 7 can be easily referenced from the overview description contained in the 'Main Manual' chapter.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@10551 a1c6a512-1295-4272-9138-f99709370657
Diffstat (limited to 'manual')
-rw-r--r-- | manual/advanced_topics/main.tex | 153 | ||||
-rwxr-xr-x | manual/configure_rockbox/system_options.tex | 71 | ||||
-rw-r--r-- | manual/main_menu/main.tex | 11 |
3 files changed, 130 insertions, 105 deletions
diff --git a/manual/advanced_topics/main.tex b/manual/advanced_topics/main.tex index 2cb5c41544..81a0d4c715 100644 --- a/manual/advanced_topics/main.tex +++ b/manual/advanced_topics/main.tex | |||
@@ -237,37 +237,128 @@ title [artist]''. | |||
237 | % % \end{verbatim} | 237 | % % \end{verbatim} |
238 | %} | 238 | %} |
239 | 239 | ||
240 | \section{\label{ref:SettingsFile}Making your own settings file} | 240 | \section{\label{ref:manage_settings}Managing Rockbox settings} |
241 | A \fname{.cfg} file is used to load settings from a plain text file. A | 241 | |
242 | \fname{.cfg} file may reside anywhere on the hard disk. The only restriction is | 242 | \subsection{Introduction to \fname{.cfg} files.} |
243 | that the filename must end in \fname{.cfg} | 243 | Rockbox allows users to store and load multiple settings through the use of |
244 | 244 | configuration files. A configuration file is simply a text file with the | |
245 | Hint: Use the \setting{Write .cfg file} feature (\setting{Main Menu$\rightarrow$ | 245 | extension \fname{.cfg}. |
246 | General Settings}) to save the current settings, then use a text editor to | 246 | |
247 | customize the settings file. See appendix \reference{ref:config_file_options} | 247 | A configuration file may reside anywhere on the hard disk. Multiple |
248 | for the full reference of available options. | 248 | configuration files are permitted. So, for example, you could have |
249 | 249 | a \fname{car.cfg} file for the settings that you use while playing your | |
250 | \subsection{Format Rules} | 250 | jukebox in your car, and a \fname{headphones.cfg} file to store the |
251 | 251 | settings that you use while listening to your \dap\ through headphones. | |
252 | \begin{itemize} | 252 | |
253 | \item Format: \config{setting: value} | 253 | See \reference{ref:cfg_specs} below for an explanation of the format |
254 | \item Each setting must be on a separate line. | 254 | for configuration files. See \reference{ref:manage_settings_menu} for an |
255 | \item Lines starting with \config{\#} are ignored. | 255 | explanation of how to create, edit and load configuration files. |
256 | \end{itemize} | 256 | |
257 | 257 | \subsection{\label{ref:cfg_specs}Specifications for \fname{.cfg} | |
258 | Example of a configuration file: | 258 | files.} |
259 | \begin{example} | 259 | |
260 | # Example configuration file | 260 | The Rockbox configuration file is a plain text file, so once you use the |
261 | volume: 70 | 261 | \setting{Write .cfg file} option to create the file, you can edit the file on |
262 | bass: 11 | 262 | your computer using any text editor program. See |
263 | treble: 12 | 263 | Appendix \reference{ref:config_file_options} for available settings. Configuration |
264 | balance: 0 | 264 | files use the following formatting rules: % |
265 | time format: 12hour | 265 | |
266 | volume display: numeric | 266 | \begin{enumerate} |
267 | show files: supported | 267 | \item Each setting must be on a separate line. |
268 | wps: /.rockbox/car.wps | 268 | \item Each line has the format ``setting: value''. |
269 | lang: /.rockbox/afrikaans.lng | 269 | \item Values must be within the ranges specified in this manual for each |
270 | \end{example} | 270 | setting. |
271 | \item Lines starting with \# are ignored. This lets you write comments into | ||
272 | your configuration files. | ||
273 | \end{enumerate} | ||
274 | |||
275 | Example of a configuration file: | ||
276 | \begin{example} | ||
277 | # Example configuration file | ||
278 | # volume: 70 | ||
279 | # bass: 11 | ||
280 | # treble: 12 | ||
281 | # balance: 0 | ||
282 | # time format: 12hour | ||
283 | # volume display: numeric | ||
284 | # show files: supported | ||
285 | # wps: /.rockbox/car.wps | ||
286 | # lang: /.rockbox/afrikaans.lng | ||
287 | \end{example} | ||
288 | |||
289 | \note{As you can see from the example, configuration files do not need to | ||
290 | contain all of the Rockbox options. You can create configuration files | ||
291 | that change only certain settings. So, for example, supppose you | ||
292 | typically use the \dap at one volume in the car, and another when using | ||
293 | headphones. Further, suppose you like to use an inverse LCD when you are | ||
294 | in the car, and a regular LCD setting when you are using headphones. You | ||
295 | could create configuration files that control only the volume and LCD | ||
296 | settings. Create a few different files with different settings, give | ||
297 | each file a different name (such as \fname{car.cfg}, | ||
298 | \fname{headphones.cfg}, etc.), and you can then use the \setting{Browse .cfg | ||
299 | files} option to quickly change settings.} | ||
300 | |||
301 | \subsection{\label{ref:manage_settings_menu}The \setting{Manage Settings} | ||
302 | menu} The \setting{Manage Settings} menu can be found in the \setting{Main | ||
303 | Menu}. The \setting{Manage Settings} menu allows you to save and load | ||
304 | \fname{.cfg} files. \opt{MASCODEC}{The \setting{Manage Settings} menu also | ||
305 | allows you to load or save different firmware versions.} | ||
306 | |||
307 | \begin{description} | ||
308 | |||
309 | \item [Browse .cfg Files.]Opens the file browser in the | ||
310 | \fname{/.rockbox} directory and displays all \fname{.cfg} (configuration) | ||
311 | files. Selecting a \fname{.cfg} file will cause Rockbox to load the | ||
312 | settings contained in that file. Pressing \ButtonLeft\ will exit back to | ||
313 | the \setting{Manage Settings} menu. See the \setting{Write .cfg files} | ||
314 | option on the \setting{Manage Settings} menu for details of how to save | ||
315 | and edit a configuration file. | ||
316 | |||
317 | \item [Browse Firmwares.] | ||
318 | % | ||
319 | \opt{SWCODEC}{\fixme{This is a legacy item, and is deprecated.}} | ||
320 | % | ||
321 | \opt{MASCODEC}{ | ||
322 | This displays a list of firmware files in the \fname{/.rockbox} | ||
323 | system directory. | ||
324 | % | ||
325 | \opt{recorder,recorderv2fm}{Firmware files have an extension of | ||
326 | \fname{.ajz}. } | ||
327 | % | ||
328 | \opt{player,ondio}{Firmware files have an extension of \fname{.mod}. } | ||
329 | % | ||
330 | Playing a firmware file loads it into memory. Thus, it is possible | ||
331 | to run the original Archos firmware or a different version of Rockbox | ||
332 | from here (assuming that you have the right files installed on your | ||
333 | disk. There is no need for any other file or directory to be | ||
334 | installed to use this option; the firmware is resident in that one | ||
335 | file. | ||
336 | } | ||
337 | |||
338 | \item [Reset Settings.]This wipes the saved settings in the \dap\ and | ||
339 | resets all settings to their default values. | ||
340 | |||
341 | \opt{h100,h300}{\note{You can also reset all settings to their default | ||
342 | values by turning off the \dap\, turning it back on, and pressing the | ||
343 | \ButtonRec button immediately after the \dap\ turns on.} | ||
344 | } | ||
345 | \opt{ipod}{\note{You can also reset all settings to their default values | ||
346 | by turning off the \dap\, and turning it back on with the hold button | ||
347 | on.} | ||
348 | } | ||
349 | |||
350 | \item [Write .cfg file.]This option writes a \fname{.cfg} file to | ||
351 | your \daps\ hard disk. The configuration file has the \fname{.cfg} | ||
352 | extension and is used to store all of the user settings that are described | ||
353 | throughout this manual. | ||
354 | |||
355 | Hint: Use the \setting{Write .cfg file} feature (\setting{Main | ||
356 | Menu $\rightarrow$ General Settings}) to save the current settings, then | ||
357 | use a text editor to customize the settings file. See Appendix | ||
358 | \reference{ref:config_file_options} for the full reference of available | ||
359 | options. | ||
360 | |||
361 | \end{description} | ||
271 | 362 | ||
272 | \section{\label{ref:PartISection1}Differences between binaries} | 363 | \section{\label{ref:PartISection1}Differences between binaries} |
273 | There are 3 different types of firmware binaries from Rockbox website: | 364 | There are 3 different types of firmware binaries from Rockbox website: |
diff --git a/manual/configure_rockbox/system_options.tex b/manual/configure_rockbox/system_options.tex index 9e2975f6d0..8973bd4f59 100755 --- a/manual/configure_rockbox/system_options.tex +++ b/manual/configure_rockbox/system_options.tex | |||
@@ -148,75 +148,4 @@ This submenu relates to limits in the Rockbox operating system. | |||
148 | \end{itemize} | 148 | \end{itemize} |
149 | } | 149 | } |
150 | 150 | ||
151 | \subsection{\label{ref:manage_settings}Manage settings} | ||
152 | This submenu deals with loading and saving settings. | ||
153 | \opt{MASCODEC}{This submenu also allows you to load or save different | ||
154 | firmware versions.} | ||
155 | % | ||
156 | \begin{description} | ||
157 | \item [Browse .cfg Files: ]Opens the file browser in the | ||
158 | \fname{/.rockbox} directory and displays all \fname{.cfg} (configuration) files. | ||
159 | Selecting a \fname{.cfg} file will cause Rockbox to load the settings | ||
160 | contained in that file. Pressing \ButtonLeft\ will exit back to the menu. | ||
161 | See the \setting{Write .cfg files} option on the \setting{Manage Settings} menu for | ||
162 | details of how to save and edit a configuration file. | ||
163 | % | ||
164 | \item [Browse Firmwares: ]This displays a list of firmware file in | ||
165 | the \fname{/.rockbox} system directory. % | ||
166 | \opt{SWCODEC}{\fixme{This is legacy item, and is depreciated.}} | ||
167 | \opt{MASCODEC}{% | ||
168 | \opt{recorder,recorderv2fm}{Firmware files have an extension of \fname{.ajz}. }% | ||
169 | \opt{player,ondio}{Firmware files have an extension of \fname{.mod}. }% | ||
170 | Playing a firmware file loads it into memory. Thus, it is possible to | ||
171 | run the original Archos firmware or a different version of Rockbox | ||
172 | from here assuming that you have the right files installed on your | ||
173 | disk. There is no need for any other file or directory to be installed | ||
174 | to use this option; the firmware is resident in that one file. | ||
175 | } | ||
176 | \item [Reset Settings: ]This wipes the saved settings in the \dap\ and | ||
177 | resets all settings to their default values. | ||
178 | \opt{h100, h300}{\note{You can also reset all settings to their default | ||
179 | values by turning off the \dap\, turning it back on, and pressing | ||
180 | the \ButtonRec button immediately after the \dap\ turns on.} | ||
181 | } | ||
182 | \item [Write .cfg file: ]This option writes a Rockbox configuration file | ||
183 | to your \daps\ hard disk. The configuration file has the \fname{.cfg} | ||
184 | extension and is used to store all of the user settings that are described | ||
185 | throughout this manual. | ||
186 | A configuration file may reside anywhere on the hard disk. Multiple | ||
187 | configuration files are permitted. So, for example, you could have | ||
188 | a \fname{car.cfg} file for the settings that you use while playing your | ||
189 | jukebox in your car, and a \fname{headphones.cfg} file to store the | ||
190 | settings that you use while listening to your \dap\ through headphones. | ||
191 | |||
192 | The Rockbox configuration file is a plain text file, so once you use the | ||
193 | \setting{Write .cfg file} option to create the file, you can edit the file | ||
194 | on your computer using any text editor program. See | ||
195 | \reference{ref:config_file_options} for available settings. Configuration | ||
196 | files use the following formatting rules: | ||
197 | % | ||
198 | \begin{enumerate} | ||
199 | \item Each setting must be on a separate line. | ||
200 | \item Each line has the format ``setting: value''. | ||
201 | \item Values must be within the ranges specified in this manual for each | ||
202 | setting. | ||
203 | \item Lines starting with \# are ignored. This lets you write comments | ||
204 | into your configuration files. | ||
205 | \end{enumerate} | ||
206 | |||
207 | Configuration files may be loaded using the \setting{Browse .cfg files} | ||
208 | option on the \setting{Manage Settings} menu. | ||
209 | |||
210 | \note{Configuration files do not need to contain all of the Rockbox | ||
211 | options. You can create configuration files that change only certain | ||
212 | settings. So, for example, supppose you typically use the \dap at one | ||
213 | volume in the car, and another when using headphones. Further, | ||
214 | suppose you like to use an inverse LCD when you're in the car, and | ||
215 | a regular LCD setting when you're using headphones. You could create | ||
216 | configuration files that control only the volume and LCD settings. | ||
217 | Create a few different files with different settings, give each file | ||
218 | a different name (such as \fname{car.cfg}, \fname{headphones.cfg}, | ||
219 | etc.), and you can then use the \setting{Browse .cfg files} option | ||
220 | to quickly change settings.} | ||
221 | \end{description} | ||
222 | 151 | ||
diff --git a/manual/main_menu/main.tex b/manual/main_menu/main.tex index af4d5add96..e86407a21b 100644 --- a/manual/main_menu/main.tex +++ b/manual/main_menu/main.tex | |||
@@ -85,9 +85,14 @@ and the way it plays music. The details of this menu are covered in detail in | |||
85 | 85 | ||
86 | \section{Manage Settings} | 86 | \section{Manage Settings} |
87 | The \setting{Manage Settings} option allows the saving and re-loading of user | 87 | The \setting{Manage Settings} option allows the saving and re-loading of user |
88 | configuration settings, browse the hard drive for alternate firmwares, and finally | 88 | configuration settings, browsing the hard drive for alternate firmwares, and finally |
89 | to reset your \dap\ back to initial configuration. The details of this menu are | 89 | resetting your \dap\ back to initial configuration. |
90 | covered in detail in \reference{ref:manage_settings}. | 90 | % |
91 | \opt{MASCODEC}{This menu also allows the user to load different versions of the | ||
92 | Rockbox firmware.} | ||
93 | % | ||
94 | The details of this menu are covered in detail in | ||
95 | \reference{ref:manage_settings}. | ||
91 | 96 | ||
92 | \section{Browse Themes} | 97 | \section{Browse Themes} |
93 | This option will display all the currently installed themes on the \dap, | 98 | This option will display all the currently installed themes on the \dap, |