doc/docbook/GuideMainWindowMenus.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <section id="GuideMainWindowMenus">
   3     <title>
   4       Menus
   5     </title>
   6     <para>
   7       This section describes the functions of each item on the menu bar in the Geeqie main window.
   8     </para>
   9     <para/><section id="FileMenu"><title>
  10       File Menu
  11     </title>
  12     <variablelist><varlistentry><term>
  13         New window
  14       </term><listitem><para>
  15         Opens a new main window, with the initial path set to the current folder.
  16       </para></listitem></varlistentry><varlistentry><term>
  17         New collection
  18       </term><listitem><para>
  19         Opens a new collection window, the new collection will be empty.
  20       </para></listitem></varlistentry><varlistentry><term>
  21         Open collection
  22       </term><listitem><para>
  23         Displays a dialog to open a collection stored on disk, the selected collection will then appear in a new window.
  24       </para></listitem></varlistentry><varlistentry><term>
  25         Open recent
  26       </term><listitem><para>
  27         This menu item lists the recently active collections, selecting an item from the list will open that collection in a new window. The most recent item will appear at the top of the list. Maximum number of entries can be modified through <link linkend="GuideOptionsAdvanced">Open recent list maximum size?</link> option.
  28       </para></listitem></varlistentry><varlistentry><term>
  29         Search…
  30       </term><listitem><para>
  31         Opens a new Search window.
  32       </para></listitem></varlistentry><varlistentry><term>
  33         Find duplicates…
  34       </term><listitem><para>
  35         Opens a new Find Duplicates window.
  36       </para></listitem></varlistentry><varlistentry><term>
  37         Print..
  38       </term><listitem><para>
  39         Opens a print dialog.
  40       </para></listitem></varlistentry><varlistentry><term>
  41         New folder…
  42       </term><listitem><para>
  43         Creates a new folder in the current path.
  44       </para></listitem></varlistentry><varlistentry><term>
  45         Copy…
  46       </term><listitem><para>
  47         Opens a dialog to select a destination to copy the currently selected files.
  48       </para></listitem></varlistentry><varlistentry><term>
  49         Move…
  50       </term><listitem><para>
  51         Opens a dialog to select a destination to move currently selected files.
  52       </para></listitem></varlistentry><varlistentry><term>
  53         Rename…
  54       </term><listitem><para>
  55         Renames the current file selection.
  56       </para></listitem></varlistentry><varlistentry><term>
  57         Delete…
  58       </term><listitem><para>
  59         Deletes the current file selection.
  60       </para></listitem></varlistentry><varlistentry><term>
  61         Symlink
  62       </term><listitem><para>
  63         Creates a symbolic link. This is implemented via <link linkend="GuideEditors">external editor?</link>.
  64       </para></listitem></varlistentry><varlistentry><term>
  65         Close window
  66       </term><listitem><para>
  67         Closes the window containing the menu, if the window is the last main window Geeqie will quit.
  68       </para></listitem></varlistentry><varlistentry><term>
  69         Quit
  70       </term><listitem><para>
  71         Quits the Geeqie application, if collections or image metadata have been changed but not saved, the user will be prompted for confirmation.
  72       </para></listitem></varlistentry></variablelist>
  73     <para/></section><section id="Gomenu"><title>
  74       Go menu
  75     </title>
  76     <variablelist><varlistentry><term>
  77         First Image
  78       </term><listitem><para>
  79         Goes tothe first image.
  80       </para></listitem></varlistentry><varlistentry><term>
  81         Previous Image
  82       </term><listitem><para>
  83         Goes to the previous image.
  84       </para></listitem></varlistentry><varlistentry><term>
  85         Next Image
  86       </term><listitem><para>
  87         Goes to the next image.
  88       </para></listitem></varlistentry><varlistentry><term>
  89         Last Image
  90       </term><listitem><para>
  91         Goes to the last image. Back Goes to the previous folder. Home Goes to home folder.
  92       </para></listitem></varlistentry></variablelist>
  93     <para/></section><section id="Selectmenu"><title>
  94       Select menu
  95     </title>
  96     <variablelist><varlistentry><term>
  97         Select all
  98       </term><listitem><para>
  99         Selects all files in the current list
 100       </para></listitem></varlistentry><varlistentry><term>
 101         Select none
 102       </term><listitem><para>
 103         Deselects all files
 104       </para></listitem></varlistentry><varlistentry><term>
 105         Invert Selection
 106       </term><listitem><para>
 107         Inverts current selection
 108       </para></listitem></varlistentry><varlistentry><term>
 109         Copy path
 110       </term><listitem><para>
 111         Copy selected item path to clipboard.
 112       </para></listitem></varlistentry><varlistentry><term>
 113         Show marks
 114       </term><listitem><para>
 115         Displays marks in the file list
 116       </para></listitem></varlistentry><varlistentry><term>
 117         Mark n
 118       </term><listitem><para>
 119         Opens submenu for manipulating mark n
 120       </para></listitem></varlistentry><varlistentry><term>
 121         Mark n / Toggle mark n
 122       </term><listitem><para>
 123         Set or unset mark n on selected files
 124       </para></listitem></varlistentry><varlistentry><term>
 125         Mark n / Set mark n
 126       </term><listitem><para>
 127         Set mark n on selected files
 128       </para></listitem></varlistentry><varlistentry><term>
 129         Mark n / Reset mark n
 130       </term><listitem><para>
 131         Unset mark n on selected files
 132       </para></listitem></varlistentry><varlistentry><term>
 133         Mark n / Select mark n
 134       </term><listitem><para>
 135         Selects all files having mark n set
 136       </para></listitem></varlistentry><varlistentry><term>
 137         Mark n / Add mark n
 138       </term><listitem><para>
 139         Adds files having mark n set to selection
 140       </para></listitem></varlistentry><varlistentry><term>
 141         Mark n / Intersection with mark n
 142       </term><listitem><para>
 143         Intersects current selection and mark n
 144       </para></listitem></varlistentry><varlistentry><term>
 145         Mark n / Unselect mark n
 146       </term><listitem><para>
 147         Removes files having mark n set from current selection
 148       </para></listitem></varlistentry><varlistentry><term>
 149         Mark n / Filter mark n
 150       </term><listitem><para>
 151         Shows only the images that have mark n set.
 152       </para></listitem></varlistentry></variablelist>
 153     <para/></section><section id="Editmenu"><title>
 154       Edit menu
 155     </title>
 156     <variablelist><varlistentry><term>
 157         External Editors
 158       </term><listitem><para>
 159         This submenu contains external editors that were found on the system. See <link linkend="GuideEditors">Editors section?</link> for details.
 160       </para></listitem></varlistentry><varlistentry><term>
 161         Orientation
 162       </term><listitem><para>
 163         Adjust image orientation
 164       </para></listitem></varlistentry><varlistentry><term>
 165         Orientation / Rotate clockwise
 166       </term><listitem><para>
 167         Rotates the current image clockwise 90 degrees, does not modify the file on disk.
 168       </para></listitem></varlistentry><varlistentry><term>
 169         Orientation / Rotate counterclockwise
 170       </term><listitem><para>
 171         Rotates the current image counterclockwise 90 degrees, does not modify the file on disk.
 172       </para></listitem></varlistentry><varlistentry><term>
 173         Orientation / Rotate 180
 174       </term><listitem><para>
 175         Rotates the current image 180 degrees, does not modify the file on disk.
 176       </para></listitem></varlistentry><varlistentry><term>
 177         Orientation / Mirror
 178       </term><listitem><para>
 179         Swaps the left and right sides of the image so that the result is similar to that of looking at the image in a mirror, does not modify the file on disk.
 180       </para></listitem></varlistentry><varlistentry><term>
 181         Orientation / Flip
 182       </term><listitem><para>
 183         Swaps the top and bottom sides of the image, does not modify the file on disk.
 184       </para></listitem></varlistentry><varlistentry><term>
 185         Orientation / Original state
 186       </term><listitem><para>
 187         Removes all effects applied through the Adjust menu, reverting image to its original state. Orientation / Apply the orientation to image content The commands above modifies image metadata only. This commands actually transforms image pixels. See <link linkend="GuideEditors">Editors section?</link> for details.
 188       </para></listitem></varlistentry><varlistentry><term>
 189         Save metadata
 190       </term><listitem><para>
 191         Saves queued metadata changes. Autosave can be configured too.
 192       </para></listitem></varlistentry></variablelist>
 193     <variablelist><varlistentry><term>
 194         Preferences
 195       </term><listitem><para>
 196         This submenu contains configuration and maintenance commands
 197       </para></listitem></varlistentry><varlistentry><term>
 198         Preferences / Preferences…
 199       </term><listitem><para>
 200         Opens the <link linkend="GuideOptions">Preferences Dialog</link> for changing of global preferences.
 201       </para></listitem></varlistentry><varlistentry><term>
 202         Preferences / Configure Editors…
 203       </term><listitem><para>
 204         Opens the <link linkend="GuideEditors">Editors Dialog?</link> for changing of global preferences.
 205       </para></listitem></varlistentry><varlistentry><term>
 206         Preferences / Configure This window…
 207       </term><listitem><para>
 208         Opens the <link linkend="GuideWindowOptions">Window Preferences Dialog?</link> for changing of options that can differ for each window.
 209       </para></listitem></varlistentry><varlistentry><term>
 210         Preferences / Thumbnail maintenance
 211       </term><listitem><para>
 212         Opens a dialog with utilities to manage cached thumbnails and keywords data.
 213       </para></listitem></varlistentry><varlistentry><term>
 214         Set as wallpaper
 215       </term><listitem><para>
 216         Renders the current image to the root window (desktop). The resulting image will be tiled to fit the root window if zoom is not set to <emphasis role="i">fit to window</emphasis>; when zoom is set to <emphasis role="i">fit to window</emphasis>, the image will be scaled to fill the root window.
 217       </para></listitem></varlistentry></variablelist>
 218     <para/></section><section id="Viewmenu"><title>
 219       View menu
 220     </title>
 221     <variablelist><varlistentry><term>
 222         View in new window
 223       </term><listitem><para>
 224         Opens selected image in its own window
 225       </para></listitem></varlistentry><varlistentry><term>
 226         Pan view
 227       </term><listitem><para>
 228         Opens current folder in Pan view window
 229       </para></listitem></varlistentry><varlistentry><term>
 230         Files and Folders
 231       </term><listitem><para/></listitem></varlistentry></variablelist>
 232     <variablelist><varlistentry><term>
 233         Zoom
 234       </term><listitem><para/></listitem></varlistentry><varlistentry><term>
 235         Zoom in
 236       </term><listitem><para>
 237         Increases the zoom by one increment, resulting in a larger image.
 238       </para></listitem></varlistentry><varlistentry><term>
 239         Zoom out
 240       </term><listitem><para>
 241         Decreases the zoom by one increment, resulting in a smaller image.
 242       </para></listitem></varlistentry><varlistentry><term>
 243         Zoom to fit
 244       </term><listitem><para>
 245         Automatically adjusts the zoom so that the image will fit within the display pane. The effect on images with an original size smaller than the display pane can be changed with the Allow enlargement of image for zoom to fit option located on the <link linkend="GuideOptionsImage">Image tab</link> of the preferences dialog.
 246       </para></listitem></varlistentry><varlistentry><term>
 247         Fit Horizontally
 248       </term><listitem><para>
 249         Adjusts the zoom so image height fit within the display pane.
 250       </para></listitem></varlistentry><varlistentry><term>
 251         Fit Vertically
 252       </term><listitem><para>
 253         Adjusts the zoom so image width fit within the display pane.
 254       </para></listitem></varlistentry><varlistentry><term>
 255         Zoom n:m
 256       </term><listitem><para>
 257         Set zoom to the n:m value. 1:1 is the original size of the image. When n is greater than m, zoom in occurs else zoom out occurs.
 258       </para></listitem></varlistentry></variablelist>
 259     <variablelist><varlistentry><term>
 260         Connected zoom
 261       </term><listitem><para>
 262         Actions in this menu are identical to those in Zoom menu, but apply to all images displayed in splitted view.
 263       </para></listitem></varlistentry><varlistentry><term>
 264         Split
 265       </term><listitem><para/></listitem></varlistentry><varlistentry><term>
 266         Horizontal
 267       </term><listitem><para>
 268         Splits main image view in two horizontal panes.
 269       </para></listitem></varlistentry><varlistentry><term>
 270         Vertical
 271       </term><listitem><para>
 272         Splits main image view in two vertical panes.
 273       </para></listitem></varlistentry><varlistentry><term>
 274         Quad
 275       </term><listitem><para>
 276         Splits main image view in four panes.
 277       </para></listitem></varlistentry><varlistentry><term>
 278         Single
 279       </term><listitem><para>
 280         Reverts to normal view mode (one image).
 281       </para></listitem></varlistentry></variablelist>
 282     <variablelist><varlistentry><term>
 283         Thumbnails
 284       </term><listitem><para>
 285         Toggles the display of image thumbnails in the file list, this item is not available when the file list is in icon view mode. A check appears next to this item when thumbnails are enabled.
 286       </para></listitem></varlistentry><varlistentry><term>
 287         List
 288       </term><listitem><para>
 289         Changes the file list to display files in list format.
 290       </para></listitem></varlistentry><varlistentry><term>
 291         Icons
 292       </term><listitem><para>
 293         Changes the file list to display files as icons.
 294       </para></listitem></varlistentry><varlistentry><term>
 295         View Directory as
 296       </term><listitem><para/></listitem></varlistentry><varlistentry><term>
 297         List
 298       </term><listitem><para>
 299         Set the folder view mode to list.
 300       </para></listitem></varlistentry><varlistentry><term>
 301         Tree
 302       </term><listitem><para>
 303         Set the folder view mode to tree.
 304       </para></listitem></varlistentry></variablelist>
 305     <variablelist><varlistentry><term>
 306         Image Overlay
 307       </term><listitem><para>
 308         Displays Image Overlay information box (OSD), use twice to add histogram to it.
 309       </para></listitem></varlistentry><varlistentry><term>
 310         Histogram channels
 311       </term><listitem><para>
 312         Switches channels displayed in the histogram (red, green, blue, RGB, value, maximum value).
 313       </para></listitem></varlistentry><varlistentry><term>
 314         Histogram log mode
 315       </term><listitem><para>
 316         Toggles between linear and logarithmical histogram.
 317       </para></listitem></varlistentry><varlistentry><term>
 318         Full screen
 319       </term><listitem><para>
 320         Toggles the full screen window display.
 321       </para></listitem></varlistentry><varlistentry><term>
 322         Float file list
 323       </term><listitem><para>
 324         Toggles the location of the menu bar, tool bar, status bar, and file lists between the main window and a second window. A check appears next to this item when the location is the second window.
 325       </para></listitem></varlistentry><varlistentry><term>
 326         Hide file list
 327       </term><listitem><para>
 328         Toggles visibility of the menu bar, tool bar, status bar, and file lists.
 329       </para></listitem></varlistentry><varlistentry><term>
 330         Hide toolbar
 331       </term><listitem><para>
 332         Toggles visibility of the tool bar. A check appears next to this item when the tool bar is not visible.
 333       </para></listitem></varlistentry><varlistentry><term>
 334         Keywords
 335       </term><listitem><para>
 336         Toggles display of the Keywords sidebar.
 337       </para></listitem></varlistentry><varlistentry><term>
 338         Exif data
 339       </term><listitem><para>
 340         Toggles display of the EXIF sidebar.
 341       </para></listitem></varlistentry><varlistentry><term>
 342         Sort manager
 343       </term><listitem><para>
 344         Toggles display of the Sort Manager sidebar.
 345       </para></listitem></varlistentry><varlistentry><term>
 346         Toggle slideshow
 347       </term><listitem><para>
 348         Begins or ends a slide show, the slide show status is displayed in the status bar.
 349       </para></listitem></varlistentry><varlistentry><term>
 350         Pause slideshow
 351       </term><listitem><para>
 352         Pauses a slide show, the slide show status is displayed in the status bar.
 353       </para></listitem></varlistentry><varlistentry><term>
 354         Refresh
 355       </term><listitem><para>
 356         Updates the contents of the folder and file lists to match what is currently on disk, the current image will also be reread from disk.
 357       </para></listitem></varlistentry></variablelist>
 358     <para/></section><section id="Helpmenu"><title>
 359       Help menu
 360     </title>
 361     <variablelist><varlistentry><term>
 362         Contents
 363       </term><listitem><para>
 364         Opens the Geeqie user manual in a new browser window.
 365       </para></listitem></varlistentry><varlistentry><term>
 366         Keyboard shortcuts
 367       </term><listitem><para>
 368         Displays a window listing the default keyboard shortcuts.
 369       </para></listitem></varlistentry><varlistentry><term>
 370         Release notes
 371       </term><listitem><para>
 372         Displays a window containing the release notes for the version of Geeqie in use.
 373       </para></listitem></varlistentry><varlistentry><term>
 374         About
 375       </term><listitem><para>
 376         Opens a window containing the Geeqie version, credits, website, and email contact information.
 377       </para></listitem></varlistentry><varlistentry><term>
 378         Log window
 379       </term><listitem><para>
 380         Opens the log window, mostly used for debugging purposes.
 381       </para></listitem></varlistentry></variablelist>
 382     <para/></section><section id="Tearoffmenus"><title>
 383       Tear off menus
 384     </title>
 385     <para>
 386       Menus can be permanently displayed by selecting the dotted line item at the top of each menu category. A tear off menu will behave the same as an ordinary window. To close a tear off menu, select the dotted line item at the top of the menu.
 387     </para>
 388     <para/></section><section id="Keyboardshortcuts"><title>
 389       Keyboard shortcuts
 390     </title>
 391     <para>
 392       The keyboard sequence associated to each menu entry is listed within the main window menu bar. For reference, the complete list of default keyboard shortcuts can be found in section <link linkend="GuideReferenceKeyboardShortcuts">Keyboard Shortcuts</link>.
 393     </para>
 394     <para/></section><section id="Changingthemainwindowmenubarkeyboardshortcuts"><title>
 395       Changing the main window menu bar keyboard shortcuts
 396     </title>
 397     <para>
 398       The keyboard shortcuts associated with the menu bar items can be changed by editing the accels file located in the Geeqie configuration folder <emphasis role="strong">while the Geeqie application is not running</emphasis>:
 399     </para>
 400     <para>
 401       <literal>($HOME)/.geeqie/accels</literal>
 402     </para>
 403     <para>
 404       To change a menu item, first find the line corresponding to the menu item to change. For example the File menu Quit line originally looks like this:
 405     </para>
 406     <para>
 407       <literal>; (gtk_accel_path "&amp;lt;main&amp;gt;/File/Quit" "&amp;lt;Control&amp;gt;q")</literal>
 408     </para>
 409     <para>
 410       To change this menu's keyboard shortcut, first remove the leading semicolon (;), removing the semicolon will tell Geeqie that this menu item has been customized. Then change the keyboard shortcut defined by the text in quotes at the end of the line, be sure to only change the text within the quotes; in this case the text “&amp;lt;control&amp;gt;q”. For example changing the shortcut associated with Quit to the Q key will result in this line:
 411     </para>
 412     <para>
 413       <literal>(gtk_accel_path "&amp;lt;main&amp;gt;/File/Quit" "q")</literal>
 414     </para>
 415     <para>
 416       Please note the removed semicolon and the change of “&amp;lt;control&amp;gt;q” to “q”, be careful not to change any of the other text on the line or Geeqie may ignore the customization. The keyboard modifiers and their respective text are listed below:
 417     </para>
 418     <informaltable><tgroup cols="2"><tbody><row><entry>
 419           &lt;tablestyle="width:60%"&gt; Key
 420         </entry><entry>
 421           Text to use in accels file
 422         </entry></row>
 423 <row><entry>
 424           &lt;tablestyle="width:60%"&gt; Shift
 425         </entry><entry>
 426           &amp;lt;shift&amp;gt;
 427         </entry></row>
 428 <row><entry>
 429           Ctrl
 430         </entry><entry>
 431           &amp;lt;control&amp;gt;
 432         </entry></row>
 433 <row><entry>
 434           Alt
 435         </entry><entry>
 436           &amp;lt;alt&amp;gt;
 437         </entry></row>
 438 </tbody></tgroup></informaltable>
 439     <para>
 440       Modifiers can be combined, for example in the exit line above, the text would be “&amp;lt;control&amp;gt;&amp;lt;shift&amp;gt;q” to set the exit shortcut to Ctrl + Shift + Q.
 441     </para>
 442   <para/></section></section>