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