summaryrefslogtreecommitdiff
path: root/manual/configure_rockbox/system_options.tex
diff options
context:
space:
mode:
Diffstat (limited to 'manual/configure_rockbox/system_options.tex')
-rw-r--r--manual/configure_rockbox/system_options.tex110
1 files changed, 74 insertions, 36 deletions
diff --git a/manual/configure_rockbox/system_options.tex b/manual/configure_rockbox/system_options.tex
index 0a3dfd9a3d..cfecf36c76 100644
--- a/manual/configure_rockbox/system_options.tex
+++ b/manual/configure_rockbox/system_options.tex
@@ -7,9 +7,11 @@
7 WPS. Selecting \setting{Previous Screen} will make Rockbox start in the 7 WPS. Selecting \setting{Previous Screen} will make Rockbox start in the
8 screen it was when the \dap{} was shut off. 8 screen it was when the \dap{} was shut off.
9 9
10\subsection{Battery} 10\nopt{sansa}%will probably be there on Sansas one day - exclude it the simple way without specific option
11 Options relating to the \opt{archos}{batteries}\nopt{archos}{battery} 11{
12 in the \dap. 12 \subsection{Battery}
13 Options relating to the \opt{archos}{batteries}\nopt{archos}{battery}
14 in the \dap.
13 \begin{description} 15 \begin{description}
14 \item [Battery Capacity: ]This setting can be used to tell Rockbox what 16 \item [Battery Capacity: ]This setting can be used to tell Rockbox what
15 capacity (in mAh) the battery being used has. The default is 17 capacity (in mAh) the battery being used has. The default is
@@ -20,31 +22,42 @@
20 \opt{ipodmini}{400mAh (1G) or 630mAh (2G)}% 22 \opt{ipodmini}{400mAh (1G) or 630mAh (2G)}%
21 \opt{ipodcolor}{700mAh}% 23 \opt{ipodcolor}{700mAh}%
22 \opt{ipodnano,ipodvideo,ipod4g,ipod3g}{\fixme{unknown}}% 24 \opt{ipodnano,ipodvideo,ipod4g,ipod3g}{\fixme{unknown}}%
23 \opt{x5}{950mAh}% 25 \opt{m5,x5}{950mAh}%
24 , which is the capacity value for the standard 26 , which is the capacity value for the standard
25 \opt{archos}{batteries}\nopt{archos}{battery} shipped with the \dap. 27 \opt{archos}{batteries}\nopt{archos}{battery} shipped with the \dap.
26 Rockbox uses this value to estimate remaining battery life for the 28 Rockbox uses this value to estimate remaining battery life for the
27 statusbar and WPS. Changing this setting has no effect whatsoever on 29 info screen and WPS. Changing this setting has no effect whatsoever on
28 actual battery life. This setting only affects the accuracy of the 30 actual battery life. This setting only affects the accuracy of the
29 battery life estimation as shown on screen. 31 battery life estimation as shown on screen.
30 32 \opt{iaudio}{Rockbox does not automatically distinguish between the
31 \opt{ipod}{This value is fairly meaningless in the \playerman{} family at 33 ``L'' models and the ``simple'' models which determine the default
32 present, and work is on-going into finding a better way to determine 34 value. If your dap{} is an \opt{m5}{M5L}\opt{x5}{X5L} set the value
33 battery life.} 35 to 2250mAh for more accuracy in the runtime estimation.}
34 36 \opt{ipod,sansa}{This value is fairly meaningless in the \playerman{}
35 \opt{ondiosp,ondiofm}{ 37 family at present, and work is on-going into finding a better way to
36 \item [Battery Type: ]This setting tells Rockbox which type of battery 38 determine battery life.}
37 is currently used in the \dap{}. The two supported battery types are 39
38 ``Alkaline'' or ``NiMH''. 40 \opt{BATTERY_TYPES}{%Ondios only (currently), following the lang features.txt
39 } 41 \item [Battery Type: ]This setting tells Rockbox which type of battery
40 \end{description} 42 is currently used in the \dap{}. The two supported battery types are
43 ``Alkaline'' or ``NiMH''.}
41 44
42\nopt{ondiosp,ondiofm}{ 45 \opt{HAVE_USB_CHARGING}{
46%TODO: check where it is working correctly (except H300) and append the option to the respective platform file
47 \item [Charge During USB Connection: ]This option lets you control whether
48 the \dap{} should charge during the USB connection and hence draw the
49 full 500mA. Turning it \setting{Off} is recommended if the dap{} is
50 connected through an unpowered USB hub or a laptop port.
51 }
52
53 \end{description}
54}
55\opt{HAVE_DIRCACHE,HAVE_DISK_STORAGE}{
43\subsection{Disk} 56\subsection{Disk}
44 Options relating to the hard disk. 57 Options relating to the hard disk.
45 58
46 \begin{description} 59 \begin{description}
47 \nopt{ipodnano}{ 60 \opt{HAVE_DISK_STORAGE}{
48 \item [Disk Spindown: ]Rockbox has a timer that makes it spin down the 61 \item [Disk Spindown: ]Rockbox has a timer that makes it spin down the
49 hard disk after it is idle for a certain amount of time. This setting 62 hard disk after it is idle for a certain amount of time. This setting
50 controls the amount of time between the last user activity and the time 63 controls the amount of time between the last user activity and the time
@@ -54,7 +67,7 @@
54 afterwards. 67 afterwards.
55 } 68 }
56 69
57 \opt{SWCODEC}{ 70 \opt{HAVE_DIRCACHE}{
58 \item [Directory Cache: ]Rockbox has the ability to cache the contents of 71 \item [Directory Cache: ]Rockbox has the ability to cache the contents of
59 your drive in RAM. The \setting{Directory Cache} takes a small amount of 72 your drive in RAM. The \setting{Directory Cache} takes a small amount of
60 memory away from Rockbox that would otherwise be used to buffer music, 73 memory away from Rockbox that would otherwise be used to buffer music,
@@ -69,7 +82,7 @@
69 background.} 82 background.}
70 } 83 }
71 \end{description} 84 \end{description}
72} % \nopt{ondiosp,ondiofm} 85} % \opt{HAVE_DIRCACHE,HAVE_DISK_STORAGE}
73 86
74\opt{CONFIG_RTC}{ 87\opt{CONFIG_RTC}{
75 \subsection{Time and Date} 88 \subsection{Time and Date}
@@ -93,15 +106,17 @@ available.
93% TODO this isn't quite right for all targets, I think 106% TODO this isn't quite right for all targets, I think
94 This option turns the \dap{} off and then starts it up again at the 107 This option turns the \dap{} off and then starts it up again at the
95 specified time. Use \ActionSettingInc{} and \ActionSettingDec{} to adjust 108 specified time. Use \ActionSettingInc{} and \ActionSettingDec{} to adjust
96 the minutes setting, \ActionAlarmHoursDec{} and \ActionAlarmHoursInc{} to adjust the hours. 109 the minutes setting, \ActionAlarmHoursDec{} and \ActionAlarmHoursInc{} to
110 adjust the hours.
97 \ActionAlarmSet{} confirms the alarm and shuts the \dap{} down, and 111 \ActionAlarmSet{} confirms the alarm and shuts the \dap{} down, and
98 \ActionAlarmCancel{} cancels setting an alarm. If the \dap{} is turned on 112 \ActionAlarmCancel{} cancels setting an alarm. If the \dap{} is turned on
99 again before the alarm occurs, the alarm will be cancelled. Using this 113 again before the alarm occurs, the alarm will be cancelled. Using this
100 option disables the \setting{Sleep Timer}. 114 option disables the \setting{Sleep Timer}.
101 115
116 \opt{HAVE_RECORDING,CONFIG_TUNER}{
102 \subsection{Alarm Wake up Screen} 117 \subsection{Alarm Wake up Screen}
103 This option controls what the \dap{} does when it is woken up by the alarm. 118 This option controls what the \dap{} does when it is woken up by the alarm.
104 119 }
105} 120}
106 121
107\subsection{Limits} 122\subsection{Limits}
@@ -114,14 +129,25 @@ This sub menu relates to limits in the Rockbox operating system.
114 the music buffer, so you should increase this setting \emph{only} if you have 129 the music buffer, so you should increase this setting \emph{only} if you have
115 directories with a large number of files. 130 directories with a large number of files.
116 131
117 \item [Max playlist size: ]This setting controls the maximum size of 132 \item [Max playlist size: ]This setting controls the maximum size of
118 a playlist. The playlist size can be between 1,000 and 32,000 files, 133 a playlist. The playlist size can be between 1,000 and 32,000 files,
119 in steps of 1,000 (default is 10,000). Higher values will shorten the 134 in steps of 1,000 (default is 10,000). Higher values will shorten the
120 music buffer, so you should increase this setting \emph{only} if you 135 music buffer, so you should increase this setting \emph{only} if you
121 have very large playlists. 136 have very large playlists.
122 \end{description} 137 \end{description}
123 138
124\opt{player,recorder,recorderv2fm,gigabeat,ipodvideo,iriver,iaudio,e200}{ 139% TODO: this needs to be rewritten in another style, it lets you mix sound from another source into the music
140\opt{player}{
141 \subsection{Line In} This option activates the line in port on \dap, which is
142 off by default. This is useful for such applications as:
143 \begin{itemize}
144 \item Game boy $\rightarrow$ \dap $\rightarrow$ human
145 \item laptop $\rightarrow$ \dap $\rightarrow$ human
146 \item LAN party computer $\rightarrow$ \dap $\rightarrow$ human
147 \end{itemize}
148}
149
150\opt{HAVE_CAR_ADAPTER_MODE}{
125\subsection{Car Adapter Mode} 151\subsection{Car Adapter Mode}
126 This option turns \setting{On} and \setting{Off} the car ignition 152 This option turns \setting{On} and \setting{Off} the car ignition
127 auto stop function. 153 auto stop function.
@@ -144,13 +170,25 @@ This sub menu relates to limits in the Rockbox operating system.
144 playback. 170 playback.
145} 171}
146 172
147% TODO: this needs to be rewritten in another style, but i really don't know what kind of "line in" this describes... isn't it used for recording? 173\opt{HAVE_BUTTON_LIGHTS}{
148\opt{player}{ 174 \opt{e200}{
149 \subsection{Line In} This option activates the line in port on \dap, which is 175 \subsection{Wheel Light Timeout}
150 off by default. This is useful for such applications as: 176 This setting controls the amount of time the wheel lights shine after a
151 \begin{itemize} 177 button press or wheel turn. If set to \setting{Off}, the LEDs will not
152 \item Game boy $\rightarrow$ \dap $\rightarrow$ human 178 light when a button is pressed. If set to \setting{On}, the lights will
153 \item laptop $\rightarrow$ \dap $\rightarrow$ human 179 never shut off. If set to a time (1 to 120 seconds), the wheel will stay
154 \item LAN party computer $\rightarrow$ \dap $\rightarrow$ human 180 lit for that amount of time after a button press or wheel turn.
155 \end{itemize} 181 }
182 \nopt{e200}{
183 \subsection{Button Light Timeout}
184 This setting controls the amount of time the button lights shine after a
185 button press. If set to \setting{Off}, the LEDs will not light when a
186 button is pressed. If set to \setting{On}, the lights will never shut off.
187 If set to a time (1 to 120 seconds), the buttons will stay lit for
188 that amount of time after a button press.
189 }
190 \opt{gigabeatf}{
191 \subsection{Button Light Brightness}
192 Changes the brightness of the button lights.
193 }
156} 194}