manual/configure_rockbox/system_options.tex

   1 % $Id$ %
   2 \section{\label{ref:SystemOptions}System}
   3 \subsection{Start Screen}
   4     Set the screen that Rockbox will start in. Selecting
   5     \setting{Resume Playback} will resume playback where it was when the \dap{}
   6     was shut off if there is a playlist to resume and will then end up in the
   7     WPS. Selecting \setting{Previous Screen} will make Rockbox start in the
   8     screen it was when the \dap{} was shut off.
   9
  10 \nopt{sansa}%will probably be there on Sansas one day -  exclude it the simple way without specific option
  11 {
  12   \subsection{Battery}
  13   Options relating to the \opt{archos}{batteries}\nopt{archos}{battery}
  14   in the \dap.
  15   \begin{description}
  16     \item [Battery Capacity: ]This setting can be used to tell Rockbox what
  17       capacity (in mAh) the battery being used has. The default is
  18       \opt{player,recorder}{1500mAh}%
  19       \opt{recorderv2fm}{2200mAh}%
  20       \opt{ondiosp,ondiofm}{1000mAh}%
  21       \opt{h1xx,h300}{1300mAh}%
  22       \opt{ipodmini}{400mAh (1G) or 630mAh (2G)}%
  23       \opt{ipodcolor}{700mAh}%
  24       \opt{ipodnano,ipodvideo,ipod4g,ipod3g}{\fixme{unknown}}%
  25       \opt{m5,x5}{950mAh}%
  26       , which is the capacity value for the standard
  27       \opt{archos}{batteries}\nopt{archos}{battery} shipped with the \dap.
  28         Rockbox uses this value to estimate remaining battery life for the
  29         info screen and WPS. Changing this setting has no effect whatsoever on
  30         actual battery life. This setting only affects the accuracy of the
  31         battery life estimation as shown on screen.
  32       \opt{iaudio}{Rockbox does not automatically distinguish between the
  33         ``L'' models and the ``simple'' models which determine the default
  34         value. If your dap{} is an \opt{m5}{M5L}\opt{x5}{X5L} set the value
  35         to 2250mAh for more accuracy in the runtime estimation.}
  36       \opt{ipod,sansa}{This value is fairly meaningless in the \playerman{}
  37         family at present, and work is on-going into finding a better way to
  38         determine battery life.}
  39
  40       \opt{BATTERY_TYPES}{%Ondios only (currently), following the lang features.txt
  41       \item [Battery Type: ]This setting tells Rockbox which type of battery
  42         is currently used in the \dap{}. The two supported battery types are
  43         ``Alkaline'' or ``NiMH''.}
  44
  45       \opt{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{dircache,HAVE_DISK_STORAGE}{
  56 \subsection{Disk}
  57     Options relating to the hard disk.
  58
  59   \begin{description}
  60     \opt{HAVE_DISK_STORAGE}{
  61     \item [Disk Spindown: ]Rockbox has a timer that makes it spin down the
  62       hard disk after it is idle for a certain amount of time. This setting
  63       controls the amount of time between the last user activity and the time
  64       that the disk spins down. This idle time is only affected by user
  65       activity, like navigating through the \setting{File Browser}. When the
  66       hard disk spins up to fill the audio buffer, it automatically spins down
  67       afterwards.
  68     }
  69
  70     \opt{dircache}{
  71     \item [Directory Cache: ]Rockbox has the ability to cache the contents of
  72       your drive in RAM. The \setting{Directory Cache} takes a small amount of
  73       memory away from Rockbox that would otherwise be used to buffer music,
  74       but it speeds up navigation in the file browser by eliminating
  75       the slight pause between the time a navigation button is pressed and the
  76       time Rockbox responds. Turning this setting on activates the
  77       directory cache, and turning it off deactivates the directory
  78       cache.
  79       \note{The first time you enable the directory cache,
  80       Rockbox will request a reboot of the \dap{} and upon restarting take a few
  81       minutes to scan the drive. After this, the directory cache will work in the
  82       background.}
  83     }
  84   \end{description}
  85 } % \opt{dircache,HAVE_DISK_STORAGE}
  86
  87 \opt{rtc}{
  88   \subsection{Time and Date}
  89   Time related menu options.
  90     \begin{description}
  91       \item [Set Time/Date: ] Set current time and date.
  92       \item [Time Format: ] Choose 12 or 24 hour clock.
  93     \end{description}
  94 }
  95
  96 \subsection{Idle Poweroff}
  97 Rockbox can be configured to turn off power after the unit has been idle for a
  98 defined number of minutes. The \dap{} is idle when playback is stopped or
  99 paused. It is not idle while the USB or charger is connected
 100 \opt{recording}{, or while recording}.
 101 Settings are either \setting{Off} or \setting{1} to \setting{10}
 102 minutes in 1 minute steps. Then \setting{15,30,45} and \setting{60} minutes are
 103 available.
 104
 105 \opt{alarm}{
 106 \subsection{Wake-Up Alarm}
 107 % TODO this isn't quite right for all targets, I think
 108     This option turns the \dap{} off and then starts it up again at the
 109     specified time. Use \ActionSettingInc{} and \ActionSettingDec{} to adjust
 110     the minutes setting, \ActionAlarmHoursDec{} and \ActionAlarmHoursInc{} to
 111     adjust the hours.
 112     \ActionAlarmSet{} confirms the alarm and shuts the \dap{} down, and
 113     \ActionAlarmCancel{} cancels setting an alarm. If the \dap{} is turned on
 114     again before the alarm occurs, the alarm will be cancelled. Using this
 115     option disables the \setting{Sleep Timer}.
 116
 117   \opt{recording,radio}{
 118     \subsection{Alarm Wake up Screen}
 119     This option controls what the \dap{} does when it is woken up by the alarm.
 120   }
 121 }
 122
 123 \subsection{Limits}
 124 This sub menu relates to limits in the Rockbox operating system.
 125   \begin{description}
 126     \item [Max Entries in File Browser: ]This setting controls the limit on
 127     the number of files that you can put in any particular directory in the
 128     file browser. You can configure the size to be between 50 and
 129     10,000 files in steps of 50. The default is 400. Higher values will shorten
 130     the music buffer, so you should increase this setting \emph{only} if you have
 131     directories with a large number of files.
 132
 133     \item [Max Playlist Size: ]This setting controls the maximum size of
 134     a playlist. The playlist size can be between 1,000 and 32,000 files,
 135     in steps of 1,000 (default is 10,000). Higher values will shorten the
 136     music buffer, so you should increase this setting \emph{only} if you
 137     have very large playlists.
 138   \end{description}
 139
 140 % TODO: this needs to be rewritten in another style, it lets you mix sound from another source into the music
 141 \opt{player}{
 142   \subsection{Line In} This option activates the line in port on \dap, which is
 143     off by default. This is useful for such applications as:
 144     \begin{itemize}
 145     \item Game boy $\rightarrow$ \dap $\rightarrow$ human
 146     \item laptop $\rightarrow$ \dap $\rightarrow$ human
 147     \item LAN party computer $\rightarrow$ \dap $\rightarrow$ human
 148     \end{itemize}
 149 }
 150
 151 \opt{HAVE_CAR_ADAPTER_MODE}{
 152 \subsection{Car Adapter Mode}
 153       This option turns \setting{On} and \setting{Off} the car ignition
 154       auto stop function.
 155   \begin{description}
 156   \item [Car Adapter Mode: ]When using the \dap{} in a car,
 157   \setting{Car Adapter Mode} automatically stops playback on the \dap{} when
 158   power (i.e. from cigarette lighter power adapter) to the external DC in jack
 159   is turned off. If the \setting{Car Adapter Mode} is set to \setting{On},
 160   Rockbox will pause playback when the external power off condition is
 161   detected. Rockbox will then shutdown the \dap{} after the length of time set
 162   in the \setting{Idle Poweroff} setting (see above).
 163   If power to the DC in jack is turned back on before the \emph{Idle Poweroff}
 164   function has shut the \dap{} off, playback will be resumed 5 seconds after
 165   the power is applied. This delay is to allow for the time while the car
 166   engine is being started.
 167   \end{description}
 168
 169   Once the \dap{} is shut off either manually, or automatically with the
 170   \setting{Idle Poweroff} function, it must be powered up manually to resume
 171   playback.
 172 }
 173
 174 \opt{HAVE_BUTTON_LIGHTS}{
 175   \opt{e200}{
 176   \subsection{Wheel Light Timeout}
 177     This setting controls the amount of time the wheel lights shine after a
 178     button press or wheel turn. If set to \setting{Off}, the LEDs will not
 179     light when a button is pressed. If set to \setting{On}, the lights will
 180     never shut off. If set to a time (1 to 120 seconds), the wheel will stay
 181     lit for that amount of time after a button press or wheel turn.
 182   }
 183   \nopt{e200}{
 184   \subsection{Button Light Timeout}
 185     This setting controls the amount of time the button lights shine after a
 186     button press. If set to \setting{Off}, the LEDs will not light when a
 187     button is pressed. If set to \setting{On}, the lights will never shut off.
 188     If set to a time (1 to 120 seconds), the buttons will stay lit for
 189     that amount of time after a button press.
 190   }
 191   \opt{gigabeatf}{
 192     \subsection{Button Light Brightness}
 193       Changes the brightness of the button lights.
 194   }
 195 }