summaryrefslogtreecommitdiff
path: root/manual/configure_rockbox/system_options.tex
diff options
context:
space:
mode:
Diffstat (limited to 'manual/configure_rockbox/system_options.tex')
-rwxr-xr-xmanual/configure_rockbox/system_options.tex85
1 files changed, 53 insertions, 32 deletions
diff --git a/manual/configure_rockbox/system_options.tex b/manual/configure_rockbox/system_options.tex
index b090deff95..0976fe33b5 100755
--- a/manual/configure_rockbox/system_options.tex
+++ b/manual/configure_rockbox/system_options.tex
@@ -1,39 +1,38 @@
1 \subsection{\label{ref:SystemOptions}System Options} 1 \subsection{\label{ref:SystemOptions}System Options}
2 2
3 \begin{itemize} 3 \begin{itemize}
4 \item \textbf{Battery} 4 \item \textbf{Battery: }
5 Options relating to the batteries in the \dap. 5 Options relating to the batteries in the \dap.
6 \begin{itemize} 6 \begin{itemize}
7 \item \textbf{Battery Capacity} can be used to tell Rockbox what capacity (in mAh) of battery is being used inside it. 7 \item \textbf{Battery Capacity: }This setting can be used to tell Rockbox what capacity (in mAh) of battery is being used inside it.
8 \opt{player,recorder,recorderv2fm,ondio}{The default is 1500mAh for NiMH battery based units, and 2300mAh for LiOn battery based units, which is the capacity value for the standard batteries shipped with these units.} 8 \opt{player,recorder,recorderv2fm,ondio}{The default is 1500mAh for NiMH battery based units, and 2300mAh for LiOn battery based units, which is the capacity value for the standard batteries shipped with these units.}
9 \opt{h1xx,h300}{The default is 1300mAh.} 9 \opt{h1xx,h300}{The default is 1300mAh.}
10 This value is used for calculating remaining battery life. 10 \opt{ipodnano,ipodcolor,ipodvideo}{TODO: correct battery values for ipod platforms.}
11 Rockbox uses this value to estimate remaining battery life for the status bar and WPS.
11 \opt{recorder}{ 12 \opt{recorder}{
12 \item \textbf{Deep discharge} 13 \item \textbf{Deep discharge}
13 Set this to ON if you intend to keep your charger connected for a long period of time. It lets the batteries go down to 10\% before starting to charge again. Setting this to OFF will cause the charging to restart on 95\%. 14 Set this to ON if you intend to keep your charger connected for a long period of time. It lets the batteries go down to 10\% before starting to charge again. Setting this to OFF will cause the charging to restart on 95\%.
14 } 15 }
15 \opt{recorder}{ 16 \opt{recorder}{
16 \item \textbf{Trickle Charge} 17 \item \textbf{Trickle Charge}
17 The \dap cannot be turned off while the charger is connected. 18 The \dap cannot be turned off while the charger is connected. Therefore, trickle charge is needed to keep the batteries full after charging has completed. For more in depth information about charging see Battery FAQ in your \textbf{/.rockbox/docs }directory.
18 Therefore, trickle charge is needed to keep the batteries full after
19 charging has completed. For more in depth information about charging
20 see Battery FAQ in your \textbf{/.rockbox/docs }directory.
21 } 19 }
22 \end{itemize} 20 \end{itemize}
23 21
24 \item \textbf{Disk} 22 \item \textbf{Disk: }
25 Options relating to the hard disk. 23 Options relating to the hard disk.
26 24
27 \begin{itemize} 25 \begin{itemize}
28 \item \textbf{DiskSpindown:} 26 \item \textbf{Disk Spindown: }
29 Rockbox has a timer that makes it spin down the hard disk after being idle for acertain time. You can modify this timeout here. This idle time is only affected by user activity, like navigating through file browser. When the hard disk spins up to fill mp3 buffer, it automatically spins down afterwards. 27 Rockbox has a timer that makes it spin down the hard disk after it is idle for a certain amount of time. This setting controls the amount of time between the last user activity and the time that the disk spins down. This idle time is only affected by user activity, like navigating through file browser. When the hard disk spins up to fill mp3 buffer, it automatically spins down afterwards.
30 \opt{recorder,h1xx,h300}{ 28 \opt{recorder,h1xx,h300}{
31 \item \textbf{Disk Poweroff:} 29 \item \textbf{Disk Poweroff: }
32 Whether the disk is powered OFF or only set to ``sleep'' when spun down. Power off uses less power but takes longer to spin{}-up.} 30 This setting controls whether the disk is powered off or only set to ``sleep'' when spun down. If this setting is YES, the disk will power off. If set to NO, the disk will enter ``sleep'' mode. Power off uses less power but takes longer to spin{}-up.}
31 \item \textbf{Directory cache: } Rockbox has the ability to scan the contents of your drive in the background and save those contents to a cache in RAM. The Directory Cache takes a small amount of memory away from Rockbox that would otherwise be used to buffer music, but it speeds up navigation by eliminating the slight pause between the time a navigation button is pressed and the time Rockbox responds. Turning this setting ON activates the directory cache, and turning it OFF deactivates the directory cache. Note: the first time you set the directory cache to ON, Rockbox will take a few minutes to scan the drive and you will need to restart the player. Thereafter, the directory cache will work in the background. (TODO: confirm that these last two sentences are true.)
33 \end{itemize} 32 \end{itemize}
34 33
35 \opt{recorder,recorderv2fm,h3xx}{ 34 \opt{recorder,recorderv2fm,h3xx}{
36 \item \textbf{Time and Date} 35 \item \textbf{Time and Date:}
37 Time related menu options. 36 Time related menu options.
38 37
39 \begin{itemize} 38 \begin{itemize}
@@ -44,37 +43,35 @@
44 \end{itemize} 43 \end{itemize}
45 } 44 }
46 45
47 \item \textbf{\label{ref:idlepoweroff}Idle Poweroff} 46 \item \textbf{\label{ref:idlepoweroff}Idle Poweroff:}
48 Rockbox can be configured to turn off power after the unit has been idle for a defined number of minutes. The unit is idle when playback is stopped or paused. It is not idle while the USB or charger is connected, or while recording. 47 Rockbox can be configured to turn off power after the unit has been idle for a defined number of minutes. The \dap\ is idle when playback is stopped or paused. It is not idle while the USB or charger is connected, or while recording.
49
50 \item \textbf{Sleep Timer}
51 This option lets you power off your \dap after playing for a given time. \opt{recorderv2fm}{This setting is reset on boot. Using this option disables the \textbf{Wake up alarm} (see below).}
52 48
49 \item \textbf{Sleep Timer:}
50 This option lets you power off your \dap after playing for a given time.
51 \opt{recorderv2fm}{This setting is reset on boot. Using this option disables the \textbf{Wake up alarm} (see below).}
53 \opt{recorderv2fm}{ 52 \opt{recorderv2fm}{
54 \item \textbf{Wake up alarm (Recorder v2/FM only)} 53 \item \textbf{Wake up alarm:}
55 This option turns the \dap off and then starts it up again at the specified time. This is most useful when combined with the Resume setting in the Playback options set to ``Yes'', so that the \dap wakes up and immediately starts playing music. Use LEFT and RIGHT to adjust the minutes setting, UP and DOWN to adjust the HOURS. PLAY confirms the alarm and shuts your \dap down, and STOP cancels setting an alarm. If the \dap is turned on again before the alarm occurs the alarm will be canceled. Using this option disables the \textbf{Sleep Timer} (see above). 54 This option turns the \dap off and then starts it up again at the specified time. This is most useful when combined with the ``resume'' setting in the ``Playback options'' menu is set to YES, so that the \dap wakes up and immediately starts playing music. Use LEFT and RIGHT to adjust the minutes setting, UP and DOWN to adjust the HOURS. PLAY confirms the alarm and shuts your \dap down, and STOP cancels setting an alarm. If the \dap is turned on again before the alarm occurs, the alarm will be canceled. Using this option disables the \textbf{Sleep Timer} (see above).
56 } 55 }
57 56
58 \item \textbf{Limits} 57 \item \textbf{Limits:}
59 This submenu relates to limits in the Rockbox operating system. 58 This submenu relates to limits in the Rockbox operating system.
60 59
61 \begin{itemize} 60 \begin{itemize}
62 \item \textbf{Max files in dir browser:} 61 \item \textbf{Max files in dir browser:}
63 Configurable limit of files in the directory browser (file buffer size). You can configure the size to be between 50 and 10000 files in steps of 50 files. The default is 400, higher values will shorten the music buffer.\\ 62 This setting controls the limit on the number of files that you can put in any particular directory in the file browser. You can configure the size to be between 50 and 10000 files in steps of 50 files. The default is 400. Higher values will shorten the music buffer, so you should increase this setting \textbf{only} if you have directories with a large number of files.
63
64 \item \textbf{Max playlist size:} 64 \item \textbf{Max playlist size:}
65 Option to configure the maximum size of a playlist. The playlist size can be between 1000 and 20000 files in 65 This setting controls the maximum size of a playlist. The playlist size can be between 1,000 and 20,000 files, in steps of 1000. The default is 10,000. Higher values will shorten the music buffer, so you should increase this setting \textbf{only} if you have very large playlists.\\
66 steps of 1000. By default it is 10000. Higher values will shorten the music buffer.\\
67 \end{itemize} 66 \end{itemize}
68 67
69 \opt{player,recorder,recorderv2fm}{ 68 \opt{player,recorder,recorderv2fm}{
70 \item \textbf{Car Adapter Mode} 69 \item \textbf{Car Adapter Mode}
71 This option turns on and off the car ignition auto stop function. 70 This option turns on and off the car ignition auto stop function.
72 71
73 When using the \dap in a car, car adapter mode automatically stops playback on the \dap when power (i.e. from cigarette lighter power adapter) to the external DC in jack is turned off. 72 When using the \dap in a car, car adapter mode automatically stops playback on the \dap when power (i.e. from cigarette lighter power adapter) to the external DC in jack is turned off. If the Car Adaptor Mode is set to ON, Rockbox will pause playback when the external power off condition is detected. Rockbox will then shutdown the \dap after the length of time set in the \textbf{Idle Poweroff} setting (see above). If power to the DC in jack is turned back on before the \textbf{Idle Poweroff} function has shut the \dap off, playback will be resumed 5 seconds after the power is applied. This delay is to allow for the time while the car engine is being started.
74
75 When the external power off condition is detected, the Car Adapter Mode function only pauses the playback. In order to shut down the \dap completely the \textbf{Idle Poweroff} function (see above) must also be set.
76 73
77 If power to the DC in jack is turned back on before the \textbf{Idle Poweroff} function has shut the \dap off, playback will be resumed 5 seconds after the power is applied. This delay is to allow for the time while the car engine is being started. Once the \dap is shut off either manually, or automatically with the \textbf{Idle Poweroff}function, it must be powered up manually to resume playback. 74 Once the \dap is shut off either manually, or automatically with the \textbf{Idle Poweroff}function, it must be powered up manually to resume playback.
78 } 75 }
79 \opt{player}{ 76 \opt{player}{
80 \item \textbf{Line In (Player only)} 77 \item \textbf{Line In (Player only)}
@@ -89,17 +86,41 @@
89 } 86 }
90 87
91 \item \textbf{Manage settings} 88 \item \textbf{Manage settings}
92 This submenu deals with loading and saving settings. 89 This submenu deals with loading and saving settings. \opt{MASCODEC}{This submenu also allows you to load or save different firmware versions.
90 }
93 91
94 \begin{itemize} 92 \begin{itemize}
95 \item \textbf{Browse .cfg Files: } 93 \item \textbf{Browse .cfg Files: }
96 This displays a list of configuration (.cfg) files stored in the \textbf{/.rockbox} system directory. This is useful if the \dap is plugged into more than one different output device (e.g. headphones, computer, car stereo, hi{}-fi) so that a settings file can be maintained for each. 94 Opens the file browser in the \textbf{/.rockbox} directory and displays all .cfg (configuration) files. Selecting a .cfg file will cause Rockbox to load that the settings contained in that file. STOP will exit back to the menu. (TODO--proper button configurations for different platforms.) See the \textbf{Write .cfg files} option on the Manage Settings menu for details of how to save and edit a configuration file.
95
96 \opt{MASCODEC}{
97 \item \textbf{Browse Firmwares:} 97 \item \textbf{Browse Firmwares:}
98 This displays a list of firmware file in the \fname{/.rockbox} system directory. Playing a firmware file loads it into memory. Thus it is possible to run the original Archos firmware or a different version of Rockbox from here assuming that you have the right files installed on your disk. 98 This displays a list of firmware file in the \fname{/.rockbox} system directory.
99 \opt{recorder,recorderv2fm}{ Firmware files have an extension of .ajz.}
100 \opt{player,ondio}{ Firmware files have an extension of .mod}
101
102 Playing a firmware file loads it into memory. Thus, it is possible to run the original Archos firmware or a different version of Rockbox from here assuming that you have the right files installed on your disk. There's no need of any other file or directory to be installed to use this option; the firmware is resident in that one file.
103 }
99 \item \textbf{Reset Settings: } 104 \item \textbf{Reset Settings: }
100 This wipes the saved settings in the \dap and resets all settings to their default values. 105 This wipes the saved settings in the \dap and resets all settings to their default values.
106 \opt{h100, h300}{ \textbf{Note: } You can also reset all settings to their default values by turning off the \dap\, turning it back on, and pressing the REC button (TODO--proper button def) immediately after the \dap\ turns on. (TODO: check if this feature is available on other platforms.}
101 \item \textbf{Write .cfg file: } 107 \item \textbf{Write .cfg file: }
102 Saves the current settings into a .cfg file for later use with \textbf{Browse .cfg Files} above. 108 This option writes a Rockbox configuration file to your jukebox's hard disk. The configuration file has the ".cfg" extension and is used to store all of the user settings that are described throughout this manual.
109
110 A configuration file may reside anywhere on the hard disk. Multiple configuration files are permitted. So, for example, you could have a car.cfg file for the settings that you use while playing your jukebox in your car, and a headphones.cfg file to store the settings that you use while listening to your jukebox through headphones.
111
112 The Rockbox configuration file is a plain text file, so once you use the \textbf{Write .cfg file} option to create the file, you can edit the file on your computer using any text editor program. Configuration files use the following formatting rules:
113
114 \begin{enumerate}
115 \item Each setting must be on a separate line.
116 \item Each line has the format ``setting: value''.
117 \item Values must be within the ranges specified in this manual for each setting.
118 \item Lines starting with # are ignored. This lets you write comments into your configuration files.
119 \end{enumerate}
120
121 Configuration files may be loaded using the Browse .cfg files option on the Manage Settings menu.
122
123 \textbf{Hint: }Configuration files do not need to contain all of the Rockbox options. You can create configuration files that change only certain settings. So, for example, let's say you typically use the \dap at one volume in the car, and another when using headphones. Further, suppose you like to use an inverse LCD when you're in the car, and a regular LCD setting when you're using headphones. You could create configuration files that control only the volume and LCD settings. Create a few different files with different settings, give each file a different name (such as car.cfg, headphones.cfg, etc.), and you can then use the \textbf{Browse .cfg files} option to quickly change settings.
103 \end{itemize} 124 \end{itemize}
104 125
105 \end{itemize} 126 \end{itemize}