~ubuntu-branches/ubuntu/intrepid/gwenview/intrepid

« back to all changes in this revision

Viewing changes to doc/gwenview.1

  • Committer: Bazaar Package Importer
  • Author(s): Christopher Martin
  • Date: 2005-04-06 11:33:06 UTC
  • mfrom: (1.2.1 upstream) (2.1.1 warty)
  • Revision ID: james.westby@ubuntu.com-20050406113306-7zovl7z0io5bacpd
Tags: 1.2.0-1
* New upstream release.
  + Fixes crashes when using "Back" to navigate. (Closes: #301811)
* Enable KIPI support.
* Add a doc-base file for the handbook.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.TH "gwenview" "1" "0.11.0" "Michael Spanier" "An Image Viewer for KDE"
2
 
.SH "NAME"
3
 
.LP 
4
 
gwenview \- an imageviewer for KDE 
5
 
.SH "SYNTAX"
6
 
.LP 
7
 
gwenview 
8
 
.br 
9
 
.SH "DESCRIPTION"
10
 
.LP 
11
 
gwenview is an imageviewer for KDE.
12
 
It features a folder tree window and a file list window to provide easy navigation in your file hierarchy.
13
 
.
14
 
Image loading is done by the Qt library, so it supports all image formats your Qt installation supports. Gwenview correctly displays images with alpha channels. 
15
 
 
16
 
It uses docked windows, so you can alter the layout in any way you want. You can also browse your images in full screen. 
17
 
.SH "OPTIONS"
18
 
.LP 
19
 
.TP 
20
 
\fB\-\-help\fR
21
 
Output help information and exit.
22
 
.TP 
23
 
\fB\-\-version\fR
24
 
Output version information and exit.
25
 
.SH "AUTHORS"
26
 
.LP 
27
 
 
28
 
Aurelien Gateau <aurelien.gateau@mail.dotcom.fr>
29
 
 
30
 
This manual page was written by Michael Spanier <mail@michael\-spanier.de> for the Debian GNU/Linux system (but may be used by others).
 
1
.TH GWENVIEW 1 "January 2005" "K Desktop Environment" "Image viewer for KDE"
 
2
.SH NAME
 
3
Gwenview \- An image viewer for KDE
 
4
.SH SYNOPSIS
 
5
.B gwenview
 
6
[\fIoptions\fR] [\fIfile or folder\fR]
 
7
.SH DESCRIPTION
 
8
Gwenview is an image viewer for KDE. It features a folder tree window and a file list window to provide easy navigation of your file hierarchy. Gwenview uses docked windows, so you can alter its layout any way you wish. You can also browse your images in full\-screen mode, or embedded within Konqueror using the Gwenview Image Browser View and Kpart.
 
9
.PP
 
10
Image loading is handled by the Qt library, so Gwenview supports all image formats your Qt installation supports. Gwenview correctly displays images with an alpha channel.
 
11
.PP
 
12
Gwenview supports the displaying and editing of EXIF comments, if the necessary JPEG kfile\-plugin is installed. This comes as part of the kdegraphics package. Lossless JPEG transforms are also supported.
 
13
.SH OPTIONS
 
14
.SS Arguments:
 
15
.TP
 
16
.B file or folder
 
17
An initial image file, or a folder containing images.
 
18
.SS Gwenview options:
 
19
.TP
 
20
.B  \-f
 
21
Start in Full Screen mode.
 
22
.SS Generic options:
 
23
.TP
 
24
.B  \-\-help
 
25
Show help about options.
 
26
.TP
 
27
.B  \-\-help\-qt
 
28
Show Qt specific options.
 
29
.TP
 
30
.B  \-\-help\-kde
 
31
Show KDE specific options.
 
32
.TP
 
33
.B  \-\-help\-all
 
34
Show all options.
 
35
.TP
 
36
.B  \-\-author
 
37
Show author information.
 
38
.TP
 
39
.B \-v\fR, \fB\-\-version
 
40
Show version information.
 
41
.TP
 
42
.B  \-\-license
 
43
Show license information.
 
44
.TP
 
45
.B  \-\-
 
46
End of options.
 
47
.SS Qt options:
 
48
.TP
 
49
.B  \-\-display \fIdisplayname\fR
 
50
Use the X\-server display 'displayname'.
 
51
.TP
 
52
.B  \-\-session \fIsessionId\fR
 
53
Restore the application for the given 'sessionId'.
 
54
.TP
 
55
.B  \-\-cmap
 
56
Causes the application to install a private color
 
57
map on an 8\-bit display.
 
58
.TP
 
59
.B  \-\-ncols \fIcount\fR
 
60
Limits the number of colors allocated in the color
 
61
cube on an 8\-bit display, if the application is
 
62
using the QApplication::ManyColor color
 
63
specification.
 
64
.TP
 
65
.B  \-\-nograb
 
66
Tells Qt to never grab the mouse or the keyboard.
 
67
.TP
 
68
.B  \-\-dograb
 
69
Running under a debugger can cause an implicit
 
70
\-nograb, use \-dograb to override.
 
71
.TP
 
72
.B  \-\-sync
 
73
Switches to synchronous mode for debugging.
 
74
.TP
 
75
.B \-\-fn\fR, \fB\-\-font \fIfontname\fR
 
76
Defines the application font.
 
77
.TP
 
78
.B \-\-bg\fR, \fB\-\-background \fIcolor\fR
 
79
Sets the default background color and an
 
80
application palette (light and dark shades are
 
81
calculated).
 
82
.TP
 
83
.B \-\-fg\fR, \fB\-\-foreground \fIcolor\fR
 
84
Sets the default foreground color.
 
85
.TP
 
86
.B \-\-btn\fR, \fB\-\-button \fIcolor\fR
 
87
Sets the default button color.
 
88
.TP
 
89
.B  \-\-name \fIname\fR
 
90
Sets the application name.
 
91
.TP
 
92
.B  \-\-title \fItitle\fR
 
93
Sets the application title (caption).
 
94
.TP
 
95
.B  \-\-visual TrueColor
 
96
Forces the application to use a TrueColor visual on
 
97
an 8\-bit display.
 
98
.TP
 
99
.B  \-\-inputstyle \fIinputstyle\fR
 
100
Sets XIM (X Input Method) input style. Possible
 
101
values are onthespot, overthespot, offthespot and
 
102
root.
 
103
.TP
 
104
.B  \-\-im \fIXIM server\fR
 
105
Set XIM server.
 
106
.TP
 
107
.B  \-\-noxim
 
108
Disable XIM.
 
109
.TP
 
110
.B  \-\-reverse
 
111
Mirrors the whole layout of widgets.
 
112
.SS KDE options:
 
113
.TP
 
114
.B  \-\-caption \fIcaption\fR
 
115
Use 'caption' as name in the titlebar.
 
116
.TP
 
117
.B  \-\-icon \fIicon\fR
 
118
Use 'icon' as the application icon.
 
119
.TP
 
120
.B  \-\-miniicon \fIicon\fR
 
121
Use 'icon' as the icon in the titlebar.
 
122
.TP
 
123
.B  \-\-config \fIfilename\fR
 
124
Use alternative configuration file.
 
125
.TP
 
126
.B  \-\-dcopserver \fIserver\fR
 
127
Use the DCOP Server specified by 'server'.
 
128
.TP
 
129
.B  \-\-nocrashhandler
 
130
Disable crash handler, to get core dumps.
 
131
.TP
 
132
.B  \-\-waitforwm
 
133
Waits for a WM_NET compatible windowmanager.
 
134
.TP
 
135
.B  \-\-style \fIstyle\fR
 
136
Sets the application GUI style.
 
137
.TP
 
138
.B  \-\-geometry \fIgeometry\fR
 
139
Sets the client geometry of the main widget.
 
140
.SH INTERFACE
 
141
.SS Browse and View modes
 
142
By default, Gwenview opens in Browse mode, with the docked windows (showing
 
143
directory structure and contents) displayed. Starting Gwenview with a directory
 
144
as an argument also begins in Browse mode. Starting with an image as an argument,
 
145
however, opens Gwenview in View mode, with these docked windows hidden to give
 
146
full space to the image itself.
 
147
.PP
 
148
Once Gwenview is started, the user can toggle between Browse and View modes by
 
149
clicking the Browse button on the Main Toolbar. The same option can be found
 
150
in the View menu. Ctrl-Return will toggle these modes as well.
 
151
.PP
 
152
Whereas normally, in Browse mode, single-clicking on an image thumbnail or
 
153
listing is sufficient for Gwenview to display it, users also have the option of
 
154
double-clicking, which displays the image and switches Gwenview to View mode.
 
155
.SS Docked windows
 
156
The Gwenview interface is composed of a number of smaller docked windows.
 
157
Manipulating these windows can be difficult at first. To focus a particular
 
158
window in the Gwenview interface, simply click within it.
 
159
.PP
 
160
Each docked window has a small grip bar along the top, with a dock/undock button
 
161
resembling an arrow at its right end, as well as a close button resembling the
 
162
letter X.
 
163
.PP
 
164
Clicking the close button on a docked window will remove it from the interface.
 
165
To bring back a window, select it from the Window menu.
 
166
.PP
 
167
To resize docked windows, click on the border between the windows, and drag.
 
168
To re-arrange the docked windows, click on a window's grip bar along its top, and drag
 
169
the window over to the desired position relative to the other docked windows.
 
170
While dragging, a small box outline should appear that indicates the new position
 
171
that the window will take, when you release the mouse and end the drag. If you wish
 
172
to stack two windows, and use tabs to choose between them, drag the window to the
 
173
very center of the other window with which you wish to stack.
 
174
.PP
 
175
To undock a window, either click the dock/undock button in its top right corner, or
 
176
double-click on the window's grip bar. Double-clicking again, or clicking
 
177
on the dock/undock button, should return the window to its original position.
 
178
Otherwise, you can dock an undocked window by dragging its grip bar back to a
 
179
point within the general interface, just as if you were rearranging an already
 
180
docked window.
 
181
.PP
 
182
The file view window cannot be undocked or moved, but by moving other windows
 
183
around, it can itself be shifted about. 
 
184
.PP
 
185
While dragging a window, press the Escape key to cancel the operation. To reset
 
186
the docked windows to the default Gwenview layout, use the Reset option in the
 
187
Window menu.
 
188
.SS Mouse operations
 
189
Browsing a directory of images can be done several ways, including mouse
 
190
gestures. Hold down the left mouse button over an image, then click the right
 
191
button to go to the next image. Hold down the right button, then click the
 
192
left button to load the previous image.
 
193
.PP
 
194
Clicking the right mouse button on an image brings up a context menu.
 
195
.PP
 
196
Clicking the middle mouse button will toggle the auto zoom on/off.
 
197
.PP
 
198
Double-clicking on an image toggles Full Screen mode.
 
199
.PP
 
200
Holding down the left mouse button on an image allows you to
 
201
scroll the image. By default, you can also scroll up and down an image by
 
202
using the mouse wheel. However, this can be configured to browse the images
 
203
in the current directory instead.
 
204
.PP
 
205
The mouse wheel, used while holding down the Shift key, will zoom the image
 
206
in and out.
 
207
.PP
 
208
The mouse wheel, used while holding down the Control or Alt keys, will scroll the image horizontally.
 
209
.SS Keybindings
 
210
Gwenview comes with a range of keyboard shortcuts, all of which can be viewed and remapped by
 
211
selecting "Configure Shortcuts" in the Settings menu. Note that in the Files and Folders windows,
 
212
all the normal KDE shortcuts are functional, unless otherwise remapped.
 
213
.PP
 
214
A few of the most useful default bindings are:
 
215
.PP
 
216
  Ctrl-Shift-F    Toggles Full Screen mode.
 
217
  Escape          Stop, exit from Full Screen mode.
 
218
 
 
219
  Home            Displays the first image in the directory.
 
220
  End             Displays the last image in the directory.
 
221
 
 
222
  Space           Displays the next image in the directory.
 
223
  Backspace       Displays the previous image in the directory.
 
224
.SH "SEE ALSO"
 
225
The Gwenview homepage can be found at \fIhttp://gwenview.sourceforge.net\fR.
 
226
.PP
 
227
A mailing list is also available at \fIhttp://lists.sourceforge.net/lists/listinfo/gwenview-general\fR.
 
228
.SH BUGS
 
229
To report a bug, please visit \fIhttp://bugs.kde.org\fR.
 
230
.SH AUTHOR
 
231
Gwenview was written by Aurelien Gateau <aurelien.gateau@free.fr>.
 
232
.PP
 
233
This manual page was written by Christopher Martin <chrsmrtn@freeshell.org> for Debian GNU/Linux, but may be used by others.