summaryrefslogtreecommitdiff
path: root/manual/main_menu/main.tex
diff options
context:
space:
mode:
authorNils Wallménius <nils@rockbox.org>2007-03-03 00:07:31 +0000
committerNils Wallménius <nils@rockbox.org>2007-03-03 00:07:31 +0000
commit909b9462da8387e1c8379a52058c61bf18e222e5 (patch)
treef2f7b1e7073343d1ede9981a14e707fd1d12ad53 /manual/main_menu/main.tex
parent79a2a936a289ed7dc6e997b6f8fdd53d45a48b57 (diff)
downloadrockbox-909b9462da8387e1c8379a52058c61bf18e222e5.tar.gz
rockbox-909b9462da8387e1c8379a52058c61bf18e222e5.zip
Update the manual to reflect recent menu changes, add descriptions of how to move and remove tracks in the playlist viewer, Recording settings are now in their own chapter.
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@12553 a1c6a512-1295-4272-9138-f99709370657
Diffstat (limited to 'manual/main_menu/main.tex')
-rw-r--r--manual/main_menu/main.tex97
1 files changed, 52 insertions, 45 deletions
diff --git a/manual/main_menu/main.tex b/manual/main_menu/main.tex
index ca1207d3ad..3eae984ab2 100644
--- a/manual/main_menu/main.tex
+++ b/manual/main_menu/main.tex
@@ -1,26 +1,18 @@
1% $Id$ % 1% $Id$ %
2\chapter{The Main Menu} 2\chapter{The Main Menu}
3 3\section{\label{ref:main_menu}Introducing the Main Menu}
4\section{Introducing the Main Menu}
5\screenshot{main_menu/images/ss-main-menu}{The main menu}{} 4\screenshot{main_menu/images/ss-main-menu}{The main menu}{}
6The \setting{Main Menu} is the screen from which the rest of the Rockbox functions can be 5The \setting{Main Menu} is the screen from which all of the Rockbox functions can be
7accessed. It is used for a variety of functions, which are detailed below. 6accessed. To enter the \setting{Main Menu},
8All options in Rockbox can be controlled via the \setting{Main Menu}. 7 \nopt{ONDIO_PAD}{press the \ActionStdMenu{} button.}%
9To enter the \setting{Main Menu},
10 \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{press the \ButtonMode\ button.}%
11 \opt{RECORDER_PAD}{press the \ButtonFOne\ button.}%
12 \opt{PLAYER_PAD,IPOD_4G_PAD,IPOD_3G_PAD}{press the \ButtonMenu\
13 button.}%
14 \opt{ONDIO_PAD}{hold the \ButtonMenu{} button.}% 8 \opt{ONDIO_PAD}{hold the \ButtonMenu{} button.}%
15 \opt{IAUDIO_X5_PAD}{press the \ButtonRec\ button.}%
16 \opt{IRIVER_H10_PAD}{press the \ButtonPower\ button.}%
17 9
18All settings are stored on the unit. However, Rockbox does not spin up 10All settings are stored on the unit. However, Rockbox does not spin up
19the disk solely for the purpose of saving settings. Instead, Rockbox will 11the disk solely for the purpose of saving settings. Instead, Rockbox will
20save settings when it spins up the disk the next time, for example when 12save settings when it spins up the disk the next time, for example when
21refilling the MP3 buffer or navigating through the file browser. Changes to 13refilling the MP3 buffer or navigating through the \setting{File Browser}.
22settings may therefore not be saved unless the \dap\ is shut down safely 14Changes to settings may therefore not be saved unless the \dap{} is shut down
23(see \reference{ref:Safeshutdown}). 15safely (see \reference{ref:Safeshutdown}).
24 16
25\section{Navigating the Main Menu} 17\section{Navigating the Main Menu}
26\opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD,IPOD_4G_PAD,IPOD_3G_PAD,IRIVER_H10_PAD}{ 18\opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD,IPOD_4G_PAD,IPOD_3G_PAD,IRIVER_H10_PAD}{
@@ -75,19 +67,31 @@ If the \setting{Save a list of recently created bookmarks} option is enabled
75then you can view a list of several recent bookmarks here and select one to 67then you can view a list of several recent bookmarks here and select one to
76jump straight to that track. See \reference{ref:Bookmarkconfigactual} 68jump straight to that track. See \reference{ref:Bookmarkconfigactual}
77for more details on configuring bookmarking in Rockbox. 69for more details on configuring bookmarking in Rockbox.
78\note{This option is off by default.} 70\note{This entry is not shown in the \setting{Main Menu} when the option is off
71 and the option is off by default.}
72
73\section{Files}
74Browse the files on your \dap{} (see \reference{ref:file_browser}).
75
76\section{Database}
77Browse by the meta-data in your audio files (see \reference{ref:database}).
79 78
80\section{Sound Settings} 79\section{Now Playing/Resume Playback}
80Go to the \setting{While Playing Screen} and resume if music playback is
81stopped or paused and there is something to resume (see \reference{ref:WPS}).
82
83\section{Settings}
84\subsection{Sound Settings}
81The \setting{Sound Settings} menu offers a selection of sound properties you may 85The \setting{Sound Settings} menu offers a selection of sound properties you may
82change to customise your listening experience. The details of this menu are 86change to customise your listening experience. The details of this menu are
83covered in detail in \reference{ref:configure_rockbox_sound}. 87covered in detail in \reference{ref:configure_rockbox_sound}.
84 88
85\section{General Settings} 89\subsection{General Settings}
86The \setting{General Settings} menu allows you to customise the way Rockbox looks 90The \setting{General Settings} menu allows you to customise the way Rockbox looks
87and the way it plays music. The details of this menu are covered in detail in 91and the way it plays music. The details of this menu are covered in detail in
88\reference{ref:configure_rockbox_general}. 92\reference{ref:configure_rockbox_general}.
89 93
90\section{Manage Settings} 94\subsection{Manage Settings}
91The \setting{Manage Settings} option allows the saving and re-loading of user 95The \setting{Manage Settings} option allows the saving and re-loading of user
92configuration settings, browsing the hard drive for alternate firmwares, and finally 96configuration settings, browsing the hard drive for alternate firmwares, and finally
93resetting your \dap{} back to initial configuration. 97resetting your \dap{} back to initial configuration.
@@ -98,13 +102,13 @@ Rockbox firmware.}
98The details of this menu are covered in detail in 102The details of this menu are covered in detail in
99\reference{ref:manage_settings}. 103\reference{ref:manage_settings}.
100 104
101\section{Browse Themes} 105\subsection{Browse Themes}
102This option will display all the currently installed themes on the \dap, 106This option will display all the currently installed themes on the \dap,
103press \ButtonRight\ to load the chosen theme and apply it. 107press \ActionTreeEnter{} to load the chosen theme and apply it.
104 108
105A theme is basically a configuration file, stored in a specific directory, 109A theme is basically a configuration file, stored in a specific directory,
106that typically changes the WPS 110that typically changes the WPS
107\opt{h1xx,h300,x5}{and remote WPS}, font used and on some platforms 111\opt{HAVE_REMOTE_LCD}{and remote WPS}, font used and on some platforms
108additional information such as background image and text colours. 112additional information such as background image and text colours.
109 113
110There are a number of themes that ship with Rockbox. If none of 114There are a number of themes that ship with Rockbox. If none of
@@ -120,22 +124,26 @@ these suit your needs, many more can be downloaded from
120Some of the downloads from this site will actually be standalone WPS files, 124Some of the downloads from this site will actually be standalone WPS files,
121others will be full-blown themes. 125others will be full-blown themes.
122 126
123\note{Themes do not have to be purely visual. It is quite possible to create 127\note{Themes do not have to be purely visual. It is quite possible to create
124a theme that switches between audio configurations for use in the car, with 128 a theme that switches between audio configurations for use in the car, with
125headphones and when connected to an external amplifier. See 129 headphones and when connected to an external amplifier. See
126\reference{ref:CreateYourOwnWPS} for more details. 130 \reference{ref:CreateYourOwnWPS} for more details.}
127}
128 131
129\opt{CONFIG_TUNER}{\input{main_menu/fmradio.tex}} 132\subsection{Recording Settings}
133The \setting{Recording Settings} menu allows you to configure settings related
134to recording. The details of this menu are covered in detail in
135\reference{ref:Recordingsettings}.
130 136
131\opt{HAVE_RECORDING}{\input{main_menu/recording.tex}} 137\opt{HAVE_RECORDING}{\input{main_menu/recording_screen.tex}}
132 138
133\section{\label{ref:playlistoptions}Playlist Options} 139\opt{CONFIG_TUNER}{\input{main_menu/fmradio.tex}}
140
141\section{\label{ref:playlistoptions}Playlist}
134 This menu allows you to work with playlists. Playlists can be created in 142 This menu allows you to work with playlists. Playlists can be created in
135 three ways. Playing a file in a directory causes all the files in the 143 three ways. Playing a file in a directory causes all the files in the
136 directory to be placed in a playlist. Playlists can be created manually by 144 directory to be placed in a playlist. Playlists can be created manually by
137 either using the \setting{File Menu} (see \reference{ref:Filemenu}) or using 145 either using the \setting{File Menu} (see \reference{ref:Filemenu}) or using
138 the \setting{Playlist Options} menu. Both automatically and manually created 146 the \setting{Playlist} menu. Both automatically and manually created
139 playlists can be edited using this menu. 147 playlists can be edited using this menu.
140 148
141\begin{description} 149\begin{description}
@@ -151,27 +159,20 @@ from where you currently are.
151 Saves the current dynamic playlist, excluding queued tracks, to the 159 Saves the current dynamic playlist, excluding queued tracks, to the
152specified file. If no path is provided then playlist is saved to current 160specified file. If no path is provided then playlist is saved to current
153directory (see \reference{ref:Playlistsubmenu}). 161directory (see \reference{ref:Playlistsubmenu}).
154 162
155\item[Recursively Insert Directories: ] 163\item[Playlist Catalog:]
156 If set to \setting{On}, then when a directory is inserted or queued into a 164 The \setting{Playlist Catalog} provides a simple interface to maintain
157 dynamic playlist, all sub-directories will also be inserted. If set to \setting{Ask}, 165 several playlist (see \reference{label:WorkingWithPlaylists}).
158 Rockbox will prompt the user about whether to include sub-directories.
159 Options: \setting{Off}, \setting{Ask}, \setting{On}
160
161\item[Warn When Erasing Dynamic Playlist: ]
162 If set to \setting{Yes}, Rockbox will provide a warning if the user attempts to
163 take an action that will cause Rockbox to erase the current dynamic playlist.
164 Options: \setting{Yes}, \setting{No}
165\end{description} 166\end{description}
166 167
167\section{Browse Plugins} 168\section{Plugins}
168 With this option you can load and run various plugins that have been 169 With this option you can load and run various plugins that have been
169written for Rockbox. There are a wide variety of these supplied with 170written for Rockbox. There are a wide variety of these supplied with
170Rockbox, including several games, some impressive demos and a number of 171Rockbox, including several games, some impressive demos and a number of
171utilities. A detailed description of the different plugins is to be found in 172utilities. A detailed description of the different plugins is to be found in
172\reference{ref:plugins}. 173\reference{ref:plugins}.
173 174
174\section{\label{ref:Info}Info} 175\section{\label{ref:Info}System}
175 This option shows RAM buffer size, battery voltage level and estimated time 176 This option shows RAM buffer size, battery voltage level and estimated time
176remaining, disk total space and disk free space. 177remaining, disk total space and disk free space.
177\opt{player}{Use the MINUS and PLUS keys to step through several 178\opt{player}{Use the MINUS and PLUS keys to step through several
@@ -192,6 +193,12 @@ pages of information.}
192\item[Version:] 193\item[Version:]
193 Software version and credits display. 194 Software version and credits display.
194 195
196\item[Sleep Timer:]
197 The \setting{Sleep Timer} powers off your \dap{} after playing for a given
198 time. It can be set from \setting{Off} to 5 hours in 5 minute steps.
199 The \setting{Sleep Timer} is reset on boot.
200 \opt{HAVE_RTC_ALARM}{Using this option disables the \setting{Wake up alarm}.}
201
195\item[Debug (Keep Out!):] 202\item[Debug (Keep Out!):]
196 This sub menu is intended to be used \emph{only} by Rockbox developers. 203 This sub menu is intended to be used \emph{only} by Rockbox developers.
197 It shows hardware, disk, battery status and other technical information. 204 It shows hardware, disk, battery status and other technical information.