Rename the hash table to thumbs_hash_table.

[gliv.git] / gliv.1

.TH "gliv" "1" "1.8" "Guillaume Chazarain" "Image viewer"
.SH "NAME"
gliv \- An OpenGL Image Viewer
.SH "SYNOPSIS"
\fBgliv\fR [OPTIONS]... [FILES]...
.SH "DESCRIPTION"
\fIgliv\fR uses gdk\-pixbuf to load images and OpenGL to render them.
It allows to do some moving, rotating, zooming and slide show.
.SH "OPTIONS"
The options are first set to their default value, then read from ~/.glivrc and finally read from the command line.
.br 
To disable an option activated by default just specify it, in order to toggle its value.

.TP 
\fB\-h, \-\-help\fR
Print help and exit.
.TP 
\fB\-V, \-\-version\fR
Print version and exit.
.TP 
\fB\-s, \-\-shuffle\fR
Show images in random order. The images list will be shuffled before the slide show.
.TP 
\fB\-S, \-\-sort\fR
Show images in sorted order. The images list will be sorted before the slide show.
.TP 
\fB\-R, \-\-recursive\fR
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.
.TP 
\fB\-f, \-\-fullscreen\fR
Start in full screen mode (default=off). You can still go back to windowed mode by pressing 'f' or using the menu.
.TP 
\fB\-l, \-\-scale\-down\fR
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.
.TP 
\fB\-M, \-\-maximize\fR
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.
.TP 
\fB\-m, \-\-make\-fit\fR
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.
.TP 
\fB\-z, \-\-zoom\-pointer\fR
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.
.TP 
\fB\-t, \-\-dither\fR
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.
.br 
Note that it makes loading a bit slower.
.TP 
\fB\-F, \-\-force\-load\fR
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.
.TP 
\fB\-p, \-\-mipmap\fR
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.
.TP 
\fB\-n, \-\-mnemonics\fR
Make mnemonics for images menus (default=off). When this option is disabled the images menus are built much more quickly.
.TP 
\fB\-w, \-\-slide\-show\fR
Start the slide show immediately (default=off). This way you will not have to start the slide show from the menu.
.TP 
\fB\-L, \-\-loop\fR
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.
.TP 
\fB\-1, \-\-one\-image\fR
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.
.TP 
\fB\-e, \-\-build\-menus\fR
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.
.TP 
\fB\-b, \-\-menu\fR
Display the menu bar (default=on). Use it to display the currently minimal menubar, you can also use the 'b' key.
.TP 
\fB\-i, \-\-info\fR
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'.
.TP 
\fB\-o, \-\-scrollbars\fR
Display scrollbars (default=on). Enable or disable the scrollbars on the borders.
.TP 
\fB\-g, \-\-glivrc\fR
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.
.TP 
\fB\-c, \-\-alpha\-checks\fR
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.
.TP 
\fB\-T, \-\-thumbnails\fR
Show thumbnails in images menus (default=on). The thumbnails size is configurable in the option dialog.
.TP 
\fB\-W, \-\-resize\-win\fR
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.
.TP 
\fB\-dINT, \-\-delay=INT\fR
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.
.TP 
\fB\-uINT, \-\-history=INT\fR
Length of history. The maximum number of items in the history. Use 0 to disable the history, and \-1 to make it unlimited.
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.
.TP 
\fB\-aINT, \-\-duration=INT\fR
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.
.TP 
\fB\-PINT, \-\-fps=INT\fR
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.
.SH "COLLECTIONS"
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.
.br 
GLiv supports also transparent decompression, so the collections can be compressed in bzip2, gzip or compress(1) provided that  you have the corresponding decompressor.
.SH "CONTROLS"

ESC, q : Quit
.br
f      : Full-screen/window
.br
+/=/-  : Zoom in/in/out
.br
n/p    : Next/previous image
.br
l      : Reduce the image to the window
.br
M      : Maximize the image to the window
.br
m      : Make the image fit the window
.br
r      : Reset position and size
.br
b      : Toggle display of the menu bar
.br
i      : Toggle display of the info bar
.br
s      : Toggle display of the scrollbars
.br
a      : Toggle display of the alpha checks
.br
h      : Toggle display of the help box
.br
o      : Display the open dialog
.br
t      : Display the options dialog
.br
d      : Hide the cursor
.br
u      : Undo
.br
y      : Redo
.br
c      : Clear the history
.br
x      : Delete the current file
.br
C-up   : Rotate by +45 degrees
.br
C-down : Rotate by -45 degrees
.br
C-left : Rotate by +0.1 degree
.br
C-right: Rotate by -0.1 degree
.br
z      : Horizontal flip
.br
e      : Vertical flip
.br

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.
.br

Your mouse wheel (if supported) will zoom the image and switch it when you press the button.
.br

You can also zoom by dragging the mouse vertically while holding Shift and the first button.
.br

Space and Backspace act like n and p.
.br

Draw a rectangle with the third button and gliv will zoom in it.
.br

.SH "FILE"
\fB~/.glivrc\fR \- This file is absolutely not mandatory.
.SH "AUTHOR"
Guillaume Chazarain <guichaz@yahoo.fr>
.br
See http://gliv.tuxfamily.org.