# The &codeine; Handbook

## Introduction

&codeine; Screenshot Screenshot

&codeine; is a simple media player using the xine backend. &codeine; is a no frills media player that is especially usefull for short video clips where most other media players would just get in the way.

## Configuring &codeine;

## Using &codeine;

### Starting &codeine;

&codeine; can be started from the K-Menu, or from the command-line

#### From the K-Menu

Open the &kde; program menu by clicking on the big K icon on your panel. This will raise the program menu. Move your cursor up the menu to the Multimedia menu item. Choose &codeine;.

#### From the Command Line

You can start &codeine; by typing it's name on the command line. If you include a file name it will play the file.

    %codeine movie.avi

## Menu and Command Reference

### The Play Menu

Ctrl o Play Play File..

- Opens a file dialog to choose a file to play.

Play Play Audio-CD

- Plays an Audio-CD that is in your CD-Rom drive.

Play Play DVD

- Plays a DVD that is in your DVD drive.

Ctrl q Play Quit

- Quits &codeine;.

### The Settings Menu

Settings Toolbars Show Main Toolbar

- Enables or disable the main application toolbar.

Settings Toolbars Show DVD Toolbar

- Enables or disable the DVD toolbar.

Settings Configure Shortcuts...

- Allows you to configure the &codeine; shortcuts.

Settings Configure Toolbars...

- Allows you to configure the &codeine; toolbar options.

Settings Configure Video...

- Opens a dialog for configuring the video output settings. The settings include: contrast, brightness, saturation, and hue.

### The Help Menu

Help &codeine; Handbook

- Opens this help document.

Shift F1 Help What's This?

- Activates the "What's This?" mouse cursor allowing you to click an object to get a "What's this?" tooltip.

Help Report Bug...

- Starts the bug report tool dialog window.

Help About &codeine;

- Starts the About &codeine; dialog window.

Help About KDE

- Starts the About &kde; dialog window.

## Credits and License

### &codeine;

Program copyright 2004 Max B. Howell max.howell@methylblue.com

&underGPL;

### Documentation

Documentation copyright 2004 Mike Diehl madpenguin8@yahoo.com

&underFDL;

## Requirements

&codeine; requires the installation of some software packages. The required packages are listed below.

## Required:

- tdelibs

- xine-lib

## Optional:

- XTest Library

- xcb-util-keysyms

If you obtain these dependencies via a packaging system, you must also install the devel versions of these packages!

## Installation

### How to obtain &codeine;

&codeine; is now part of the TDE project, it can be found at: http://trinitydesktop.org/.

### Compilation and Installation

In order to compile and install &codeine; on your system, type the following in the base directory; distribution:

    % mkdir -p build
    % cd build
    % cmake ../
    % make
    % make install

Since &codeine; uses cmake you should have not trouble compiling it. Default options for cmake build are available in the INSTALL file.

&documentation.index;