Prepare for images transitions.
[gliv.git] / gliv.1
blob0d18f047773b13198dec9b7d02ff49aaf4711c6c
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 values, "off" for flags, then read from ~/.glivrc and finally read from the command line.
11 .br 
12 Omitting the argument for an option that takes an "on|off" argument (flags) is like giving it "on", so \-\-foo is the same as \-\-foo=on if foo is an on|off flag.
13 .TP 
14 \fB\-h, \-\-help\fR
15 Print help and exit.
16 .TP 
17 \fB\-V, \-\-version\fR
18 Print version and exit.
19 .TP 
20 \fB\-a, \-\-duration=delay\fR
21 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.
22 .TP 
23 \fB\-b, \-\-menu=on|off\fR
24 Hide the menu bar. Use it to give more room to the displayed image. You can also use the 'b' key.
25 .TP 
26 \fB\-C, \-\-client=on|off\fR
27 Connect to an already running gliv. 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.
28 .TP 
29 \fB\-c, \-\-alpha\-checks=on|off\fR
30 No alpha checks in the background. Use it to have the same background with images having an alpha channel as when the image lacks it instead of a checker background. This may speed up redrawing images with an alpha channel. You can also use the 'a' key.
31 .TP 
32 \fB\-d, \-\-delay=hide\-delay\fR
33 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.
34 .TP 
35 \fB\-e, \-\-build\-menus=on|off\fR
36 No images menu at startup. Disabling the images menus creation at startup makes it faster, especially with many files on the command line.
37 .TP 
38 \fB\-F, \-\-force\-load=on|off\fR
39 Try to load every file. 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.
40 .TP 
41 \fB\-f, \-\-fullscreen=on|off\fR
42 Start in full screen mode. You can still go back to windowed mode by pressing 'f' or using the menu.
43 .TP 
44 \fB\-g, \-\-glivrc=on|off\fR
45 Ignore ~/.glivrc. Specify it to disable loading of the rc file. It can be used to make finding which argument to put on the command line easier.
46 .TP 
47 \fB\-i, \-\-info=on|off\fR
48 Hide the status bar. With this option, \fIgliv\fR will hide the info line, it gives more room to the displayed image. You can then re\-enable it by typing 'i' or using the menu.
49 .TP 
50 \fB\-L, \-\-loop=on|off\fR
51 Make the slide show loop at the end. When the last image is displayed, asking for the next one will show the first one. It will also loop backward when asked for the image before the first one.
52 .TP 
53 \fB\-l, \-\-scale\-down=on|off\fR
54 Reduce the image to the window. Make the image fit the window if the image need to be reduced. It is like typing 'l' with every image.
55 .TP 
56 \fB\-M, \-\-maximize=on|off\fR
57 Maximize the image to the window. Make the image fit window if the image need to be enlarged. It is like typing 'M' with every image.
58 .TP 
59 \fB\-m, \-\-make\-fit=on|off\fR
60 Make the image fit the window. 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.
61 .TP 
62 \fB\-n, \-\-mnemonics=on|off\fR
63 No mnemonics in images menus. Disabling mnemonics in images menus can make their construction a bit faster.
64 .TP 
65 \fB\-o, \-\-scrollbars=on|off\fR
66 Hide the scrollbars. Scrollbars can slow down image manipulations, and eat some space.
67 .TP 
68 \fB\-P, \-\-fps=fps\fR
69 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.
70 .TP 
71 \fB\-p, \-\-mipmap=on|off\fR
72 Build mipmaps. Mipmaps are good on a not so fast graphics board, to speed up drawing large images zoomed out. On the other hand, they make loading slower.
73 .TP 
74 \fB\-R, \-\-recursive=on|off\fR
75 Process directories recursively. If you specify a directory in the command line \fIgliv\fR will open every image in this directory and its subdirectories.
76 .TP 
77 \fB\-S, \-\-sort=on|off\fR
78 Show images in sorted order. The images list will be sorted before the slide show.
79 .TP 
80 \fB\-s, \-\-shuffle=on|off\fR
81 Show images in random order. The images list will be shuffled before the slide show.
82 .TP 
83 \fB\-T, \-\-thumbnails=on|off\fR
84 No thumbnails in images menus. The thumbnails size is configurable in the option dialog.
85 .TP 
86 \fB\-t, \-\-dither=on|off\fR
87 Enable dithering. 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. Note that it makes loading a bit slower.
88 .TP 
89 \fB\-u, \-\-history=length\fR
90 Length of history. The maximum number of items in the history. Use 0 to disable the history, and \-1 to make it unlimited.
91 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.
92 .TP 
93 \fB\-W, \-\-resize\-win=on|off\fR
94 No window resizing. By default, in window mode, GLiv resizes the window for each image. You can disable this behaviour with this option.
95 .TP 
96 \fB\-w, \-\-slide\-show=on|off\fR
97 Start the slide show immediately. This way you will not have to start it manually from the menu.
98 .TP 
99 \fB\-z, \-\-zoom\-pointer=on|off\fR
100 Zoom centered on pointer. By default the zoom is centered on the window center, with this option, it is on the mouse pointer.
101 .TP 
102 \fB\-0, \-\-null=on|off\fR
103 Read null\-terminated filenames. 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.
104 .TP 
105 \fB\-1, \-\-one\-image=on|off\fR
106 Keep only one image in memory. 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.
107 .SH "COLLECTIONS"
108 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.
109 .br 
110 GLiv supports also transparent decompression, so the collections can be compressed in bzip2, gzip or compress(1) provided that  you have the corresponding decompressor.
111 .SH "CONTROLS"
113 ESC, q : Quit
115 f      : Full-screen/window
117 +/=/-  : Zoom in/in/out
119 n/p    : Next/previous image
121 l      : Reduce the image to the window
123 M      : Maximize the image to the window
125 m      : Make the image fit the window
127 r      : Reset position and size
129 b      : Toggle display of the menu bar
131 i      : Toggle display of the info bar
133 s      : Toggle display of the scrollbars
135 a      : Toggle display of the alpha checks
137 h      : Toggle display of the help box
139 o      : Display the open dialog
141 t      : Display the options dialog
143 d      : Hide the cursor
145 u      : Undo
147 y      : Redo
149 c      : Clear the history
151 x      : Delete the current file
153 C-up   : Rotate by +45 degrees
155 C-down : Rotate by -45 degrees
157 C-left : Rotate by +0.1 degree
159 C-right: Rotate by -0.1 degree
161 z      : Horizontal flip
163 e      : Vertical flip
166 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.
169 Your mouse wheel (if supported) will zoom the image and switch it when you press the button.
172 You can also zoom by dragging the mouse vertically while holding Shift and the first button.
175 Space and Backspace act like n and p.
178 Draw a rectangle with the third button and gliv will zoom in it.
181 .SH "FILE"
182 \fB~/.glivrc\fR \- This file is absolutely not mandatory.
183 .SH "AUTHOR"
184 Guillaume Chazarain <guichaz@yahoo.fr>
186 See http://gliv.tuxfamily.org.