Differential D20784 Diff 56896 user_manual/autosave.rst

Changeset View

Standalone View

user_manual/autosave.rst

This file was added.

1		.. meta::
2		:description:
3		How AutoSave and Backup Files Work in Krita
4
5		.. metadata-placeholder
6
7		:authors: - Boudewijn Rempt
8		:license: GNU free documentation license 1.3 or later.
9
10		.. index:: ! Saving, Autosave, Backup
11		.. _autosave:
12
13		=================================
14		Saving, AutoSave and Backup Files
15		=================================
16
17		Krita does its best to keep your work safe. But if you want to make sure that you won't lose work, you will need to understand how Saving, AutoSave and Backup Files work in Krita.
18
19		Saving
20		------
21
22		Krita does not store your images somewhere without your intervention. You need to save your work, or it will be lost, irretrievably. Krita can save your images in many formats. You should always save your work in Krita's native format, ``.kra``
23		because that supports all Krita's features.
24
25		Additionally, you can export your work to other formats, for compatibility with other applications or publication on the Web or on paper. Krita will warn which aspects of your work are going to be lost when you save to another format than ``.kra`` and offers to make a ``.kra`` file for you as well.
26
	woltheravUnsubmitted Not Done shouldn't these be backticks? woltherav: shouldn't these be backticks?
27		If you save your work, Krita will ask you where it should save on your computer. By default, this is the Pictures folder in your User folder: this is true for all operating systems.
28
29		If you use "Save As" your image will be saved under a new name. The original file under its own name are not deleted. From now on, your file will be saved under the new name.
30
31		If you use "Export" using a new filename, a new file will be created with a new name. The file you have open will keep the new name, and the next time you save it, it will be saved under the old name.
32
	kamathraghavendraUnsubmitted Not Done This should be :ref:`Saving for the Web <saving_for_the_web>` kamathraghavendra: This should be :ref:`Saving for the Web <saving_for_the_web>`
33		You can Save, Save As and Export to any file format.
34
35
36		See also
37
38
	tymondUnsubmitted Done I think it would be useful to have it clearly said here that if Krita closes normally, all unsaved work is lost and autosave files are deleted. Details are below in those two sections, but I feel like it still would be beneficial if repeated. tymond: I think it would be useful to have it clearly said here that if Krita closes normally, all…
	woltheravUnsubmitted Not Done Krita autosaves every woltherav: Krita autosaves //every//
39		:ref:Saving for the Web <saving_for_the_web>
40
41
42		AutoSave
43		--------
44
45		AutoSave is what happens when you've worked for a bit and not saved your work yourself: Krita will save your work for you. Autosave files are by default visible in your file manager. You can configure Krita 4.2 and up to create autosave files that are visible in your file manager. By default, Krita autosaves every fifteen minutes; you can configure that in the File tab of the General Settings page of the Configure Krita dialog, which is in the Settings menu (Linux, Windows) or in the Application menu (macOS).
46
47		If you close Krita without saving, your unsaved work is lost and cannot be retrieved. Closing Krita normally also means that autosave files are removed.
48
49		.. image:: /images/en/file_config_page.png
50
51		There are two possibilities:
52
53		- You hadn't saved your work at all
54		- You had saved your work already
55
56		AutoSave for Unsaved Files
57		~~~~~~~~~~~~~~~~~~~~~~~~~~~
58
59		If you had not yet saved your work, Krita will create an unnamed AutoSave file.
60
61		If you're using Linux or macOS, the AutoSave file will be a hidden file in your home directory. If you're using Windows, the AutoSave file will be a file in your user's ``%TEMP%`` folder. In Krita 4.2 and up, you can configure Krita to make the AutoSave files visible by default.
62
63		A hidden autosave file will be named like ``.krita-12549-document_1-autosave.kra``
64
65		If Krita crashes before you had saved your file, then the next time you start Krita, you will see the file in a dialog that shows up as soon as Krita starts. You can select to restore the files, or to delete them.
66
67		.. image:: /images/en/autosave_unnamed_restore.png
68
69		If Krita crashed, and you're on Windows and your ``%TEMP%`` folder gets cleared, you will have lost your work. Windows does not clear the ``%TEMP%`` folder by default, but you can enable this feature in Settings. Applications like Disk Cleanup or cCleaner will also clear the ``%TEMP%`` folder. Again, if Krita crashes, and you haven't saved your work, and you have something enabled that clear your ``%TEMP%`` folder, you will have lost your work.
70
71		If Krita doesn't crash, and you close Krita without saving your work, Krita will remove the AutoSave file: you work will be gone and cannot be retrieved.
	woltheravUnsubmitted Not Done refer back to the two cases here, most people will have forgotten what cases you were talking about at this point. woltherav: refer back to the two cases here, most people will have forgotten what cases you were talking…
