summaryrefslogtreecommitdiffstats
path: root/manual/main_menu/main.tex
blob: e678072e9f695f93e7ff9891cd79ae81c43cb99f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
% $Id$ %
\chapter{The Main Menu}
\section{\label{ref:main_menu}Introducing the Main Menu}
\screenshot{main_menu/images/ss-main-menu}{The main menu}{}
The \setting{Main Menu} is the screen from which all of the Rockbox functions can be 
accessed. To enter the \setting{Main Menu}, 
  \nopt{ONDIO_PAD}{press the \ActionStdMenu{} button.}%
  \opt{ONDIO_PAD}{hold the \ButtonMenu{} button.}%

All settings are stored on the unit. However, Rockbox does not spin up 
the disk solely for the purpose of saving settings. Instead, Rockbox will
save settings when it spins up the disk the next time, for example when 
refilling the MP3 buffer or navigating through the \setting{File Browser}.
Changes to settings may therefore not be saved unless the \dap{} is shut down
safely (see \reference{ref:Safeshutdown}).

\section{Navigating the Main Menu}
\opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD,IPOD_4G_PAD,IPOD_3G_PAD,IRIVER_H10_PAD}{
  \begin{table}
    \begin{btnmap}{}{}
      \opt{IPOD_4G_PAD,IPOD_3G_PAD,IPOD_VIDEO_PAD}{\ButtonScrollFwd}
      \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD}{\ButtonUp}
      \opt{IRIVER_H10_PAD}{\ButtonScrollUp} 
      & Moves up in the menu.\\
      & Inside a setting, increases the value or
        chooses next option \\
      %
      \opt{IPOD_4G_PAD,IPOD_3G_PAD,IPOD_VIDEO_PAD}{\ButtonScrollBack}
      \opt{RECORDER_PAD,ONDIO_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD}{\ButtonDown}
      \opt{IRIVER_H10_PAD}{\ButtonScrollDown} 
      & Moves down in the menu.\\
      & Inside a setting, decreases the value or
        chooses previous option \\
      %
      \opt{RECORDER_PAD}{\ButtonPlay/\ButtonRight}
      \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IAUDIO_X5_PAD}{\ButtonSelect/\ButtonRight}
      \opt{ONDIO_PAD,IPOD_4G_PAD,IPOD_3G_PAD,IPOD_VIDEO_PAD,IRIVER_H10_PAD}{\ButtonRight} 
      & Selects option \\
      %
      \opt{RECORDER_PAD,IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOff/\ButtonLeft}
      \opt{IAUDIO_X5_PAD,ONDIO_PAD,IPOD_4G_PAD,IPOD_3G_PAD,IPOD_VIDEO_PAD,IRIVER_H10_PAD}{\ButtonLeft} 
      & Exits menu, setting or moves to parent menu\\
    \end{btnmap}
  \end{table}
}
\opt{PLAYER_PAD}{
  \begin{table}
    \begin{btnmap}{}{}
      %
      \ButtonLeft  & Selects previous option in the menu.\\
                   & Inside an setting, decreases the value or chooses previous option \\
      %
      \ButtonRight & Selects next option in the menu.\\
                   & Inside an setting increases the value or chooses next option \\
      %
      \ButtonPlay  & Selects item \\
      %
      \ButtonStop  & Exit menu, setting or moves to parent menu.\\
    \end{btnmap}
  \end{table}
}

\section {Recent Bookmarks}
\screenshot{main_menu/images/ss-list-bookmarks}%
  {The list bookmarks screen}{}
If the \setting{Save a list of recently created bookmarks} option is enabled 
then you can view a list of several recent bookmarks here and select one to 
jump straight to that track. See \reference{ref:Bookmarkconfigactual} 
for more details on configuring bookmarking in Rockbox.
\note{This entry is not shown in the \setting{Main Menu} when the option is off
  and the option is off by default.}

\section{Files}
Browse the files on your \dap{} (see \reference{ref:file_browser}).

\section{Database}
Browse by the meta-data in your audio files (see \reference{ref:database}).

\section{Now Playing/Resume Playback}
Go to the \setting{While Playing Screen} and resume if music playback is
stopped or paused and there is something to resume (see \reference{ref:WPS}).

\section{Settings}

The \setting{Settings} menu allows to set or adjust many parameters that affect
the way your \dap{} works. There are many submenus for different parameter
areas. Every time you are setting a value of a parameter, and that value is
selected from a list of some predefined available values, you can press
\ActionStdContext, and the selection cursor will jump to the default value for
the parameter. You can then confirm or cancel the value. This is useful if you
have changed the value of the parameter from the default to some other value and
would like to restore the default value.

\subsection{Sound Settings}
The \setting{Sound Settings} menu offers a selection of sound properties you may 
change to customise your listening experience. The details of this menu are covered
in \reference{ref:configure_rockbox_sound}.

