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