Add a note about Rockbox not running on Sansas v2 (FS#8477 by Marc Guay).
[Rockbox.git] / manual / configure_rockbox / bookmarking.tex
blob5103f28d675e1d434b9c81820bbf37f8fea29e85
1 % $Id$ %
2 \section{\label{ref:Bookmarkconfigactual}Bookmarking}
3 Bookmarks allow you to save your current position within a track so that
4 you can return to it at a later time. Bookmarks are saved on a per directory
5 basis, they are stored in the same directory as the files they reference.
6 You can store multiple bookmarks for the same track.
7 \begin{description}
8 \item [Bookmark on Stop. ]This option controls whether Rockbox writes a
9 bookmark to the disk when playback is stopped. Setting this to
10 \setting{No} turns automatic bookmarking completely off. In contrast
11 \setting{Yes} turns automatic bookmarking on while \setting{Ask}
12 asks on stopping the track if a bookmark should be created.
13 With the above options \setting{Yes} and \setting{Ask} if there is an existing
14 \fname{.bmark} file the current position information will be added to the
15 front of the existing list, up to the maximum number of allowed bookmarks
16 per file (currently 10). If no \fname{.bmark} file exists, one will be
17 created with the new bookmark information. Finally, if the
18 \setting{Maintain a list of Recently Used Bookmarks}
19 option is enabled, the bookmarking
20 information will be added to recent bookmarks list.
21 \begin{description}
22 \item[Yes -- Recent Only.]
23 Turns on automatic bookmarking -- One bookmark only
24 \item[Ask -- Recent Only.]
25 Asks if a bookmark should be created when stopping track --
26 One bookmark only
27 \end{description}
28 With the two \setting{Recent Only} options, nothing is written to the
29 \fname{.bmark} file. If the \setting{Maintain a list of Recently Used Bookmarks}
30 option is enabled, the bookmarking information will however be added to
31 recent bookmarks list.
32 \note{The \setting{Resume} function remembers your position in the most
33 recently accessed track regardless of how the \setting{Bookmark on Stop}
34 option is set.}
36 \item [Load Last Bookmark. ]
38 When the \setting{Load Last Bookmark} option is set to \setting{Yes}, Rockbox
39 automatically returns to the position of the last bookmark within a file
40 when that file is played.
42 When the \setting{Load Last Bookmark} option is set to \setting{Ask}, Rockbox will
43 give the user the option of starting from the beginning of the track
44 of or from the bookmark.
46 When the \setting{Load Last Bookmark} option is set to \setting{No}, playback always
47 starts from the beginning of the track, and the user must play the bookmark
48 or use the \setting{Load Bookmark} function in the Main Menu, while the file
49 is playing, to resume at the bookmarked location.
51 \item [Maintain a list of Recently Used Bookmarks. ]
53 This list of Most Recent Bookmarks (MRB's) may be accessed through the
54 \setting{Recent Bookmarks} option of the \setting{Bookmarks} sub menu of the
55 Main Menu. When set to \setting{Yes} each new bookmark will be added to the
56 MRB list. Setting this to \setting{No} disables the addition of bookmarks to
57 the MRB list. \setting{Unique Only} will remove an old bookmark for the current
58 track from the MRB list and replace it with the new one if a bookmark in the
59 MRB list already existed. Otherwise this will behave like the
60 \setting{Yes} setting.
61 \fixme{The above information was obtained by reading the source code, but my C is rather rusty...}
62 \end{description}