rockbox/manual/configure_rockbox/system_options.tex

% $Id$ %
\section{\label{ref:SystemOptions}System}
\subsection{Start Screen}
    Set the screen that Rockbox will start in. Selecting
    \setting{Resume Playback} will resume playback where it was when the \dap{}
    was shut off if there is a playlist to resume and will then end up in the
    WPS. Selecting \setting{Previous Screen} will make Rockbox start in the
    screen it was when the \dap{} was shut off.

\nopt{sansa}%will probably be there on Sansas one day -  exclude it the simple way without specific option
{
  \subsection{Battery}
  Options relating to the \opt{archos}{batteries}\nopt{archos}{battery}
  in the \dap.
  \begin{description}
    \item [Battery Capacity: ]This setting can be used to tell Rockbox what
      capacity (in mAh) the battery being used has. The default is
      \opt{player,recorder}{1500mAh}%
      \opt{recorderv2fm}{2200mAh}%
      \opt{ondiosp,ondiofm}{1000mAh}%
      \opt{h100,h300}{1300mAh}%
      \opt{ipodmini}{400mAh (1G) or 630mAh (2G)}%
      \opt{ipodcolor}{700mAh}%
      \opt{ipodnano}{300mAh}%
      \opt{ipodvideo}{400mAh (30GB) or 600mAh (60/80GB)}%
      \opt{ipod4g}{630mAh}%
      \opt{ipod3g}{630mAh}%
      \opt{ipod1g2g}{1200mAh}%
      \opt{m5,x5}{950mAh}%
      \opt{gigabeatf}{2000mAh}%
      \opt{gigabeats}{700mAh}%
      , which is the capacity value for the standard
      \opt{archos}{batteries}\nopt{archos}{battery} shipped with the \dap.
        Rockbox uses this value for runtime estimation, not battery percentage
        calculation. Changing this setting has no effect whatsoever on
        actual battery life. This setting only affects the accuracy of the
        runtime estimation as shown on screen.
      \opt{iaudio}{Rockbox does not automatically distinguish between the
        ``L'' models and the ``simple'' models which determine the default
        value. If your dap{} is an \opt{m5}{M5L}\opt{x5}{X5L} set the value
        to 2250mAh for more accuracy in the runtime estimation.}
      \opt{ipod,sansa}{This value is fairly meaningless in the \playerman{}
        family at present, and work is on-going into finding a better way to
        determine battery life.}

      \opt{battery_types}{
      \item [Battery Type: ]This setting tells Rockbox which type of battery
        is currently used in the \dap{}. The two supported battery types are
        ``Alkaline'' or ``NiMH''.}

      \opt{usb_charging}{
      \item [Charge During USB Connection: ]This option lets you control whether
        the \dap{} should charge during the USB connection and hence draw the
        full 500mA. Turning it \setting{Off} is recommended if the dap{} is
        connected through an unpowered USB hub or a laptop port.
      }

     \end{description}
}
\opt{dircache,HAVE_DISK_STORAGE}{
\subsection{Disk}
    Options relating to the hard disk.

  \begin{description}
    \opt{HAVE_DISK_STORAGE}{
    \item [Disk Spindown: ]Rockbox has a timer that makes it spin down the
      hard disk after it is idle for a certain amount of time. This setting
      controls the amount of time between the last user activity and the time
      that the disk spins down. This idle time is only affected by user
      activity, like navigating through the \setting{File Browser}. When the
      hard disk spins up to fill the audio buffer, it automatically spins down
      afterwards.
    }

    \opt{dircache}{
    \item [Directory Cache: ]Rockbox has the ability to cache the contents of
      your drive in RAM. The \setting{Directory Cache} takes a small amount of
      memory away from Rockbox that would otherwise be used to buffer music,
      but it speeds up navigation in the file browser by eliminating
      the slight pause between the time a navigation button is pressed and the
      time Rockbox responds. Turning this setting on activates the
      directory cache, and turning it off deactivates the directory
      cache.
      \note{The first time you enable the directory cache,
      Rockbox will request a reboot of the \dap{} and upon restarting take a few
      minutes to scan the drive. After this, the directory cache will work in the
      background.}
    }
  \end{description}
} % \opt{dircache,HAVE_DISK_STORAGE}

