From 2f5a9e8ee0c89e93d43f97f97744313ff9e8236a Mon Sep 17 00:00:00 2001 From: Michele Calgaro Date: Fri, 23 Feb 2024 21:15:44 +0900 Subject: Restructure doc/man folders Signed-off-by: Michele Calgaro --- doc/Makefile.am | 3 +- doc/browse_mode.png | Bin 136143 -> 0 bytes doc/dock_grip.png | Bin 566 -> 0 bytes doc/docked_windows.docbook | 69 ------------ doc/en/Makefile.am | 2 + doc/en/browse_mode.png | Bin 0 -> 136143 bytes doc/en/dock_grip.png | Bin 0 -> 566 bytes doc/en/docked_windows.docbook | 69 ++++++++++++ doc/en/external_tools.docbook | 68 +++++++++++ doc/en/external_tools_dialog.png | Bin 0 -> 14063 bytes doc/en/index.docbook | 63 +++++++++++ doc/en/interface.docbook | 49 ++++++++ doc/en/introduction.docbook | 26 +++++ doc/en/keybindings.docbook | 20 ++++ doc/en/mouse.docbook | 40 +++++++ doc/en/view_mode.png | Bin 0 -> 38389 bytes doc/external_tools.docbook | 68 ----------- doc/external_tools_dialog.png | Bin 14063 -> 0 bytes doc/index.docbook | 63 ----------- doc/interface.docbook | 49 -------- doc/introduction.docbook | 26 ----- doc/keybindings.docbook | 20 ---- doc/man/Makefile.am | 1 + doc/man/gwenview.1 | 238 +++++++++++++++++++++++++++++++++++++++ doc/mouse.docbook | 40 ------- doc/view_mode.png | Bin 38389 -> 0 bytes src/Makefile.am | 2 +- src/doc/Makefile.am | 1 - src/doc/gwenview.1 | 238 --------------------------------------- 29 files changed, 578 insertions(+), 577 deletions(-) delete mode 100644 doc/browse_mode.png delete mode 100644 doc/dock_grip.png delete mode 100644 doc/docked_windows.docbook create mode 100644 doc/en/Makefile.am create mode 100644 doc/en/browse_mode.png create mode 100644 doc/en/dock_grip.png create mode 100644 doc/en/docked_windows.docbook create mode 100644 doc/en/external_tools.docbook create mode 100644 doc/en/external_tools_dialog.png create mode 100644 doc/en/index.docbook create mode 100644 doc/en/interface.docbook create mode 100644 doc/en/introduction.docbook create mode 100644 doc/en/keybindings.docbook create mode 100644 doc/en/mouse.docbook create mode 100644 doc/en/view_mode.png delete mode 100644 doc/external_tools.docbook delete mode 100644 doc/external_tools_dialog.png delete mode 100644 doc/index.docbook delete mode 100644 doc/interface.docbook delete mode 100644 doc/introduction.docbook delete mode 100644 doc/keybindings.docbook create mode 100644 doc/man/Makefile.am create mode 100644 doc/man/gwenview.1 delete mode 100644 doc/mouse.docbook delete mode 100644 doc/view_mode.png delete mode 100644 src/doc/Makefile.am delete mode 100644 src/doc/gwenview.1 diff --git a/doc/Makefile.am b/doc/Makefile.am index 26d239d..8bd0272 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,2 +1 @@ -KDE_LANG = en -KDE_DOCS = gwenview +SUBDIRS = en man diff --git a/doc/browse_mode.png b/doc/browse_mode.png deleted file mode 100644 index 9020b24..0000000 Binary files a/doc/browse_mode.png and /dev/null differ diff --git a/doc/dock_grip.png b/doc/dock_grip.png deleted file mode 100644 index 04c090d..0000000 Binary files a/doc/dock_grip.png and /dev/null differ diff --git a/doc/docked_windows.docbook b/doc/docked_windows.docbook deleted file mode 100644 index 8363310..0000000 --- a/doc/docked_windows.docbook +++ /dev/null @@ -1,69 +0,0 @@ -Docked windows -The &kappname; interface is composed of a number of smaller docked windows. -Manipulating these windows can be difficult at first. To focus a particular -window in the &kappname; interface, simply click within it. - -Each docked window has a small grip bar along the top. It contains a dock/undock button -resembling an arrow at its right end and a close button resembling the -letter X. It looks like this: - - - Grip bar of a docked window - - - - - - Grip bar of a docked window - - - - - - - Clicking the close button on a docked window will remove it from the interface. -To bring it back, select its name in the Window -menu. - - - To resize docked windows, drag the border between the - windows. - - - - To re-arrange the docked windows, drag a window by its grip bar - over to the desired position. While dragging, a small box - outline will appear to indicate the position the window - will take when you end the drag. - - If you wish to stack two windows and use tabs to choose between them, - drag the window to the very center of the other window with which you wish - to stack. - - - - To undock a window, either click the dock/undock button in its top right corner, or - double-click on the window's grip bar. - Double-clicking again or clicking on the dock/undock button, should return the window to its original - position. - You can also dock an undocked window by dragging its grip bar back to a -point within the general interface, just as if you were rearranging an already -docked window. - - - - The file view window cannot be undocked or moved, but by moving other windows - around, it can itself be shifted about. - - - - While dragging a window, press the Escape key to cancel the operation. To reset - the docked windows to the default &kappname; layout, use - - Window - Reset - . - - - - diff --git a/doc/en/Makefile.am b/doc/en/Makefile.am new file mode 100644 index 0000000..26d239d --- /dev/null +++ b/doc/en/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG = en +KDE_DOCS = gwenview diff --git a/doc/en/browse_mode.png b/doc/en/browse_mode.png new file mode 100644 index 0000000..9020b24 Binary files /dev/null and b/doc/en/browse_mode.png differ diff --git a/doc/en/dock_grip.png b/doc/en/dock_grip.png new file mode 100644 index 0000000..04c090d Binary files /dev/null and b/doc/en/dock_grip.png differ diff --git a/doc/en/docked_windows.docbook b/doc/en/docked_windows.docbook new file mode 100644 index 0000000..8363310 --- /dev/null +++ b/doc/en/docked_windows.docbook @@ -0,0 +1,69 @@ +Docked windows +The &kappname; interface is composed of a number of smaller docked windows. +Manipulating these windows can be difficult at first. To focus a particular +window in the &kappname; interface, simply click within it. + +Each docked window has a small grip bar along the top. It contains a dock/undock button +resembling an arrow at its right end and a close button resembling the +letter X. It looks like this: + + + Grip bar of a docked window + + + + + + Grip bar of a docked window + + + + + + + Clicking the close button on a docked window will remove it from the interface. +To bring it back, select its name in the Window +menu. + + + To resize docked windows, drag the border between the + windows. + + + + To re-arrange the docked windows, drag a window by its grip bar + over to the desired position. While dragging, a small box + outline will appear to indicate the position the window + will take when you end the drag. + + If you wish to stack two windows and use tabs to choose between them, + drag the window to the very center of the other window with which you wish + to stack. + + + + To undock a window, either click the dock/undock button in its top right corner, or + double-click on the window's grip bar. + Double-clicking again or clicking on the dock/undock button, should return the window to its original + position. + You can also dock an undocked window by dragging its grip bar back to a +point within the general interface, just as if you were rearranging an already +docked window. + + + + The file view window cannot be undocked or moved, but by moving other windows + around, it can itself be shifted about. + + + + While dragging a window, press the Escape key to cancel the operation. To reset + the docked windows to the default &kappname; layout, use + + Window + Reset + . + + + + diff --git a/doc/en/external_tools.docbook b/doc/en/external_tools.docbook new file mode 100644 index 0000000..61722cc --- /dev/null +++ b/doc/en/external_tools.docbook @@ -0,0 +1,68 @@ + +External tools + +You can easily extend &kappname; by defining external tools. These tools + are accessible from the contextual popup menu which appears when + right-clicking on a thumbnail or in the image view. Look in the + External Tools entry. + +&kappname; comes with a few predefined external tools, but it's very + easy to add more through the Configure External Tools dialog. You can open + it from SettingsConfigure + External Tools.... + + +Here is how it looks: + + + External tools dialog + + + + + + + + +In this example, I defined an external tool which will call Exiftran to + regenerate the EXIF tags for JPEG images. Here is a more detailed description + of its definition: + + + + The Name: field contains the description of your + tool, has it will appear in the menu. + + + + The Command: field contains the command which + will be run when this tool is invoked. + Click on the little question mark on the right of the field to get a list + of the keywords you can use in this field. These keywords will get + expanded to the image files. + + + + + The button on the right lets you associate an icon with your tool. + + + + + The File Associations group indicates what type of + files this tool can work with. Your tool will only appear in the + External Tools menu if the + selected files are of the correct type. In my example, this tool is only + valid with JPEG images, so I choose Custom:, then + image/jpeg and image/pjpeg. + + + + + + You can find other external tool examples from + &kappname; web site. + + + + diff --git a/doc/en/external_tools_dialog.png b/doc/en/external_tools_dialog.png new file mode 100644 index 0000000..72e6723 Binary files /dev/null and b/doc/en/external_tools_dialog.png differ diff --git a/doc/en/index.docbook b/doc/en/index.docbook new file mode 100644 index 0000000..bbeeb09 --- /dev/null +++ b/doc/en/index.docbook @@ -0,0 +1,63 @@ + + + + + + + + + + + +]> + + +Gwenview User Manual + + + + +Aurélien +Gâteau +
aurelien.gateau@free.fr
 + + +ChristopherMartin +
