Katana_mirror/kde-extraapps
1
0
Fork 0
mirror of https://bitbucket.org/smil3y/kde-extraapps.git synced 2025-02-23 10:22:52 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

removed docs

Browse source
This commit is contained in:
Ivailo Monev 2014-11-22 21:11:47 +00:00
parent aeae6f213a
commit 1ac7051989
343 changed files with 0 additions and 34951 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
ark/CMakeLists.txt
View file

@ -42,7 +42,6 @@ add_subdirectory(plugins)
add_subdirectory(kerfuffle)
add_subdirectory(part)
add_subdirectory(app)
add_subdirectory(doc)
if(${CMAKE_SOURCE_DIR} STREQUAL ${CMAKE_CURRENT_SOURCE_DIR})
message(STATUS "Supported MIME types: ${SUPPORTED_ARK_MIMETYPES}")

5
ark/doc/CMakeLists.txt
View file

@ -1,5 +0,0 @@
########### install files ###############
#
kde4_create_handbook(index.docbook INSTALL_DESTINATION ${HTML_INSTALL_DIR}/en SUBDIR ark)
kde4_create_manpage(man-ark.1.docbook 1 INSTALL_DESTINATION ${MAN_INSTALL_DIR})

BIN
ark/doc/ark-mainwindow.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 53 KiB

336
ark/doc/index.docbook
View file

@ -1,336 +0,0 @@
<?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
<!ENTITY kappname "&ark;">
<!ENTITY package "kdeutils">
<!ENTITY % addindex "IGNORE">
<!ENTITY % English "INCLUDE" > <!-- change language only here -->
]>
<book id="ark" lang="&language;">
<bookinfo>
<title>The &ark; Handbook</title>
<authorgroup>
<author>
&Matt.Johnston; &Matt.Johnston.mail;
</author>
<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>
<copyright>
<year>2000</year>
<holder>&Matt.Johnston;</holder>
</copyright>
<copyright>
<year>2004</year>
<holder>Henrique Pinto</holder>
</copyright>
<legalnotice>&FDLNotice;</legalnotice>
<date>2013-06-21</date>
<releaseinfo>2.19 &kde; (4.11)</releaseinfo>
<abstract>
<para>&ark; is an archive manager for &kde;.</para></abstract>
<keywordset>
<keyword>KDE</keyword>
<keyword>gzip</keyword>
<keyword>gunzip</keyword>
<keyword>tar</keyword>
<keyword>archive</keyword>
<keyword>zip</keyword>
<keyword>compression</keyword>
<keyword>7z</keyword>
<keyword>kdeutils</keyword>
<keyword>ark</keyword>
</keywordset>
</bookinfo>
<chapter id="introduction">
<title>Introduction</title>
<para>&ark; is a program for viewing, extracting, creating and modifying
archives.
&ark; can handle various archive formats such as
<command>tar</command>, <command>gzip</command>,
<command>bzip2</command>, <command>zip</command>, <command>rar</command>,
<command>7zip</command>, <command>xz</command>, <command>rpm</command>,
<command>cab</command> and <command>deb</command> (support for certain archive formats depend on
the appropriate command-line programs being installed).</para>
<screenshot>
<screeninfo>&ark;'s main window</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="ark-mainwindow.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>&ark;'s main window</phrase>
</textobject>
</mediaobject>
</screenshot>
</chapter>
<chapter id="using-ark">
<title>Using &ark;</title>
<sect1 id="ark-open">
<title>Opening Archives</title>
<para>To open an archive in &ark;, choose
<guimenuitem>Open...</guimenuitem> (<keycombo
action="simul">&Ctrl;<keycap>O</keycap></keycombo>) from the <guimenu>File</guimenu>
menu. You can also open archive files by dragging and dropping from
&konqueror; or &dolphin;. Archive files should be associated with &ark;, so you can
also <mousebutton>right</mousebutton> click a file in &konqueror; or &dolphin; and
select <guimenuitem>Open with &ark;</guimenuitem> to open it or select an extract action for this file.</para>
<para>If you have enabled the information panel in the <guimenu>Settings</guimenu> menu
additional information about the selected folders or files in the archive is displayed.</para>
</sect1>
<sect1 id="ark-work-files">
<title>Working with Files</title>
<para>Once an archive has been opened, you can perform various
operations on the files inside the archive. By
selecting a file and using the <guimenu>Action</guimenu>
menu, you can choose what you want to do:</para>
<itemizedlist>
<listitem>
<para><guimenuitem>Add File...</guimenuitem> will add files from your disk to the archive.</para>
</listitem>
<listitem>
<para><guimenuitem>Add Folder...</guimenuitem> will add folders from your disk to the archive.</para>
</listitem>
<listitem>
<para><guimenuitem>Delete</guimenuitem> (<keycap>Del</keycap>) will remove the currently
selected file(s) from the archive.</para>
</listitem>
<listitem>
<para><guimenuitem>Extract...</guimenuitem> (<keycombo
action="simul">&Ctrl;<keycap>E</keycap></keycombo>) opens a submenu with previously accessed folders,
and you can select to quick extract into any of them.</para>
</listitem>
<listitem>
<para><guimenuitem>Preview</guimenuitem> will open the file in the associated viewer for that file type.</para>
<!-- File Associations Embedding first item in Service Preference Order for a file type-->
</listitem>
</itemizedlist>
</sect1>
<sect1 id="ark-extract">
<title>Extracting Archives and Removing Files</title>
<para>Once an archive has been opened in &ark;, it can be extracted. To
quick extract files from an archive, you can select
<guisubmenu>Extract</guisubmenu> from the
<guimenu>Action</guimenu> menu. This opens a submenu with previously accessed folders,
and you can select to quick extract into any of them. Clicking on the check mark at
the right side of the <guibutton>Extract</guibutton> button in the toolbar performes the same action.
</para>
<para>
To open the <guilabel>Extract</guilabel> dialog click the <guibutton>Extract</guibutton>
button in the toolbar or use the shortcut <keycombo action="simul">&Ctrl;
<keycap>E</keycap></keycombo>.
This dialog allows you to select where you will extract files to. The default
location is the folder the archive is in.</para>
<para>You can specify to extract the files into a subfolder. The default name of this
subfolder is the first part of the archive name, but you can edit it to your needs.
If you want to preserve paths when extracting, select this option.
You may also choose to open the destination folder
in &konqueror; or &dolphin; or close &ark; once the extraction is complete.</para>
<para>If a file in the archive list is highlighted, you can
also select which files to extract:</para>
<itemizedlist>
<listitem>
<para><guimenuitem>Selected files only</guimenuitem> extracts only the files
which have been selected.</para>
</listitem>
<listitem>
<para><guimenuitem>All files</guimenuitem> extracts the entire contents of the
archive.</para>
</listitem>
</itemizedlist>
<para>To extract a single file from an archive, click on the filename and drag it to the
target folder
</para>
<!--FIXME extract several files by drag + drop? - only in basyskom branch-->
<para>Extracting files from an archive does not change the archive and its contents.
Use <menuchoice><guimenu>Action</guimenu><guimenuitem>Delete</guimenuitem></menuchoice>
(<keysym>Del</keysym>) for this task.
</para>
</sect1>
<sect1 id="ark-create">
<title>Creating Archives and Adding Files</title>
<para>To create a new archive in &ark;, choose
<guimenuitem>New</guimenuitem> from the <guimenu>File</guimenu>
menu.</para>
<para>You can then type the name of the archive, with the appropriate
extension (<literal role="extension">tar.gz</literal>, <literal
role="extension">zip</literal>, <literal role="extension">bz2</literal>
&etc;) or select a supported format in the <guilabel>Filter</guilabel> combo box
and check the <guilabel>Automatically select filename extension</guilabel> option.
To add files to the archive, choose <guimenuitem>Add
File...</guimenuitem> from the <guimenu>Action</guimenu> menu. If you
want to add an entire folder to an archive, choose <guimenuitem>Add
Folder...</guimenuitem> from the <guimenu>Action</guimenu> menu.</para>
<para>An alternative way to add files to the archive is to drag one or more files
from &konqueror;, &dolphin; or the desktop into the main &ark; window, and it will
be added to the current archive.</para>
</sect1>
</chapter>
<chapter id="ark-in_filemanager">
<title>Using &ark; in the Filemanager</title>
<para>Clicking with the &RMB; on an archive in a filemanager like &dolphin; or &konqueror;
displays a context menu with an item <guimenuitem>Open with Ark</guimenuitem>.
The menu has these additional items to extract an archive using &ark;:
</para>
<itemizedlist>
<listitem>
<para><guimenuitem>Extract Archive Here, Autodetect Subfolder</guimenuitem> creates a
subfolder in the folder with the archive and extracts the folders and files into it.</para>
</listitem>
<listitem>
<para><guimenuitem>Extract Archive To...</guimenuitem> works like in &ark;.</para>
</listitem>
<listitem>
<para><guimenuitem>Extract Archive Here</guimenuitem> extracts the content of the archive into same folder.</para>
</listitem>
</itemizedlist>
<para>
&dolphin;'s or &konqueror;'s context menu for a selection displays these actions in the
<guimenu>Compress</guimenu> submenu:
</para>
<itemizedlist>
<listitem>
<para><guimenuitem>Here</guimenuitem> creates a Tar archive (gzip-compressed) in the current folder
with the extension <filename class="extension">.tar.gz</filename>.</para>
</listitem>
<listitem>
<para><guimenuitem>As ZIP Archive</guimenuitem>, <guimenuitem>As RAR Archive</guimenuitem>
or <guimenuitem>As ZIP/TAR Archive</guimenuitem> creates these archive types in the current folder.</para>
</listitem>
<listitem>
<para><guimenuitem>Compress To...</guimenuitem> opens a dialog where you can select folder, name and archive type.</para>
</listitem>
</itemizedlist>
</chapter>
<chapter id="batchmode">
<title>Advanced Batch Mode</title>
<para>&ark; has an advanced batch mode to manage archives without launching a &GUI; interface.
This mode allows you to extract or create archives and add files to them.</para>
<para>The batch mode is documented in <ulink url="man:/ark">&ark;'s man page</ulink>.
</para>
</chapter>
<chapter id="credits">
<title>Credits and License</title>
<para>&ark; is Copyright &copy; 1997-2008, The Various &ark; Developers</para>
<itemizedlist>
<title>Authors:</title>
<listitem><para>Raphael Kubo da Costa
<email>rakuco@FreeBSD.org</email></para></listitem>
<listitem><para>Harald Hvaal
<email>haraldhv@stud.ntnu.no</email></para></listitem>
<listitem><para>Helio Chissini de Castro
<email>helio@conectiva.com.br</email></para></listitem>
<listitem><para>Georg Robbers
<email>Georg.Robbers@urz.uni-hd.de</email></para></listitem>
<listitem><para>Henrique Pinto
<email>henrique.pinto@kdemail.net</email></para></listitem>
<listitem><para>Roberto Selbach Teixeira
<email>maragato@kde.org</email></para></listitem>
<listitem><para>Robert Palmbos
<email>palm9744@kettering.edu</email></para></listitem>
<listitem><para>Francois-Xavier Duranceau
<email>duranceau@kde.org</email></para></listitem>
<listitem><para>Corel Corporation (author: Emily Ezust)
<email>emilye@corel.com</email></para></listitem>
<listitem><para>Corel Corporation (author: Michael Jarrett)
<email>michaelj@corel.com</email></para></listitem>
</itemizedlist>
<para>Documentation Copyright &copy; 2000 &Matt.Johnston;
&Matt.Johnston.mail;</para>
<para>Documentation updated for &kde; 3.3 by Henrique Pinto
<email>henrique.pinto@kdemail.net</email>.</para>
<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
&underFDL;
&underGPL;
</chapter>
<appendix id="installation">
<title>Installation</title>
<sect1 id="getting-ark">
<title>How to obtain &ark;</title>
&install.intro.documentation;
</sect1>
<sect1 id="requirements">
<title>Requirements</title>
<para>In order to successfully use &ark;, you need &kde;
4. &GNU; <command>tar</command> and a recent
<command>gzip</command> are also needed if you want &ark; to handle tar archives. To handle other
file formats, you need the appropriate command line programs, such as <command>bzip2</command>,
<command>zip</command>, <command>unzip</command>, <command>ar</command>, <command>rar</command>,
<command>7zip</command>, <command>xz</command>, <command>rpm</command>,
<command>cab</command> and <command>deb</command>.</para>
</sect1>
<sect1 id="compilation">
<title>Compilation and Installation</title>
&install.compile.documentation;
</sect1>
</appendix>
&documentation.index;
</book>
<!--
Local Variables:
mode: sgml
sgml-minimize-attributes: nil
sgml-general-insert-case: lower
End:
-->

208
ark/doc/man-ark.1.docbook
View file

@ -1,208 +0,0 @@
<?xml version="1.0" ?>
<!DOCTYPE refentry PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
<!ENTITY kappname "&ark;">
<!ENTITY % English "INCLUDE">
]>
<refentry lang="&language;">
<refentryinfo>
<title>&kde; User's Manual</title>
<author><firstname>Lauri</firstname><surname>Watts</surname> <contrib>Initial version of &ark; man page.</contrib></author>
<author><firstname>Raphael</firstname><surname>Kubo da Costa</surname> <contrib>Update &ark; man page.</contrib></author>
<date>2013-08-23</date>
<releaseinfo>2.19 (&kde; 4.11)</releaseinfo>
<productname>K Desktop Environment</productname>
</refentryinfo>
<refmeta>
<refentrytitle><command>ark</command></refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname><command>ark</command></refname>
<refpurpose>&kde; archiving tool</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>ark</command>
<group choice="opt"><option>-b</option></group>
<group choice="opt"><option>-a</option></group>
<group choice="opt"><option>-e</option></group>
<group choice="opt"><option>-c</option></group>
<group choice="opt"><option>-f</option> <replaceable>
suffix</replaceable></group>
<group choice="opt"><option>-p</option></group>
<group choice="opt"><option>-t</option> <replaceable>
file</replaceable></group>
<group choice="opt"><option>-d</option></group>
<group choice="opt"><option>-o</option> <replaceable>
directory</replaceable></group>
<arg choice="opt">&kde; Generic Options</arg>
<arg choice="opt">&Qt; Generic Options</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>&ark; is a program for managing various compressed file formats
within &kde;. Archives can be viewed, extracted, created
and modified with &ark;. The program can handle various
formats such as <application>tar</application>,
<application>gzip</application>, <application>bzip2</application>,
<application>zip</application>, <application>rar</application>
(when the appropriate libraries or command-line programs are
installed).</para>
</refsect1>
<refsect1>
<title>Operation modes</title>
<para>&ark; can be used either as a stand-alone &GUI; program as well as a
command-line program in order to perform some specific tasks.</para>
<para>If invoked without the -b (--batch) or -c (--add) options, &ark; is started
as a normal &GUI; program.</para>
<para>When the -b (--batch) option is used, &ark; can be used to extract the
contents of one or more files directly from the command-line, without
launching its &GUI;.</para>
<para>When the -c (--add) option is used, &ark; prompts for files that should
be added to a new archive or to an existing archive.</para>
<para></para>
<para></para>
</refsect1>
<refsect1>
<title>Options</title>
<variablelist>
<varlistentry>
<term><option>-d, --dialog</option></term>
<listitem>
<para>Show a dialog for specifying the options for a batch or add operation.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-o, --destination
<replaceable>directory</replaceable></option></term>
<listitem><para>Default the extraction directory to <replaceable>directory</replaceable>.
If not passed, the current path is used.</para>
</listitem>
</varlistentry>
</variablelist>
<refsect2>
<title>Options for adding files</title>
<variablelist>
<varlistentry>
<term><option>-c, --add</option></term>
<listitem>
<para>Query the user for an archive filename and add specified files to it.
Quit when finished.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-t, --add-to <replaceable>filename</replaceable></option></term>
<listitem>
<para>Add the specified files to <replaceable>filename</replaceable>. Create archive
if it does not exist. Quit when finished.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-p, --changetofirstpath</option></term>
<listitem>
<para>Change the current directory to the first entry and add all other entries relative
to this one.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-f, --autofilename <replaceable>suffix</replaceable></option></term>
<listitem>
<para>Automatically choose a filename, with the selected <replaceable>suffix</replaceable>
(for example rar, tar.gz, zip or any other supported types).</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2>
<title>Options for batch extraction</title>
<variablelist>
<varlistentry>
<term><option>-b, --batch</option></term>
<listitem>
<para>Use the batch interface instead of the usual dialog. This option is implied
if more than one url is specified.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-e, --autodestination</option></term>
<listitem>
<para>The destination argument will be set to the path of the first file
supplied.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-a, --autosubfolder</option></term>
<listitem>
<para>Archive contents will be read, and if detected to not be a single folder archive,
a subfolder by the name of the archive will be created.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<refsect1>
<title>Examples</title>
<variablelist>
<varlistentry>
<term><userinput><command>ark</command> <option>--batch</option>
<replaceable>archive.tar.bz2</replaceable></userinput></term>
<listitem>
<para>Will extract <replaceable>archive.tar.bz2</replaceable> into the current directory
without showing any &GUI;.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><userinput><command>ark</command> <option>-b</option> <option>-d</option>
<replaceable>archive.tar.bz2</replaceable> <replaceable>archive2.zip</replaceable></userinput></term>
<listitem>
<para>Will first show an extraction options dialog and then extract both
<replaceable>archive.tar.bz2</replaceable> and <replaceable>archive2.zip</replaceable>
into the directory chosen in the dialog.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><userinput><command>ark</command> <option>--add-to</option>
<replaceable>my-archive.zip</replaceable> <replaceable>photo1.jpg</replaceable>
<replaceable>text.txt</replaceable></userinput></term>
<listitem>
<para>Will create <replaceable>my-archive.zip</replaceable> if does not exist and
then add <replaceable>photo1.jpg</replaceable> and <replaceable>text.txt</replaceable> to it.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Authors</title>
<para>&ark; is currently maintained by &Harald.Hvaal; &Harald.Hvaal.mail;
and &Raphael.Kubo.da.Costa; &Raphael.Kubo.da.Costa.mail;.</para>
<para>This man page was first written by &Lauri.Watts;
&Lauri.Watts.mail; in 2005 for &kde; 3.4, and was later updated in 2009 by
&Raphael.Kubo.da.Costa; &Raphael.Kubo.da.Costa.mail;.</para>
</refsect1>
</refentry>

1
dragon/CMakeLists.txt
View file

@ -21,4 +21,3 @@ configure_file(config.h.cmake ${CMAKE_CURRENT_BINARY_DIR}/config.h)
add_subdirectory( src/app )
add_subdirectory( misc )
add_subdirectory( doc )

2
dragon/doc/CMakeLists.txt
View file

@ -1,2 +0,0 @@
kde4_create_handbook(index.docbook INSTALL_DESTINATION ${HTML_INSTALL_DIR}/en/ SUBDIR dragonplayer)
kde4_create_manpage(man-dragon.1.docbook 1 INSTALL_DESTINATION ${MAN_INSTALL_DIR})

208
dragon/doc/index.docbook
View file

