# The &digikam; Handbook

Renchi
Raju

    renchi at pooh.tam.uiuc.edu

Gilles
Caulier

    caulier dot gilles at free.fr

2001
2004
The &digikam; developers team
&FDLNotice;
xx/xx/2004
0.6.2

&digikam; is a KDE Photo Management Application with support for Digital Cameras.

KDE
Digital Camera
digikam
gphoto
Graphics

## Introduction

&digikam; is a simple digital photo management application, which makes importing and organizing digital photos a "snap". The photos can be organized in "albums" which are automatically sorted chronologically. An easy to use interface is provided to connect to your camera and preview images and download and/or delete them.

Please email bug reports, questions, comments and suggestions to digikam-users@lists.sourceforge.net. You find the &digikam; home page at http://digikam.sourceforge.net.

## Using &digikam;

### The main &digikam; window

&digikam; is a fairly easy to use application. When you load up &digikam; for the first time (or upgrade from 0.5), you will get a popup window that tells you that the way that &digikam; stores photos has changed. &digikam; uses now a folder on your filesystem as an album library, meaning that every subfolder of this folder will be considered as a photo album and displayed in the album list on the left side of the main window. Simply set a path to the album library using this popup window. Doing this, the &digikam; main window will be loaded with the album list on the left and the content of the selected album on the right side. You could see some albums in album list if you have choosen an album library with subfolders. If you have already folders where you keep your photos, you can copy them into the album library and they will be displayed as albums in &digikam;. As soon as you add an album, it will be sorted chronologically based on the month/year it was last modified. Lot of times these dates don't match with the month/year when the pictures were actually taken. You can right click on an album and it will give you an option to change the album date. The right click menu will also provide you more options to change the title of the album, add comments or remove it from the index or delete it entirely.

Clicking on an album will start generating the thumbnails for the images in the album or if the thumbnails have already been generated, will load them from cache. You can change the iconsize to small, medium, large or huge from the magnify buttons in the toolbar (Also you can set the default iconsize you want when &digikam; starts up. More on this in the setupwindow). Right Clicking on an item will give you a popup menu, using which you can view, rename, delete, see the exif information, and add/edit comments of the images. When you add comments to an image, they are shown below the filename in the thumbnailview. Double clicking on an item will open it up in the imageviewer.

The main window

### Using a Digital Camera with &digikam;

To be able to use your digital camera with &digikam;, connect the camera to your computer, switch the camera to the image display mode and turn it on. Now you need to setup the camera model and port using the setup interface. Try and see if &digikam; can auto-detect the camera; if not, you can set the camera model and port manually. Once you have the camera setup, goto the "Cameras" menu in the main interface and you will see the camera listed in the menu (Note: You can choose any title you like for the camera in the setup and this title will be used in the "Cameras" menu). If you have more than one cameras, you can add them throught the setup interface. Clicking on the camera item in the menu will popup a new Camera Interface and this will connect to the camera, and thumbnails (if supported by the camera) will be downloaded and displayed. You can then select the images and download or delete them from the camera. Downloading can be done by using the menu/toolbar buttons or by dragging and dropping them onto an album folder.

Digital cameras nowadays store images on either a CompactFlash card or SmartMedia card. The camera internally makes subfolders in these storage media which it uses to save the images. &digikam; displays these internal folder tree and also provides a global virtual folder which shows all the images available in the camera. When you open the camera interface for the first time the folders are hidden and the contents of the global virtual folder are shown (i.e. all the pictures in the camera). You can choose to see the actual folders on the camera by unselecting "Hide Folders" in the "View" menu. This will show the folders on the camera, the topmost folder being the global virtual folder. Clicking on a folder will show the contents of the folder in the thumbnailview.

The camera client window

## Menu Descriptions

### The main &digikam; window

#### The Album Menu

CtrlN Album New Album

  Create a new album folder

Albums Sort Albums

  Sort all &digikam; Albums by Collection, by Date, or by a flat method

CtrlI Album Add Images

  Select images to be added to the currently selected Album

CtrlF3 Album Edit Album Properties

  Edit the currently selected album title and comments

Album Archive to CD

  Archive &digikam; Albums in a CD/DVD media using K3b program. You can select easily the Albums to archive in the media. An HTML interface can be built for a confortable data navigation. For the Win32 platform, an 'AutoRun' option is available.

  K3b program is available at this url.

