]> Shamusworld >> Repos - ardour-manual/blob - include/snapshots.html
Update Luadoc for upcoming Ardour 7
[ardour-manual] / include / snapshots.html
1
2 <p>
3   A <dfn>snapshot</dfn> is a backup of the current state of a session. It differs
4   from a simple save by allowing branching. It is a "frozen" version of the session
5   at a certain point in time.
6 </p>
7 <p>
8   For example, creating a snapshot before changing the entire arrangement of a
9   piece, or drastically altering the signal processing provides  a reference to
10   come back to, should that not work out.
11 </p>
12 <p>
13   This is accomplished by using either of the <kbd class="menu">Session &gt;
14   Snapshot</kbd> menus. A small dialog will appear, allowing to enter a name for
15   the snapshot. The default name is based on the current date and time.
16 </p>
17
18 <p>
19   The difference between the two snapshot menus is:
20 </p>
21 <table>
22   <tr>
23     <td><kbd class="menu">Snapshot (& keep working on current version)...</kbd></td>
24     <td>Saves a snapshot of the session, but keeps the current session active, i.e. any
25       subsequent <kbd class="menu">Session &gt; Save</kbd> will overwrite the original
26       session, and the snapshot will remain unchanged.</td>
27   </tr>
28   <tr>
29     <td><kbd class="menu">Snapshot (& switch to new version)...</kbd></td>
30     <td>Saves a snapshot of the session, and uses this snapshot as the current
31       active session, i.e. any subsequent <kbd class="menu">Session &gt; Save</kbd>
32       will overwrite the snapshot, and the original session will remain unchanged.</td>
33   </tr>
34 </table>
35
36 <p>
37   Any number of snapshots can be created.
38 </p>
39 <p class="warning">
40   Creating a snapshot does <strong>not</strong> modify the session,
41   nor does it save the session. Instead, it saves an alternate version
42   of the session, within the session folder. The snapshot shares all data
43   present in the session.
44 </p>
45
46 <h2>Switching to a Snapshot</h2>
47 <p>
48   Switching to an existing snapshot is done by navigating the
49   <a href="@@the-snapshot-list">Snapshot List</a> and clicking the the name of
50   the desired snapshot. Ardour will switch to the snapshot, and, if there are
51   unsaved changes in the current session, offer to save them.
52 </p>
53
54 <h2>Starting Ardour With a Snapshot</h2>
55 <p>
56   Since a snapshot is just another session file stored within the session
57   folder, that "version" can be chosen when loading an existing session.
58   The browser in the "Open Session" dialog will show an expander arrow for
59   sessions that have more than one session file (i.e. snapshots)
60   present. Clicking on it shows the list, and then clicking on the name of the
61   snapshot loads it.
62 </p>
63