Minor doc update - config file locations
[geeqie.git] / doc / docbook / GuideReferenceConfig.xml
1 <?xml version="1.0" encoding="utf-8"?>\r
2 <section id="GuideReferenceConfig">\r
3   <title id="titleGuideReferenceConfig">Configuration Files and Locations</title>\r
4   <para>The following data lists the locations Geeqie uses for various actions. The uppercase symbols are environment variables. If they are not set on your system the fallback locations are listed in parentheses.</para>\r
5   <para>\r
6     Geqqie will first attempt to load a configuration file from:\r
7     <programlisting xml:space="preserve">/etc/geeqie/geeqierc.xml</programlisting>\r
8   </para>\r
9   <para>It will then continue with the following locations.</para>\r
10   <para>\r
11     Most of Geeqie's configuration files are contained in the folder, and sub-folders of:\r
12     <programlisting xml:space="preserve">$XDG_CONFIG_HOME/geeqie/</programlisting>\r
13     <programlisting xml:space="preserve">($~/.config/geeqie/)</programlisting>\r
14   </para>\r
15   <para>\r
16     Geeqie's standard configuration file is:\r
17     <programlisting xml:space="preserve">.../geeqierc.xml</programlisting>\r
18   </para>\r
19   <para>\r
20     An alternative configuration file may be used by executing:\r
21     <programlisting xml:space="preserve">geeqie -r --config-load:&lt;filename&gt;</programlisting>\r
22   </para>\r
23   <para>\r
24     Geeqie-created desktop files used by\r
25     <link linkend="GuideImageManagementExternalEditing">External Editors</link>\r
26     are in the folder:\r
27     <programlisting xml:space="preserve">.../applications</programlisting>\r
28   </para>\r
29   <para>\r
30     Lua script files for\r
31     <link linkend="GuideReferenceLua">Lua Extensions</link>\r
32     are in the folder:\r
33     <programlisting xml:space="preserve">.../lua</programlisting>\r
34   </para>\r
35   <para>\r
36     Historic data such as last several folders visited, bookmarks, and recently used collections, as well as default print settings are contained in this text file:\r
37     <programlisting xml:space="preserve">.../history</programlisting>\r
38   </para>\r
39   <para>\r
40     Keyboard shortcut maps are contained in this text file:\r
41     <programlisting xml:space="preserve">.../accels</programlisting>\r
42   </para>\r
43   <para>\r
44     The location for Collections is in the folder:\r
45     <programlisting xml:space="preserve">$XDG_DATA_HOME/geeqie/collections</programlisting>\r
46     <programlisting xml:space="preserve">($~/.local/share/geeqie/collections)</programlisting>\r
47   </para>\r
48   <para>\r
49     The lirc\r
50     <link linkend="GuideReferenceLIRC" endterm="titleGuideReferenceLIRC" />\r
51     configuration file must be located at:\r
52     <programlisting xml:space="preserve">$HOME/.lircrc</programlisting>\r
53   </para>\r
54   <para>\r
55     Thumbnails are stored in a location specified in\r
56     <link linkend="PreferencesThumbnails">Thumbnail Preferences</link>\r
57   </para>\r
58   <para>\r
59     Metadata is stored either in the image file or in the location specified in\r
60     <link linkend="Delete">Safe Delete</link>\r
61   </para>\r
62   <para>\r
63     The safe delete folder is specified in the\r
64     <link linkend="MetadataWritingProcess">Metadata</link>\r
65     tab of main Preferences\r
66   </para>\r
67 </section>\r