Fix runtime error
[geeqie.git] / geeqie.1
1 .\"Created with GNOME Manpages Editor
2 .\"http://gmanedit.sourceforge.net
3 .\"Sergio Rua <srua@gpul.org>
4 .\"
5 .\"
6 .\" Geeqie manual page.
7 .\" (C)2004 John Ellis <johne@verizon.net>
8 .\"
9 .\" This document is free to modify and distribute.
10 .\"
11 .TH geeqie 1 "Geeqie"
12
13 .SH NAME
14 Geeqie \- GTK based multiformat image viewer
15 .SH SYNOPSIS
16 .B geeqie
17 .RI [ options ] 
18 .RI [ path ]
19 .br
20
21 .SH DESCRIPTION
22 \fBGeeqie\fP is an interactive GTK based image viewer that supports multiple image formats, zooming, panning, thumbnails and sorting images into collections.
23
24 .SH OPTIONS
25 .B
26 .IP \+t,\-\-with\-tools
27 Force the toolbox to be shown.
28 .br
29 .B
30 .IP \-t,\-\-without\-tools
31 Force the toolbox to be hidden.
32 .br
33 .B
34 .IP \-f,\-\-fullscreen
35 Start in full screen mode.
36 .br
37 .B
38 .IP \-s,\-\-slideshow
39 Start in slideshow mode.
40 .br
41 .B
42 .IP \-l,\-\-list[files...][collections...]
43 Open collection window for command line files.
44 .br
45 .B
46 .IP \-\-blank
47 Start with blank file list.
48 .br
49 .B
50 .IP \-\-geometry=XxY+XOFF+YOFF
51 Set main window location.
52 .br
53 .B
54 .IP \-n,\-\-new-instance
55 Open a new instance of Geeqie.
56 .br
57 .B
58 .IP \-r,\-\-remote
59 Send following commands to open window.
60 .br
61 .B
62 .IP \-rh,\-\-remote-help
63 Print remote command list.
64 .br
65 .B
66 .IP \-\-debug[=level]
67 Turn on debugging output.
68 .br
69 .B
70 .IP \-g:<regexp>,\-\-grep:<regexp>
71 Filter debug output.
72 .br
73 .B
74 .IP \+w,\-\-show-log-window
75 Show log window.
76 .br
77 .B
78 .IP \-o:<FILE>,\-\-log-file:<FILE>
79 Save log data to FILE.
80 .br
81 .B
82 .IP \-v,\-\-version
83 Print version.
84 .br
85 .B
86 .IP \-h,\-\-help
87 Print command line options.
88 .br
89 .B
90 .IP \-\-disable-clutter
91 Disable use of Clutter library (i.e. GPU accel.).
92 .br
93 .B
94 .IP \-\-cache-maintenance\ <path>
95 Run cache maintenance in non-GUI mode.
96
97 .SH REMOTE OPTIONS
98 .B
99 .IP \-n,\-\-next
100 Next image.
101 .br
102 .B
103 .IP \-b,\-\-back
104 Previous image.
105 .br
106 .B
107 .IP \-\-first
108 First image.
109 .br
110 .B
111 .IP \-\-last
112 Last image.
113 .br
114 .B
115 .IP \-f,\-\-fullscreen
116 Toggle full screen.
117 .br
118 .B
119 .IP \-fs,\-\-fullscreen-start
120 Start full screen.
121 .br
122 .B
123 .IP \-fS,\-\-fullscreen-stop
124 Stop full screen.
125 .br
126 .B
127 .IP \-s,\-\-slideshow
128 Toggle slideshow.
129 .br
130 .B
131 .IP \-ss,\-\-slideshow-start
132 Start slideshow.
133 .br
134 .B
135 .IP \-sS,\-\-slideshow-stop
136 Stop slideshow.
137 .br
138 .B
139 .IP \-\-slideshow-recurse:<FOLDER>
140 Start recursive slide show in FOLDER.
141 .br
142 .B
143 .IP \-d<[HRS:][MINS:][N][.M]>,\-\-delay=<[hrs:][mins][N][.M]>
144 Set slide show delay to Hrs Mins N.M seconds.
145 .br
146 .B
147 .IP \+t,\-\-tools-show
148 Show tools.
149 .br
150 .B
151 .IP \-t,\-\-tools-hide
152 Hide tools.
153 .br
154 .B
155 .IP \-q,\-\-quit
156 Quit.
157 .br
158 .B
159 .IP \-\-config-load:<FILE>|layout\ ID
160 Load configuration from FILE.
161 .br
162 .B
163 .IP \-\-get-sidecars:<FILE>
164 Get list of sidecars of FILE.
165 .br
166 .B
167 .IP \-\-get-destination:<FILE>
168 Get destination path of FILE.
169 .br
170 .B
171 .IP file:<FILE>|<URL>
172 Open FILE or URL, bring Geeqie window to the top.
173 .br
174 .B
175 .IP \-\-file:<FILE>|<URL>
176 Open FILE or URL, bring Geeqie window to the top.
177 .br
178 .B
179 .IP File:<FILE>|<URL>
180 Open FILE or URL, do not bring Geeqie window to the top.
181 .br
182 .B
183 .IP \-\-File:<FILE>|<URL>
184 Open FILE or URL, do not bring Geeqie window to the top.
185 .br
186 .B
187 .IP \-\-tell
188 Print filename [and Collection] of current image.
189 .br
190 .B
191 .IP \-\-pixel\-info
192 Print X, Y and RGB of mouse pointer on current image.
193 .br
194 .B
195 .IP \-\-get\-rectangle
196 Get rectangle co-ordinates.
197 .br
198 .B
199 .IP \-\-get\-render\-intent
200 Get render intent.
201 .br
202 .B
203 .IP \-\-get\-filelist:[<FOLDER>]
204 Get list of files and class.
205 .br
206 .B
207 .IP \-\-get\-filelist-recurse:[<FOLDER>]
208 Get list of file and class recursive.
209 .br
210 .B
211 .IP \-\-get\-collection:<COLLECTION>
212 Get collection content.
213 .br
214 .B
215 .IP \-\-get\-collection\-list
216 Get collection list.
217 .br
218 .B
219 .IP \-\-get\-file\-info
220 Get file info.
221 .br
222 .B
223 .IP view:<FILE>
224 Open FILE in new window.
225 .br
226 .B
227 .IP \-\-view:<FILE>
228 Open FILE in new window.
229 .br
230 .B
231 .IP \-\-list-clear
232 Clear command line collection list.
233 .br
234 .B
235 .IP \-\-list-add:<FILE>
236 Add FILE to command line collection list.
237 .br
238 .B
239 .IP raise
240 Bring the Geeqie window to the top.
241 .br
242 .B
243 .IP \-\-raise
244 Bring the Geeqie window to the top.
245 .br
246 .B
247 .IP \-\-id:<ID>
248 Window ID for following commands.
249 .br
250 .B
251 .IP \-\-new-window
252 Open new window.
253 .br
254 .B
255 .IP \-\-close-window
256 Close window.
257 .br
258 .B
259 .IP \-\-geometry=[XxY][+XOFF+YOFF]
260 Set window geometry.
261 .br
262 .B
263 .IP \-ct:clear|clean,\-\-cache-thumbs:clear|clean
264 Clear or clean thumbnail cache.
265 .br
266 .B
267 .IP \-cs:clear|clean,\-\-cache-shared:clear|clean
268 Clear or clean shared thumbnail cache.
269 .br
270 .B
271 .IP \-cm,\-\-cache-metadata
272 Clean metadata cache.
273 .br
274 .B
275 .IP \-cr:<folder>,\-\-cache-render:<folder>
276 Render thumbnails.
277 .br
278 .B
279 .IP \-crr:<folder>,\-\-cache-render-recurse:<folder>
280 Render thumbnails recursively.
281 .br
282 .B
283 .IP \-crs:<folder>,\-\-cache-render-shared:<folder>
284 Render thumbnails (see Help).
285 .br
286 .B
287 .IP \-crsr:<folder>,\-\-cache-render-shared-recurse:<folder>
288 Render thumbnails recursively (see Help).
289 .br
290 .B
291 .IP \-\-lua:<FILE>,<lua-script>
292 Run lua script on FILE.
293 .br
294 .B
295 .IP \-\-PWD:<PWD>
296 Use PWD as working directory for following commands.
297 .br
298 .B
299 .IP \-\-print0
300 Terminate returned data with null character instead of newline.
301 .br
302
303 .SH USAGE
304 Key naming is similar to that of \fBemacs\fP(1): \fIC-key\fP indicates that control should be held, and key should be pressed; \fIS-key\fP  indicates that shift should be held and key should be pressed; these two can be combined, also, into \fIC-S-key\fP.
305 .B
306 .IP left-mouse-click
307 (on image) next image
308 .br
309 .B
310 .IP middle-mouse-click
311 (on image) previous image
312 .br
313 .B
314 .IP right-mouse
315 context menu
316 .br
317 .B
318 .IP middle-mouse-drag
319 drag and drop operations
320 .br
321 .B
322 .IP mouse-wheel
323 (on image) Changes to the next or previous image, or if option is enabled, scrolls the image vertically.
324 .br
325 .B
326 .IP mouse-wheel+Shift-key
327 (on image) Inverts the mouse wheel behavior between scrolling image or changing image.
328 .br
329 .B
330 .IP mouse-wheel+Control-key
331 (on image) Zooms the image in and out.
332 .br
333 .SS GENERAL  KEYS
334 .B
335 .IP PageDown
336 next image
337 .br
338 .B
339 .IP PageUp
340 previous image
341 .br
342 .B
343 .IP Home                             
344 first image in list
345 .br
346 .B
347 .IP End
348 last image in list
349 .br
350 .B
351 .IP Tab
352 tab completion in path entry window
353 .br
354 .B
355 .IP Escape
356 cancel completion in path entry window or stop generating thumbnails
357 .br
358 .SS IMAGE KEYS
359 Keys that are valid when the image part of the window is focused.
360 .B
361 .IP Arrows
362 pan image
363 .br
364 .B
365 .IP Shift+Arrows
366 pan image faster
367 .br
368 .B
369 .IP Space,N
370 next image
371 .br
372 .B
373 .IP Backspace,B
374 previous image
375 .br
376 .SS FILE RELATED KEYS
377 .B
378 .IP C
379 new empty collection
380 .br
381 .B
382 .IP O
383 open collection
384 .br
385 .B
386 .IP D
387 open the Find Duplicates window
388 .br
389 .B
390 .IP C-F
391 new folder
392 .br
393 .B
394 .IP C-C
395 copy file
396 .br
397 .B
398 .IP C-M
399 move file
400 .br
401 .B
402 .IP C-R
403 rename file
404 .br
405 .B
406 .IP C-D,Delete
407 delete file
408 .br
409 .B
410 .IP C-N
411 new window
412 .br
413 .B
414 .IP C-W
415 close window
416 .br
417 .B
418 .IP C-Q
419 quit
420 .br
421 .SS EDIT MENU RELATED KEYS
422 .B
423 .IP C-1,2..9,0
424 run external editor
425 .br
426 .B
427 .IP C-A
428 select all files
429 .br
430 .B
431 .IP C-S-A
432 unselect all files
433 .br
434 .B
435 .IP C-O
436 go to the Configuration window
437 .br
438 .B
439 .IP C-P
440 display image properties
441 .br
442 .B
443 .IP ]
444 rotate image clockwise
445 .br
446 .B
447 .IP [
448 rotate image counterclockwise
449 .br
450 .B
451 .IP S-R
452 rotate image 180 degrees
453 .br
454 .B
455 .IP S-M
456 mirror image (horizontal)
457 .br
458 .B
459 .IP S-F
460 flip image (vertical)
461 .br
462 .SS VIEW MENU RELATED KEYS
463 .B
464 .IP +,=
465 zoom in
466 .br
467 .B
468 .IP -
469 zoom out
470 .br
471 .B
472 .IP Z,KeyPad-/
473 zoom to original size
474 .br
475 .B
476 .IP X,KeyPad-*
477 zoom to fit window
478 .br
479 .B
480 .IP 1,2,3,4
481 zoom in to X scale factor
482 .br
483 .B
484 .IP 9,8,7
485 zoom to \-2, \-3, \-4, respectively
486 .br
487 .B
488 .IP T
489 toggle thumbnail display
490 .br
491 .B
492 .IP C-L
493 display files in list format
494 .br
495 .B
496 .IP C-I
497 display files in icon format
498 .br
499 .B
500 .IP C-T
501 toggle tree view for directories
502 .br
503 .B
504 .IP R
505 refresh file list
506 .br
507 .B
508 .IP L
509 toggle floating of file selection area
510 .br
511 .B
512 .IP H
513 toggle hiding of file selection area
514 .br
515 .B
516 .IP F,V
517 toggle full-screen mode
518 .br
519 .B
520 .IP S
521 toggle slide-show mode
522 .br
523 .B
524 .IP P
525 toggle pause of slideshow
526 .br
527 .B
528 .IP C-E
529 toggle display of exif sidebar
530 .br
531 .B
532 .IP C-S
533 toggle display of sort manager
534 .br
535 .SS COLLECTION WINDOW KEYS
536 .B
537 .IP Arrows
538 move selection
539 .br
540 .B
541 .IP Shift+Arrows
542 select multiple images
543 .br
544 .B
545 .IP Control+Arrows
546 move selector without changing selection
547 .br
548 .B
549 .IP Space
550 select the image under the selector
551 .br
552 .B
553 .IP Control+Space
554 toggle selection of the image under the selector
555 .br
556 .B
557 .IP Home
558 move selector to the top image
559 .br
560 .B
561 .IP End
562 move selector to bottom image
563 .br
564 Adding Shift or Control to Home and End has a similar effect as adding them to the arrows.
565 .B
566 .IP C-A
567 select all images
568 .br
569 .B
570 .IP C-S-A
571 unselect all images
572 .br
573 .B
574 .IP Delete
575 remove image form collection (does not delete the file)
576 .br
577 .B
578 .IP C-L
579 add images to collection form main file list
580 .br
581 .B
582 .IP N
583 sort collection by name
584 .br
585 .B
586 .IP D
587 sort collection by date
588 .br
589 .B
590 .IP B
591 sort collection by file size
592 .br
593 .B
594 .IP P
595 sort collection by pathname
596 .br
597 .B
598 .IP I
599 sort collection by name numerically (*)
600 .br
601 .B
602 .IP Enter
603 view image under selector in the main image window
604 .br
605 .B
606 .IP V
607 view image under selector in new window
608 .br
609 .B
610 .IP C-1,2..9,0
611 open selected image(s) in external editor
612 .br
613 .B
614 .IP S
615 save collection
616 .br
617 .B
618 .IP C-S
619 save collection as
620 .br
621 .B
622 .IP A
623 append current collection to existing collection
624 .br
625 .B
626 .IP C-C
627 copy selected files
628 .br
629 .B
630 .IP C-M
631 move selected files
632 .br
633 .B
634 .IP C-R
635 rename selected files
636 .br
637 .B
638 .IP C-D
639 delete selected files
640 .br
641 .B
642 .IP C-W
643 close window
644 .br
645 .SS DUPLICATES WINDOW KEYS
646 .B
647 .IP C-A
648 select all images
649 .br
650 .B
651 .IP C-S-A
652 unselect all images
653 .br
654 .B
655 .IP 1
656 select group 1 images
657 .br
658 .B
659 .IP 2
660 select group 2 images
661 .br
662 .B
663 .IP C-L
664 add images from main window file list
665 .br
666 .B
667 .IP C
668 add selected images to new collection
669 .br
670 .B
671 .IP Delete
672 remove selected images from list
673 .br
674 .B
675 .IP C-Delete
676 clear window
677 .br
678 .B
679 .IP Enter
680 view image with focus in main window
681 .br
682 .B
683 .IP V
684 view image with focus in new window
685 .br
686 .B
687 .IP C-1,2..9,0
688 open selected image(s) in editor
689 .br
690 .B
691 .IP C-P
692 display properties window for selected images
693 .br
694 .B
695 .IP C-C
696 copy selected files
697 .br
698 .B
699 .IP C-M
700 move selected files
701 .br
702 .B
703 .IP C-R
704 rename selected files
705 .br
706 .B
707 .IP C-D
708 delete selected files
709 .br
710 .B
711 .IP C-W
712 close window
713 .br
714
715 .SH FILES
716 The following data lists the locations Geeqie uses for various actions. The
717 uppercase symbols are environment variables. If they are not set on your system
718 the fallback locations are listed in parentheses. Geeqie will first attempt to
719 load a configuration file from:
720
721 .B /etc/geeqie/geeqierc.xml
722
723 It will then continue with the following locations.
724 Most of Geeqie's configuration files are contained in the folder, and sub-folders of:
725
726 .B $XDG_CONFIG_HOME/geeqie/
727 .B ($~/.config/geeqie/)
728
729 Geeqie's standard configuration file is:
730
731 .B .../geeqierc.xml
732
733 An alternative configuration file may be used by executing:
734
735 .B geeqie -r --config-load:<filename>
736
737 Geeqie-created desktop files used by Plugins are in the folder:
738
739 .B .../applications
740
741 Lua script files for Lua Extensions are in the folder:
742
743 .B .../lua
744
745 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:
746
747 .B .../history
748
749 Keyboard shortcut maps are contained in this text file:
750
751 .B .../accels
752
753 The location for Collections is in the folder:
754
755 .B $XDG_DATA_HOME/geeqie/collections
756 .br
757 .B ($~/.local/share/geeqie/collections)
758
759 The lirc Infra-red controller configuration file must be located at:
760
761 .B $HOME/.lircrc
762
763 Thumbnails are stored in a location specified in Thumbnail Preferences
764
765 Metadata is stored either in the image file or in the location specified in Safe Delete
766
767 The safe delete folder is specified in the Metadata tab of main Preferences
768
769 .SH LICENSE
770 Copyright (C) 1999-2004 by John Ellis.
771 Copyright (C) 2004-2017 by The Geeqie Team.
772 Use this software at your own risk!  
773 This software released under the GNU General Public License. Please read the COPYING file for more information.
774 .SH BUGS
775 Please send bug reports and feedback to https://github.com/BestImageViewer/geeqie/issues
776 .SH AUTHOR
777 .B John Ellis
778 <johne@verizon.net>
779 .br
780 Manpage originally prepared by
781 .B Nick Rusnov
782 <nick@grawk.net>