Fix #934: Request to add image bookmarking/tagging within a folder
[geeqie.git] / doc / docbook / GuideOptionsBehavior.xml
index 3e107ec..9fb2a7b 100644 (file)
 <?xml version="1.0" encoding="utf-8"?>
 <section id="GuideOptionsBehavior">
-    <title>
-      Advanced Behavior Options
-    </title>
-    <para>
-      This section describes the options presented under the Behavior Tab of the preferences dialog.
-    </para>
-    <para/><section id="Delete"><title>
-      Delete
-    </title>
-    <variablelist><varlistentry><term>
-        Confirm file delete
-      </term><listitem><para/></listitem></varlistentry></variablelist>
-    <para>
-      Prompts for confirmation before deleting files.
-    </para>
-    <variablelist><varlistentry><term>
-        Enable Delete key
-      </term><listitem><para/></listitem></varlistentry></variablelist>
-    <para>
-      Disable this to disassociate the delete file function from the Delete key. This option does not effect the Ctrl + D key sequence. May be useful in combination with “confirm file delete”, above, disabled so that accidentally hitting a single key will not result in deleted files.
-    </para>
-    <variablelist><varlistentry><term>
-        Safe Delete
-      </term><listitem><para/></listitem></varlistentry></variablelist>
-    <para>
-      Moves deleted files to a temporary folder, for easy retrieval of deleted files. Files in the temporary folder are retained until the maximum size is reached, at which point deleting additional files will result in the removal of the oldest files to reclaim the space needed for the new files.
-    </para>
-    <para>
-      Note: Files moved to the Safe Delete folder are prefixed with a six digit number in the format: <literal>nnnnnn_FILENAME</literal><?db2html element="br"?>
-      This is used by the delete feature to distinguish which files to remove first when clearing space for new files.<?db2html element="br"?>
-      The digit counter increments with each deleted file.
-    </para>
-    <variablelist><varlistentry><term>
-        Folder
-      </term><listitem><para/></listitem></varlistentry></variablelist>
-    <para>
-      The location of the folder used by the Safe Delete feature.
-    </para>
-    <variablelist><varlistentry><term>
-        Maximum size
-      </term><listitem><para/></listitem></varlistentry></variablelist>
-    <para>
-      The size to use for the Safe Delete folder, in megabytes. Note that setting this value to 0 (zero) will disable any limit.
-    </para>
-    <variablelist><varlistentry><term>
-        Clear button
-      </term><listitem><para/></listitem></varlistentry></variablelist>
-    <para>
-      Removes all files contained in the Safe Delete folder.
-    </para>
-    <variablelist><varlistentry><term>
-        View button
-      </term><listitem><para/></listitem></varlistentry></variablelist>
-    <para>
-      Changes the Geeqie main window to display the contents of the Safe Delete folder.
-    </para>
-    <para/></section><section id="Behavior"><title>
-      Behavior
-    </title>
-    <variablelist><varlistentry><term>
-        Rectangular selection in icon view
-      </term><listitem><para/></listitem></varlistentry></variablelist>
-    <para>
-      Enable this to change the selection method used when selecting multiple items in an icon view.
-    </para>
-    <variablelist><varlistentry><term>
-        Descend folders in tree view
-      </term><listitem><para/></listitem></varlistentry></variablelist>
-    <para>
-      This will allow Geeqie to read sub folder content to determine if it should display expander indicators in the folder tree view.
-    </para>
-    <para>
-      Note: Disable this if Geeqie wakes up auto mounted network shares, or takes too long to initially display the folder view.
-    </para>
-    <variablelist><varlistentry><term>
-        Show date in directories list view
-      </term><listitem><para/></listitem></varlistentry></variablelist>
-    <para>
-      Enable this to display directory modification date along its name in the list view
-    </para>
-    <variablelist><varlistentry><term>
-        In place renaming
-      </term><listitem><para/></listitem></varlistentry></variablelist>
-    <para>
-      When renaming a single file, this will allow the rename entry to appear directly over the original filename.
-    </para>
-    <variablelist><varlistentry><term>
-        Show "Copy path" menu item
-      </term><listitem><para/></listitem></varlistentry></variablelist>
-    <para>
-      Enable this option to show a "Copy path" menu item in applicable menus.
-    </para>
-    <para>
-      This allows to copy path to files or directories to the clipboard, names are enclosed with double quotes and separated by space.
-    </para>
-    <variablelist><varlistentry><term>
-        Open recent list maximum size
-      </term><listitem><para/></listitem></varlistentry></variablelist>
-    <para>
-      This is the number of entries saved in the recent open file list.
-    </para>
-    <variablelist><varlistentry><term>
-        Drag'n drop icon size
-      </term><listitem><para/></listitem></varlistentry></variablelist>
-    <para>
-      This is the width and height of the icon generated from image and displayed when doing drap'n drop actions. High resolution screens may require to increase this number.
-    </para>
-    <para/></section><section id="Navigation"><title>
-      Navigation
-    </title>
-    <variablelist><varlistentry><term>
-        Progressive keyboard scrolling
-      </term><listitem><para/></listitem></varlistentry></variablelist>
-    <para>
-      This will cause image panning speed to gradually accelerate when holding down the keyboard arrows.
-    </para>
-    <variablelist><varlistentry><term>
-        Mouse wheel scrolls image
-      </term><listitem><para/></listitem></varlistentry></variablelist>
-    <para>
-      The default is for the mouse wheel to change the image, and to scroll the image when Shift is used in combination with the wheel. Enabling this swaps the behavior so that operating the wheel will scroll the image, and holding down Shift will change the image.
-    </para>
-    <variablelist><varlistentry><term>
-        Home button path
-      </term><listitem><para/></listitem></varlistentry></variablelist>
-    <para>
-      This defines the path to use for the "Home" button in the main window. By default or when this field is empty, this is the user's directory.
-    </para>
-    <variablelist><varlistentry><term>
-        Use current
-      </term><listitem><para/></listitem></varlistentry></variablelist>
-    <para>
-      Pressing this button will set the Home button path to the current open directory.
-    </para>
-    <para/></section><section id="Miscellaneous"><title>
-      Miscellaneous
-    </title>
-    <variablelist><varlistentry><term>
-        Custom similarity threshold
-      </term><listitem><para/></listitem></varlistentry></variablelist>
-    <para>
-      This setting is used by the compare method “similarity (custom)”, located in the Find Duplicates window.
-    </para>
-    <para/></section><section id="Debugging"><title>
-      Debugging
-    </title>
-    <variablelist><varlistentry><term>
-        Debug level
-      </term><listitem><para/></listitem></varlistentry></variablelist>
-    <para>
-      This defines the verbosity of debug info sent to console and log window (0 disables the debug output).
-    </para>
-  <para/></section></section>
+  <title>Behavior Options</title>
+  <para>This section describes the options presented under the Behavior Tab of the preferences dialog.</para>
+  <section id="Delete">
+    <title>Delete</title>
+    <variablelist>
+      <varlistentry>
+        <term>
+          <guilabel>Confirm permanent file delete</guilabel>
+        </term>
+        <listitem>
+          <para>Prompts for confirmation before deleting files.</para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>
+          <guilabel>Confirm move file to Trash</guilabel>
+        </term>
+        <listitem>
+          <para>Prompts for confirmation before moving files to the trash bin.</para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>
+          <guilabel>
+            Enable
+            <keycap>Delete key</keycap>
+          </guilabel>
+        </term>
+        <listitem>
+          <para>
+            Disable this to disassociate the delete file function from the
+            <keycap>Delete</keycap>
+            key.
+          </para>
+          <para>
+            If
+            <emphasis>Confirm file delete</emphasis>
+            , above, is disabled, accidentally hitting the
+            <keycap>Delete</keycap>
+            can result in files being erroneously deleted without warning. Disabling the
+            <keycap>Delete</keycap>
+            key will prevent this. The
+            <code>
+              Ctrl +
+              <keycap>D</keycap>
+            </code>
+            key sequence is not affected.
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>
+          <guilabel>Use Geeqie trash location</guilabel>
+        </term>
+        <listitem>
+          <para>Moves deleted files to a temporary folder, for easy retrieval of deleted files. Files in the temporary folder are retained until the maximum size is reached, at which point deleting additional files will result in the removal of the oldest files to reclaim the space needed for the new files.</para>
+          <note>
+            <para>
+              Files moved to the Safe Delete folder are prefixed with a six digit number in the format:
+              <literal>nnnnnn_FILENAME</literal>
+              <para />
+              This is used by the delete feature to distinguish which files to remove first when clearing space for new files.
+              <para />
+              The digit counter increments with each deleted file.
+            </para>
+          </note>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>
+          <guilabel>Use system Trash bin</guilabel>
+        </term>
+        <listitem>
+          <para>Moves deleted files to the system-defined trash bin.</para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>
+          <guilabel>Folder</guilabel>
+        </term>
+        <listitem>
+          <para>The location of the folder used by the Safe Delete feature.</para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>
+          <guilabel>Maximum size</guilabel>
+        </term>
+        <listitem>
+          <para>The size to use for the Safe Delete folder, in megabytes. Note that setting this value to 0 (zero) will disable any limit.</para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>
+          <guilabel>Clear button</guilabel>
+        </term>
+        <listitem>
+          <para>Removes all files contained in the Safe Delete folder.</para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>
+          <guilabel>View button</guilabel>
+        </term>
+        <listitem>
+          <para>Changes the Geeqie main window to display the contents of the Safe Delete folder.</para>
+        </listitem>
+      </varlistentry>
+    </variablelist>
+  </section>
+  <section id="Behaviour">
+    <title>Behavior</title>
+    <variablelist>
+      <varlistentry>
+        <term>
+          <guilabel>Descend folders in tree view</guilabel>
+        </term>
+        <listitem>
+          <para>This will allow Geeqie to read sub folder content to determine if it should display expander indicators in the folder tree view.</para>
+          <note>
+            <para>Disable this if Geeqie wakes up auto mounted network shares, or takes too long to initially display the folder view.</para>
+          </note>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>
+          <guilabel>In place renaming</guilabel>
+        </term>
+        <listitem>
+          <para>When renaming a single file, this will allow the rename entry to appear directly over the original filename.</para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>
+          <guilabel>List directory view uses single click to enter</guilabel>
+        </term>
+        <listitem>
+          <para>If selected, a single click will enter a directory, rather than the GTK+ default of a double click.</para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>
+          <guilabel>Circular selection lists</guilabel>
+        </term>
+        <listitem>
+          <para>If selected, when traversing a list of selected images using Next or Previous Image, when the last or first image is encountered the focus moves to the beginning or end of the list. When deselected, focus will go no further than the start or end of the list.</para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>
+          <guilabel>Save marks on exit</guilabel>
+        </term>
+        <listitem>
+          <para>Save all marks that have been set. Note that marks that are linked to a keyword will always be saved irrespective of this setting.</para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>
+          <guilabel>Use "With Rename" as default for Copy/Move dialogs</guilabel>
+        </term>
+        <listitem>
+          <para>Move the "With Rename" button to the default position.</para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>
+          <guilabel>Open Collections on top</guilabel>
+        </term>
+        <listitem>
+          <para>Open collection windows with "Always on Top" set.</para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>
+          <guilabel>Recent folder list maximum size</guilabel>
+        </term>
+        <listitem>
+          <para>This is the maximum number of entries to be displayed in the recent open folder list drop-down box.</para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>
+          <guilabel>Recent folder-image list maximum size</guilabel>
+        </term>
+        <listitem>
+          <para>The last image viewed in a folder is stored in a list. This value is the maximum number of entries in the list. When a folder is subsequently re-opened, focus moves to the last image viewed in that folder.</para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>
+          <guilabel>Drag'n drop icon size</guilabel>
+        </term>
+        <listitem>
+          <para>This is the width and height of the icon generated from image and displayed when doing drag and drop actions. High resolution screens may require to increase this number.</para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>
+          <guilabel>Drag'n drop default action</guilabel>
+        </term>
+        <listitem>
+          <para>When using drag and drop to copy or move files, the default action is to use a pop-up menu to permit you to select which action is to be taken. This option allows you to set the default action to either Copy or Move.
+          </para>
+          <note>
+            <para>When using the pop-up menu, the menu will also include an option for a symbolic link and any other plugins that are defined as being a <link linkend="Geeqieextensions">filter</link>. If you set the default action to Copy or Move these additional options will not be available to you.</para>
+          </note>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>
+          <guilabel>Copy path clipboard selection</guilabel>
+        </term>
+        <listitem>
+          <para>
+            This option determines which clipboard selection is used for the "Copy path" menu item. The exact method of the paste operation will depend on the operating system, but in general will be:
+            <variablelist>
+              <varlistentry>
+                <term>
+                  <guilabel>Primary</guilabel>
+                </term>
+                <listitem>
+                  <para>Paste using mouse middle-click, or shift-insert.</para>
+                </listitem>
+              </varlistentry>
+              <varlistentry>
+                <term>
+                  <guilabel>Clipboard</guilabel>
+                </term>
+                <listitem>
+                  <para>Paste using mouse right-click and select paste, or control-v.</para>
+                </listitem>
+              </varlistentry>
+              <varlistentry>
+                <term>
+                  <guilabel>Both</guilabel>
+                </term>
+                <listitem>
+                  <para>Paste using either method.</para>
+                </listitem>
+              </varlistentry>
+            </variablelist>
+          </para>
+        </listitem>
+      </varlistentry>
+    </variablelist>
+  </section>
+  <section id="Navigation">
+    <title>Navigation</title>
+    <variablelist>
+      <varlistentry>
+        <term>
+          <guilabel>Progressive keyboard scrolling</guilabel>
+        </term>
+        <listitem>
+          <para>This will cause image panning speed to gradually accelerate when holding down the keyboard arrows.</para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>
+          <guilabel>Keyboard scrolling step multiplier:</guilabel>
+        </term>
+        <listitem>
+          <para>Defines the amount to pan an image when using the keyboard arrows.</para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>
+          <guilabel>Mouse wheel scrolls image</guilabel>
+        </term>
+        <listitem>
+          <para>
+            The default is for the mouse wheel to change the image, and to scroll the image when
+            <keycap>Shift</keycap>
+            is used in combination with the wheel. Enabling this swaps the behavior so that operating the wheel will scroll the image, and holding down
+            <keycap>Shift</keycap>
+            will change the image.
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>
+          <guilabel>Navigation by left or middle click on image</guilabel>
+        </term>
+        <listitem>
+          <para>If selected, mouse left-click will select the next image; mouse middle-click will select the previous image.</para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>
+          <guilabel>Open archive by left click on image</guilabel>
+        </term>
+        <listitem>
+          <para>If selected, mouse left-click on an image belonging to the archive class will decompress the file contents and display them in a new Geeqie window.</para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>
+          <guilabel>Play video by left click on image</guilabel>
+        </term>
+        <listitem>
+          <para>If selected, mouse left-click on an image belonging to the video class will start a program chosen in a box below.</para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>
+          <guilabel>Mouse button Back/Forward</guilabel>
+        </term>
+        <listitem>
+          <para>Some mice have additional buttons designated Back/Forward (mouse buttons 8 and 9). You may allocate any menu item to either of these buttons.</para>
+        </listitem>
+      </varlistentry>
+    </variablelist>
+  </section>
+  <section id="Debugging">
+    <title>Debugging</title>
+    <variablelist>
+      <varlistentry>
+        <term>
+          <guilabel>Debug level</guilabel>
+        </term>
+        <listitem>
+          <para>Displayed when compiled with the option --enable-debug-log. This defines the verbosity of debug info sent to console and log window (0 disables the debug output).</para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>
+          <guilabel>Log Window max. lines</guilabel>
+        </term>
+        <listitem>
+          <para>The maximum number of data lines to be displayed. The window will show the most recent data.</para>
+        </listitem>
+      </varlistentry>
+    </variablelist>
+  </section>
+</section>