# The &dolphin; Handbook

## Introduction

&dolphin; is a file manager for &kde; which aims to improve usability at the user interface level. &dolphin; is not intended to be a competitor to &konqueror;, &kde;'s default file manager. &dolphin; focuses only on being a file manager whereas &konqueror; is a universal viewer of many file types. This development approach allows for concentrating on optimizing the user interface for the specific task of file management.

&dolphin; is currently in beta stage, but already provides most features necessary for daily usage. Please report any problems or feature requests to the &dolphin; author via the bug report dialog. This is accessible from the Help Report Bug... menu of the application.

## &dolphin; Interface

### &dolphin; Features

&dolphin; does not represent a wild departure from the &konqueror; file manager interface. There are certain paradigms in use however, which may require some readjustment on the user's part. An attempt is made below to explain these in an effort to provide a more enjoyable experience for our users.

#### &dolphin; User Interface

The default Dolphin interface consists of a (1) menu bar, (2) toolbar, (3) location bar, (4) workspace and (5) status bar.

Here's a screenshot of &dolphin; Dolphin Screenshot

The location bar displays the path to the current directory. The location bar has two versions. There is the typical line input version which shows the path to the current directory via a string of text e.g. `/home/peter/Documents`. The second version of the location bar uses the 'bread crumb' display. The bread crumb display makes each folder a link which can be used to immediately go to the entry. The `/home/peter/Documents` entry in the bread crumb view would become 'Home > peter > Documents' with Home, peter, and Documents being clickable links which are able go to there respective locations. This makes navigation to directories above the current directory easier and more intuitive. It also removes the need for the Up icon to be present in the toolbar.

The workspace shows the contents of the current directory. The workspace can also be configured to show the contents of a directory with multiple views. More information about the workspace is provided in the following section.

The status bar shows a limited amount of data relating to the file hovered over and the current directory. When a file is hovered over, the status bar shows the file name, the file size and the file type e.g. Jpeg. When no file has been highlighted or hovered over, the status bar shows the amount of files and folders in the current directory. At all times the status bar shows the amount of storage space that has currently been used on the current mount point, as well as the maximum space available on the mount pount e.g. /home/.

#### &dolphin; Workspace

The &dolphin; workspace can display the contents of a directory in a variety of views. Currently there are icons, details and previews modes.

The Icons view shows the contents of the directory via the file icon type e.g. an mp3 file will be represented with the icon for an mp3 file. Sub-directories are represented in the form of a folder icon. The folder icon is defined by the &kde; icon theme currently in use, however individual folders can have their icon changed manually if the user wishes. This can be done via the properties dialogue.

The Details view lists the contents of a directory in alphabetical order and by type. Sub-folders are at the top of the list in alphabetical order, while underneath, the files within the directory are in alphabetical order.

Details are displayed to the right of the files within the directory. The default &dolphin; configuration only displays the size of the file and the date it was last modified. More details can be added via the Configure Dolphin dialogue however.

The Preview view is similar to the icons view. The difference is that wherever possible previews of the files are shown. This function works for a number of image types including; JPG, PNG, XCF, SVG and numerous others. The previews view is also capable of showing the first 14 lines from text documents. &dolphin; is also capable of displaying a preview of HTML and PDF files in the previews view. It is also possible to modify the size of the previews via the Configure Dolphin dialogue.

Changing the view of the directory a user is working in is as simple as clicking the icon of the view they wish to use. This will cause the workspace view to change accordingly.

Here's a screenshot of &dolphin; Dolphin Workspace View Buttons

The workspace in &dolphin; is capable of showing two directories within the same window, known as split workspaces. In order to enable or disable the split workspace mode toggle the icon on the taskbar. Another way to enable or disable the split workspace mode is to use the View Split View menu option.

If this option is enabled then the workspace will split apart. Two seperate workspace areas will be available for use, along with two seperate location bars. Clicking on either workspace will make it the active workspace. If the user toggles the split workspace mode off, then the currently active workspace will remain, while the inactive workspace will close.

Here's a screenshot of &dolphin; Dolphin In Split Workspace Mode

&dolphin; is capable of remembering the workspace view on a per-directory basis. For example, if while viewing `/home/peter/Pictures/` the user choses to use the previews view, then the next time the user enters that directory, the view will be changed to the previews view. This is especially useful for directories containing mainly images. The feature only works for local directories which the user has read/write permissions to. &dolphin; will also remember the viewing mode it was in when last running e.g. single workspace or split workspace.

Dolphin can also display files and sub-directories that are hidden in the the current directory e.g. files such as .dolphin and sub-directory such as ./kde/

