diff options
Diffstat (limited to 'manual')
-rwxr-xr-x | manual/configure_rockbox/file_view.tex | 9 | ||||
-rw-r--r-- | manual/rockbox_interface/tagcache.tex | 124 |
2 files changed, 88 insertions, 45 deletions
diff --git a/manual/configure_rockbox/file_view.tex b/manual/configure_rockbox/file_view.tex index 20b012c329..a5944140f1 100755 --- a/manual/configure_rockbox/file_view.tex +++ b/manual/configure_rockbox/file_view.tex | |||
@@ -56,10 +56,9 @@ | |||
56 | in the File Browser. For details of these icons, please see page | 56 | in the File Browser. For details of these icons, please see page |
57 | \pageref{ref:Supportedfileformats}. | 57 | \pageref{ref:Supportedfileformats}. |
58 | 58 | ||
59 | \item[Tag Cache: ]This option allows you to control whether the Tag Cache is stored | 59 | \item[Tag Cache:] |
60 | in RAM or on disk. See page \pageref{ref:tagcache} for more information about using | 60 | This option allows you to configure the Tag Cache. |
61 | See page \pageref{ref:tagcache} for more information about using | ||
61 | the Tag Cache. | 62 | the Tag Cache. |
62 | 63 | ||
63 | \item[Force Tag Cache Update: ]This option will update the Tag Cache in the background. | ||
64 | See page \pageref{ref:tagcache} for more information about using the Tag Cache. | ||
65 | \end{description} | 64 | \end{description} |
diff --git a/manual/rockbox_interface/tagcache.tex b/manual/rockbox_interface/tagcache.tex index 48f60c051f..5fbbeb9755 100644 --- a/manual/rockbox_interface/tagcache.tex +++ b/manual/rockbox_interface/tagcache.tex | |||
@@ -1,51 +1,95 @@ | |||
1 | % $Id$ % | 1 | % $Id$ % |
2 | \section{Tag Cache\label{ref:tagcache}} | 2 | \section{\label{ref:tagcache}Tag Cache} |
3 | 3 | ||
4 | \subsection{Introduction} | 4 | \subsection{Introduction} |
5 | Tag Cache is Rockbox's music database system. Using the information | 5 | Tag Cache is the Rockbox music database system. Using the information |
6 | contained in the tags (ID3v1, ID3v2, Vorbis Comments, Apev2, etc.) in your | 6 | contained in the tags (ID3v1, ID3v2, Vorbis Comments, Apev2, etc.) in your |
7 | audio files, Rockbox builds and maintains a database of the music files on | 7 | audio files, Rockbox builds and maintains a database of the music files on |
8 | your player and allows you to browse them by Artist, Album and Genre. | 8 | your player and allows you to browse them by Artist, Album and Genre. |
9 | 9 | ||
10 | \subsection{Using Tag Cache} | 10 | \subsection{Initializing the Tag Cache} |
11 | Before you use the Tag Cache for the first time, you need to tell Rockbox to | 11 | Before you use the Tag Cache for the first time, you must initialize it by using |
12 | create the database from your music files. This typically takes around | 12 | the \setting{Initialize Now} function in the \setting{Tag Cache Menu}, which is |
13 | 5 -- 10 minutes and you can continue listening to music normally whilst | 13 | described in the following section. |
14 | this is happenning. You can even shut down your player and resume the | 14 | |
15 | database building process next time you turn it on. | 15 | \subsection{\label{ref:tagcachemenu}The Tag Cache Menu} |
16 | To force the initial database to be built, go to the main menu, then | 16 | |
17 | \setting{General Settings $\rightarrow$ File View $\rightarrow$ Force tag cache update}. | 17 | \begin{description} |
18 | 18 | \opt{SWCODEC}{ | |
19 | \opt{SWCODEC}{ | 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). This configuration option can be | 21 | loaded into RAM (for fast browsing). Setting this to \setting{Yes} loads |
22 | found in \setting{General Settings $\rightarrow$ File View $\rightarrow$ Tag cache}. | 22 | the tagcache to RAM, allowing faster browsing and searching. Setting this |
23 | } | 23 | option to \setting{No} keeps the tagcache on the disk, meaning slower |
24 | Once the database has been built, you can browse your music using this | 24 | browsing but it does not use extra RAM and saves some battery on boot up. |
25 | database. To use the database change the show mode by changing the | 25 | |
26 | \setting{General Settings $\rightarrow$ File View $\rightarrow$ Show files} option to | 26 | \note{If you use TagCache frequently, you should load to RAM, as this |
27 | \setting{ID3 database}. This disables the File Browser and instead of the file | 27 | will reduce the overall battery consumption because the disk will not |
28 | browser you will now access the database. | 28 | need to spin on each search.} |
29 | % | 29 | } |
30 | \begin{description} | 30 | |
31 | \item[Keeping Tag Cache on disk.] This does not require extra RAM for the | 31 | \item[Auto Update: ] |
32 | Tag Cache and speeds up the boot process, but is slower when accessing. | 32 | If \setting{Auto update} is set to \setting{on}, each time the play |
33 | \item[Keeping Tag Cache on disk with Dircache enabled.] With Dircache | 33 | boots, Tag Cache will automatically do everything that the |
34 | enabled updating of the database is much faster. Also updates can be | 34 | \setting{Update now} setting does. Note that the \setting{Auto |
35 | committed in background immediately. | 35 | Update} will only check for deleted files if the Directory Cache |
36 | \item[Loading Tag Cache to RAM.] The fastest mode is when loading Tag Cache | 36 | (\setting{General Settings $\rightarrow$ System $\rightarrow$ |
37 | to RAM. New files are automatically detected and Tag Cache will get updated. | 37 | Disk $\rightarrow$ Directory Cache}) is enabled. |
38 | Use this for the fastest browsing and searching without any waiting. | 38 | "Update now" includes that check whether dircache has been enabled or not. |
39 | \note{To use the RAM mode, first you have to turn on | 39 | |
40 | Directory Cache in \setting{General Settings $\rightarrow$ System $\rightarrow$ | 40 | \item[Initialize Now: ] |
41 | Disk $\rightarrow$ Directory Cache}.} | 41 | Before you use the Tag Cache for the first time, you must initialize it by |
42 | \end{description} | 42 | using the \setting{Initialize Now} function in the \setting{Tag Cache |
43 | Menu}. \setting{Initialize Now} removes all database files (removing | ||
44 | runtimedb data also) and rebuilds the database from scratch. This takes | ||
45 | approximately 5 to 10 minutes, and may require a restart to allow the | ||
46 | files to be committed to the cache. | ||
47 | |||
48 | The Tag Cache initialization happens in the background, so you can continue | ||
49 | to listen to music while the Tag Cache is being initialized. If you shut | ||
50 | down your player during initialization, the database building process will | ||
51 | continue next time you turn it on. | ||
52 | |||
53 | \item[Update Now: ] | ||
54 | \setting{Update now} causes Tag Cache to detect new and deleted files | ||
55 | Note that unlike the \setting{Auto Update} function, \setting{Update Now} | ||
56 | will update the database regardless of whether the \setting{Directory Cache} | ||
57 | is enabled. Thus, an update using \setting{Update now} may take a long | ||
58 | time. Unlike \setting{Initialize Now}, the \setting{Update Now} function | ||
59 | does not remove runtime database information. | ||
60 | |||
61 | \item[Gather Runtime Data (Experimental): ] | ||
62 | When enabled, this option allows the most played, unplayed and most recently | ||
63 | played tracks to be logged and scored. | ||
64 | |||
65 | \item[Export modifications: ] | ||
66 | This allows for the runtime data to be exported into | ||
67 | \fname{/.rockbox/tagcache\_changelog.txt}, which backs up the runtime data in | ||
68 | ASCII format. This is needed when Tag Cache structures change, because new | ||
69 | code cannot read old Tag Cache database code. But, all modifications | ||
70 | exported to ASCII format should be readable by all Tag Cache versions. | ||
71 | |||
72 | \item[Import modifications: ] | ||
73 | Allows the \fname{/.rockbox/tagcache\_changelog.txt} backup to be | ||
74 | conveniently loaded into the Tag Cache. This is performed automatically when | ||
75 | the Tag Cache is initialized. | ||
76 | |||
77 | \end{description} | ||
78 | |||
79 | \subsection{Using the Tag Cache} | ||
80 | Once the Tag Cache has been initialized, you can browse your music by Artist, | ||
81 | Album, Genre and Song Name. To use the Tag Cache, change the | ||
82 | \setting{Show Files} show mode by changing the \setting{General Settings | ||
83 | $\rightarrow$ File View $\rightarrow$ Show files} option to | ||
84 | \setting{ID3 database}. This disables the \setting{File Browser} and instead | ||
85 | allows you to view files using the information in the Tag Cache database.\\ | ||
86 | |||
87 | \note{You may need to increase the value of the \setting{Max files in dir | ||
88 | browser} setting (\setting{General Settings $\rightarrow$ System $\rightarrow$ | ||
89 | Limits}) in order to view long lists of tracks in the ID3 database browser.\\ | ||
43 | 90 | ||
44 | \note{You may need to increase the value of the \setting{Max files in dir browser} | 91 | There is no option to turn off Tag Cache completely. If you do not want |
45 | setting (\setting{General Settings $\rightarrow$ System $\rightarrow$ Limits}) | 92 | to use it just don't do the initial build of the database and do not load it |
46 | in order to view long lists of tracks in the ID3 database browser.\\ | ||
47 | There is no option to turn off Tag Cache completely. If you don't want | ||
48 | to use it just don't do the initial build of the database and don't load it | ||
49 | to RAM.} | 93 | to RAM.} |
50 | % | 94 | % |
51 | \begin{table} | 95 | \begin{table} |