chrsmrtn@debian.org
 + + + + +2005 +Aurélien Gâteau + + + +2005-08-21 +1.2.92 + +&kappname; is an image viewer for TDE. + + +KDE +image +viewer +artist +photo +picture + + +&introduction; +&interface; + +&external_tools; + + +Tips +&mouse; +&keybindings; +&docked_windows; + + + diff --git a/doc/en/interface.docbook b/doc/en/interface.docbook new file mode 100644 index 0000000..3ac0780 --- /dev/null +++ b/doc/en/interface.docbook @@ -0,0 +1,49 @@ + +The interface + +Browse and View modes + +By default, &kappname; opens in Browse mode. + +In this mode you can easily navigate through your files and folders. As + you can see on the screenshot, the preview window shows the current image as + well as any embedded image comment. + + + Browse Mode Screenshot + + + + + + + + +From the Browse mode, + unchecking + + + &Ctrl;Return + + View + Browse + + will put you in View mode, where the image takes all the + space of the window. + + + View Mode Screenshot + + + + + + + +You can start directly in View mode by starting &kappname; with an image + as an argument. + + + + + diff --git a/doc/en/introduction.docbook b/doc/en/introduction.docbook new file mode 100644 index 0000000..1501dc0 --- /dev/null +++ b/doc/en/introduction.docbook @@ -0,0 +1,26 @@ + +Introduction + + +What is &kappname; + + +&kappname; is a fast and easy to use image viewer for TDE. + + + +It features a folder tree window and a file list window to provide easy +navigation of your file hierarchy. &kappname; 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 Image View and Kpart. + +Image loading is handled by the TQt library, so &kappname; supports all +image formats your TQt installation supports. &kappname; correctly displays images +with an alpha channel as well as animations. + +&kappname; supports the displaying and editing of EXIF comments in JPEG +images. Lossless JPEG transforms such as rotations and mirroring are also supported. + + + + diff --git a/doc/en/keybindings.docbook b/doc/en/keybindings.docbook new file mode 100644 index 0000000..3156400 --- /dev/null +++ b/doc/en/keybindings.docbook @@ -0,0 +1,20 @@ + +Key bindings + +&kappname; comes with a range of keyboard shortcuts, all of which can be viewed and remapped by + selecting SettingsConfigure + Shortcuts.... Note that in the Files and Folders windows, +all the normal TDE shortcuts are functional, unless otherwise remapped. + +A few of the most useful default bindings are: + + + Space: Displays the next image in the directory. + Backspace: Displays the previous image in the directory. + &Ctrl;Return: Toggles between Browse and View modes. + &Ctrl; + &Shift;F: Activates Full Screen mode. + Escape: Exits from Full Screen mode. + + diff --git a/doc/en/mouse.docbook b/doc/en/mouse.docbook new file mode 100644 index 0000000..0792b3a --- /dev/null +++ b/doc/en/mouse.docbook @@ -0,0 +1,40 @@ +Using the mouse + +Panning with the mouse + + Holding down the left mouse button on an image allows you to + scroll the image. + The mouse wheel will scroll the image up and + down. + + + + +Zooming with the mouse + + Clicking the middle mouse button will toggle the auto zoom + on/off. + Hold down the Control key, then either use the mouse wheel to + zoom in and out or left click to zoom in and right click to zoom + out. + + The mouse wheel, used while holding down the Alt key, will + scroll the image horizontally. + + + + +Browsing with the mouse + + Double-clicking on an image toggles Browse + mode. + By default, the mouse wheel will scroll the image up and down. But, + this can be configured to browse the images in the current directory + instead. + Hold down the left mouse button over an image, then click the right + button to go to the next image. + Hold down the right button, then click the + left button to load the previous image. + + + diff --git a/doc/en/view_mode.png b/doc/en/view_mode.png new file mode 100644 index 0000000..801ad23 Binary files /dev/null and b/doc/en/view_mode.png differ diff --git a/doc/external_tools.docbook b/doc/external_tools.docbook deleted file mode 100644 index 61722cc..0000000 --- a/doc/external_tools.docbook +++ /dev/null @@ -1,68 +0,0 @@ - -External tools - -You can easily extend &kappname; by defining external tools. These tools - are accessible from the contextual popup menu which appears when - right-clicking on a thumbnail or in the image view. Look in the - External Tools entry. - -&kappname; comes with a few predefined external tools, but it's very - easy to add more through the Configure External Tools dialog. You can open - it from SettingsConfigure - External Tools.... - - -Here is how it looks: - - - External tools dialog - - - - - - - - -In this example, I defined an external tool which will call Exiftran to - regenerate the EXIF tags for JPEG images. Here is a more detailed description - of its definition: - - - - The Name: field contains the description of your - tool, has it will appear in the menu. - - - - The Command: field contains the command which - will be run when this tool is invoked. - Click on the little question mark on the right of the field to get a list - of the keywords you can use in this field. These keywords will get - expanded to the image files. - - - - - The button on the right lets you associate an icon with your tool. - - - - - The File Associations group indicates what type of - files this tool can work with. Your tool will only appear in the - External Tools menu if the - selected files are of the correct type. In my example, this tool is only - valid with JPEG images, so I choose Custom:, then - image/jpeg and image/pjpeg. - - - - - - You can find other external tool examples from - &kappname; web site. - - - - diff --git a/doc/external_tools_dialog.png b/doc/external_tools_dialog.png deleted file mode 100644 index 72e6723..0000000 Binary files a/doc/external_tools_dialog.png and /dev/null differ diff --git a/doc/index.docbook b/doc/index.docbook deleted file mode 100644 index bbeeb09..0000000 --- a/doc/index.docbook +++ /dev/null @@ -1,63 +0,0 @@ - - - - - - - - - - - -]> - - -Gwenview User Manual - - - - -Aurélien -Gâteau -
