doc/docbook/CommandLineOptions.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
   3                    "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
   4 <!-- lifted from man+troff by doclifter -->
   5 <refentry id='geeqie1'>
   6 <!-- DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.3. -->
   7 <refmeta>
   8 <refentrytitle>GEEQIE</refentrytitle>
   9 <manvolnum>1</manvolnum>
  10 <refmiscinfo class='source'>April 2024</refmiscinfo>
  11 <refmiscinfo class='manual'>Geeqie 2.4+git20240413-fc816858 GTK3</refmiscinfo>
  12 </refmeta>
  13 <refnamediv>
  14 <refname>Geeqie</refname>
  15 <refpurpose>GTK based multiformat image viewer</refpurpose>
  16 </refnamediv>
  17 <!-- body begins here -->
  18 <refsynopsisdiv id='synopsis'>
  19 <cmdsynopsis>
  20   <command>geeqie</command>
  21     <arg choice='opt'><replaceable>options</replaceable></arg>
  22     <arg choice='opt'><replaceable>path</replaceable></arg>
  23 </cmdsynopsis>
  24 </refsynopsisdiv>
  25
  26
  27 <refsect1 id='description'><title>DESCRIPTION</title>
  28 <para>Geeqie is an interactive GTK based image viewer that supports multiple image formats,
  29 zooming, panning, thumbnails and sorting images into collections.</para>
  30
  31 <para>Generated for version:</para>
  32
  33 <para>Geeqie 2.4+git20240413-fc816858</para>
  34
  35 <refsect2 id='valid_options'><title>Valid options:</title>
  36 <variablelist remap='TP'>
  37   <varlistentry>
  38   <term><emphasis role='strong' remap='B'>--blank</emphasis></term>
  39   <listitem>
  40 <para>start with blank file list</para>
  41   </listitem>
  42   </varlistentry>
  43   <varlistentry>
  44   <term><emphasis role='strong' remap='B'>--cache-maintenance=</emphasis>&lt;path&gt;</term>
  45   <listitem>
  46 <para>run cache maintenance in non-GUI mode</para>
  47   </listitem>
  48   </varlistentry>
  49   <varlistentry>
  50   <term><emphasis role='strong' remap='B'>--disable-clutter</emphasis></term>
  51   <listitem>
  52 <para>disable use of Clutter library (i.e. GPU accel.)</para>
  53   </listitem>
  54   </varlistentry>
  55   <varlistentry>
  56   <term><emphasis role='strong' remap='B'>-f</emphasis>, <emphasis role='strong' remap='B'>--fullscreen</emphasis></term>
  57   <listitem>
  58 <para>start in full screen mode</para>
  59   </listitem>
  60   </varlistentry>
  61   <varlistentry>
  62   <term><emphasis role='strong' remap='B'>--geometry</emphasis>=<emphasis remap='I'>WxH</emphasis>+XOFF+YOFF</term>
  63   <listitem>
  64 <para>set main window location</para>
  65   </listitem>
  66   </varlistentry>
  67   <varlistentry>
  68   <term><emphasis role='strong' remap='B'>-h</emphasis>, <emphasis role='strong' remap='B'>--help</emphasis></term>
  69   <listitem>
  70 <para>show this message</para>
  71   </listitem>
  72   </varlistentry>
  73 </variablelist>
  74
  75 <para><emphasis role='strong' remap='B'>-l</emphasis>, <emphasis role='strong' remap='B'>--list</emphasis> [files] [collections] open collection window for command line</para>
  76 <variablelist remap='TP'>
  77   <varlistentry>
  78   <term><emphasis role='strong' remap='B'>-n</emphasis>, <emphasis role='strong' remap='B'>--new-instance</emphasis></term>
  79   <listitem>
  80 <para>open a new instance of Geeqie *</para>
  81   </listitem>
  82   </varlistentry>
  83   <varlistentry>
  84   <term><emphasis role='strong' remap='B'>-o</emphasis>, <emphasis role='strong' remap='B'>--log-file=</emphasis>&lt;file&gt;</term>
  85   <listitem>
  86 <para>save log data to file</para>
  87   </listitem>
  88   </varlistentry>
  89   <varlistentry>
  90   <term><emphasis role='strong' remap='B'>-r</emphasis>, <emphasis role='strong' remap='B'>--remote</emphasis></term>
  91   <listitem>
  92 <para>send following commands to open window</para>
  93   </listitem>
  94   </varlistentry>
  95   <varlistentry>
  96   <term><emphasis role='strong' remap='B'>--remote-help</emphasis></term>
  97   <listitem>
  98 <para>print remote command list</para>
  99   </listitem>
 100   </varlistentry>
 101   <varlistentry>
 102   <term><emphasis role='strong' remap='B'>-s</emphasis>, <emphasis role='strong' remap='B'>--slideshow</emphasis></term>
 103   <listitem>
 104 <para>start in slideshow mode</para>
 105   </listitem>
 106   </varlistentry>
 107   <varlistentry>
 108   <term><emphasis role='strong' remap='B'>-T</emphasis>, <emphasis role='strong' remap='B'>--with-tools</emphasis></term>
 109   <listitem>
 110 <para>force show of tools</para>
 111   </listitem>
 112   </varlistentry>
 113   <varlistentry>
 114   <term><emphasis role='strong' remap='B'>-t</emphasis>, <emphasis role='strong' remap='B'>--without-tools</emphasis></term>
 115   <listitem>
 116 <para>force hide of tools</para>
 117   </listitem>
 118   </varlistentry>
 119   <varlistentry>
 120   <term><emphasis role='strong' remap='B'>-v</emphasis>, <emphasis role='strong' remap='B'>--version</emphasis></term>
 121   <listitem>
 122 <para>print version info</para>
 123   </listitem>
 124   </varlistentry>
 125   <varlistentry>
 126   <term><emphasis role='strong' remap='B'>-w</emphasis>, <emphasis role='strong' remap='B'>--show-log-window</emphasis></term>
 127   <listitem>
 128 <para>show log window</para>
 129   </listitem>
 130   </varlistentry>
 131   <varlistentry>
 132   <term><emphasis role='strong' remap='B'>--debug</emphasis>[=<emphasis remap='I'>level</emphasis>]</term>
 133   <listitem>
 134 <para>turn on debug output</para>
 135   </listitem>
 136   </varlistentry>
 137   <varlistentry>
 138   <term><emphasis role='strong' remap='B'>-g</emphasis>, <emphasis role='strong' remap='B'>--grep=</emphasis>&lt;regexp&gt;</term>
 139   <listitem>
 140 <para>filter debug output</para>
 141   </listitem>
 142   </varlistentry>
 143 </variablelist>
 144
 145 <para>* Normally a single set of configuration files is used for all instances.
 146 However, the environment variables XDG_CONFIG_HOME, XDG_CACHE_HOME, XDG_DATA_HOME
 147 can be used to modify this behavior on an individual basis e.g.</para>
 148
 149 <para>XDG_CONFIG_HOME=/tmp/a XDG_CACHE_HOME=/tmp/b geeqie</para>
 150 </refsect2>
 151
 152 <refsect2 id='remote_command_list'><title>Remote command list:</title>
 153 <variablelist remap='TP'>
 154   <varlistentry>
 155   <term><emphasis role='strong' remap='B'>--action=</emphasis>&lt;ACTION&gt;</term>
 156   <listitem>
 157 <para>execute keyboard action (See Help/Reference/Remote Keyboard Actions)</para>
 158   </listitem>
 159   </varlistentry>
 160   <varlistentry>
 161   <term><emphasis role='strong' remap='B'>--action-list</emphasis></term>
 162   <listitem>
 163 <para>list available keyboard actions (some are redundant)</para>
 164   </listitem>
 165   </varlistentry>
 166   <varlistentry>
 167   <term><emphasis role='strong' remap='B'>-b</emphasis> <emphasis role='strong' remap='B'>--back</emphasis></term>
 168   <listitem>
 169 <para>previous image</para>
 170   </listitem>
 171   </varlistentry>
 172   <varlistentry>
 173   <term><emphasis role='strong' remap='B'>--close-window</emphasis></term>
 174   <listitem>
 175 <para>close window</para>
 176   </listitem>
 177   </varlistentry>
 178   <varlistentry>
 179   <term><emphasis role='strong' remap='B'>--config-load=</emphasis>&lt;FILE&gt;|layout ID</term>
 180   <listitem>
 181 <para>load configuration from FILE</para>
 182   </listitem>
 183   </varlistentry>
 184   <varlistentry>
 185   <term><emphasis role='strong' remap='B'>--cache-metadata</emphasis></term>
 186   <listitem>
 187 <para>clean the metadata cache</para>
 188   </listitem>
 189   </varlistentry>
 190   <varlistentry>
 191   <term><emphasis role='strong' remap='B'>--cache-render=</emphasis>&lt;folder&gt;</term>
 192   <listitem>
 193 <para>render thumbnails</para>
 194   </listitem>
 195   </varlistentry>
 196   <varlistentry>
 197   <term><emphasis role='strong' remap='B'>--cache-render-recurse=</emphasis>&lt;folder&gt;</term>
 198   <listitem>
 199 <para>render thumbnails recursively</para>
 200   </listitem>
 201   </varlistentry>
 202   <varlistentry>
 203   <term><emphasis role='strong' remap='B'>--cache-render-shared=</emphasis>&lt;folder&gt;</term>
 204   <listitem>
 205 <para>render thumbnails (see Help)</para>
 206   </listitem>
 207   </varlistentry>
 208   <varlistentry>
 209   <term><emphasis role='strong' remap='B'>--cache-render-shared-recurse=</emphasis>&lt;folder&gt;</term>
 210   <listitem>
 211 <para>render thumbnails recursively (see Help)</para>
 212   </listitem>
 213   </varlistentry>
 214   <varlistentry>
 215   <term><emphasis role='strong' remap='B'>--cache-shared</emphasis>=<emphasis remap='I'>clean</emphasis>|clear</term>
 216   <listitem>
 217 <para>clean or clear shared thumbnail cache</para>
 218   </listitem>
 219   </varlistentry>
 220   <varlistentry>
 221   <term><emphasis role='strong' remap='B'>--cache-thumbs</emphasis>=<emphasis remap='I'>clean</emphasis>|clear</term>
 222   <listitem>
 223 <para>clean or clear thumbnail cache</para>
 224   </listitem>
 225   </varlistentry>
 226   <varlistentry>
 227   <term><emphasis role='strong' remap='B'>-d</emphasis> <emphasis role='strong' remap='B'>--delay=</emphasis>&lt;[H=][M=][N][.M]&gt;</term>
 228   <listitem>
 229 <para>set slide show delay to Hrs Mins N.M seconds</para>
 230   </listitem>
 231   </varlistentry>
 232   <varlistentry>
 233   <term><emphasis role='strong' remap='B'>--first</emphasis></term>
 234   <listitem>
 235 <para>first image</para>
 236   </listitem>
 237   </varlistentry>
 238   <varlistentry>
 239   <term><emphasis role='strong' remap='B'>-f</emphasis> <emphasis role='strong' remap='B'>--fullscreen</emphasis></term>
 240   <listitem>
 241 <para>toggle full screen</para>
 242   </listitem>
 243   </varlistentry>
 244   <varlistentry>
 245   <term><emphasis role='strong' remap='B'>--file=</emphasis>&lt;FILE&gt;|&lt;URL&gt;</term>
 246   <listitem>
 247 <para>open FILE or URL, bring Geeqie window to the top</para>
 248   </listitem>
 249   </varlistentry>
 250   <varlistentry>
 251   <term><emphasis role='strong' remap='B'>--File=</emphasis>&lt;FILE&gt;|&lt;URL&gt;</term>
 252   <listitem>
 253 <para>open FILE or URL, do not bring Geeqie window to the top</para>
 254   </listitem>
 255   </varlistentry>
 256   <varlistentry>
 257   <term><emphasis role='strong' remap='B'>--fullscreen-start</emphasis></term>
 258   <listitem>
 259 <para>start full screen</para>
 260   </listitem>
 261   </varlistentry>
 262   <varlistentry>
 263   <term><emphasis role='strong' remap='B'>--fullscreen-stop</emphasis></term>
 264   <listitem>
 265 <para>stop full screen</para>
 266   </listitem>
 267   </varlistentry>
 268   <varlistentry>
 269   <term><emphasis role='strong' remap='B'>--geometry=</emphasis>&lt;GEOMETRY&gt;</term>
 270   <listitem>
 271 <para>set window geometry</para>
 272   </listitem>
 273   </varlistentry>
 274   <varlistentry>
 275   <term><emphasis role='strong' remap='B'>--get-collection=</emphasis>&lt;COLLECTION&gt;</term>
 276   <listitem>
 277 <para>get collection content</para>
 278   </listitem>
 279   </varlistentry>
 280   <varlistentry>
 281   <term><emphasis role='strong' remap='B'>--get-collection-list</emphasis></term>
 282   <listitem>
 283 <para>get collection list</para>
 284   </listitem>
 285   </varlistentry>
 286   <varlistentry>
 287   <term><emphasis role='strong' remap='B'>--get-destination=</emphasis>&lt;FILE&gt;</term>
 288   <listitem>
 289 <para>get destination path of FILE (See Plugins Configuration)</para>
 290   </listitem>
 291   </varlistentry>
 292   <varlistentry>
 293   <term><emphasis role='strong' remap='B'>--get-file-info</emphasis></term>
 294   <listitem>
 295 <para>get file info</para>
 296   </listitem>
 297   </varlistentry>
 298   <varlistentry>
 299   <term><emphasis role='strong' remap='B'>--get-filelist</emphasis>=<emphasis remap='I'>[</emphasis>&lt;FOLDER&gt;]</term>
 300   <listitem>
 301 <para>get list of files and class</para>
 302   </listitem>
 303   </varlistentry>
 304   <varlistentry>
 305   <term><emphasis role='strong' remap='B'>--get-filelist-recurse</emphasis>=<emphasis remap='I'>[</emphasis>&lt;FOLDER&gt;]</term>
 306   <listitem>
 307 <para>get list of files and class recursive</para>
 308   </listitem>
 309   </varlistentry>
 310   <varlistentry>
 311   <term><emphasis role='strong' remap='B'>--get-rectangle</emphasis></term>
 312   <listitem>
 313 <para>get rectangle co-ordinates</para>
 314   </listitem>
 315   </varlistentry>
 316   <varlistentry>
 317   <term><emphasis role='strong' remap='B'>--get-render-intent</emphasis></term>
 318   <listitem>
 319 <para>get render intent</para>
 320   </listitem>
 321   </varlistentry>
 322   <varlistentry>
 323   <term><emphasis role='strong' remap='B'>--get-selection</emphasis></term>
 324   <listitem>
 325 <para>get list of selected files</para>
 326   </listitem>
 327   </varlistentry>
 328   <varlistentry>
 329   <term><emphasis role='strong' remap='B'>--get-sidecars=</emphasis>&lt;FILE&gt;</term>
 330   <listitem>
 331 <para>get list of sidecars of FILE</para>
 332   </listitem>
 333   </varlistentry>
 334   <varlistentry>
 335   <term><emphasis role='strong' remap='B'>--get-window-list</emphasis></term>
 336   <listitem>
 337 <para>get window list</para>
 338   </listitem>
 339   </varlistentry>
 340   <varlistentry>
 341   <term><emphasis role='strong' remap='B'>--id=</emphasis>&lt;ID&gt;</term>
 342   <listitem>
 343 <para>window id for following commands</para>
 344   </listitem>
 345   </varlistentry>
 346   <varlistentry>
 347   <term><emphasis role='strong' remap='B'>--last</emphasis></term>
 348   <listitem>
 349 <para>last image</para>
 350   </listitem>
 351   </varlistentry>
 352   <varlistentry>
 353   <term><emphasis role='strong' remap='B'>--list-add=</emphasis>&lt;FILE&gt;</term>
 354   <listitem>
 355 <para>add FILE to command line collection list</para>
 356   </listitem>
 357   </varlistentry>
 358   <varlistentry>
 359   <term><emphasis role='strong' remap='B'>--list-clear</emphasis></term>
 360   <listitem>
 361 <para>clear command line collection list</para>
 362   </listitem>
 363   </varlistentry>
 364   <varlistentry>
 365   <term><emphasis role='strong' remap='B'>--lua=</emphasis>&lt;FILE&gt;,&lt;lua script&gt;</term>
 366   <listitem>
 367 <para>run lua script on FILE</para>
 368   </listitem>
 369   </varlistentry>
 370   <varlistentry>
 371   <term><emphasis role='strong' remap='B'>--new-window</emphasis></term>
 372   <listitem>
 373 <para>new window</para>
 374   </listitem>
 375   </varlistentry>
 376   <varlistentry>
 377   <term><emphasis role='strong' remap='B'>-n</emphasis> <emphasis role='strong' remap='B'>--next</emphasis></term>
 378   <listitem>
 379 <para>next image</para>
 380   </listitem>
 381   </varlistentry>
 382   <varlistentry>
 383   <term><emphasis role='strong' remap='B'>--pixel-info</emphasis></term>
 384   <listitem>
 385 <para>print pixel info of mouse pointer on current image</para>
 386   </listitem>
 387   </varlistentry>
 388   <varlistentry>
 389   <term><emphasis role='strong' remap='B'>--print0</emphasis></term>
 390   <listitem>
 391 <para>terminate returned data with null character instead of newline</para>
 392   </listitem>
 393   </varlistentry>
 394   <varlistentry>
 395   <term><emphasis role='strong' remap='B'>--PWD=</emphasis>&lt;PWD&gt;</term>
 396   <listitem>
 397 <para>use PWD as working directory for following commands</para>
 398   </listitem>
 399   </varlistentry>
 400   <varlistentry>
 401   <term><emphasis role='strong' remap='B'>-q</emphasis> <emphasis role='strong' remap='B'>--quit</emphasis></term>
 402   <listitem>
 403 <para>quit</para>
 404   </listitem>
 405   </varlistentry>
 406   <varlistentry>
 407   <term><emphasis role='strong' remap='B'>--raise</emphasis></term>
 408   <listitem>
 409 <para>bring the Geeqie window to the top</para>
 410   </listitem>
 411   </varlistentry>
 412   <varlistentry>
 413   <term><emphasis role='strong' remap='B'>--selection-add</emphasis>=<emphasis remap='I'>[</emphasis>&lt;FILE&gt;]</term>
 414   <listitem>
 415 <para>adds the current file (or the specified file) to the current selection</para>
 416   </listitem>
 417   </varlistentry>
 418   <varlistentry>
 419   <term><emphasis role='strong' remap='B'>--selection-clear</emphasis></term>
 420   <listitem>
 421 <para>clears the current selection</para>
 422   </listitem>
 423   </varlistentry>
 424   <varlistentry>
 425   <term><emphasis role='strong' remap='B'>--selection-remove</emphasis>=<emphasis remap='I'>[</emphasis>&lt;FILE&gt;]</term>
 426   <listitem>
 427 <para>removes the current file (or the specified file) from the current selection</para>
 428   </listitem>
 429   </varlistentry>
 430   <varlistentry>
 431   <term><emphasis role='strong' remap='B'>-s</emphasis> <emphasis role='strong' remap='B'>--slideshow</emphasis></term>
 432   <listitem>
 433 <para>toggle slide show</para>
 434   </listitem>
 435   </varlistentry>
 436   <varlistentry>
 437   <term><emphasis role='strong' remap='B'>--slideshow-recurse=</emphasis>&lt;FOLDER&gt;</term>
 438   <listitem>
 439 <para>start recursive slide show in FOLDER</para>
 440   </listitem>
 441   </varlistentry>
 442   <varlistentry>
 443   <term><emphasis role='strong' remap='B'>--slideshow-start</emphasis></term>
 444   <listitem>
 445 <para>start slide show</para>
 446   </listitem>
 447   </varlistentry>
 448   <varlistentry>
 449   <term><emphasis role='strong' remap='B'>--slideshow-stop</emphasis></term>
 450   <listitem>
 451 <para>stop slide show</para>
 452   </listitem>
 453   </varlistentry>
 454   <varlistentry>
 455   <term><emphasis role='strong' remap='B'>--tell</emphasis></term>
 456   <listitem>
 457 <para>print filename [and Collection] of current image</para>
 458   </listitem>
 459   </varlistentry>
 460   <varlistentry>
 461   <term><emphasis role='strong' remap='B'>-T</emphasis> <emphasis role='strong' remap='B'>--tools-show</emphasis></term>
 462   <listitem>
 463 <para>show tools</para>
 464   </listitem>
 465   </varlistentry>
 466   <varlistentry>
 467   <term><emphasis role='strong' remap='B'>-t</emphasis> <emphasis role='strong' remap='B'>--tools-hide</emphasis></term>
 468   <listitem>
 469 <para>hide tools</para>
 470   </listitem>
 471   </varlistentry>
 472   <varlistentry>
 473   <term><emphasis role='strong' remap='B'>--view=</emphasis>&lt;FILE&gt;</term>
 474   <listitem>
 475 <para>open FILE in new window</para>
 476
 477 <para>All other command line parameters are used as plain files if they exist.</para>
 478
 479 <para>The name of a collection, with or without either path or extension (.gqv) may be used.</para>
 480   </listitem>
 481   </varlistentry>
 482 </variablelist>
 483 </refsect2>
 484 </refsect1>
 485
 486 <refsect1 id='bugs'><title>BUGS</title>
 487 <para>Please send bug reports and feedback to https://github.com/BestImageViewer/geeqie/issues</para>
 488 </refsect1>
 489
 490 <refsect1 id='copyright'><title>COPYRIGHT</title>
 491 <para>Copyright (C) 1999-2004 by John Ellis. Copyright (C) 2004-2024 by The Geeqie Team. Use this software  at  your
 492 own  risk! This  software released under the GNU General Public License. Please read the COPYING file for more
 493 information.</para>
 494 </refsect1>
 495
 496 <refsect1 id='see_also'><title>SEE ALSO</title>
 497 <para>Full documentation: https://www.geeqie.org/help/GuideIndex.html</para>
 498 </refsect1>
 499 </refentry>
 500