Preparing stable version
[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 of current image.
169 .br
170 .B
171 .IP \-\-view:<FILE>
172 Open FILE in new window.
173 .br
174 .B
175 .IP \-\-list-clear
176 Clear command line collection list.
177 .br
178 .B
179 .IP \-\-list-add:<FILE>
180 Add FILE to command line collection list.
181 .br
182 .B
183 .IP raise
184 Bring the Geeqie window to the top.
185 .br
186 .B
187 .IP \-ct:clear|clean,\-\-cache-thumbs:clear|clean
188 Clear or clean thumbnail cache.
189 .br
190 .B
191 .IP \-cs:clear|clean,\-\-cache-shared:clear|clean
192 Clear or clean shared thumbnail cache.
193 .br
194 .B
195 .IP \-cm,\-\-cache-metadata
196 Clean metadata cache.
197 .br
198 .B
199 .IP \-cr:<folder>,\-\-cache-render:<folder>
200 Render thumbnails.
201 .br
202 .B
203 .IP \-crr:<folder>,\-\-cache-render-recurse:<folder>
204 Render thumbnails recursively.
205 .br
206 .B
207 .IP \-crs:<folder>,\-\-cache-render-shared:<folder>
208 Render thumbnails (see Help).
209 .br
210 .B
211 .IP \-crsr:<folder>,\-\-cache-render-shared-recurse:<folder>
212 Render thumbnails recursively (see Help).
213 .br
214 .B
215 .IP \-\-lua:<FILE>,<lua-script>
216 Run lua script on FILE.
217 .br
218
219 .SH USAGE
220 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.
221 .B
222 .IP left-mouse-click
223 (on image) next image
224 .br
225 .B
226 .IP middle-mouse-click
227 (on image) previous image
228 .br
229 .B
230 .IP right-mouse
231 context menu
232 .br
233 .B
234 .IP middle-mouse-drag
235 drag and drop operations
236 .br
237 .B
238 .IP mouse-wheel
239 (on image) Changes to the next or previous image, or if option is enabled, scrolls the image vertically.
240 .br
241 .B
242 .IP mouse-wheel+Shift-key
243 (on image) Inverts the mouse wheel behavior between scrolling image or changing image.
244 .br
245 .B
246 .IP mouse-wheel+Control-key
247 (on image) Zooms the image in and out.
248 .br
249 .SS GENERAL  KEYS
250 .B
251 .IP PageDown
252 next image
253 .br
254 .B
255 .IP PageUp
256 previous image
257 .br
258 .B
259 .IP Home                             
260 first image in list
261 .br
262 .B
263 .IP End
264 last image in list
265 .br
266 .B
267 .IP Tab
268 tab completion in path entry window
269 .br
270 .B
271 .IP Escape
272 cancel completion in path entry window or stop generating thumbnails
273 .br
274 .SS IMAGE KEYS
275 Keys that are valid when the image part of the window is focused.
276 .B
277 .IP Arrows
278 pan image
279 .br
280 .B
281 .IP Shift+Arrows
282 pan image faster
283 .br
284 .B
285 .IP Space,N
286 next image
287 .br
288 .B
289 .IP Backspace,B
290 previous image
291 .br
292 .SS FILE RELATED KEYS
293 .B
294 .IP C
295 new empty collection
296 .br
297 .B
298 .IP O
299 open collection
300 .br
301 .B
302 .IP D
303 open the Find Duplicates window
304 .br
305 .B
306 .IP C-F
307 new folder
308 .br
309 .B
310 .IP C-C
311 copy file
312 .br
313 .B
314 .IP C-M
315 move file
316 .br
317 .B
318 .IP C-R
319 rename file
320 .br
321 .B
322 .IP C-D,Delete
323 delete file
324 .br
325 .B
326 .IP C-N
327 new window
328 .br
329 .B
330 .IP C-W
331 close window
332 .br
333 .B
334 .IP C-Q
335 quit
336 .br
337 .SS EDIT MENU RELATED KEYS
338 .B
339 .IP C-1,2..9,0
340 run external editor
341 .br
342 .B
343 .IP C-A
344 select all files
345 .br
346 .B
347 .IP C-S-A
348 unselect all files
349 .br
350 .B
351 .IP C-O
352 go to the Configuration window
353 .br
354 .B
355 .IP C-P
356 display image properties
357 .br
358 .B
359 .IP ]
360 rotate image clockwise
361 .br
362 .B
363 .IP [
364 rotate image counterclockwise
365 .br
366 .B
367 .IP S-R
368 rotate image 180 degrees
369 .br
370 .B
371 .IP S-M
372 mirror image (horizontal)
373 .br
374 .B
375 .IP S-F
376 flip image (vertical)
377 .br
378 .SS VIEW MENU RELATED KEYS
379 .B
380 .IP +,=
381 zoom in
382 .br
383 .B
384 .IP -
385 zoom out
386 .br
387 .B
388 .IP Z,KeyPad-/
389 zoom to original size
390 .br
391 .B
392 .IP X,KeyPad-*
393 zoom to fit window
394 .br
395 .B
396 .IP 1,2,3,4
397 zoom in to X scale factor
398 .br
399 .B
400 .IP 9,8,7
401 zoom to \-2, \-3, \-4, respectively
402 .br
403 .B
404 .IP T
405 toggle thumbnail display
406 .br
407 .B
408 .IP C-L
409 display files in list format
410 .br
411 .B
412 .IP C-I
413 display files in icon format
414 .br
415 .B
416 .IP C-T
417 toggle tree view for directories
418 .br
419 .B
420 .IP R
421 refresh file list
422 .br
423 .B
424 .IP L
425 toggle floating of file selection area
426 .br
427 .B
428 .IP H
429 toggle hiding of file selection area
430 .br
431 .B
432 .IP F,V
433 toggle full-screen mode
434 .br
435 .B
436 .IP S
437 toggle slide-show mode
438 .br
439 .B
440 .IP P
441 toggle pause of slideshow
442 .br
443 .B
444 .IP C-E
445 toggle display of exif sidebar
446 .br
447 .B
448 .IP C-S
449 toggle display of sort manager
450 .br
451 .SS COLLECTION WINDOW KEYS
452 .B
453 .IP Arrows
454 move selection
455 .br
456 .B
457 .IP Shift+Arrows
458 select multiple images
459 .br
460 .B
461 .IP Control+Arrows
462 move selector without changing selection
463 .br
464 .B
465 .IP Space
466 select the image under the selector
467 .br
468 .B
469 .IP Control+Space
470 toggle selection of the image under the selector
471 .br
472 .B
473 .IP Home
474 move selector to the top image
475 .br
476 .B
477 .IP End
478 move selector to bottom image
479 .br
480 Adding Shift or Control to Home and End has a similar effect as adding them to the arrows.
481 .B
482 .IP C-A
483 select all images
484 .br
485 .B
486 .IP C-S-A
487 unselect all images
488 .br
489 .B
490 .IP Delete
491 remove image form collection (does not delete the file)
492 .br
493 .B
494 .IP C-L
495 add images to collection form main file list
496 .br
497 .B
498 .IP N
499 sort collection by name
500 .br
501 .B
502 .IP D
503 sort collection by date
504 .br
505 .B
506 .IP B
507 sort collection by file size
508 .br
509 .B
510 .IP P
511 sort collection by pathname
512 .br
513 .B
514 .IP I
515 sort collection by name numerically (*)
516 .br
517 .B
518 .IP Enter
519 view image under selector in the main image window
520 .br
521 .B
522 .IP V
523 view image under selector in new window
524 .br
525 .B
526 .IP C-1,2..9,0
527 open selected image(s) in external editor
528 .br
529 .B
530 .IP S
531 save collection
532 .br
533 .B
534 .IP C-S
535 save collection as
536 .br
537 .B
538 .IP A
539 append current collection to existing collection
540 .br
541 .B
542 .IP C-C
543 copy selected files
544 .br
545 .B
546 .IP C-M
547 move selected files
548 .br
549 .B
550 .IP C-R
551 rename selected files
552 .br
553 .B
554 .IP C-D
555 delete selected files
556 .br
557 .B
558 .IP C-W
559 close window
560 .br
561 .SS DUPLICATES WINDOW KEYS
562 .B
563 .IP C-A
564 select all images
565 .br
566 .B
567 .IP C-S-A
568 unselect all images
569 .br
570 .B
571 .IP 1
572 select group 1 images
573 .br
574 .B
575 .IP 2
576 select group 2 images
577 .br
578 .B
579 .IP C-L
580 add images from main window file list
581 .br
582 .B
583 .IP C
584 add selected images to new collection
585 .br
586 .B
587 .IP Delete
588 remove selected images from list
589 .br
590 .B
591 .IP C-Delete
592 clear window
593 .br
594 .B
595 .IP Enter
596 view image with focus in main window
597 .br
598 .B
599 .IP V
600 view image with focus in new window
601 .br
602 .B
603 .IP C-1,2..9,0
604 open selected image(s) in editor
605 .br
606 .B
607 .IP C-P
608 display properties window for selected images
609 .br
610 .B
611 .IP C-C
612 copy selected files
613 .br
614 .B
615 .IP C-M
616 move selected files
617 .br
618 .B
619 .IP C-R
620 rename selected files
621 .br
622 .B
623 .IP C-D
624 delete selected files
625 .br
626 .B
627 .IP C-W
628 close window
629 .br
630
631
632 .SH LICENSE
633 Copyright (C) 1999-2004 by John Ellis.
634 Copyright (C) 2004-2017 by The Geeqie Team.
635 Use this software at your own risk!  
636 This software released under the GNU General Public License. Please read the COPYING file for more information.
637 .SH BUGS
638 Please send bug reports and feedback to https://github.com/BestImageViewer/geeqie/issues
639 .SH AUTHOR
640 .B John Ellis
641 <johne@verizon.net>
642 .br
643 Manpage originally prepared by
644 .B Nick Rusnov
645 <nick@grawk.net>