@ -1,208 +0,0 @@
<?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
<!ENTITY kappname "&dragonplayer;">
<!ENTITY dragonplayer "<application>Dragon Player</application>">
<!ENTITY % addindex "IGNORE">
<!ENTITY % English "INCLUDE"><!-- change language only here -->
]>
<book id="dragon" lang="&language;">
<bookinfo>
<title>The &dragonplayer; Handbook</title>
<authorgroup>
<author>
<firstname>Mike</firstname>
<surname>Diehl</surname>
<affiliation>
<address><email>madpenguin8@yahoo.com</email></address>
</affiliation>
</author>
<author>
<firstname>Ian</firstname>
<surname>Monroe</surname>
<affiliation>
<address><email>imonroe@kde.org</email></address>
</affiliation>
</author>
<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>
<copyright>
<year>2004</year>
<holder>Mike Diehl</holder>
</copyright>
<copyright>
<year>2007</year>
<holder>Ian Monroe</holder>
</copyright>
<legalnotice>&FDLNotice;</legalnotice>
<date>2013-05-11</date>
<releaseinfo>2.0 (&kde; 4.11)</releaseinfo>
<abstract>
<para>
&dragonplayer; is a simple video player for &kde;.
</para>
</abstract>
<keywordset>
<keyword>KDE</keyword>
<keyword>Codeine</keyword>
<keyword>Phonon</keyword>
<keyword>Dragon</keyword>
<keyword>Player</keyword>
<keyword>Dragon Player</keyword>
<keyword>video</keyword>
<keyword>multi-media</keyword>
</keywordset>
</bookinfo>
<chapter id="introduction">
<title>Introduction</title>
<screenshot>
<screeninfo>&dragonplayer; Screenshot</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="main.png" format="PNG"/></imageobject>
<textobject><phrase>Screenshot</phrase></textobject>
</mediaobject>
</screenshot>
<para>
&dragonplayer; is a simple media player using &phonon; technology. &dragonplayer; is a no frills media player that excels at playing DVDs and movie files without getting in your way.
</para>
</chapter>
<chapter id="select-media">
<title>Select a Media</title>
<para>If you start &dragonplayer; from the application launcher or use <guibutton>Play Media</guibutton>
(<keycombo action="simul">&Ctrl;<keycap>O</keycap></keycombo>) from the toolbar or from the <guimenu>Play</guimenu>
menu this window is displayed:</para>
<screenshot>
<screeninfo>Play Media</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="playmedia.png" format="PNG"/></imageobject>
<textobject><phrase>Play Media</phrase></textobject>
</mediaobject>
</screenshot>
<para>There are three ways to play a video file:</para>
<para><guibutton>Play File</guibutton> opens the file dialog and allows you to select a file to play.</para>
<para><guibutton>Play Disc</guibutton> to play a &CD; or DVD.</para>
<para><guibutton>Play Stream</guibutton> opens a dialog to enter an address of some <ulink url="http://en.wikipedia.org/wiki/Streaming_media">multimedia stream</ulink>.</para>
<para>Double click on an entry in the play list with recently opened files to start playing it.
The context menu of the play list shows actions to remove a selected entry or clear the whole play list.
Any file you played will be automatically added to the list.</para>
</chapter>
<chapter id="features">
<title>Features</title>
<variablelist>
<varlistentry>
<term>
<guimenuitem>Full Screen Mode</guimenuitem>
</term>
<listitem><para>
While playing a movie, you can enter full screen mode. This uses the entire monitor to display the movie.
Moving the mouse shows a toolbar at the top of the screen in full screen mode.
Toggle the full screen mode using the <guimenu>Settings</guimenu> menu, the action in the toolbar, double click on the video or use the shortcut
<keycap>F</keycap>.
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<guimenuitem>Video Settings</guimenuitem>
</term>
<listitem><para>Select this action from the <guimenu>Settings</guimenu> menu to adjust <guilabel>Brightness</guilabel>, <guilabel>Contrast</guilabel>, <guilabel>Hue</guilabel> and <guilabel>Saturation</guilabel>.
These settings are stored together with the playback position for each video file. This enables you resume playing a video with the selected video settings and the position where you stopped playing.
</para></listitem>
</varlistentry>
<varlistentry>
<term>
Navigation
</term>
<listitem><para>The shortcut <keycap>PgUp</keycap> brings you 10% forward, <keycap>PgDown</keycap> 10% backward.
Use <menuchoice><guimenu>Settings</guimenu> <guimenuitem>Menu Toggle</guimenuitem></menuchoice> (<keycap>R</keycap>) to switch to the video menu and select another chapter to play.
<menuchoice><guimenu>Play</guimenu><guimenuitem>Play/Pause</guimenuitem></menuchoice> (<keysym>Space</keysym>) allows you to pause and resume playback if a movie is loaded. <menuchoice><guimenu>Play</guimenu><guimenuitem>Stop</guimenuitem></menuchoice> (<keycap>S</keycap>) stops playback.
Go to the previous or next chapter of a video with <guimenuitem>Previous Chapter</guimenuitem> (<keycap>,</keycap>) or <guimenuitem>Next Chapter</guimenuitem> (<keycap>.</keycap>) from the <guimenu>Play</guimenu> menu.
</para></listitem>
</varlistentry>
<varlistentry>
<term>
<guimenuitem>Volume control</guimenuitem>
</term>
<listitem><para>If you play videos with a hidden toolbar, you can use the shortcut <keycap>M</keycap> to mute or unmute the sound; and the shortcut <keycap>V</keycap> to toggle the display of the volume slider right to the video.
</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Settings</guimenu>
<guisubmenu>Aspect Ratio</guisubmenu>
</menuchoice></term>
<listitem><para><action>This menu lets you pick the aspect ratio of the playing movie. The aspect ratio is width of movie compared to the height.</action></para></listitem>
</varlistentry>
<varlistentry>
<term>
<guisubmenu>Subtitles</guisubmenu> and <guisubmenu>Audio Channels</guisubmenu>
</term>
<listitem><para>
These menu items from the <guimenu>Settings</guimenu> menu are active if there are any subtitles or additional audio channels (&eg; with different languages) available from the currently playing movie. Note that it may take a few seconds of playback before the subtitles or audio channels become available.
</para></listitem>
</varlistentry>
</variablelist>
</chapter>
<chapter id="credits">
<title>Credits and License</title>
<para>
&dragonplayer;
</para>
<para>Program copyright 2004 Max B. Howell <email>max.howell@methylblue.com</email></para>
<para>Program copyright 2007 Ian A. Monroe <email>imonroe@kde.org</email></para>
<para>
Documentation copyright 2004 Mike Diehl <email>madpenguin8@yahoo.com</email>
</para>
<para>
Documentation copyright 2007 Ian Monroe <email>imonroe@kde.org</email>
</para>
<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
&underFDL;
&underGPL;
</chapter>
&documentation.index;
</book>
<!--
Local Variables:
mode: sgml
sgml-minimize-attributes:nil
sgml-general-insert-case:lower
sgml-indent-step:0
sgml-indent-data:nil
End:
-->

BIN
dragon/doc/main.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 138 KiB

124
dragon/doc/man-dragon.1.docbook
View file

@ -1,124 +0,0 @@
<?xml version="1.0" ?>
<!DOCTYPE refentry PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
<!ENTITY % English "INCLUDE">
]>
<refentry lang="&language;">
<refentryinfo>
<title>KDE User's Manual</title>
<author><firstname>Praveen</firstname><surname>Arimbrathodiyil</surname>
<contrib>Dragon Player man page.</contrib>
<email>pravi.a@gmail.com</email></author>
<date>2012-03-16</date>
<productname>K Desktop Environment</productname>
</refentryinfo>
<refmeta>
<refentrytitle><command>dragon</command></refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>dragon</refname>
<refpurpose>a video player that has a usability focus</refpurpose>
</refnamediv>
<!-- body begins here -->
<refsynopsisdiv id='synopsis'>
<cmdsynopsis>
<command>dragon</command> <arg choice="opt"><replaceable>Qt-options</replaceable></arg>
<arg choice="opt"><replaceable>KDE-options</replaceable></arg>
<arg choice="opt"><replaceable>URL</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 id="description"><title>Description</title>
<para><command>dragon</command>
player plays audio and video in different formats.</para>
</refsect1>
<refsect1 id="generic_options"><title>Generic Options</title>
<variablelist>
<varlistentry>
<term><option>--help</option></term>
<listitem>
<para>Show help about options.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--help-qt</option></term>
<listitem>
<para>Show Qt specific options.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--help-kde</option></term>
<listitem>
<para>Show KDE specific options.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--help-all</option></term>
<listitem>
<para>Show all options.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--author</option></term>
<listitem>
<para>Show author information.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-v, --version</option></term>
<listitem>
<para>Show version information.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--license</option></term>
<listitem>
<para>Show license information.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--</option></term>
<listitem>
<para>End of options.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="options"><title>Options</title>
<variablelist>
<varlistentry>
<term><option>--play-dvd</option></term>
<listitem>
<para>Play DVD Video.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="feedback"><title>Feedback</title>
<para>On IRC, irc.freenode.net #dragonplayer or via email, imonroe@kde.org or on the web, &lt;<ulink url="http://multimedia.kde.org">http://multimedia.kde.org</ulink>&gt;</para>
</refsect1>
<refsect1>
<title>See Also</title>
<para>More detailed user documentation is available from <ulink
url="help:/dragonplayer">help:/dragonplayer</ulink>
(either enter this <acronym>URL</acronym> into &konqueror;, or run
<userinput><command>khelpcenter</command>
<parameter>help:/dragonplayer</parameter></userinput>).</para>
</refsect1>
<refsect1 id="copyright"><title>Copyright</title>
<para>Copyright &copy; 2006 Max Howell</para>
<para>Copyright &copy; 2007 Ian Monroe</para>
<para>License: GNU General Public Version 2 &lt;<ulink url="http://www.gnu.org/licenses/gpl-2.0.html">http://www.gnu.org/licenses/gpl-2.0.html</ulink>&gt;</para>
</refsect1>
</refentry>

BIN
dragon/doc/playmedia.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 49 KiB

1
gwenview/CMakeLists.txt
View file

@ -69,6 +69,5 @@ add_subdirectory(icons)
add_subdirectory(images)
add_subdirectory(cursors)
add_subdirectory(color-schemes)
add_subdirectory(doc)
configure_file(config-gwenview.h.cmake ${CMAKE_CURRENT_BINARY_DIR}/config-gwenview.h)

4
gwenview/doc/CMakeLists.txt
View file

@ -1,4 +0,0 @@
########### install files ###############
#
#
kde4_create_handbook(index.docbook INSTALL_DESTINATION ${HTML_INSTALL_DIR}/en SUBDIR gwenview)

BIN
gwenview/doc/browse_mode.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 287 KiB

BIN
gwenview/doc/fullscreen-browse.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 358 KiB

BIN
gwenview/doc/fullscreen-view.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 623 KiB

BIN
gwenview/doc/importer-picking-root-folder.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 224 KiB

BIN
gwenview/doc/importer.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 233 KiB

713
gwenview/doc/index.docbook
View file

@ -1,713 +0,0 @@
<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN"
"dtd/kdex.dtd" [
<!ENTITY kappname "<application>Gwenview</application>">
<!ENTITY package "kdegraphics">
<!ENTITY % addindex "IGNORE">
<!ENTITY % English "INCLUDE"><!-- change language only here -->
]>
<book id="gwenview" lang="&language;">
<title>Gwenview User Manual</title>
<bookinfo>
<authorgroup>
<author>
<firstname>Aurélien</firstname>
<surname>Gâteau</surname>
<affiliation><address><email>agateau@kde.org</email></address></affiliation>
</author>
<author>
<firstname>Christopher</firstname><surname>Martin</surname>
<affiliation><address><email>chrsmrtn@debian.org</email></address></affiliation>
</author>
<author>
<firstname>Henry</firstname>
<surname>de Valence</surname>
<affiliation><address><email>hdevalence@gmail.com</email></address></affiliation>
</author>
<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>
<copyright>
<year>2005</year>
<holder>Aurélien Gâteau</holder>
</copyright>
<copyright>
<year>2008</year>
<holder>Henry de Valence</holder>
</copyright>
<legalnotice>&FDLNotice;</legalnotice>
<date>2014-03-06</date>
<releaseinfo>4.13 (&kde; 4.13)</releaseinfo>
<abstract>
<para>&kappname; is an image viewer for &kde;.</para>
</abstract>
<keywordset>
<keyword>KDE</keyword>
<keyword>image</keyword>
<keyword>viewer</keyword>
<keyword>artist</keyword>
<keyword>photo</keyword>
<keyword>picture</keyword>
</keywordset>
</bookinfo>
<!--FIXME Read devels blog on http://agateau.com/
-->
<chapter id="introduction">
<title>Introduction</title>
<sect1 id="what-is-gwenview">
<title>What is &kappname;</title>
<para>
&kappname; is a fast and easy to use image and video viewer for KDE.
</para>
<para>
Gwenview features two main modes: Browse and View. Both modes can be used
in a normal application window and Full Screen. Browse Mode
lets you navigate through your computer showing thumbnails of your images, View
Mode lets you view images one at a time, and Full Screen lets you make quick
slideshows. There is also a start screen that displays a list of recently opened
folders and &URL;s as well as your places and tags.
</para>
<para>Image loading is handled by the Qt library, so &kappname; supports all
image formats your Qt installation supports. &kappname; correctly displays images
with an alpha channel (transparency) as well as animations.</para>
<para>&kappname; supports the displaying and editing of EXIF comments in JPEG
images. Lossless JPEG transforms such as rotations and mirroring are also supported.</para>
<para>&kappname; can read embedded color profiles from PNG and JPEG files.
It can use the image color profile together with the display color profile
to output correct colors on the screen.</para>
</sect1>
</chapter>
<chapter id="interface">
<title>The Interface</title>
<sect1 id='start_page'><title>Start Page</title>
<para>The start page lists recently opened folders and &URL;s on the left side,
and your places and tags on the right side.</para>
<screenshot>
<screeninfo>Start Page Screenshot</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="start-page.png" format="PNG" />
</imageobject>
</mediaobject>
</screenshot>
</sect1>
<sect1 id='image_operations'><title>Image Operations</title>
<para>&kappname; has a few features which are available in both Browse, View, and
Full Screen view. &kappname; has the capability to do basic alteration of your
images.</para>
<itemizedlist>
<listitem><para>Rotate: A rotate operation will rotate the image either to the left
or to the right, depending on whether you do
<menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>R</keycap></keycombo>
</shortcut>
<guimenu>Edit</guimenu>
<guimenuitem>Rotate Right</guimenuitem>
</menuchoice>
or
<menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>L</keycap></keycombo>
</shortcut>
<guimenu>Edit</guimenu>
<guimenuitem>Rotate Left</guimenuitem>
</menuchoice> </para></listitem>
<listitem><para>
<menuchoice>
<guimenu>Edit</guimenu>
<guimenuitem>Mirror</guimenuitem>
</menuchoice>:
This operation will reflect the image along the vertical
axis, as if you were seeing it in a mirror.</para></listitem>
<listitem><para>
<menuchoice>
<guimenu>Edit</guimenu>
<guimenuitem>Flip</guimenuitem>
</menuchoice>:
This operation will reflect the image upside-down (a
reflection along the horizontal axis)</para></listitem>
<listitem><para>
<menuchoice>
<shortcut>
<keycombo action="simul">&Shift;<keycap>R</keycap></keycombo>
</shortcut>
<guimenu>Edit</guimenu>
<guimenuitem>Resize</guimenuitem>
</menuchoice>:
This operation will allow you to shrink or expand the image. Note that if you
increase the size of an image, it may appear
blurry and/or pixelated.</para></listitem>
<!-- Crop + Red Eye Reduction are discussed in View mode sect-->
</itemizedlist>
<para>These actions are also available on the <guilabel>Operations</guilabel> tab of the sidebar.</para>
<para>If you have edited one or more images a bar with additional actions is displayed at the top of the image.
You can undo or redo your changes, go to the previous or next modified image and there are three options to save
the changed images.
</para>
<screenshot>
<screeninfo>Actions bar for modified images</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="modified-bar.png" format="PNG" />
</imageobject>
</mediaobject>
</screenshot>
<!--FIXME all actions also available context menus, where to add that info -->
<tip><para>If you have installed the Kipi Plugins, a <guimenu>Plugins</guimenu>
menu will be available that will allow you to perform many additional operations
on your images. For more information, see the
<ulink url="help:kipi-plugins">Kipi Plugins documentation</ulink>.</para></tip>
</sect1>
<sect1 id='browse_mode'><title>Browse Mode</title>
<para>When in Browse Mode, you can easily navigate through your files and folders.
The preview window shows thumbnails of the images in the current folder, as
well as subfolders. </para>
<screenshot>
<screeninfo>Browse Mode Screenshot</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="browse_mode.png" format="PNG" />
</imageobject>
</mediaobject>
</screenshot>
<para>
Moving the mouse over an image shows buttons to select or rotate the image as well as
a button to enter Fullscreen Mode.
Modified images are indicated by an icon down right, click it to save the changed image.
Clicking on an image takes you into View
Mode. You may select multiple images and switch to View Mode to view them side-by-side.</para>
<para>The slider at the bottom right allows you to change the size of the images.
You can also filter the images by filename, date, tag or rating using the box on the
lower left. The toolbar appears in both Browse mode as well as View
mode and contains the most commonly used actions. </para>
<itemizedlist>
<listitem><para><guiicon>Start Page</guiicon>: Open the start page.</para></listitem>
<listitem><para><guiicon>Browse</guiicon>: Switches to Browse Mode.</para></listitem>
<listitem><para><guiicon>View</guiicon>: Switches to View Mode.</para></listitem>
<listitem><para><guiicon>Full Screen</guiicon>: Switches to Full Screen Mode.</para></listitem>
<listitem><para><guiicon>Previous</guiicon>: Clicking this icon will go
to the previous image in the folder.</para></listitem>
<listitem><para><guiicon>Next</guiicon>: Clicking this button will go to
the next image in the folder.</para></listitem>
<listitem><para>Rotate Left/Right: Same as discussed in
Image Operations</para></listitem>
<!--FIXME missing Share -->
</itemizedlist>
</sect1>
<sect1 id='view_mode'><title>View Mode</title>
<para>View Mode displays full-size images. The same
<link linkend="sidebar">sidebar</link> available in Browse Mode is displayed on
the left. At the bottom, there is the Thumbnail Bar, which allows you to scroll
through the images in the current folder. The Thumbnail Bar can be minimized by
clicking on the <guibutton>Thumbnail Bar</guibutton> button. Clicking again will
restore it. To change the size of the thumbnails move the splitter with the &LMB;.</para>
<para>View Mode supports viewing multiple images side-by-side. You may select
multiple images in Browse Mode before switching to View Mode, or you may click the
<guibutton>+</guibutton> button that appears when hovering over images in the
Thumbnail Bar to add a pane displaying that image. A <guibutton>-</guibutton> will
then appear that will permit you to remove its pane.</para>
<para>When multiple images are displayed, a small toolbar appears below each image
that permits you to delete the image or remove its pane. You may perform zoom operations
independently for each image, or synchronize them. Toggle this by checking the
<guilabel>Synchronize</guilabel> to the left of the zoom slider or by pressing
<keycombo action="simul">&Ctrl;<keycap>Y</keycap></keycombo>. You can switch images
by clicking on their pane, or using your keyboard. To switch to the image on the
right, press <keycombo action="simul">&Tab;</keycombo>. To switch to the image
on the left, press <keycombo action="simul">&Shift;&Tab;</keycombo>.</para>
<screenshot>
<screeninfo>View Mode Screenshot</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="view_mode.png" format="PNG" />
</imageobject>
</mediaobject>
</screenshot>
<para>The slider at the bottom right controls the zoom of the image. The
<guibutton>Fit</guibutton> button and the <guibutton>100%</guibutton>
button are next to the zoom slider and are two preset zoom levels. The
<guibutton>Fit</guibutton> button zooms the current image to fit the size
of the window, and the <guibutton>100%</guibutton> button zooms the image to
the actual pixel size. The shortcut <keycap>F</keycap> toggles between both view modes.</para>
<para>When an image is in zoom-to-fit mode, you can go to the previous and next
image with the arrow keys. When you zoom in, arrow keys are used to scroll the image.
This is very similar to the behavior provided by phones or digital cameras.</para>
<para>When an image is zoomed in, a bird-eye view appears and lets you scroll
the image using the mouse and the arrow keys. The bird-eye view automatically hides
itself after a short delay, showing back only while zooming or scrolling.</para>
<tip><para>You can start directly in View mode by starting &kappname; from a
context menu like <guimenuitem>Open With</guimenuitem> in another program or by
launching it from the command line with an image as an argument.</para> </tip>
<para>The following additional image operations are available only in View Mode:</para>
<itemizedlist>
<listitem><para>
<menuchoice>
<shortcut>
<keycombo action="simul">&Shift;<keycap>C</keycap></keycombo>
</shortcut>
<guimenu>Edit</guimenu>
<guimenuitem>Crop</guimenuitem>
</menuchoice>:
This operation lets you discard parts of the image you don't want.
</para>
<para>
You can access the advanced cropping parameters by ticking <guilabel>Advanced settings</guilabel> check box on the bottom popup pane. Use the corresponding fields to tune up the cropping operation.
</para>
<para>
It is also possible to adjust the cropped area by dragging the gray square handles on the borders of the image. You can move the cropped area by clicking and holding the &LMB; and drag it with the mouse pointer.
</para>
<para>
Press the <guibutton>Crop</guibutton> button to see the results when you are ready. Use the upper popup pane to save the results or undo/redo the operation.
</para></listitem>
<listitem><para>
<menuchoice>
<guimenu>Edit</guimenu>
<guimenuitem>Red Eye Reduction</guimenuitem>
</menuchoice>:
This operation reduces the "red eye" effect commonly found in photographs taken
with a flash camera.
</para></listitem>
</itemizedlist>
</sect1>
<sect1 id='fullscreen_mode'>
<title>Full Screen Modes</title>
<para>Access Full Screen by pressing the <guiicon>Full Screen</guiicon>
button on the toolbar, or by
<menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;&Shift;<keycap>F</keycap></keycombo>
</shortcut>
<guimenu>View</guimenu>
<guimenuitem>Full Screen Mode</guimenuitem>
</menuchoice>.
</para>
<para>To leave this mode press the &Esc; key.</para>
<sect2>
<title>Browse Mode Full Screen</title>
<para>In Browse Mode you can switch to fullscreen also by clicking on the button that
appears when you move the mouse over the thumbnails.
</para>
<screenshot>
<screeninfo>Full Screen View Mode Screenshot</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="fullscreen-browse.png" format="PNG" />
</imageobject>
</mediaobject>
</screenshot>
<para>Going fullscreen while browsing gives you a more immersive experience while
you go through your pictures. It is quite nice on your regular computer, but makes
even more sense when you connect your laptop to the big TV in the living room to show
pictures to your guests.
</para>
</sect2>
<sect2>
<title>View Mode Full Screen</title>
<para>The full screen View Mode shows a slideshow of your images. Access Full Screen
Mode by clicking on the button that appears when you move the mouse over the
thumbnails in Browse Mode, by pressing the <guiicon>Full Screen</guiicon>
button on the taskbar.
<screenshot>
<screeninfo>Full Screen Browse Mode Screenshot</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="fullscreen-view.png" format="PNG" />
</imageobject>
</mediaobject>
</screenshot>
</para>
<para>The top bar will hide itself automatically; to show it simply move the
mouse to the top of the screen. If the mouse cursor is over the top bar, it
will not autohide. Most of the buttons on the bar are the same as the ones on
the toolbar in Browse or View Modes, except for the <guiicon>Exit Full
Screen Mode</guiicon> button which returns you to the &kappname; window, the
<guiicon>Start/Stop Slideshow</guiicon> button, and the
<guiicon>Configure Full Screen Mode</guiicon> button which shows a
small settings dialog that allows you to easily and quickly configure the
slideshow. The slideshow controls there are: </para>
<itemizedlist>
<listitem><para>The <guilabel>Interval</guilabel> slider controls how long
&kappname; will show an image before it move to the next one.</para></listitem>
<listitem><para>If the <guilabel>Loop</guilabel> check box is checked, when the
end of the slideshow is reached, it will continue from the beginning instead
of stopping. </para></listitem>
<listitem><para>If the <guilabel>Random</guilabel> check box is checked,
instead of progressing through the folder alphabetically, images will be
shown in random order.</para></listitem>
<listitem><para><guibutton>Select Image Information to Display</guibutton> allows
you to define what metadata is displayed under the buttons on the toolbar.
</para></listitem>
<listitem><para>If the <guilabel>Show thumbnails</guilabel> check box is checked,
thumbnails for all images in the current folder will be displayed to the right of
the toolbar.</para></listitem>
<listitem><para>The <guilabel>Height</guilabel> slider changes the size of the
thumbnails displayed.</para></listitem>
</itemizedlist>
<para>If enabled, an area that shows you the other images in the current folder will
be shown on the top bar. Clicking on one will display it.</para>
</sect2>
</sect1>
<sect1 id="sidebar">
<title>Sidebar</title>
<para>The sidebar on the left is available in the Browse and View <!--FIXME not in Full Screen-->modes, but does
not appear by default in Browse Mode. Its appearance can be toggled using
<menuchoice>
<shortcut>
<keycap>F4</keycap>
</shortcut>
<guimenu>View</guimenu>
<guimenuitem>Sidebar</guimenuitem>
</menuchoice>
or using the <guiicon>▮←</guiicon> / <guiicon>▮→</guiicon> button at the left side
of the statusbar. When clicked it collapses or expands the sidebar.
The sidebar contains several tabs:</para>
<variablelist>
<varlistentry>
<term><guilabel>Folders</guilabel></term>
<listitem><para>Displays a list of all folders on your system permitting you to
switch between them. In Browse Mode thumbnails from the folder will be displayed,
while in View Mode the first image in the folder will appear, from which you can
browse through the folder using the <guibutton>Previous</guibutton> and
<guibutton>Next</guibutton> buttons or shortcuts.</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Information</guilabel></term>
<listitem><para>Displays <guilabel>Meta Information</guilabel> like the filename
and size. The <guilabel>More...</guilabel> link permits you to view all available
metadata and select which data appear in the sidebar.</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Operations</guilabel></term>
<listitem><para>This permits you to perform the
<link linkend="image_operations">previously described global image operations</link>
as well as those specific to View Mode. It also permits common file operations like
copying, renaming, deleting, and creating new folders.</para></listitem>
</varlistentry>
</variablelist>
</sect1>
</chapter>
<chapter id="importer">
<title>&kappname; Importer</title>
<sect1>
<title>Introduction</title>
<para>The &kappname; Importer allows you to import images from a digital camera or
removable media. To launch it, select <guilabel>Download Photos with &kappname;</guilabel>
in the &kde; Device Notifier after connecting a supported device.</para>
<para>When you plug in a device the &kappname; importer recursively lists all images and videos.
</para>
<para>This is not always what you expect, &eg; plugging a smartphone you do not want to list all medias
of the device; but only the pictures you took, which are usually in a special subfolder.
</para>
<screenshot>
<screeninfo>Root Folder Picking</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="importer-picking-root-folder.png" format="PNG" />
</imageobject>
</mediaobject>
</screenshot>
<para>It is possible to select the root folder to list, and &kappname; Importer will remember the
last root folder for each device. This way, next time you plug a device in, only the relevant
pictures and videos should be listed.
</para>
<sect2>
<title>Importing Images</title>
<screenshot>
<screeninfo>&kappname; Importer Screenshot</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="importer.png" format="PNG" />
</imageobject>
</mediaobject>
</screenshot>
<para>If you wish, you may select the images you want to import under
<guilabel>Select the documents to import</guilabel> by pressing the <guiicon>+</guiicon>
button that appears when hovering over an image. You may also select the folder
that images are imported to in the text box at the bottom of the window. When you are done, click the
<guibutton>Import Selected</guibutton> button to import only the images you have
selected, or click <guibutton>Import All</guibutton> to import all images found
on the device.</para>
</sect2>
<sect2>
<title>Automatic Renaming</title>
<para>&kappname; Importer can rename your files according to a specified pattern.
To configure this, select the <guibutton>Settings</guibutton> in the lower left
corner. You may turn this feature on or off using the check box at the top. The
<guilabel>Rename Format</guilabel> supports several special parameters, which will
be replaced by metadata such as the date the image was created or its filename.
They are listed below the text box. You may either click on the parameter name to
enter it into the text box or type one manually.</para>
</sect2>
</sect1>
</chapter>
<chapter id="tips">
<title>Tips</title>
<sect1 id='mouse'><title>Using the mouse</title>
<sect2 id='mouse_panning'><title>Panning with the mouse</title>
<itemizedlist>
<listitem><para>Holding down the left mouse button on an image allows you to
scroll the image.</para></listitem>
<listitem><para>The mouse wheel will scroll the image up and
down.</para></listitem>
</itemizedlist>
</sect2>
<sect2 id='mouse_zooming'><title>Zooming with the mouse</title>
<itemizedlist>
<listitem><para>Clicking the middle mouse button will toggle the auto zoom
on/off.</para></listitem>
<listitem><para>Hold down the &Ctrl; key, then either use the mouse wheel to
zoom in and out or left click to zoom in and right click to zoom
out.</para></listitem>
<listitem><para>The mouse wheel, used while holding down the &Alt; key, will
scroll the image horizontally.</para></listitem>
</itemizedlist>
</sect2>
<sect2 id='mouse_browsing'><title>Browsing with the mouse</title>
<itemizedlist>
<listitem><para>When in Browse mode, clicking an image switches into View mode and
shows that image.</para></listitem>
<listitem><para>When in Browse mode, scrolling the mouse wheel will scroll up
or down the thumbnail view area.</para></listitem>
<listitem><para>If the <guilabel>Mouse Behavior</guilabel> option in
<menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure
&kappname;</guimenuitem></menuchoice>
is set to Browse, scrolling the mouse wheel while in View Mode will
move you through the images in the folder.</para></listitem>
</itemizedlist>
</sect2>
</sect1>
<sect1 id="keybindings"> <title>Key bindings</title>
<para>&kappname; comes with a range of keyboard shortcuts, all of which can be
viewed and remapped by selecting
<menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure
Shortcuts...</guimenuitem></menuchoice>. Note that in the Files and Folders
windows, all the normal KDE shortcuts are functional, unless otherwise
remapped.</para>
<para>A few of the most useful default bindings are:</para>
<itemizedlist>
<listitem><para><keycap>Space</keycap>: Displays the next image
in the directory.</para></listitem>
<listitem><para>&Backspace;:
Displays the previous image in the directory.</para></listitem>
<listitem><para><keycombo
action="simul">&Alt;<keycap>Up</keycap></keycombo>:
Moves to the parent folder of the current folder.</para></listitem>
<listitem><para><keycombo
action="simul">&Ctrl;&Shift;<keycap>F</keycap></keycombo>:
Switches into Full Screen Mode.</para></listitem>
<listitem><para>&Esc;: Switches back to Browse Mode.
</para></listitem>
<listitem><para><keycombo
action="simul">&Ctrl;<keycap>M</keycap></keycombo>:
Show or hide the menubar.</para></listitem>
<listitem><para><keycombo
action="simul">&Ctrl;<keycap>B</keycap></keycombo>:
Show or hide the Thumbnail bar.</para></listitem>
<listitem><para><keycap>F4</keycap>:
Show or hide the Sidebar.</para></listitem>
<listitem><para><keycap>F6</keycap>:
Make the Location bar editable so that you can directly type in a file path.
You can return to the standard Location Bar by pressing the arrow at the
right.</para></listitem>
<listitem><para><keycombo
action="simul">&Ctrl;<keycap>R</keycap></keycombo>:
Rotate the current image to the right.</para></listitem>
<listitem><para><keycombo
action="simul">&Ctrl;<keycap>L</keycap></keycombo>:
Rotate the current image to the left.</para></listitem>
<listitem><para><keycombo action="simul">&Shift;<keycap>R</keycap></keycombo>:
Resize the current image.</para></listitem>
<listitem><para><keycombo action="simul">&Shift;<keycap>C</keycap></keycombo>:
Crop the current image.</para></listitem>
<listitem><para><keycombo action="simul">&Ctrl;<keycap>Y</keycap></keycombo>:
When multiple images are displayed in View Mode, this synchronizes their views.
</para></listitem>
<listitem><para><keycombo action="simul">&Tab;</keycombo>:
When multiple images are displayed in View Mode, this switched to the image to
the right of the currently selected image.</para></listitem>
<listitem><para><keycombo action="simul">&Shift;&Tab;</keycombo>:
When multiple images are displayed in View Mode, this switched to the image to
the left of the currently selected image.</para></listitem>
<listitem><para><keycombo
action="simul">&Ctrl;<keycap>S</keycap></keycombo>:
Save any changes made to the image.</para></listitem>
<listitem><para><keycap>Del</keycap>:
Move the current image to the trash.</para></listitem>
<listitem><para><keycombo
action="simul">&Shift;<keycap>Del</keycap></keycombo>:
Permanently delete the image from the disk. Note that this operation is
irreversible and cannot be undone.</para></listitem>
<listitem><para><keycombo
action="simul">&Ctrl;<keycap>P</keycap></keycombo>:
Print the current image.</para></listitem>
<listitem><para><keycombo
action="simul">&Ctrl;<keycap>O</keycap></keycombo>:
Open an image using the standard file selection dialog.</para></listitem>
<listitem><para><keycap>F</keycap>:
Pressing this shortcut toggles zoom-to-fit on and off.</para></listitem>
<listitem><para><keycap>P</keycap>:
Viewing a video this shortcut toggles playback on and off.</para></listitem>
<listitem><para><keycombo
action="simul">&Ctrl;<keycap>T</keycap></keycombo>:
Edit tags.</para></listitem>
<listitem><para><keycombo
action="simul">&Ctrl;<keycap>F2</keycap></keycombo>:
Rename an image inline.</para></listitem>
<listitem><para><keycap>Del</keycap>:
Move an image to the trash.</para></listitem>
<listitem><para><keycombo
action="simul">&Shift;<keycap>Del</keycap></keycombo>:
Delete an image.</para></listitem>
<listitem><para><keycombo
action="simul">&Ctrl;<keycap>F7</keycap></keycombo>:
Copy an image.</para></listitem>
<listitem><para><keycombo
action="simul">&Ctrl;<keycap>F8</keycap></keycombo>:
Move an image.</para></listitem>
<listitem><para><keycombo
action="simul">&Ctrl;<keycap>F9</keycap></keycombo>:
Link an image.</para></listitem>
</itemizedlist>
</sect1>
<sect1 id="advanced-configuration">
<title>Advanced Configuration Options</title>
<para>
Some notes on hidden &kappname; options can be found on
<ulink url="http://userbase.kde.org/Special:myLanguage/Gwenview/Hidden_Configuration_Options">this page</ulink>.
</para>
<important>
<para>
The options described on the above-mentioned page may help you
tune &kappname; for specific needs, but please keep in mind
there is no warranty they will continue working from one
version to another.
</para>
</important>
</sect1>
</chapter>
<chapter id="credits">
<title>Credits and Copyright</title>
<para>&kappname; is currently maintained by Aurélien Gâteau</para>
<para>This document was written by Christopher Martin</para>
<para>This document was updated for &kde; 4 by Henry de Valence</para>
<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
&underFDL;
&underGPL;
</chapter>
</book>