Hidden files and sub-folders can be distinguished from non-hidden file and sub-folders by their colouring. Hidden files/sub-directories are fainter then non-hidden files/sub-directories.

Here's a screenshot of &dolphin; Dolphin Showing Hidden Folders/Directories Enabled

To enable the showing of hidden files and sub-directories via the main menu View>Show Hidden Files.

Dolphin is able to sort the contents of a directory in a number of ways. These are; By Name, By Date, By Size and Descending. These only apply to the current directory the user is currently in and do not affect other directories. As with the Views Modes the Sorting order is saved for this directory.

To change the way the directory is sorted, via the Main Menu View>Sort>sorting type (e.g. By Date).

#### &dolphin; Sidebar

The &dolphin; sidebar has two modes. The first mode is the Bookmarks mode. The second mode is the Information mode. The sidebar can be enabed and disabled via the the menu bar; Views > Sidebar.

The sidebar mode can be changed via the drop down menu at the top. Selecting Bookmakrs will enable the bookmarks mode, while selecting Information will enable the Information mode.

The Bookmarks sidebar mode displays the filesystem bookmarks the user has stored. The bookmarks sidebar mode also allows the user to add more bookamrks, this can be done via right clicking the sidebar.

Here's a screenshot of &dolphin; Dolphin Showing The Sidebar With The Bookmarks Mode Enabled

The Information sidebar mode also allows the user access to their service menus for a given file type. A service menu entry that is directly under the Actions > ... menu is diaplayed as a single button. However if a service menu entry is in a submenu under the Actions > .... menu e.g. Actions > Amarok, then this is presented as a drop down menu containing the options.

Here's a screenshot of &dolphin; Dolphin Showing The Sidebar With The Information Mode Enabled

## Using &dolphin;

### &dolphin; Navigation

The main feature of Dolphin that allows navigation of the file system is the work space. Clicking on a sub-directory within the current directory changes to this directory. Clicking on files within the workspace will open the file in the default application that has been assigned to it.

The tool bar is also used for navigating the file system. The tool bar contains two buttons essential for navigating the file system quickly and easily, these are; back and forward.

Here's a screenshot of &dolphin; Dolphin Toolbar Buttons

Other buttons can be added to the tool bar to further aid navigation or to provide short cuts for functions within Dolphin e.g. deleting a file.

Dolphin continually shows the directory that it is currently viewing the contents of, via the location bar and the title bar. The location bar has two views available. The first is the directory path view. This shows the path to the current directory e.g. /usr/share/apps/dolphin/

Here's a screenshot of &dolphin; Dolphin Displaying The Directory Path View

The second view is the breadcrumb view. This allows the user to move to a directory a number of folders back from the current one. This is achieved via a tab like interface where the name of each previous directory is displayed and can be clicked on to change into.

Here's a screenshot of &dolphin; Dolphin Displaying The Breadcrumb View

In order to change between the two location bar views, click on the the browse button. This will toggle the view between the directory path view and the bread crumb view. A second way of switching between the directory path view and the breadcrumb view is via View>Navigation Bar>Edit Location or Browse.

Here's a screenshot of &dolphin; Dolphin Browse Button

With the directory path view the user is able to enter the whole path to the directory they wish to enter. In order to do so, the user can toggle the browse button to the directory path view or alternatively via the menu bar View > Navigation Bar > Browse Location/Browse then enter the path to the directory they wish to enter. The user will notice as they are entering the path, a box will open underneath the address bar showing the content of the folder they are currently heading to. The content of this box will change as they continue to enter the path to the directory, showing the directories and the files beginning with the characters being entered e.g. /usr/share/apps/k would display everything within the directory beginning with the k character.

If the breadcrumb view is enabled then the user is unable to enter the path to the directory. The user must manually navigate the file system by clicking the folders and sub-folders within the directories.

In order to aid the navigation of the file system, Dolphin can use bookmarks. Bookmarks can be set for any location on the file system including virtual directories that do not physically exist, but kde creates for ease of use e.g. trash:/. This in turn means that if the user chooses a bookmark from the list the workspace will move into that directory or virtual location.

Here's a screenshot of &dolphin; Dolphin Bookmark Button Open

In order to select a bookmark, the location bar must be set to the breadcrumb view. Clicking the image of the home button (as set by the icon theme currently in use) will drop down a list of all the available bookmarks. The &dolphin; sidebar also contains a bookmark list. This can be accessed via switching the the sideba to bookmakrs mode. The user then clicks the desired bookmark to open that directory. By default Dolphin sets bookmarks for; the users home folder /home/usrname/, the Root partition and the system:/ area (location were the user is able to view the storage devices). More bookmarks can be set via the Configure Dolphin dialogue.

