summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--manual/rockbox_interface/tagcache.tex33
1 files changed, 18 insertions, 15 deletions
diff --git a/manual/rockbox_interface/tagcache.tex b/manual/rockbox_interface/tagcache.tex
index 149fbeaa97..297333ffd3 100644
--- a/manual/rockbox_interface/tagcache.tex
+++ b/manual/rockbox_interface/tagcache.tex
@@ -6,9 +6,12 @@ This chapter describes the Rockbox music database system. Using the information
6contained in the tags (ID3v1, ID3v2% 6contained in the tags (ID3v1, ID3v2%
7 \opt{swcodec}{, Vorbis Comments, Apev2, etc.}% 7 \opt{swcodec}{, Vorbis Comments, Apev2, etc.}%
8) in your audio files, Rockbox builds and maintains a database of the music 8) in your audio files, Rockbox builds and maintains a database of the music
9files on your player and allows you to browse them by Artist, Album and Genre. 9files on your player and allows you to browse them by Artist, Album, Genre,
10Song Name, etc. The criteria the database uses to sort the songs can be completely
11 customised. More information on how to achieve this can be found on the Rockbox
12 website at \wikilink{DataBase}.
10 13
11\subsection{Initializing the database} 14\subsection{Initializing the Database}
12The first time you use the database, Rockbox will scan your disk for audio files. 15The first time you use the database, Rockbox will scan your disk for audio files.
13This can take quite a while depending on the number of files on your \dap{}. 16This can take quite a while depending on the number of files on your \dap{}.
14This scan happens in the background, so you can choose to return to the 17This scan happens in the background, so you can choose to return to the
@@ -17,7 +20,7 @@ If you shut down your player, the scan will continue next time you turn it on.
17After the scan is finished you may be prompted to restart your \dap{} before 20After the scan is finished you may be prompted to restart your \dap{} before
18you can use the database. 21you can use the database.
19 22
20\subsubsection{Ignoring directories during database initialization} 23\subsubsection{Ignoring Directories During Database Initialization}
21 24
22You may have directories on your \dap{} whose contents should not be added 25You may have directories on your \dap{} whose contents should not be added
23to the database. Placing a file named \fname{database.ignore} in a directory 26to the database. Placing a file named \fname{database.ignore} in a directory
@@ -33,7 +36,7 @@ its subdirectories will be scanned and added to the database.
33 36
34\begin{description} 37\begin{description}
35 \opt{swcodec}{ 38 \opt{swcodec}{
36 \item[Load To Ram.] 39 \item[Load To RAM]
37 The database can either be kept on disk (to save memory), or 40 The database can either be kept on disk (to save memory), or
38 loaded into RAM (for fast browsing). Setting this to \setting{Yes} loads 41 loaded into RAM (for fast browsing). Setting this to \setting{Yes} loads
39 the database to RAM, allowing faster browsing and searching. Setting this 42 the database to RAM, allowing faster browsing and searching. Setting this
@@ -45,7 +48,7 @@ its subdirectories will be scanned and added to the database.
45 the disk will not need to spin on each search.} 48 the disk will not need to spin on each search.}
46 } 49 }
47 50
48\item[Auto Update.] 51\item[Auto Update]
49 If \setting{Auto update} is set to \setting{on}, each time the \dap{} 52 If \setting{Auto update} is set to \setting{on}, each time the \dap{}
50 boots, the database will automatically be updated. 53 boots, the database will automatically be updated.
51 \opt{swcodec}{ 54 \opt{swcodec}{
@@ -58,14 +61,14 @@ its subdirectories will be scanned and added to the database.
58 \opt{MASCODEC}{\setting{Auto Update} does not detect deleted files. To remove 61 \opt{MASCODEC}{\setting{Auto Update} does not detect deleted files. To remove
59 deleted files from the database you need to run \setting{Update Now}.}% 62 deleted files from the database you need to run \setting{Update Now}.}%
60 63
61\item[Initialize Now.] 64\item[Initialize Now]
62 You can force Rockbox to rescan your disk for tagged files by 65 You can force Rockbox to rescan your disk for tagged files by
63 using the \setting{Initialize Now} function in the \setting{Database 66 using the \setting{Initialize Now} function in the \setting{Database
64 Menu}. 67 Menu}.
65 \warn{\setting{Initialize Now} removes all database files (removing 68 \warn{\setting{Initialize Now} removes all database files (removing
66 runtimedb data also) and rebuilds the database from scratch.} 69 runtimedb data also) and rebuilds the database from scratch.}
67 70
68\item[Update Now.] 71\item[Update Now]
69 \setting{Update now} causes the database to detect new and deleted files 72 \setting{Update now} causes the database to detect new and deleted files
70 \opt{swcodec}{ 73 \opt{swcodec}{
71 \note{Unlike the \setting{Auto Update} function, \setting{Update Now} 74 \note{Unlike the \setting{Auto Update} function, \setting{Update Now}
@@ -77,13 +80,13 @@ its subdirectories will be scanned and added to the database.
77 Unlike \setting{Initialize Now}, the \setting{Update Now} function 80 Unlike \setting{Initialize Now}, the \setting{Update Now} function
78 does not remove runtime database information. 81 does not remove runtime database information.
79 82
80\item[Gather Runtime Data.] 83\item[Gather Runtime Data]
81 When enabled, rockbox will record how often and how long a track is being played, 84 When enabled, rockbox will record how often and how long a track is being played,
82 when it was last played and its rating. This information can be displayed in 85 when it was last played and its rating. This information can be displayed in
83 the WPS and is used in the database browser to, for example, show the most played, 86 the WPS and is used in the database browser to, for example, show the most played,
84 unplayed and most recently played tracks. 87 unplayed and most recently played tracks.
85 88
86\item[Export Modifications.] 89\item[Export Modifications]
87 This allows for the runtime data to be exported to the file \\ 90 This allows for the runtime data to be exported to the file \\
88 \fname{/.rockbox/database\_changelog.txt}, which backs up the runtime data in 91 \fname{/.rockbox/database\_changelog.txt}, which backs up the runtime data in
89 ASCII format. This is needed when database structures change, because new 92 ASCII format. This is needed when database structures change, because new
@@ -97,10 +100,10 @@ its subdirectories will be scanned and added to the database.
97 100
98\end{description} 101\end{description}
99 102
100\subsection{Using the database} 103\subsection{Using the Database}
101Once the database has been initialized, you can browse your music by Artist, 104Once the database has been initialized, you can browse your music
102Album, Genre and Song Name. To use the database, go to the \setting{Main Menu} 105by Artist, Album, Genre, Song Name, etc. To use the database, go to the
103and select \setting{Database}.\\ 106 \setting{Main Menu} and select \setting{Database}.\\
104 107
105\note{You may need to increase the value of the \setting{Max files in dir 108\note{You may need to increase the value of the \setting{Max files in dir
106browser} setting (\setting{Settings $\rightarrow$ General Settings 109browser} setting (\setting{Settings $\rightarrow$ General Settings
@@ -109,8 +112,8 @@ tracks in the ID3 database browser.\\
109 112
110There is no option to turn off database completely. If you do not want 113There is no option to turn off database completely. If you do not want
111to use it just do not do the initial build of the database and do not load it 114to use it just do not do the initial build of the database and do not load it
112to RAM.} 115to RAM.}%
113% 116
114\begin{table} 117\begin{table}
115\begin{center} 118\begin{center}
116 \begin{tabularx}{.75\textwidth}{XXX}% 119 \begin{tabularx}{.75\textwidth}{XXX}%