BIN
gwenview/doc/modified-bar.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 8.3 KiB

BIN
gwenview/doc/start-page.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 90 KiB

BIN
gwenview/doc/view_mode.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 445 KiB

2
kcalc/CMakeLists.txt
View file

@ -101,5 +101,3 @@ install( FILES scienceconstants.xml DESTINATION ${DATA_INSTALL_DIR}/kcalc)
install( FILES kcalcrc.upd DESTINATION ${DATA_INSTALL_DIR}/kconf_update)
kde4_install_icons( ${ICON_INSTALL_DIR} )
add_subdirectory(doc)

4
kcalc/doc/CMakeLists.txt
View file

@ -1,4 +0,0 @@
########### install files ###############
#
#
kde4_create_handbook(index.docbook INSTALL_DESTINATION ${HTML_INSTALL_DIR}/en SUBDIR kcalc)

140
kcalc/doc/commands.docbook
View file

@ -1,140 +0,0 @@
<chapter id="commands">
<title>Command Reference</title>
<sect1 id="menus">
<title>Menu Items</title>
<para>A brief overview of some special menu items in &kcalc;:</para>
<variablelist>
<varlistentry>
<term><menuchoice>
<guimenu>Constants</guimenu>
<guimenuitem>Mathematics</guimenuitem>
</menuchoice></term>
<listitem><para><action>Display Pi, Euler Number or Golden Ratio.</action>
</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Constants</guimenu>
<guimenuitem>Electromagnetism</guimenuitem>
</menuchoice></term>
<listitem><para><action>Display Light Speed, Elementary Charge,
Impedance of Vacuum, Permeability of Vacuum or Permittivity of Vacuum.</action>
</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Constants</guimenu>
<guimenuitem>Atomic &amp; Nuclear</guimenuitem>
</menuchoice></term>
<listitem><para><action>Display Planck's Constant, Elementary Charge or
Fine-Structure Constant.</action>
</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Constants</guimenu>
<guimenuitem>Thermodynamics</guimenuitem>
</menuchoice></term>
<listitem><para><action>Display Boltzmann Constant, Atomic Mass Unit, Molar Gas
Constant, Stefan-Boltzmann Constant or Avogadro's Number.</action>
</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Constants</guimenu>
<guimenuitem>Gravitation</guimenuitem>
</menuchoice></term>
<listitem><para>Display Constant of Gravitation or Earth Acceleration.
</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Simple Mode</guimenuitem>
</menuchoice></term>
<listitem><para><action>Displays the simple math buttons.</action>
</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Science Mode</guimenuitem>
</menuchoice></term>
<listitem><para><action>Displays trigonometric and science buttons.</action>
</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Statistic Mode</guimenuitem>
</menuchoice></term>
<listitem><para><action>Displays <link linkend="statistical-mode">statistic
buttons.</link></action>
</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Numeral System Mode</guimenuitem>
</menuchoice></term>
<listitem><para><action>Displays <link linkend="and-or-xor">logic
buttons</link> and allows changing the numeral system.</action>
</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Constants Buttons</guimenuitem>
</menuchoice></term>
<listitem><para><action>Display constants buttons. They are available in <link linkend="science-mode">science mode</link> and
<link linkend="statistical-mode">statistic mode</link>. </action>
</para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Show Bit Edit</guimenuitem>
</menuchoice></term>
<listitem><para><action>Displays a bit edit field. Click on a bit to toggle it. Only available in
<link linkend="numeral-system-mode">numeral system mode</link>.</action>
</para></listitem>
</varlistentry>
</variablelist>
<para>
Additionally &kcalc; has the common &kde; <guimenu>File</guimenu>, <guimenu>Edit</guimenu>,
<guimenu>Settings</guimenu> and <guimenu>Help</guimenu> menu items, for more information
read the sections about the <ulink url="help:/fundamentals/ui.html#menus">Menus</ulink>
in the &kde; Fundamentals.
</para>
</sect1>
</chapter>
<!--
Local Variables:
mode: sgml
sgml-parent-document: ("index.docbook" "book" "chapter")
sgml-minimize-attributes:nil
sgml-general-insert-case:lower
sgml-indent-step:0
sgml-indent-data:nil
End:
-->

880
kcalc/doc/index.docbook
View file