Album HTML Export

  Export &digikam; Albums in HTML page for a WEB publication. You can select easily the Albums to export in an HTML page. You can set a big parameters list the HTML rendering. The UTF-8 encoding is used for a best internationalization.

  You can see some samples building with this plugin at this url.

Album Open Album in Konqueror

  Open the current Album in a the konqueror file manager.

Album Open Album in Nautilus

  Open the current Album in the Nautilus file manager.

Album Delete Album from HardDisk

  Delete selected Album and all items in it from the hard drive

CtrlQ Album Quit

  Quit &digikam;

#### The Image Menu

F4 Image View/Edit

  Open the currently selected image in the imageviewer

F3 Image Edit Image Comments

  Edit the image comments

F6 Image View Exif Information

  See the exif information stored in the image

AltEnter Image Properties

  View Image Properties

Shift-1 Shift-2 Shift-3 Image Transform Rotate

  Do Lossless JPEG 90/180/270 Degree Rotation (this will rotate an image without losing any quality and any exif information)

Image Transform Flip

  Do Lossless JPEG Horizontal or Vertical flip (this will flip an image without losing any quality and any exif information)

Image Transform Convert to Black and White

  Do Lossless JPEG black and white convertion (this will convert an image to black and white without losing any exif information)

F2 Image Rename

  Rename the current item

ShiftDelete Image Delete

  Delete selected items

Image E-mail Images

  E-mail the selected items with your favorite mail agent. A resizing items operation is possible. You can use the drag and drop for to add more images in the list to send.

Image Print Wizard

  The print wizard allows multiple images to be combined into single sheets of paper in standard photo sizes for printing. The combined images can also be automatically opened with the image editor Gimp for enhancement or for direct printing using the Gimp-Print plugin. The combined images can also be output directly to jpeg files.

Image Set as background

  Place the current selected image in the KDE desktop in according with the menu sub-option selected:

  - Centered.

  - Tiled.

  - Centered tiled.

  - Centered max-aspect.

  - Tiled max-aspect.

  - Scaled.

  - Centered auto fit.

#### The Select Menu

CtrlA Select Select All

  Select all images currently shown

CtrlU Select Select None

  Unselect all items in the current view

Ctrl* Select Invert Selection

  Invert the current selection

#### The View Menu

Alt+ View Increase Thumbnail Size

  Increase the thumbnail size

Alt- View Decrease Thumbnail Size

  Decrease the thumbnail size

CtrlShiftF View Toggle Full Screen

  Toggles the graphic interface in full screen mode

#### The Camera Menu

Any configured digital camera will be listed here. You can use the &digikam; setup dialog for add a new camera in the list.

#### The Tools Menu

Some installed tools &digikam; plugins will be listed here. More news about the &digikam; plugins can be found at this URL: http://digikam.sourceforge.net/plugins.html

Tools Create calendar

  Used this wizard for create a calendar with some &digikam; Albums images.

Tools Batch Comments Editor

  Launch the Comments Editor plugin dialog box for editing Album images comments in bulk.

Tools Batch Border images

  This plugin can be used for batch border images in an Album. It use "convert" program from "ImageMagick" package. An image effect preview is available. Actually, 4 border styles have been implemented:

  - Solid : simple line.

  - Niepce : old border style for black and white pictures.

  - Raise : a 3D effect arroud the pictures.

  - Frame : surrond the images with an ornamental border.

  You can see some samples building with this plugin at this url.

Tools Batch Convert images

  This plugin can be used for batch convert images in an Album. It use "convert" program from "ImageMagick" package. The image files formats supported are:

  - JPEG.

  - PNG.

  - PPM.

  - BMP.

  - TIFF.

  - TGA.

Tools Batch Color images

  This plugin can be used for batch colors enhancement images in an Album. It use "convert" program from "ImageMagick" package. An image effect preview (partial or full) is available. 10 colors filters types have been implemented:

  - Decrease contrast : reduce the image contrast.

  - Depth : change the color depth of the image.

  - Equalize : perform histogram equalization to the image.

  - Fuzz : merging colors within a distance are considered equal.

  - Gray scales : convert colors image to gray scales image.

  - Increase contrast : enhance the image contrast.

  - Monochrome : transform the image to black and white.

  - Negate : replace every pixel with its complementary color.

  - Normalize : transform image to span the full range of color values.

  - Segment : segment an image by analyzing the histograms of the color components.

  - Trim : trim an image (fuzz reverse technic).

  You can see some samples building with this plugin at this url.

