From 0b2288da16894d45e95caf5c0f1f5cba3f17c2dd Mon Sep 17 00:00:00 2001 From: gregory guy Date: Sat, 13 Jun 2020 16:55:00 +0200 Subject: Conversion to the cmake building system. Signed-off-by: gregory guy --- doc/CMakeLists.txt | 1 + doc/en/CMakeLists.txt | 1 + doc/en/index.docbook | 437 +++++++++++++++++++++++++++++++++++++++++++++++++ doc/en/main.png | Bin 0 -> 12016 bytes doc/man/CMakeLists.txt | 5 + doc/man/codeine.1 | 94 +++++++++++ 6 files changed, 538 insertions(+) create mode 100644 doc/CMakeLists.txt create mode 100644 doc/en/CMakeLists.txt create mode 100644 doc/en/index.docbook create mode 100644 doc/en/main.png create mode 100644 doc/man/CMakeLists.txt create mode 100644 doc/man/codeine.1 (limited to 'doc') diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt new file mode 100644 index 0000000..6d0aa9f --- /dev/null +++ b/doc/CMakeLists.txt @@ -0,0 +1 @@ +tde_auto_add_subdirectories( ) diff --git a/doc/en/CMakeLists.txt b/doc/en/CMakeLists.txt new file mode 100644 index 0000000..ba3ef3e --- /dev/null +++ b/doc/en/CMakeLists.txt @@ -0,0 +1 @@ +tde_create_handbook( DESTINATION ${PROJECT_NAME} ) diff --git a/doc/en/index.docbook b/doc/en/index.docbook new file mode 100644 index 0000000..c056003 --- /dev/null +++ b/doc/en/index.docbook @@ -0,0 +1,437 @@ + + + Codeine"> + + + +]> + + + + + + + + + +The &codeine; Handbook + + + +Mike +Diehl + +
madpenguin8@yahoo.com
+ + + + + + + +2004 +Mike Diehl + + + +&FDLNotice; + + + +10/19/2004 +1 + + + + + +&codeine; is a simple media player for the TRINITY Desktop Environment. &codeine; is a front end to the xine multi-media player. + + + + + + +KDE +Codeine +xine +video +multi-media + + + + + + + +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 + + + + + + + + + + + + +Menu and Command Reference + + +The Play Menu + + + + +Ctrlo + +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. + + + + + + +Ctrlq + +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. + + + + + +ShiftF1 + +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; + + diff --git a/doc/en/main.png b/doc/en/main.png new file mode 100644 index 0000000..a13586e Binary files /dev/null and b/doc/en/main.png differ diff --git a/doc/man/CMakeLists.txt b/doc/man/CMakeLists.txt new file mode 100644 index 0000000..8512250 --- /dev/null +++ b/doc/man/CMakeLists.txt @@ -0,0 +1,5 @@ +INSTALL( + FILES ${PROJECT_NAME}.1 + DESTINATION ${MAN_INSTALL_DIR}/man1 + COMPONENT doc +) diff --git a/doc/man/codeine.1 b/doc/man/codeine.1 new file mode 100644 index 0000000..dac7494 --- /dev/null +++ b/doc/man/codeine.1 @@ -0,0 +1,94 @@ +'\" -*- coding: us-ascii -*- +.if \n(.g .ds T< \\FC +.if \n(.g .ds T> \\F[\n[.fam]] +.de URL +\\$2 \(la\\$1\(ra\\$3 +.. +.if \n(.g .mso www.tmac +.TH codeine 1 2006-05-12 "" "" +.SH NAME +codeine \- video player for TDE, designed to be as simple as possible +.SH SYNOPSIS +'nh +.fi +.ad l +\fBcodeine\fR \kx +.if (\nx>(\n(.l/2)) .nr x (\n(.l/5) +'in \n(.iu+\nxu +[ +\fB\fIQt-options\fB\fR +] [ +\fB\fTDE-options\fB\fR +] [ +\fB\fIURL|file\fB\fR +] [ +--play-dvd +] +'in \n(.iu-\nxu +.ad b +'hy +.SH DESCRIPTION +Video player with a different philosophy: Simple, uncluttered interface +.PP +Features: +.TP 0.2i +\(bu +Plays DVDs, VCDs, all video formats supported by Xine +.TP 0.2i +\(bu +Bundled with a simple web-page KPart +.TP 0.2i +\(bu +Starts quickly +.SH OPTIONS +All TDE and TQt +programs accept a some common command-line options. codeine has no +application-specific options. +.PP +.TP +\*(T<\fB\-\-help\fR\*(T> +Show help about options +.TP +\*(T<\fB\-\-help\-qt\fR\*(T> +Show TQt specific options +.TP +\*(T<\fB\-\-help\-tde\fR\*(T> +Show TDE specific options +.TP +\*(T<\fB\-\-help\-all\fR\*(T> +Show all options +.TP +\*(T<\fB\-\-author\fR\*(T> +Show author information +.TP +\*(T<\fB\-v\fR\*(T>, \*(T<\fB\-\-version\fR\*(T> +Show version information +.TP +\*(T<\fB\-\-license\fR\*(T> +Show license information +.TP +\*(T<\fB\-\-\fR\*(T> +Indicates end of options +.TP +\*(T<\fBURL|file\fR\*(T> +URL to or filename of a video +.TP +\*(T<\fB\-\-play\-dvd\fR\*(T> +Play DVD Video +.SH AUTHOR +Codeine was written by Max Howell <\*(T> +Homepage: +.URL "" https://mirror.git.trinitydesktop.org/gitea/TDE/codeine/ +.SH COPYRIGHT +This manual page was written by Achim Bohnet <\*(T>, +based on work of Anthony Mercatante +<\*(T>, for the +Debian system (but may be used by others). +Tom Albers <\*(T> documented the play-dvd part. +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU General Public License, +Version 2 or any later version published by the Free Software Foundation. +.PP +On Debian systems, the complete text of the GNU General Public Version 2 +License can be found in +\*(T<\fI/usr/share/common\-licenses/GPL\-2\fR\*(T>. -- cgit v1.2.3