@ -1,880 +0,0 @@
<?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
<!ENTITY kappname "&kcalc;" >
<!ENTITY package "kdeutils">
<!ENTITY % addindex "IGNORE">
<!ENTITY % English "INCLUDE" > <!-- change language only here -->
<!ENTITY commands SYSTEM "commands.docbook">
]>
<book id="kcalc" lang="&language;">
<bookinfo>
<title>The &kcalc; Handbook</title>
<authorgroup>
<author>
&Bernd.Johannes.Wuebben; &Bernd.Johannes.Wuebben.mail;
</author>
<author>
&Pamela.Roberts;&Pamela.Roberts.mail;
<!-- <affiliation><jobtitle>Handbook maintainer</jobtitle>
</affiliation> -->
</author>
<author>
&Anne-Marie.Mahfouf;&Anne-Marie.Mahfouf.mail;
<!-- <affiliation><jobtitle>Handbook maintainer</jobtitle>
</affiliation> -->
</author>
<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>
<copyright>
<year>2001</year> <year>2002</year> <year>2005</year> <year>2006</year>
<holder>&Bernd.Johannes.Wuebben;, &Pamela.Roberts;,
&Anne-Marie.Mahfouf;</holder>
</copyright>
<legalnotice>&FDLNotice;</legalnotice>
<date>2013-05-24</date>
<releaseinfo>2.13 (&kde; 4.11)</releaseinfo>
<abstract><para>&kcalc; is a calculator for &kde;. In the simple mode it can
be used for basic arithmetic operations, but provides advanced modes for scientific,
statistical and numeral system calculations.</para></abstract>
<keywordset>
<keyword>KDE</keyword>
<keyword>KCalc</keyword>
<keyword>calculator</keyword>
</keywordset>
</bookinfo>
<chapter id="introduction">
<title>Introduction</title>
<para>&kcalc; offers many more mathematical functions than meet the eye
on a first glance. Please study the section on keyboard accelerators and
modes in this handbook to learn more about the many functions
available.</para>
<para>In addition to the usual functionality offered by most scientific
calculators, &kcalc; offers a number of features, which I think are
worthwhile pointing out:</para>
<itemizedlist>
<listitem>
<para>&kcalc; provides trigonometric functions, logic operations, and it is
able to do statistical calculations.</para>
</listitem>
<listitem>
<para>&kcalc; allows you to cut and paste numbers from/into its display.</para>
</listitem>
<listitem>
<para>&kcalc; features a <firstterm>results-stack</firstterm> which lets
you conveniently recall previous results.</para>
</listitem>
<listitem>
<para>You can configure &kcalc;'s display colors and font.</para>
</listitem>
<listitem>
<para>You can configure &kcalc;'s precision, the number of displayed digits and the number
of digits after the period in the settings dialog.</para>
</listitem>
<listitem>
<para> &kcalc; offers a great number of useful <link linkend="key-accels">
key-bindings</link>, which make using &kcalc; without using a pointing device easy.</para>
<para>Hint: pressing (and holding) the &Ctrl;-key, displays on
every button,the corresponding key-binding.</para>
</listitem>
</itemizedlist>
<!--see https://bugs.kde.org/show_bug.cgi?id=326481-->
<note><para>&kcalc; uses <ulink url="https://en.wikipedia.org/wiki/Calculator_input_methods#Infix_notation">Infix
notation</ulink> which enforces correct order of operations as taught in school; contrary to
<ulink url="https://en.wikipedia.org/wiki/Calculator_input_methods#Immediate_execution">Immediate execution</ulink>
used by many simple calculators.
</para></note>
<para>Have fun with &kcalc;!</para>
<para>&Bernd.Johannes.Wuebben;</para>
</chapter>
<chapter id="usage">
<title>Usage</title>
<sect1 id="general-usage">
<title>General Usage</title>
<para>General usage is straight forward and similar to the way most
simple scientific calculators operate, but take note of the following
special &kcalc; features:</para>
<variablelist>
<varlistentry>
<term>Result Stack</term>
<listitem><para>Each time you &LMB; click on the
<guibutton>=</guibutton> button or press your keyboard's
&Enter; or <keysym>=</keysym> keys, the display result is
written to &kcalc;'s result stack. You can navigate through the result
stack with your keyboard's
<keycombo action="simul">&Ctrl;<keycap>Z</keycap></keycombo>
and <keycombo action="simul">&Ctrl; &Shift;<keycap>Z</keycap></keycombo>
keys.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Percent Function</term>
<listitem>
<para>The percent function works somewhat differently to that on most
calculators. However, once understood, its enhanced functionality proves
quite useful. See the section about the <link
linkend="percent">percent</link> function for further details.</para>
</listitem></varlistentry>
<varlistentry>
<term>Cut and Paste</term>
<listitem>
<para><itemizedlist>
<listitem>
<para>Pressing <keycombo action="simul">&Ctrl;<keycap>C</keycap></keycombo>
will place the displayed number on to the clipboard.</para>
</listitem>
<listitem>
<para>Pressing <keycombo action="simul">&Ctrl;<keycap>V</keycap></keycombo>
will paste the clipboard content into the display if the content of the
clipboard is a valid floating point number.</para>
</listitem>
<listitem>
<para>It is still possible to copy/paste by clicking on &kcalc;'s display,
but this may disappear in future versions.</para>
</listitem>
</itemizedlist>
</para></listitem></varlistentry>
<varlistentry>
<term>Advanced functions</term>
<listitem>
<para>When you start &kcalc; for the first time, the calculator will only
display buttons for basic arithmetic computations.</para>
<para>Under the menu entry <guimenu>Settings</guimenu> it is possible to select a mode for &kcalc;:
it is possible to choose
<link linkend="simple-mode">Simple</link> or
<link linkend="science-mode">Science</link> or
<link linkend="statistical-mode">Statistic</link> or
<link linkend="numeral-system-mode">Numeral System</link> mode. Please note, that these modes will
slightly change as &kcalc; evolves.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Button Layout</term>
<listitem>
<para>To give easy access to all the functions in advanced modes in &kcalc;, many keys have a second layout. Click
on <guibutton>&Shift;</guibutton> or press the shortcut <keycombo action="simul">&Ctrl;<keycap>2</keycap></keycombo> to make
the second layout of the buttons visible.</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<!-- describing MODES here -->
<sect1 id="simple-mode">
<title>Simple Mode</title>
<para>This mode contains only those buttons and functions, which are essential necessary for basic calculations.</para>
<para>If you just want to sum up all items on an invoice this mode may be your choice.</para>
</sect1>
<sect1 id="science-mode">
<title>Science Mode</title>
<para>In this mode the left column of buttons is allocated to trigonometric
functions:</para>
<informaltable><tgroup cols="2">
<thead>
<row><entry>Buttons</entry>
<entry>Function</entry></row>
</thead>
<tbody>
<row><entry><guibutton>Hyp</guibutton></entry>
<entry>Enter Hyperbolic sub mode. Hyp Sin for example is the hyperbolic sine:
sinh</entry></row>
<row><entry><guibutton>Sin</guibutton></entry>
<entry>Compute the sine</entry></row>
<row><entry>&Shift; <guibutton>Sin</guibutton> or <guibutton>Asin</guibutton></entry>
<entry>Compute the inverse sine</entry></row>
<row><entry><guibutton>Cos</guibutton></entry>
<entry>Compute the cosine</entry></row>
<row><entry>&Shift; <guibutton>Cos</guibutton> or <guibutton>Acos</guibutton></entry>
<entry>Compute the inverse cosine</entry></row>
<row><entry><guibutton>Tan</guibutton></entry>
<entry>Compute the tangent</entry></row>
<row><entry>&Shift; <guibutton>Tan</guibutton> or <guibutton>Atan</guibutton></entry>
<entry>Compute the inverse tangent</entry></row>
<row><entry><guibutton>Log</guibutton></entry>
<entry>Compute the Log base 10</entry></row>
<row><entry>&Shift; <guibutton>Log</guibutton> or 10<superscript>x</superscript></entry>
<entry>Compute 10 to the power of x</entry></row>
<row><entry><guibutton>Ln</guibutton></entry>
<entry>Compute the natural logarithm. That is the log to base e</entry></row>
<row><entry>&Shift; <guibutton>Ln</guibutton> or e<superscript>x</superscript></entry>
<entry>Compute e (the base of the natural logarithm) to the power of x</entry></row>
</tbody></tgroup></informaltable>
<para>The second column has buttons for algebraic functions:</para>
<informaltable><tgroup cols="2">
<thead>
<row><entry>Buttons</entry>
<entry>Function</entry></row>
</thead>
<tbody>
<row><entry><guibutton>Mod</guibutton></entry>
<entry>Compute the remainder in Euclidean division</entry></row>
<row><entry><guibutton>&Shift;</guibutton> <guibutton>Mod</guibutton> or <guibutton>IntDiv</guibutton></entry>
<entry>Integer division (integer part of the quotient)</entry></row>
<row><entry><guibutton>1/x</guibutton></entry>
<entry>Compute the reciprocal for a number</entry></row>
<row><entry><guibutton>&Shift;</guibutton> <guibutton>1/x</guibutton> or <guibutton>nCm</guibutton></entry>
<entry>Compute the number of distinct second-operand-element subsets of it that can be formed for any set containing first operand elements (binomial coefficient)</entry></row>
<row><entry><guibutton>x!</guibutton></entry>
<entry>Compute the product of all positive integers less than or equal to the current integer operand (factorial)</entry></row>
<row><entry><guibutton>x²</guibutton></entry>
<entry>Compute the square of x</entry></row>
<row><entry><guibutton>&Shift;</guibutton> <guibutton>x²</guibutton> or <guibutton>√x</guibutton></entry>
<entry>Compute the square root of x</entry></row>
<row><entry><guibutton>xʸ</guibutton></entry>
<entry>x power y</entry></row>
<row><entry>&Shift; x<superscript>y</superscript> or x<superscript>1/y</superscript></entry>
<entry>x power 1/y</entry></row>
<row><entry><guibutton>x³</guibutton></entry>
<entry>Computes the third (cubic) power of x</entry></row>
<row><entry><guibutton>&Shift;</guibutton> <guibutton>x³</guibutton> or <guibutton>∛x</guibutton></entry>
<entry>Computes the third (cubic) root of x</entry></row>
<row><entry><guibutton>x·10ʸ</guibutton></entry>
<entry>Computes the product of the first operand and decimal exponent of the second operand</entry></row>
</tbody></tgroup></informaltable>
</sect1>
<sect1 id="statistical-mode">
<title>Statistical Mode</title>
<para>In this mode the left column of buttons is allocated to statistical
functions:</para>
<para> Most of the functionality in this mode is centered around the <guibutton>Dat</guibutton>
button. To create a data list of numbers, enter a number into the calculator and press
<guibutton>Dat</guibutton>. A sequentially increasing number is shown on the display indicating
which position in the Data <quote>list</quote> the number occupies. A traditional calculator only
stores three values for statistical functions: The number of discrete items in a list, the sum of
the data items entered and the sum of the square of all data items in the list. &kcalc; differs by
actually storing each discrete value, allowing you to calculate the median value of the data.
</para>
<informaltable><tgroup cols="2">
<thead>
<row><entry>Buttons</entry>
<entry>Function</entry></row></thead>
<tbody>
<row><entry><guibutton>N</guibutton></entry>
<entry>Recall the number of data items entered</entry></row>
<row><entry><guibutton>&Shift;</guibutton> <guibutton>N</guibutton> or <guibutton>&Sgr;x</guibutton></entry>
<entry>Display the sum of all data items entered</entry></row>
<row><entry><guibutton>Mea</guibutton></entry>
<entry>Display the mean of the data items entered</entry></row>
<row><entry><guibutton>&Shift;</guibutton> <guibutton>Mea</guibutton> or <guibutton>&Sgr;x²</guibutton></entry>
<entry>Display the sum of the square of all data items entered</entry></row>
<row><entry>&sgr;<subscript>N</subscript></entry>
<entry>Display the standard deviation (n)</entry></row>
<row><entry><guibutton>&Shift;</guibutton> &sgr;<subscript>N</subscript> or &sgr;<subscript>N-1</subscript> </entry>
<entry>Display the population standard deviation (n-1)</entry></row>
<row><entry><guibutton>Med</guibutton></entry>
<entry>Display the median</entry></row>
<row><entry><guibutton>Dat</guibutton></entry>
<entry>Enter a data item</entry></row>
<row><entry><guibutton>&Shift;</guibutton> <guibutton>Dat</guibutton> or <guibutton>CDat</guibutton></entry>
<entry>Clear last data item entered</entry></row>
<row><entry><guibutton>CSt</guibutton></entry>
<entry>Clear the store of all data item entered</entry></row>
</tbody></tgroup></informaltable>
<para>The next two columns hold the buttons with trigonometric and algebraic functions described in the
<link linkend="science-mode">Science</link> mode section.</para>
</sect1>
<sect1 id="numeral-system-mode">
<title>Numeral System Mode</title>
<para>This mode contains buttons and functions to calculate in binary, hexadecimal, octal and decimal.</para>
<para>You select the numeral system with the radio buttons on the right. To insert a hexadecimal number for example,
just do the following: Select <guilabel>Hex</guilabel> from the radio buttons. Then enter a number and note, that you can
use the letters <guibutton>A</guibutton> to <guibutton>F</guibutton>
for numbers larger than 9. If you would like to see this number in binary, just select <guilabel>Bin</guilabel> from the radio buttons.</para>
<para>Binary, octal and hexadecimal numbers can be displayed as groups of digits separated by whitespaces. Such grouping can improve readability of numbers. For example, hexadecimal number <emphasis>AF1C42</emphasis> can be displayed as <emphasis>AF 1C 42</emphasis> with separation every second digit. Grouping can be turned off or tweaked. Select <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure &kcalc;...</guimenuitem></menuchoice> to bring up the configuration dialog and change the setting on <guilabel>General</guilabel> page as appropriate.</para>
<para>You may want to select <guimenu>Show Bit Edit</guimenu> from the <guimenu>Settings</guimenu> menu to see selected bits.</para>
<para>There are logic operators available in this mode. These operators are:
<informaltable><tgroup cols="2">
<thead>
<row><entry>Buttons</entry>
<entry>Function</entry></row></thead>
<tbody>
<row><entry><guibutton>AND</guibutton></entry>
<entry>Two numbers are logically anded</entry></row>
<row><entry><guibutton>OR</guibutton></entry>
<entry>Two numbers are logically ored</entry></row>
<row><entry><guibutton>XOR</guibutton></entry>
<entry>Two numbers are logically exclusive ored</entry></row>
<row><entry><guibutton>Lsh</guibutton></entry>
<entry>Left shift the value</entry></row>
<row><entry><guibutton>Rsh</guibutton></entry>
<entry>Right shift the value</entry></row>
<row><entry><guibutton>Cmp</guibutton></entry>
<entry>Perform a 1's complement</entry></row>
</tbody></tgroup></informaltable>
</para>
<para>The second column holds the buttons with algebraic functions described in the
<link linkend="science-mode">Science</link> mode section.</para>
<para>The third column with the buttons <guibutton>A</guibutton> to <guibutton>F</guibutton> is
enabled only in <guilabel>Hex</guilabel> mode.
</para>
</sect1>
<!-- end of MODES -->
<sect1 id="memory-operations">
<title>Memory Operations</title>
<para>&kcalc; supports the memory operations given by standard
calculators plus six slots to hold constants.</para>
<sect2 id="standard_memory">
<title> Standard Memory Operations</title>
<para>&kcalc; can remember results of operations for you, and re-use them in
later calculations. You can access these functions via several buttons
labeled <guibutton>MR</guibutton>, <guibutton>MS</guibutton>,
<guibutton>M+</guibutton> and <guibutton>MC</guibutton>.</para>
<variablelist>
<varlistentry>
<term><guibutton>MS</guibutton></term>
<listitem><para>The <guibutton>MS</guibutton> button stores the currently
displayed result in memory.</para></listitem>
</varlistentry>
<varlistentry>
<term><guibutton>M+</guibutton></term>
<listitem><para>The <guibutton>M+</guibutton> button adds the current result to the
one in memory. So, if you had stored a 20, and the current result is a 5,
your memory would contain 25 when you press it. If the memory is empty, it
acts like <guibutton>MS</guibutton> and simply stores the
result.</para></listitem>
</varlistentry>
<varlistentry>
<term><guibutton>MR</guibutton></term>
<listitem><para>The <guibutton>MR</guibutton> button gets the value stored
in memory and puts it in the display.</para></listitem>
</varlistentry>
<varlistentry>
<term><guibutton>MC</guibutton></term>
<listitem><para>The <guibutton>MC</guibutton> button clears the
memory.</para></listitem>
</varlistentry>
</variablelist>
<para>If a value is stored in memory a <guilabel>M</guilabel> will appear in
the status bar, next to the calculator mode indicator</para>
</sect2>
<sect2 id="constant_buttons">
<title>Constants</title>
<para>The six constants buttons <guibutton>C1</guibutton> to
<guibutton>C6</guibutton> will only be visible after activating the
item <guilabel>Constants Buttons</guilabel> in the menu
<guimenu>Settings</guimenu> of the menu bar. They are available in <guilabel>Science mode</guilabel>
and <guilabel>Statistics mode</guilabel></para>
<para>To see the value stored in each constant hover the button with the mouse pointer.</para>
<para>To store the number shown in the &kcalc; display in one of the
six constants, first press <guibutton>&Shift;</guibutton> followed
by the desired button key <guibutton>C1</guibutton> up to
<guibutton>C6</guibutton>.</para>
<para>To use the value stored in any of the constants in a calculation, just
press the desired button (<guibutton>C1</guibutton> to <guibutton>C6</guibutton>),
and the corresponding number will appear in the display. </para>
<para>It is possible to change the label of the constants button to make it easier
to remember which button holds which constant. Click with the right mouse
button on one of the buttons <guibutton>C1</guibutton> to <guibutton>
C6</guibutton>. A popup menu appears, in which you select <guilabel>
Set Name</guilabel>. </para>
<para>There are many (mostly physical) predefined constants, which can
be put on any of the six buttons <guibutton>C1</guibutton> -
<guibutton>C6</guibutton> by selecting the desired constant in the
popup menu that appears after right clicking on one of the constant
buttons and selecting <guilabel>Choose from List</guilabel>. Though
the predefined constants can also be accessed via the
<guimenu>Constants</guimenu> in the menu bar, storing it on a
constants button is very handy, if the number is used
frequently.</para>
</sect2>
</sect1>
<sect1 id="key-accels">
<title>Single Key Accelerators</title>
<para>To simplify entering calculations from the keyboard &kcalc; has single key
accelerators for most functions. For example entering <userinput>7R</userinput>
or <userinput>7r</userinput> will calculate the reciprocal of 7 (1/7).</para>
<para>During a computation, you can always press &Ctrl; to make each
button display its key-binding.</para>
<!-- Shift works like Caps Lock-->
<informaltable><tgroup cols="3">
<thead>
<row><entry>Key</entry>
<entry>Function</entry>
<entry>Notes</entry></row>
</thead>
<tbody>
<row><entry><keycap>H</keycap></entry>
<entry><guibutton>Hyp</guibutton></entry>
<entry>Hyperbolic as in Hyp Sin,
the sinh</entry></row>
<row><entry><keycap>S</keycap></entry>
<entry><guibutton>Sin</guibutton></entry>
<entry></entry></row>
<row><entry><keycap>C</keycap></entry>
<entry><guibutton>Cos</guibutton></entry>
<entry></entry></row>
<row><entry><keycap>T</keycap></entry>
<entry><guibutton>Tan</guibutton></entry>
<entry></entry></row>
<row><entry><keycap>N</keycap></entry>
<entry><guibutton>Ln</guibutton></entry>
<entry>log base e</entry></row>
<row><entry><keycap>L</keycap></entry>
<entry><guibutton>Log</guibutton></entry>
<entry>log base 10</entry></row>
<row><entry><keycap>Ctrl-2</keycap></entry>
<entry> <guibutton>&Shift;</guibutton></entry>
<entry>Second function for this button. &eg; if
you want arcsin type <userinput>Ctrl-2 s </userinput></entry></row>
<row><entry><keysym>\</keysym></entry>
<entry><guibutton>+/-</guibutton></entry>
<entry>Change sign</entry></row>
<row><entry><keysym>[</keysym></entry>
<entry><guibutton>x^2</guibutton></entry>
<entry></entry></row>
<row><entry><keysym>^</keysym></entry>
<entry><guibutton>x^y</guibutton></entry>
<entry></entry></row>
<row><entry><keysym>!</keysym></entry>
<entry><guibutton>x!</guibutton></entry>
<entry>Factorial</entry></row>
<row><entry><keysym>E</keysym></entry>
<entry>x10<superscript>y</superscript></entry>
<entry>Exponent</entry></row>
<row><entry><keysym>&lt;</keysym></entry>
<entry><guibutton>Lsh</guibutton></entry>
<entry>Left shift</entry></row>
<!-- no "<" on Lsh key only ">" on Rsh key-->
<row><entry><keysym>&gt;</keysym></entry>
<entry><guibutton>Rsh</guibutton></entry>
<entry>Right shift.</entry></row>
<row><entry><keysym>&amp;</keysym></entry>
<entry><guibutton>AND</guibutton></entry>
<entry>Logical AND</entry></row>
<row><entry><keysym>x</keysym> or <keysym>*</keysym></entry>
<entry><guibutton>X</guibutton></entry>
<entry>Multiply</entry></row>
<row><entry><keysym>/</keysym></entry>
<entry><guibutton>/</guibutton></entry>
<entry>Divide</entry></row>
<row><entry><keycap>D</keycap></entry>
<entry><guibutton>Dat</guibutton></entry>
<entry>Enter data item in statistical mode</entry></row>
<row><entry><keycap>|</keycap></entry>
<entry><guibutton>OR</guibutton></entry>
<entry>Logical OR. Note: <guibutton>&Shift;</guibutton>
<guibutton>OR</guibutton> is XOR</entry></row>
<row><entry><keycap>R</keycap></entry>
<entry><guibutton>1/x</guibutton></entry>
<entry>Reciprocal</entry></row>
<row><entry>&Enter;</entry>
<entry><guibutton>=</guibutton></entry>
<entry></entry></row>
<row><entry><keycap>Return</keycap></entry>
<entry><guibutton>=</guibutton></entry>
<entry></entry></row>
<row><entry>&Backspace;</entry>
<entry><guibutton>&lt;=</guibutton></entry>
<entry>Delete last number</entry></row>
<row><entry><keycap>PgUp</keycap></entry>
<entry><guibutton>C</guibutton></entry>
<entry>Clear</entry></row>
<row><entry>&Esc;</entry>
<entry><guibutton>C</guibutton></entry>
<entry>Clear</entry></row>
<!--
<row><entry><keycap>Prior</keycap></entry>
<entry><guibutton>C</guibutton></entry>
<entry>Clear</entry></row>
-->
<row><entry><keycap>PgDown</keycap></entry>
<entry><guibutton>AC</guibutton></entry>
<entry>Clear all</entry></row>
<!--
<row><entry><keycap>Next</keycap></entry>
<entry><guibutton>AC</guibutton></entry>
<entry>Clear all</entry></row>
-->
<row><entry><keycap>Del</keycap></entry>
<entry><guibutton>AC</guibutton></entry>
<entry>Clear all</entry></row>
<row><entry><keycap>:</keycap></entry>
<entry><guibutton>Mod</guibutton></entry>
<entry>remainder of dividing</entry></row>
<row><entry>&Alt;+<keycap>1</keycap> to &Alt;+<keycap>6</keycap></entry>
<entry><guibutton>C1</guibutton></entry>
<entry>use the value stored in C1 to C6</entry></row>
</tbody></tgroup></informaltable>
</sect1>
</chapter>
<chapter id="comments-on-specific-functions">
<title>Comments on Specific Functions</title>
<sect1 id="mod">
<title>Mod and IntDiv</title>
<variablelist>
<varlistentry>
<term><guibutton>Mod</guibutton> gives the remainder of dividing the displayed
number by the next input number.</term>
<listitem><para><userinput>22 Mod 8 = </userinput> will give the result
<emphasis>6</emphasis></para>
<para><userinput>22.345 Mod 8 = </userinput> will give the result
<emphasis>6.345</emphasis></para>
</listitem></varlistentry>
<varlistentry>
<term><guibutton>&Shift;</guibutton> <guibutton>IntDiv</guibutton> does integer
division of the displayed number by the next input number.</term>
<listitem><para><userinput>22 Shift IntDiv 8 = </userinput> will give the result
<emphasis>2</emphasis></para>
<para><userinput>22.345 Shift IntDiv 8 = </userinput> also gives <emphasis>2</emphasis>
</para></listitem></varlistentry>
</variablelist>
</sect1>
<sect1 id="percent">
<title>&percnt;</title>
<para>Used instead of the <guibutton>=</guibutton> key,
<guibutton>%</guibutton> interprets the final operation carried out in the
current calculation as follows:</para>
<para><itemizedlist>
<listitem>
<para>If the final operator is + or - the second argument is interpreted as percentage of the first operand.
</para>
</listitem>
<listitem>
<para>If the final operator is * divide the result of the multiplication by 100.
</para>
</listitem>
<listitem>
<para>If the final operator is / give the left operand
as a percentage of the right operand.
</para>
</listitem>
<listitem>
<para> In all other cases the &percnt; key gives identical results to the = key.
</para>
</listitem>
</itemizedlist></para>
<variablelist>
<varlistentry>
<term>Examples:</term>
<listitem>
<para><userinput>150 + 50 %</userinput> gives <emphasis>225</emphasis> (150 plus 50 percent of this amount)</para>
<para><userinput>42 * 3 %</userinput> gives
<emphasis>1.26</emphasis> (42 * 3 / 100)</para>
<para><userinput>45 / 55 %</userinput> gives
<emphasis>81.81...</emphasis> (45 is 81.81.. percent of 55)</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<sect1 id="lsh-rsh">
<title>Lsh and Rsh</title>
<variablelist>
<varlistentry>
<term><guibutton>Lsh</guibutton> left shifts the integer part of the displayed
value (multiplies it by 2) n times, where n is the next input number, and
gives an integer result (base is set to <guibutton>Bin</guibutton>):</term>
<listitem><para><userinput>10 Lsh 3 =</userinput> gives <emphasis>80</emphasis>
(10 multiplied by 2 three times).</para>
<para><userinput>10.345 Lsh 3 =</userinput> also gives
<emphasis>80</emphasis>.</para></listitem>
</varlistentry>
<varlistentry>
<term><guibutton>Rsh</guibutton> right shifts the
value (performs an integer divide by 2) n times.</term>
<listitem><para><userinput>16 Rsh 2 =</userinput> gives
<emphasis>4</emphasis> (16 divided by 2 twice).</para>
<para><userinput>16.999 Rsh 2 =</userinput> also gives
<emphasis>4</emphasis>.</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<sect1 id="and-or-xor">
<title>Cmp, And, Or and Xor</title>
<para>The <guibutton>Cmp</guibutton>, <guibutton>And</guibutton> and
<guibutton>Or</guibutton> functions perform bitwise logical operations and
therefore appear more meaningful if the base is set to
<guilabel>Hex</guilabel>, <guilabel>Oct</guilabel> or <guilabel>Bin</guilabel>
rather than <guilabel>Dec</guilabel>. In the following
examples base is set to <guilabel>Bin</guilabel>.</para>
<variablelist>
<varlistentry>
<term><guibutton>Cmp</guibutton> performs a 1's complement (inverts the
bits).</term>
<listitem><para><userinput>101 Cmp</userinput> gives
<emphasis>111...111010</emphasis></para> </listitem>
</varlistentry>
<varlistentry>
<term><guibutton>AND</guibutton> does a logical AND.</term>
<listitem><para><userinput>101 AND 110 =</userinput> gives
<emphasis>100</emphasis></para> </listitem>
</varlistentry>
<varlistentry>
<term><guibutton>OR</guibutton> does the logical OR.</term>
<listitem><para><userinput>101 OR 110 =</userinput> gives
<emphasis>111</emphasis></para> </listitem>
</varlistentry>
<varlistentry>
<term><guibutton>XOR</guibutton> performs the logical
XOR (exclusive OR) operation.</term>
<listitem><para><userinput>101 XOR 110 =</userinput> gives
<emphasis>11</emphasis></para> </listitem>
</varlistentry>
</variablelist>
</sect1>
</chapter>
<chapter id="questions-and-answers">
<title>Questions and Answers</title>
<qandaset>
<qandaentry>
<question><para>How do I get e, the Euler number?</para></question>
<answer><para>Type <userinput>1 Shift Ln</userinput>.</para></answer>
</qandaentry>
<qandaentry>
<question><para>How do I get two fixed digits after the period?</para></question>
<answer><para>Select <menuchoice><guimenu>Settings</guimenu><guimenuitem>
Configure &kcalc;...</guimenuitem></menuchoice> on the menubar, this will
bring up the configuration dialog. Check <guilabel>Set decimal
precision</guilabel> and adjust the spin control so that it shows a
2.</para></answer> </qandaentry>
<qandaentry>
<question><para>What about Precision?</para></question>
<answer><para>The main factor determining the precision of &kcalc; is whether your libc and libmath
supports the C data type <type>long double</type>. If this is the case, &kcalc; will detect this
at compile time and use it as its fundamental data type to represent numbers.
</para>
<para>Adjust the <guilabel>Precision</guilabel> in &kcalc;'s
<guibutton>Configure</guibutton> dialog so that the above computations
work correctly. I recommend a precision of 14 if the fundamental data type
for your copy of &kcalc; is <type>long double</type>, otherwise 8 or 10.</para>
<para>Higher precision doesn't necessarily lead to better results. Play with
the precision and you will see what I mean.</para>
</answer>
</qandaentry>
</qandaset>
</chapter>
&commands;
<chapter id="copyright">
<title>Credits and License</title>
<para>&kcalc; Program Copyright &copy;:</para>
<para>&Bernd.Johannes.Wuebben; 1996-2000</para>
<para>The &kde; Team 2000-2008</para>
<itemizedlist>
<listitem><para>&Bernd.Johannes.Wuebben; &Bernd.Johannes.Wuebben.mail;</para></listitem>
<listitem><para>&Evan.Teran; &Evan.Teran.mail;</para></listitem>
<listitem><para>&Espen.Sand; &Espen.Sand.mail;</para></listitem>
<listitem><para>&Chris.Howells; &Chris.Howells.mail;</para></listitem>
<listitem><para>&Aaron.J.Seigo; &Aaron.J.Seigo.mail;</para></listitem>
<listitem><para>&Charles.Samuels; &Charles.Samuels.mail;</para></listitem>
<listitem><para>&David.Johnson; &David.Johnson.mail;</para></listitem>
</itemizedlist>
<para>&kcalc; was inspired by <personname><firstname>Martin</firstname> <surname>Bartlett</surname></personname>'s <application>xfrmcalc</application>,
whose stack engine is still part of &kcalc;.</para>
<para>Documentation Copyright &copy; 2001,2002,2005, 2006,2010:</para>
<itemizedlist>
<listitem><para>&Bernd.Johannes.Wuebben; &Bernd.Johannes.Wuebben.mail;</para></listitem>
<listitem><para>&Pamela.Roberts; &Pamela.Roberts.mail;</para></listitem>
<listitem><para>&J.Hall; &J.Hall.mail;</para></listitem>
<listitem><para>&Anne-Marie.Mahfouf; &Anne-Marie.Mahfouf.mail;</para></listitem>
<listitem><para><personname><firstname>Eike</firstname><surname>Krumbacher</surname></personname>
<email>eike.krumbacher@x-eike.de</email></para></listitem>
</itemizedlist>
<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
&underFDL;
&underGPL;
</chapter>
<appendix id="installation">
<title>Installation</title>
<para>&kcalc; is part of the kdeutils package within the &kde; project and will
normally be provided as part of a &kde; installation. For more details about
&kde; visit <ulink url="http://www.kde.org">http://www.kde.org</ulink>.</para>
<sect1 id="compilation-and-installation">
<title>Compilation and Installation</title>
&install.intro.documentation;
&install.compile.documentation;
</sect1>
</appendix>
</book>
<!--
Local Variables:
mode: sgml
sgml-minimize-attributes:nil
sgml-general-insert-case:lower
sgml-indent-step:0
sgml-indent-data:nil
End:
-->

123
kcalc/doc/kcalc_on_Aix.txt
View file

@ -1,123 +0,0 @@
X-RDate: Mon, 11 Aug 1997 17:34:22 -0400 (EDT)
Return-Path: <diehl@mail.schoeck.de>
Received: from cornell.edu (cornell.edu [132.236.56.6]) by
postoffice2.mail.cornell.edu (8.8.5/8.8.5) with ESMTP id JAA08757 for
<bw18@POSTOFFICE2.MAIL.CORNELL.EDU>; Mon, 11 Aug 1997 09:50:57 -0400 (EDT)
Received: (from daemon@localhost) by cornell.edu (8.8.5/8.8.5) id JAA11825 for
bw18@postoffice3.mail.cornell.edu; Mon, 11 Aug 1997 09:50:56 -0400 (EDT)
Received: from polygon.math.cornell.edu (POLYGON.MATH.CORNELL.EDU
[128.84.234.110]) by cornell.edu (8.8.5/8.8.5) with SMTP id JAA11800 for
<bw18@cornell.edu>; Mon, 11 Aug 1997 09:50:53 -0400 (EDT)
Received: from ibmmail.COM by polygon.math.cornell.edu (5.x/SMI-SVR4) id
AA10464; Mon, 11 Aug 1997 09:50:48 -0400
Received: from IMXGATE.COM by ibmmail.COM (IBM VM SMTP V2R3) with BSMTP id
5302; Mon, 11 Aug 97 09:50:47 EDT
Received: from mail.schoeck.de by imxgate.com (IBM VM SMTP V2R3) with TCP;
Mon, 11 Aug 97 09:49:44 EDT
Received: from isndj1.ag.schoeck.com by mail.schoeck.de (AIX 4.1/UCB 5.64/4.03)
id AA15070; Mon, 11 Aug 1997 15:46:57 +0100
Message-Id: <9708111446.AA15070@mail.schoeck.de>
Comments: Authenticated sender is <diehjoch@mail.schoeck.com>
X-PH: V4.1@cornell.edu (Cornell Modified)
Organization: Schoeck AG
Date: Mon, 11 Aug 1997 15:47:27 +1
Mime-Version: 1.0
Content-Type: text/plain; charset=ISO-8859-1
Content-Transfer-Encoding: 8BIT
Comments: Sender has elected to use 8-bit data in this message. If problems
arise, refer to postmaster at sender's site.
Reply-To: diehl@mail.schoeck.de
Priority: normal
In-Reply-To: <XFMail.970810103958.wuebben@math.cornell.edu>
References: <9708101509.AA13824@mail.schoeck.de>
X-Mailer: Pegasus Mail for Win32 (v2.52)
XFMstatus: 0000
From: "Jochen Diehl" <diehl@mail.schoeck.de>
To: Bernd Johannes Wuebben <wuebben@math.cornell.edu>
Subject: RE: kcalc under AIX
> O.K Jochen,
>
> das wird jetzt aber ein bische unuebersichtlich.
> Ich schlage vor, Du findest jetzt erst mal in Ruhe eine
> Loesung die fuer AIX funktioniert. Dann sende mir Dein
> kcalc.h und ich werde meine bestes tun das einzubauen.
> Ich glaube es ist am besten wenn wir das so machen,
> ein ganzen Haufen Leute sind naemlich immer zielich sauer,
> wenn ich eine neue version von kcalc rausbringe und
> es laeuft auf ihrer platform nicht mehr richtig.
Sowas ist in der Tat aergerlich. Langsam verstehe ich, wieso
kommerzielle Softwareschmieden sich so str?uben, auf n Plattformen zu
portieren...
Ok. Hier also mal meine Aenderungen, sind eigentlich minimal.
Immerhin funktioniert die Trigonometrie dann bei mir. Ausser beim
ersten Start: cos 0 gibt dann 0.9932483259 irgendwas, erst wenn ich
AC druecke kommt 1 raus. Sonst klappt das erstmal. AIX scheint
uebrigens asinhl und Konsorten nicht zu kennen, obwohl sinhl bekannt
ist. Nun ja, hier der diff:
kcalc.h
72a73,81
> #if defined(_AIX) && defined(HAVE_FABSL)
> #define __LONGDOUBLE128
> #define pi M_PI
> #define asinhl(X) asinh(X)
> #define acoshl(X) acosh(X)
> #define atanhl(X) atanh(X)
> #endif
>
>
kcalc_core.cpp
35c35
39d38
< #include <math.h>
40a40
> #include <math.h>
68a69
> #ifndef _AIX
69a71
> #endif
157a160
> #ifndef _AIX
158a162
> #endif
Damit bricht der Compiler wenigstens mal nicht ab.
Anscheinend ist IBM echt zu doof zum Rechnen (wundert mich, bei den
Preisen und den unendlich vielen Seriennummern :-), Deine Definition
von pi schluckt es nicht, da kommt dann NaNQ in die Anzeige.
Auch sonst stimmt etwas noch nicht so, ich habe nur noch nicht
herausgefunden, woran das liegt:
Nach exp(1) zeigt kcalc e^1.5 an usw. Was am Source falsch sein
soll, ist mir absolut schleierhaft, ich habe genau denselben Code in
einem eigenen Programm und da rechnet er es richtig. Weiss der Geier.
"0!" bringt bei mir einen core dump, schaetze mal, der modfl (IBM)
ist daran schuld. Wenn ich vorher ein cout mache, bleibt das Programm
stehen, cored aber wenigstens nicht.
Was soll's? Da ich scheinbar der einzige bin, der Interesse an KDE
auf AIX hat, stoert mich das nicht so ungemein, will sagen: ich habe
keine Probleme xcalc zu nehmen (wenn ich ueberhaupt mal einen
Taschenrechner brauche). Ansonsten gilt natuerlich die
Standardaussage: Super, dass sich jemand hinsetzt und den Code
ueberhaupt schreibt und dann noch fuer umme weggibt.
Fass es bitte nicht als Kritik auf, sondern einfach als Info, was
unter anderen OS so alles passieren kann :-) Was Du mit deinem Source
machst, ist natuerlich Deine Sache, ich will hier ja keinen
veraergern.
Viele Gruesse
Jochen
-------------------------------------------------------------
Jochen Diehl, R/3-Basis
Schoeck AG, Vimbucher Str. 2, 76534 Baden-Baden
Tel.: +497223967381 Fax.: +497223967352

62
kcalc/doc/kcalc_on_OSF.txt
View file

@ -1,62 +0,0 @@
X-RDate: Mon, 01 Sep 1997 07:45:22 -0400 (EDT)
Return-Path: <knoll@daniel.mpi-hd.mpg.de>
Received: from cornell.edu (cornell.edu [132.236.56.6]) by
postoffice2.mail.cornell.edu (8.8.5/8.8.5) with ESMTP id KAA06175 for
<bw18@POSTOFFICE2.MAIL.CORNELL.EDU>; Tue, 26 Aug 1997 10:56:10 -0400 (EDT)
Received: (from daemon@localhost) by cornell.edu (8.8.5/8.8.5) id KAA25547 for
bw18@postoffice3.mail.cornell.edu; Tue, 26 Aug 1997 10:55:42 -0400 (EDT)
Received: from polygon.math.cornell.edu (POLYGON.MATH.CORNELL.EDU
[128.84.234.110]) by cornell.edu (8.8.5/8.8.5) with SMTP id KAA25126 for
<bw18@cornell.edu>; Tue, 26 Aug 1997 10:55:15 -0400 (EDT)
Received: from mpimail.mpi-hd.mpg.de by polygon.math.cornell.edu (5.x/SMI-SVR4)
id AA07964; Tue, 26 Aug 1997 10:54:56 -0400
Received: from daniel.mpi-hd.mpg.de (daniel.mpi-hd.mpg.de [149.217.1.90]) by
mpimail.mpi-hd.mpg.de (8.8.2/8.8.2) with SMTP id QAA19532 for
<wuebben@math.cornell.edu>; Tue, 26 Aug 1997 16:54:56 +0200 (MET DST)
Received: from localhost by daniel.mpi-hd.mpg.de
(5.65v4.0/1.1.10.5/31Jul97-0446PM) id AA04869; Tue, 26 Aug 1997 16:54:56 +0200
Date: Tue, 26 Aug 1997 16:54:56 +0200 (MET DST)
X-PH: V4.1@cornell.edu (Cornell Modified)
Message-Id: <Pine.OSF.3.96.970826163314.32213A-100000@daniel.mpi-hd.mpg.de>
Mime-Version: 1.0
Content-Type: TEXT/PLAIN; charset=US-ASCII
XFMstatus: 0002
From: Lars Knoll <Lars.Knoll@mpi-hd.mpg.de>
To: wuebben@math.cornell.edu
Subject: kcalc unter dec osf4.0
Hi,
ich hatte ein paar Probleme, kcalc auf einer dec alpha unter osf4.0
zu kompilieren. Das Problem ist, dass bei diesem System
sizeof(long double) = sizeof(double)
ist, und dass Routinen namens asinl, fabsl, ... existieren, aber nicht
in irgendwelchen headers definiert werden.
Zusaetzlich funktioniert fabsl() wie erwartet, asinl gibt aber leider
immer nur 0. zurueck. Der folgende patch loest das Problem bei mir.
Lars
diff -c kcalc/kcalc.h kcalc.osf/kcalc.h
*** kcalc/kcalc.h Sun Aug 3 05:01:41 1997
--- kcalc.osf/kcalc.h Tue Aug 26 16:53:12 1997
***************
*** 63,68 ****
--- 63,72 ----
/* TAKE CARE OF TH HAVE_LONG_DOUBLE defines in core.cpp*/
+ /* dec osf4.0 has fabsl, but not asinl... */
+ #ifdef __osf__
+ #undef HAVE_FABSL
+ #endif
#ifdef HAVE_FABSL
#define CALCAMNT long double
---
Lars Knoll knoll@mpi-hd.mpg.de
PGP pub key [6DADF3D5]: finger knoll@pluto.mpi-hd.mpg.de

1
kcron/CMakeLists.txt
View file

@ -41,6 +41,5 @@ endif(CMAKE_COMPILER_IS_GNUCXX)
##
add_subdirectory(src)
add_subdirectory(doc)

3
kcron/doc/CMakeLists.txt
View file

@ -1,3 +0,0 @@
########### install files ###############
kde4_create_handbook(index.docbook INSTALL_DESTINATION ${HTML_INSTALL_DIR}/en SUBDIR kcron)

443
kcron/doc/index.docbook
View file

@ -1,443 +0,0 @@
<?xml version="1.0" ?>
<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN"
"dtd/kdex.dtd" [
<!ENTITY % English "INCLUDE" > <!-- change language only here -->
<!ENTITY % addindex "IGNORE">
]>
<article id="kcron" lang="&language;">
<title>Task Scheduler</title>
<articleinfo>
<authorgroup>
<author>
<firstname>Morgan</firstname>
<othername>N.</othername>
<surname>Sandquist</surname>
<affiliation><address>&Morgan.N.Sandquist.mail;</address>
</affiliation>
</author>
<othercredit role="developer">
<firstname>Gary</firstname>
<surname>Meyer</surname>
<affiliation><address>&Gary.Meyer.mail;</address>
</affiliation>
<contrib>Developer</contrib>
</othercredit>
<othercredit role="reviewer">
<firstname>Lauri</firstname>
<surname>Watts</surname>
<affiliation><address>&Lauri.Watts.mail;</address>
</affiliation>
<contrib>Reviewer</contrib>
</othercredit>
<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>
<copyright>
<year>2000</year>
<holder>&Morgan.N.Sandquist;</holder>
</copyright>
<date>2013-06-22</date>
<releaseinfo>&kde; 4.11</releaseinfo>
<keywordset>
<keyword>KDE</keyword>
<keyword>cron</keyword>
<keyword>crontab</keyword>
<keyword>scheduler</keyword>
</keywordset>
</articleinfo>
<sect1 id="introduction">
<title>Introduction</title>
<para>This is a module for scheduling programs to run in the
background. It is a graphical user interface to <command>cron</command>,
the &UNIX; system scheduler.</para>
<important><para>Don't forget to tell your system to start the
<filename>crond</filename> cron daemon first, or the settings in this
module will not work.</para></important>
<sect2 id="kcron-start-up">
<title>Start Up</title>
<para>When you start this module you will see a summarized view of existing
scheduled tasks and associated environment variables. If you are running
as the root user, you will see these items for all users on the computer
as well as the system scheduled tasks.</para>
<!--admin mode-->
<screenshot>
<screeninfo>start up</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="kcronstart.png" format="PNG"/></imageobject>
<textobject><phrase>start up</phrase></textobject>
</mediaobject>
</screenshot>
<sect3>
<title>Scheduled Tasks</title>
<para>Scheduled tasks appear under a <guilabel>Tasks</guilabel>
list. For each scheduled task, the following items are displayed:</para>
<variablelist>
<!-- system cron first column User=root-->
<varlistentry>
<term><guilabel>Scheduling</guilabel></term>
<listitem><para>In this column either "@reboot" for task schedules at boot or
the crontab entry is displayed.</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Command</guilabel></term>
<listitem><para>Program file and parameters.</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Status</guilabel></term>
<listitem><para>Enabled or Disabled.</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Description</guilabel></term>
<listitem><para>A description for the task, such as its
purpose.</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Scheduling Details</guilabel></term>
<listitem><para>Natural language description of scheduled
task.</para></listitem>
</varlistentry>
</variablelist>
</sect3>
<sect3>
<title>Environment Variables</title>
<para>Environment variables appear in the
<guilabel>Environment Variables</guilabel> list. For each environment variable,
the following are displayed: </para>
<variablelist>
<varlistentry>
<term><guilabel>Variable</guilabel></term>
<listitem><para>Variable name.</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Value</guilabel></term>
<listitem><para>Variable value.</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Status</guilabel></term>
<listitem><para>Enabled or Disabled.</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Comment</guilabel></term>
<listitem><para>Natural language description of variable.</para></listitem>
</varlistentry>
</variablelist>
<para>Environment variables appearing here will override any existing
environment variable for all scheduled tasks.</para>
</sect3>
</sect2>
<sect2 id="new-task">
<title>Adding Scheduled Tasks</title>
<para>To create a new scheduled task, click the <guibutton>New Task...</guibutton>
button. Alternatively, you can select this action from the
<mousebutton>right</mousebutton> mouse button context menu.</para>
<sect3>
<title>The Edit Task Dialog</title>
<screenshot>
<screeninfo><guilabel>Edit Task</guilabel> dialog.</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="newtask.png" format="PNG"/></imageobject>
<textobject><phrase><guilabel>Edit Task</guilabel> dialog</phrase></textobject>
</mediaobject>
</screenshot>
<variablelist>
<varlistentry>
<term><guilabel>Command</guilabel></term>
<listitem><para>Enter the name of the program. You can specify either a
relative path or absolute path. If you want to look up the program, click
<guiicon>Browse</guiicon> icon.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Comment</guilabel></term>
<listitem><para>Enter a description of the task to schedule.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guibutton>Enable this task</guibutton></term>
<listitem><para>To enable or disable the task, select or de-select
this button.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guibutton>Run at system bootup</guibutton></term>
<listitem>
<para>Check this button to run the task at system bootup.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guibutton>Run every day</guibutton></term>
<listitem>
<para>If you want to schedule the task to run daily, select this button.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Months</guilabel></term>
<listitem><para>Select the months during which the task is to be
scheduled.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Days of Month</guilabel></term>
<listitem><para>Select the days of the month on which the task is to be
scheduled.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Days of Week</guilabel></term>
<listitem><para>Select the days of the week on which the task is to be
scheduled.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Hours</guilabel></term>
<listitem><para>Select the hours on which the task is to be
scheduled.</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Minutes</guilabel></term>
<listitem><para>Select the minute at which the task is to be scheduled. <command>cron</command>
does not support scheduling tasks at smaller than one minute intervals.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guibutton>OK</guibutton></term>
<listitem><para>Completes the creation of this task.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guibutton>Cancel</guibutton></term>
<listitem><para>Cancels the creation of this task.</para>
</listitem>
</varlistentry>
</variablelist>
<para>If you select both days of the month, and days of the week, the
task will run when either condition is met. For instance, if you select
the 1st and 15th, and select Sunday, the program will be run every 1st
and 15th of the selected months (regardless of day of week) as well as
every Sunday of the selected months (regardless of day of the
month).</para>
<para>The scheduled task is not actually set up until the
<filename>crontab</filename> has been saved.</para>
</sect3>
</sect2>
<sect2 id="manage-tasks">
<title>Managing Scheduled Tasks</title>
<para>As with creating new tasks, changes to tasks will not actually be
made until the <filename>crontab</filename> is saved.</para>
<para>Use the buttons at the right of the task list to modify, delete,
print or run a selected task now. You reach all these actions from the
context menu as well. Additionally the context menu provides actions to
cut, copy and paste tasks.</para>
</sect2>
<sect2 id="new-variable">
<title>Adding Environment Variables</title>
<para>To create a new environment variable, click the
<guibutton>New Variable...</guibutton> button.</para>
<para>Alternatively, you can use the <mousebutton>right</mousebutton>
mouse button menu to choose this action.</para>
<sect3>
<title>The Edit Variable dialog</title>
<screenshot>
<screeninfo><guilabel>Edit Variable</guilabel> dialog.</screeninfo>
<mediaobject>
<imageobject><imagedata fileref="newvariable.png" format="PNG"/></imageobject>
<textobject><phrase><guilabel>Edit Variable</guilabel>
dialog.</phrase></textobject>
</mediaobject>
</screenshot>
<variablelist>
<varlistentry>
<term><guilabel>Variable</guilabel></term>
<listitem><para>Enter the environment variable name. You can use the drop down
list box to select from the most common environment variables used by scheduled
tasks. Those include:</para>
<variablelist>
<varlistentry>
<term><guimenuitem>HOME</guimenuitem></term>
<listitem><para>To be used instead of the default user's home
folder.</para></listitem>
</varlistentry>
<varlistentry>
<term><guimenuitem>MAILTO</guimenuitem></term>
<listitem><para>To send email output to an email address other than the user's
default email address.</para></listitem>
</varlistentry>
<varlistentry>
<term><guimenuitem>PATH</guimenuitem></term>
<listitem><para>To be used to search folders for program
files.</para></listitem>
</varlistentry>
<varlistentry>
<term><guimenuitem>SHELL</guimenuitem></term>
<listitem><para>To be used instead of the user's default
value.</para></listitem>
</varlistentry>
<varlistentry>
<term><guimenuitem>LD_CONFIG_PATH</guimenuitem></term>
<listitem><para>The location of dynamic libraries. This allows cron jobs to execute
applications which have libraries they need to run installed outside the system library path.</para></listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Value</guilabel></term>
<listitem><para>Enter the environment variable value.</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Comment</guilabel></term>
<listitem><para>Enter a description for the environment variable, such as its
purpose.</para></listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Enable this variable</guilabel></term>
<listitem>
<para>To enable or disable the variable, select or de-select
this button.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guibutton>OK</guibutton></term>
<listitem>
<para>Completes the setting of this variable.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guibutton>Cancel</guibutton></term>
<listitem>
<para>Cancels the setting of this variable.</para>
</listitem>
</varlistentry>
</variablelist>
<para>The environment variable is not actually set up until the
<filename>crontab</filename> has been saved.</para>
</sect3>
</sect2>
<sect2 id="manage-variables">
<title>Managing Environment Variables</title>
<note><para>As with creating new variables, changes to variables will
not actually be made until the <filename>crontab</filename> is
saved.</para></note>
<para>Use the buttons at the right of the variable list to modify or delete
a selected variable. You reach all these actions from the
context menu as well. Additionally the context menu provides actions to
cut, copy and paste variables.</para>
</sect2>
<!--
<sect2 id="saving-crontab">
<title>Saving the <filename>crontab</filename></title>
<para>Once all scheduled tasks and environment variables have been
created and/or properly modified, save the <filename>crontab</filename>
by selecting
<menuchoice>
<guimenu>File</guimenu> <guimenuitem>Save</guimenuitem> </menuchoice>.</para>
<para>Alternatively, you can simply press <keycombo
action="simul">&Ctrl;<keycap>S</keycap></keycombo>. Additions or changes
will not actually be made until this is done.</para>
</sect2>
<sect2 id="printing-crontab">
<title>Printing the <filename>crontab</filename></title>
<para>To print the <filename>crontab</filename> as it has been saved,
select <menuchoice> <guimenu>File</guimenu>
<guimenuitem>Print</guimenuitem> </menuchoice>.</para>
<para>The standard &kde; printer dialog will display. If you select
<guilabel>Expand</guilabel> you will see that there are two extra
&kcron; specific options in the Print Dialog box.</para>
<variablelist>
<varlistentry>
<term><guilabel>Print Crontab</guilabel></term>
<listitem>
<para>Prints the <filename>crontab</filename> for the current user.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Print All Users</guilabel></term>
<listitem>
<para>Prints the <filename>crontab</filename>s for all users. This option is
enabled only for users with super-user privileges.</para>
</listitem>
</varlistentry>
</variablelist>
</sect2>
-->
</sect1>
</article>
<!--
Local Variables:
mode: sgml
sgml-minimize-attributes:nil
sgml-general-insert-case:lower
sgml-indent-step:0
sgml-indent-data:nil
End:
-->

BIN
kcron/doc/kcronstart.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 36 KiB

BIN
kcron/doc/newtask.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 64 KiB

BIN
kcron/doc/newvariable.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 25 KiB

1
kget/CMakeLists.txt
View file

@ -104,7 +104,6 @@ add_subdirectory(sounds)
add_subdirectory(desktop)
add_subdirectory(plasma)
add_subdirectory(tests)
add_subdirectory(doc)
macro_optional_find_package(KDE4Workspace)
macro_log_feature(KDE4WORKSPACE_FOUND "KDE4Workspace" "KDE4 workspace libraries, part of kdebase-workspace" "http://www.kde.org" FALSE "" "Allows 'shutdown after downloads completed' in kget")

2
kget/doc/CMakeLists.txt
View file

@ -1,2 +0,0 @@
########### install files ###############
kde4_create_handbook(index.docbook INSTALL_DESTINATION ${HTML_INSTALL_DIR}/en SUBDIR kget)

BIN
kget/doc/file.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 62 KiB

BIN
kget/doc/import_link.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 36 KiB

817
kget/doc/index.docbook
View file

@ -1,817 +0,0 @@
<?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
<!-- Define an entity for your application if it is not part of KDE CVS -->
<!ENTITY kget "<application>KGet</application>">
<!ENTITY kappname "&kget;"><!-- replace kget here do *not* replace kappname-->
<!ENTITY package "kdenetwork">
<!ENTITY % addindex "IGNORE">
<!ENTITY % English "INCLUDE">
]>
<book id="kget" lang="&language;">
<bookinfo>
<title>The &kget; Handbook</title>
<authorgroup>
<author>
<personname>
<firstname>Gaurav</firstname>
<surname>Chaturvedi</surname>
</personname>
<email>gaurav.p.chaturvedi@gmail.com</email>
</author>
<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>
<copyright>
<year>2009</year>
<holder>Gaurav Chaturvedi</holder>
</copyright>
<legalnotice>&FDLNotice;</legalnotice>
<date>2010-07-17</date>
<releaseinfo>2.4.93 (&kde; 4.5)</releaseinfo>
<!-- Abstract about this handbook -->
<abstract>
<para>
&kget; is the download manager for &kde;
</para>
</abstract>
<keywordset>
<keyword>KDE</keyword>
<keyword>kdenetwork</keyword>
<keyword>kget</keyword>
<keyword>kppp</keyword>
<keyword>download</keyword>
</keywordset>
</bookinfo>
<chapter id="Introduction">
<title>Introduction</title>
<para>
<orderedlist>
<listitem><para>Start &kget; (you should see a Drop Target)</para></listitem>
<listitem><para>Drag and drop the required &URL; in the &kget; window/Drop Target.</para></listitem>
</orderedlist>
<screenshot>
<screeninfo>Screenshot of &kget;</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="kget_group.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Screenshot of &kget;</phrase>
</textobject>
</mediaobject>
</screenshot>
</para>
</chapter>
<chapter id="KGet_Drop_Target">
<title> &kget; Drop Target </title>
<para>
The &kget; Drop Target has four options.
</para>
<screenshot>
<screeninfo>Screenshot of &kget; drop target</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="kget_drop_target.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Screenshot of &kget; drop target</phrase>
</textobject>
</mediaobject>
</screenshot>
<sect1 id="kget-features">
<title> &kget; Drop Target options</title>
<para>
Right click on the drop target to see the options.
</para>
<variablelist>
<varlistentry>
<term>
<menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>R</keycap></keycombo>
</shortcut>
<guimenuitem>Start / Resume All</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>To start a download or resume all the pending downloads. The shortcut for doing this is <keycombo action="simul">&Ctrl;<keycap>R</keycap></keycombo></action>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<guimenuitem>Show/Hide Main Window</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>This option shows or minimizes the main window to the system tray.</action>
</para>
</listitem>
</varlistentry>
<!-- no longer in 4.5
<varlistentry>
<term>
<menuchoice>
<guimenuitem>Show Drop Target</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Uncheck this box to make the &kget; Drop Target go away.</action>
</para>
</listitem>
</varlistentry>
-->
<varlistentry>
<term>
<menuchoice>
<guimenuitem>Sticky</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Makes the &kget; drop target undraggable.</action>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<guimenuitem>Quit &kget;</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Quits &kget;</action>
</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
</chapter>
<chapter id="Configuration">
<title> &kget;'s Configuration window </title>
<variablelist>
<varlistentry>
<term><menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Configure &kget;</guimenuitem>
</menuchoice></term>
<listitem><para><action>Opens the &kget; configuration window</action></para></listitem>
</varlistentry>
</variablelist>
<sect1 id="Appearance">
<title>Appearance</title>
<para>
<screenshot>
<screeninfo>Appearance</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="kget_Appearance.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Appearance</phrase>
</textobject>
</mediaobject>
</screenshot>
</para>
<para>
<variablelist>
<varlistentry>
<term>
<menuchoice>
<guimenuitem>Appearance</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>You can modify the various appearance related stuff here.</action>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<guimenuitem>Show splashscreen</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Check this check box to show a splashscreen before startup.</action>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<guimenuitem>Show drop target</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Uncheck this if you do not want the &kget; Drop Target.</action>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<guimenuitem>Enable animations</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Enables few fancy animations.</action>
</para>
</listitem>
</varlistentry>
<!-- what is this?
<varlistentry>
<term>
<menuchoice>
<guimenuitem>Enable popup tooltip</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>???</action>
</para>
</listitem>
</varlistentry>
-->
</variablelist>
</para>
</sect1>
<sect1 id="Groups">
<title>Groups</title>
<para>You can group downloads.</para>
<screenshot>
<screeninfo>&kget; Groups</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="kget_groups.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>&kget; Groups</phrase>
</textobject>
</mediaobject>
</screenshot>
<para>
<variablelist>
<varlistentry>
<term>
<menuchoice>
<guimenuitem>Use default folders for groups as suggestion</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Tick this box if you want &kget; to use default folders for your downloads.</action>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</sect1>
<sect1 id="Network">
<title>Network</title>
<para>You can modify your network related settings here.</para>
<screenshot>
<screeninfo>&kget; Network</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="kget_Network.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>&kget; Network</phrase>
</textobject>
</mediaobject>
</screenshot>
<para>
<variablelist>
<varlistentry>
<term>
<menuchoice>
<guimenuitem>Limit Maximum Downloads Per Group</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Check this box if you want Download limits to be implemented.</action>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<guimenuitem>Number of downloads</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>You can set the maximum simultaneous downloads using this box.</action>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<guimenuitem>Speed Limit</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Check this box if you want the Global speed limits to be used.</action>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<guimenuitem>Global download limit</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Set the maximum global download limit.</action>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<guimenuitem>Global upload limit</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Set the maximum upload limit.</action>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<guimenuitem>Reconnect on Error or Broken Connection</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Check this box if you want &kget; to reconnect after an error or a broken connection.</action>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<guimenuitem>Number of retries</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Set the maximum number of time &kget; will try to reconnect.</action>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<guimenuitem>Retry after</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Set the retrying interval here (in seconds)</action>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</sect1>
<sect1 id='Web_Interface'>
<title>Web Interface</title>
<para>
To enable the web interface, check <guilabel>Enable Web Interface</guilabel>;
default port is 8080, and you configure any port higher than 1024. Then set
<guilabel>User</guilabel> and <guilabel>Password</guilabel>.
You can access your web interface at http://127.0.0.1:&lt;port&gt;.
You will need to enter the username and password to get access.
</para>
<screenshot>
<screeninfo>&kget; Web Interface</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="kget_Web_Interface.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>&kget; Web Interface</phrase>
</textobject>
</mediaobject>
</screenshot>
</sect1>
<sect1 id='Verification'>
<title>Verification</title>
<para>Verify your downloads.</para>
<screenshot>
<screeninfo>&kget; Verification</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="kget_verification.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>&kget; Verification</phrase>
</textobject>
</mediaobject>
</screenshot>
<para>Using the two methods <guilabel>Checksums</guilabel> and <guilabel>Signature</guilabel>
you can verify your downloads. You just have to tick the Automatic verification check box.</para>
</sect1>
<sect1 id='Advanced'>
<title>Advanced</title>
<para>Modify Advanced Options.</para>
<screenshot>
<screeninfo>&kget; Advanced Options</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="kget_Advanced.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>&kget; Advanced Options</phrase>
</textobject>
</mediaobject>
</screenshot>
<variablelist>
<varlistentry>
<term>
<menuchoice>
<guimenuitem>Disable confirmation dialogs (less verbosity)</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>Disables the confirmation dialogs</action>, which causes verbosity.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<guimenuitem>Enable system tray icon</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>This check box enables the &kget; system tray icon.</action>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<guimenuitem>Execute action after all downloads have been finished</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action> Check this box to enable Quitting &kget; after all downloads have finished.
At startup you can choose to Restore Download state. Such as Stop All downloads/ Start All downloads.</action>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<guimenuitem>History backend</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>You can choose your history backend as Sqlite or Xml.</action>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<guimenuitem>Use as download manager for Konqueror</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>You can set &kget; as your download manager for &konqueror;.</action>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<guimenuitem>Monitor clipboard for files to download</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<!--
<action>Blank</action>
-->
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<guimenuitem>Enable &kde; global progress tracking</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>
<action>You can set &kget; to show every single download or show overall progress.</action>
</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
</chapter>
<chapter id="Main_Window">
<title>Main Window</title>
<para>Overview of &kget;'s Main Window</para>
<screenshot>
<screeninfo>Screenshot of &kget;</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="file.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Screenshot of &kget;</phrase>
</textobject>
</mediaobject>
</screenshot>
<sect1 id='File_Options'>
<title>The <guimenu>File</guimenu> Menu</title>
<variablelist>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>
</shortcut>
<guimenu>File</guimenu>
<guimenuitem>New Download...</guimenuitem>
</menuchoice></term>
<listitem><para><action>Add a new file to download</action></para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>I</keycap></keycombo>
</shortcut>
<guimenu>File</guimenu>
<guimenuitem>Import Transfers...</guimenuitem>
</menuchoice></term>
<listitem><para><action>Loads a *.kgt, *.metalink, *.meta4 or *.torrent file.</action></para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>E</keycap></keycombo>
</shortcut>
<guimenu>File</guimenu>
<guimenuitem>Export Transfers List...</guimenuitem>
</menuchoice></term>
<listitem><para><action>Export the highlighted links to a .kgt file, to be loaded later.</action></para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>P</keycap></keycombo>
</shortcut>
<guimenu>File</guimenu>
<guimenuitem>Export Transfers as Plain Text...</guimenuitem>
</menuchoice></term>
<listitem><para><action>Exports the links being downloaded as plain text.</action></para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>L</keycap></keycombo>
</shortcut>
<guimenu>File</guimenu>
<guimenuitem>Import Links...</guimenuitem>
</menuchoice></term>
<listitem>
<screenshot>
<screeninfo>Import Links</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="import_link.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Import Links</phrase>
</textobject>
</mediaobject>
</screenshot>
<para><action>This action brings up another window, where you can see and manipulate which file to download. Also you can make a selection based on <guilabel>Videos</guilabel>, <guilabel>Images</guilabel>, <guilabel>Audio</guilabel> and <guilabel>Archives</guilabel>.
There is also a text box to filter out results.</action></para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>File</guimenu>
<guimenuitem>Create a Metalink</guimenuitem>
</menuchoice></term>
<listitem>
<screenshot>
<screeninfo>Creating a metalink0</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="metalink0.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Creating a Metalink0</phrase>
</textobject>
</mediaobject>
</screenshot>
<para>Select between creating a new Metalink and loading an existing Metalink. Click the <guilabel>Next</guilabel> button to proceed.</para>
<screenshot>
<screeninfo>Creating a metalink1</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="metalink1.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Creating a Metalink1</phrase>
</textobject>
</mediaobject>
</screenshot>
<para>Here you can choose to enter some general optional information. Such as where can this metalink be obtained from (Enter the &URL; in the text box next to <guilabel>Origin</guilabel>).</para>
<screenshot>
<screeninfo>Creating a metalink2</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="metalink2.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Creating a Metalink2</phrase>
</textobject>
</mediaobject>
</screenshot>
<para>Here you have to enter the &URL; from where you are trying to download the file. Also you can enter some optional information such as Preference (Priority) for a particular mirror if you are adding more then one mirrors, for the file you want to download.</para>
<screenshot>
<screeninfo>Creating a metalink 3</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="metalink3.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Creating a Metalink 3</phrase>
</textobject>
</mediaobject>
</screenshot>
<para>You should be able to see a new window where all your files which will be imported will be shown.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>H</keycap></keycombo>
</shortcut>
<guimenu>File</guimenu>
<guimenuitem>Transfer History</guimenuitem>
</menuchoice></term>
<listitem>
<screenshot>
<screeninfo>Transfer History</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="kget_transfer_hostory.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Transfer History</phrase>
</textobject>
</mediaobject>
</screenshot>
<para><action>Opens a new window where you can see all the files downloaded using &kget;.
You can manage your history here, including filter and clear the history. </action></para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo>
</shortcut>
<guimenu>File</guimenu>
<guimenuitem>Quit</guimenuitem>
</menuchoice></term>
<listitem><para><action>Quits &kget;</action></para></listitem>
</varlistentry>
</variablelist>
</sect1>
</chapter>
<chapter id="credits">
<title>Credits and License</title>
<para>
&kget;
</para>
<para>Documentation copyright &copy; 2009 Gaurav Chaturvedi <email>gaurav.p.chaturvedi@gmail.com </email> </para>
<para>Thanks to:</para>
<para>&Anne-Marie.Mahfouf; &Anne-Marie.Mahfouf.mail; (for helping me with DocBook related stuff)</para>
<para>&Jonathan.Drews; &Jonathan.Drews.mail; (copy and pasted a lot of things from his old &kget; documentation) </para>
<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
&underFDL;
&underGPL;
</chapter>
<appendix id="installation">
<title>Installation</title>
<sect1 id="getting-KGet">
<title>How to obtain &kget;</title>
&install.intro.documentation;
</sect1>
<sect1 id="compilation">
<title>Compilation and installation</title>
&install.compile.documentation;
</sect1>
</appendix>
&documentation.index;
</book>
<!--
Local Variables:
mode: sgml
sgml-minimize-attributes:nil
sgml-general-insert-case:lower
sgml-indent-step:0
sgml-indent-data:nil
End:
// vim:ts=2:sw=2:tw=78:noet:noai
-->

BIN
kget/doc/kget_Advanced.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 50 KiB

BIN
kget/doc/kget_Appearance.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 55 KiB

BIN
kget/doc/kget_Network.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 44 KiB

BIN
kget/doc/kget_Web_Interface.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 37 KiB

BIN
kget/doc/kget_drop_target.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 12 KiB

BIN
kget/doc/kget_group.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 62 KiB

BIN
kget/doc/kget_groups.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 44 KiB

BIN
kget/doc/kget_plugins.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 62 KiB

BIN
kget/doc/kget_transfer_hostory.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 24 KiB

BIN
kget/doc/kget_verification.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 56 KiB

BIN
kget/doc/metalink0.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 27 KiB

BIN
kget/doc/metalink1.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 38 KiB

BIN
kget/doc/metalink2.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 16 KiB

BIN
kget/doc/metalink3.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 34 KiB

1
kgpg/CMakeLists.txt
View file

@ -20,7 +20,6 @@ find_package( KdepimLibs REQUIRED )
find_package( Gpgme REQUIRED )
add_subdirectory( icons )
add_subdirectory( doc )
include_directories( ${KDE4_INCLUDES} ${KDEPIMLIBS_INCLUDE_DIR} ${GPGME_INCLUDES} )
option(KGPG_DEBUG_TRANSACTIONS "show commands and results of gpg calls in debug log" Off)

