summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThom Johansen <thomj@rockbox.org>2007-12-14 00:29:46 +0000
committerThom Johansen <thomj@rockbox.org>2007-12-14 00:29:46 +0000
commitc75d98d5494ab975ba2132d9b045646b19ad7303 (patch)
treeac4e8b42507ae783cf6544ab5dfcfc008d5206f5
parentc8ea4cc3cee93e87dfbe15555350d2442183c799 (diff)
downloadrockbox-c75d98d5494ab975ba2132d9b045646b19ad7303.tar.gz
rockbox-c75d98d5494ab975ba2132d9b045646b19ad7303.zip
Small tweaks/corrections to system options manual section.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@15922 a1c6a512-1295-4272-9138-f99709370657
-rw-r--r--manual/configure_rockbox/system_options.tex33
1 files changed, 19 insertions, 14 deletions
diff --git a/manual/configure_rockbox/system_options.tex b/manual/configure_rockbox/system_options.tex
index 38f446be2e..0a3dfd9a3d 100644
--- a/manual/configure_rockbox/system_options.tex
+++ b/manual/configure_rockbox/system_options.tex
@@ -12,7 +12,7 @@
12 in the \dap. 12 in the \dap.
13 \begin{description} 13 \begin{description}
14 \item [Battery Capacity: ]This setting can be used to tell Rockbox what 14 \item [Battery Capacity: ]This setting can be used to tell Rockbox what
15 capacity (in mAh) of battery is being used inside it. The default is 15 capacity (in mAh) the battery being used has. The default is
16 \opt{player,recorder}{1500mAh}% 16 \opt{player,recorder}{1500mAh}%
17 \opt{recorderv2fm}{2200mAh}% 17 \opt{recorderv2fm}{2200mAh}%
18 \opt{ondiosp,ondiofm}{1000mAh}% 18 \opt{ondiosp,ondiofm}{1000mAh}%
@@ -21,9 +21,10 @@
21 \opt{ipodcolor}{700mAh}% 21 \opt{ipodcolor}{700mAh}%
22 \opt{ipodnano,ipodvideo,ipod4g,ipod3g}{\fixme{unknown}}% 22 \opt{ipodnano,ipodvideo,ipod4g,ipod3g}{\fixme{unknown}}%
23 \opt{x5}{950mAh}% 23 \opt{x5}{950mAh}%
24 , which is the capacity value for the standard batteries shipped with the 24 , which is the capacity value for the standard
25 \dap. Rockbox uses this value to estimate remaining battery life for the 25 \opt{archos}{batteries}\nopt{archos}{battery} shipped with the \dap.
26 statusbar and WPS. Changing this setting has no effect what-so-ever on 26 Rockbox uses this value to estimate remaining battery life for the
27 statusbar and WPS. Changing this setting has no effect whatsoever on
27 actual battery life. This setting only affects the accuracy of the 28 actual battery life. This setting only affects the accuracy of the
28 battery life estimation as shown on screen. 29 battery life estimation as shown on screen.
29 30
@@ -33,8 +34,8 @@
33 34
34 \opt{ondiosp,ondiofm}{ 35 \opt{ondiosp,ondiofm}{
35 \item [Battery Type: ]This setting tells Rockbox which type of battery 36 \item [Battery Type: ]This setting tells Rockbox which type of battery
36 that is currently used in the \dap{}. Select \setting{Alkaline} or 37 is currently used in the \dap{}. The two supported battery types are
37 \setting{NiMH} with \ButtonUp/\ButtonDown. 38 ``Alkaline'' or ``NiMH''.
38 } 39 }
39 \end{description} 40 \end{description}
40 41
@@ -43,6 +44,7 @@
43 Options relating to the hard disk. 44 Options relating to the hard disk.
44 45
45 \begin{description} 46 \begin{description}
47 \nopt{ipodnano}{
46 \item [Disk Spindown: ]Rockbox has a timer that makes it spin down the 48 \item [Disk Spindown: ]Rockbox has a timer that makes it spin down the
47 hard disk after it is idle for a certain amount of time. This setting 49 hard disk after it is idle for a certain amount of time. This setting
48 controls the amount of time between the last user activity and the time 50 controls the amount of time between the last user activity and the time
@@ -50,19 +52,20 @@
50 activity, like navigating through the \setting{File Browser}. When the 52 activity, like navigating through the \setting{File Browser}. When the
51 hard disk spins up to fill the audio buffer, it automatically spins down 53 hard disk spins up to fill the audio buffer, it automatically spins down
52 afterwards. 54 afterwards.
55 }
53 56
54 \opt{SWCODEC}{ 57 \opt{SWCODEC}{
55 \item [Directory Cache: ]Rockbox has the ability to cache the contents of 58 \item [Directory Cache: ]Rockbox has the ability to cache the contents of
56 your drive in RAM. The \setting{Directory Cache} takes a small amount of 59 your drive in RAM. The \setting{Directory Cache} takes a small amount of
57 memory away from Rockbox that would otherwise be used to buffer music, 60 memory away from Rockbox that would otherwise be used to buffer music,
58 but it speeds up navigation in the \setting{File Browser} by eliminating 61 but it speeds up navigation in the file browser by eliminating
59 the slight pause between the time a navigation button is pressed and the 62 the slight pause between the time a navigation button is pressed and the
60 time Rockbox responds. Turning this setting \setting{On} activates the 63 time Rockbox responds. Turning this setting on activates the
61 directory cache, and turning it \setting{Off} deactivates the directory 64 directory cache, and turning it off deactivates the directory
62 cache. 65 cache.
63 \note{The first time you set the directory cache to \setting{On}, 66 \note{The first time you enable the directory cache,
64 Rockbox will request a reboot of the \dap{} and upon restarting take a few 67 Rockbox will request a reboot of the \dap{} and upon restarting take a few
65 minutes to scan the drive. Thereafter, the directory cache will work in the 68 minutes to scan the drive. After this, the directory cache will work in the
66 background.} 69 background.}
67 } 70 }
68 \end{description} 71 \end{description}
@@ -72,8 +75,8 @@
72 \subsection{Time and Date} 75 \subsection{Time and Date}
73 Time related menu options. 76 Time related menu options.
74 \begin{description} 77 \begin{description}
75 \item [Set Time/Date: ]Set current time and date. 78 \item [Set Time/Date: ] Set current time and date.
76 \item [Time Format: ] Choose 12 or 24 Hour clock. 79 \item [Time Format: ] Choose 12 or 24 hour clock.
77 \end{description} 80 \end{description}
78} 81}
79 82
@@ -87,6 +90,7 @@ available.
87 90
88\opt{HAVE_RTC_ALARM}{ 91\opt{HAVE_RTC_ALARM}{
89\subsection{Wake-Up Alarm} 92\subsection{Wake-Up Alarm}
93% TODO this isn't quite right for all targets, I think
90 This option turns the \dap{} off and then starts it up again at the 94 This option turns the \dap{} off and then starts it up again at the
91 specified time. Use \ActionSettingInc{} and \ActionSettingDec{} to adjust 95 specified time. Use \ActionSettingInc{} and \ActionSettingDec{} to adjust
92 the minutes setting, \ActionAlarmHoursDec{} and \ActionAlarmHoursInc{} to adjust the hours. 96 the minutes setting, \ActionAlarmHoursDec{} and \ActionAlarmHoursInc{} to adjust the hours.
@@ -105,7 +109,7 @@ This sub menu relates to limits in the Rockbox operating system.
105 \begin{description} 109 \begin{description}
106 \item [Max files in dir browser: ]This setting controls the limit on 110 \item [Max files in dir browser: ]This setting controls the limit on
107 the number of files that you can put in any particular directory in the 111 the number of files that you can put in any particular directory in the
108 \setting{File Browser}. You can configure the size to be between 50 and 112 file browser. You can configure the size to be between 50 and
109 10,000 files in steps of 50. The default is 400. Higher values will shorten 113 10,000 files in steps of 50. The default is 400. Higher values will shorten
110 the music buffer, so you should increase this setting \emph{only} if you have 114 the music buffer, so you should increase this setting \emph{only} if you have
111 directories with a large number of files. 115 directories with a large number of files.
@@ -140,6 +144,7 @@ This sub menu relates to limits in the Rockbox operating system.
140 playback. 144 playback.
141} 145}
142 146
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?
143\opt{player}{ 148\opt{player}{
144 \subsection{Line In} This option activates the line in port on \dap, which is 149 \subsection{Line In} This option activates the line in port on \dap, which is
145 off by default. This is useful for such applications as: 150 off by default. This is useful for such applications as: