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