### &dolphin; Storage Media Navigation

Dolphin is not restricted to navigating your local file system, it is also capable of navigating Removable Storage Media. In addition to this, Dolphin also has the ability to mount and un-mount storage media on the system.

When in the kde directory for storage Media; system:/media/ the available Storage Media are shown. Typically this is the hard drive(s)/partitions and Floppy Drive. Each device is named according to their name or device type. The root Partition/Drive is named / while the home partition is named /home, the Floppy Disk is named Floppy Drive.

Here's a screenshot of &dolphin; Dolphin Displaying The System:/Media Directory

If the user has inserted Removable Storage media e.g. a Flash USB disk, then this will be shown. This also applies to CDROM/DVDROM drives. As with the Hard Disks these devices will also be named accordingly, either by there drive name, device type or in the case of CDROMS/DVDROMS by their disk name.

Each device found in this location has the appropriate icon for their device type. However this only applies if the hal daemon is running.

Dolphin can mount devices found in the System:/media/ directory via a number of ways. Firstly right clicking on the device and via the menu Actions>Mount. The second way is by clicking on the device icon.

To un-mount a device right click on the device and via the menu; Actions>Safely Remove. This will then un-mount the device.

To open a mounted device there are two methods. Firstly clicking the mounted device will change into that directory. The second method is by right clicking the device and via the menu Actions>Open Device.

### &dolphin; Configuration

In order to configure Dolphin the user needs to access the Dolphin Configuration dialogue. This can be accessed via the menu bar; Settings>Configure Dolphin.

The Dolphin Configuration dialogue consists of three sections; General, View Modes and Bookmarks. Clicking one of these esections will make those options available accordingly. The options available are displayed to the right of the dialogue.

Here's a screenshot of &dolphin; Dolphin Cnfiguration Window Showing The General Options

The General option allows users to set a number of options for Dolphin, these are; the default home location for the user e.g. /home/Peter, the default view mode (all directories will use this view unless they have already been changed) and wether or not split view is anable by default.

Here's a screenshot of &dolphin; Dolphin Cnfiguration Window Showing The View Options

The View Modes option differes slightly from the General option in that it has three tabs in the options. The Icons tab allows users to set options to do with the Icons View Mode .e.g icon size. The Details tab allows users to set options relating to the Details View Mode e.g. what information about files are shown. The Previews to allows users to set options relating to the Prevews View Mode e.g. the size of the preview images.

Here's a screenshot of &dolphin; Dolphin Cnfiguration Window Showing The Bookmark Options

The Bookmarks option allows the user to add, edit and remove Bookmarks that have been created. Note: only bookmarks created by the user may be removed.

### Quick Tips

The following are a number of tips to save time when using Dolphin.

#### Quick Bookmarking

To quickly create a bookmark of the directory currently being viewed, right click in the work space and via the menu select Bookmark this folder. The Bookmarking dialogue will open, enter a name for the bookmark along with an icon to represent the bookmark.

Another method is to have the sidebar enabled in the bookmakrs mode. Right clikcing the side bar and selecting 'Add Bookmark...' will open the dialogue to add bookmarks.

#### Finding Files

Dolphin is capable of searching for files in a filesystem. If Ctrl+f is pressed or via the Tools menu; Tools > Find Files, kfind will open already set up to search within the current directory and any sub-directories contained within.

#### Mounting Storage Media

A quick way to mount Storage Media is to click on the device. This will mount and open the device in Dolphin.

#### Open A Terminal

&dolphin; can open a terminal already in the current directory. This can be done by pressing the F4 button. For example if the user were in /home/Peter/Packages/ and pressed f4 a terminal will open already in the /home/Peter/Packages/ directory or via the Tools menu; Tools > Open Terminal.

#### Undo Actions

&dolphin; is capable of undoing changes users have made to files. For example if a user sent a file to the Trash, Dolphin can undo this and move it back to the directory it previously belonged in. To undo an action via the menu Edit>Undo(action name)... e.g. Undo rename or by pressing Ctrl+Z

#### Renaming A Batch Of Files

&dolphin; is capable of renaming a number of files at the same time. Each file will have the file name specified, followed by a number for how many files that have been chosen to rename e.g. Tester 1.png, Tester 2.png, Tester 3.png. This is useful for when you have a number of audio files where you wish to number them via their track number, or for photographs taken from a digital camera.

If a user wishes to rename a batch of files they must first select the files to be renamed. This can be done via dragging the mouse over the files to be renamed, or via holding Ctrl and clicking each file to be renamed. The user must then open the batch-rename dialogue, this, can be done via pressing F2 or via the File menu; File > Rename.

