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