Tools Batch Effect images

  This plugin can be used for batch FX transforming images in an Album. It use "convert" program from "ImageMagick" package. An image effect preview (partial or full) is also available. 11 FX filters types have been implemented:

  - Adaptative threshold : perform local adaptive thresholding.

  - Charcoal : simulate a charcoal drawing.

  - Detect edges : detect edges within an image.

  - Emboss : returns a grayscale image with a three-dimensional effect.

  - Implode : implode image pixels about the center.

  - Paint : applies a special effect filter that simulates an oil painting.

  - Shade light : shines a distant light on an image to create a three-dimensional effect.

  - Solarize : negate all pixels above the threshold level.

  - Spread : this is a special effects method that randomly displaces each pixel in a block defined by the radius parameter.

  - Swirl : swirls the pixels about the center of the image.

  - Wave : creates a ripple effect in the image by shifting the pixels vertically along a sine wave.

  You can see some samples building with this plugin at this url.

Tools Batch Filter images

  This plugin can be used for batch filter images in an Album. It use "convert" program from "ImageMagick" package. An image effect preview (partial or full) is available. 9 filters types have been implemented:

  - Add noise : add noise in an image.

  - Antialias : remove pixel aliasing.

  - Blur : blur the image with a Gaussian operator.

  - Despeckle : reduce the speckles within an image.

  - Enhance : apply a digital filter to enhance a noisy image.

  - Median : apply a median filter to an image.

  - Noise reduction : reduce noise in an image.

  - Sharpen : sharpen the image with a Gaussian operator.

  - Unsharp : sharpen the image with an unsharp mask operator.

  You can see some samples building with this plugin at this url.

Tools Batch Rename images

  This plugin can be used for batch rename image files in an Album.

Tools Batch Recompress images

  This plugin can be used for batch recompress images in an Album. It use "convert" program from "ImageMagick" package. The image files formats supported are:

  - JPEG.

  - PNG.

  - TIFF.

  - TGA.

Tools Batch Resize images

  This plugin can be used for batch resize images in an Album. It use "convert" program from "ImageMagick" package. You can resize up or down the images size. 3 resizing types have been implemented:

  - Proportional (1 dim.) : standard auto-resizing using one dimension. The width or the height of the images will be automatically selected in depending of the images orientation. The images aspect ratio are preserved.

  - Proportional (2 dim.) : auto-resizing using two dimensions. The images aspect ratio are preserved. For example, you can use that for to adapt your images size to your screen size.

  - Non proportional : non proportional resizing using two dimensions. The images aspect ratio aren't preserved.

  - Prepare to print : prepare the image for a photographic printing. The user can set the print resolution and the photographic paper size. The target image will be adapted to the good dimensions (included the background size, marging size, and background color).

Tools Batch Raw Images Converter

  Launch the batch Raw Converter plugin dialog box. This plugin can convert quite a few RAW file images from differents digital cameras (Canon, Nikon, Sigma, Olympus, Minolta, etc.). It uses the Dave Coffin RAW photo decoder program "dcraw".

  "dcraw" program is available at this url.

Tools Raw Image Converter

  Launch the Raw Converter plugin dialog box. This plugin is for process an unique image.

Tools Acquire Images Scan Images

  Launch the Kooka interface dialog box for scan images with a scanner supported by Sane project.

Tools Acquire Images Screenshot

  Launch the &digikam; dialog for screenshots capture.

Tools Find Images Find duplicate images

  This plugin can be used for find dupplicates images in Albums database.

Tools MPEG Encoder

  Launch the MPEG Encoder plugin dialog box for convert the selected images on a MPEG sequence with a specific duration and merge all images on an single MPEG file. This plugin use the "MjpegTools" and "ImageMagick" packages. Between the images, you can insert a basic transition. You can also add an audio track on the images sequence with a MP2 or WAV file. All images will be automatically scaling to the good size for the video format. Also a specific background color could be used. You can use this plugin for to build some DVD/XVCD/SVCD/VCD image portfolios for your home DVD player. Use K3b program for create this media.

  You can see some samples building with this plugin at this url.

Tools SlideShow

  Launch the SlideShow plugin dialog box. This plugin is an album images slideshow with a large number of visual effects

#### The Settings Menu

Settings Configure Shortcuts

  Configure the &digikam; shortcuts

Settings Configure Toolbars

  Configure the &digikam; toolbars

Settings Configure &digikam;

  Configure the Camera and Album Settings

#### The Help Menu

&help.menu.documentation;

