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