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