\subsection{Idle Poweroff}
Rockbox can be configured to turn off power after the unit has been idle for a
defined number of minutes. The \dap{} is idle when playback is stopped or
paused. It is not idle while the USB or charger is connected
\opt{recording}{, or while recording}. 
Settings are either \setting{Off} or \setting{1} to \setting{10}
minutes in 1 minute steps. Then \setting{15,30,45} and \setting{60} minutes are
available.


\subsection{Limits}
This sub menu relates to limits in the Rockbox operating system.
  \begin{description}
    \item [Max Entries in File Browser: ]This setting controls the limit on
    the number of files that you can put in any particular directory in the
    file browser. You can configure the size to be between 50 and
    10,000 files in steps of 50. The default is 400. Higher values will shorten
    the music buffer, so you should increase this setting \emph{only} if you have
    directories with a large number of files.

    \item [Max Playlist Size: ]This setting controls the maximum size of
    a playlist. The playlist size can be between 1,000 and 32,000 files,
    in steps of 1,000 (default is 10,000). Higher values will shorten the
    music buffer, so you should increase this setting \emph{only} if you
    have very large playlists.
  \end{description}

% TODO: this needs to be rewritten in another style, it lets you mix sound from another source into the music
\opt{player}{
  \subsection{Line In} This option activates the line in port on \dap, which is
    off by default. This is useful for such applications as:
    \begin{itemize}
    \item Game boy $\rightarrow$ \dap $\rightarrow$ human
    \item laptop $\rightarrow$ \dap $\rightarrow$ human
    \item LAN party computer $\rightarrow$ \dap $\rightarrow$ human
    \end{itemize}
}

\opt{HAVE_CAR_ADAPTER_MODE}{
\subsection{Car Adapter Mode}
      This option turns \setting{On} and \setting{Off} the car ignition
      auto stop function.
  \begin{description}
  \item [Car Adapter Mode: ]When using the \dap{} in a car,
  \setting{Car Adapter Mode} automatically stops playback on the \dap{} when
  power (i.e. from cigarette lighter power adapter) to the external DC in jack
  is turned off. If the \setting{Car Adapter Mode} is set to \setting{On},
  Rockbox will pause playback when the external power off condition is
  detected. Rockbox will then shutdown the \dap{} after the length of time set
  in the \setting{Idle Poweroff} setting (see above).
  If power to the DC in jack is turned back on before the \emph{Idle Poweroff}
  function has shut the \dap{} off, playback will be resumed 5 seconds after
  the power is applied. This delay is to allow for the time while the car
  engine is being started.
  \end{description}

  Once the \dap{} is shut off either manually, or automatically with the
  \setting{Idle Poweroff} function, it must be powered up manually to resume
  playback.
}

\opt{accessory_supply}{
\subsection{Accessory Power Supply}
This option turns the accessory power supply \setting{On} and \setting{Off}.
The Apple accessory protocol has been partially implemented in Rockbox, and
thus there is a reasonable chance that your favourite accessory will work.
The accessory may require power from the \dap{} to function, and if so you should turn
this option \setting{On}. If it is not required, then turning this setting
\setting{Off} will save battery and therefore result in better runtime.
} 

