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