diff options
Diffstat (limited to 'manual')
-rwxr-xr-x | manual/configure_rockbox/system_options.tex | 107 |
1 files changed, 53 insertions, 54 deletions
diff --git a/manual/configure_rockbox/system_options.tex b/manual/configure_rockbox/system_options.tex index b239f1e23c..9e2975f6d0 100755 --- a/manual/configure_rockbox/system_options.tex +++ b/manual/configure_rockbox/system_options.tex | |||
@@ -1,3 +1,4 @@ | |||
1 | % $Id$ % | ||
1 | \section{\label{ref:SystemOptions}System Options} | 2 | \section{\label{ref:SystemOptions}System Options} |
2 | 3 | ||
3 | \subsection{Battery} | 4 | \subsection{Battery} |
@@ -5,15 +6,15 @@ | |||
5 | \begin{description} | 6 | \begin{description} |
6 | \item [Battery Capacity: ]This setting can be used to tell Rockbox what | 7 | \item [Battery Capacity: ]This setting can be used to tell Rockbox what |
7 | capacity (in mAh) of battery is being used inside it. The default is | 8 | capacity (in mAh) of battery is being used inside it. The default is |
8 | \opt{player,recorder}{1500mAh} | 9 | \opt{player,recorder}{1500mAh}% |
9 | \opt{recorderv2fm}{2200mAh} | 10 | \opt{recorderv2fm}{2200mAh}% |
10 | \opt{ondiosp,ondiofm}{1000mAh} | 11 | \opt{ondiosp,ondiofm}{1000mAh}% |
11 | \opt{h1xx,h300}{1300mAh} | 12 | \opt{h1xx,h300}{1300mAh}% |
12 | \opt{ipodmini}{400mAh (1G) or 630mAh (2G)} | 13 | \opt{ipodmini}{400mAh (1G) or 630mAh (2G)}% |
13 | \opt{ipodcolor}{700mAh} | 14 | \opt{ipodcolor}{700mAh}% |
14 | \opt{ipodnano,ipodvideo,ipod4g}{\fixme{unknown}} | 15 | \opt{ipodnano,ipodvideo,ipod4g}{\fixme{unknown}}% |
15 | \opt{x5}{950mAh} | 16 | \opt{x5}{950mAh}% |
16 | which is the capacity value for the standard batteries shipped with the \dap. | 17 | , which is the capacity value for the standard batteries shipped with the \dap. |
17 | Rockbox uses this value to estimate remaining battery life for the status | 18 | Rockbox uses this value to estimate remaining battery life for the status |
18 | bar and WPS. Changing this setting has no effect whatsoever on actual battery life. | 19 | bar and WPS. Changing this setting has no effect whatsoever on actual battery life. |
19 | This setting affects only the the accuracy of the battery life display on screen. | 20 | This setting affects only the the accuracy of the battery life display on screen. |
@@ -25,7 +26,6 @@ | |||
25 | \item [Battery Type: ]This setting tells Rockbox wich type of battery | 26 | \item [Battery Type: ]This setting tells Rockbox wich type of battery |
26 | that is currently used in the \dap. | 27 | that is currently used in the \dap. |
27 | } | 28 | } |
28 | |||
29 | \end{description} | 29 | \end{description} |
30 | 30 | ||
31 | \nopt{ondiosp,ondiofm}{ | 31 | \nopt{ondiosp,ondiofm}{ |
@@ -54,11 +54,11 @@ | |||
54 | that would otherwise be used to buffer music, but it speeds up navigation | 54 | that would otherwise be used to buffer music, but it speeds up navigation |
55 | by eliminating the slight pause between the time a navigation button is | 55 | by eliminating the slight pause between the time a navigation button is |
56 | pressed and the time Rockbox responds. Turning this setting \setting{On} | 56 | pressed and the time Rockbox responds. Turning this setting \setting{On} |
57 | activates the directory cache, and turning it \setting{Off} deactivates the | 57 | activates the directory cache, and turning it \setting{Off} deactivates the |
58 | directory cache. | 58 | directory cache. |
59 | \note{The first time you set the directory cache to \setting{On}, | 59 | \note{The first time you set the directory cache to \setting{On}, |
60 | Rockbox will request a reboot of the \dap\ and upon restarting take a few | 60 | Rockbox will request a reboot of the \dap\ and upon restarting take a few |
61 | minutes to scan the drive. Thereafter, the directory cache will work in the | 61 | minutes to scan the drive. Thereafter, the directory cache will work in the |
62 | background.} | 62 | background.} |
63 | } | 63 | } |
64 | \end{description} | 64 | \end{description} |
@@ -87,13 +87,13 @@ | |||
87 | \opt{recorderv2fm}{ | 87 | \opt{recorderv2fm}{ |
88 | \item [Wake up alarm: ]This option turns the \dap\ off and then starts | 88 | \item [Wake up alarm: ]This option turns the \dap\ off and then starts |
89 | it up again at the specified time. This is most useful when combined | 89 | it up again at the specified time. This is most useful when combined |
90 | with the \setting{resume} setting in the \setting{Playback Options} | 90 | with the \setting{resume} setting in the \setting{Playback Options} |
91 | menu is set to \setting{Yes}, so that the \dap\ wakes up and immediately | 91 | menu is set to \setting{Yes}, so that the \dap\ wakes up and immediately |
92 | starts playing music. Use \ButtonLeft\ and \ButtonRight\ to adjust the | 92 | starts playing music. Use \ButtonLeft\ and \ButtonRight\ to adjust the |
93 | minutes setting, \ButtonUp\ and \ButtonDown\ to adjust the HOURS. | 93 | minutes setting, \ButtonUp\ and \ButtonDown\ to adjust the HOURS. |
94 | \ButtonPlay\ confirms the alarm and shuts your \dap\ down, and \ButtonOff | 94 | \ButtonPlay\ confirms the alarm and shuts your \dap\ down, and \ButtonOff |
95 | cancels setting an alarm. If the \dap\ is turned on again before the | 95 | cancels setting an alarm. If the \dap\ is turned on again before the |
96 | alarm occurs, the alarm will be canceled. Using this option disables | 96 | alarm occurs, the alarm will be canceled. Using this option disables |
97 | the \setting{Sleep Timer}(see above). | 97 | the \setting{Sleep Timer}(see above). |
98 | } | 98 | } |
99 | \end{description} | 99 | \end{description} |
@@ -101,32 +101,32 @@ | |||
101 | \subsection{Limits} | 101 | \subsection{Limits} |
102 | This submenu relates to limits in the Rockbox operating system. | 102 | This submenu relates to limits in the Rockbox operating system. |
103 | \begin{description} | 103 | \begin{description} |
104 | \item [Max files in dir browser: ]This setting controls the limit on | 104 | \item [Max files in dir browser: ]This setting controls the limit on |
105 | the number of files that you can put in any particular directory in the | 105 | the number of files that you can put in any particular directory in the |
106 | file browser. You can configure the size to be between 50 and 10000 files | 106 | file browser. You can configure the size to be between 50 and 10,000 files |
107 | in steps of 50 files. The default is 400. Higher values will shorten the | 107 | in steps of 50 files. The default is 400. Higher values will shorten the |
108 | music buffer, so you should increase this setting \emph{only} if you have | 108 | music buffer, so you should increase this setting \emph{only} if you have |
109 | directories with a large number of files. | 109 | directories with a large number of files. |
110 | 110 | ||
111 | \item [Max playlist size: ]This setting controls the maximum size of | 111 | \item [Max playlist size: ]This setting controls the maximum size of |
112 | a playlist. The playlist size can be between 1,000 and 20,000 files, | 112 | a playlist. The playlist size can be between 1,000 and 20,000 files, |
113 | in steps of 1000 (default is 10,000). Higher values will shorten the | 113 | in steps of 1,000 (default is 10,000). Higher values will shorten the |
114 | music buffer, so you should increase this setting \emph{only} if you | 114 | music buffer, so you should increase this setting \emph{only} if you |
115 | have very large playlists. | 115 | have very large playlists. |
116 | \end{description} | 116 | \end{description} |
117 | 117 | ||
118 | \opt{player,recorder,recorderv2fm}{ | 118 | \opt{player,recorder,recorderv2fm}{ |
119 | \subsection{Car Adapter Mode} | 119 | \subsection{Car Adapter Mode} |
120 | This option turns \setting{On} and \setting{Off} the car ignition | 120 | This option turns \setting{On} and \setting{Off} the car ignition |
121 | auto stop function. | 121 | auto stop function. |
122 | \begin{description} | 122 | \begin{description} |
123 | \item [Car Adaptor Mode: ]When using the \dap\ in a car, car adapter mode | 123 | \item [Car Adapter Mode: ]When using the \dap\ in a car, |
124 | automatically stops playback on the \dap\ when power (i.e. from cigarette | 124 | \setting{Car Adapter Mode} automatically stops playback on the \dap\ when |
125 | lighter power adapter) to the external DC in jack is turned off. If the Car | 125 | power (i.e. from cigarette lighter power adapter) to the external DC in jack |
126 | Adaptor Mode is set to \setting{On}, Rockbox will pause playback when the | 126 | is turned off. If the \setting{Car Adapter Mode} is set to \setting{On}, |
127 | external power off condition is detected. Rockbox will then shutdown the | 127 | Rockbox will pause playback when the external power off condition is |
128 | \dap\ after the length of time set in the \setting{Idle Poweroff} setting | 128 | detected. Rockbox will then shutdown the \dap\ after the length of time set |
129 | (see above). | 129 | in the \setting{Idle Poweroff} setting (see above). |
130 | If power to the DC in jack is turned back on before the \emph{Idle Poweroff} | 130 | If power to the DC in jack is turned back on before the \emph{Idle Poweroff} |
131 | function has shut the \dap\ off, playback will be resumed 5 seconds after | 131 | function has shut the \dap\ off, playback will be resumed 5 seconds after |
132 | the power is applied. This delay is to allow for the time while the car | 132 | the power is applied. This delay is to allow for the time while the car |
@@ -134,20 +134,18 @@ This submenu relates to limits in the Rockbox operating system. | |||
134 | \end{description} | 134 | \end{description} |
135 | 135 | ||
136 | Once the \dap\ is shut off either manually, or automatically with the | 136 | Once the \dap\ is shut off either manually, or automatically with the |
137 | \emph{Idle Poweroff} function, it must be powered up manually to resume | 137 | \setting{Idle Poweroff} function, it must be powered up manually to resume |
138 | playback. | 138 | playback. |
139 | } | 139 | } |
140 | 140 | ||
141 | \opt{player}{ | 141 | \opt{player}{ |
142 | \begin{description} | 142 | \subsection{Line In} This option activates the line in port on \dap, which is |
143 | \item [Line In (Player only): ] This option activates the line in port | 143 | off by default. This is useful for such applications as: |
144 | on \dap\ Player, which is off by default. This is useful for such applications as: | ||
145 | \begin{itemize} | 144 | \begin{itemize} |
146 | \item Game boy $\rightarrow$ \dap $\rightarrow$ human | 145 | \item Game boy $\rightarrow$ \dap $\rightarrow$ human |
147 | \item laptop $\rightarrow$ \dap $\rightarrow$ human | 146 | \item laptop $\rightarrow$ \dap $\rightarrow$ human |
148 | \item LAN party computer $\rightarrow$ \dap $\rightarrow$ human | 147 | \item LAN party computer $\rightarrow$ \dap $\rightarrow$ human |
149 | \end{itemize} | 148 | \end{itemize} |
150 | \end{description} | ||
151 | } | 149 | } |
152 | 150 | ||
153 | \subsection{\label{ref:manage_settings}Manage settings} | 151 | \subsection{\label{ref:manage_settings}Manage settings} |
@@ -157,26 +155,26 @@ firmware versions.} | |||
157 | % | 155 | % |
158 | \begin{description} | 156 | \begin{description} |
159 | \item [Browse .cfg Files: ]Opens the file browser in the | 157 | \item [Browse .cfg Files: ]Opens the file browser in the |
160 | \fname{/.rockbox} directory and displays all .cfg (configuration) files. | 158 | \fname{/.rockbox} directory and displays all \fname{.cfg} (configuration) files. |
161 | Selecting a .cfg file will cause Rockbox to load that the settings | 159 | Selecting a \fname{.cfg} file will cause Rockbox to load the settings |
162 | contained in that file. Pressing \ButtonLeft\ will exit back to the menu. | 160 | contained in that file. Pressing \ButtonLeft\ will exit back to the menu. |
163 | See the \setting{Write .cfg files} option on the Manage Settings menu for | 161 | See the \setting{Write .cfg files} option on the \setting{Manage Settings} menu for |
164 | details of how to save and edit a configuration file. | 162 | details of how to save and edit a configuration file. |
165 | % | 163 | % |
166 | \item [Browse Firmwares: ]This displays a list of firmware file in | 164 | \item [Browse Firmwares: ]This displays a list of firmware file in |
167 | the \fname{/.rockbox} system directory. % | 165 | the \fname{/.rockbox} system directory. % |
168 | \opt{SWCODEC}{This is legacy item, and is depreciated.} | 166 | \opt{SWCODEC}{\fixme{This is legacy item, and is depreciated.}} |
169 | \opt{MASCODEC}{ | 167 | \opt{MASCODEC}{% |
170 | \opt{recorder,recorderv2fm}{Firmware files have an extension of .ajz.} | 168 | \opt{recorder,recorderv2fm}{Firmware files have an extension of \fname{.ajz}. }% |
171 | \opt{player,ondio}{ Firmware files have an extension of .mod} | 169 | \opt{player,ondio}{Firmware files have an extension of \fname{.mod}. }% |
172 | Playing a firmware file loads it into memory. Thus, it is possible to | 170 | Playing a firmware file loads it into memory. Thus, it is possible to |
173 | run the original Archos firmware or a different version of Rockbox | 171 | run the original Archos firmware or a different version of Rockbox |
174 | from here assuming that you have the right files installed on your | 172 | from here assuming that you have the right files installed on your |
175 | disk. There is no need for any other file or directory to be installed | 173 | disk. There is no need for any other file or directory to be installed |
176 | to use this option; the firmware is resident in that one file. | 174 | to use this option; the firmware is resident in that one file. |
177 | } | 175 | } |
178 | \item [Reset Settings: ]This wipes the saved settings in the \dap\ and | 176 | \item [Reset Settings: ]This wipes the saved settings in the \dap\ and |
179 | resets all settings to their default values. | 177 | resets all settings to their default values. |
180 | \opt{h100, h300}{\note{You can also reset all settings to their default | 178 | \opt{h100, h300}{\note{You can also reset all settings to their default |
181 | values by turning off the \dap\, turning it back on, and pressing | 179 | values by turning off the \dap\, turning it back on, and pressing |
182 | the \ButtonRec button immediately after the \dap\ turns on.} | 180 | the \ButtonRec button immediately after the \dap\ turns on.} |
@@ -186,15 +184,16 @@ firmware versions.} | |||
186 | extension and is used to store all of the user settings that are described | 184 | extension and is used to store all of the user settings that are described |
187 | throughout this manual. | 185 | throughout this manual. |
188 | A configuration file may reside anywhere on the hard disk. Multiple | 186 | A configuration file may reside anywhere on the hard disk. Multiple |
189 | configuration files are permitted. So, for example, you could have | 187 | configuration files are permitted. So, for example, you could have |
190 | a \fname{car.cfg} file for the settings that you use while playing your | 188 | a \fname{car.cfg} file for the settings that you use while playing your |
191 | jukebox in your car, and a \fname{headphones.cfg} file to store the | 189 | jukebox in your car, and a \fname{headphones.cfg} file to store the |
192 | settings that you use while listening to your \dap\ through headphones. | 190 | settings that you use while listening to your \dap\ through headphones. |
193 | 191 | ||
194 | The Rockbox configuration file is a plain text file, so once you use the | 192 | The Rockbox configuration file is a plain text file, so once you use the |
195 | \setting{Write .cfg file} option to create the file, you can edit the file | 193 | \setting{Write .cfg file} option to create the file, you can edit the file |
196 | on your computer using any text editor program. Configuration files use | 194 | on your computer using any text editor program. See |
197 | the following formatting rules: | 195 | \reference{ref:config_file_options} for available settings. Configuration |
196 | files use the following formatting rules: | ||
198 | % | 197 | % |
199 | \begin{enumerate} | 198 | \begin{enumerate} |
200 | \item Each setting must be on a separate line. | 199 | \item Each setting must be on a separate line. |
@@ -208,16 +207,16 @@ firmware versions.} | |||
208 | Configuration files may be loaded using the \setting{Browse .cfg files} | 207 | Configuration files may be loaded using the \setting{Browse .cfg files} |
209 | option on the \setting{Manage Settings} menu. | 208 | option on the \setting{Manage Settings} menu. |
210 | 209 | ||
211 | \note{Configuration files do not need to contain all of the Rockbox | 210 | \note{Configuration files do not need to contain all of the Rockbox |
212 | options. You can create configuration files that change only certain | 211 | options. You can create configuration files that change only certain |
213 | settings. So, for example, supppose you typically use the \dap at one | 212 | settings. So, for example, supppose you typically use the \dap at one |
214 | volume in the car, and another when using headphones. Further, | 213 | volume in the car, and another when using headphones. Further, |
215 | suppose you like to use an inverse LCD when you're in the car, and | 214 | suppose you like to use an inverse LCD when you're in the car, and |
216 | a regular LCD setting when you're using headphones. You could create | 215 | a regular LCD setting when you're using headphones. You could create |
217 | configuration files that control only the volume and LCD settings. | 216 | configuration files that control only the volume and LCD settings. |
218 | Create a few different files with different settings, give each file | 217 | Create a few different files with different settings, give each file |
219 | a different name (such as \fname{car.cfg}, \fname{headphones.cfg}, | 218 | a different name (such as \fname{car.cfg}, \fname{headphones.cfg}, |
220 | etc.), and you can then use the \setting{Browse .cfg files} option | 219 | etc.), and you can then use the \setting{Browse .cfg files} option |
221 | to quickly change settings.} | 220 | to quickly change settings.} |
222 | \end{description} | 221 | \end{description} |
223 | 222 | ||