diff options
Diffstat (limited to 'manual')
-rwxr-xr-x | manual/configure_rockbox/file_view.tex | 118 | ||||
-rwxr-xr-x | manual/configure_rockbox/playback_options.tex | 353 | ||||
-rwxr-xr-x | manual/configure_rockbox/sound_settings.tex | 4 | ||||
-rwxr-xr-x | manual/getting_started/ipod_install.tex | 2 | ||||
-rw-r--r-- | manual/getting_started/main.tex | 4 | ||||
-rw-r--r-- | manual/main_menu/main.tex | 12 | ||||
-rw-r--r-- | manual/plugins/main.tex | 2 | ||||
-rw-r--r-- | manual/plugins/wormlet.tex | 2 | ||||
-rw-r--r-- | manual/rockbox_interface/tagcache.tex | 123 | ||||
-rw-r--r-- | manual/rockbox_interface/wps.tex | 2 |
10 files changed, 319 insertions, 303 deletions
diff --git a/manual/configure_rockbox/file_view.tex b/manual/configure_rockbox/file_view.tex index 5170215bd4..dfbbb3aa8f 100755 --- a/manual/configure_rockbox/file_view.tex +++ b/manual/configure_rockbox/file_view.tex | |||
@@ -1,64 +1,64 @@ | |||
1 | % $Id$ % | 1 | % $Id$ % |
2 | \section{File View} | 2 | \section{File View} |
3 | The File View menu deals with options relating to how the File Browser | 3 | The File View menu deals with options relating to how the File Browser |
4 | displays files. | 4 | displays files. |
5 | % | ||
6 | \begin{description} | ||
7 | \item[Sort Case Sensitive:] | ||
8 | If this option is set to \setting{Yes}, all files that start with upper case | ||
9 | letters will be listed first, followed by all files that begin with lower | ||
10 | case letters. If this option is set to NO, then case will be ignored when | ||
11 | sorting files. | ||
12 | \item[Sort Directories:] | ||
13 | This option controls how Rockbox sorts folders. The default is to sort | ||
14 | them alphabetically. \setting{By date} sorts them with the oldest folder first. | ||
15 | \setting{By newest date} sorts them with the newest folder first. | ||
16 | |||
17 | \item[Sort Files:] | ||
18 | This option controls how Rockbox sorts files. All of the options for | ||
19 | \setting{Sort Directories} are available in this option. In addition, there | ||
20 | is a \setting{By type} option which sorts files alphabetically by their type | ||
21 | (such as \fname{.mp3}) then alphabetically within each type. | ||
22 | |||
23 | \item[\label{ref:ShowFiles}Show Files:] | ||
24 | This option controls which files are displayed in the File Browser. | ||
5 | % | 25 | % |
6 | \begin{description} | 26 | \begin{description} |
7 | \item[Sort Case Sensitive:] | 27 | \item[All:] The File Browser displays all files and directories. |
8 | If this option is set to \setting{Yes}, all files that start with upper case | 28 | Extensions are shown. No files or directories are hidden. |
9 | letters will be listed first, followed by all files that begin with lower | 29 | \item[ID3 Database:] This shows the files based on the Tag Cache |
10 | case letters. If this option is set to NO, then case will be ignored when | 30 | information, thus disabling the file browser. You can browse the |
11 | sorting files. | 31 | database by various tags and search them. Only information present |
12 | \item[Sort Directories:] | 32 | in music file tags are shown. For a detailed description of Tag Cache |
13 | This option controls how Rockbox sorts folders. The default is to sort | 33 | refer to \reference{ref:tagcache}. |
14 | them alphabetically. \setting{By date} sorts them with the oldest folder first. | 34 | \item[Playlists:] The File Browser displays only directories and playlists, |
15 | \setting{By newest date} sorts them with the newest folder first. | 35 | for simplified navigation. |
16 | 36 | \item[Music:] The File Browser displays only folders, \fname{.m3u} files | |
17 | \item[Sort Files:] | 37 | and the supported \emph{audio} file formats. Extensions are stripped. |
18 | This option controls how Rockbox sorts files. All of the options for | 38 | Files and directories starting with \fname{.} or with the ``hidden'' |
19 | \setting{Sort Directories} are available in this option. In addition, there | 39 | flag set are hidden. |
20 | is a \setting{By type} option which sorts files alphabetically by their type | 40 | \item[Supported:] The File Browser displays all directories and files |
21 | (such as \fname{.mp3}) then alphabetically within each type. | 41 | supported by Rockbox (see \reference{ref:Supportedfileformats}). |
22 | 42 | Files and directories starting with \fname{.} or with the ``hidden'' | |
23 | \item[\label{ref:ShowFiles}Show Files:] | 43 | flag set are hidden. |
24 | This option controls which files are displayed in the File Browser. | ||
25 | % | ||
26 | \begin{description} | ||
27 | \item[All:] The File Browser displays all files and directories. | ||
28 | Extensions are shown. No files or directories are hidden. | ||
29 | \item[ID3 Database:] This shows the files based on the Tag Cache | ||
30 | information, thus disabling the file browser. You can browse the | ||
31 | database by various tags and search them. Only information present | ||
32 | in music file tags are shown. For a detailed description of Tag Cache | ||
33 | refer to \reference{ref:tagcache}. | ||
34 | \item[Playlists:] The File Browser displays only directories and playlists, | ||
35 | for simplified navigation. | ||
36 | \item[Music:] The File Browser displays only folders, \fname{.m3u} files | ||
37 | and the supported \emph{audio} file formats. Extensions are stripped. | ||
38 | Files and directories starting with \fname{.} or with the ``hidden'' | ||
39 | flag set are hidden. | ||
40 | \item[Supported:] The File Browser displays all directories and files | ||
41 | supported by Rockbox (see \reference{ref:Supportedfileformats}). | ||
42 | Files and directories starting with \fname{.} or with the ``hidden'' | ||
43 | flag set are hidden. | ||
44 | \end{description} | ||
45 | |||
46 | \item[Follow Playlist:] | ||
47 | This option determine what directory the File Browser | ||
48 | displays first. If \setting{Follow Playlist} is set to \setting{Yes}, when | ||
49 | you enter the File Browser from the WPS, you will find yourself in the same | ||
50 | directory as the currently playing file. If \setting{Follow Playlist} is set | ||
51 | to \setting{No}, when you enter the File Browser from the WPS, you will find | ||
52 | yourself in the directory you were in when you last left the File Browser. | ||
53 | |||
54 | \item[Show Icons:] | ||
55 | Rockbox has the ability to display an icon to the left of the file | ||
56 | in the File Browser. For details of these icons, please see | ||
57 | \reference{ref:Supportedfileformats}. | ||
58 | |||
59 | \item[Tag Cache:] | ||
60 | This option allows you to configure the Tag Cache. | ||
61 | See \reference{ref:tagcache} for more information about using | ||
62 | the Tag Cache. | ||
63 | |||
64 | \end{description} | 44 | \end{description} |
45 | |||
46 | \item[Follow Playlist:] | ||
47 | This option determines what directory the File Browser displays first. If | ||
48 | \setting{Follow Playlist} is set to \setting{Yes}, when you enter the File | ||
49 | Browser from the WPS, you will find yourself in the same directory as the | ||
50 | currently playing file. If \setting{Follow Playlist} is set to \setting{No}, | ||
51 | when you enter the File Browser from the WPS, you will find yourself in the | ||
52 | directory you were in when you last left the File Browser. | ||
53 | |||
54 | \item[Show Icons:] | ||
55 | Rockbox has the ability to display an icon to the left of the file | ||
56 | in the File Browser. For details of these icons, please see | ||
57 | \reference{ref:Supportedfileformats}. | ||
58 | |||
59 | \item[Tag Cache:] | ||
60 | This option allows you to configure the Tag Cache. | ||
61 | See \reference{ref:tagcache} for more information about using | ||
62 | the Tag Cache. | ||
63 | |||
64 | \end{description} | ||
diff --git a/manual/configure_rockbox/playback_options.tex b/manual/configure_rockbox/playback_options.tex index 2de8a09300..e2217f136c 100755 --- a/manual/configure_rockbox/playback_options.tex +++ b/manual/configure_rockbox/playback_options.tex | |||
@@ -1,191 +1,206 @@ | |||
1 | % $Id$ % | 1 | % $Id$ % |
2 | \section{\label{ref:PlaybackOptions}Playback Options} | 2 | \section{\label{ref:PlaybackOptions}Playback Options} |
3 | The \setting{Playback Options} submenu allows you to configure settings | 3 | The \setting{Playback Options} submenu allows you to configure settings |
4 | related to audio playback. | 4 | related to audio playback. |
5 | \begin{description} | ||
6 | \item[Shuffle: ]Alters how Rockbox will select which next song to play.\\ | ||
7 | Options: \setting{On}/\setting{Off}. | ||
8 | % | ||
9 | \item[Repeat: ]Configures settings related to repeating of directories or | ||
10 | playlists.\\ | ||
11 | Options: \setting{Off} / \setting{All} / \setting{One} / \setting{Shuffle} | ||
12 | \nopt{ondiosp,ondiofm}{\setting{/A--B}}: | ||
5 | \begin{description} | 13 | \begin{description} |
6 | \item[Shuffle: ]Alters how Rockbox will select which next song to play.\\ | 14 | % |
7 | Options: \setting{On}/\setting{Off}. | 15 | \item[Off: ]The current directory or playlist will not repeat |
8 | % | 16 | when it is finished. |
9 | \item[Repeat: ]Configures settings related to repeating of directories or | 17 | \note{If you have the \setting{Auto change directory} option set to |
10 | playlists.\\ | 18 | \setting{Yes}, Rockbox will move on to the next directory on your |
11 | Options: \setting{Off} / \setting{All} / \setting{One} / \setting{Shuffle} | 19 | hard drive. If the \setting{Auto Change Directory} option is set to |
12 | \nopt{ondiosp,ondiofm}{\setting{/A--B}}: | 20 | \setting{No}, playback will stop when the current directory or |
13 | \begin{description} | 21 | playlist is finished.} |
14 | % | 22 | % |
15 | \item[Off: ]The current directory or playlist will not repeat | 23 | \item[All: ]The current directory or playlist will repeat when it is |
16 | when it is finished. | 24 | finished. |
17 | \note{If you have the \setting{Auto change directory} option set to | 25 | \note{This option does \emph{not} shuffle all files on your \dap. |
18 | \setting{Yes}, Rockbox will move on to the next directory on your | 26 | Rockbox is playlist oriented. When you play a song, a directory, or |
19 | hard drive. If the \setting{Auto Change Directory} option is set to | 27 | an album, Rockbox creates a playlist and plays it. Thus, to shuffle |
20 | \setting{No}, playback will stop when the current directory or | 28 | all songs on the \dap, you need to create a playlist of all songs on |
21 | playlist is finished.} | 29 | the player, and play that playlist with shuffle mode set to |
22 | % | 30 | \setting{All}.} |
23 | \item[All: ]The current directory or playlist will repeat when it is | 31 | % |
24 | finished. | 32 | \item[One: ]Repeat one track over and over. |
25 | \note{This option does \emph{not} shuffle all files on your \dap. | 33 | % |
26 | Rockbox is playlist oriented. When you play a song, a directory, or | 34 | \item[Shuffle: ]When the current directory or playlist has finished |
27 | an album, Rockbox creates a playlist and plays it. Thus, to shuffle | 35 | playing, it will be shuffled and then repeated. |
28 | all songs on the \dap, you need to create a playlist of all songs on | 36 | % |
29 | the player, and play that playlist with shuffle mode set to | 37 | \nopt{ondiosp,ondiofm}{ |
30 | \setting{All}.} | 38 | \item[A--B: ]Repeats between two user defined point within a track, |
31 | % | 39 | typically used by musicians when attempting to learn a piece of music. |
32 | \item[One: ]Repeat one track over and over. | 40 | This option is more complicated to use that the others as the \dap\ |
33 | % | 41 | must first be placed into A--B repeat mode and then the start and end |
34 | \item[Shuffle: ]When the current directory or playlist has finished | 42 | points defined.\\ |
35 | playing, it will be shuffled and then repeated. | 43 | \fixme{ |
36 | % | 44 | Hold Play and press Left --- Sets Start Point (A)\\ |
37 | \nopt{ondiosp,ondiofm}{ | 45 | Hold Play and press Right --- Sets End Point (B)\\ |
38 | \item[A--B: ]Repeats between two user defined point within a track, | 46 | } |
39 | typically used by musicians when attempting to learn a piece of music. | 47 | } |
40 | This option is more complicated to use that the others as the \dap\ | 48 | \end{description} |
41 | must first be placed into A--B repeat mode and then the start and end | 49 | |
42 | points defined.\\ | 50 | \item[Play Selected First: ]This setting controls what happens when you |
43 | \fixme{ | 51 | select a file for playback while shuffle mode is on. If the |
44 | Hold Play and press Left --- Sets Start Point (A)\\ | 52 | \setting{Play Selected First} setting is \setting{Yes}, the file you |
45 | Hold Play and press Right --- Sets End Point (B)\\ | 53 | selected will be played first. If this setting is \setting{No}, a random |
46 | } | 54 | file in the directory will be played first. |
47 | } | 55 | |
48 | \end{description} | 56 | \item[Resume: ]Rockbox can be configured to start playing automatically |
49 | 57 | when you turn on the \dap. If the resume function is set to start | |
50 | \item[Play Selected First: ]This setting controls what happens when you | 58 | automatically playing, Rockbox will start at the point where you last |
51 | select a file for playback while shuffle mode is on. If the | 59 | turned off the \dap. The options for the \setting{Resume} function are: |
52 | \setting{Play Selected First} setting is \setting{Yes}, the file you | 60 | \begin{description} |
53 | selected will be played first. If this setting is \setting{No}, a random | 61 | \item[Yes: ]Rockbox will unconditionally try to resume. |
54 | file in the directory will be played first. | 62 | \item[No: ]Rockbox will not resume. |
55 | 63 | \emph{If resume is set to \setting{No}, Rockbox will start in the | |
56 | \item[Resume: ]Rockbox can be configured to start playing automatically | 64 | \setting{File Browser}.} |
57 | when you turn on the \dap. If the resume function is set to start | 65 | \end{description} |
58 | automatically playing, Rockbox will start at the point where you last | 66 | \note{Earlier versions of Rockbox had an ``Ask'' setting, which would ask |
59 | turned off the \dap. The options for the \setting{Resume} function are: | 67 | whether to resume when the jukebox was turned on. This setting has been |
60 | \begin{description} | 68 | eliminated because it was redundant. If resume is set to ``Yes'' pressing |
61 | \item[Yes: ]Rockbox will unconditionally try to resume. | 69 | \opt{PLAYER_PAD,RECORDER_PAD,IAUDIO_X5_PAD,IPOD_4G_PAD}{\fixme{FixMe}} |
62 | \item[No: ]Rockbox will not resume. | 70 | \opt{ONDIO_PAD}{\fixme{FixMe}} |
63 | \emph{If resume is set to \setting{No}, Rockbox will start in the | 71 | \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOn} |
64 | \setting{File Browser}.} | 72 | on the \dap\ will resume from the point where the \dap\ was stopped before |
65 | \end{description} | 73 | shutdown. |
66 | \note{Earlier versions of Rockbox had an ``Ask'' setting, which would ask whether | 74 | |
67 | to resume when the jukebox was turned on. This setting has been eliminated because it | 75 | \item[Fast-Forward/Rewind: ]How fast you want search (fast forward or rewind) |
68 | was redundant. If resume is set to ``Yes'' pressing | 76 | to accelerate when you hold down the button. \setting{Off} means no |
69 | \opt{PLAYER_PAD,RECORDER_PAD,IAUDIO_X5_PAD,IPOD_4G_PAD}{\fixme{FixMe}} | 77 | acceleration. \setting{2x/1s} means double the search speed once every |
70 | \opt{ONDIO_PAD}{\fixme{FixMe}} | 78 | second the button is held. \setting{2x/5s} means double the search speed |
71 | \opt{IRIVER_H100_PAD,IRIVER_H300_PAD}{\ButtonOn} | 79 | once every 5 seconds the button is held. |
72 | on the \dap\ will resume from the point where the \dap\ was stopped before shutdown. | 80 | |
73 | 81 | \item[Anti-Skip Buffer: ]This setting allows you to control how much music is | |
74 | \item[Fast-Forward/Rewind: ]How fast you want search (fast forward or rewind) to accelerate | 82 | stored in the \dap's memory whilst playing a song, acting as a buffer |
75 | when you hold down the button. \setting{Off} means no acceleration. \setting{2x/1s} means double | 83 | against shock or playback problems. The \dap\ transfers the selected amount |
76 | the search speed once every second the button is held. \setting{2x/5s} means double the | 84 | of the forthcoming song into its memory at high speed whilst you are |
77 | search speed once every 5 seconds the button is held. | 85 | playing the song. It keeps a ``rolling'' buffer, which keeps feeding more |
78 | 86 | of the forthcoming song into memory as it goes along. | |
79 | \item[Anti-Skip Buffer: ]This setting allows you to control how much music is stored | 87 | If the \dap\ is knocked, shaken or jogged heavily while Rockbox is trying |
80 | in the \dap's memory whilst playing a song, acting as a buffer against shock or | 88 | to read the hard drive, Rockbox might not be able to read the drive. |
81 | playback problems. The \dap\ transfers the selected amount of the forthcoming song | 89 | Rockbox will retry over and over again until it succeeds, but may |
82 | into its memory at high speed whilst you are playing the song. It keeps a ``rolling'' | 90 | eventually reach the end of the memory buffer. When that happens, Rockbox |
83 | buffer, which keeps feeding more of the forthcoming song into memory as it goes along. | 91 | must stop playing and wait for more data from the disk, which causes your |
84 | If the \dap\ is knocked, shaken or jogged heavily while Rockbox is trying to read the | 92 | music to skip. The anti-skip setting tells Rockbox how much extra buffer |
85 | hard drive, Rockbox might not be able to read the drive. Rockbox will retry over and | 93 | memory to spare to handle this situation. This setting therefore allows you |
86 | over again until it succeeds, but may eventually reach the end of the memory buffer. | 94 | to reduce the chances of there being a gap or pause during playback of |
87 | When that happens, Rockbox must stop playing and wait for more data from the disk, | 95 | songs. |
88 | which causes your music to skip. The anti-skip setting tells Rockbox how much extra | 96 | |
89 | buffer memory to spare to handle this situation. This setting therefore allows you to | 97 | \opt{MASCODEC}{The anti-skip buffer can be set to a value between 0 and 7 |
90 | reduce the chances of there being a gap or pause during playback of songs. | 98 | seconds.} |
91 | |||
92 | \opt{MASCODEC}{The anti-skip buffer can be set to a value between 0 and 7 seconds.} | ||
93 | \opt{SWCODEC}{The anti-skip buffer can be set to various values between | 99 | \opt{SWCODEC}{The anti-skip buffer can be set to various values between |
94 | 5 seconds and 10 minutes.} | 100 | 5 seconds and 10 minutes.} |
95 | 101 | ||
96 | \note{Having a large anti-skip buffer tends to use more power, and may | 102 | \note{Having a large anti-skip buffer tends to use more power, and may |
97 | reduce your battery life. It is recommended to always use the lowest | 103 | reduce your battery life. It is recommended to always use the lowest |
98 | possible setting that allows correct and continuous playback.} | 104 | possible setting that allows correct and continuous playback.} |
99 | 105 | ||
100 | \item[Fade On Stop/Pause: ]Enables and disables a fade effect when you | 106 | \item[Fade On Stop/Pause: ]Enables and disables a fade effect when you |
101 | pause or stop playing a song. If the Fade on Stop/Pause option is | 107 | pause or stop playing a song. If the Fade on Stop/Pause option is |
102 | set to \setting{Yes}, your music will fade out when you stop or pause playback, | 108 | set to \setting{Yes}, your music will fade out when you stop or pause |
103 | and fade in when you resume playback. | 109 | playback, and fade in when you resume playback. |
104 | 110 | ||
105 | \item[Party Mode: ]Enables unstoppable music playback. When new songs are | 111 | \item[Party Mode: ]Enables unstoppable music playback. When new songs are |
106 | selected, they are added to the end of the current dynamic playlist | 112 | selected, they are added to the end of the current dynamic playlist |
107 | instead of being played immediately. | 113 | instead of being played immediately. |
108 | The \fixme{PLAY} and \fixme{STOP} buttons are disabled. | 114 | The \fixme{PLAY} and \fixme{STOP} buttons are disabled. |
109 | 115 | ||
110 | \opt{SWCODEC}{ | 116 | \opt{SWCODEC}{ |
111 | \item[Crossfade: ] | 117 | \item[Crossfade: ] |
112 | This setting enables a cross-fader. At the end of a song, the song will fade out as the | 118 | This setting enables a cross-fader. At the end of a song, the song will |
113 | next song fades in, creating a smooth transition between songs.\\ | 119 | fade out as the next song fades in, creating a smooth transition between |
120 | songs.\\ | ||
114 | Options: | 121 | Options: |
115 | \begin{description} | 122 | \begin{description} |
116 | \item[Enable Crossfade: ]If set to \setting{Off}, crossfade is disabled. If set to \setting{Always}, | 123 | \item[Enable Crossfade: ]If set to \setting{Off}, crossfade is disabled. |
117 | songs will always crossfade into one another. If set to \setting{Shuffle}, crossfade is | 124 | If set to \setting{Always}, songs will always crossfade into one |
118 | enabled when the shuffle feature is set to \setting{Yes}, but disabled otherwise. If set to | 125 | another. If set to \setting{Shuffle}, crossfade is enabled when the |
119 | track skip only, tracks will only crossfade when you manually change tracks. | 126 | shuffle feature is set to \setting{Yes}, but disabled otherwise. If set |
127 | to track skip only, tracks will only crossfade when you manually change | ||
128 | tracks. | ||
120 | % | 129 | % |
121 | \item[Fade In Delay: ]The ``fade in delay'' is the length of time between when the crossfade | 130 | \item[Fade In Delay: ]The ``fade in delay'' is the length of time between |
122 | process begins and when the new track begins to fade in. | 131 | when the crossfade process begins and when the new track begins to fade |
132 | in. | ||
123 | % | 133 | % |
124 | \item[Fade In Duration: ]The length of time, in seconds, that it takes your music to fade in. | 134 | \item[Fade In Duration: ]The length of time, in seconds, that it takes |
135 | your music to fade in. | ||
125 | % | 136 | % |
126 | \item[Fade Out Delay: ]The ``fade out delay'' is the length of time between when the crossfade | 137 | \item[Fade Out Delay: ]The ``fade out delay'' is the length of time |
127 | process begins and when the old track begins to fade out. | 138 | between when the crossfade process begins and when the old track begins |
139 | to fade out. | ||
128 | % | 140 | % |
129 | \item[Fade Out Duration: ]The length of time, in seconds, that it takes your music to fade out. | 141 | \item[Fade Out Duration: ]The length of time, in seconds, that it takes |
142 | your music to fade out. | ||
130 | % | 143 | % |
131 | \item[Fade Out Mode: ]If set to \setting{Crossfade}, one song will fade out and the next song will | 144 | \item[Fade Out Mode: ]If set to \setting{Crossfade}, one song will fade |
132 | simultaneously fade in. If set to \setting{Mix}, the ending song will continue to play as normal | 145 | out and the next song will simultaneously fade in. If set to |
133 | until its end, while the starting song will fade in from under it. \setting{Mix} mode is not | 146 | \setting{Mix}, the ending song will continue to play as normal until |
147 | its end, while the starting song will fade in from under it. | ||
148 | \setting{Mix} mode is not | ||
134 | used for manual track skips, even if it is selected here. | 149 | used for manual track skips, even if it is selected here. |
135 | \end{description} | 150 | \end{description} |
136 | 151 | ||
137 | \note{The crossfade setting is particularly effective when the player is set on shuffle.} | 152 | \note{The crossfade setting is particularly effective when the player is |
153 | set on shuffle.} | ||
138 | } | 154 | } |
139 | 155 | ||
140 | \opt{SWCODEC}{ | 156 | \opt{SWCODEC}{ |
141 | \item[Replaygain: ]This allows you to control the replaygain function. | 157 | \item[Replaygain: ]This allows you to control the replaygain function. |
142 | The purpose of replaygain is to adjust the volume of the music played | 158 | The purpose of replaygain is to adjust the volume of the music played |
143 | so that all songs (or albums, depending on your settings) have the | 159 | so that all songs (or albums, depending on your settings) have the |
144 | same apparent volume. This prevents sudden changes in volume when | 160 | same apparent volume. This prevents sudden changes in volume when |
145 | changing between songs recorded at different volume levels. | 161 | changing between songs recorded at different volume levels. |
146 | For replaygain to work, the songs must have been processed by a program | 162 | For replaygain to work, the songs must have been processed by a program |
147 | that adds replaygain information to the ID3 tags (vorbis tags | 163 | that adds replaygain information to the ID3 tags (or Vorbis tags). |
148 | respectively). | 164 | \note{APEv2 tags are not currently supported.} |
149 | \note{APEv2 tags are not currently supported.} | 165 | |
150 | 166 | Options for replaygain are: | |
151 | Options for replaygain are: | 167 | \begin{description} |
168 | \item[Enable Replaygain: ]This turns on/off the replaygain function. | ||
169 | % | ||
170 | \item[Prevent Clipping: ]Avoid clipping of a song's waveform. | ||
171 | If a song would clip during playback, the volume is lowered for | ||
172 | that song. Replaygain information is needed for this to work. | ||
173 | % | ||
174 | \item[Replaygain type: ]Choose the type of replaygain to apply: | ||
152 | \begin{description} | 175 | \begin{description} |
153 | \item[Enable Replaygain: ]This turns on/off the replaygain function. | 176 | \item[Album Gain: ]Maintain a constant volume level between |
154 | % | 177 | albums, but keep any intentional volume variations between |
155 | \item[Prevent Clipping: ]Avoid clipping of a song's waveform. | 178 | songs in an album. (If album gain value is not available, |
156 | If a song would clip during playback, the volume is lowered for | 179 | uses track gain information). |
157 | that song. Replaygain information is needed for this to work. | 180 | % |
158 | % | 181 | \item[Track Gain: ]Maintain a constant volume level between |
159 | \item[Replaygain type: ]Choose the type of replaygain to apply: | 182 | tracks. If track gain value is not available, no replaygain |
160 | \begin{description} | 183 | is applied. |
161 | \item[Album Gain: ]Maintain a constant volume level between | 184 | % |
162 | albums, but keep any intentional volume variations between | 185 | \item[Track Gain if Shuffling: ]Maintains a constant volume |
163 | songs in an album. (If album gain value is not available, | 186 | between tracks if shuffle mode is selected. Reverts to album |
164 | uses track gain information). | 187 | mode if shuffle is off. |
165 | % | ||
166 | \item[Track Gain: ]Maintain a constant volume level between | ||
167 | tracks. If track gain value is not available, no replaygain | ||
168 | is applied. | ||
169 | % | ||
170 | \item[Track Gain if Shuffling: ]Maintains a constant volume | ||
171 | between tracks if shuffle mode is selected. Reverts to album | ||
172 | mode if shuffle is off. | ||
173 | \end{description} | ||
174 | % | ||
175 | \item[Pre-Amp: ]This allows you to adjust the volume when replaygain | ||
176 | is applied. Replaygain often lowers the volume, sometimes quite | ||
177 | much, so here you can compensate for that. Please note that a | ||
178 | (large) positive pre-amp setting can cause clipping, unless | ||
179 | prevent clipping is enabled. The pre-amp can be set to any | ||
180 | decibel (dB) value between -12dB and +12dB, in increments of 0.1{}dB. | ||
181 | \end{description} | 188 | \end{description} |
182 | } | 189 | % |
190 | \item[Pre-Amp: ]This allows you to adjust the volume when replaygain | ||
191 | is applied. Replaygain often lowers the volume, sometimes quite | ||
192 | much, so here you can compensate for that. Please note that a | ||
193 | (large) positive pre-amp setting can cause clipping, unless | ||
194 | prevent clipping is enabled. The pre-amp can be set to any | ||
195 | decibel (dB) value between -12dB and +12dB, in increments of 0.1{}dB. | ||
196 | \end{description} | ||
183 | } | 197 | } |
184 | \item[Auto Change Directory: ]Control what Rockbox does when it reaches the end | 198 | } |
185 | of a directory. If Auto Change Directory is set to \setting{Yes}, Rockbox will | 199 | \item[Auto Change Directory: ]Control what Rockbox does when it reaches the end |
186 | continue to the next directory. If \setting{Auto Change Directory} is set to \setting{No}, | 200 | of a directory. If Auto Change Directory is set to \setting{Yes}, Rockbox |
187 | playback will stop at the end of the current directory. | 201 | will continue to the next directory. If \setting{Auto Change Directory} is |
188 | \note{You must have the \setting{Repeat} option set to \setting{No} for \setting{Auto Change Directory} | 202 | set to \setting{No}, playback will stop at the end of the current directory. |
189 | to function properly.} | 203 | \note{You must have the \setting{Repeat} option set to \setting{No} for |
190 | % | 204 | \setting{Auto Change Directory} to function properly.} |
191 | \end{description} | 205 | % |
206 | \end{description} | ||
diff --git a/manual/configure_rockbox/sound_settings.tex b/manual/configure_rockbox/sound_settings.tex index ed39cd1f27..e9b3e2f121 100755 --- a/manual/configure_rockbox/sound_settings.tex +++ b/manual/configure_rockbox/sound_settings.tex | |||
@@ -23,12 +23,12 @@ as a negative number. Volume can be adjusted from a | |||
23 | \opt{player,recorder,recorderv2fm,ondio}{This emphasises or suppresses the | 23 | \opt{player,recorder,recorderv2fm,ondio}{This emphasises or suppresses the |
24 | lower (bass) sounds in the track. 0 means that bass sounds are unaltered | 24 | lower (bass) sounds in the track. 0 means that bass sounds are unaltered |
25 | (flat response).} | 25 | (flat response).} |
26 | \opt{h1xx,h300}{The Bass setting can be used to increase (but not decrease) | 26 | \opt{h1xx,h300}{The bass setting can be used to increase (but not decrease) |
27 | frequencies below 300Hz. Bass boost can be set from 0 to 24 dB in | 27 | frequencies below 300Hz. Bass boost can be set from 0 to 24 dB in |
28 | increments of 2 dB. A setting of 0 means that low frequencies are unaltered | 28 | increments of 2 dB. A setting of 0 means that low frequencies are unaltered |
29 | (flat response).} | 29 | (flat response).} |
30 | \opt{ipodnano,ipodcolor,ipodvideo}{This emphasizes or suppresses the | 30 | \opt{ipodnano,ipodcolor,ipodvideo}{This emphasizes or suppresses the |
31 | lower (Bass) sounds in the track. 0dB means that bass in unaltered | 31 | lower (bass) sounds in the track. 0dB means that bass in unaltered |
32 | (flat response). The minimum setting is -6dB and the maximum is 9dB.} | 32 | (flat response). The minimum setting is -6dB and the maximum is 9dB.} |
33 | \opt{x5}{\fixme{add platform specific information here}} | 33 | \opt{x5}{\fixme{add platform specific information here}} |
34 | 34 | ||
diff --git a/manual/getting_started/ipod_install.tex b/manual/getting_started/ipod_install.tex index d3f9fb8e13..08a6e8d596 100755 --- a/manual/getting_started/ipod_install.tex +++ b/manual/getting_started/ipod_install.tex | |||
@@ -35,7 +35,7 @@ for the next daily builds.} | |||
35 | \item \url{http://download.rockbox.org/bootloader/ipod/ipodpatcher.exe} | 35 | \item \url{http://download.rockbox.org/bootloader/ipod/ipodpatcher.exe} |
36 | \item \url{http://download.rockbox.org/bootloader/ipod/ipod_fw.exe} | 36 | \item \url{http://download.rockbox.org/bootloader/ipod/ipod_fw.exe} |
37 | \end{itemize} | 37 | \end{itemize} |
38 | \item Locate the \dap{} by opening a command windows. You can do this by | 38 | \item Locate the \dap{} by opening a command window. You can do this by |
39 | clicking ``Start'', ``Execute'' and typing \fname{cmd}. Press Enter to | 39 | clicking ``Start'', ``Execute'' and typing \fname{cmd}. Press Enter to |
40 | execute that command. Now change directory to the | 40 | execute that command. Now change directory to the |
41 | folder you created and run the following commands: | 41 | folder you created and run the following commands: |
diff --git a/manual/getting_started/main.tex b/manual/getting_started/main.tex index e5a6c82aa4..0e930ff1a6 100644 --- a/manual/getting_started/main.tex +++ b/manual/getting_started/main.tex | |||
@@ -73,7 +73,7 @@ are used: | |||
73 | here. Notes are used to mark informations that could help you | 73 | here. Notes are used to mark informations that could help you |
74 | or indicate a possible ``weirdness'' in rockbox that would be explained. | 74 | or indicate a possible ``weirdness'' in rockbox that would be explained. |
75 | } | 75 | } |
76 | \warn{This is a warning. In contrast to notes as mentioned above a warning | 76 | \warn{This is a warning. In contrast to notes mentioned above, a warning |
77 | should be taken more seriously. While ignoring notes won't cause any serious | 77 | should be taken more seriously. While ignoring notes won't cause any serious |
78 | damage ignoring warnings \emph{could} cause serious damage. If you're new to | 78 | damage ignoring warnings \emph{could} cause serious damage. If you're new to |
79 | rockbox you should really read the warnings before doing anything that is | 79 | rockbox you should really read the warnings before doing anything that is |
@@ -84,7 +84,7 @@ are used: | |||
84 | read the manual in the same way sighted people can do we've added some | 84 | read the manual in the same way sighted people can do we've added some |
85 | additional descriptions. If you aren't blind or visually impaired you most | 85 | additional descriptions. If you aren't blind or visually impaired you most |
86 | likely can completely skip these blocks. To make this easier, there is an | 86 | likely can completely skip these blocks. To make this easier, there is an |
87 | icon shown in the margin like here. | 87 | icon shown in the margin on the right. |
88 | } | 88 | } |
89 | }{}% end ifpdfoutput | 89 | }{}% end ifpdfoutput |
90 | 90 | ||
diff --git a/manual/main_menu/main.tex b/manual/main_menu/main.tex index 9a27f6fe84..34fc46269b 100644 --- a/manual/main_menu/main.tex +++ b/manual/main_menu/main.tex | |||
@@ -126,12 +126,12 @@ headphones and when connected to an external amplifier. See | |||
126 | \opt{HAVE_RECORDING}{\input{main_menu/recording.tex}} | 126 | \opt{HAVE_RECORDING}{\input{main_menu/recording.tex}} |
127 | 127 | ||
128 | \section{\label{ref:playlistoptions}Playlist Options} | 128 | \section{\label{ref:playlistoptions}Playlist Options} |
129 | This menu allows you to work with playlists. Playlists can either be created | 129 | This menu allows you to work with playlists. Playlists can be created in |
130 | automatically by playing a file in a directory directly, which will cause all | 130 | three ways. Playing a file in a directory causes all the files in the |
131 | of the files in that directory to be placed in the playlist, or they can be | 131 | directory to be placed in a playlist. Playlists can be created manually by |
132 | created by hand using the \setting{File Menu} (see \reference{ref:Filemenu}) | 132 | either using the \setting{File Menu} (see \reference{ref:Filemenu}) or using |
133 | or using the \setting{Playlist Options} menu. Both automatic and manually | 133 | the \setting{Playlist Options} menu. Both automatically and manually created |
134 | created playlists can be edited using this menu. | 134 | playlists can be edited using this menu. |
135 | 135 | ||
136 | \begin{description} | 136 | \begin{description} |
137 | \item[Create Playlist:] | 137 | \item[Create Playlist:] |
diff --git a/manual/plugins/main.tex b/manual/plugins/main.tex index 180bb1a521..cd60a0b55e 100644 --- a/manual/plugins/main.tex +++ b/manual/plugins/main.tex | |||
@@ -5,7 +5,7 @@ be loaded at a time. Plugins have exclusive control over the user interface. | |||
5 | This means you cannot switch back and forth between a plugin and Rockbox, a | 5 | This means you cannot switch back and forth between a plugin and Rockbox, a |
6 | plugin is loaded, run and then exited, which returns control to Rockbox. Most | 6 | plugin is loaded, run and then exited, which returns control to Rockbox. Most |
7 | plugins will not interfere with music playback but some of them will stop | 7 | plugins will not interfere with music playback but some of them will stop |
8 | playback while runnig. Plugins have the file extension \fname{.rock}. Most of | 8 | playback while running. Plugins have the file extension \fname{.rock}. Most of |
9 | them can be started from \setting{Browse Plugins} in the \setting{Main Menu}. | 9 | them can be started from \setting{Browse Plugins} in the \setting{Main Menu}. |
10 | 10 | ||
11 | Viewer plugins get started automatically by opening an associated file (i.e. | 11 | Viewer plugins get started automatically by opening an associated file (i.e. |
diff --git a/manual/plugins/wormlet.tex b/manual/plugins/wormlet.tex index 7a3953de60..73d666c465 100644 --- a/manual/plugins/wormlet.tex +++ b/manual/plugins/wormlet.tex | |||
@@ -117,7 +117,7 @@ game. | |||
117 | Press | 117 | Press |
118 | \opt{RECORDER_PAD}{\ButtonPlay}\opt{ONDIO_PAD}{\ButtonMenu} | 118 | \opt{RECORDER_PAD}{\ButtonPlay}\opt{ONDIO_PAD}{\ButtonMenu} |
119 | \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IPOD_4G_PAD}{\ButtonSelect} | 119 | \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IPOD_4G_PAD}{\ButtonSelect} |
120 | to pause the game. Hit | 120 | to pause the game. Press |
121 | \opt{RECORDER_PAD}{\ButtonPlay}\opt{ONDIO_PAD}{\ButtonMenu} | 121 | \opt{RECORDER_PAD}{\ButtonPlay}\opt{ONDIO_PAD}{\ButtonMenu} |
122 | \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IPOD_4G_PAD}{\ButtonSelect} | 122 | \opt{IRIVER_H100_PAD,IRIVER_H300_PAD,IPOD_4G_PAD}{\ButtonSelect} |
123 | again to resume the game. | 123 | again to resume the game. |
diff --git a/manual/rockbox_interface/tagcache.tex b/manual/rockbox_interface/tagcache.tex index 5fbbeb9755..1343957d87 100644 --- a/manual/rockbox_interface/tagcache.tex +++ b/manual/rockbox_interface/tagcache.tex | |||
@@ -14,67 +14,68 @@ described in the following section. | |||
14 | 14 | ||
15 | \subsection{\label{ref:tagcachemenu}The Tag Cache Menu} | 15 | \subsection{\label{ref:tagcachemenu}The Tag Cache Menu} |
16 | 16 | ||
17 | \begin{description} | 17 | \begin{description} |
18 | \opt{SWCODEC}{ | 18 | \opt{SWCODEC}{ |
19 | \item[Load To Ram: ] | 19 | \item[Load To Ram: ] |
20 | The Tag Cache database can either be kept on disk (to save memory), or | 20 | The Tag Cache database can either be kept on disk (to save memory), or |
21 | loaded into RAM (for fast browsing). Setting this to \setting{Yes} loads | 21 | loaded into RAM (for fast browsing). Setting this to \setting{Yes} loads |
22 | the tagcache to RAM, allowing faster browsing and searching. Setting this | 22 | the tagcache to RAM, allowing faster browsing and searching. Setting this |
23 | option to \setting{No} keeps the tagcache on the disk, meaning slower | 23 | option to \setting{No} keeps the tagcache on the disk, meaning slower |
24 | browsing but it does not use extra RAM and saves some battery on boot up. | 24 | browsing but it does not use extra RAM and saves some battery on boot up. |
25 | 25 | ||
26 | \note{If you use TagCache frequently, you should load to RAM, as this | 26 | \note{If you use TagCache frequently, you should load to RAM, as this |
27 | will reduce the overall battery consumption because the disk will not | 27 | will reduce the overall battery consumption because the disk will not |
28 | need to spin on each search.} | 28 | need to spin on each search.} |
29 | } | 29 | } |
30 | 30 | ||
31 | \item[Auto Update: ] | 31 | \item[Auto Update: ] |
32 | If \setting{Auto update} is set to \setting{on}, each time the play | 32 | If \setting{Auto update} is set to \setting{on}, each time the \dap{} |
33 | boots, Tag Cache will automatically do everything that the | 33 | boots, Tag Cache will automatically do everything that the |
34 | \setting{Update now} setting does. Note that the \setting{Auto | 34 | \setting{Update now} setting does. Note that the \setting{Auto |
35 | Update} will only check for deleted files if the Directory Cache | 35 | Update} will only check for deleted files if the Directory Cache |
36 | (\setting{General Settings $\rightarrow$ System $\rightarrow$ | 36 | (\setting{General Settings $\rightarrow$ System $\rightarrow$ |
37 | Disk $\rightarrow$ Directory Cache}) is enabled. | 37 | Disk $\rightarrow$ Directory Cache}) is enabled. |
38 | "Update now" includes that check whether dircache has been enabled or not. | 38 | \setting{Update now} includes that check whether dircache has been enabled or |
39 | 39 | not. | |
40 | \item[Initialize Now: ] | 40 | |
41 | Before you use the Tag Cache for the first time, you must initialize it by | 41 | \item[Initialize Now: ] |
42 | using the \setting{Initialize Now} function in the \setting{Tag Cache | 42 | Before you use the Tag Cache for the first time, you must initialize it by |
43 | Menu}. \setting{Initialize Now} removes all database files (removing | 43 | using the \setting{Initialize Now} function in the \setting{Tag Cache |
44 | runtimedb data also) and rebuilds the database from scratch. This takes | 44 | Menu}. \setting{Initialize Now} removes all database files (removing |
45 | approximately 5 to 10 minutes, and may require a restart to allow the | 45 | runtimedb data also) and rebuilds the database from scratch. This takes |
46 | files to be committed to the cache. | 46 | approximately 5 to 10 minutes, and may require a restart to allow the |
47 | 47 | files to be committed to the cache. | |
48 | The Tag Cache initialization happens in the background, so you can continue | 48 | |
49 | to listen to music while the Tag Cache is being initialized. If you shut | 49 | The Tag Cache initialization happens in the background, so you can continue |
50 | down your player during initialization, the database building process will | 50 | to listen to music while the Tag Cache is being initialized. If you shut |
51 | continue next time you turn it on. | 51 | down your player during initialization, the database building process will |
52 | 52 | continue next time you turn it on. | |
53 | \item[Update Now: ] | 53 | |
54 | \setting{Update now} causes Tag Cache to detect new and deleted files | 54 | \item[Update Now: ] |
55 | Note that unlike the \setting{Auto Update} function, \setting{Update Now} | 55 | \setting{Update now} causes Tag Cache to detect new and deleted files |
56 | will update the database regardless of whether the \setting{Directory Cache} | 56 | Note that unlike the \setting{Auto Update} function, \setting{Update Now} |
57 | is enabled. Thus, an update using \setting{Update now} may take a long | 57 | will update the database regardless of whether the \setting{Directory Cache} |
58 | time. Unlike \setting{Initialize Now}, the \setting{Update Now} function | 58 | is enabled. Thus, an update using \setting{Update now} may take a long |
59 | does not remove runtime database information. | 59 | time. Unlike \setting{Initialize Now}, the \setting{Update Now} function |
60 | 60 | does not remove runtime database information. | |
61 | \item[Gather Runtime Data (Experimental): ] | 61 | |
62 | When enabled, this option allows the most played, unplayed and most recently | 62 | \item[Gather Runtime Data (Experimental): ] |
63 | played tracks to be logged and scored. | 63 | When enabled, this option allows the most played, unplayed and most recently |
64 | 64 | played tracks to be logged and scored. | |
65 | \item[Export modifications: ] | 65 | |
66 | This allows for the runtime data to be exported into | 66 | \item[Export modifications: ] |
67 | \fname{/.rockbox/tagcache\_changelog.txt}, which backs up the runtime data in | 67 | This allows for the runtime data to be exported into \\ |
68 | ASCII format. This is needed when Tag Cache structures change, because new | 68 | \fname{/.rockbox/tagcache\_changelog.txt}, which backs up the runtime data in |
69 | code cannot read old Tag Cache database code. But, all modifications | 69 | ASCII format. This is needed when Tag Cache structures change, because new |
70 | exported to ASCII format should be readable by all Tag Cache versions. | 70 | code cannot read old Tag Cache database code. But, all modifications |
71 | 71 | exported to ASCII format should be readable by all Tag Cache versions. | |
72 | \item[Import modifications: ] | 72 | |
73 | Allows the \fname{/.rockbox/tagcache\_changelog.txt} backup to be | 73 | \item[Import modifications: ] |
74 | conveniently loaded into the Tag Cache. This is performed automatically when | 74 | Allows the \fname{/.rockbox/tagcache\_changelog.txt} backup to be |
75 | the Tag Cache is initialized. | 75 | conveniently loaded into the Tag Cache. This is performed automatically when |
76 | 76 | the Tag Cache is initialized. | |
77 | \end{description} | 77 | |
78 | \end{description} | ||
78 | 79 | ||
79 | \subsection{Using the Tag Cache} | 80 | \subsection{Using the Tag Cache} |
80 | Once the Tag Cache has been initialized, you can browse your music by Artist, | 81 | Once the Tag Cache has been initialized, you can browse your music by Artist, |
diff --git a/manual/rockbox_interface/wps.tex b/manual/rockbox_interface/wps.tex index 1b9c60760b..7e421aa99a 100644 --- a/manual/rockbox_interface/wps.tex +++ b/manual/rockbox_interface/wps.tex | |||
@@ -11,7 +11,7 @@ currently playing audio file. | |||
11 | \begin{itemize} | 11 | \begin{itemize} |
12 | \item Status bar: The Status bar shows Battery level, charger status, | 12 | \item Status bar: The Status bar shows Battery level, charger status, |
13 | volume, play mode, repeat mode, shuffle mode\opt{CONFIG_RTC}{ and clock}. | 13 | volume, play mode, repeat mode, shuffle mode\opt{CONFIG_RTC}{ and clock}. |
14 | In contrast to all other item the status bar is always at the top of | 14 | In contrast to all other items, the status bar is always at the top of |
15 | the screen. | 15 | the screen. |
16 | \item (Scrolling) path and filename of the current song. | 16 | \item (Scrolling) path and filename of the current song. |
17 | \item The ID3 track name. | 17 | \item The ID3 track name. |