3
kgpg/doc/CMakeLists.txt
View file

@ -1,3 +0,0 @@
########### install files ###############
#
kde4_create_handbook(index.docbook INSTALL_DESTINATION ${HTML_INSTALL_DIR}/en SUBDIR kgpg)

BIN
kgpg/doc/editor.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 52 KiB

545
kgpg/doc/index.docbook
View file

@ -1,545 +0,0 @@
<?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN"
"dtd/kdex.dtd" [
<!ENTITY package "kdeutils">
<!ENTITY kappname "&kgpg;">
<!ENTITY % addindex "IGNORE">
<!ENTITY % English "INCLUDE">
]>
<book id="kgpg" lang="&language;">
<bookinfo>
<title>The &kgpg; Handbook</title>
<authorgroup>
<author>
<firstname>Jean-Baptiste</firstname>
<surname>Mardelle</surname>
<affiliation>
<address><email>bj@altern.org</email></address>
</affiliation>
</author>
<author>
<firstname>Rolf Eike</firstname>
<surname>Beer</surname>
<affiliation>
<address><email>kde@opensource.sf-tec.de</email></address>
</affiliation>
</author>
<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>
<copyright>
<year>2002</year>
<year>2007</year>
<year>2008</year>
<year>2009</year>
<year>2010</year>
<holder>Jean-Baptiste Mardelle</holder>
<holder>Rolf Eike Beer</holder>
</copyright>
<legalnotice>&FDLNotice;</legalnotice>
<date>2013-05-25</date>
<releaseinfo>2.9.50 (&kde; 4.11)</releaseinfo>
<abstract>
<para>
&kgpg; is a simple graphical interface for GnuPG (<ulink
url="http://gnupg.org">http://gnupg.org</ulink>).
</para>
</abstract>
<keywordset>
<keyword>KDE</keyword>
<keyword>KGpg</keyword>
<keyword>encryption</keyword>
<keyword>gpg</keyword>
<keyword>pgp</keyword>
<keyword>security</keyword>
</keywordset>
</bookinfo>
<chapter id="introduction">
<title>Introduction</title>
<para>&kgpg; is a simple interface for GnuPG, a powerful encryption utility. GnuPG (also known as gpg) is included in most distributions and should be installed on your system. You can get the latest version on <ulink
url="http://gnupg.org">http://gnupg.org</ulink>.</para>
<para>With &kgpg; you will be able to encrypt and decrypt your files and emails, allowing much more secure communications. A mini howto on encryption with gpg is available on <ulink url="http://www.gnupg.org/documentation/howtos.en.html">GnuPG's web site</ulink>.
</para>
<para>With &kgpg;, you don't need to remember gpg's command lines and options. Almost everything can be done with a few mouse clicks.
</para>
</chapter>
<chapter id="getting-started">
<title>Getting Started</title>
<para>Here is a list of &kgpg;'s main components:</para>
<variablelist>
<varlistentry>
<term>System Tray Icon </term>
<listitem>
<screenshot>
<screeninfo>&kgpg; system tray applet</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="systray.png" format="PNG"/></imageobject>
</mediaobject>
</screenshot>
<para>
When you start &kgpg;, a system tray icon will appear. A &LMB;
click will open the Key Manager window, while a &RMB; click will open a menu allowing quick access to some important features. If you prefer other options you can change the &LMB; action to show the editor or completely disable the system tray icon using the <link linkend="conf-misc">settings dialog</link>.
</para>
<para>Please note that the system tray icon of &kgpg; is marked as &quot;inactive&quot; basically all the time. Since the system tray applet will usually hide inactive icons the one of &kgpg; will not be shown until you explicitly request it. For details please have a look at the &plasma; documentation.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Key Manager Window</term>
<listitem>
<screenshot>
<screeninfo>Key manager window</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="keymanage.png" format="PNG"/></imageobject>
</mediaobject>
</screenshot>
<para>That's the central place to manage your keys. To open the <link linkend="keymanager">Key Manager window</link>, click with the &LMB; on &kgpg;'s applet.
You can import, export, sign and edit your keys. Most actions can be performed with a &RMB; click on a key.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Editor Window</term>
<listitem>
<screenshot>
<screeninfo>Editor window</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="editor.png" format="PNG"/></imageobject>
</mediaobject>
</screenshot>
<para>It's a simple text editor, where you can type or paste text to encrypt/decrypt it. To open the <link linkend="editor">editor</link>, click with the &RMB; on &kgpg;'s applet.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>File manager integration</term>
<listitem>
<para>&kgpg; is integrated in &konqueror; and Dolphin. It means that when you right click on a file, you can choose
<menuchoice><guimenu>Actions</guimenu><guimenuitem>Encrypt
File</guimenuitem></menuchoice> to encrypt a file. You can decrypt a file with a &LMB; click.
</para>
</listitem>
</varlistentry>
</variablelist>
</chapter>
<chapter id="using-kgpg">
<title>Using &kgpg;</title>
<para>
There are two ways to encrypt your data:
<itemizedlist>
<listitem><para>Symmetrical encryption: your data is just encrypted with a password. Anybody who has a computer with gpg can decrypt your message if you give him/her the password. To perform a symmetrical encryption, choose "symmetrical encryption" in the options box when asked to choose an encryption key.</para></listitem>
<listitem><para>Key encryption: you must first create your key pair (secret key and public key) and give a passphrase. Keep your secret key in a safe place, and exchange your public key with your friends. Then, if you want to send an encrypted message to Alex, you must encrypt the message with Alex's public key. To decrypt the message, the recipient will need Alex's secret key and passphrase.</para></listitem>
</itemizedlist>
</para>
<para>Key encryption is a bit more complicated (you must exchange keys with your friends) but safer. Remember that if you encrypt a message with someone else's key, you will not be able to decrypt it. You can only decrypt messages that have been encrypted with your public key.</para>
<sect1 id="key-generation">
<title>Generating a key</title>
<para>If you don't have a key, &kgpg; will automatically pop up
the key generation dialog at the first startup. You can also access it
in the Key Manager from
<menuchoice><guimenu>Keys</guimenu><guimenuitem>Generate Key
Pair</guimenuitem></menuchoice>.</para>
<screenshot>
<screeninfo>Key generation dialog</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="keygen.png" format="PNG"/></imageobject>
</mediaobject>
</screenshot>
<para>Simply enter your name, Email address and click
<guibutton>Ok</guibutton>. This will generate a standard gpg key. If
you want more options, you can click on the <guibutton>Expert Mode</guibutton> button, which
will bring up a &konsole; window with all of gpg's options.</para>
<para>Many people play around with their first
key, generate bad user ids, add comments they later regret or simply forget their
passphrase. To avoid such keys to stay valid forever it's usually a good idea
to limit the lifetime to some 12 month. You can modify the lifetime of your
secret keys later using the <link linkend="keyproperties">key properties window</link>.</para>
</sect1>
<sect1 id="key-revoke">
<title>Revoking a key</title>
<para>A key pair that has expired can be brought back into an operational state
as long as you have access to the private key and the passphrase. To
reliably render a key unusable you need to revoke it. Revoking is done by
adding a special revocation signature to the key.</para>
<para>This revocation signature can be created together with the key. In this
case it is stored in a separate file. This file can later be imported into
the keyring and is then attached to the key rendering it unusable. Please
note that to import this signature to the key no password is required.
Therefore you should store this revocation signature in a safe place,
usually one that is different from you key pair. It is a good advise to
use a place that is detached from your computer, either copy it to an
external storage device like an USB stick or print it out.</para>
<para>If you have not created such a detached revocation on key creation you can
create such a revocation signature at any time choosing <menuchoice><guimenu>Keys</guimenu>
<guimenuitem>Revoke key</guimenuitem></menuchoice>,
optionally importing it to your keyring immediately.</para>
</sect1>
<sect1 id="encryption">
<title>Encrypting Your Data</title>
<sect2 id="konqui">
<title>Encrypting a file from &konqueror; or Dolphin</title>
<para>Click on the file you want to encrypt with the &RMB;. Choose <menuchoice><guimenu>Actions</guimenu><guimenuitem>Encrypt File</guimenuitem></menuchoice> in the pop up menu. You will then be prompted with the Public key selection dialog. Choose the key of the recipient and click <guibutton>Encrypt</guibutton>. The encrypted file will be saved with a <literal
role="extension">.asc</literal> or <literal role="extension">.gpg</literal> extension depending on whether you chose <guilabel>ASCII armored encryption</guilabel> or not. ASCII encrypted files only use readable characters to represent the data resulting in files that are more robust when copied around or sent by mail but are one third larger.</para>
<screenshot>
<screeninfo>Here is a screen shot of the key selection window</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="keys.png" format="PNG"/></imageobject>
</mediaobject>
</screenshot>
</sect2>
<sect2 id="drop">
<title>Encrypting a text with &kgpg;'s applet</title>
<para>You can encrypt the contents of the clipboard by selecting the
<guimenuitem>Encrypt clipboard</guimenuitem> item in applet menu. When you
choose <guimenuitem>Sign clipboard</guimenuitem> then the text will be signed
instead. Both actions will import the current clipboard contents into an
<link linkend="editor">editor window</link>, perform the requested action and
paste the contents back into the editor.</para>
</sect2>
<sect2 id="editor">
<title>Encrypting text from &kgpg;'s editor</title>
<para>This is as simple as clicking on the
<guibutton>Encrypt</guibutton> button. You will then be prompted with
the Public key selection dialog. Choose your key and click
<guibutton>Ok</guibutton>. The encrypted message will
appear in the editor window.</para>
<para>Usually you can only encrypt files with keys that are trusted by
you. Since you sometimes want to just send a confident note to some random
people you are aware of having a GPG key you can set the option
<guilabel>Allow encryption with untrusted keys</guilabel>.</para>
<para>To make sure that you can decrypt every file you have encrypted even if
they are encrypted with someone else's key you can use the options
<guilabel>Always encrypt with</guilabel> and <guilabel>Encrypt files with</guilabel>
which are available in the <link linkend="conf-encryption">KGpg configuration</link>.</para>
<para>For more information on the encryption options <guilabel>ASCII
armor</guilabel>, <guilabel>Allow encryption with untrusted keys</guilabel> and
<guilabel>Symmetrical encryption</guilabel>, please refer to gpg's
documentation or <ulink url="man:gpg">man pages</ulink>.</para>
</sect2>
</sect1>
<sect1 id="decryption">
<title>Decrypting Your Data</title>
<sect2 id="konq-dec">
<title>Decrypting a file from &konqueror; or Dolphin</title>
<para><mousebutton>Left</mousebutton> click on the file you want to
decrypt. Enter your passphrase and it will be decrypted. You can also
drag an encrypted text file and drop it into &kgpg;'s editor window. It
will then ask the passphrase and open the decrypted text in &kgpg;'s
editor. You can even drop remote files ! You can also use the
<menuchoice><guimenu>File</guimenu><guimenuitem>Decrypt
File</guimenuitem></menuchoice> and choose a file to decrypt.</para>
</sect2>
<sect2 id="applet-dec">
<title>Decrypting text with &kgpg;'s applet</title>
<para>You can also decrypt the contents of the clipboard with the
<guimenuitem>decrypt clipboard</guimenuitem> menu
entry of the &kgpg; applet. An <link linkend="editor">editor window</link>
will show up with the decrypted text.</para>
</sect2>
<sect2 id="editor-dec">
<title>Decrypting a text from the editor</title>
<para>Copy or Drag and Drop the text you want to decrypt, and click on
the <guibutton>Decrypt</guibutton> button. You will be prompted for the
passphrase.
</para>
</sect2>
</sect1>
<sect1 id="manage">
<title>Key Management</title>
<para>All basic key management options can be performed through
&kgpg;. To open the key management window click the &LMB; on &kgpg;'s applet.
Most options are available with a <mousebutton>right</mousebutton> click on a key.
To import/export public keys, you can use drag
and drop or the Copy/Paste keyboard shortcuts.</para>
<sect2 id="keymanager">
<title>Key Manager</title>
<screenshot>
<screeninfo>Here's a screen shot of key management</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="keymanage.png" format="PNG"/></imageobject>
</mediaobject>
</screenshot>
<para>In this example you see a key group containing two keys, two key pairs and three public keys. The third column shows the trust you have in the keys. The first key pair is ultimately trusted and is also set as the default key (bold font) while the second one has expired. Two of the public keys are fully trusted while the trust of the last key is marginal. The last key is expanded, showing it's ElGamal subkey, an additional user id, both also with marginal trust, and some of it's signatures.</para>
<para>Signatures allow navigating through your keyring. Double clicking on a signature or a key shown as member of a group will jump directly to the corresponding primary key.</para>
</sect2>
<sect2 id="keyproperties">
<title>Key properties</title>
<screenshot>
<screeninfo>The key properties window</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="keyprop.png" format="PNG"/></imageobject>
</mediaobject>
</screenshot>
<para>While the key manager allows you to do general actions with one or multiple keys, key groups or signatures, the key properties window gives you access to a single key. You can reach it by pressing enter in the key manager or double clicking the key.</para>
<para>In this window you can change the key passphrase and expiration of your secret keys. For all keys you can also set the owner trust value.</para>
<para>This value indicates how much you trust the owner of this key to correctly verify the identity of the keys he signs. Taking the owner trust into account gpg creates your own web of trust. You trust the keys you signed. If you assign owner trust to these persons you will also trust the keys they have signed without the need that you first have to sign their keys too.</para>
</sect2>
<sect2 id="keysigning">
<title>Signing keys</title>
<para>When you sign a key of someone else (let's call her Alice) you announce that you are sure that this key really belongs to that person and the key can be trusted. Of course you really should have checked that. This usually means that you have to meet Alice, check at least one identity card and get the full key fingerprint or a copy of her key. Then you go home and sign that key. Usually you will later upload the newly signed key to a <link linkend="keyserver">key server</link> so everyone knows you have checked that key and the owner may be trusted. Alice will likely do the same so you both will have your keys signed by the other one. If one of you has no identity card at hand it's no problem if the signing happens in only direction.</para>
<para>But think about what happens if Alice lives on the other end of the world. You communicate with her regularly but there is no chance you will see her anytime soon. How do you trust her key?</para>
<para>When you select her key and then choose <guimenuitem>Sign Key...</guimenuitem> you will get the dialog that allows you to choose the options how you would like to sign that key.</para>
<screenshot>
<screeninfo>Selecting a Secret Key for Signing</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="select-secret-key.png" format="PNG"/></imageobject>
</mediaobject>
</screenshot>
<para>First you can choose the key you will use to sign the key. Then you can enter how carefully you checked that she really is the person she pretends to be. This information will be stored together with the signature so it is a guidance for everyone else who might need that signature (more on this below). And then comes the option that would help you if you can't meet Alice in person: <guilabel>Local signature (cannot be exported)</guilabel>. When you activate that option a special version of a signature will be created that can never even by accident leave you keyring.</para>
<para>But why is it important how carefully you checked Alice's identity? Who should care? There is a different way to solve your problem with the identity of Alice. If you can't visit Alice anytime soon just think of Trent. You know Trent has a keypair, too. And Trent is a globetrotter, being on a different continent at least twice a month. If you are lucky he will fly close to Alice soon. So you will go and meet with Trent to sign keys. Then you will drop Alice a note that Trent will be at her place soon and ask her if she can meet with him too to sign keys. After all this has happened you know that Trent's key can be trusted and Trent knows that Alice's key can be trusted. If you trust Trent that he has carefully checked Alice's identity then you can also trust her key.</para>
<para>These relationships between keys and their owners form a so called web of trust. Within that web there are some important values that define how trustworthy a particular key is. The first thing is how carefully the identity of the key owner was checked. That is the value you have seen above in the secret key selection window. For example you will likely know how to verify your local countries identity card but one from a completely different country may be hard to verify. So you could say that you have very carefully checked Trent's identity because you have seen his identity card and it looks very much the same as yours. But Trent, although he has seen both Alice's identity card and driver license might say he has only done casual checking of her identity as he is not absolutely sure about the documents from that part of the world.</para>
<para>The next important value is how much you trust the other person to verify documents. You know Trent is good at that. But George for example is no one you would call smart. He barely looked at your id card when you met him for key signing. You are sure that George is the person he pretends to be as you checked his documents carefully. But he doesn't seem to really care if he checks other people so you will have a high trust in the key of George but a very low trust in the signatures of George. If you open the <link linkend="keyproperties">properties</link> of a key you will find the field <guilabel>Owner Trust</guilabel>. This is how much you trust the key owner when he signs keys. This value will not be exported, it is completely up to your personal preference.</para>
<screenshot>
<screeninfo>The key properties window</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="keyprop.png" format="PNG"/></imageobject>
</mediaobject>
</screenshot>
<para>Now you should have an idea how the web of trust is built, what the owner and key trust values are for, and why you always should be very careful when checking identities: other people might rely on you. But one element in the process is still unverified: the email addresses in the keys you signed. Creating a new user identity in your key with the email address of Alice or Trent will only take a few mouse clicks. You have verified that Trent really owns his key. But noone has checked until now that Trent really controls the email addresses of his user identities.</para>
<para>If you choose <guimenuitem>Sign and Mail User ID...</guimenuitem> from the menu instead you can close that gap. The idea is that you will sign the key as usual and afterwards it will be split into pieces. Every piece will only contain one user identity of Trent's key and your signature to it. This will be encrypted with Trent's key and sent only to the email address given in that identity. Only if Trent can receive this mail and decrypt the message he will be able to import that signature into his key ring. You will not upload your signatures, this is entirely up to him. If your signature will show up on a key server you can be sure that Trent really controls both his key as well as the email address you signed. The signatures you make in this process will also be not part of your keyring. So right after you signed Trent's key it will still be shown as untrusted in your keyring. Once Trent has received your mail and imported your signature into his keyring he can upload them to a keyserver. When you refresh his key from a keyserver you will get the new signatures. While that may sound inconvenient first it makes sure that you will not by accident see one of his identities as trusted that he does not control. Only the signatures that show up on a keyserver are those where everyone, including you, can be sure that he really controls the corresponding email addresses.</para>
</sect2>
</sect1>
<sect1 id="keyserver">
<title>Working with key servers</title>
<sect2>
<title>Communication with key servers</title>
<para>The public part of a key pair is usually stored on a key server. These servers allow anyone to search for a key belonging to a specific person or mail address. The signatures are also stored on these servers.</para>
<screenshot>
<screeninfo>Here's a screen shot of keyserver window.</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="keyserver.png" format="PNG"/></imageobject>
</mediaobject>
</screenshot>
<para>This dialog gives you access to the keyservers. You can search and import keys from a keyserver as well as export keys to a server. An example of searching and importing is when you want to write a mail to someone new. If you would like to encrypt your mail to your contact you can search if he or she has a public key on the key servers. If you have created a new key pair or have signed someone else's key you might want to export the public key (possibly with new signatures) to a keyserver.</para>
<para>Most keyservers synchronize their data between each others so you will get similar search results regardless which server you use. Since there are exceptions of this rule you can choose the keyserver to use in this dialog. It's usually a good idea to choose a default keyserver that is located close to you (i.e. in your country or on your continent) as they usually respond faster to your queries.</para>
<para>Please note that everything you upload to a keyserver usually stays there forever. This is one reason you should usually limit the lifetime of your keys. Also note that the keyservers are sometimes scanned by spammers for email addresses.</para>
</sect2>
<sect2 id="keyserver-results">
<title>Key server search results</title>
<screenshot>
<screeninfo>This is an example of the results of a keyserver search.</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="keyserver-search.png" format="PNG"/></imageobject>
</mediaobject>
</screenshot>
<para>All results of a search are displayed in this window. This picture shows a search for &quot;@kde.org&quot; addresses which showed up 244 results. Using the search field the displayed list was reduced to a single key. This key has two matches: the primary user id itself matches the search string as well as one of the other user ids.</para>
<para>You can select one or more keys to import. The ids of those keys are shown in the <guilabel>Keys to import</guilabel> field at the bottom of the window. When you click on <guibutton>Import</guibutton> the key server is contacted again and the keys are fetched into your keyring.</para>
</sect2>
</sect1>
<sect1 id="options">
<title>Configuring &kgpg;</title>
<para>Configuration is accessible through the &kgpg; applet menu (&RMB;
click on the applet) or through the main menu (
<menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure KGpg</guimenuitem></menuchoice>).
You can set default parameters for encryption, decryption, user interface and applet.
Most encryption options are directly related to gpg and are documented in it's <ulink url="man:gpg">man page</ulink>.</para>
<sect2 id="conf-encryption">
<title>Encryption</title>
<screenshot>
<screeninfo>A screen shot of the option dialog with encryption tab opened</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="options.png" format="PNG"/></imageobject>
</mediaobject>
</screenshot>
<para>Here you can configure special options to be passed to GnuPG to change the encryption behavior. For detailed description please have a look at the GnuPG manual.</para>
<itemizedlist>
<listitem><para><guilabel>ASCII armored encryption</guilabel>: this causes encrypted files to be stored in a format that uses only printable ASCII characters and has short lines. Files stored this way are bigger than the files in binary format but are easier to send &eg; by email.</para></listitem>
<listitem><para><guilabel>Allow encryption with untrusted keys</guilabel>: this allows you to encrypt files with keys that are not trusted by you.</para></listitem>
<listitem><para><guilabel>PGP 6 compatibility</guilabel>: encrypted files are compatible with the older PGP6 standard. This disables certain features so you should only use this if really needed.</para></listitem>
<listitem><para><guilabel>Hide user id</guilabel>: this removes all evidence of the receiver from the encrypted file. In case the transmission is intercepted noone could gain information about the recipient from the file. If the receiver has multiple keys he needs to try which one was used.</para></listitem>
<listitem><para><guilabel>Always encrypt with</guilabel>: all encryptions are additionally encrypted with this key. If you set this to one of your private keys this makes sure you can read all data you encrypted by the price of bigger messages.</para></listitem>
<listitem><para><guilabel>Encrypt files with</guilabel>: behaves like <guilabel>Always encrypt with</guilabel> for file encryption.</para></listitem>
<listitem><para><guilabel>Custom encryption command</guilabel>: if you need to pass some unusual options to GnuPG you can specify the command line here. Most users will not need this.</para></listitem>
<listitem><para><guilabel>Use *.pgp extension for encrypted files</guilabel>: if you check this option encrypted files will be named as the input file with the extension <literal role="extension">.pgp</literal> added, otherwise the extension <literal role="extension">.gpg</literal> is used.</para></listitem>
</itemizedlist>
</sect2>
<sect2 id="conf-decryption">
<title>Decryption</title>
<para>Here you can specify a custom decryption command. This option is seldomly needed and only useful for advanced users that know of GnuPGs command line options.</para>
</sect2>
<sect2 id="conf-appearance">
<title>Appearance</title>
<para>Here you can configure the way &kgpg; looks to you. Possible settings are the colors that reflect the different levels of key trust in the <link linkend="keymanager">key manager</link> and the font settings for the <link linkend="editor">editor</link>.</para>
</sect2>
<sect2 id="conf-gnupg">
<title>GnuPG Settings</title>
<para>Here you can configure which gpg binary and which <guilabel>configuration file</guilabel> and home folder are used. These values are autodetected on first start and should already work.</para>
<para>Using the <ulink url="man:gpg-agent">GnuPG agent</ulink> makes work with GnuPG more comfortable as you do not need to type in your password for every action. It is cached in memory for a while so any operation that would require a password can immediately be done. Note that this may allow other people to use your private keys if you leave your session accessible to them.</para>
</sect2>
<sect2 id="conf-keyservers">
<title>Key Servers</title>
<para>Here you can create a list of keyservers that are shown to you when you open the <link linkend="keyserver">key server dialog</link>. If you run GnuPG from the command line only the key server you set as default here will be used.</para>
<para>The protocol used for communication with the key servers is based on &HTTP;, so it makes sense in some environments to <guilabel>honor the &HTTP; proxy when available</guilabel>.</para>
</sect2>
<sect2 id="conf-misc">
<title>Misc</title>
<para>This section allows the setting of some different features that do not fit into the other sections. You can configure for example to <guilabel>start KGpg automatically at login</guilabel>. The option <guilabel>use mouse selection instead of clipboard</guilabel> changes if selection happens by mouse and pasting by middle mouse button or if all operations are done by keyboard shortcuts.</para>
<para>You can also change if the systray icon of &kgpg; is shown or not and what action happens if the icon is clicked with the &LMB;. If the systray icon is shown closing the &kgpg; window will minimize the application to tray. If the systray icon is not shown &kgpg; will exit when all windows are closed.</para>
</sect2>
</sect1>
</chapter>
<chapter id="credits">
<title>Credits and License</title>
<para>
&kgpg;
</para>
<para>Program copyright &copy; 2002-2003 Jean-Baptiste Mardelle
<email>bj@altern.org</email>.</para>
<para>&copy; 2006-2007 Jimmy Gilles
<email>jimmygilles@gmail.com</email></para>
<para>&copy; 2006,2007,2008,2009,2010 Rolf Eike Beer
<email>kde@opensource.sf-tec.de</email>
</para>
<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
&underFDL; <!-- FDL: do not remove -->
&underGPL;
</chapter>
&documentation.index;
</book>
<!--
Local Variables:
mode: sgml
sgml-minimize-attributes: nil
sgml-general-insert-case: lower
sgml-intent-step:0
sgml-indent-data:nil
End:
-->

BIN
kgpg/doc/keygen.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 23 KiB

BIN
kgpg/doc/keymanage.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 76 KiB

BIN
kgpg/doc/keyprop.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 36 KiB

BIN
kgpg/doc/keys.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 33 KiB

BIN
kgpg/doc/keyserver-search.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 22 KiB

BIN
kgpg/doc/keyserver.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 18 KiB

BIN
kgpg/doc/options.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 46 KiB

BIN
kgpg/doc/select-secret-key.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 24 KiB

BIN
kgpg/doc/systray.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 8.3 KiB

1
kmix/CMakeLists.txt
View file

@ -48,7 +48,6 @@ configure_file (config.h.cmake ${CMAKE_CURRENT_BINARY_DIR}/config.h )
include_directories( ${GLIB2_INCLUDE_DIR} /usr/lib/oss/include)
add_subdirectory( doc )
add_subdirectory( pics )
add_subdirectory( profiles )
#add_subdirectory( tests )

2
kmix/doc/CMakeLists.txt
View file

@ -1,2 +0,0 @@
########### install files ###############
kde4_create_handbook(index.docbook INSTALL_DESTINATION ${HTML_INSTALL_DIR}/en SUBDIR kmix)

84
kmix/doc/ControlNames.txt
View file

@ -1,84 +0,0 @@
This document describes standard names of mixer controls.
Syntax: SOURCE [DIRECTION] FUNCTION
DIRECTION:
<nothing> (both directions)
Playback
Capture
Bypass Playback
Bypass Capture
FUNCTION:
Switch (on/off switch)
Volume
Route (route control, hardware specific)
SOURCE:
Master
Master Mono
Hardware Master
Headphone
PC Speaker
Phone
Phone Input
Phone Output
Synth
FM
Mic
Line
CD
Video
Zoom Video
Aux
PCM
PCM Front
PCM Rear
PCM Pan
Loopback
Analog Loopback (D/A -> A/D loopback)
Digital Loopback (playback -> capture loopback - without analog path)
Mono
Mono Output
Multi
ADC
Wave
Music
I2S
IEC958
Exceptions:
[Digital] Capture Source
[Digital] Capture Switch (aka input gain switch)
[Digital] Capture Volume (aka input gain volume)
[Digital] Playback Switch (aka output gain switch)
[Digital] Playback Volume (aka output gain volume)
Tone Control - Switch
Tone Control - Bass
Tone Control - Treble
3D Control - Switch
3D Control - Center
3D Control - Depth
3D Control - Wide
3D Control - Space
3D Control - Level
Mic Boost [(?dB)]
PCM interface:
Sample Clock Source { "Word", "Internal", "AutoSync" }
Clock Sync Status { "Lock", "Sync", "No Lock" }
External Rate /* external capture rate */
Capture Rate /* capture rate taken from external source */
IEC958 (S/PDIF) interface:
IEC958 [...] [Playback|Capture] Switch /* turn on/off the IEC958 interface */
IEC958 [...] [Playback|Capture] Volume /* digital volume control */
IEC958 [...] [Playback|Capture] Default /* default or global value - read/write */
IEC958 [...] [Playback|Capture] Mask /* consumer and professional mask */
IEC958 [...] [Playback|Capture] Con Mask /* consumer mask */
IEC958 [...] [Playback|Capture] Pro Mask /* professional mask */
IEC958 [...] [Playback|Capture] PCM Stream /* the settings assigned to a PCM stream */
IEC958 Q-subcode [Playback|Capture] Default /* Q-subcode bits */
IEC958 Preamble [Playback|Capture] Default /* burst preamble words (4*16bits) */

457
kmix/doc/index.docbook
View file

@ -1,457 +0,0 @@
<?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
<!ENTITY kappname "&kmix;">
<!ENTITY package "kdemultimedia">
<!ENTITY % English "INCLUDE" > <!-- change language only here -->
<!ENTITY % addindex "IGNORE">
]>
<book id="kmix" lang="&language;">
<bookinfo>
<title>The &kmix; Handbook</title>
<authorgroup>
<author>
<firstname>Gaurav</firstname>
<surname>Chaturvedi</surname>
<address><email>gaurav.p.chaturvedi@gmail.com</email></address>
</author>
<othercredit role="developer">
<firstname>Christian</firstname>
<surname>Esken</surname>
<affiliation><address><email>esken@kde.org</email></address></affiliation>
<contrib>Developer</contrib>
</othercredit>
<othercredit role="developer">
<firstname>Helio</firstname>
<surname>Chissini de Castro</surname>
<affiliation><address><email>helio@kde.org</email></address></affiliation>
<contrib>Developer</contrib>
</othercredit>
<othercredit role="developer">
<firstname>Brian</firstname>
<surname>Hanson</surname>
<affiliation><address><email>bhanson@hotmail.com</email></address></affiliation>
<contrib>Developer</contrib>
</othercredit>
<!-- TRANS:ROLES_OF_TRANSLATORS -->
</authorgroup>
<copyright>
<year>1996</year><year>2005</year>
<holder>Christian Esken &amp; &Matt.Johnston;</holder>
</copyright>
<legalnotice>&FDLNotice;</legalnotice>
<date>2013-12-21</date>
<releaseinfo>4.5 (&kde; 4.13)</releaseinfo>
<abstract>
<para>&kmix; is an application that allows you to change the volume of your sound card.</para>
</abstract>
<keywordset>
<keyword>KDE</keyword>
<keyword>KMix</keyword>
<keyword>kdemultimedia</keyword>
<keyword>sound</keyword>
<keyword>volume</keyword>
<keyword>mixer</keyword>
</keywordset>
</bookinfo>
<!-- FIXME
http://kmix5.wordpress.com/2012/06/26/kmixs-top-secret-features-part-1-volume-presets/
-->
<chapter id="introduction">
<title>Introduction</title>
<!--<para>&kmix; is &kde;'s soundcard mixer program. Though small, it is
full-featured. The program should give controls for each of your
soundcards.</para>-->
<para>&kmix; supports several platforms and sound drivers.</para>
<!--<itemizedlist>
<listitem><para> The ALSA soundcard driver.</para></listitem>
<listitem><para> All Open Sound System platforms. Explicitly tested are &Linux;, FreeBSD, NetBSD and BSDI.</para></listitem>
<listitem><para> &Solaris; based machines.</para></listitem>
<listitem><para> &HP-UX; based machines.</para></listitem>
</itemizedlist>-->
<para>If you have both ALSA and Open Sound System drivers installed, &kmix; will use the ALSA driver.</para>
<para>
<screenshot>
<screeninfo>Screenshot of &kmix;</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="kmix.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Screenshot of &kmix;</phrase>
</textobject>
</mediaobject>
</screenshot>
</para>
</chapter>
<chapter id="Main_Window">
<title>Main Window</title>
<para>Overview of &kmix; Main Window</para>
<screenshot>
<screeninfo>Screenshot of &kmix;</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="kmix.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Screenshot of &kmix;</phrase>
</textobject>
</mediaobject>
</screenshot>
<sect1 id='File_Options'>
<title>File Options</title>
<screenshot>
<screeninfo>&kmix; File options</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="kmix-file.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>&kmix; File options</phrase>
</textobject>
</mediaobject>
</screenshot>
<variablelist>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo action="simul">&Esc;</keycombo>
</shortcut>
<guimenu>File</guimenu>
<guimenuitem>Hide Mixer Window</guimenuitem>
</menuchoice></term>
<listitem><para><action>Hide Mixer Window</action></para></listitem>
</varlistentry>
</variablelist>
</sect1>
<sect1 id='Settings'>
<title>Settings</title>
<screenshot>
<screeninfo>&kmix; Settings</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="kmix-options.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>&kmix; Settings</phrase>
</textobject>
</mediaobject>
</screenshot>
<variablelist>
<varlistentry>
<term><menuchoice>
<guimenu>Settings</guimenu>
<guimenuitem>Audio Setup</guimenuitem>
</menuchoice></term>
<listitem><para><action>Open <ulink url="help:/kcontrol/phonon">&phonon; &systemsettings; module</ulink></action> to configure the sound and video device preference and the backends used by &kde; multimedia API, &phonon;.</para></listitem>
</varlistentry>
</variablelist>
<!-- Unavailable for standard PulseAudio configuration
<sect2 id='Channels'>
<title>Configure &kmix; Channels</title>
<screenshot>
<screeninfo>&kmix; Channels</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="kmix-channels.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>&kmix; Channels</phrase>
</textobject>
</mediaobject>
</screenshot>
<para>Select the &kmix; channels you want to be used for output or input audio information.</para>
</sect2>
-->
<sect2 id='Master_Channels'>
<title>Select Master Channel</title>
<screenshot>
<screeninfo>&kmix; Master Channel</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="kmix-master.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>&kmix; Master Channel</phrase>
</textobject>
</mediaobject>
</screenshot>
<para>Select your &kmix; master channel.</para>
</sect2>
<sect2 id='Configure'>
<title>Configure &kmix;</title>
<sect3 id="configure-general">
<title>
General configuration
</title>
<screenshot>
<screeninfo>General configuration of &kmix;</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="kmix-configure-general.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>General configuration of &kmix;</phrase>
</textobject>
</mediaobject>
</screenshot>
<para>Configure general &kmix; parameters.</para>
<variablelist>
<varlistentry>
<term><menuchoice>
<guimenu>Behavior</guimenu>
<guimenuitem>Volume Feedback</guimenuitem>
</menuchoice></term>
<listitem><para><action>Check this box to enable audible feedback on volume change.</action></para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Behavior</guimenu>
<guimenuitem>Volume Overdrive</guimenuitem>
</menuchoice></term>
<listitem><para>Check this box to allow volume to be more than recommended value (sometimes PulseAudio maximal volume exceeds the normal value). &kmix; restart is needed for this setting to take effect.</para>
<warning>
<para>
Uncheck this item if there are audible sound distortions at the maximal volume.
</para>
</warning>
</listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Visual</guimenu>
<guimenuitem>Show tickmarks</guimenuitem>
</menuchoice></term>
<listitem><para><action>Check this box to show tickmarks on controls.</action></para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Visual</guimenu>
<guimenuitem>Show labels</guimenuitem>
</menuchoice></term>
<listitem><para><action>Check this box to show labels of controls.</action></para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Visual</guimenu>
<guimenuitem>Show On Screen Display (OSD)</guimenuitem>
</menuchoice></term>
<listitem><para><action>Check this box to enable OSD show on hovering &kmix; tray widget.</action></para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Slider orientation</guimenu>
<guimenuitem>Horizontal</guimenuitem>
</menuchoice></term>
<listitem><para><action>Check this radio button to orientate the control slider horizontally.</action></para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Slider orientation</guimenu>
<guimenuitem>Vertical</guimenuitem>
</menuchoice></term>
<listitem><para><action>Check this radio button to orientate the control slider vertically.</action></para></listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Slider orientation (System tray volume control)</guimenu>
<guimenuitem>Horizontal/Vertical</guimenuitem>
</menuchoice></term>
<listitem><para>Same as the previous two radio buttons but for the system tray volume control (the panel that is shown after &LMB; click on &kmix; tray icon).</para></listitem>
</varlistentry>
</variablelist>
</sect3>
<sect3 id="configure-start">
<title>
Start configuration
</title>
<screenshot>
<screeninfo>Start configuration of &kmix;</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="kmix-configure-start.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Start configuration of &kmix;</phrase>
</textobject>
</mediaobject>
</screenshot>
<para>This page allows you to configure various &kmix; start parameters.</para>
<variablelist>
<varlistentry>
<term><menuchoice>
<guimenu>Startup</guimenu>
<guimenuitem>Restore volumes on login</guimenuitem>
</menuchoice></term>
<listitem><para><action>Check this box to enable volume restoration on login.</action></para>
<warning>
<para>
Dynamic controls from PulseAudio and MPRIS2 will not be restored.
</para>
</warning>
</listitem>
</varlistentry>
<varlistentry>
<term><menuchoice>
<guimenu>Startup</guimenu>
<guimenuitem>Autostart</guimenuitem>
</menuchoice></term>
<listitem><para><action>Check this box to enable &kmix; autostart with desktop environment.</action></para></listitem>
</varlistentry>
</variablelist>
</sect3>
<sect3 id="configure-sound-menu">
<title>
Sound menu configuration
</title>
<screenshot>
<screeninfo>Sound menu configuration of &kmix;</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="kmix-configure-sound-menu.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Sound menu configuration of &kmix;</phrase>
</textobject>
</mediaobject>
</screenshot>
<para>This page allows you to configure various &kmix; sound menu parameters.</para>
<variablelist>
<varlistentry>
<term><guilabel>Dock in system tray</guilabel>
</term>
<listitem><para><action>Check this box to dock &kmix; in system tray.</action></para></listitem>
</varlistentry>
</variablelist>
<para>
It is possible to select mixers that will be shown in the sound menu using the corresponding list on this page.
</para>
</sect3>
</sect2>
</sect1>
</chapter>
<chapter id="advanced">
<title>Advanced usage</title>
<sect1>
<title>Remote controlling and scripting via &DBus;</title>
<para>
You can control &kmix; via &DBus;. This is for advanced users who want to achieve special tasks, like muting the PC every day at 10 pm, or for any other scripting task.
</para>
<para>
List all &kmix; related &DBus; methods and properties
<programlisting>qdbus org.kde.kmix</programlisting>
</para>
<para>
Getting volume level (0-100%):
<programlisting>qdbus org.kde.kmix /Mixers/0/Master_0 org.freedesktop.DBus.Properties.Get org.kde.KMix.Control volume</programlisting>
</para>
<para>
Setting volume level (0-100%):
<programlisting>qdbus org.kde.kmix /Mixers/0/Master_0 org.freedesktop.DBus.Properties.Set org.kde.KMix.Control volume 70</programlisting>
</para>
</sect1>
</chapter>
<chapter id="credits">
<title>Credits and License</title>
<para>
&kmix;
</para>
<para>Documentation copyright &copy; 2010 Gaurav Chaturvedi <email>gaurav.p.chaturvedi@gmail.com </email> </para>
<para>Thanks to:</para>
<para>&Matt.Johnston; &Matt.Johnston.mail; (copy and pasted a lot of things from his old &kmix; documentation) </para>
<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
&underFDL;
&underGPL;
</chapter>
<appendix id="installation">
<title>Installation</title>
<sect1 id="getting-Kmix">
<title>How to obtain &kmix;</title>
&install.intro.documentation;
</sect1>
<sect1 id="compilation">
<title>Compilation and installation</title>
&install.compile.documentation;
</sect1>
</appendix>
&documentation.index;
</book>
<!--
Local Variables:
mode: sgml
sgml-minimize-attributes:nil
sgml-general-insert-case:lower
sgml-indent-step:0
sgml-indent-data:nil
End:
// vim:ts=2:sw=2:tw=78:noet:noai
-->

BIN
kmix/doc/kmix-configure-general.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 17 KiB

BIN
kmix/doc/kmix-configure-sound-menu.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 15 KiB

BIN
kmix/doc/kmix-configure-start.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 12 KiB

BIN
kmix/doc/kmix-file.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 31 KiB

BIN
kmix/doc/kmix-master.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 30 KiB

BIN
kmix/doc/kmix-options.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 37 KiB

BIN
kmix/doc/kmix.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 34 KiB

1
kolourpaint/CMakeLists.txt
View file

@ -70,7 +70,6 @@ ${QIMAGEBLITZ_INCLUDES}
)
add_subdirectory( pics )
add_subdirectory( doc )
########### next target ###############