Additionally &digikam; offers this item:

Help Tip of the Day

  This displays a dialog with useful hints for using &digikam;.

### The &digikam; setup window

The setup window has two tabs, one for the camera settings and the second for the album settings. The camera settings shows on the left the list of currently support cameras. On the right at the top there is an auto-detect button which tries to identify the camera connected to your computer (make sure that the camera is connected properly to the computer and turned on in the image display mode). Below this are the port settings; the currently supported being serial and usb.

Clicking on a camera in the list on the left will display the supported ports which you can then select. If there is only one supported port it will be automatically selected. At the bottom on the right there is a box for setting the exact path in case of a serial port. Please note that usb interface does not need any paths to be set. At the very bottom is where you set the path for a USB MassStorage Camera. This box becomes active once you select USB MassStorage Camera in the camera list. You need to enter here the path where you mount the camera, usually "/mnt/camera".

The add camera dialogbox

In the album settings you can choose options as to how &digikam; will behave:

Show Only Files With Extension

  Lets you choose the extensions of the files which will be shown in the thumbnailview. Some default values have been setup in the list already

Set Default Icon Size

  Set the icon-size which you want to be default when showing both local and camera thumbnails. You can choose between Small, Medium, Large and Huge Options here

Extra Information In Thumbnail View

  You can choose what extra information (apart from the filename should be shown in the ThumbnailView). You can choose to show filesize, mimetype, the date file was last modified and the comments for the file

The setup album dialogbox

### The Camera window

#### The Camera Menu

CtrlD Camera Connect

  Connect/Disconnect to/from the camera

Camera Download Selected

  Download the selected images

Camera Download All

  Download all images in the camera

Camera Delete Selected

  Delete the selected images

Camera Delete All

  Delete all images from the camera

CtrlShiftU Camera Upload

  Upload images into the camera

Esc Camera Stop

  Cancel any camera operations being performed

CtrlF3 Camera Information

  Show information about the camera and the camera driver

CtrlQ Camera Quit

  Quits the camera interface

#### The Select Menu

CtrlA Select Select All

  Select all images currently shown

CtrlU Select Select None

  Unselect all items in the current view

Ctrl* Select Invert Selection

  Invert the current selection

Ctrl/ Select Select New Items

  Select only those items which haven't been downloaded yet

#### The View Menu

Alt+ View Increase Thumbnail Size

  Increase the thumbnail size

Alt- View Decrease Thumbnail Size

  Decrease the thumbnail size

CtrlShiftF View Toggle Full Screen

  Toggles the graphic interface in full screen mode

View Hide Folders

  Toggles showing the camera folders

View Hide StatusBar

  Toggles showing the statusbar

#### The Settings Menu

Settings Configure Shortcuts

  Configure the digital camera client shortcuts

Settings Configure Toolbars

  Configure the digital camera client toolbars

### The Image Viewer

&digikam; incorporates a fast imageviewer with a few basic image editing tools. The imageviewer has a toolbar at the top which shows the filename and the current filenumber at the extreme left. To the right of it is shown the current zoomlevel. A number of buttons are to the right of this which provide the functionality for the viewer/editor.

The image viewer window

#### The Toolbar Buttons

Previous Image

  Show previous image

Next Image

  Show next image

Images list

  Show the current images list. Select one item for to navigate speedly between the images

Zoom In

  Zoom into the image

Zoom Out

  Zoom Out of the image

Auto Zoom

  Toggle Auto Zooming (if selected image will fit in the window)

Zoom 1:1

  Zoom to 1:1 scale the image

Full Screen

  Toggle Full Screen (if selected image will be shown in full screen mode)

Adjust Image

  Modify the brightness, the contrast, or the gamma of the current image

Rotate Image

  Rotate the current image (through 90, 180 or 270 degrees)

Flip Image

  Flip the current image (through horizontally or vertically)

Crop

  Crop the image to the selected region

Edit Image Comments

  Edit the comments of the current image

View Exif Information

  Launch the Exif information viewer for the current image

View Image properties

  Launch the file properties dialog for the current image

Print Image

  Print the current image

Save

  Save the modified image

Save as

  Save the modified image with a new file name

Restore

  If the image has been modified and not saved you can restore the original image using this button

Remove from Album

  Remove the current image from the current Album

Close

  Close the imageviewer

#### Shortcuts for the imageviewer

Next Album Image

  PageDown

Previous Album Image

  PageUp

Zoom In

  +