aurelien.gateau@free.fr
 - - -ChristopherMartin -
chrsmrtn@debian.org
 - - - - -2005 -Aurélien Gâteau - - - -2005-08-21 -1.2.92 - -&kappname; is an image viewer for TDE. - - -KDE -image -viewer -artist -photo -picture - - -&introduction; -&interface; - -&external_tools; - - -Tips -&mouse; -&keybindings; -&docked_windows; - - - diff --git a/doc/interface.docbook b/doc/interface.docbook deleted file mode 100644 index 3ac0780..0000000 --- a/doc/interface.docbook +++ /dev/null @@ -1,49 +0,0 @@ - -The interface - -Browse and View modes - -By default, &kappname; opens in Browse mode. - -In this mode you can easily navigate through your files and folders. As - you can see on the screenshot, the preview window shows the current image as - well as any embedded image comment. - - - Browse Mode Screenshot - - - - - - - - -From the Browse mode, - unchecking - - - &Ctrl;Return - - View - Browse - - will put you in View mode, where the image takes all the - space of the window. - - - View Mode Screenshot - - - - - - - -You can start directly in View mode by starting &kappname; with an image - as an argument. - - - - - diff --git a/doc/introduction.docbook b/doc/introduction.docbook deleted file mode 100644 index 1501dc0..0000000 --- a/doc/introduction.docbook +++ /dev/null @@ -1,26 +0,0 @@ - -Introduction - - -What is &kappname; - - -&kappname; is a fast and easy to use image viewer for TDE. - - - -It features a folder tree window and a file list window to provide easy -navigation of your file hierarchy. &kappname; 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 Image View and Kpart. - -Image loading is handled by the TQt library, so &kappname; supports all -image formats your TQt installation supports. &kappname; correctly displays images -with an alpha channel as well as animations. - -&kappname; supports the displaying and editing of EXIF comments in JPEG -images. Lossless JPEG transforms such as rotations and mirroring are also supported. - - - - diff --git a/doc/keybindings.docbook b/doc/keybindings.docbook deleted file mode 100644 index 3156400..0000000 --- a/doc/keybindings.docbook +++ /dev/null @@ -1,20 +0,0 @@ - -Key bindings - -&kappname; comes with a range of keyboard shortcuts, all of which can be viewed and remapped by - selecting SettingsConfigure - Shortcuts.... Note that in the Files and Folders windows, -all the normal TDE shortcuts are functional, unless otherwise remapped. - -A few of the most useful default bindings are: - - - Space: Displays the next image in the directory. - Backspace: Displays the previous image in the directory. - &Ctrl;Return: Toggles between Browse and View modes. - &Ctrl; - &Shift;F: Activates Full Screen mode. - Escape: Exits from Full Screen mode. - - diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am new file mode 100644 index 0000000..a34ff18 --- /dev/null +++ b/doc/man/Makefile.am @@ -0,0 +1 @@ +man_MANS = gwenview.1 diff --git a/doc/man/gwenview.1 b/doc/man/gwenview.1 new file mode 100644 index 0000000..d1d9de2 --- /dev/null +++ b/doc/man/gwenview.1 @@ -0,0 +1,238 @@ +.TH GWENVIEW 1 "January 2005" "Trinity Desktop Environment" "Image viewer for TDE" +.SH NAME +Gwenview \- An image viewer for TDE +.SH SYNOPSIS +.B gwenview +[\fIoptions\fR] [\fIfile or folder\fR] +.SH DESCRIPTION +Gwenview is an image viewer for TDE. 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. +.PP +Image loading is handled by the TQt library, so Gwenview supports all image formats your TQt installation supports. Gwenview correctly displays images with an alpha channel. +.PP +Gwenview supports the displaying and editing of EXIF comments, if the necessary JPEG tdefile\-plugin is installed. This comes as part of the tdegraphics package. Lossless JPEG transforms are also supported. +.SH OPTIONS +.SS Arguments: +.TP +.B file or folder +An initial image file, or a folder containing images. +.SS Gwenview options: +.TP +.B \-f +Start in Full Screen mode. +.SS Generic options: +.TP +.B \-\-help +Show help about options. +.TP +.B \-\-help\-tqt +Show TQt specific options. +.TP +.B \-\-help\-kde +Show KDE specific options. +.TP +.B \-\-help\-all +Show all options. +.TP +.B \-\-author +Show author information. +.TP +.B \-v\fR, \fB\-\-version +Show version information. +.TP +.B \-\-license +Show license information. +.TP +.B \-\- +End of options. +.SS TQt options: +.TP +.B \-\-display \fIdisplayname\fR +Use the X\-server display 'displayname'. +.TP +.B \-\-session \fIsessionId\fR +Restore the application for the given 'sessionId'. +.TP +.B \-\-cmap +Causes the application to install a private color +map on an 8\-bit display. +.TP +.B \-\-ncols \fIcount\fR +Limits the number of colors allocated in the color +cube on an 8\-bit display, if the application is +using the QApplication::ManyColor color +specification. +.TP +.B \-\-nograb +Tells TQt to never grab the mouse or the keyboard. +.TP +.B \-\-dograb +Running under a debugger can cause an implicit +\-nograb, use \-dograb to override. +.TP +.B \-\-sync +Switches to synchronous mode for debugging. +.TP +.B \-\-fn\fR, \fB\-\-font \fIfontname\fR +Defines the application font. +.TP +.B \-\-bg\fR, \fB\-\-background \fIcolor\fR +Sets the default background color and an +application palette (light and dark shades are +calculated). +.TP +.B \-\-fg\fR, \fB\-\-foreground \fIcolor\fR +Sets the default foreground color. +.TP +.B \-\-btn\fR, \fB\-\-button \fIcolor\fR +Sets the default button color. +.TP +.B \-\-name \fIname\fR +Sets the application name. +.TP +.B \-\-title \fItitle\fR +Sets the application title (caption). +.TP +.B \-\-visual TrueColor +Forces the application to use a TrueColor visual on +an 8\-bit display. +.TP +.B \-\-inputstyle \fIinputstyle\fR +Sets XIM (X Input Method) input style. Possible +values are onthespot, overthespot, offthespot and +root. +.TP +.B \-\-im \fIXIM server\fR +Set XIM server. +.TP +.B \-\-noxim +Disable XIM. +.TP +.B \-\-reverse +Mirrors the whole layout of widgets. +.SS KDE options: +.TP +.B \-\-caption \fIcaption\fR +Use 'caption' as name in the titlebar. +.TP +.B \-\-icon \fIicon\fR +Use 'icon' as the application icon. +.TP +.B \-\-miniicon \fIicon\fR +Use 'icon' as the icon in the titlebar. +.TP +.B \-\-config \fIfilename\fR +Use alternative configuration file. +.TP +.B \-\-dcopserver \fIserver\fR +Use the DCOP Server specified by 'server'. +.TP +.B \-\-nocrashhandler +Disable crash handler, to get core dumps. +.TP +.B \-\-waitforwm +Waits for a WM_NET compatible windowmanager. +.TP +.B \-\-style \fIstyle\fR +Sets the application GUI style. +.TP +.B \-\-geometry \fIgeometry\fR +Sets the client geometry of the main widget. +.SH INTERFACE +.SS Browse and View modes +By default, Gwenview opens in Browse mode, with the docked windows (showing +directory structure and contents) displayed. Starting Gwenview with a directory +as an argument also begins in Browse mode. Starting with an image as an argument, +however, opens Gwenview in View mode, with these docked windows hidden to give +full space to the image itself. +.PP +Once Gwenview is started, the user can toggle between Browse and View modes by +clicking the Browse button on the Main Toolbar. The same option can be found +in the View menu. Ctrl-Return will toggle these modes as well. +.PP +Whereas normally, in Browse mode, single-clicking on an image thumbnail or +listing is sufficient for Gwenview to display it, users also have the option of +double-clicking, which displays the image and switches Gwenview to View mode. +.SS Docked windows +The Gwenview interface is composed of a number of smaller docked windows. +Manipulating these windows can be difficult at first. To focus a particular +window in the Gwenview interface, simply click within it. +.PP +Each docked window has a small grip bar along the top, with a dock/undock button +resembling an arrow at its right end, as well as a close button resembling the +letter X. +.PP +Clicking the close button on a docked window will remove it from the interface. +To bring back a window, select it from the Window menu. +.PP +To resize docked windows, click on the border between the windows, and drag. +To re-arrange the docked windows, click on a window's grip bar along its top, and drag +the window over to the desired position relative to the other docked windows. +While dragging, a small box outline should appear that indicates the new position +that the window will take, when you release the mouse and end the drag. If you wish +to stack two windows, and use tabs to choose between them, drag the window to the +very center of the other window with which you wish to stack. +.PP +To undock a window, either click the dock/undock button in its top right corner, or +double-click on the window's grip bar. Double-clicking again, or clicking +on the dock/undock button, should return the window to its original position. +Otherwise, you can dock an undocked window by dragging its grip bar back to a +point within the general interface, just as if you were rearranging an already +docked window. +.PP +The file view window cannot be undocked or moved, but by moving other windows +around, it can itself be shifted about. +.PP +While dragging a window, press the Escape key to cancel the operation. To reset +the docked windows to the default Gwenview layout, use the Reset option in the +Window menu. +.SS Mouse operations +Browsing a directory of images can be done several ways, including mouse +gestures. Hold down the left mouse button over an image, then click the right +button to go to the next image. Hold down the right button, then click the +left button to load the previous image. +.PP +Clicking the right mouse button on an image brings up a context menu. +.PP +Clicking the middle mouse button will toggle the auto zoom on/off. +.PP +Double-clicking on an image toggles Full Screen mode. +.PP +Holding down the left mouse button on an image allows you to +scroll the image. By default, you can also scroll up and down an image by +using the mouse wheel. However, this can be configured to browse the images +in the current directory instead. +.PP +The mouse wheel, used while holding down the Shift key, will zoom the image +in and out. +.PP +The mouse wheel, used while holding down the Control or Alt keys, will scroll the image horizontally. +.SS Keybindings +Gwenview comes with a range of keyboard shortcuts, all of which can be viewed and remapped by +selecting "Configure Shortcuts" in the Settings menu. Note that in the Files and Folders windows, +all the normal KDE shortcuts are functional, unless otherwise remapped. +.PP +A few of the most useful default bindings are: +.PP + Ctrl-Shift-F Toggles Full Screen mode. + Escape Stop, exit from Full Screen mode. + + Home Displays the first image in the directory. + End Displays the last image in the directory. + + Space Displays the next image in the directory. + Backspace Displays the previous image in the directory. +.SH "SEE ALSO" +The Gwenview homepage can be found at \fIhttp://gwenview.sourceforge.net\fR. +.PP +A mailing list is also available at \fIhttp://lists.sourceforge.net/lists/listinfo/gwenview-general\fR. +.SH BUGS +To report a bug, please visit \fIhttp://bugs.kde.org\fR. +.SH AUTHOR +Gwenview was written by Aurelien Gateau . +.PP +This manual page was written by Christopher Martin for +Debian GNU/Linux, but may be used by others. +.PP +Permission is granted to copy, distribute and/or modify this document under the +terms of the GNU General Public License, Version 2, any later version published +by the Free Software Foundation. diff --git a/doc/mouse.docbook b/doc/mouse.docbook deleted file mode 100644 index 0792b3a..0000000 --- a/doc/mouse.docbook +++ /dev/null @@ -1,40 +0,0 @@ -Using the mouse - -Panning with the mouse - - Holding down the left mouse button on an image allows you to - scroll the image. - The mouse wheel will scroll the image up and - down. - - - - -Zooming with the mouse - - Clicking the middle mouse button will toggle the auto zoom - on/off. - Hold down the Control key, then either use the mouse wheel to - zoom in and out or left click to zoom in and right click to zoom - out. - - The mouse wheel, used while holding down the Alt key, will - scroll the image horizontally. - - - - -Browsing with the mouse - - Double-clicking on an image toggles Browse - mode. - By default, the mouse wheel will scroll the image up and down. But, - this can be configured to browse the images in the current directory - instead. - Hold down the left mouse button over an image, then click the right - button to go to the next image. - Hold down the right button, then click the - left button to load the previous image. - - - diff --git a/doc/view_mode.png b/doc/view_mode.png deleted file mode 100644 index 801ad23..0000000 Binary files a/doc/view_mode.png and /dev/null differ diff --git a/src/Makefile.am b/src/Makefile.am index 81a3b05..2c0f108 100644 --- a/src/Makefile.am +++ b/src/Makefile.am @@ -1,4 +1,4 @@ -SUBDIRS = tsthread imageutils gvcore pics desktopfiles doc tools updates gvimagepart gvdirpart app +SUBDIRS = tsthread imageutils gvcore pics desktopfiles tools updates gvimagepart gvdirpart app EXTRA_DIST = AUTHORS ChangeLog COPYING INSTALL NEWS README TODO CREDITS DESIGN diff --git a/src/doc/Makefile.am b/src/doc/Makefile.am deleted file mode 100644 index a34ff18..0000000 --- a/src/doc/Makefile.am +++ /dev/null @@ -1 +0,0 @@ -man_MANS = gwenview.1 diff --git a/src/doc/gwenview.1 b/src/doc/gwenview.1 deleted file mode 100644 index d1d9de2..0000000 --- a/src/doc/gwenview.1 +++ /dev/null @@ -1,238 +0,0 @@ -.TH GWENVIEW 1 "January 2005" "Trinity Desktop Environment" "Image viewer for TDE" -.SH NAME -Gwenview \- An image viewer for TDE -.SH SYNOPSIS -.B gwenview -[\fIoptions\fR] [\fIfile or folder\fR] -.SH DESCRIPTION -Gwenview is an image viewer for TDE. 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. -.PP -Image loading is handled by the TQt library, so Gwenview supports all image formats your TQt installation supports. Gwenview correctly displays images with an alpha channel. -.PP -Gwenview supports the displaying and editing of EXIF comments, if the necessary JPEG tdefile\-plugin is installed. This comes as part of the tdegraphics package. Lossless JPEG transforms are also supported. -.SH OPTIONS -.SS Arguments: -.TP -.B file or folder -An initial image file, or a folder containing images. -.SS Gwenview options: -.TP -.B \-f -Start in Full Screen mode. -.SS Generic options: -.TP -.B \-\-help -Show help about options. -.TP -.B \-\-help\-tqt -Show TQt specific options. -.TP -.B \-\-help\-kde -Show KDE specific options. -.TP -.B \-\-help\-all -Show all options. -.TP -.B \-\-author -Show author information. -.TP -.B \-v\fR, \fB\-\-version -Show version information. -.TP -.B \-\-license -Show license information. -.TP -.B \-\- -End of options. -.SS TQt options: -.TP -.B \-\-display \fIdisplayname\fR -Use the X\-server display 'displayname'. -.TP -.B \-\-session \fIsessionId\fR -Restore the application for the given 'sessionId'. -.TP -.B \-\-cmap -Causes the application to install a private color -map on an 8\-bit display. -.TP -.B \-\-ncols \fIcount\fR -Limits the number of colors allocated in the color -cube on an 8\-bit display, if the application is -using the QApplication::ManyColor color -specification. -.TP -.B \-\-nograb -Tells TQt to never grab the mouse or the keyboard. -.TP -.B \-\-dograb -Running under a debugger can cause an implicit -\-nograb, use \-dograb to override. -.TP -.B \-\-sync -Switches to synchronous mode for debugging. -.TP -.B \-\-fn\fR, \fB\-\-font \fIfontname\fR -Defines the application font. -.TP -.B \-\-bg\fR, \fB\-\-background \fIcolor\fR -Sets the default background color and an -application palette (light and dark shades are -calculated). -.TP -.B \-\-fg\fR, \fB\-\-foreground \fIcolor\fR -Sets the default foreground color. -.TP -.B \-\-btn\fR, \fB\-\-button \fIcolor\fR -Sets the default button color. -.TP -.B \-\-name \fIname\fR -Sets the application name. -.TP -.B \-\-title \fItitle\fR -Sets the application title (caption). -.TP -.B \-\-visual TrueColor -Forces the application to use a TrueColor visual on -an 8\-bit display. -.TP -.B \-\-inputstyle \fIinputstyle\fR -Sets XIM (X Input Method) input style. Possible -values are onthespot, overthespot, offthespot and -root. -.TP -.B \-\-im \fIXIM server\fR -Set XIM server. -.TP -.B \-\-noxim -Disable XIM. -.TP -.B \-\-reverse -Mirrors the whole layout of widgets. -.SS KDE options: -.TP -.B \-\-caption \fIcaption\fR -Use 'caption' as name in the titlebar. -.TP -.B \-\-icon \fIicon\fR -Use 'icon' as the application icon. -.TP -.B \-\-miniicon \fIicon\fR -Use 'icon' as the icon in the titlebar. -.TP -.B \-\-config \fIfilename\fR -Use alternative configuration file. -.TP -.B \-\-dcopserver \fIserver\fR -Use the DCOP Server specified by 'server'. -.TP -.B \-\-nocrashhandler -Disable crash handler, to get core dumps. -.TP -.B \-\-waitforwm -Waits for a WM_NET compatible windowmanager. -.TP -.B \-\-style \fIstyle\fR -Sets the application GUI style. -.TP -.B \-\-geometry \fIgeometry\fR -Sets the client geometry of the main widget. -.SH INTERFACE -.SS Browse and View modes -By default, Gwenview opens in Browse mode, with the docked windows (showing -directory structure and contents) displayed. Starting Gwenview with a directory -as an argument also begins in Browse mode. Starting with an image as an argument, -however, opens Gwenview in View mode, with these docked windows hidden to give -full space to the image itself. -.PP -Once Gwenview is started, the user can toggle between Browse and View modes by -clicking the Browse button on the Main Toolbar. The same option can be found -in the View menu. Ctrl-Return will toggle these modes as well. -.PP -Whereas normally, in Browse mode, single-clicking on an image thumbnail or -listing is sufficient for Gwenview to display it, users also have the option of -double-clicking, which displays the image and switches Gwenview to View mode. -.SS Docked windows -The Gwenview interface is composed of a number of smaller docked windows. -Manipulating these windows can be difficult at first. To focus a particular -window in the Gwenview interface, simply click within it. -.PP -Each docked window has a small grip bar along the top, with a dock/undock button -resembling an arrow at its right end, as well as a close button resembling the -letter X. -.PP -Clicking the close button on a docked window will remove it from the interface. -To bring back a window, select it from the Window menu. -.PP -To resize docked windows, click on the border between the windows, and drag. -To re-arrange the docked windows, click on a window's grip bar along its top, and drag -the window over to the desired position relative to the other docked windows. -While dragging, a small box outline should appear that indicates the new position -that the window will take, when you release the mouse and end the drag. If you wish -to stack two windows, and use tabs to choose between them, drag the window to the -very center of the other window with which you wish to stack. -.PP -To undock a window, either click the dock/undock button in its top right corner, or -double-click on the window's grip bar. Double-clicking again, or clicking -on the dock/undock button, should return the window to its original position. -Otherwise, you can dock an undocked window by dragging its grip bar back to a -point within the general interface, just as if you were rearranging an already -docked window. -.PP -The file view window cannot be undocked or moved, but by moving other windows -around, it can itself be shifted about. -.PP -While dragging a window, press the Escape key to cancel the operation. To reset -the docked windows to the default Gwenview layout, use the Reset option in the -Window menu. -.SS Mouse operations -Browsing a directory of images can be done several ways, including mouse -gestures. Hold down the left mouse button over an image, then click the right -button to go to the next image. Hold down the right button, then click the -left button to load the previous image. -.PP -Clicking the right mouse button on an image brings up a context menu. -.PP -Clicking the middle mouse button will toggle the auto zoom on/off. -.PP -Double-clicking on an image toggles Full Screen mode. -.PP -Holding down the left mouse button on an image allows you to -scroll the image. By default, you can also scroll up and down an image by -using the mouse wheel. However, this can be configured to browse the images -in the current directory instead. -.PP -The mouse wheel, used while holding down the Shift key, will zoom the image -in and out. -.PP -The mouse wheel, used while holding down the Control or Alt keys, will scroll the image horizontally. -.SS Keybindings -Gwenview comes with a range of keyboard shortcuts, all of which can be viewed and remapped by -selecting "Configure Shortcuts" in the Settings menu. Note that in the Files and Folders windows, -all the normal KDE shortcuts are functional, unless otherwise remapped. -.PP -A few of the most useful default bindings are: -.PP - Ctrl-Shift-F Toggles Full Screen mode. - Escape Stop, exit from Full Screen mode. - - Home Displays the first image in the directory. - End Displays the last image in the directory. - - Space Displays the next image in the directory. - Backspace Displays the previous image in the directory. -.SH "SEE ALSO" -The Gwenview homepage can be found at \fIhttp://gwenview.sourceforge.net\fR. -.PP -A mailing list is also available at \fIhttp://lists.sourceforge.net/lists/listinfo/gwenview-general\fR. -.SH BUGS -To report a bug, please visit \fIhttp://bugs.kde.org\fR. -.SH AUTHOR -Gwenview was written by Aurelien Gateau . -.PP -This manual page was written by Christopher Martin for -Debian GNU/Linux, but may be used by others. -.PP -Permission is granted to copy, distribute and/or modify this document under the -terms of the GNU General Public License, Version 2, any later version published -by the Free Software Foundation. -- cgit v1.2.1