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{h100,h300}{1300mAh}%
  22       \opt{ipodmini}{400mAh (1G) or 630mAh (2G)}%
  23       \opt{ipodcolor}{700mAh}%
  24       \opt{ipodnano}{300mAh}%
  25       \opt{ipodvideo}{400mAh (30GB) or 600mAh (60/80GB)}%
  26       \opt{ipod4g}{630mAh}%
  27       \opt{ipod3g}{630mAh}%
  28       \opt{ipod1g2g}{1200mAh}%
  29       \opt{m5,x5}{950mAh}%
  30       \opt{gigabeatf}{2000mAh}%
  31       \opt{gigabeats}{700mAh}%
  32       , which is the capacity value for the standard
  33       \opt{archos}{batteries}\nopt{archos}{battery} shipped with the \dap.
  34         Rockbox uses this value for runtime estimation, not battery percentage
  35         calculation. Changing this setting has no effect whatsoever on
  36         actual battery life. This setting only affects the accuracy of the
  37         runtime estimation as shown on screen.
  38       \opt{iaudio}{Rockbox does not automatically distinguish between the
  39         ``L'' models and the ``simple'' models which determine the default
  40         value. If your dap{} is an \opt{m5}{M5L}\opt{x5}{X5L} set the value
  41         to 2250mAh for more accuracy in the runtime estimation.}
  42       \opt{ipod,sansa}{This value is fairly meaningless in the \playerman{}
  43         family at present, and work is on-going into finding a better way to
  44         determine battery life.}
  45
  46       \opt{battery_types}{
  47       \item [Battery Type: ]This setting tells Rockbox which type of battery
  48         is currently used in the \dap{}. The two supported battery types are
  49         ``Alkaline'' or ``NiMH''.}
  50
  51       \opt{usb_charging}{
  52       \item [Charge During USB Connection: ]This option lets you control whether
  53         the \dap{} should charge during the USB connection and hence draw the
  54         full 500mA. Turning it \setting{Off} is recommended if the dap{} is
  55         connected through an unpowered USB hub or a laptop port.
  56       }
  57
  58      \end{description}
  59 }
  60 \opt{dircache,HAVE_DISK_STORAGE}{
  61 \subsection{Disk}
  62     Options relating to the hard disk.
  63
  64   \begin{description}
  65     \opt{HAVE_DISK_STORAGE}{
  66     \item [Disk Spindown: ]Rockbox has a timer that makes it spin down the
  67       hard disk after it is idle for a certain amount of time. This setting
  68       controls the amount of time between the last user activity and the time
  69       that the disk spins down. This idle time is only affected by user
  70       activity, like navigating through the \setting{File Browser}. When the
  71       hard disk spins up to fill the audio buffer, it automatically spins down
  72       afterwards.
  73     }
  74
  75     \opt{dircache}{
  76     \item [Directory Cache: ]Rockbox has the ability to cache the contents of
  77       your drive in RAM. The \setting{Directory Cache} takes a small amount of
  78       memory away from Rockbox that would otherwise be used to buffer music,
  79       but it speeds up navigation in the file browser by eliminating
  80       the slight pause between the time a navigation button is pressed and the
  81       time Rockbox responds. Turning this setting on activates the
  82       directory cache, and turning it off deactivates the directory
  83       cache.
  84       \note{The first time you enable the directory cache,
  85       Rockbox will request a reboot of the \dap{} and upon restarting take a few
  86       minutes to scan the drive. After this, the directory cache will work in the
  87       background.}
  88     }
  89   \end{description}
  90 } % \opt{dircache,HAVE_DISK_STORAGE}
  91
  92 \subsection{Idle Poweroff}
  93 Rockbox can be configured to turn off power after the unit has been idle for a
  94 defined number of minutes. The \dap{} is idle when playback is stopped or
  95 paused. It is not idle while the USB or charger is connected
  96 \opt{recording}{, or while recording}.
  97 Settings are either \setting{Off} or \setting{1} to \setting{10}
  98 minutes in 1 minute steps. Then \setting{15,30,45} and \setting{60} minutes are
  99 available.
 100
 101
 102 \subsection{Limits}
 103 This sub menu relates to limits in the Rockbox operating system.
 104   \begin{description}
 105     \item [Max Entries in File Browser: ]This setting controls the limit on
 106     the number of files that you can put in any particular directory in the
 107     file browser. You can configure the size to be between 50 and
 108     10,000 files in steps of 50. The default is 400. Higher values will shorten
 109     the music buffer, so you should increase this setting \emph{only} if you have
 110     directories with a large number of files.
 111
 112     \item [Max Playlist Size: ]This setting controls the maximum size of
 113     a playlist. The playlist size can be between 1,000 and 32,000 files,
 114     in steps of 1,000 (default is 10,000). Higher values will shorten the
 115     music buffer, so you should increase this setting \emph{only} if you
 116     have very large playlists.
 117   \end{description}
 118
 119 % TODO: this needs to be rewritten in another style, it lets you mix sound from another source into the music
 120 \opt{player}{
 121   \subsection{Line In} This option activates the line in port on \dap, which is
 122     off by default. This is useful for such applications as:
 123     \begin{itemize}
 124     \item Game boy $\rightarrow$ \dap $\rightarrow$ human
 125     \item laptop $\rightarrow$ \dap $\rightarrow$ human
 126     \item LAN party computer $\rightarrow$ \dap $\rightarrow$ human
 127     \end{itemize}
 128 }
 129
 130 \opt{HAVE_CAR_ADAPTER_MODE}{
 131 \subsection{Car Adapter Mode}
 132       This option turns \setting{On} and \setting{Off} the car ignition
 133       auto stop function.
 134   \begin{description}
 135   \item [Car Adapter Mode: ]When using the \dap{} in a car,
 136   \setting{Car Adapter Mode} automatically stops playback on the \dap{} when
 137   power (i.e. from cigarette lighter power adapter) to the external DC in jack
 138   is turned off. If the \setting{Car Adapter Mode} is set to \setting{On},
 139   Rockbox will pause playback when the external power off condition is
 140   detected. Rockbox will then shutdown the \dap{} after the length of time set
 141   in the \setting{Idle Poweroff} setting (see above).
 142   If power to the DC in jack is turned back on before the \emph{Idle Poweroff}
 143   function has shut the \dap{} off, playback will be resumed 5 seconds after
 144   the power is applied. This delay is to allow for the time while the car
 145   engine is being started.
 146   \end{description}
 147
 148   Once the \dap{} is shut off either manually, or automatically with the
 149   \setting{Idle Poweroff} function, it must be powered up manually to resume
 150   playback.
 151 }
 152
 153 \opt{accessory_supply}{
 154 \subsection{Accessory Power Supply}
 155 This option turns the accessory power supply \setting{On} and \setting{Off}.
 156 The Apple accessory protocol has been partially implemented in Rockbox, and
 157 thus there is a reasonable chance that your favourite accessory will work.
 158 The accessory may require power from the \dap{} to function, and if so you should turn
 159 this option \setting{On}. If it is not required, then turning this setting
 160 \setting{Off} will save battery and therefore result in better runtime.
 161 }
 162
 163 \opt{HAVE_BUTTON_LIGHTS}{
 164   \opt{e200}{
 165   \subsection{Wheel Light Timeout}
 166     This setting controls the amount of time the wheel lights shine after a
 167     button press or wheel turn. If set to \setting{Off}, the LEDs will not
 168     light when a button is pressed. If set to \setting{On}, the lights will
 169     never shut off. If set to a time (1 to 120 seconds), the wheel will stay
 170     lit for that amount of time after a button press or wheel turn.
 171   }
 172   \nopt{e200}{
 173   \subsection{Button Light Timeout}
 174     This setting controls the amount of time the button lights shine after a
 175     button press. If set to \setting{Off}, the LEDs will not light when a
 176     button is pressed. If set to \setting{On}, the lights will never shut off.
 177     If set to a time (1 to 120 seconds), the buttons will stay lit for
 178     that amount of time after a button press.
 179   }
 180   \opt{gigabeatf}{
 181     \subsection{Button Light Brightness}
 182       Changes the brightness of the button lights.
 183   }
 184 }