Zoom Out

  -

Zoom 1:1

  Shift-1

Toggle Auto Zoom

  A

Toggle Full Screen

  Ctrl-Shift-F

Rotate Image through 90 degrees

  1

Rotate Image through 180 degrees

  2

Rotate Image through 270 degrees

  3

Flip Image Horizontally

  H

Flip Image Vertically

  V

Crop Image

  Ctrl-C

Adjust Image

  Ctrl-E

Increase Brightness

  B

Decrease Brightness

  Shift-B

Increase Gamma

  G

Decrease Gamma

  Shift-G

Increase Contrast

  C

Decrease Contrast

  Shift-C

Edit Image Comments

  F3

View Exif Information

  F6

View Image properties

  Alt-Enter

Print Image

  Ctrl-P

Save

  Ctrl-S

Save as

  Ctrl-Shift-S

Restore

  Ctrl-R

Remove from Album

  Shift-Del

Help

  F1

About

  Ctrl-Shift-A

Close

  Esc

## Credits and License

&digikam;

Program copyright 2001-2003, &digikam; developers team

Documentation copyright 2001-2003 Renchi Raju renchi at pooh.tam.uiuc.edu and Gilles Caulier caulier dot gilles at free.fr

Contributors:

- Caulier Gilles caulier dot gilles at free.fr: French Translations, Developer, and Translations Coordinator

- Todd Shoemaker todd at theshoemakers.net: Developer

- Gregory Kokanosky gregory dot kokanosky at free.fr: Developer

- Stefano Rivoir s dot rivoir at gts.it: Italian translations

- Rune Laursen runerl at skjoldhoej.dk: Danish translations

- Jan Toenjes jan dot toenjes at web.de: German translations

- Oliver Doerr oliver at doerr-privat.de: German translations and beta tester

- Quique quique at sindominio.net: Spanish translations

- Marcus Meissner marcus at jet.franken.de: Czech translations

- Janos Tamasi janusz at vnet.hu: Hungarian translations

- Jasper van der Marel jasper dot van dot der dot marel at wanadoo.nl: Dutch translations

- Anna Sawicka ania at kajak.org.pl: Polish translations

- Achim Bohnet ach at mpe.mpg.de: Bugs reports and patchs

- Charles Bouveyron c dot bouveyron at tuxfamily.org: Beta tester

- Richard Groult Richard dot Groult at jalix.org: Plugins contributor and beta tester

&underFDL;

&underGPL;

## Installation

### How to obtain &digikam;

The website for &digikam; is at http://digikam.sourceforge.net. Please check there regularly to obtain news about &digikam;. &digikam; can be obtained in binary and source format from http://www.sourceforge.net/projects/digikam.

Also you can checkout the digikam3 and digikamplugins source code modules from SourceForge.net CVS repository like this:

    % cvs -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/digikam login
    % cvs -z3 -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/digikam co digikam3
    % cvs -z3 -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/digikam co digikamplugins

The last CVS snapshoots can be downloaded at this URL http://digikam.free.fr/Tarballs.

### Requirements

In order to successfully use &digikam;, you need the following:

- AutoConf >= 2.5

- AutoMake >= 1.7.0

- KDE 3.x

- gphoto2 2.x

- imlib1 >= 1.90

- libexif >= 0.5.7

- ImageMagick >= 5.5.4

- MJPEGTools >= 1.6.0

- dcRAW >= 5.02

KDE can be obtained from KDE Home Page, and Gphoto2 can be obtained from Gphoto Home Page. Most likely your distribution vendor might already have packaged and provided these packages.

### Compilation and Installation

In order to compile and install &digikam; on your system, type the following in the basedirectorys of the digikam3 and digikamplugins module distributions:

    % export WANT_AUTOCONF_2_5=1
    % export KDEDIR=KDE_installation_dir_on_your_system
    % make -f Makefile.cvs
    % ./configure
    % make
    % su
    % make install

#### Important notices

More specifics compilations and installations options can be used with .configure script. Check it with `./configure --help` command line.

Because digikamplugins module depend of digikam3 plugin interface, you must build digikamplugins module after the digikam3 module compilation and installation.

Some plugins can be disabled during the build process in digikamplugins module. Checked the end of 'configure.in.in' file and decomments the plugins lines corresponding. Then start the installation procedure.

Since &digikam; uses autoconf and automake you should have not trouble compiling it. Should you run into problems please report them to digikam-users@lists.sourceforge.net

&documentation.index;