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