2
kolourpaint/doc/CMakeLists.txt
View file

@ -1,2 +0,0 @@
########### install files ###############
kde4_create_handbook(index.docbook INSTALL_DESTINATION ${HTML_INSTALL_DIR}/en SUBDIR kolourpaint)

BIN
kolourpaint/doc/KolourPaint.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 54 KiB

BIN
kolourpaint/doc/brush_shapes.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 242 B

BIN
kolourpaint/doc/color_box.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 1.7 KiB

BIN
kolourpaint/doc/eraser_shapes.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 188 B

BIN
kolourpaint/doc/fcc_std_text.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 5.6 KiB

BIN
kolourpaint/doc/fcc_trans_text.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 6.6 KiB

BIN
kolourpaint/doc/fill_color_similarity.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 13 KiB

BIN
kolourpaint/doc/fill_style.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 181 B

BIN
kolourpaint/doc/image_balance.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 49 KiB

BIN
kolourpaint/doc/image_emboss.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 84 KiB

BIN
kolourpaint/doc/image_flatten.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 35 KiB

BIN
kolourpaint/doc/image_invert.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 42 KiB

BIN
kolourpaint/doc/image_reduce_colors.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 34 KiB

BIN
kolourpaint/doc/image_resize_scale.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 42 KiB

BIN
kolourpaint/doc/image_rotate.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 43 KiB

BIN
kolourpaint/doc/image_skew.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 34 KiB

BIN
kolourpaint/doc/image_soften_sharpen.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 89 KiB

1529
kolourpaint/doc/index.docbook
View file

File diff suppressed because it is too large Load diff

BIN
kolourpaint/doc/line_width.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 168 B

BIN
kolourpaint/doc/lines_30_45_deg.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 551 B

BIN
kolourpaint/doc/lines_30_deg.png
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 430 B

Some files were not shown because too many files have changed in this diff Show more