\opt{HAVE_BUTTON_LIGHTS}{
  \opt{e200}{
  \subsection{Wheel Light Timeout}
    This setting controls the amount of time the wheel lights shine after a
    button press or wheel turn. If set to \setting{Off}, the LEDs will not
    light when a button is pressed. If set to \setting{On}, the lights will
    never shut off. If set to a time (1 to 120 seconds), the wheel will stay
    lit for that amount of time after a button press or wheel turn.
  }
  \nopt{e200}{
  \subsection{Button Light Timeout}
    This setting controls the amount of time the button lights shine after a
    button press. If set to \setting{Off}, the LEDs will not light when a
    button is pressed. If set to \setting{On}, the lights will never shut off.
    If set to a time (1 to 120 seconds), the buttons will stay lit for
    that amount of time after a button press.
  }
  \opt{gigabeatf}{
    \subsection{Button Light Brightness}
      Changes the brightness of the button lights.
  }
}
\opt{USB_ENABLE_HID}{
  \subsection{USB keypad Mode}
    This setting control the keypad mode when the \dap{} is attached to a
    computer through USB. The \dap{} registers itself as a USB keyboard (in
    addition to being identified as a mass-storage device). Pressing a button
    on the \dap{} sends a keystroke the computer the \dap{} is attached to,
    according to the mapping set by the keypad mode.
    The \dap{}'s keys can be mapped in different sets (modes) to achieve
    different functionality. The following modes are available:
    \begin{description}

      \item [Multimedia: ]This mode lets you control the volume, playback, and
        skips tracks on the host computer. It is equivalent for the multimedia
        keys found on top of some multimedia keyboards.
        \begin{table}
          \begin{btnmap}{}{}
            %
            % Volume up / down
            \opt{SANSA_E200_PAD,IPOD_4G_PAD,IPOD_3G_PAD,IPOD_1G2G_PAD}
              {\ButtonScrollBack / \ButtonScrollFwd}
            \opt{GIGABEAT_S_PAD,SANSA_C200_PAD,SANSA_CLIP_PAD}
              {\ButtonVolUp / \ButtonVolDown}
            \opt{IRIVER_H10_PAD}{\ButtonScrollUp / \ButtonScrollDown}
            \opt{MROBE100_PAD}{\ButtonUp / \ButtonDown}
            \opt{HAVEREMOTEKEYMAP}{
              &
              \opt{GIGABEAT_RC_PAD}{\ButtonRCVolUp / \ButtonRCVolDown}%
            }
            & Volume up / down, respectively \\
            %
            % Volume mute
            \opt{SANSA_E200_PAD,SANSA_C200_PAD,SANSA_CLIP_PAD,IPOD_4G_PAD%
                ,IPOD_3G_PAD,IPOD_1G2G_PAD,MROBE100_PAD}
              {\ButtonSelect}
            \opt{GIGABEAT_S_PAD}{\ButtonSelect; \ButtonBack}
            \opt{IRIVER_H10_PAD}{\ButtonFF}
            \opt{HAVEREMOTEKEYMAP}{
              &
              \opt{GIGABEAT_RC_PAD}{Long \ButtonRCFF}%
            }
            & Volume mute \\
            %
            % Playback play / pause
            \opt{SANSA_E200_PAD,SANSA_C200_PAD,SANSA_CLIP_PAD}{\ButtonUp}
            \opt{GIGABEAT_S_PAD,IRIVER_H10_PAD,IPOD_4G_PAD,IPOD_3G_PAD%
                ,IPOD_1G2G_PAD,MROBE100_PAD}
              {\ButtonPlay}
            \opt{HAVEREMOTEKEYMAP}{
              &
              \opt{GIGABEAT_RC_PAD}{\ButtonRCPlay}%
            }
            & Play / Pause \\
            %
            % Playback stop
            \opt{SANSA_E200_PAD,SANSA_C200_PAD}{\ButtonPower}
            \opt{GIGABEAT_S_PAD}{\ButtonMenu}
            \opt{SANSA_CLIP_PAD}{\ButtonHome}
            \opt{IRIVER_H10_PAD}{\ButtonRew}
            \opt{IPOD_4G_PAD,IPOD_3G_PAD,IPOD_1G2G_PAD}{Long \ButtonPlay}
            \opt{MROBE100_PAD}{\ButtonDisplay}
            \opt{HAVEREMOTEKEYMAP}{
              &
              \opt{GIGABEAT_RC_PAD}{Long \ButtonRCPlay}%
            }
            & Stop \\
            %
            % Scan previous / next track
            \opt{SANSA_E200_PAD,GIGABEAT_S_PAD,SANSA_C200_PAD,SANSA_CLIP_PAD%
                ,IRIVER_H10_PAD,IPOD_4G_PAD,IPOD_3G_PAD,IPOD_1G2G_PAD%
                ,MROBE100_PAD}
              {\ButtonLeft / \ButtonRight}
            \opt{SANSA_E200_PAD}{\ButtonMenu}
            \opt{HAVEREMOTEKEYMAP}{
              &
              \opt{GIGABEAT_RC_PAD}{\ButtonRCRew / \ButtonRCFF}%
            }
            & Scan previous / next track \\
          \end{btnmap}
        \end{table}

      \item [Presentation: ]This mode lets you control a presentation program
        (e.g. OpenOffice Impress, and some other popular application), making
        the \dap{} a wired remote control device. This mode is can be useful
        for lecturers who does not have a wireless remote control for this
        purpose.
        \begin{table}
          \begin{btnmap}{}{}
            %
            % Slideshow start / leave
            \opt{SANSA_E200_PAD,SANSA_C200_PAD}{\ButtonUp / \ButtonPower}
            \opt{GIGABEAT_S_PADIRIVER_H10_PAD}{\ButtonPlay / \ButtonMenu}
            \opt{SANSA_CLIP_PAD}{\ButtonUp / \ButtonHome}
            \opt{IRIVER_H10_PAD}{\ButtonPlay / \ButtonRew}
            \opt{IPOD_4G_PAD,IPOD_3G_PAD,IPOD_1G2G_PAD}
              {\ButtonPlay / Long \ButtonPlay}
            \opt{MROBE100_PAD}{\ButtonPlay / \ButtonDisplay}
            \opt{HAVEREMOTEKEYMAP}{
              &
              \opt{GIGABEAT_RC_PAD}{\ButtonRCPlay / Long \ButtonRCPlay}%
            }
            & Slideshow start / leave, respectively \\
            %
            % Slide previous / next
            \opt{SANSA_E200_PAD,GIGABEAT_S_PAD,SANSA_C200_PAD,SANSA_CLIP_PAD%
            ,IRIVER_H10_PAD,IPOD_4G_PAD,IPOD_3G_PAD,IPOD_1G2G_PAD,MROBE100_PAD}
              {\ButtonLeft / \ButtonRight}
            \opt{HAVEREMOTEKEYMAP}{
              &
              \opt{GIGABEAT_RC_PAD}{\ButtonRCRew / \ButtonRCFF}%
            }
            & Slide previous / next, respectively \\
            %
            % Slide first / last
            \opt{SANSA_E200_PAD,GIGABEAT_S_PAD,SANSA_C200_PAD,SANSA_CLIP_PAD%
            ,IRIVER_H10_PAD,IPOD_4G_PAD,IPOD_3G_PAD,IPOD_1G2G_PAD,MROBE100_PAD}
              {Long \ButtonLeft / Long \ButtonRight}
            \opt{HAVEREMOTEKEYMAP}{& }
            & Slide first / last, respectively \\
            %
            % Screen black
            \opt{SANSA_E200_PAD,GIGABEAT_S_PAD,SANSA_C200_PAD,SANSA_CLIP_PAD}
              {\ButtonDown}
            \opt{IRIVER_H10_PAD}{\ButtonPower}
            \opt{IPOD_4G_PAD,IPOD_3G_PAD,IPOD_1G2G_PAD,MROBE100_PAD}{\ButtonMenu}
            \opt{HAVEREMOTEKEYMAP}{& }
            & Blank screen \\
            %
            % Screen white
            \opt{SANSA_E200_PAD,GIGABEAT_S_PAD,SANSA_C200_PAD,SANSA_CLIP_PAD}
              {Long \ButtonDown}
            \opt{MROBE100_PAD}{Long \ButtonMenu}
            \opt{HAVEREMOTEKEYMAP}{& }
            & White screen \\
            %
            % Link previous / next
            \opt{SANSA_E200_PAD,IPOD_4G_PAD,IPOD_3G_PAD,IPOD_1G2G_PAD}
              {\ButtonScrollBack / \ButtonScrollFwd}
            \opt{GIGABEAT_S_PAD,SANSA_C200_PAD,SANSA_CLIP_PAD}
              {\ButtonVolUp / \ButtonVolDown}
            \opt{IRIVER_H10_PAD}{\ButtonScrollUp / \ButtonScrollDown}
            \opt{MROBE100_PAD}{\ButtonUp / \ButtonDown}
            \opt{HAVEREMOTEKEYMAP}{
              &
              \opt{GIGABEAT_RC_PAD}{\ButtonRCVolUp / \ButtonRCVolDown}%
            }
            & Previous / next link in slide, respectively \\
            %
            % Mouse click
            \opt{SANSA_E200_PAD,SANSA_C200_PAD,SANSA_CLIP_PAD,IPOD_4G_PAD%
                ,IPOD_3G_PAD,IPOD_1G2G_PAD,MROBE100_PAD}
              {\ButtonSelect}
            \opt{GIGABEAT_S_PAD}{\ButtonSelect; \ButtonBack}
            \opt{IRIVER_H10_PAD}{\ButtonFF}
            \opt{HAVEREMOTEKEYMAP}{
              &
              \opt{GIGABEAT_RC_PAD}{Long \ButtonRCFF}%
            }
            & Perform a 'mouse click' over a link \\
            %
            % Mouse over
            \opt{SANSA_E200_PAD,SANSA_C200_PAD,SANSA_CLIP_PAD,IPOD_4G_PAD%
                ,IPOD_3G_PAD,IPOD_1G2G_PAD,MROBE100_PAD}
              {Long \ButtonSelect}
            \opt{GIGABEAT_S_PAD}{Long \ButtonSelect; Long \ButtonBack}
            \opt{HAVEREMOTEKEYMAP}{
              &
              \opt{GIGABEAT_RC_PAD}{Long \ButtonRCRew}%
            }
            & Perform a 'mouse over' over a link \\
          \end{btnmap}
        \end{table}

      \item [Browser: ]This mode lets you control a web browser (e.g. Firefox).
        It uses the \dap{}'s keys to navigate through the web page and
        different tabs, navigate through history, and to control zoom.
        \begin{table}
          \begin{btnmap}{}{}
            %
            % Scroll up / down
            \opt{SANSA_E200_PAD,IPOD_4G_PAD,IPOD_3G_PAD,IPOD_1G2G_PAD}
              {\ButtonScrollBack / \ButtonScrollFwd}
            \opt{GIGABEAT_S_PAD,SANSA_C200_PAD,SANSA_CLIP_PAD}
              {\ButtonVolUp / \ButtonVolDown}
            \opt{IRIVER_H10_PAD}{\ButtonScrollUp / \ButtonScrollDown}
            \opt{MROBE100_PAD}{\ButtonUp / \ButtonDown}
            \opt{HAVEREMOTEKEYMAP}{
              &
              \opt{GIGABEAT_RC_PAD}{\ButtonRCVolUp / \ButtonRCVolDown}%
            }
            & Scroll up / down, respectively \\
            %
            % Scroll page up / page down
            \opt{SANSA_E200_PAD,SANSA_C200_PAD,SANSA_CLIP_PAD}
              {\ButtonUp / \ButtonDown}
            \opt{GIGABEAT_S_PAD}{\ButtonPlay / \ButtonDown}
            \opt{IRIVER_H10_PAD}{\ButtonPlay / \ButtonPower}
            \opt{IPOD_4G_PAD,IPOD_3G_PAD,IPOD_1G2G_PAD,MROBE100_PAD}
              {\ButtonPlay / \ButtonMenu}
            \opt{HAVEREMOTEKEYMAP}{
              &
              \opt{GIGABEAT_RC_PAD}{\ButtonRCPlay / Long \ButtonRCDsp}%
            }
            & Scroll page up / page down, respectively \\
            %
            % Zoom in / out
            \opt{SANSA_E200_PAD,SANSA_C200_PAD,SANSA_CLIP_PAD}
              {Long \ButtonUp / Long \ButtonDown}
            \opt{GIGABEAT_S_PAD}{Long \ButtonPlay / Long \ButtonPower}
            \opt{MROBE100_PAD}{Long \ButtonPlay / Long \ButtonMenu}
            \opt{HAVEREMOTEKEYMAP}{& }
            & Zoom in / out, respectively \\
            %
            % Zoom reset
            \opt{SANSA_E200_PAD,SANSA_C200_PAD,SANSA_CLIP_PAD,MROBE100_PAD}
              {Long \ButtonSelect}
            \opt{GIGABEAT_S_PAD}{Long \ButtonSelect; Long \ButtonBack}
            \opt{HAVEREMOTEKEYMAP}{
              &
              \opt{GIGABEAT_RC_PAD}{Long \ButtonRCRew}%
            }
            & Zoom reset \\
            %
            % Tab previous / next
            \opt{SANSA_E200_PAD,GIGABEAT_S_PAD,SANSA_C200_PAD,SANSA_CLIP_PAD%
                ,IPOD_4G_PAD,IPOD_3G_PAD,IPOD_1G2G_PAD,MROBE100_PAD}
              {\ButtonLeft / \ButtonRight}
            \opt{IRIVER_H10_PAD}{\ButtonRew / \ButtonFF}
            \opt{HAVEREMOTEKEYMAP}{& }
            & Tab previous / next, respectively \\
            %
            % Tab close
            \opt{SANSA_E200_PAD,SANSA_C200_PAD}{Long \ButtonPower}
            \opt{GIGABEAT_S_PAD}{Long \ButtonMenu}
            \opt{SANSA_CLIP_PAD}{Long \ButtonHome}
            \opt{MROBE100_PAD}{Long \ButtonDisplay}
            \opt{HAVEREMOTEKEYMAP}{& }
            & Tab close \\
            %
            % History back / forward
            \opt{SANSA_E200_PAD,GIGABEAT_S_PAD,SANSA_C200_PAD,SANSA_CLIP_PAD%
            ,IRIVER_H10_PAD,IPOD_4G_PAD,IPOD_3G_PAD,IPOD_1G2G_PAD,MROBE100_PAD}
              {Long \ButtonLeft / Long \ButtonRight}
            \opt{HAVEREMOTEKEYMAP}{
              &
              \opt{GIGABEAT_RC_PAD}{\ButtonRCRew / \ButtonRCFF}%
            }
            & History back / forward \\
            %
            % View full-screen
            \opt{SANSA_E200_PAD,SANSA_C200_PAD,SANSA_CLIP_PAD,IPOD_4G_PAD%
                ,IPOD_3G_PAD,IPOD_1G2G_PAD,MROBE100_PAD}
              {\ButtonSelect}
            \opt{GIGABEAT_S_PAD}{Long \ButtonSelect; Long \ButtonBack}
            \opt{IRIVER_H10_PAD}{\ButtonFF}
            \opt{HAVEREMOTEKEYMAP}{
              &
              \opt{GIGABEAT_RC_PAD}{Long \ButtonRCRew}%
            }
            & View full-screen toggle \\
          \end{btnmap}
        \end{table}

      \item [Mouse: ]This mode emulates a mouse. Features supported: Mouse
        movement; left and right button clicking; and dragging and dropping.
        \begin{table}
          \begin{btnmap}{}{}
            %
            % Cursor move up / down / left / right
            \opt{SANSA_E200_PAD,GIGABEAT_S_PAD,SANSA_C200_PAD,SANSA_CLIP_PAD%
                ,MROBE100_PAD}
              {\ButtonUp / \ButtonDown / \ButtonLeft / \ButtonRight}
            \opt{IPOD_4G_PAD,IPOD_3G_PAD,IPOD_1G2G_PAD}
              {\ButtonMenu / \ButtonPlay / \ButtonLeft / \ButtonRight}
            \opt{HAVEREMOTEKEYMAP}{& }
            & Cursor move up / down / left / right, respectively \\
            %
            % Mouse button left-click
            \opt{SANSA_E200_PAD,SANSA_C200_PAD,SANSA_CLIP_PAD,IPOD_4G_PAD%
                ,IPOD_3G_PAD,IPOD_1G2G_PAD}
              {\ButtonSelect}
            \opt{GIGABEAT_S_PAD}{\ButtonSelect; \ButtonBack}
            \opt{MROBE100_PAD}{\ButtonSelect; \ButtonMenu}
            \opt{HAVEREMOTEKEYMAP}{& }
            & Left mouse button click \\
            %
            % Mouse button right-click
            \opt{SANSA_E200_PAD,SANSA_C200_PAD}{\ButtonPower}
            \opt{GIGABEAT_S_PAD}{\ButtonMenu}
            \opt{SANSA_CLIP_PAD}{\ButtonHome}
            \opt{MROBE100_PAD}{\ButtonPlay}
            \opt{HAVEREMOTEKEYMAP}{& }
            & Right mouse button click \\
            % Mouse wheel scroll up / down
            \opt{SANSA_E200_PAD,IPOD_4G_PAD,IPOD_3G_PAD,IPOD_1G2G_PAD}
              {\ButtonScrollBack / \ButtonScrollFwd}
            \opt{GIGABEAT_S_PAD,SANSA_C200_PAD,SANSA_CLIP_PAD}
              {\ButtonVolUp / \ButtonVolDown}
            \opt{HAVEREMOTEKEYMAP}{& }
            & Mouse wheel scroll up / down, respectively \\
          \end{btnmap}
        \end{table}
    \end{description}
}