The user must then enter the name they wish to give the filEs. The # character must also be present within the name (failure to include the # key will result in an error as this indicates where the file number should be sequentially increased for each file.) The files will then be renamed with a number present within the file name.

#### Comparing A Selection Of Files

&dolphin; is capable of comparing a selection of files to see the differences between them. For a user to be able to compare files then the Kompare application must be installed. &dolphin; can only compare the files that Kompare is capable on analyzing.

If a user wishes to compare a selection of files, then first they must select the files to be compared. Then launch the Kompare application via the Tools menu; Tools > Compare Files. Kompare will then open showing the differences between the files.

#### Filter A Selection Of Files

&dolphin; is capable of filtering a selection of files within the workspace via a text string. For example if a user wish to filter all of the MP3 files within a directory, they could filter for .mp3. Tis would then filter out all of the files that did not have .mp3 within their file name.

If a user wishes to filter a selection of files this can be done via the filter bar. The user then enters the text they wish to filter for within that directory. To enable the filter bar the user must press either the '/' key or via the Menu Bar; Tools > Show Filter Bar. To disable the filter bar the user must press either the 'Esc' Key, or via the Menu Bar; Tools > Show Filter Bar.

## Command Reference

### The main &dolphin; window

#### The File Menu

&Ctrl;N File New

- Creates a new document.

F2 File Rename

- Renames the currently selected document(s).

Delete File Move to Trash

- Moves the currently selected file(s) to the trash.

Shift+Delete File Delete

- Permanently deletes the currently selected file(s). The files are not moved to the trash.

Alt+Returm File Properties

- Shows the properties dialogue for the currently selected file(s).

Ctrl+Q File Quit

- Exits &dolphin;.

#### The Edit Menu

Ctrl+Z Edit Undo

- Undoes the last action performed by &dolphin;.

Ctrl+Shift+Z Edit Redo

- Redoes the last action previouly undone.

Ctrl+X Edit Cut

- Cuts the currently selected file(s).

Ctrl+C Edit Cut

- Copies the currently selected file(s).

Ctrl+V Edit Paste

- Pastes the currently copied/cut files to the current directory.

Ctrl+A Edit Select All

- Selects all files and folders in the current directory.

Ctrl+Shift+A Edit Invert Selection

- Inverts the currently selected files e.g. if you select ten files out of twenty, then the selected ten files will be swapped for the un-selected ten files. (If you have a better way of phrasing this please let me know as I am a little stuck here).

#### The View Menu

Ctrl++ View Zoom In

- Increases the size of icons in the workspace.

Ctrl+- View Zoom Out

- Decreases the size of icons in the workspace.

Ctrl+1 Ctrl+2 Ctrl+3 View View Mode...

- Changes the workspace view; Icons, Details, Previews.

View Sort...

- Changes the order in white files within a directory are sorted and wether they are descending; By Name, By Size, By Date | Descending.

Alt+. View Show Hidden Files

- Shows all the hidden files and sud-directories within the current directory.

F10 View Split View

- Enables and disables the split view workspace mode.

F5 View Reload

- Reloads the current directory.

F5 View Stop

- Stops loading/reading the contents of the current directory.

Ctrl+L Ctrl+B View Navigation Bar...

- Changes the address bar between the two modes; the line input mode and the breadcrumb mode.

F9 View Sidebar

- Enables and disables the sidebar.

View Adjust View Proprties...

- Opens the view properties dialogue.

#### The Go Menu

Alt+Up Go Up

- Changes to the directory above the current directory.

Backspace Go Back

- Changes to the previously viewed directory.

Alt+Right Go Forward

- Changes to the most recently viewed directory.

Alt+Home Go Home

- Changes to the users home directory e.g. /home/Peter/.

#### The Tools Menu

F4 Tools Open Terminal

- Opens a terminal already within the current directory.

Ctrl+F Tools Find File...

- Opens Kfind already within the current directory.

Ctrl+F Tools Show Filter Bar

- Enables and disables the filter bar.

/ Tools Show Filter Bar

- Enables and disables the filter bar.

Tools Compare Files

- Compare the currently selected files with Kompare.

#### The Settings Menu

/ Settings Hide Toolbar

- Hides and Shows the toolbar.

Settings Configure Shortcuts...

- Opens the shortcut configuration dialogue.

Settings Configure Toolbars...

- Opens the toolbar configuration dialogue.

Settings Configure Dolphin...

- Opens the &dolphin; configuration dialogue.

#### The Help Menu

&help.menu.documentation;

## Frequently asked Questions

