diff options
author | Nick Peskett <rockbox@peskett.co.uk> | 2011-12-26 08:26:38 +0000 |
---|---|---|
committer | Nick Peskett <rockbox@peskett.co.uk> | 2011-12-26 08:26:38 +0000 |
commit | 2ecaca91f028fec8bae7b66ffb014f60afd7b34f (patch) | |
tree | 54efdbda16def5680097c11f060e9e5e606dd023 /manual | |
parent | 3bc771d669676e9295c3f369955b7e46f5b413d2 (diff) | |
download | rockbox-2ecaca91f028fec8bae7b66ffb014f60afd7b34f.tar.gz rockbox-2ecaca91f028fec8bae7b66ffb014f60afd7b34f.zip |
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.tex | 16 | ||||
-rw-r--r-- | manual/configure_rockbox/sleep_timer.tex | 13 | ||||
-rw-r--r-- | manual/configure_rockbox/startup_shutdown_options.tex | 57 | ||||
-rw-r--r-- | manual/configure_rockbox/system_options.tex | 34 | ||||
-rw-r--r-- | manual/configure_rockbox/time_and_date.tex | 1 | ||||
-rw-r--r-- | manual/main_menu/main.tex | 7 |
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 @@ | |||
14 | \input{configure_rockbox/database.tex} | 14 | \input{configure_rockbox/database.tex} |
15 | \input{configure_rockbox/display_options.tex} | 15 | \input{configure_rockbox/display_options.tex} |
16 | \input{configure_rockbox/system_options.tex} | 16 | \input{configure_rockbox/system_options.tex} |
17 | \input{configure_rockbox/startup_shutdown_options.tex} | ||
17 | \input{configure_rockbox/bookmarking.tex} | 18 | \input{configure_rockbox/bookmarking.tex} |
18 | \opt{tagcache}{\opt{swcodec}{ | 19 | \opt{tagcache}{\opt{swcodec}{ |
19 | \input{configure_rockbox/autoresume.tex} | 20 | \input{configure_rockbox/autoresume.tex} |
@@ -21,12 +22,6 @@ | |||
21 | \input{configure_rockbox/language.tex} | 22 | \input{configure_rockbox/language.tex} |
22 | \input{configure_rockbox/voice.tex} | 23 | \input{configure_rockbox/voice.tex} |
23 | \input{configure_rockbox/hotkey_settings.tex} | 24 | \input{configure_rockbox/hotkey_settings.tex} |
24 | \nopt{rtc}{ | ||
25 | \section{\label{ref:sleep_timer}Sleep Timer} | ||
26 | \begin{description} | ||
27 | \input{configure_rockbox/sleep_timer.tex} | ||
28 | \end{description} | ||
29 | } | ||
30 | 25 | ||
31 | \chapter{Theme Settings} | 26 | \chapter{Theme Settings} |
32 | \label{ref:configure_rockbox_themes} | 27 | \label{ref:configure_rockbox_themes} |
@@ -38,15 +33,6 @@ | |||
38 | \input{configure_rockbox/recording_settings.tex} | 33 | \input{configure_rockbox/recording_settings.tex} |
39 | } | 34 | } |
40 | 35 | ||
41 | \nopt{rtc}{ | ||
42 | \chapter{Sleep Timer related settings} | ||
43 | \label{ref:SleepTimerRelatedSettings} | ||
44 | These settings control the behaviour of the sleep timer. | ||
45 | \begin{description} | ||
46 | \input{configure_rockbox/sleep_timer.tex} | ||
47 | \end{description} | ||
48 | } | ||
49 | |||
50 | \opt{rtc}{ | 36 | \opt{rtc}{ |
51 | \chapter{Time and Date} | 37 | \chapter{Time and Date} |
52 | \input{configure_rockbox/time_and_date.tex} | 38 | \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 @@ | |||
1 | % $Id:$ % | ||
2 | \item[Sleep Timer:] | ||
3 | The \setting{Sleep Timer} powers off your \dap{} after playing for a given | ||
4 | time. | ||
5 | Shown when the \setting{Sleep Timer} is inactive, it can be set from | ||
6 | \setting{Off} to 5 hours in 5 minute steps. | ||
7 | While the \setting{Sleep Timer} is reset on boot, the value selected is | ||
8 | retained and will be used as the default from then on. | ||
9 | \item[Cancel Sleep Timer (h:mm):] | ||
10 | Shown when the \setting{Sleep Timer} is active, this option disables the | ||
11 | current \setting{Sleep Timer}. | ||
12 | \item[Start Sleep Timer On Boot:] | ||
13 | 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 @@ | |||
1 | % $Id$ % | ||
2 | |||
3 | \section{\label{ref:StartupShutdownOptions}Startup/Shutdown} | ||
4 | |||
5 | The \setting{Startup/Shutdown} sub menu allows you to configure items which | ||
6 | are run at startup, or initiate a shutdown when conditions are met. | ||
7 | |||
8 | \subsection{Start Screen} | ||
9 | Set the screen that Rockbox will start in. The default is the main menu but | ||
10 | the following options are available: | ||
11 | % almost all items in the main menu with a few exceptions | ||
12 | \begin{description} | ||
13 | \item[Previous Screen.] Start Rockbox in the same screen as when it was | ||
14 | shut off. | ||
15 | \item[Main Menu.] Show the main menu. | ||
16 | \item[Files.] Display the file browser, starting in the root directory of | ||
17 | your \dap. | ||
18 | \item[Database.] Show the default database view. | ||
19 | \item[Resume Playback.] Go to the WPS and and resume playback from where | ||
20 | it was before turning off (if there is a playlist to resume). | ||
21 | \item[Settings.] Display the main settings menu. | ||
22 | \opt{recording}{ | ||
23 | \item[Recording.] Start the \dap{} in the recording screen | ||
24 | (recording does not start automatically). | ||
25 | } | ||
26 | \opt{radio}{ | ||
27 | \item[FM Radio.] Go to the radio screen and start playing. | ||
28 | } | ||
29 | \item[Recent Bookmarks.] Show the list of recent bookmarks as | ||
30 | described in \reference{ref:Bookmarkconfigactual}. Bookmarking needs | ||
31 | to be enabled. | ||
32 | \end{description} | ||
33 | |||
34 | \subsection{\label{ref:IdlePoweroffSetting}Idle Poweroff} | ||
35 | Rockbox can be configured to turn off power after the unit has been idle for | ||
36 | a defined number of minutes. The \dap{} is idle when playback is stopped or | ||
37 | paused. It is not idle while the USB or charger is connected | ||
38 | \opt{recording}{, or while recording}. | ||
39 | Settings are either \setting{Off} or 1 to 10 minutes in 1 minute steps. Then | ||
40 | 15, 30, 45 or 60 minutes are available. | ||
41 | |||
42 | \subsection{Sleep Timer} | ||
43 | The \setting{Sleep Timer} powers off your \dap{} after a given time, whether | ||
44 | playing or not. | ||
45 | \begin{description} | ||
46 | \item[Sleep Timer:] | ||
47 | Shown when the \setting{Sleep Timer} is inactive, it can be set from | ||
48 | \setting{Off} to 5 hours in 5 minute steps. | ||
49 | While the \setting{Sleep Timer} is reset on boot, the value selected is | ||
50 | retained and will be used as the default from then on. | ||
51 | \item[Cancel Sleep Timer (h:mm):] | ||
52 | Shown when the \setting{Sleep Timer} is active, this option disables the | ||
53 | current \setting{Sleep Timer}. | ||
54 | \item[Start Sleep Timer On Boot:] | ||
55 | If set, a \setting{Sleep Timer} will be initiated when the device | ||
56 | starts. | ||
57 | \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 @@ | |||
1 | % $Id$ % | 1 | % $Id$ % |
2 | \section{\label{ref:SystemOptions}System} | 2 | \section{\label{ref:SystemOptions}System} |
3 | \subsection{Start Screen} | ||
4 | Set the screen that Rockbox will start in. The default is the main menu but | ||
5 | the following options are available: % almost all items in the main menu with a few exceptions | ||
6 | \begin{description} | ||
7 | \item[Previous Screen.] Start Rockbox in the same screen as when it was shut off. | ||
8 | \item[Main Menu.] Show the main menu. | ||
9 | \item[Files.] Display the file browser, starting in the root directory of your \dap. | ||
10 | \item[Database.] Show the default database view. | ||
11 | \item[Resume Playback.] Go to the WPS and and resume playback from where it was | ||
12 | before turning off (if there is a playlist to resume). | ||
13 | \item[Settings.] Display the main settings menu. | ||
14 | \opt{recording}{% | ||
15 | \item[Recording.] Start the \dap{} in the recording screen | ||
16 | (recording does not start automatically). | ||
17 | } | ||
18 | \opt{radio}{% | ||
19 | \item[FM Radio.] Go to the radio screen and start playing. | ||
20 | } | ||
21 | \item[Recent Bookmarks.] Show the list of recent bookmarks as | ||
22 | described in \reference{ref:Bookmarkconfigactual}. Bookmarking needs | ||
23 | to be enabled. | ||
24 | \end{description} | ||
25 | 3 | ||
26 | \nopt{sansa}%will probably be there on Sansas one day - exclude it the simple way without specific option | 4 | \nopt{sansa}%will probably be there on Sansas one day - exclude it the simple way without specific option |
27 | {\nopt{sansaAMS}{ | 5 | {\nopt{sansaAMS}{ |
@@ -112,15 +90,6 @@ | |||
112 | \end{description} | 90 | \end{description} |
113 | } % \opt{dircache,HAVE_DISK_STORAGE} | 91 | } % \opt{dircache,HAVE_DISK_STORAGE} |
114 | 92 | ||
115 | \subsection{Idle Poweroff} | ||
116 | Rockbox can be configured to turn off power after the unit has been idle for a | ||
117 | defined number of minutes. The \dap{} is idle when playback is stopped or | ||
118 | paused. It is not idle while the USB or charger is connected | ||
119 | \opt{recording}{, or while recording}. | ||
120 | Settings are either \setting{Off} or 1 to 10 minutes in 1 minute steps. Then | ||
121 | 15, 30, 45 or 60 minutes are available. | ||
122 | |||
123 | |||
124 | \subsection{Limits} | 93 | \subsection{Limits} |
125 | This sub menu relates to limits in the Rockbox operating system. | 94 | This sub menu relates to limits in the Rockbox operating system. |
126 | \begin{description} | 95 | \begin{description} |
@@ -167,7 +136,8 @@ This sub menu relates to limits in the Rockbox operating system. | |||
167 | is turned off. If the \setting{Car Adapter Mode} is set to \setting{On}, | 136 | is turned off. If the \setting{Car Adapter Mode} is set to \setting{On}, |
168 | Rockbox will pause playback when the external power off condition is | 137 | Rockbox will pause playback when the external power off condition is |
169 | detected. Rockbox will then shutdown the \dap{} after the length of time set | 138 | detected. Rockbox will then shutdown the \dap{} after the length of time set |
170 | in the \setting{Idle Poweroff} setting (see above). | 139 | in the \setting{Idle Poweroff} setting |
140 | (see \reference{ref:IdlePoweroffSetting}). | ||
171 | If power to the DC in jack is turned back on before the \emph{Idle Poweroff} | 141 | If power to the DC in jack is turned back on before the \emph{Idle Poweroff} |
172 | function has shut the \dap{} off, playback will be resumed 5 seconds after | 142 | function has shut the \dap{} off, playback will be resumed 5 seconds after |
173 | the power is applied. This delay is to allow for the time while the car | 143 | 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. | |||
18 | This option controls what the \dap{} does when it is woken up by the alarm. | 18 | This option controls what the \dap{} does when it is woken up by the alarm. |
19 | }%\opt{recording,radio} | 19 | }%\opt{recording,radio} |
20 | }%\opt{alarm} | 20 | }%\opt{alarm} |
21 | \input{configure_rockbox/sleep_timer.tex} | ||
22 | \item[Time Format:] Choose 12 or 24 hour clock. | 21 | \item[Time Format:] Choose 12 or 24 hour clock. |
23 | \end{description} | 22 | \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 | |||
144 | \reference{ref:Recordingsettings}. | 144 | \reference{ref:Recordingsettings}. |
145 | } | 145 | } |
146 | 146 | ||
147 | \nopt{rtc}{ | ||
148 | \subsection{Sleep Timer related Settings} | ||
149 | The \setting{Sleep Timer} related settings allow you to configure the sleep timer | ||
150 | which powers off your \dap{} after playing for a given time. | ||
151 | The details of this menu are covered in detail in \reference{ref:SleepTimerRelatedSettings}. | ||
152 | } | ||
153 | |||
154 | \subsection{Manage Settings} | 147 | \subsection{Manage Settings} |
155 | The \setting{Manage Settings} option allows the saving and re-loading of user | 148 | The \setting{Manage Settings} option allows the saving and re-loading of user |
156 | configuration settings, browsing the hard drive for alternate firmwares, and finally | 149 | configuration settings, browsing the hard drive for alternate firmwares, and finally |