\subsection{General Settings}
The \setting{General Settings} menu allows you to customise the way Rockbox looks 
and the way it plays music. The details of this menu are covered in
\reference{ref:configure_rockbox_general}.

\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
resetting your \dap{} back to initial configuration.
%
\opt{MASCODEC}{This menu also allows the user to load different versions of the 
Rockbox firmware.}
%
The details of this menu are covered in
\reference{ref:manage_settings}.

\subsection{Theme Settings}
The \setting{Theme Settings} menu contains options that control the visual
apperance of Rockbox. The details of this menu are covered in
\reference{ref:configure_rockbox_themes}.

\opt{recording}{
\subsection{Recording Settings}
The \setting{Recording Settings} menu allows you to configure settings related
to recording. The details of this menu are covered in detail in
\reference{ref:Recordingsettings}.

\input{main_menu/recording_screen.tex}
}

\opt{radio}{\input{main_menu/fmradio.tex}}

\section{\label{ref:playlistoptions}Playlist}
  This menu allows you to work with playlists. Playlists can be created in 
  three ways. Playing a file in a directory causes all the files in it
  to be placed in a playlist. Playlists can be created manually by
  either using the  \setting{Context Menu} (see \reference{ref:Contextmenu}) or using
  the \setting{Playlist} menu. Both automatically and manually created
  playlists can be edited using this menu.

\begin{description}
\item[Create Playlist:]
  Rockbox will create a playlist with all tracks in the current directory 
and all sub-directories. The playlist will be created one directory level ``up'' 
from where you currently are.
  
\item[View Current Playlist:]
  Displays the contents of the playlist currently stored in memory.
  
\item[Save Current Playlist:]
  Saves the current dynamic playlist, excluding queued tracks, to the 
specified file. If no path is provided then playlist is saved to current 
directory (see \reference{ref:Playlistsubmenu}).

\item[Playlist Catalog:]
  The \setting{Playlist Catalog} provides a simple interface to maintain
  several playlist (see \reference{label:WorkingWithPlaylists}).
\end{description}

\section{Plugins}
  With this option you can load and run various plugins that have been
written for Rockbox. There are a wide variety of these supplied with
Rockbox, including several games, some impressive demos and a number of
utilities. A detailed description of the different plugins is to be found in 
\reference{ref:plugins}.

\section{\label{ref:Info}System}
  This option shows RAM buffer size, battery voltage level and estimated time
remaining, disk total space and disk free space.
\opt{player}{Use the MINUS and PLUS keys to step through several 
pages of information.}

\begin{description}
\item[Rockbox Info:]
  Displays some basic system information. This is, from top to bottom,
  the amount of memory Rockbox has available for storing music (the buffer).
  The battery status.
\opt{multivolume}{%
  Memory size and amount of free space on the two data volumes, this info is
  given seperately for internal memory (\emph{Int}) and for a plugged in
  memory card
  \opt{ondio}{(\emph{MMC})}
  \opt{sansa}{(\emph{MSD})}.
}%
\nopt{multivolume}{Hard disk size and the amount of free space on the disk.}

\item[Version:]
  Software version and credits display.
  
\item[Sleep Timer:]
  The \setting{Sleep Timer} powers off your \dap{} after playing for a given
  time. It can be set from \setting{Off} to 5 hours in 5 minute steps.
  The \setting{Sleep Timer} is reset on boot.
  \opt{alarm}{Using this option disables the \setting{Wake up alarm}.}

\item[Debug (Keep Out!):]
  This sub menu is intended to be used \emph{only} by Rockbox developers.
  It shows hardware, disk, battery status and other technical information.  
  \warn{It is not recommended that users access this menu unless instructed to
  do so in the course of fixing a problem with Rockbox. If you think you have 
  messed up your settings by use of this menu please try to reset \emph{all} 
  settings before asking for help.}
\end{description}

\opt{player}{
  \section{Shutdown}
  This menu option saves the Rockbox configuration and turns off the hard
  drive before shutting down the machine. For maximum safety this procedure
  is recommended when turning off the \dap. (There is a very small risk
  of hard disk corruption otherwise.) See \reference{ref:Safeshutdown}
  for more details.
}

\nopt{PLAYER_PAD,ONDIO_PAD}
{
\section{Quick Screen}
  Whilst not strictly part of the \setting{Main Menu}, it is worth noting that
  a few of the more commonly used settings are available from the
  \setting{Quick Screen}.
  The \setting{Quick Screen} screen is accessed with \ActionStdQuickScreen{}
  and exited with the same button.
  It allows rapid access to the \setting{Shuffle} and \setting{Repeat}
  modes (\reference{ref:PlaybackOptions}) and the \setting{Show Files}
  option (\reference{ref:ShowFiles}).
}