summaryrefslogtreecommitdiff
path: root/manual
diff options
context:
space:
mode:
authorNick Peskett <rockbox@peskett.co.uk>2011-12-26 08:26:38 +0000
committerNick Peskett <rockbox@peskett.co.uk>2011-12-26 08:26:38 +0000
commit2ecaca91f028fec8bae7b66ffb014f60afd7b34f (patch)
tree54efdbda16def5680097c11f060e9e5e606dd023 /manual
parent3bc771d669676e9295c3f369955b7e46f5b413d2 (diff)
New General Settings submenu: Startup/Shutdown
A dedicated submenu for items which are run at startup, or initiate a shutdown. Currently containing: Start Screen, Idle Poweroff, Sleep Timer & Start Sleep Timer on Boot. git-svn-id: svn://svn.rockbox.org/rockbox/trunk@31435 a1c6a512-1295-4272-9138-f99709370657
Diffstat (limited to 'manual')
-rw-r--r--manual/configure_rockbox/main.tex16
-rw-r--r--manual/configure_rockbox/sleep_timer.tex13
-rw-r--r--manual/configure_rockbox/startup_shutdown_options.tex57
-rw-r--r--manual/configure_rockbox/system_options.tex34
-rw-r--r--manual/configure_rockbox/time_and_date.tex1
-rw-r--r--manual/main_menu/main.tex7
6 files changed, 60 insertions, 68 deletions
diff --git a/manual/configure_rockbox/main.tex b/manual/configure_rockbox/main.tex
index 60054f4912..0eeea4e256 100644
--- a/manual/configure_rockbox/main.tex
+++ b/manual/configure_rockbox/main.tex
@@ -14,6 +14,7 @@
\input{configure_rockbox/database.tex}
\input{configure_rockbox/display_options.tex}
\input{configure_rockbox/system_options.tex}
+ \input{configure_rockbox/startup_shutdown_options.tex}
\input{configure_rockbox/bookmarking.tex}
\opt{tagcache}{\opt{swcodec}{
\input{configure_rockbox/autoresume.tex}
@@ -21,12 +22,6 @@
\input{configure_rockbox/language.tex}
\input{configure_rockbox/voice.tex}
\input{configure_rockbox/hotkey_settings.tex}
- \nopt{rtc}{
- \section{\label{ref:sleep_timer}Sleep Timer}
- \begin{description}
- \input{configure_rockbox/sleep_timer.tex}
- \end{description}
- }
\chapter{Theme Settings}
\label{ref:configure_rockbox_themes}
@@ -38,15 +33,6 @@
\input{configure_rockbox/recording_settings.tex}
}
-\nopt{rtc}{
- \chapter{Sleep Timer related settings}
- \label{ref:SleepTimerRelatedSettings}
- These settings control the behaviour of the sleep timer.
- \begin{description}
- \input{configure_rockbox/sleep_timer.tex}
- \end{description}
-}
-
\opt{rtc}{
\chapter{Time and Date}
\input{configure_rockbox/time_and_date.tex}
diff --git a/manual/configure_rockbox/sleep_timer.tex b/manual/configure_rockbox/sleep_timer.tex
deleted file mode 100644
index f9cb76a603..0000000000
--- a/manual/configure_rockbox/sleep_timer.tex
+++ /dev/null
@@ -1,13 +0,0 @@
-% $Id:$ %
-\item[Sleep Timer:]
- The \setting{Sleep Timer} powers off your \dap{} after playing for a given
- time.
- Shown when the \setting{Sleep Timer} is inactive, it can be set from
- \setting{Off} to 5 hours in 5 minute steps.
- While the \setting{Sleep Timer} is reset on boot, the value selected is
- retained and will be used as the default from then on.
-\item[Cancel Sleep Timer (h:mm):]
- Shown when the \setting{Sleep Timer} is active, this option disables the
- current \setting{Sleep Timer}.
-\item[Start Sleep Timer On Boot:]
- If set, a \setting{Sleep Timer} will be initiated when the device starts.
diff --git a/manual/configure_rockbox/startup_shutdown_options.tex b/manual/configure_rockbox/startup_shutdown_options.tex
new file mode 100644
index 0000000000..2fb4c4881a
--- /dev/null
+++ b/manual/configure_rockbox/startup_shutdown_options.tex
@@ -0,0 +1,57 @@
+% $Id$ %
+
+\section{\label{ref:StartupShutdownOptions}Startup/Shutdown}
+
+The \setting{Startup/Shutdown} sub menu allows you to configure items which
+are run at startup, or initiate a shutdown when conditions are met.
+
+\subsection{Start Screen}
+ Set the screen that Rockbox will start in. The default is the main menu but
+ the following options are available:
+ % almost all items in the main menu with a few exceptions
+ \begin{description}
+ \item[Previous Screen.] Start Rockbox in the same screen as when it was
+ shut off.
+ \item[Main Menu.] Show the main menu.
+ \item[Files.] Display the file browser, starting in the root directory of
+ your \dap.
+ \item[Database.] Show the default database view.
+ \item[Resume Playback.] Go to the WPS and and resume playback from where
+ it was before turning off (if there is a playlist to resume).
+ \item[Settings.] Display the main settings menu.
+ \opt{recording}{
+ \item[Recording.] Start the \dap{} in the recording screen
+ (recording does not start automatically).
+ }
+ \opt{radio}{
+ \item[FM Radio.] Go to the radio screen and start playing.
+ }
+ \item[Recent Bookmarks.] Show the list of recent bookmarks as
+ described in \reference{ref:Bookmarkconfigactual}. Bookmarking needs
+ to be enabled.
+ \end{description}
+
+\subsection{\label{ref:IdlePoweroffSetting}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 1 to 10 minutes in 1 minute steps. Then
+ 15, 30, 45 or 60 minutes are available.
+
+\subsection{Sleep Timer}
+ The \setting{Sleep Timer} powers off your \dap{} after a given time, whether
+ playing or not.
+ \begin{description}
+ \item[Sleep Timer:]
+ Shown when the \setting{Sleep Timer} is inactive, it can be set from
+ \setting{Off} to 5 hours in 5 minute steps.
+ While the \setting{Sleep Timer} is reset on boot, the value selected is
+ retained and will be used as the default from then on.
+ \item[Cancel Sleep Timer (h:mm):]
+ Shown when the \setting{Sleep Timer} is active, this option disables the
+ current \setting{Sleep Timer}.
+ \item[Start Sleep Timer On Boot:]
+ If set, a \setting{Sleep Timer} will be initiated when the device
+ starts.
+ \end{description}
diff --git a/manual/configure_rockbox/system_options.tex b/manual/configure_rockbox/system_options.tex
index b61c55a5f2..6db37d9fe7 100644
--- a/manual/configure_rockbox/system_options.tex
+++ b/manual/configure_rockbox/system_options.tex
@@ -1,27 +1,5 @@
% $Id$ %
\section{\label{ref:SystemOptions}System}
-\subsection{Start Screen}
- Set the screen that Rockbox will start in. The default is the main menu but
- the following options are available: % almost all items in the main menu with a few exceptions
- \begin{description}
- \item[Previous Screen.] Start Rockbox in the same screen as when it was shut off.
- \item[Main Menu.] Show the main menu.
- \item[Files.] Display the file browser, starting in the root directory of your \dap.
- \item[Database.] Show the default database view.
- \item[Resume Playback.] Go to the WPS and and resume playback from where it was
- before turning off (if there is a playlist to resume).
- \item[Settings.] Display the main settings menu.
- \opt{recording}{%
- \item[Recording.] Start the \dap{} in the recording screen
- (recording does not start automatically).
- }
- \opt{radio}{%
- \item[FM Radio.] Go to the radio screen and start playing.
- }
- \item[Recent Bookmarks.] Show the list of recent bookmarks as
- described in \reference{ref:Bookmarkconfigactual}. Bookmarking needs
- to be enabled.
- \end{description}
\nopt{sansa}%will probably be there on Sansas one day - exclude it the simple way without specific option
{\nopt{sansaAMS}{
@@ -112,15 +90,6 @@
\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 1 to 10 minutes in 1 minute steps. Then
-15, 30, 45 or 60 minutes are available.
-
-
\subsection{Limits}
This sub menu relates to limits in the Rockbox operating system.
\begin{description}
@@ -167,7 +136,8 @@ This sub menu relates to limits in the Rockbox operating system.
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).
+ in the \setting{Idle Poweroff} setting
+ (see \reference{ref:IdlePoweroffSetting}).
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
diff --git a/manual/configure_rockbox/time_and_date.tex b/manual/configure_rockbox/time_and_date.tex
index 9f1223ecfe..fe1624211b 100644
--- a/manual/configure_rockbox/time_and_date.tex
+++ b/manual/configure_rockbox/time_and_date.tex
@@ -18,6 +18,5 @@ if voice support is enabled.
This option controls what the \dap{} does when it is woken up by the alarm.
}%\opt{recording,radio}
}%\opt{alarm}
- \input{configure_rockbox/sleep_timer.tex}
\item[Time Format:] Choose 12 or 24 hour clock.
\end{description}
diff --git a/manual/main_menu/main.tex b/manual/main_menu/main.tex
index 16f0189160..33e64c12fe 100644
--- a/manual/main_menu/main.tex
+++ b/manual/main_menu/main.tex
@@ -144,13 +144,6 @@ to recording. The details of this menu are covered in detail in
\reference{ref:Recordingsettings}.
}
-\nopt{rtc}{
-\subsection{Sleep Timer related Settings}
-The \setting{Sleep Timer} related settings allow you to configure the sleep timer
-which powers off your \dap{} after playing for a given time.
-The details of this menu are covered in detail in \reference{ref:SleepTimerRelatedSettings}.
-}
-
\subsection{Manage Settings}
The \setting{Manage Settings} option allows the saving and re-loading of user
configuration settings, browsing the hard drive for alternate firmwares, and finally