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