How do I add my own custom service menus to &dolphin;?

Dolphin can use the majority of service menus created for Konqueror, however &dolphin; does impose one limitation on the service menus: Service menu entries that add them selves to the top level of the context menu will automatically be placed below the Actions sub-menu. This prevents that the context menu will get crowded.

To add a custom service menu to &dolphin; save the service menu to the &dolphin; service menu directory, this can be found in /home/house/.kde/share/apps/dolphin/servicemenus/. If the servicemenus sub-directory does not exist in the &dolphin; directory, then create the sub-directory and save the service menu to that directory. The next time the user launch &dolphin; the service menu will be available.

How do I make Dolphin my default file manager

To make &dolphin; the default file manager for &kde; from the &kde; control centre open the File Associations section via; KDE Components>File Associations. If the user adds &dolphin; to the list of applications for the directory mime type and make it the first choice, then &dolphin; will become the default application to open any directory with. The directory mime type can be found by expanding the inode section of Known Types.

To make &dolphin; the default file manager for the virtual directories &kde; creates e.g. system:/ then again in the File Associations section of the control centre expand the inode section of Known Types. Under the system_directory mime type, add &dolphin; to the list of applications, however instead of choosing &dolphin; from the kmenu, type the following in to the text box at the top; dolphin %u The virtual directories created by &kde; will then be opened by &dolphin; as default.

## Miscellaneous Questions

Does Dolphin intended to replace Konqueror?

&dolphin; is not intended to be a competitor to Konqueror: Konqueror acts as universal viewer being able to show HTML pages, text documents, directories and a lot more, whereas &dolphin; focuses on being only a file manager. This approach allows to optimize the user interface for the task of file management.

Will Dolphin be ported to Kde4?

Development of &dolphin; for Kde4 is scheduled to begin in December (2006). These are just intial ideas floating around at the moment between the developers. By the time the first alpha release of Kde4 is released, then &dolphin; devlopment should be well underway.

How can I get involved with the development of Dolphin?

The easiest way to get involved with &dolphin; is to drop the developers an email. If you email Peter Penz (Lead Developer/Project Leader), what you can do, how much time you can devote etc and he will let you know what you can do in the project. If you wish to contribute the documentation email Michael Austin (Documentation Leader). He can then fill you in on the situation e.g. what needs to be added/finished, the procedure for submitting documentation.

The email addresses of Peter Penz and Michael Austin can be found on the main page of the documentation, or in the Credits section.

Where do I submit bug reports to?

Bug reports should only be submitted for release versions of &dolphin;, please do not submit bug reports for the Subversion release of &dolphin; as this is expected to break due to it's constant development.

The official channel for submitting bug reports is via the &dolphin; tracker found at the &dolphin; Sourceforge page. Alternatively bug reports can be emailed to Peter Penz (email address is found on the main page or the credits section).

The &dolphin; bug tracker can be found here.

Where do I submit feature requests to?

The official channel for submitting feature requests is via the &dolphin; tracker. Alternatively feature requests can be emailed to Peter Penz (email address is found on the main page or the credits section).

As with the bug tracker, the feature request tracker can be found here below the link for the bug tracker.

## Credits and License

&dolphin;

Program copyright 2005,2006 Peter Penz peter.penz@gmx.at

Contributors:

- Cvetoslav Ludmiloff ludmiloff@gmail.com

- Stefan Monov logixoul@gmail.com

- Michael Austin tuxedup@users.sourceforge.net

- Orville Bennett obennett@hartford.edu

Documentation copyright 2005 Peter Penz peter.penz@gmx.at

Documentation copyright 2006 Orville Bennett obennett@hartford.edu

Documentation copyright 2006 Michael Austin tuxedup@users.sourceforge.net

&underFDL; &underGPL;

## Installation

### How to obtain &dolphin;

&dolphin; can be obtained from the &dolphin; home page.

&dolphin; can also be found on the kde-apps.org website.

The &dolphin; Sourceforge page also hosts the current release version, as well as the development version found on the &dolphin; Subversion Repository. The release version of&dolphin; can be found on it's Sourceforge page.

The development version of &dolphin; can be found at it's Subversion Repository.

### Requirements

In order to successfully use &dolphin; you need to at least have kdebase and kdelibs from &kde; 3.5 installed. &dolphin; may work on older versions of &kde;, however not all functions offered by &dolphin; may work.

In order to compile &dolphin; you will also require libqt2-mt-dev, libx11-dev, kdebase-dev, zlibg-dev and gcc.

Other &kde; libraries may also be required for some advanced features.

### Compilation and Installation

&install.compile.documentation;
&documentation.index;