72
73		If you save your work and continue, or close Krita and do save your work, the AutoSave file will be removed.
74
75		AutoSave for Saved Files
76		~~~~~~~~~~~~~~~~~~~~~~~~
77
78		If you had already saved your work, Krita will create a named AutoSave file.
79
80		A hidden named autosave file will look like ``.myimage.kra-autosave.kra``.
81
82		By default, named AutoSave files are hiden. Named AutoSave files are placed in the same folder as the file you were working on.
	tymondUnsubmitted Done If you use "Save As" option, autosave files from previous "name" are not deleted. It is very visible when using Incremental Version feature which essentially do the same. (At least that was how it worked last time I checked). tymond: If you use "Save As" option, autosave files from previous "name" are not deleted. It is very…
83
84		If you start Krita again after it crashed and try to open your original file, Krita will ask you whether to open the AutoSave file instead:
85
86		.. image:: /images/en/autosave_named_restore.png
87
	tymondUnsubmitted Not Done Maybe add differences between Save, Save As and Export in "Saving" category above? You wrote about exporting to other formats, but in Krita you can both Save and Export in the same set of formats. tymond: Maybe add differences between Save, Save As and Export in "Saving" category above? You wrote…
88		If you choose "no", the AutoSave file will be removed. The work done since the last time you saved your file yourself is lost and cannot be retrieved.
89
90		If you choose "yes", the AutoSave file will be opened, then removed. The file you have open will have the name of your original file. The file will be set to Modified, so the next time you try to close Krita, Krita will ask you whether you want to save the file. If you choose No, your work is irretrievably gone. It cannot be restored.
91
92		If you use "Save As" your image will be saved under a new name. The original file under its own name and its AutoSave file are not deleted. From now on, your file will be saved under the new name; if you save again, an AutoSave file will be created using the new filename.
93
94		If you use "Export" using a new filename, a new file will be created with a new name. The file you have open will keep the new name, and the next time you save it, the AutoSave file will be created from the last file saved with the current name, that is, not the name you choose for "Export".
95
	woltheravUnsubmitted Not Done 'has been opened' woltherav: 'has been opened'
96
97		Backup Files
	woltheravUnsubmitted Not Done 'save the file' woltherav: 'save the file'
98		------------
99
100		There are three kinds of Backup files
101
102		- Ordinary Backup files that are created when you save a file that has been opened from disk
103		- Incremental Backup files that are copies of the file as it is on disk to a numbered backup, and while your file is saved under the current name
104		- Incremental Version files that are saves of the file you are working on with a new number, leaving alone the existing files on disk.
105
106
	woltheravUnsubmitted Not Done duplicate? woltherav: duplicate?
107		Ordinary Backup Files
108		~~~~~~~~~~~~~~~~~~~~~
109
110		If you have opened a file, made changes, then save it, or save a new file after the first time you've saved it, Krita will save a backup of your file.
111
112		You can disable this mechanism in the File tab of the General Settings page of the Configure Krita dialog, which is in the Settings menu (Linux, Windows) or in the Application menu (macOS). By default, Backup files are enabled.
113
114		.. image:: /images/en/file_config_page.png
115
116		By default, a Backup file will be in the same folder as your original file. You can also choose to save Backup files in the User folder or the ``%TEMP%`` folder; this is not as safe because if you edit two files with the same name in two different folders, their backups will overwrite each other.
117
118		By default, a Backup file will have ``~`` as suffix, to distinguish it from an ordinary file. If you are using Windows, you will have to enable "show file extensions" in Windows Explorer to see the extension.
119
120		.. image:: /images/en/file_and_backup_file.png
121
122		If you want to open the Backup file, you will have to rename it in your file manager. Make sure the extension ends with ``.kra``.
123
124		Every time you save your file, the last version without a ``~`` suffix will be copied to the version with the ``~`` suffix. The contents of the original file will be gone: it will not be possible to restore that version.
125
126		Incremental Backup Files
127		~~~~~~~~~~~~~~~~~~~~~~~~
128
129		Incremental Backup files are similar to ordinary Backup files: the last saved state is copied to another file just before saving. However, instead of overwriting the Backup file, the Backup files are numbered:
130
131		.. image:: /images/en/save_incremental_backup.png
132
133		Use this when you want to keep various known good states of your image throughout your painting process. This takes more disk space, of course.
134
135		Do not be confused: Krita does not save the current state of your work to the latest Incremental file, but copies the last saved file to the Backup file and then saves your image under the original filename.
136
137		Incremental Version Files
138		~~~~~~~~~~~~~~~~~~~~~~~~~
139
140		Incremental Version works a bit like Incremental Backup, but it leaves the original files alone. Instead it will save a new file with a file number:
141
142		.. image:: /images/en/save_incremental_version.png