IPC added to let GLiv reuse an existing window.
[gliv.git] / gliv.1
blob707f1b4fa2912ab7ac5a0d7921bb2fb06c86414d
1 .TH "gliv" "1" "1.8" "Guillaume Chazarain" "Image viewer"
2 .SH "NAME"
3 gliv \- An OpenGL Image Viewer
4 .SH "SYNOPSIS"
5 \fBgliv\fR [OPTIONS]... [FILES]...
6 .SH "DESCRIPTION"
7 \fIgliv\fR uses gdk\-pixbuf to load images and OpenGL to render them.
8 It allows to do some moving, rotating, zooming and slide show.
9 .SH "OPTIONS"
10 The options are first set to their default value, then read from ~/.glivrc and finally read from the command line.
11 .br 
12 To disable an option activated by default just specify it, in order to toggle its value.
14 .TP 
15 \fB\-h, \-\-help\fR
16 Print help and exit.
17 .TP 
18 \fB\-V, \-\-version\fR
19 Print version and exit.
20 .TP 
21 \fB\-s, \-\-shuffle\fR
22 Show images in random order. The images list will be shuffled before the slide show.
23 .TP 
24 \fB\-S, \-\-sort\fR
25 Show images in sorted order. The images list will be sorted before the slide show.
26 .TP 
27 \fB\-R, \-\-recursive\fR
28 Processe directories recursively (default=off). If you specify a directory in the command line \fIgliv\fR will open every image in this directory and its subdirectories.
29 .TP 
30 \fB\-f, \-\-fullscreen\fR
31 Start in full screen mode (default=off). You can still go back to windowed mode by pressing 'f' or using the menu.
32 .TP 
33 \fB\-l, \-\-scale\-down\fR
34 Reduce the image to the window (default=off). Make the image fit window if the image need to be reduced. It implies \-f and is like typing 'l' with every image.
35 .TP 
36 \fB\-M, \-\-maximize\fR
37 Maximize the image to the window (default=off). Make the image fit window if the image need to be enlarged. It implies \-f and is like typing 'M' with every image.
38 .TP 
39 \fB\-m, \-\-make\-fit\fR
40 Make the image fit the window (default=off). Make the image fit the window wathever the image size, this is the equivalent of \-l and \-M. It is like typing 'm' with every image.
41 .TP 
42 \fB\-z, \-\-zoom\-pointer\fR
43 Zoom centered on pointer (default=off). By default the zoom is centered on the window center, with this option, it is on the mouse pointer.
44 .TP 
45 \fB\-t, \-\-dither\fR
46 Enable dithering (default=off). Use this option if you are on a low colors display, that is with a depth of 16 bits, and the image quality does not satisfy you.
47 .br 
48 Note that it makes loading a bit slower.
49 .TP 
50 \fB\-F, \-\-force\-load\fR
51 Try to load every file (default=off). When loading a file, the loader is chosen according to the filename extension in order to optimize the loading time. If the extension is unknown, the file is ignored, with this option \fIgliv\fR will always try to load the file.
52 .TP 
53 \fB\-p, \-\-mipmap\fR
54 Build mipmaps (default=off). Mipmaps are good on a not so fast graphics board, to speed up drawing large images zoomed out. On the other hand, it makes loading slower.
55 .TP 
56 \fB\-n, \-\-mnemonics\fR
57 Make mnemonics for images menus (default=off). When this option is disabled the images menus are built much more quickly.
58 .TP 
59 \fB\-w, \-\-slide\-show\fR
60 Start the slide show immediately (default=off). This way you will not have to start the slide show from the menu.
61 .TP 
62 \fB\-L, \-\-loop\fR
63 Make the slide show loop at the end (default=off). When the last image is displayed, asking for the next one will show the first one.
64 .TP 
65 \fB\-1, \-\-one\-image\fR
66 Keep only one image in memory (default=off). This is useful when you load very big images that would not fit in memory if they were not alone. Otherwise it would just make switching between images slower since the image is not preloaded anymore.
67 .TP 
68 \fB\-0, \-\-null\fR
69 Read null\-terminated filenames (default=off). This can be used with "find \-print0" or with "tr '\en' '\e0'" when you have a very long list of filenames to pass to gliv. Unlike xargs(1) it allows an unlimited number of filenames.
70 .TP 
71 \fB\-C, \-\-client\fR
72 Connect to an already running gliv (default=off). With this option, GLiv will open the files passed in the arguments in the GLiv server window. It only honours the options to sort, shuffle and recursively traverse directories. It can also be used with the above \-0 option. The GLiv server is the latest launched gliv or the one which has been chosen using the Options menu.
73 .TP 
74 \fB\-e, \-\-build\-menus\fR
75 Build images menu at startup (default=on). Disabling the images menus creation at startup makes it faster, especially with many files on the command line.
76 .TP 
77 \fB\-b, \-\-menu\fR
78 Display the menu bar (default=on). Use it to display the currently minimal menubar, you can also use the 'b' key.
79 .TP 
80 \fB\-i, \-\-info\fR
81 Show infos about displayed image (default=on). With this option, \fIgliv\fR will by default print the info line you can obtain by typing 'i'.
82 .TP 
83 \fB\-o, \-\-scrollbars\fR
84 Display scrollbars (default=on). Enable or disable the scrollbars on the borders.
85 .TP 
86 \fB\-g, \-\-glivrc\fR
87 Load ~/.glivrc (default=on). Specify it once to disable loading of the rc file. It can be used to make finding which argument to put on the command line easier.
88 .TP 
89 \fB\-c, \-\-alpha\-checks\fR
90 Alpha checks in the background (default=on). Use it to have a checker background when the image has an alpha channel. This may cause slowdown when redrawing images with an alpha channel. You can also use the 'a' key.
91 .TP 
92 \fB\-T, \-\-thumbnails\fR
93 Show thumbnails in images menus (default=on). The thumbnails size is configurable in the option dialog.
94 .TP 
95 \fB\-W, \-\-resize\-win\fR
96 Automatic window resizing (default=on). By default, in window mode, GLiv resizes the window for each image. You can disable this behaviour with this option.
97 .TP 
98 \fB\-dINT, \-\-delay=INT\fR
99 Delay before hiding the cursor. If you use this option with a strictly positive number t as argument, \fIgliv\fR will wait for t milliseconds of mouse inactivity and then hide the cursor. It reappears when you move the mouse.
100 .TP 
101 \fB\-uINT, \-\-history=INT\fR
102 Length of history. The maximum number of items in the history. Use 0 to disable the history, and \-1 to make it unlimited.
103 The default is 1000 but the suggested value is \-1, because the size of an item is 44 bytes (on a 32 bits system) which won't fill your memory.
104 .TP 
105 \fB\-aINT, \-\-duration=INT\fR
106 Delay between each image. This is the minimal time to wait between each image during the slide show. It does not include the time load the image, and is exprimed in seconds.
107 .TP 
108 \fB\-PINT, \-\-fps=INT\fR
109 Maximum framerate. When moving the image with the mouse, the framerate can become quite big, and the CPU usage too. With this option and a positive argument, the framerate can be limited in this situation.
110 .SH "COLLECTIONS"
111 Starting with version 1.8, GLiv supports a file format called "GLiv collection". It contains an images list and the associated thumbnails, this way, when you load a collection the images menus rebuilding is faster since it does not have to make thumbnails.
112 .br 
113 GLiv supports also transparent decompression, so the collections can be compressed in bzip2, gzip or compress(1) provided that  you have the corresponding decompressor.
114 .SH "CONTROLS"
116 ESC, q : Quit
118 f      : Full-screen/window
120 +/=/-  : Zoom in/in/out
122 n/p    : Next/previous image
124 l      : Reduce the image to the window
126 M      : Maximize the image to the window
128 m      : Make the image fit the window
130 r      : Reset position and size
132 b      : Toggle display of the menu bar
134 i      : Toggle display of the info bar
136 s      : Toggle display of the scrollbars
138 a      : Toggle display of the alpha checks
140 h      : Toggle display of the help box
142 o      : Display the open dialog
144 t      : Display the options dialog
146 d      : Hide the cursor
148 u      : Undo
150 y      : Redo
152 c      : Clear the history
154 x      : Delete the current file
156 C-up   : Rotate by +45 degrees
158 C-down : Rotate by -45 degrees
160 C-left : Rotate by +0.1 degree
162 C-right: Rotate by -0.1 degree
164 z      : Horizontal flip
166 e      : Vertical flip
169 The first mouse button and the arrow keys will move the image unless the Control key is pressed. In which case the image will be rotated around the window center.
172 Your mouse wheel (if supported) will zoom the image and switch it when you press the button.
175 You can also zoom by dragging the mouse vertically while holding Shift and the first button.
178 Space and Backspace act like n and p.
181 Draw a rectangle with the third button and gliv will zoom in it.
184 .SH "FILE"
185 \fB~/.glivrc\fR \- This file is absolutely not mandatory.
186 .SH "AUTHOR"
187 Guillaume Chazarain <guichaz@yahoo.fr>
189 See http://gliv.tuxfamily.org.