diff options
| author | toma <toma@283d02a7-25f6-0310-bc7c-ecb5cbfe19da> | 2009-11-25 17:56:58 +0000 |
|---|---|---|
| committer | toma <toma@283d02a7-25f6-0310-bc7c-ecb5cbfe19da> | 2009-11-25 17:56:58 +0000 |
| commit | 2bda8f7717adf28da4af0d34fb82f63d2868c31d (patch) | |
| tree | 8d927b7b47a90c4adb646482a52613f58acd6f8c /doc | |
| download | tdeutils-2bda8f7717adf28da4af0d34fb82f63d2868c31d.tar.gz tdeutils-2bda8f7717adf28da4af0d34fb82f63d2868c31d.zip | |
Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features.
BUG:215923
git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/kdeutils@1054174 283d02a7-25f6-0310-bc7c-ecb5cbfe19da
Diffstat (limited to 'doc')
90 files changed, 8614 insertions, 0 deletions
diff --git a/doc/KRegExpEditor/Makefile.am b/doc/KRegExpEditor/Makefile.am new file mode 100644 index 0000000..6872b30 --- /dev/null +++ b/doc/KRegExpEditor/Makefile.am @@ -0,0 +1,5 @@ + +KDE_LANG = en +KDE_DOCS = AUTO + +docdir = $(kde_htmldir)/$(KDE_LANG)/KRegExpEditor diff --git a/doc/KRegExpEditor/altn.png b/doc/KRegExpEditor/altn.png Binary files differnew file mode 100644 index 0000000..900a1e9 --- /dev/null +++ b/doc/KRegExpEditor/altn.png diff --git a/doc/KRegExpEditor/altntool.png b/doc/KRegExpEditor/altntool.png Binary files differnew file mode 100644 index 0000000..2d450e8 --- /dev/null +++ b/doc/KRegExpEditor/altntool.png diff --git a/doc/KRegExpEditor/anychar.png b/doc/KRegExpEditor/anychar.png Binary files differnew file mode 100644 index 0000000..11048ca --- /dev/null +++ b/doc/KRegExpEditor/anychar.png diff --git a/doc/KRegExpEditor/anychartool.png b/doc/KRegExpEditor/anychartool.png Binary files differnew file mode 100644 index 0000000..08425d3 --- /dev/null +++ b/doc/KRegExpEditor/anychartool.png diff --git a/doc/KRegExpEditor/begline.png b/doc/KRegExpEditor/begline.png Binary files differnew file mode 100644 index 0000000..3465a9e --- /dev/null +++ b/doc/KRegExpEditor/begline.png diff --git a/doc/KRegExpEditor/boundarytools.png b/doc/KRegExpEditor/boundarytools.png Binary files differnew file mode 100644 index 0000000..c93d764 --- /dev/null +++ b/doc/KRegExpEditor/boundarytools.png diff --git a/doc/KRegExpEditor/characters.png b/doc/KRegExpEditor/characters.png Binary files differnew file mode 100644 index 0000000..7f218bf --- /dev/null +++ b/doc/KRegExpEditor/characters.png diff --git a/doc/KRegExpEditor/charactertool.png b/doc/KRegExpEditor/charactertool.png Binary files differnew file mode 100644 index 0000000..1690018 --- /dev/null +++ b/doc/KRegExpEditor/charactertool.png diff --git a/doc/KRegExpEditor/compound.png b/doc/KRegExpEditor/compound.png Binary files differnew file mode 100644 index 0000000..a56c9bb --- /dev/null +++ b/doc/KRegExpEditor/compound.png diff --git a/doc/KRegExpEditor/compoundtool.png b/doc/KRegExpEditor/compoundtool.png Binary files differnew file mode 100644 index 0000000..d1ad43c --- /dev/null +++ b/doc/KRegExpEditor/compoundtool.png diff --git a/doc/KRegExpEditor/endline.png b/doc/KRegExpEditor/endline.png Binary files differnew file mode 100644 index 0000000..29b512e --- /dev/null +++ b/doc/KRegExpEditor/endline.png diff --git a/doc/KRegExpEditor/index.docbook b/doc/KRegExpEditor/index.docbook new file mode 100644 index 0000000..fda544f --- /dev/null +++ b/doc/KRegExpEditor/index.docbook @@ -0,0 +1,652 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY % English "INCLUDE"> + <!ENTITY % addindex "IGNORE"> +]> + +<book lang="&language;"> + + <bookinfo> + <title>The Regular Expression Editor Manual</title> + + <authorgroup> + <author> + <firstname>Jesper K.</firstname> + <surname>Pedersen</surname> + <affiliation><address><email>blackie@kde.org</email></address></affiliation> + </author> + </authorgroup> + + <date>2001-07-03</date> + <releaseinfo>0.1</releaseinfo> + + <legalnotice>&underFDL;</legalnotice> + + <copyright> + <year>2001</year> + <holder>Jesper K. Pedersen</holder> + </copyright> + + <abstract> + <para>This Handbook describes the Regular Expression Editor widget</para> + </abstract> + + <keywordset> + <keyword>KDE</keyword> + <keyword>regular expression</keyword> + </keywordset> + </bookinfo> + + <!-- ====================================================================== --> + <!-- Introduction --> + <!-- ====================================================================== --> + <chapter id="introduction"> + <title>Introduction</title> + + + <para> + The regular expression editor is an editor for editing regular expression + in a graphical style (in contrast to the <acronym>ASCII</acronym> syntax). Traditionally + regular expressions have been typed in the <acronym>ASCII</acronym> syntax, which for example + looks like <literal>^.*kde\b</literal>. The major drawbacks of + this style are: + <itemizedlist> + <listitem><para>It is hard to understand for + non-programmers.</para></listitem> + + <listitem><para>It requires that you <emphasis>escape</emphasis> + certain symbols (to match a star for example, you need to type + <literal>\*</literal>). </para></listitem> + + <listitem><para>It requires that you remember rules for + <emphasis>precedence</emphasis> (What does <literal>x|y*</literal> + match? a single <literal>x</literal> or a number of + <literal>y</literal>, <emphasis>OR</emphasis> a number of + <literal>x</literal> and <literal>y</literal>'s mixed?)</para></listitem> + </itemizedlist> + </para> + + <para> + The regular expression editor, on the other hand, lets you + <emphasis>draw</emphasis> your regular expression in an unambiguous + way. The editor solves at least item two and three above. It might not make + regular expressions available for the non-programmers, though only tests by + users can tell that. So, if are you a non programmer, who has gained the + power of regular expression from this editor, then please + <ulink url="mailto:blackie@kde.org">let me know</ulink>. + </para> + + </chapter> + + <!-- ====================================================================== --> + <!-- What is a Regular Expression --> + <!-- ====================================================================== --> + <chapter id="whatIsARegExp"> + <title>What is a Regular Expression</title> + + <para>A regular expression is a way to specify + <emphasis>conditions</emphasis> to be fulfilled for a situation + in mind. Normally when you search in a text editor you specify + the text to search for <emphasis>literally</emphasis>, using a + regular expression, on the other hand, you tell what a given + match would look like. Examples of this include <emphasis>I'm + searching for the word KDE, but only at the beginning of the + line</emphasis>, or <emphasis>I'm searching for the word + <literal>the</literal>, but it must stand on its own</emphasis>, + or <emphasis>I'm searching for files starting with the word + <literal>test</literal>, followed by a number of digits, for + example <literal>test12</literal>, <literal>test107</literal> + and <literal>test007</literal></emphasis></para> + + <para>You build regular expressions from smaller regular + expressions, just like you build large Lego toys from smaller + subparts. As in the Lego world, there are a number of basic + building blocks. In the following I will describe each of these + basic building blocks using a number of examples.</para> + + <example> + <title>Searching for normal text.</title> + <para>If you just want to search for a given text, a then regular + expression is definitely not a good choice. The reason for this is that + regular expressions assign special meaning to some characters. This + includes the following characters: <literal>.*|$</literal>. Thus if you want to + search for the text <literal>kde.</literal> (i.e. the characters + <literal>kde</literal> followed by a period), then you would need to + specify this as <literal>kde\.</literal><footnote><para>The regular + expression editor solves this problem by taking care of escape rules for + you.</para></footnote> Writing <literal>\.</literal> rather than just + <literal>.</literal> is called <emphasis>escaping</emphasis>. + </para> + </example> + + <example id="positionregexp"> + <title>Matching URLs</title> + <para>When you select something looking like a URL in KDE, then the + program <command>klipper</command> will offer to start + <command>konqueror</command> with the selected URL.</para> + + <para><command>Klipper</command> does this by matching the selection + against several different regular expressions, when one of the regular + expressions matches, the accommodating command will be offered.</para> + + <para>The regular expression for URLs says (among other things), that the + selection must start with the text <literal>http://</literal>. This is + described using regular expressions by prefixing the text + <literal>http://</literal> with a hat (the <literal>^</literal> + character).</para> + + <para>The above is an example of matching positions using regular + expressions. Similar, the position <emphasis>end-of-line</emphasis> can + be matched using the character <literal>$</literal> (i.e. a dollar + sign).</para> + </example> + + <example id="boundaryregexp"> + <title>Searching for the word <literal>the</literal>, but not + <emphasis>the</emphasis><literal>re</literal>, + <literal>brea</literal><emphasis>the</emphasis> or + <literal>ano</literal><emphasis>the</emphasis><literal>r</literal></title> + <para>Two extra position types can be matches in the above way, + namely <emphasis>the position at a word boundary</emphasis>, and + <emphasis>the position at a <emphasis>non</emphasis>-word + boundary</emphasis>. The positions are specified using the text + <literal>\b</literal> (for word-boundary) and <literal>\B</literal> (for + non-word boundary)<emphasis></emphasis></para> + + <para>Thus, searching for the word <literal>the</literal> can be done + using the regular expression <literal>\bthe\b</literal>. This specifies + that we are searching for <literal>the</literal> with no letters on each + side of it (i.e. with a word boundary on each side)</para> + + <para>The four position matching regular expressions are inserted in the + regular expression editor using <link linkend="positiontool">four + different positions tool</link></para> + </example> + + <example id="altnregexp"> + <title>Searching for either <literal>this</literal> or <literal>that</literal></title> + <para>Imagine that you want to run through your document searching for + either the word <literal>this</literal> or the word + <literal>that</literal>. With a normal search method you could do this in + two sweeps, the first time around, you would search for + <literal>this</literal>, and the second time around you would search for + <literal>that</literal>.</para> + + <para>Using regular expression searches you would search for both in the + same sweep. You do this by searching for + <literal>this|that</literal>. I.e. separating the two words with a + vertical bar.<footnote><para>Note on each side of the vertical bar is a + regular expression, so this feature is not only for searching for two + different pieces of text, but for searching for two different regular + expressions.</para></footnote></para> + + <para>In the regular expression editor you do not write the vertical bar + yourself, but instead select the <link linkend="altntool">alternative + tool</link>, and insert the smaller regular expressions above each other.</para> + </example> + + <example id="repeatregexp"> + <title>Matching anything</title> + <para>Regular expressions are often compared to wildcard matching in the + shell - that is the capability to specify a number of files using the + asterisk. You will most likely recognize wildcard matching from the + following examples: + <itemizedlist> + <listitem><para><literal>ls *.txt</literal> - here <literal>*.txt</literal> is + the shell wildcard matching every file ending with the + <literal>.txt</literal> extension.</para></listitem> + <listitem><para><literal>cat test??.res</literal> - matching every file starting with + <literal>test</literal> followed by two arbitrary characters, and finally + followed by the test <literal>.res</literal></para></listitem> + </itemizedlist> + </para> + + <para>In the shell the asterisk matches any character any number of + times. In other words, the asterisk matches <emphasis>anything</emphasis>. + This is written like <literal>.*</literal> with regular expression + syntax. The dot matches any single character, i.e. just + <emphasis>one</emphasis> character, and the asterisk, says that the + regular expression prior to it should be matched any number of + times. Together this says any single character any number of + times.</para> + + <para>This may seem overly complicated, but when you get the larger + picture you will see the power. Let me show you another basic regular + expression: <literal>a</literal>. The letter <literal>a</literal> on its + own is a regular expression that matches a single letter, namely the + letter <literal>a</literal>. If we combine this with the asterisk, + i.e. <literal>a*</literal>, then we have a regular expression matching + any number of a's.</para> + + <para>We can combine several regular expression after each + other, for example <literal>ba(na)*</literal>. + <footnote><para><literal>(na)*</literal> just says that what is inside + the parenthesis is repeated any number of times.</para></footnote> + Imagine you had typed this regular expression into the search field in a + text editor, then you would have found the following words (among + others): <literal>ba</literal>, <literal>bana</literal>, + <literal>banana</literal>, <literal>bananananananana</literal> + </para> + + <para>Given the information above, it hopefully isn't hard for you to write the + shell wildcard <literal>test??.res</literal> as a regular expression + Answer: <literal>test..\.res</literal>. The dot on its own is any + character. To match a single dot you must write + <literal>\.</literal><footnote><para>This is called escaping</para></footnote>. In + other word, the regular expression <literal>\.</literal> matches a dot, + while a dot on its own matches any character. </para> + + <para>In the regular expression editor, a repeated regular expression is + created using the <link linkend="repeattool">repeat tool</link> </para> + </example> + + <example id="lookaheadregexp"> + <title>Replacing <literal>&</literal> with + <literal>&amp;</literal> in a HTML document</title> <para>In + HTML the special character <literal>&</literal> must be + written as <literal>&amp;</literal> - this is similar to + escaping in regular expressions.</para> + + <para>Imagine that you have written an HTML document in a normal editor + (e.g. XEmacs or Kate), and you totally forgot about this rule. What you + would do when realized your mistake was to replace every occurrences of + <literal>&</literal> with <literal>&amp;</literal>.</para> + + <para>This can easily be done using normal search and replace, + there is, however, one glitch. Imagine that you did remember + this rule - <emphasis>just a bit</emphasis> - and did it right + in some places. Replacing unconditionally would result in + <literal>&amp;</literal> being replaced with + <literal>&amp;amp;</literal></para> + + <para>What you really want to say is that <literal>&</literal> should + only be replaced if it is <emphasis>not</emphasis> followed by the letters + <literal>amp;</literal>. You can do this using regular expressions using + <emphasis>positive lookahead</emphasis>. </para> + + <para>The regular expression, which only matches an ampersand if it is + not followed by the letters <literal>amp;</literal> looks as follows: + <literal>&(?!amp;)</literal>. This is, of course, easier to read using + the regular expression editor, where you would use the + <link linkend="lookaheadtools">lookahead tools</link>.</para> + </example> + + </chapter> + + <!-- ====================================================================== --> + <!-- Using the Regular Expression Editor --> + <!-- ====================================================================== --> + <chapter id="theEditor"> + <title>Using the Regular Expression Editor</title> + + <para> + This chapter will tell you about how the regular expression editor works. + </para> + + <!-- ====================================================================== --> + <!-- The organization of the screen --> + <!-- ====================================================================== --> + <sect1 id="screenorganization"> + <title>The organization of the screen</title> + + <mediaobject> + <imageobject><imagedata format="PNG" fileref="theEditor.png"/></imageobject> + </mediaobject> + + <para>The most important part of the editor is of course the editing + area, this is the area where you draw your regular expression. This + area is the larger gray one in the middle.</para> + + <para>Above the editing area you have two Toolbars, the first one + contains the <link linkend="editingtools">editing actions</link> - + much like drawing tools in a drawing program. The second Toolbar + contains the <emphasis>whats this</emphasis> button, and buttons + for undo and redo.</para> + + <para>Below the editing area you find the regular expression + currently build, in the so called ascii syntax. The ascii syntax + is updated while you edit the regular expression in the graphical + editor. If you rather want to update the ascii syntax then please + do, the graphical editor is updated on the fly to reflect your + changes.</para> + + <para>Finally to the left of the editor area you will find a number + of pre-built regular expressions. They serve two purposes: (1) When + you load the editor with a regular expression then this regular + expression is made <emphasis>nicer</emphasis> or more comprehensive + by replacing common regular expressions. In the screen dump above, + you can see how the ascii syntax ".*" have been replaced with a box + saying "anything". (2) When you insert regular expression you may + find building blocks for your own regular expression from the set of + pre build regular expressions. See the section on + <link linkend="userdefinedregexps">user defined regular + expressions</link> to learn how to save your own regular expressions.</para> + </sect1> + + <!-- ====================================================================== --> + <!-- Editing Tools --> + <!-- ====================================================================== --> + <sect1 id="editingtools"> + <title>Editing Tools</title> + <para>The text in this section expects that you have read the chapter + on <link linkend="whatIsARegExp">what a regular expression + is</link>, or have previous knowledge on this subject.</para> + + <para>All the editing tools are located in the tool bar above + editing area. Each of them will be described in the following.</para> + + + + <simplesect id="selecttool"> + <title>Selection Tool</title> + <mediaobject> + <imageobject><imagedata format="PNG" fileref="select.png"/> + </imageobject></mediaobject> + <para> The selection tool is used to + mark elements for cut-and-paste and drag-and-drop. This is very + similar to a selection tool in any drawing program.</para> + </simplesect> + + + + <simplesect id="texttool"><title>Text Tool</title> + <mediaobject> + <imageobject> + <imagedata format="PNG" fileref="text.png"/> + </imageobject></mediaobject> + + <para><inlinemediaobject><imageobject> + <imagedata format="PNG" fileref="texttool.png"/> + </imageobject></inlinemediaobject></para> + + <para>Using this tool you will insert normal text to match. The + text is matched literally, i.e. you do not have to worry about + escaping of special characters. In the example above the following + regular expression will be build: <literal>abc\*\\\)</literal></para> + </simplesect> + + + + <simplesect id="characterstool"><title>Character Tool</title> + <mediaobject><imageobject> + <imagedata format="PNG" fileref="characters.png"/> + </imageobject></mediaobject> + <para><inlinemediaobject><imageobject> + <imagedata format="PNG" fileref="charactertool.png"/> + </imageobject></inlinemediaobject></para> + + <para> Using this tool you insert + character ranges. Examples includes what in ASCII text says + <literal>[0-9]</literal>, <literal>[^a-zA-Z,_]</literal>. When + inserting an item with this tool a dialog will appear, in which + you specify the character ranges.</para> + + <para>See description of <link linkend="repeatregexp">repeated + regular expressions</link>.</para> + </simplesect> + + + + <simplesect id="anychartool"><title>Any Character Tool</title> + <mediaobject><imageobject> + <imagedata format="PNG" fileref="anychar.png"/> + </imageobject></mediaobject> + <para><inlinemediaobject><imageobject><imagedata format="PNG" fileref="anychartool.png"/> + </imageobject></inlinemediaobject></para> + + <para>This is the regular expression "dot" (.). It matches any + single character.</para> + + + + </simplesect> + + + + <simplesect id="repeattool"><title>Repeat Tool</title> + <mediaobject><imageobject> + <imagedata format="PNG" fileref="repeat.png"/> + </imageobject></mediaobject> + <para><inlinemediaobject><imageobject> + <imagedata format="PNG" fileref="repeattool.png"/> + </imageobject></inlinemediaobject></para> + + <para>This is the repeated + elements. This includes what in ASCII syntax is represented + using an asterix (*), a plus (+), a question mark (?), and + ranges ({3,5}). When you insert an item using this tool, a + dialog will appear asking for the number of times to + repeat.</para> + + <para>You specify what to repeat by drawing the repeated content + inside the box which this tool inserts.</para> + + <para>Repeated elements can both be built from the outside in and + the inside + out. That is you can first draw what to be repeated, select it + and use the repeat tool to repeat it. Alternatively you can + first insert the repeat element, and draw what is to be repeated + inside it.</para> + + <para>See description on the <link linkend="repeatregexp">repeated + regular expressions</link>.</para> + </simplesect> + + + + + <simplesect id="altntool"><title>Alternative Tool</title> + <mediaobject><imageobject> + <imagedata format="PNG" fileref="altn.png"/> + </imageobject></mediaobject> + <para><inlinemediaobject><imageobject><imagedata format="PNG" fileref="altntool.png"/> + </imageobject></inlinemediaobject></para> + + <para>This is the alternative regular expression (|). You specify + the alternatives by drawing each alternative on top of each other + inside the box that this tool inserts.</para> + + <para>See description on <link linkend="altnregexp">alternative + regular expressions</link></para> + </simplesect> + + + + + <simplesect id="compoundtool"><title>Compound Tool</title> + <mediaobject><imageobject> + <imagedata format="PNG" fileref="compound.png"/> + </imageobject></mediaobject> + <para><inlinemediaobject><imageobject><imagedata format="PNG" fileref="compoundtool.png"/> + </imageobject></inlinemediaobject></para> + + <para>The compound tool does not represent any regular + expressions. It is used to group other sub parts together in a + box, which easily can be collapsed to only its title. This can be + seen in the right part of the screen dump above.</para> + </simplesect> + + + + + + <simplesect id="positiontool"><title>Line Start/End Tools</title> + <mediaobject><imageobject> + <imagedata format="PNG" fileref="begline.png"/> + </imageobject></mediaobject> + <mediaobject><imageobject> + <imagedata format="PNG" fileref="endline.png"/> + </imageobject></mediaobject> + <para><inlinemediaobject><imageobject><imagedata format="PNG" fileref="linestartendtool.png"/> + </imageobject></inlinemediaobject></para> + + <para>The line start and line end tools matches the start of the + line, and the end of the line respectively. The regular + expression in the screen dump above thus matches lines only + matches spaces.</para> + + <para>See description of <link linkend="positionregexp">position + regular expressions</link>.</para> + </simplesect> + + + + + + <simplesect><title>Word (Non)Boundary Tools</title> + <mediaobject><imageobject> + <imagedata format="PNG" fileref="wordboundary.png"/> + </imageobject></mediaobject> + <mediaobject><imageobject><imagedata format="PNG" fileref="nonwordboundary.png"/> + </imageobject></mediaobject> + <para><inlinemediaobject><imageobject><imagedata format="PNG" fileref="boundarytools.png"/> + </imageobject></inlinemediaobject></para> + + <para>The boundary tools matches a word boundary respectively a + non-word boundary. The regular expression in the screen dump thus + matches any words starting with <literal>the</literal>. The word + <literal>the</literal> itself is, however, not matched.</para> + + <para>See description of <link linkend="boundaryregexp">boundary + regular expressions</link>.</para> + </simplesect> + + + + + + <simplesect id="lookaheadtools"><title>Positive/Negative Lookahead + Tools</title> + <mediaobject><imageobject> <imagedata format="PNG" fileref="poslookahead.png"/> + </imageobject></mediaobject> + <mediaobject><imageobject> <imagedata format="PNG" fileref="neglookahead.png"/> + </imageobject></mediaobject> + + <para><inlinemediaobject><imageobject> <imagedata format="PNG" fileref="lookaheadtools.png"/> + </imageobject></inlinemediaobject></para> + + <para>The look ahead tools either specify a positive or negative + regular expression to match. The match is, however, not part of + the total match.</para> + + <para>Note: You are only allowed to place lookaheads at the end + of the regular expressions. The Regular Expression Editor widget + does not enforce this.</para> + + <para>See description of <link linkend="lookaheadregexp">look ahead + regular expressions</link>.</para> + </simplesect> + </sect1> + + <!-- ====================================================================== --> + <!-- User Defined Regular Expressions --> + <!-- ====================================================================== --> + <sect1 id="userdefinedregexps"> + <title>User Defined Regular Expressions</title> + <para>Located at the left of the editing area is a list box + containing user defined regular expressions. Some regular + expressions are pre-installed with your KDE installation, while + others you can save yourself.</para> + + <para>These regular expression serves two purposes + (<link linkend="screenorganization">see detailed + description</link>), namely (1) to offer you a set of building + block and (2) to make common regular expressions prettier.</para> + + <para>You can save your own regular expressions by right clicking the + mouse button in the editing area, and choosing <literal>Save Regular + Expression</literal>.</para> + + <para>If the regular expression you save is within a + <link linkend="compoundtool">compound container</link> then the + regular expression will take part in making subsequent regular + expressions prettier.</para> + + <para>User defined regular expressions can be deleted or renamed by + pressing the right mouse button on top of the regular expression in + question in the list box.</para> + </sect1> + </chapter> + + <!-- ====================================================================== --> + <!-- Reporting a bug and Suggesting Features --> + <!-- ====================================================================== --> + <chapter id="bugreport"> + <title>Reporting bugs and Suggesting Features</title> + <para>Bug reports and feature requests should be submitted through the + <ulink url="http://bugs.kde.org/">KDE Bug Tracking System</ulink>. <emphasis + role="strong">Before</emphasis> you report a bug or suggest a feature, + please check that it hasn't already been + <ulink url="http://bugs.kde.org/simple_search.cgi?id=kregexpeditor">reported/suggested.</ulink></para> + </chapter> + + <!-- ====================================================================== --> + <!-- FAQ --> + <!-- ====================================================================== --> + <chapter id="faq"> + <title>Frequently Asked Questions</title> + <sect1 id="question1"> + <title>Does the regular expression editor support back references?</title> + <para>No currently this is not supported. It is planned for the next + version.</para> + </sect1> + + <sect1 id="question2"> + <title>Does the regular expression editor support showing matches?</title> + <para>No, hopefully this will be available in the next version.</para> + </sect1> + + <sect1 id="question3"> + <title>I'm the author of a KDE program, how can I use this widget in + my application?</title> + <para>See <ulink + url="http://developer.kde.org/documentation/library/cvs-api/classref/interfaces/KRegExpEditorInterface.html">The documentation for the class KRegExpEditorInterface</ulink>.</para> + </sect1> + + <sect1 id="question4"> + <title>I can't find the <emphasis>Edit Regular expression</emphasis> button in for example + konqueror on another KDE3 installation, why?</title> + <para>The regular expression widget is located in the package + KDE-utils. If you do not have this package installed, then the + <emphasis>edit regular expressions</emphasis> buttons will not + appear in the programs.</para> + </sect1> + </chapter> + + <!-- ====================================================================== --> + <!-- Credits and Licenses --> + <!-- ====================================================================== --> + <chapter id="credits-and-license"> + <title>Credits and Licenses</title> + + <para> + Documentation is copyright 2001, Jesper K. Pedersen + <email>blackie@kde.org</email> + </para> + + + &underGPL; + &underFDL; + + </chapter> + + +</book> + +<!-- Keep this comment at the end of the file +Local variables: +mode: sgml +sgml-omittag:t +sgml-shorttag:t +sgml-namecase-general:t +sgml-general-insert-case:lower +sgml-minimize-attributes:nil +sgml-always-quote-attributes:t +sgml-indent-step:2 +sgml-indent-data:t +sgml-parent-document:nil +sgml-exposed-tags:nil +sgml-local-catalogs:nil +sgml-local-ecat-files:nil +End: +--> diff --git a/doc/KRegExpEditor/linestartendtool.png b/doc/KRegExpEditor/linestartendtool.png Binary files differnew file mode 100644 index 0000000..e7c1bd8 --- /dev/null +++ b/doc/KRegExpEditor/linestartendtool.png diff --git a/doc/KRegExpEditor/lookaheadtools.png b/doc/KRegExpEditor/lookaheadtools.png Binary files differnew file mode 100644 index 0000000..a986f50 --- /dev/null +++ b/doc/KRegExpEditor/lookaheadtools.png diff --git a/doc/KRegExpEditor/neglookahead.png b/doc/KRegExpEditor/neglookahead.png Binary files differnew file mode 100644 index 0000000..3cc0291 --- /dev/null +++ b/doc/KRegExpEditor/neglookahead.png diff --git a/doc/KRegExpEditor/nonwordboundary.png b/doc/KRegExpEditor/nonwordboundary.png Binary files differnew file mode 100644 index 0000000..b22f4d4 --- /dev/null +++ b/doc/KRegExpEditor/nonwordboundary.png diff --git a/doc/KRegExpEditor/poslookahead.png b/doc/KRegExpEditor/poslookahead.png Binary files differnew file mode 100644 index 0000000..492692b --- /dev/null +++ b/doc/KRegExpEditor/poslookahead.png diff --git a/doc/KRegExpEditor/repeat.png b/doc/KRegExpEditor/repeat.png Binary files differnew file mode 100644 index 0000000..2646111 --- /dev/null +++ b/doc/KRegExpEditor/repeat.png diff --git a/doc/KRegExpEditor/repeattool.png b/doc/KRegExpEditor/repeattool.png Binary files differnew file mode 100644 index 0000000..5d525e9 --- /dev/null +++ b/doc/KRegExpEditor/repeattool.png diff --git a/doc/KRegExpEditor/select.png b/doc/KRegExpEditor/select.png Binary files differnew file mode 100644 index 0000000..e04ab17 --- /dev/null +++ b/doc/KRegExpEditor/select.png diff --git a/doc/KRegExpEditor/text.png b/doc/KRegExpEditor/text.png Binary files differnew file mode 100644 index 0000000..8b256ca --- /dev/null +++ b/doc/KRegExpEditor/text.png diff --git a/doc/KRegExpEditor/texttool.png b/doc/KRegExpEditor/texttool.png Binary files differnew file mode 100644 index 0000000..8c92526 --- /dev/null +++ b/doc/KRegExpEditor/texttool.png diff --git a/doc/KRegExpEditor/theEditor.png b/doc/KRegExpEditor/theEditor.png Binary files differnew file mode 100644 index 0000000..4e2468f --- /dev/null +++ b/doc/KRegExpEditor/theEditor.png diff --git a/doc/KRegExpEditor/wordboundary.png b/doc/KRegExpEditor/wordboundary.png Binary files differnew file mode 100644 index 0000000..0e89a6b --- /dev/null +++ b/doc/KRegExpEditor/wordboundary.png diff --git a/doc/Makefile.am b/doc/Makefile.am new file mode 100644 index 0000000..6812bd2 --- /dev/null +++ b/doc/Makefile.am @@ -0,0 +1,5 @@ + +KDE_LANG = en +KDE_DOCS = AUTO +SUBDIRS = $(AUTODIRS) + diff --git a/doc/ark/Makefile.am b/doc/ark/Makefile.am new file mode 100644 index 0000000..bed8857 --- /dev/null +++ b/doc/ark/Makefile.am @@ -0,0 +1,5 @@ + +KDE_LANG = en +KDE_DOCS = AUTO + +KDE_MANS = AUTO
\ No newline at end of file diff --git a/doc/ark/index.docbook b/doc/ark/index.docbook new file mode 100644 index 0000000..224bc29 --- /dev/null +++ b/doc/ark/index.docbook @@ -0,0 +1,793 @@ +<?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 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>2004-06-19</date> +<releaseinfo>2.3.1</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>lha</keyword> +<keyword>kdeutils</keyword> +<keyword>ark</keyword> +</keywordset> +</bookinfo> + +<chapter id="introduction"> +<title>Introduction</title> + +<para>&ark; is a program for managing various archive formats within the +&kde; environment. Archives can be viewed, extracted, created and +modified from within &ark;. The program can handle various formats such +as <command>tar</command>, <command>gzip</command>, +<command>bzip2</command>, <command>zip</command>, <command>rar</command> and +<command>lha</command> (if appropriate command-line programs are +installed). &ark; can work closely with &konqueror; in the &kde; +environment to handle archives, if you install the &konqueror; Integration plugin available in the kdeaddons package.</para> + +</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> from the <guimenu>File</guimenu> +menu. You can also open archive files by dragging and dropping from +&konqueror;. Archive files should be associated with &ark;, so you can +also <mousebutton>right</mousebutton> click a file in &konqueror; and +select <guimenuitem>&ark;</guimenuitem> to open it.</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 +<mousebutton>right</mousebutton> clicking on a file within the +archive, or selecting a file and using the <guimenu>Action</guimenu> +menu, you can choose what you want to do:</para> + +<itemizedlist> +<listitem> +<para><guimenuitem>Extract</guimenuitem> will extract the file to a location you +specify on disk.</para> +</listitem> +<listitem> +<para><guimenuitem>Delete</guimenuitem> will remove the currently +selected file(s) from the archive.</para> +</listitem> +<listitem> +<para><guimenuitem>View</guimenuitem> will open the file in the integrated viewer, or in the default +viewer program in case the integrated viewer cannot view the file, or you have disabled it in the Configuration Window.</para> +</listitem> +<listitem> +<para><guimenuitem>Open With...</guimenuitem> allows you to open the +file in a program you choose.</para> +</listitem> +<listitem> +<para><guimenuitem>Edit With...</guimenuitem> will open the file a +program you choose. The difference between this and <guimenuitem>Open +With...</guimenuitem> is that any changes you make will be saved to the +file in the archive.</para> +</listitem> +</itemizedlist> + +</sect1> + +<sect1 id="ark-extract"> +<title>Extracting Archives</title> + +<para>Once an archive has been opened in &ark;, it can be extracted. To +extract files from an archive, you can either select +<guimenuitem>Extract...</guimenuitem> from the +<guimenu>Action</guimenu> menu or <mousebutton>right</mousebutton> click on the file. The <guilabel>Extract</guilabel> +dialog allows you to select where you will extract files to. You can +also select which files to extract:</para> + +<itemizedlist> +<listitem> +<para><guimenuitem>Current</guimenuitem> extracts the most recently +selected file. If multiple files are selected, only the most recently +selected one will be extracted.</para> +</listitem> +<listitem> +<para><guimenuitem>All</guimenuitem> extracts the entire contents of the +archive.</para> +</listitem> +<listitem> +<para><guimenuitem>Selected Files</guimenuitem> extracts all the files +which have been selected.</para> +</listitem> +<listitem> +<para><guimenuitem>Pattern</guimenuitem> allows you to specify which +files will be extracted, corresponding to certain patterns, ⪚ +<literal role="extension">*.txt</literal> or <literal +role="extension">*.jpg</literal>. Note that you can only use one +pattern at a time.</para> +</listitem> +</itemizedlist> + +<para>You can specify the folder to extract files to in the +<guilabel>Extract to:</guilabel> text box. The default location is the +folder the archive is in. You may also choose to have the folder that you +extract into open in &konqueror; once the extraction is complete.</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;). 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 a file +from &konqueror; or the desktop into the main &ark; window, and it will +be added to the current archive.</para> + +</sect1> + +</chapter> + +<chapter id="configuration"> +<title>Configuring &ark;</title> + +<sect1 id="generalsettings"> +<title>General Settings</title> + +<variablelist> + +<varlistentry> +<term><guilabel>Use integrated viewer</guilabel></term> +<listitem> +<para>Use the integrated viewer to view files, if possible.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Enable Konqueror integration</guilabel></term> +<listitem> +<para>Enable the plugin for extracting or adding files to archives through Konqueror context menus.</para> +<para>This option only works if the Konqueror integration plugin from kdeaddons is installed on your system.</para> +</listitem> +</varlistentry> + +</variablelist> + +</sect1> + +<sect1 id="addition"> +<title>File Addition Settings</title> + +<para>Many of these options are only configurable for specific archive +formats. Other formats may behave either way and are not +configurable.</para> + +<variablelist> +<varlistentry> +<term><guilabel>Replace old files only with newer +files</guilabel></term> +<listitem> +<para>If you add filenames that already exist in an archive, only +replace them if the added files are newer than the ones already +present in the archive.</para> +</listitem> +</varlistentry> +<!-- TODO: Entry seems to have disappearead, confirm that it's not just +hidden because I don't have lha installed +<varlistentry> +<term><guilabel>Keep entries generic (Lha)</guilabel></term> +<listitem> +<para> FIXME: Find out what this is</para> +<para>Affects only Lha archives</para> +</listitem> +</varlistentry> + --> +<varlistentry> +<term><guilabel>Force MS-DOS short filenames (Zip)</guilabel></term> +<listitem> +<para>Force names to the DOS 8.3 format.</para> +<para>Affects only zip files</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Translate LF to DOS CRLF (Zip)</guilabel></term> +<listitem> +<para>Convert the line endings in text files to DOS format from UNIX +format.</para> +<para>Affects only zip files</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Store symlinks as links (Zip, Rar)</guilabel></term> +<listitem> +<para>Save links inside the archive, instead of following them and +including the files being linked to.</para> +<para>Affects zip and rar archives.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Recursively add subfolders (Zip, +Rar)</guilabel></term> +<listitem> +<para>If you add a folder to an archive, also add any +subfolders inside. Affects zip and rar archives</para> +</listitem> +</varlistentry> +</variablelist> + +</sect1> + +<sect1 id="extraction"> +<title>Extraction Settings</title> + +<para>Many of these options are only configurable for specific archive +formats. Other formats may behave either way and are not +configurable.</para> + +<variablelist> +<varlistentry> +<term><guilabel>Overwrite files (Zip, Tar, Zoo, Rar)</guilabel></term> +<listitem> +<para>Overwrite any files that have matching names on disk with the +one from the archive.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Preserve permissions (Tar)</guilabel></term> +<listitem> +<para>Save the user, group, and permission settings on files. Use +with care, as this may result in files being extracted that do not +belong to any valid user on your computer.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Ignore folder names (Zip)</guilabel></term> +<listitem> +<para>Extract all the files into the extraction folder, ignoring +any folder structure in the archive.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Convert filenames to lowercase (Zip, Rar)</guilabel></term> +<term><guilabel>Convert filenames to uppercase (Rar)</guilabel></term> +<listitem> +<para>Extract all files with all lowercase (or uppercase) names.</para> +</listitem> +</varlistentry> + +</variablelist> + +</sect1> + +<sect1 id="folders"> +<title>Folders</title> + +<variablelist> +<varlistentry> +<term><guilabel>Folders</guilabel></term> +<listitem> +<para>This shows the <guilabel>Folders</guilabel> dialog box, so you + can <action>choose the default folders</action>. You can configure a <guilabel>Common folder</guilabel> that will be used for all options, use the last used folder, or a custom folder.</para> +</listitem> +</varlistentry> + +</variablelist> +</sect1> + +</chapter> + +<chapter id="commands"> +<title>Command Reference</title> + +<sect1 id="filemenu"> +<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</guimenuitem> </menuchoice></term> +<listitem> +<para><action>Creates a new archive</action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> <shortcut> <keycombo +action="simul">&Ctrl;<keycap>O</keycap></keycombo> </shortcut> +<guimenu>File</guimenu> +<guimenuitem>Open</guimenuitem> </menuchoice></term> +<listitem> +<para><action>Opens an archive</action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>File</guimenu> +<guisubmenu>Open Recent</guisubmenu> +</menuchoice></term> +<listitem> +<para><action>Shows a list of recent archives to choose +from</action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>File</guimenu> +<guimenuitem>New Window</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Opens a new &ark; window</action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut><keycap>F5</keycap></shortcut> +<guimenu>File</guimenu> +<guimenuitem>Reload</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Loads the current archive again from disk. This will +refresh &ark;'s view if another program has made changes to the +archive.</action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>File</guimenu> +<guimenuitem>Save As</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Allows you to save the current archive under a new file +name</action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>W</keycap> +</keycombo> +</shortcut> +<guimenu>File</guimenu> +<guimenuitem>Close</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Closes the current archive</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>Closes &ark;</action></para> +</listitem> +</varlistentry> +</variablelist> + +</sect1> +<sect1 id="editmenu"> +<title>The <guimenu>Edit</guimenu> Menu</title> + +<variablelist> + +<varlistentry> +<term><menuchoice> +<guimenu>Edit</guimenu> +<guimenuitem>Select...</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Lets you select files according to their +filename</action>. For example, you could use <literal +role="extension">*.txt</literal> to select all text files. Note that you +can't use more than one filter at a time.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut><keycombo action="simul">&Ctrl; +<keycap>A</keycap></keycombo></shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Select All</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Selects all the files in the archive</action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Edit</guimenu> +<guimenuitem>Deselect All</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Unselects all the files in the archive</action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Edit</guimenu> +<guimenuitem>Invert Selection</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Reverses which files are selected. Selected files become +unselected, and unselected files are selected.</action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Edit</guimenu> +<guimenuitem>View Shell Output</guimenuitem> +</menuchoice></term> +<listitem> +<para>Displays the <guilabel>Shell Output</guilabel> box, which +<action>shows you the output of the most recent command(s)</action> run +by &ark;. This is sometimes useful if you are having problems and want +to troubleshoot.</para> +</listitem> +</varlistentry> + +</variablelist> + +</sect1> + +<sect1 id="actionmenu"> +<title>The <guimenu>Action</guimenu> Menu</title> + +<variablelist> + +<varlistentry> +<term><menuchoice> +<guimenu>Action</guimenu> +<guimenuitem>Add File...</guimenuitem> +</menuchoice></term> +<listitem> +<para>Shows the <guilabel>Select Files to Add</guilabel> dialog box, +where you can select files. Hold down &Ctrl; and click to select +multiple files. To go up a folder, +<mousebutton>right</mousebutton> click the folder box, and you can +choose <guimenuitem>Up</guimenuitem> (this will probably be improved +soon). The <guilabel>Advanced</guilabel> tab has options which are +specific to the type or archive you are working with.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Action</guimenu> +<guimenuitem>Add Folder...</guimenuitem> +</menuchoice></term> +<listitem> +<para>Shows the <guilabel>Add Folder...</guilabel> dialog box, where you +can choose a <action>folder to add</action>. Just choose a folder +and choose <guibutton>Open</guibutton>.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Action</guimenu> +<guimenuitem>Delete</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Removes the currently selected files from the +archive.</action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Action</guimenu> +<guimenuitem>Extract</guimenuitem> +</menuchoice></term> +<listitem> +<para>Shows the <guilabel>Extract</guilabel> dialog box, which allows +you to <action>select where you will extract files</action> to. You can +also select which files to extract:</para> + +<itemizedlist> +<listitem> +<para><guilabel>Current</guilabel> extracts the most recently selected +file. If multiple files are selected, only the most recently selected +one will be extracted.</para> +</listitem> +<listitem> +<para><guilabel>All</guilabel> extracts the entire contents of the +archive.</para> +</listitem> +<listitem> +<para><guilabel>Selected Files</guilabel> extracts all the files which +have been selected.</para> +</listitem> +<listitem> +<para><guilabel>Pattern</guilabel> allows you to specify which files +will be extracted, corresponding to certain patterns, ⪚ +<literal role="extension">*.txt</literal> or <literal +role="extension">*.jpg</literal> Note that you can only use one +pattern at a time.</para> +</listitem> + +</itemizedlist> + +<para>You can specify the folder to extract files to in the +<guilabel>Extract to:</guilabel> text box. The default location is the +folder the archive is in. You may also choose to have the folder that you +extract into open in &konqueror; once the extraction is complete.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Action</guimenu> +<guimenuitem>View</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Opens the currently selected file in the associated viewer +program.</action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Action</guimenu> +<guimenuitem>Open With...</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Opens the currently selected file in a program you +choose.</action> The <guilabel>Open With...</guilabel> dialog box lets +you choose which program to use. </para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Action</guimenu> +<guimenuitem>Edit With...</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Opens the currently selected file in a program you +choose.</action> Any changes you make in the editor program will be +reflected in the archive, as it will be updated. </para> +</listitem> +</varlistentry> + +</variablelist> + +</sect1> + +<sect1 id="settingsmenu"> +<title>The <guimenu>Settings</guimenu> Menu</title> + +<variablelist> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Show/Hide Toolbar</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Toggles whether the toolbar is displayed. </action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Show/Hide Statusbar</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Toggles whether the status bar is +displayed. </action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Show/Hide Search Bar</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>Toggles whether the search bar is +displayed. </action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Shortcuts...</guimenuitem> +</menuchoice></term> +<listitem> +<para>Displays the <guilabel>Configure Shortcuts</guilabel> dialog +box. This <action>lets you choose shortcut keys for various menu +items.</action> To change a shortcut, select an action from the list, +and then choose which keystroke to use. Clicking on the bottom right +hand <interface>Key</interface> button lets you choose which specific +key to use. Just press the new key. </para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Toolbars...</guimenuitem> +</menuchoice></term> +<listitem> +<para>Displays a &kde; standard dialog where you can configure the +toolbar icons.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Ark...</guimenuitem> +</menuchoice></term> +<listitem> +<para> +This opens the &ark; configuration dialog. The dialog contains four +modules (General, Addition, Extraction and Folders). Configuring &ark; is covered in the section <link +linkend="configuration">Configuration</link></para> +</listitem> +</varlistentry> +</variablelist> + +</sect1> + +<sect1 id="help-menu"> +<title>The <guimenu>Help</guimenu> Menu</title> + +&help.menu.documentation; + +</sect1> + +</chapter> + +<chapter id="credits"> + +<title>Credits and License</title> + +<para>&ark; is Copyright © 1997-2004, The Various &ark; Developers</para> + +<itemizedlist> +<title>Authors:</title> +<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> +</itemizedlist> + +<para>Documentation Copyright © 2000 Matt Johnston +<email>mattj@flashmail.com</email></para> + +<para>Documentation updated for &kde; 3.3 by Henrique Pinto +<email>henrique.pinto@kdemail.net</email>.</para> + +&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; +3.3. <acronym>GNU</acronym> <command>Tar</command> v1.12 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>zip</command>, <command>unzip</command>, <command>ar</command>, <command>rar</command> +and <command>lha</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: +--> + diff --git a/doc/ark/man-ark.1.docbook b/doc/ark/man-ark.1.docbook new file mode 100644 index 0000000..ce2d6a8 --- /dev/null +++ b/doc/ark/man-ark.1.docbook @@ -0,0 +1,174 @@ +<?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><personname> +<firstname>Lauri</firstname> +<surname>Watts</surname> +</personname> +&Lauri.Watts.mail;</author> +<date>February 25, 2005</date> +<productname>K Desktop Environment</productname> +</refentryinfo> + +<refmeta> +<refentrytitle><command>&kappname;</command></refentrytitle> +<manvolnum>1</manvolnum> +</refmeta> + +<refnamediv> +<refname><command>ark</command></refname> +<refpurpose>A &kde; archiving tool</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<cmdsynopsis> +<command>ark</command> +<group> +<option>--extract</option> +<option>--extract-to</option> +<option>--add</option> +<option>--add-to</option> +<option>--guess-name</option> +</group> +<arg choice="opt">folder</arg> +<arg choice="opt">files</arg> +<arg choice="opt">archive</arg> +<arg choice="opt">KDE Generic Options</arg> +<arg choice="opt">Qt Generic Options</arg> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1> +<title>Description</title> +<para>&kappname; is a program for managing various archive formats +within the &kde; environment. Archives can be viewed, extracted, created +and modified from within &kappname;. The program can handle various +formats such as <application>tar</application>, +<application>gzip</application>, <application>bzip2</application>, +<application>zip</application>, <application>rar</application> and +<application>lha</application> (if appropriate command-line programs are +installed). &kappname; can work closely with &konqueror; in the &kde; +environment to handle archives, if you install the &konqueror; +Integration plugin available in the kdeaddons package.</para> + +</refsect1> + +<refsect1> +<title>Options</title> + +<variablelist> +<varlistentry> +<term><option>--extract</option></term> +<listitem> +<para>Open extract dialog, quit when finished</para> +</listitem> +</varlistentry> +<varlistentry> +<term><option>--extract-to +<replaceable>folder</replaceable> +<replaceable>archive</replaceable></option></term> +<listitem><para>Extract <replaceable>archive</replaceable> to +<replaceable>folder</replaceable>. Quit when finished. +<replaceable>folder</replaceable> will be created if it does not +exist.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><option>--add <replaceable>files</replaceable></option></term> +<listitem> +<para>Ask for the name of the archive to add +<replaceable>files</replaceable> to. Quit when finished.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><option>--add-to <replaceable>files</replaceable> +<replaceable>archive</replaceable></option></term> +<listitem> +<para>Add <replaceable>files</replaceable> to +<replaceable>archive</replaceable>. Quit when finished. +<replaceable>archive</replaceable> will be created if it does not +exist.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><option>--guess-name <replaceable>folder</replaceable> +<replaceable>archive</replaceable></option></term> +<listitem> +<para>Used with <option>--extract-to</option>. When specified, +<replaceable>archive</replaceable> will be extracted to a +subfolder of <replaceable>folder</replaceable> whose name will be +the name of <replaceable>archive without the +filename extension.</replaceable></para> +</listitem> +</varlistentry> +</variablelist> + +</refsect1> + +<refsect1> +<title>Environment</title> +<variablelist> +<varlistentry> +<term>$<envar>PATH</envar></term> +<listitem> +<para>The commandline programs to deal with the archives you wish to +handle in &kappname; must be available in your +$<envar>PATH</envar>.</para> +</listitem> +</varlistentry> +</variablelist> +</refsect1> + +<refsect1> +<title>Examples</title> + +<variablelist> +<varlistentry> +<term><userinput><command>ark</command> <option>--extract-to +--guess-name</option> <parameter>.</parameter> +<parameter>An-Archive.tar.bz2</parameter></userinput></term> +<listitem> +<para>Will extract <filename>An-Archive.tar.bz2</filename> into a +folder named <filename class="directory">An-Archive</filename> in the +current directory.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><userinput><command>ark</command> <option>--add-to</option> +<filename>*.jpg</filename> <filename>pictures.tar.bz2</filename></userinput></term> +<listitem> +<para>Add all files ending in *.jpg to an archive named +<filename>pictures.tar.bz2</filename>, creating it if it doesn't +already exist.</para> +</listitem> +</varlistentry> +</variablelist> +</refsect1> + +<refsect1> +<title>See Also</title> +<para>tar(1), gzip(1), bzip2(1), zip(1), rar(1), lha(1)</para> + +<para>More detailed user documentation is available from <ulink +url="help:/ark">help:/ark</ulink> +(either enter this <acronym>URL</acronym> into &konqueror;, or run +<userinput><command>khelpcenter</command> +<parameter>help:/ark</parameter></userinput>).</para> + +</refsect1> + +<refsect1> +<title>Authors</title> +<para>&ark; is maintained by +<personname><firstname>Henrique</firstname><surname>Pinto</surname></personname> <email>stampede@coltec.ufmg.br</email></para> +<para>This man page was written by &Lauri.Watts; +&Lauri.Watts.mail; for &kde; 3.4.</para> +</refsect1> + +</refentry> diff --git a/doc/kcalc/Makefile.am b/doc/kcalc/Makefile.am new file mode 100644 index 0000000..085981d --- /dev/null +++ b/doc/kcalc/Makefile.am @@ -0,0 +1,4 @@ + +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/kcalc/commands.docbook b/doc/kcalc/commands.docbook new file mode 100644 index 0000000..22f20e7 --- /dev/null +++ b/doc/kcalc/commands.docbook @@ -0,0 +1,254 @@ +<chapter id="commands"> + +<title>Command Reference</title> + +<sect1 id="filemenu"> +<title>The <guimenu>File</guimenu> Menu</title> +<para> +<variablelist> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo> +</shortcut> +<guimenu>File</guimenu> +<guimenuitem>Quit</guimenuitem> +</menuchoice></term> +<listitem><para><action>Quit</action> &kcalc;.</para></listitem> +</varlistentry> +</variablelist> +</para> + +</sect1> + +<sect1 id="editmenu"> +<title>The <guimenu>Edit</guimenu> Menu</title> +<para> +<variablelist> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>Z</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Undo</guimenuitem> +</menuchoice></term> +<listitem><para><action>Go back in the result +stack.</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;&Shift;<keycap>Z</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Redo</guimenuitem> +</menuchoice></term> +<listitem><para><action>Go forward in the result +stack.</action> +</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>X</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Cut</guimenuitem> +</menuchoice></term> +<listitem><para><action>Delete the displayed result and copy it to the +clipboard.</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>C</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Copy</guimenuitem> +</menuchoice></term> +<listitem><para><action>Copy the displayed result to the +clipboard.</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>V</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Paste</guimenuitem> +</menuchoice></term> +<listitem><para><action>Insert the cut or copied result in the +display.</action></para></listitem> +</varlistentry> + +</variablelist> +</para> +</sect1> + +<sect1 id="viewmenu"> +<title>The <guimenu>Constants</guimenu> Menu</title> +<para> +<variablelist> + +<varlistentry> +<term><menuchoice> +<guimenu>Constants</guimenu> +<guimenuitem>Mathematics</guimenuitem> +</menuchoice></term> +<listitem><para><action>Display Pi, Euler Number or Golder 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 & 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> + +</variablelist> +</para> +</sect1> + +<sect1 id="settingsmenu"> +<title>The <guimenu>Settings</guimenu> Menu</title> +<para><variablelist> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Science/Engineering Buttons</guimenuitem> +</menuchoice></term> +<listitem><para><action>Display science and engineering buttons.</action> +</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Statistic Buttons</guimenuitem> +</menuchoice></term> +<listitem><para><action>Display <link linkend="statistical-mode">statistic +buttons.</link></action> +</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Logic Buttons</guimenuitem> +</menuchoice></term> +<listitem><para><action>Display <link linkend="and-or-xor">logic +buttons.</link></action> +</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Constants Buttons</guimenuitem> +</menuchoice></term> +<listitem><para><action>Display constants buttons.</action> +</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Show All</guimenuitem> +</menuchoice></term> +<listitem><para><action>Display all buttons available.</action> +</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Hide All</guimenuitem> +</menuchoice></term> +<listitem><para><action>Hide all extra buttons and display only +standard default buttons.</action> +</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Shortcuts...</guimenuitem> +</menuchoice></term> +<listitem><para><action>Configure the keyboard shortcuts used by &kcalc;. +</action> +</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure &kcalc;...</guimenuitem> +</menuchoice></term> +<listitem><para><action>Display</action> the &kcalc; settings dialog. +</para></listitem> +</varlistentry> + +</variablelist> +</para> +</sect1> + +<sect1 id="helpmenu"> +<title>The <guimenu>Help</guimenu> Menu</title> + +&help.menu.documentation; + +</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: +--> diff --git a/doc/kcalc/index.docbook b/doc/kcalc/index.docbook new file mode 100644 index 0000000..b881ee9 --- /dev/null +++ b/doc/kcalc/index.docbook @@ -0,0 +1,774 @@ +<?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 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>2006-02-13</date> +<releaseinfo>2.0.2</releaseinfo> + +<abstract><para>&kcalc; is a scientific calculator for &kde;</para></abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KCalc</keyword> +<keyword>calculator</keyword> +</keywordset> +</bookinfo> + +<chapter id="introduction"> +<title>Introduction</title> + +<para>This document describes &kcalc; version 1.8.</para> + +<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 and the number +of digits after the period.</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 <keycap>&Ctrl;</keycap>-key, displays on +every button, +the corresponding key-binding.</para> +</listitem> +</itemizedlist> + +<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 +<keycap>Enter</keycap> 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 +open extra buttons for &kcalc;: +it is for example possible to choose +<link linkend="statistical-mode">Statistical</link> or +<link linkend="trigonometric-mode">Trigonometric</link> buttons.</para> +</listitem> +</varlistentry> +</variablelist> +</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>Inv</guibutton> <guibutton>N</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>Inv</guibutton> <guibutton>Mea</guibutton></entry> +<entry>Display the sum of the square of all data items entered</entry></row> + +<row><entry><guibutton>Std</guibutton></entry> +<entry>Display the standard deviation (n)</entry></row> + +<row><entry><guibutton>Inv</guibutton> <guibutton>Std</guibutton></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>Inv</guibutton> <guibutton>Dat</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> + + +</sect1> + +<sect1 id="trigonometric-mode"> +<title>Trigonometric 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(x)</entry></row> + +<row><entry><guibutton>Sin</guibutton></entry> +<entry>Compute the sine</entry></row> + +<row><entry><guibutton>Inv</guibutton> <guibutton>Sin</guibutton></entry> +<entry>Compute the inverse sine</entry></row> + +<row><entry><guibutton>Cos</guibutton></entry> +<entry>Compute the cosine</entry></row> + +<row><entry><guibutton>Inv</guibutton> <guibutton>Cos</guibutton></entry> +<entry>Compute the inverse cosine</entry></row> + +<row><entry><guibutton>Tan</guibutton></entry> +<entry>Compute the tangent</entry></row> + +<row><entry><guibutton>Inv</guibutton> <guibutton>Tan</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><guibutton>Inv</guibutton> <guibutton>Log</guibutton></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><guibutton>Inv</guibutton> <guibutton>Ln</guibutton></entry> +<entry>Compute e to the power of x</entry></row> + +</tbody></tgroup></informaltable> + +</sect1> + +<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 +labelled <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.</para> + +<para>To store the number shown in the &kcalc; display in one of the +six constants, first press <guibutton>Inv</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 contants 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>IIt 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 <keycap>&Ctrl;</keycap> to make each +button display its key-binding.</para> + +<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(x)</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>I</keycap></entry> +<entry> <guibutton>Inv</guibutton></entry> +<entry>Inverse, ⪚ if +you want arcsin(x) type <userinput>i 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><</keysym></entry> +<entry><guibutton>Lsh</guibutton></entry> +<entry>Left shift. Note: <guibutton>Inv</guibutton> +<guibutton>Lsh</guibutton> is Right shift</entry></row> + +<row><entry><keysym>&</keysym></entry> +<entry><guibutton>And</guibutton></entry> +<entry>Logical AND</entry></row> + +<row><entry><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>O</keycap></entry> +<entry><guibutton>Or</guibutton></entry> +<entry>Logical OR. Note: <guibutton>Inv</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><keysym>=</keysym></entry> +<entry><guibutton>=</guibutton></entry> +<entry></entry></row> + +<row><entry><keycap>Enter</keycap></entry> +<entry><guibutton>=</guibutton></entry> +<entry></entry></row> + +<row><entry><keycap>Return</keycap></entry> +<entry><guibutton>=</guibutton></entry> +<entry></entry></row> + +<row><entry><keycap>Page Up</keycap></entry> +<entry><guibutton>C</guibutton></entry> +<entry>Clear</entry></row> + +<row><entry><keycap>Esc</keycap></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>Page Down</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> + +</tbody></tgroup></informaltable> + +</sect1> +</chapter> + +<chapter id="comments-on-specific-functions"> +<title>Comments on Specific Functions</title> + +<sect1 id="mod"> +<title>Mod and Inv Mod</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>Inv</guibutton> <guibutton>Mod</guibutton> does integer +division of the displayed number by the next input number.</term> +<listitem><para><userinput>22 Inv Mod 8 = </userinput> will give the result +<emphasis>2</emphasis></para> +<para><userinput>22.345 Inv Mod 8 = </userinput> also gives <emphasis>2</emphasis> +</para></listitem></varlistentry> +</variablelist> + +</sect1> + + +<sect1 id="percent"> +<title>%</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 % 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 Inv Lsh</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:</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>Inv</guibutton> <guibutton>Lsh</guibutton> right shifts the +value (performs an integer divide by 2) n times.</term> +<listitem><para><userinput>16 Inv Lsh 2 =</userinput> gives +<emphasis>4</emphasis> (16 divided by 2 twice).</para> +<para><userinput>16.999 Inv Lsh 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 <guilabel>Base</guilabel> is set to +<guilabel>Hex</guilabel>, <guilabel>Oct</guilabel> or <guilabel>Bin</guilabel> +rather than <guilabel>Dec</guilabel>. In the following +examples <guilabel>Base</guilabel> 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 Inv Ln</userinput>.</para></answer> +</qandaentry> + +<qandaentry> +<question><para>How do I get two fixed digits after the period?</para></question> +<answer><para>Click on the <guibutton>Configure</guibutton> button, this will +bring up the configuration dialog. Check <guilabel>Set fixed +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 ©:</para> +<para>Bernd Johannes Wuebben 1996-2000</para> +<para>The &kde; Team 2000-2004</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> +</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 © 2001,2002,2005, 2006:</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> +</itemizedlist> + +&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> + +<!-- +<para>&kcalc;'s home site is <ulink +url="http://math.cornell.edu/~wuebben/kde.html"> +http://math.cornell.edu/~wuebben/kde.html</ulink></para> +--> + +<sect1 id="compilation-and-installation"> +<title>Compilation and Installation</title> + +&install.intro.documentation; +&install.compile.documentation; + +</sect1> + +<sect1 id="enable-long-double-precision"> +<title>How to enable long double precision for &kcalc;</title> + +<para>If your machine supports the C data type <type>long double</type> +and if you have a working libc you can enable <type>long double</type> +precision for &kcalc;.</para> + +<para>Here is what to do:</para> + +<procedure> +<step> +<para> Check <filename>../config.h</filename> and see whether +HAVE_LONG_DOUBLE is defined, &ie; you should be able to locate a +line saying:</para> + +<screen>#define HAVE_LONG_DOUBLE 1</screen> + +<para>If you can't find such a line your system doesn't support long +double IEEE precision. </para> +</step> +<step> +<para>Edit the files <filename class="headerfile">kcalctype.h</filename>, +<filename>configdlg.cpp</filename>, <filename>kcalc.cpp</filename> and +<filename>kcalc_core.cpp</filename> and remove the lines:</para> + +<screen> +#ifdef HAVE_LONG_DOUBLE +#undef HAVE_LONG_DOUBLE +#endif +</screen> + +</step> +<step> +<para> Recompile &kcalc;. +</para> +</step> +</procedure> + +</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: +--> diff --git a/doc/kcalc/kcalc_on_Aix.txt b/doc/kcalc/kcalc_on_Aix.txt new file mode 100644 index 0000000..186e9d6 --- /dev/null +++ b/doc/kcalc/kcalc_on_Aix.txt @@ -0,0 +1,123 @@ +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 diff --git a/doc/kcalc/kcalc_on_OSF.txt b/doc/kcalc/kcalc_on_OSF.txt new file mode 100644 index 0000000..59b6e6e --- /dev/null +++ b/doc/kcalc/kcalc_on_OSF.txt @@ -0,0 +1,62 @@ +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 diff --git a/doc/kcharselect/Makefile.am b/doc/kcharselect/Makefile.am new file mode 100644 index 0000000..085981d --- /dev/null +++ b/doc/kcharselect/Makefile.am @@ -0,0 +1,4 @@ + +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/kcharselect/index.docbook b/doc/kcharselect/index.docbook new file mode 100644 index 0000000..cabb4d2 --- /dev/null +++ b/doc/kcharselect/index.docbook @@ -0,0 +1,66 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY kappname "&kcharselect;"> + <!ENTITY package "kdeutils"> + <!ENTITY % English "INCLUDE"> + <!ENTITY % addindex "IGNORE"> +]> + +<book lang="&language;"> + +<bookinfo> +<title>The &kcharselect; Handbook</title> + +<authorgroup> +<author> +<firstname></firstname> +<othername></othername> +<surname></surname> +<affiliation> +<address><email></email></address> +</affiliation> +</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<legalnotice>&FDLNotice;</legalnotice> + +<date>2001-01-20</date> +<releaseinfo>0.00.00</releaseinfo> + +<abstract> +<para> +&kcharselect; is part of the kdeutils package. +</para> +</abstract> + + +<keywordset> +<keyword>KDE</keyword> +<keyword>kdeutils</keyword> +<keyword>kcharselect</keyword> +</keywordset> + +</bookinfo> + +<chapter id="introduction"> +<title>Introduction</title> +<para>The documentation for &kappname; was not finished when &kde; was installed on this computer.</para> +<para>If you need help, please check <ulink url="http://www.kde.org">The KDE Web site</ulink> for updates, or by submitting your question to <ulink url="mailto:kde@kde.org">The &kde; User Mailing list</ulink>.</para> +<para><emphasis>The &kde; Team</emphasis></para> + +&underFDL; +&underGPL; + +</chapter> + +&documentation.index; +</book> +<!-- +Local Variables: +mode: sgml +sgml-minimize-attributes: nil +sgml-general-insert-case: lower +End: +--> + diff --git a/doc/kcontrol/Makefile.am b/doc/kcontrol/Makefile.am new file mode 100644 index 0000000..930c270 --- /dev/null +++ b/doc/kcontrol/Makefile.am @@ -0,0 +1,6 @@ + +SUBDIRS = $(AUTODIRS) + +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/kcontrol/kcmlowbatcrit/Makefile.am b/doc/kcontrol/kcmlowbatcrit/Makefile.am new file mode 100644 index 0000000..335ba2c --- /dev/null +++ b/doc/kcontrol/kcmlowbatcrit/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG=en +KDE_DOCS=kcontrol/kcmlowbatcrit
\ No newline at end of file diff --git a/doc/kcontrol/kcmlowbatcrit/index.docbook b/doc/kcontrol/kcmlowbatcrit/index.docbook new file mode 100644 index 0000000..24bf9e0 --- /dev/null +++ b/doc/kcontrol/kcmlowbatcrit/index.docbook @@ -0,0 +1,47 @@ +<?xml version="1.0" ?> +<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" +"dtd/kdex.dtd" [ +<!ENTITY % addindex "IGNORE"> +<!ENTITY % English "INCLUDE" > <!-- change language only here --> +]> + +<article> +<articleinfo> + +<authorgroup> +<author> +&Mike.McBride; &Mike.McBride.mail; +</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2002-02-12</date> +<releaseinfo>3.00.00</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KControl</keyword> +<keyword>Battery</keyword> +<keyword>Power</keyword> +</keywordset> +</articleinfo> + +<sect1 id="lowbatcrit"> + +<title>Low Battery Critical</title> +<!-- <note><para>The laptop modules require the correct installation of the +apm modules. For more information see the section entitled Laptop +Information</link>.</para></note> --> +<sect2 id="low-bat-crit-use"> +<title>Use</title> +<para>This module works in exactly the same manner as the Low battery Warning module. By convention, this module should be set to warn you or automatically perform any action necessary just prior to the loss of battery power.</para> +</sect2> +<sect2 id="low-bat-crit-author"> +<title>Section Author</title> +<para>This section written by &Paul.Campbell; &Paul.Campbell.mail;</para> +<para>Converted to Docbook by &Mike.McBride; &Mike.McBride.mail;</para> +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> +</sect2> +</sect1> + +</article> diff --git a/doc/kcontrol/kcmlowbatwarn/Makefile.am b/doc/kcontrol/kcmlowbatwarn/Makefile.am new file mode 100644 index 0000000..9baf4af --- /dev/null +++ b/doc/kcontrol/kcmlowbatwarn/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG=en +KDE_DOCS=kcontrol/kcmlowbatwarn
\ No newline at end of file diff --git a/doc/kcontrol/kcmlowbatwarn/index.docbook b/doc/kcontrol/kcmlowbatwarn/index.docbook new file mode 100644 index 0000000..97ceaf2 --- /dev/null +++ b/doc/kcontrol/kcmlowbatwarn/index.docbook @@ -0,0 +1,104 @@ +<?xml version="1.0" ?> +<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" +"dtd/kdex.dtd" [ +<!ENTITY % addindex "IGNORE"> +<!ENTITY % English "INCLUDE" > <!-- change language only here --> +]> + +<article lang="&language;"> +<articleinfo> + +<authorgroup> +<author> +&Mike.McBride; &Mike.McBride.mail; +</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2002-02-12</date> +<releaseinfo>3.00.00</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KControl</keyword> +<keyword>Battery</keyword> +<keyword>Power</keyword> +</keywordset> +</articleinfo> + +<sect1 id="lowbatwarn"> + + +<title>The Low Battery Warning and Low Battery Critical Panels +</title> + +<sect2 id="low-bat-warn-intro"> +<title>Introduction</title> + + +<para>These two modules work together to control what happens when a +predetermined low battery condition occurs. There are two of them, so you can +set a warning for when time is getting close, and something more desperate for +the last minute save or suspend.</para> + +<!-- <note><para>The laptop modules require the correct installation of the apm modules. For more information see the section entitled <link linkend="laptop">Laptop Information</link>.</para></note> --> + +</sect2> + +<sect2 id="low-bat-warn-use"> +<title>Use</title> + +<para><emphasis>Low trigger</emphasis></para> + +<para>This field specifies at which point the battery low state is detected - it +is the number of minutes left (according to APM) in your batteries. When this +number is crossed the low state is triggered and one or more of the following +things will occur</para> + +<variablelist> +<varlistentry> +<term><guilabel>Run Command</guilabel></term> +<listitem><para>This is a shell command that will be executed when the battery +low is detected. By default, this is turned off.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Play Sound</guilabel></term> +<listitem><para>This specifies a sound to play when battery low is detected. Simply specify the path to the +file to have it played. By default, this is turned off.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>System Beep</guilabel></term> +<listitem><para>Enabling this will cause the battery monitor to beep whenever +the battery level drops below the preset value. This is probably the least +intrusive, yet still active, method of alerting the user that the battery is +low. By default, this is on.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Notify</guilabel></term> +<listitem><para>Enabling this will cause Battery to pop up a window when the +battery becomes low.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Suspend</guilabel></term> +<listitem><para>If you have set up <filename>/usr/bin/apm</filename> to be run +setuid (see the instructions for the <guilabel>Power</guilabel> panel) then this check box will +appear - if checked it will cause your computer to be put into <guilabel>Suspend</guilabel> +mode.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Standby</guilabel></term> +<listitem><para>Like <guilabel>Suspend</guilabel> above, but it puts your computer into <guilabel>Standby</guilabel> +mode.</para></listitem> +</varlistentry> +</variablelist> + +</sect2> +<sect2 id="low-bat-warn-author"> +<title>Section Author</title> +<para>This section written by &Paul.Campbell; &Paul.Campbell.mail;</para> +<para>Converted to Docbook by &Mike.McBride; &Mike.McBride.mail;</para> +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> +</sect2> +</sect1> + +</article> diff --git a/doc/kcontrol/laptop/Makefile.am b/doc/kcontrol/laptop/Makefile.am new file mode 100644 index 0000000..446ee8e --- /dev/null +++ b/doc/kcontrol/laptop/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG=en +KDE_DOCS=kcontrol/laptop
\ No newline at end of file diff --git a/doc/kcontrol/laptop/index.docbook b/doc/kcontrol/laptop/index.docbook new file mode 100644 index 0000000..fb83afd --- /dev/null +++ b/doc/kcontrol/laptop/index.docbook @@ -0,0 +1,111 @@ +<?xml version="1.0" ?> +<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" +"dtd/kdex.dtd" [ +<!ENTITY % addindex "IGNORE"> +<!ENTITY % English "INCLUDE" > <!-- change language only here --> +]> + +<article lang="&language;"> +<articleinfo> + + + +<authorgroup> +<author> +&Mike.McBride; &Mike.McBride.mail; +</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2002-02-12</date> +<releaseinfo>3.00.00</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KControl</keyword> +<keyword>Battery</keyword> +<keyword>level</keyword> +</keywordset> +</articleinfo> + +<sect1 id="battery-monitor"> + +<title>The Battery Monitor Panel</title> + +<!-- <note><para>The laptop modules require the correct installation of the +apm modules. For more information see the section entitled <link +linkend="laptop">Laptop Information</link>.</para></note> --> + +<sect2 id="batmon-intro"> +<title>Introduction</title> + +<para>This panel controls whether or not a battery state icon appears +in &kde;'s panel.</para> + +<para>Once enabled a battery will appear in your docking bar as one of +3 icons - a <guiicon>battery with a red X</guiicon> through it +indicates that <acronym>APM</acronym> has not been installed (in +particular <filename>/proc/apm</filename> can't be read).</para> + +<para>The other two icons indicate the battery state - a +<guiicon>small plug with a bar</guiicon> beside it indicates your +batteries are charging - the height of the blue portion of the bar +indicate how full your batteries are. A small +<guiicon>battery</guiicon> in the dock indicates you are running on +batteries, the amount of blue in the battery indicates how full your +batteries are.</para> + +<para>If you <mousebutton>left</mousebutton> click on the docked icon a +pop-up will tell you how much time you have left in minutes.</para> + +<para>If you <mousebutton>right</mousebutton> click you get a pop-up +that lets you put your laptop into suspend or standby modes - or to +bring up the laptop configuration widget.</para> + +<para>All features of Battery are configured from the Setup dialog.</para> + +</sect2> +<sect2 id="batmon-use"> +<title>Use</title> + +<para>The configuration window can be divided into 3 parts.</para> + +<variablelist> +<varlistentry> +<term><guilabel>Show Battery Monitor</guilabel></term> +<listitem><para>This controls whether or not the battery icon appears. This is +disabled by default.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Poll</guilabel></term> +<listitem><para>This setting controls how often, in seconds, the battery is +updated. </para> +<para>The default is 20 seconds.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Icons</guilabel></term> +<listitem><para>The battery monitor uses three icons to represent the three +states: No APM, Charging, and Not Charging. The icons shown are the <quote>large</quote> +icons. To select new ones, click on the buttons and a icon loader dialog will +pop up. </para> +<note><para>If you create your own icons - they will work with the battery +monitor - but be careful.</para> +<para>All the exactly white pixels in the icon get filled by blue for the +battery meter - if you want some white looking pixels to stay choose a slightly +off-white or gray color for them.</para></note> +<para>The author does not claim to be a graphic artist and would love for +someone to donate some better looking icons to the cause.</para> +</listitem> +</varlistentry> +</variablelist> + +</sect2> +<sect2 id="batmon-author"> +<title>Section Author</title> +<para>This section written by &Paul.Campbell; &Paul.Campbell.mail;</para> +<para>Converted to Docbook by &Mike.McBride; &Mike.McBride.mail;</para> +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> +</sect2> +</sect1> + +</article> diff --git a/doc/kcontrol/powerctrl/Makefile.am b/doc/kcontrol/powerctrl/Makefile.am new file mode 100644 index 0000000..eefb119 --- /dev/null +++ b/doc/kcontrol/powerctrl/Makefile.am @@ -0,0 +1,2 @@ +KDE_LANG=en +KDE_DOCS=kcontrol/powerctrl
\ No newline at end of file diff --git a/doc/kcontrol/powerctrl/index.docbook b/doc/kcontrol/powerctrl/index.docbook new file mode 100644 index 0000000..2a09b95 --- /dev/null +++ b/doc/kcontrol/powerctrl/index.docbook @@ -0,0 +1,77 @@ +<?xml version="1.0" ?> +<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" +"dtd/kdex.dtd" [ +<!ENTITY % addindex "IGNORE"> +<!ENTITY % English "INCLUDE" > <!-- change language only here --> +]> + +<article lang="&language;"> +<articleinfo> + +<authorgroup> +<author> +&Mike.McBride; &Mike.McBride.mail; +</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2002-10-16</date> +<releaseinfo>3.1</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KControl</keyword> +<keyword>Laptop</keyword> +<keyword>Power</keyword> +</keywordset> +</articleinfo> +<sect1 id="powerctrl"> + +<title>Laptop Power Control</title> +<!-- <note><para>The laptop modules require the correct installation of the apm modules. For more information see the section entitled <link linkend="laptop">Laptop Information</link>.</para></note> --> +<sect2 id="powerctrl-intro"> +<title>Introduction</title> + +<para>This tab provides a screensaver-style interface to the APM +suspend/standby modes. It allows you to configure different wait +times and/or actions depending on whether or not your laptop is +plugged into the wall. It's intended to be used in addition to the +existing &kde; screensavers - you could for example disable +suspend/standby when plugged in to the wall, but enable suspend with a +shorter time than your normal screensaver kicks in while running on +batteries.</para> + +<warning><para>Standby mode seems to do different things on different laptops - +in particular on some it may not stay in standby mode and your laptop may be +continually waking/sleeping if you leave it in this mode.</para></warning> + +</sect2> +<sect2 id="powerctrl-use"> +<title>Use</title> + +<para>This panel configures the power-down feature of your laptop. It works as +a sort of extreme screen saver.</para> +<para>You can configure different timeouts and behavior depending on whether +your computer is plugged in or running on battery power.</para> +<para>For both the <guilabel>Powered</guilabel> and <guilabel>Not Powered</guilabel>, you should select one of the +following options:</para> +<itemizedlist> +<listitem><para>Standby - Puts your laptop into standby state</para></listitem> +<listitem><para>Suspend - Puts your laptop into suspend state</para></listitem> +<listitem><para>Off - Nothing happens at the specified time.</para></listitem> +</itemizedlist> + +<para>Below that, is a text box labeled <guilabel>Wait for</guilabel>. Enter +the time in minutes, that your computer should remain unused, before the laptop +is powered down.</para> + +</sect2> +<sect2 id="powerctrl-author"> +<title>Section Author</title> +<para>This section written by &Paul.Campbell; &Paul.Campbell.mail;</para> +<para>Converted to Docbook by &Mike.McBride; &Mike.McBride.mail;</para> +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> +</sect2> +</sect1> + +</article> diff --git a/doc/kdelirc/Makefile.am b/doc/kdelirc/Makefile.am new file mode 100644 index 0000000..6812bd2 --- /dev/null +++ b/doc/kdelirc/Makefile.am @@ -0,0 +1,5 @@ + +KDE_LANG = en +KDE_DOCS = AUTO +SUBDIRS = $(AUTODIRS) + diff --git a/doc/kdelirc/irkick/Makefile.am b/doc/kdelirc/irkick/Makefile.am new file mode 100644 index 0000000..085981d --- /dev/null +++ b/doc/kdelirc/irkick/Makefile.am @@ -0,0 +1,4 @@ + +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/kdelirc/irkick/index.docbook b/doc/kdelirc/irkick/index.docbook new file mode 100644 index 0000000..972101c --- /dev/null +++ b/doc/kdelirc/irkick/index.docbook @@ -0,0 +1,131 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY irkick "<application>IRKick</application>"> + <!ENTITY kdelirc "<application>KDE LIRC</application>"> + <!ENTITY kappname "&irkick;"> + <!ENTITY package "kdeutils"> + <!ENTITY % English "INCLUDE" > <!-- change language only here --> + <!ENTITY % addindex "IGNORE"> +]> + +<book lang="&language;"> +<bookinfo> + +<title>&irkick;: The KDE LIRC Server Handbook</title> + +<authorgroup> +<author> +<firstname>Gav</firstname> +<surname>Wood</surname> +<affiliation> + <address><email>gav@kde.org</email></address> +</affiliation> +</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2004-01-02</date> +<releaseinfo>1.0</releaseinfo> + +<copyright> +<year>2004</year> +<holder>Gav Wood</holder> +</copyright> + +<legalnotice>&FDLNotice;</legalnotice> + +<abstract><para>&kdelirc; is the infrastructure for the KDE's +Infrared Remote Control functionality; &irkick; is the server +component of that infrastructure.</para></abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>irkick</keyword> +<keyword>kdelirc</keyword> +<keyword>kcmlirc</keyword> +<keyword>lirc</keyword> +</keywordset> + +</bookinfo> + +<chapter id="introduction"> +<title>Introduction</title> + +<para> +&irkick; is a background server that provides the 'glue' between +the operating system and your KDE applications for the purpose of +controlling KDE applications with your infrared remote controls. +</para> + +<para> +It has a configuration tool, which may be accessed either by the +KDE Control Center or directly from the menu of &irkick;. +</para> + +<sect1 id="requirements"> +<title>Requirements</title> + +<para> +For the KDELirc framework to be utilised you must have setup a LIRC +on your KDE machine. If it is properly set up, the &irkick; icon in +the system tray will light up red. If not, it will be grey and crossed +out. +</para> + +<para> +For more information about LIRC, visit their website at http://www.lirc.org. +</para> + +</sect1> +</chapter> + +<chapter id="using-irkick"> +<title>Using &irkick;</title> + +<para> +&irkick; provides one main function: When a button on a remote control is +pressed, it will temporarily become lit up. Aside from this &irkick; does +little for the user directly aside from telling them of the activity of their +remote controls. +</para> + +<para> +Using the right-mouse-button menu, you can configure the KDE infrared remote +control framework. +</para> + +</chapter> + +<chapter id="credits"> +<title>Credits and Licenses</title> + +<para>&kdelirc;: The KDE LIRC Framework Copyright (c) 2004 Gav Wood +<email>gav@kde.org</email>.</para> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + +&underFDL; +&underGPL; + +</chapter> + +<appendix id="installation"> +<title>Installation</title> + +&install.intro.documentation; +&install.compile.documentation; + +</appendix> +</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 +--> diff --git a/doc/kdelirc/kcmlirc/Makefile.am b/doc/kdelirc/kcmlirc/Makefile.am new file mode 100644 index 0000000..085981d --- /dev/null +++ b/doc/kdelirc/kcmlirc/Makefile.am @@ -0,0 +1,4 @@ + +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/kdelirc/kcmlirc/index.docbook b/doc/kdelirc/kcmlirc/index.docbook new file mode 100644 index 0000000..e3507c3 --- /dev/null +++ b/doc/kdelirc/kcmlirc/index.docbook @@ -0,0 +1,165 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY kcmlirc "<application>KDE LIRC Control Center Module</application>"> + <!ENTITY kdelirc "<application>KDE LIRC</application>"> + + <!ENTITY % English "INCLUDE" > <!-- change language only here --> + <!ENTITY % addindex "IGNORE"> +]> + +<book lang="&language;"> +<bookinfo> + +<title>KDE Infrared Remote Control Configuration</title> + +<authorgroup> +<author> +<firstname>Gav</firstname> +<surname>Wood</surname> +<affiliation> + <address><email>gav@kde.org</email></address> +</affiliation> +</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2004-01-02</date> +<releaseinfo>1.0</releaseinfo> + +<copyright> +<year>2004</year> +<holder>Gav Wood</holder> +</copyright> + +<legalnotice>&FDLNotice;</legalnotice> + +<abstract><para>&kdelirc; configuration: The infrastructure for the KDE's +Infrared Remote Control functionality.</para></abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>irkick</keyword> +<keyword>kdelirc</keyword> +<keyword>kcmlirc</keyword> +<keyword>lirc</keyword> +</keywordset> + +</bookinfo> + +<chapter id="introduction"> +<title>Introduction</title> + +<para> +</para> + +<sect1 id="requirements"> +<title>Requirements</title> + +<para> +For the KDELirc framework to be utilised you must have setup a LIRC +on your KDE machine. If it is properly set up, the &kdelirc; icon in +the system tray (show icon here) will light up red. If not, it will +be grey and crossed out. +</para> + +<para> +For more information about LIRC, visit their website at http://www.lirc.org. +</para> + +</sect1> +</chapter> + +<chapter id="usage"> +<title>Usage</title> + +<para> +There are several sections of the configuration. The list on the left details the remote controls and modes. The selection of that dictates the contents of the right-most list, which shows button/action bindings. Flicking the main tab over to Loaded Extensions will show a list of applications and remote controls that are recognised for the advanced functionality; some data is also viewable by selecting one of the items. +</para> + +<sect1 id="modes"> +<title>Remote Controls and Modes</title> + +<para> +Each remote control can have a number of modes. Having multiple modes allows the same button to conduct different actions in difference situations, and is how many remote controls handle many different appliances with a limited number of buttons. A good example are the TV/Video/Satellite/DVD multi-purpose remote controls - rather than having several sets of number buttons for each appliance they have only one set which works for the currently selected appliance only. +</para> + +<para> +Each remote control can be in at most one mode at once (it may also be in no mode at all). The remote control also has a "default mode", which is the mode that it starts in, and the mode that it gets reset to normally. This may be set by using the Edit button. +</para> + +<para> +The list contains any remote controls detected on your system. Modes may be added and removed by selecting the desired remote control and using the buttons directly below the list Add, Remove. Modes may be renamed "inline" in the standard KDE fashion by first selecting the mode in the list box, and then clicking it again after a short pause. The Edit button allows mode names to be edited, and also allows you to define an icon that will show up in the system tray when that mode is entered. +</para> + +</sect1> + +<sect1 id="bindings"> +<title>Action-Button Bindings</title> + +<para> +An action/button binding ("action") is a connection between a button press and an effect. The effect may be to switch modes, to start a KDE program or to execute a function in a KDE program (using DCOP). +</para> + +<para> +Actions may be associated with a mode of the remote control; if it is, the action will only have effect when the remote control is in that mode. Actions may also be placed out of any mode. Such actions will always have their desired effect no matter what mode that remote control happens to be in. +</para> + +<para> +To add an action/button binding simply use the Add button. Removal may be performed by selecting the action(s) to be removed and clicking the Remove button. Actions may be Edited with the Edit button, and moved to different modes by dragging and dropping onto the desired mode in the remotes/modes list. +</para> + +<para> +Actions may also be "automatically" populated. This handles the instance when you have a supported remote control and you wish to map its buttons to a supported application's functions. &kdelirc; can attempt to match buttons to functions for you; this behaviour may have to be tweaked, however. +</para> + +</sect1> + +<sect1 id="extensions"> +<title>Loaded Extensions</title> + +<para> +There is another tab available named "Loaded Extensions". This details the applications and remote controls that &kdelirc; recognises. &kdelirc; can also use unsupported remote controls and applications, but the Auto-Populate function will not work as well (if at all). +</para> + +<para> +By clicking on an entry you can see information on it such as the author's details. +</para> + +</sect1> + +</chapter> + +<chapter id="credits"> +<title>Credits and Licenses</title> + +<para>&kdelirc; KDE LIRC Framework Copyright (c) 2004 Gav Wood +<email>gav@kde.org</email>.</para> + +<para>Documentation Copyright (c) 2004 by Gav Wood +<email>gav@kde.org</email>.</para> + +&underFDL; +&underGPL; + +</chapter> + +<appendix id="installation"> +<title>Installation</title> + +&install.intro.documentation; +&install.compile.documentation; + +</appendix> +</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 +--> diff --git a/doc/kdf/Makefile.am b/doc/kdf/Makefile.am new file mode 100644 index 0000000..085981d --- /dev/null +++ b/doc/kdf/Makefile.am @@ -0,0 +1,4 @@ + +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/kdf/index.docbook b/doc/kdf/index.docbook new file mode 100644 index 0000000..672ef81 --- /dev/null +++ b/doc/kdf/index.docbook @@ -0,0 +1,266 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY kappname "&kdiskfree;"> + <!ENTITY package "kdeutils"> + <!ENTITY % English "INCLUDE" > <!-- change language only here --> + <!ENTITY % addindex "IGNORE"> +]> + +<book lang="&language;"> + +<bookinfo> +<title>The &kdiskfree; Handbook</title> + +<authorgroup> +<author> +&Jonathan.Singer; &Jonathan.Singer.mail; +</author> + +<author> +&Michael.Kropfberger; &Michael.Kropfberger.mail; +</author> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> + +</authorgroup> + +<copyright> +<year>2000-2002</year> +<holder>&Jonathan.Singer;</holder> +</copyright> + +<legalnotice>&FDLNotice;</legalnotice> + +<date>2003-09-16</date> +<releaseinfo>0.</releaseinfo> + +<abstract><para>&kdiskfree; displays available file devices, along with +information about them.</para> + +</abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>kdf</keyword> +<keyword>kdeutils</keyword> +<keyword>disks</keyword> +<keyword>devices</keyword> +<keyword>mount</keyword> +<keyword>unmount</keyword> +</keywordset> + +</bookinfo> + +<chapter id="introduction"> +<title>Introduction</title> + +<para>&kdiskfree; displays the available file devices (hard drive +partitions, floppy and &CD; drives, &etc;) along with information on +their capacity, free space, type and mount point. It also allows you +to mount and unmount drives and view them in a file manager.</para> + +<para>&kdiskfree; is similar to the &kcontrol; Disk-Free module <!-- +(<application>kcmdf</application>) -->, but takes up less screen +space. It is useful if you want to keep a &kdiskfree; window available at +all times.</para> + +</chapter> + +<chapter id="using-kdf"> +<title>Using &kdiskfree;</title> + +<sect1 id="starting-kdf"> +<title>Starting &kdiskfree;</title> + +<para>Type <userinput><command>kdf</command></userinput> at a command +prompt or select <guimenuitem>Disk Free</guimenuitem> from the +<guisubmenu>System</guisubmenu> group in the <guimenu>K</guimenu> +menu. The standard &Qt; and &kde; command options are available, and +can be listed by entering <userinput><command>kdf</command> +<option>--help</option></userinput> at the command prompt.</para> + +</sect1> + +<sect1 id="main-window"> +<title>The Main window</title> + +<para>The main &kdiskfree; window displays the available file devices.</para> + +<para>Normally, the following pieces of information are included:</para> +<screenshot> +<screeninfo>&kdiskfree; Screen</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="kdf.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>&kdiskfree; Screen</phrase> + </textobject> + </mediaobject> +</screenshot> + +<itemizedlist> +<listitem><para>an icon depicting the type of storage</para></listitem> +<listitem><para>device name</para></listitem> +<listitem><para>filesystem type</para></listitem> +<listitem><para>total size</para></listitem> +<listitem><para>mount point</para></listitem> +<listitem><para>free disk space</para></listitem> +<listitem><para>the percentage of space used as a number and as a +graph.</para></listitem> +</itemizedlist> + +<para>In the picture above, four devices are shown: one reiserfs-formatted +hard drive partition mounted at the filesystem root (<filename +class="directory">/</filename>), two &CD-ROM;'s, and a floppy drive.</para> + +<para><mousebutton>Left</mousebutton> clicking on the header of a +particular column sorts the devices according to that variable. A +second <mousebutton>left</mousebutton> click sorts in the opposite +order.</para> + +<para>Clicking on a row pops up a menu. If that device is not +currently mounted, the <guimenuitem>Mount Device</guimenuitem> option +is available. If the device is mounted, it can be unmounted by +choosing <guimenuitem>Unmount Device</guimenuitem>. Selecting +<guimenuitem>Open in File Manager</guimenuitem> opens a new window with a +graphical view of the files on that device.</para> + +</sect1> + +<sect1 id="the-menus"> +<title>The &kdiskfree; menu bar</title> + +<sect2> +<title>The <guimenu>File</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term> +<menuchoice> +<guimenu>File</guimenu> +<guimenuitem>Update</guimenuitem> +</menuchoice></term> +<listitem><para><action>Immediately updates the display to reflect the current +status</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>Closes</action> &kdiskfree;</para></listitem> +</varlistentry> +</variablelist> + +</sect2> + +<sect2> +<title>The <guimenu>Settings</guimenu> menu and dialog</title> + +<variablelist> +<varlistentry> +<term> +<menuchoice><guimenu>Settings</guimenu> +<guimenuitem>Configure Shortcuts...</guimenuitem></menuchoice> +</term> +<listitem> +<para>The standard &kde; dialog for setting shortcuts.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term> +<menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure KDiskFree...</guimenuitem> +</menuchoice> +</term> +<listitem><para><action>Opens a configuration dialog.</action></para> +<screenshot> +<screeninfo>Configure &kdiskfree; Screen</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="kdf_config.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Configure &kdiskfree; Screen</phrase> + </textobject> + </mediaobject> +</screenshot> + +<para>This dialog has two tabbed windows, <guilabel>General Settings</guilabel> +and <guilabel>Mount Commands</guilabel></para> +<variablelist> +<varlistentry> +<term>General Settings</term> <listitem><para>Click on the word +<guilabel>visible</guilabel> or <guilabel>hidden</guilabel> to turn +display of an data field on or off.</para> <para>Change the update +frequency by moving the slider. The value in the box on the left is +the interval (in seconds) between updates of the &kdiskfree; display to +reflect the current status.</para> <para>The File Manager setting +controls the command executed when the <guimenuitem>Open +Filemanager</guimenuitem> pop-up menu item is selected.</para> +<para>There are also two check boxes. One controls if a file manager +window will be automatically opened when a device is mounted. The +other causes an alert window to pop up if a disk gets critically +full.</para> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Mount Commands</guilabel></term> +<listitem><para>Allows the user to specify the mount and unmount commands for a +given device, as well as the icon used to represent it. More information on +these commands can be found on the man page for <application>mount</application> (type +<userinput><command>man</command> <option>mount</option></userinput> at the +command prompt).</para></listitem> +</varlistentry> +</variablelist> +</listitem> +</varlistentry> +</variablelist> +</sect2> + +<sect2> +<title>The <guimenu>Help</guimenu> menu</title> + +&help.menu.documentation; + +</sect2> + +</sect1> +</chapter> + +<chapter id="credits"> +<title>Credits and License</title> + +<para>&kdiskfree;</para> + +<para>Program Copyright © 1998-2000 &Michael.Kropfberger; &Michael.Kropfberger.mail;</para> + +<para>Documentation Copyright © 2000 &Jonathan.Singer; &Jonathan.Singer.mail;</para> + +&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: + +// vim:ts=2:sw=2:tw=78:noet +--> diff --git a/doc/kdf/kdf.png b/doc/kdf/kdf.png Binary files differnew file mode 100644 index 0000000..737ec7c --- /dev/null +++ b/doc/kdf/kdf.png diff --git a/doc/kdf/kdf_config.png b/doc/kdf/kdf_config.png Binary files differnew file mode 100644 index 0000000..09c9c91 --- /dev/null +++ b/doc/kdf/kdf_config.png diff --git a/doc/kedit/Makefile.am b/doc/kedit/Makefile.am new file mode 100644 index 0000000..085981d --- /dev/null +++ b/doc/kedit/Makefile.am @@ -0,0 +1,4 @@ + +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/kedit/index.docbook b/doc/kedit/index.docbook new file mode 100644 index 0000000..ee189ab --- /dev/null +++ b/doc/kedit/index.docbook @@ -0,0 +1,1255 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.1-Based Variant V1.0//EN" "dtd/kdex.dtd" [ + <!ENTITY kappname "&kedit;"> + <!ENTITY package "kdeutils"> + <!ENTITY % addindex "IGNORE"> + <!ENTITY % English "INCLUDE"> +]> + +<book lang="&language;"> +<bookinfo> +<title>The &kedit; Handbook</title> +<authorgroup> + +<author><firstname>Thad</firstname><surname>McGinnis</surname> +<affiliation> +<address><email>ctmcginnis@compuserve.com</email></address> +</affiliation> +</author> + +<othercredit role="reviewer"> +<firstname>Lauri</firstname> +<surname>Watts</surname> +<affiliation><address><email>lauri@kde.org</email></address></affiliation> +<contrib>Reviewer</contrib> +</othercredit> +</authorgroup> + +<date>2003-09-16</date> +<releaseinfo>1.3</releaseinfo> + +<legalnotice>&FDLNotice;</legalnotice> + +<abstract><para>This Handbook describes &kedit;, a simple +text editor for &kde;</para> </abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KEdit</keyword> +<keyword>text editor</keyword> +</keywordset> + +<copyright> +<year>2000</year> +<holder>Thad McGinnis</holder> +</copyright> + +</bookinfo> + +<chapter id="introduction"> +<title>Introduction</title> + +<para>&kedit; is a text editor for the &kde; Desktop. It is a +small editor which can be used with &konqueror; for text and +configuration file browsing. &kedit; also serves well for creating small +plain text documents. It is not meant to be a programmers editor, in +particular it is not meant to replace any of the more powerful editors +such as &kate;, <application>XEmacs</application> or +<application>Emacs</application>. &kedit;'s functionality will +intentionally remain rather limited to ensure a reasonably fast +start.</para> + +</chapter> + +<chapter id="on-screen-fundamentals"> +<title>Some Fundamentals</title> + +<para>&kedit; is very simple to use. Anyone that has used a text editor +should have no problems. </para> + +<sect1 id="drag-and-drop"> +<title>Drag and Drop</title> + +<para>&kedit; uses the &kde; Drag and Drop protocol. Files may be +dragged and dropped onto &kedit; from the Desktop, &konqueror;, or some +remote &FTP; site opened in one of &konqueror;'s windows. </para> + +</sect1> + +<sect1 id="command-line-options"> +<title>Command Line Options</title> + +<para>Though &kedit; may most often be started from the &kde; program +menu, or a desktop icon, it can also be opened at the command line +prompt of a terminal window. There are a few useful options that are +available when doing this.</para> + +<sect2 id="specify-a-file"> +<title>Specify a File</title> + +<para>By specifying the path and name of a particular file the user can +have &kedit; open (or create) that file immediately upon startup.This +option might look something like the following:</para> + +<informalexample> +<screen><prompt>%</prompt><userinput><command>kedit</command> <replaceable>/home/myhome/docs/myfile.txt</replaceable></userinput></screen> +</informalexample> + +</sect2> + +<sect2 id="editing-files-on-the-internet"> +<title>Specify a file on the Internet</title> + +<para>The above-mentioned method could even be used to open files on the +internet (if the user has an active connection at the time.) An example +of this might look like the following:</para> + +<informalexample> +<screen><prompt>%</prompt><userinput><command>kedit</command> <replaceable>ftp://ftp.kde.org/pub/kde/Welcome.msg</replaceable></userinput></screen> +</informalexample> + +</sect2> + +<sect2> +<title>Other Command Line Options</title> + +<para>The following command line help options are available</para> + +<variablelist> +<varlistentry> +<term><command>kedit</command> <option>--help</option></term> +<listitem> +<para>This lists the most basic options available at the command +line.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><command>kedit</command> <option>--help-qt</option></term> +<listitem> +<para>This lists the options available for changing the way &kedit; +interacts with &Qt;.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><command>kedit</command> <option>--help-kde</option></term> +<listitem> +<para>This lists the options available for changing the way &kedit; +interacts with &kde;.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><command>kedit</command> <option>--help-all</option></term> +<listitem> +<para>This lists all of the command line options.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><command>kedit</command> <option>--author</option></term> +<listitem> +<para>Lists &kedit;'s authors in the terminal window</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><command>kedit</command> <option>--version</option></term> +<listitem> +<para>Lists version information for &Qt;, &kde;, and &kedit;. Also +available through <command>kedit</command> <option>-V</option></para> +</listitem> +</varlistentry> +</variablelist> + +</sect2> + +</sect1> + +<sect1 id="keybindings"> +<title>Key Bindings</title> + +<para>Many of the key bindings (shortcuts) are configurable by way of +the <link linkend="settings">Settings</link> menu. By default &kedit; +honors the following key bindings.</para> + +<informaltable> +<tgroup cols="2"> +<thead> +<row> +<entry>Key Binding</entry> +<entry>Action</entry> +</row> +</thead> +<tbody> +<!-- Insert mode appears to have disappeared again +<row> +<entry><keycap>Insert</keycap></entry> +<entry><action>Toggle between Insert and Overwrite mode.</action></entry> +</row> +--> +<row> +<entry><keycap>Left Arrow</keycap></entry> +<entry><action>Move the cursor one character leftwards.</action></entry> +</row> + +<row> +<entry><keycap>Right Arrow</keycap></entry> +<entry><action>Move the cursor one character rightwards.</action></entry> +</row> + +<row> +<entry><keycap>Up Arrow</keycap></entry> +<entry><action>Move the cursor one line upwards</action></entry> +</row> + +<row> +<entry><keycap>Down Arrow</keycap></entry> +<entry><action>Move the cursor one line downwards.</action></entry> +</row> + +<row> +<entry><keycap>Page Up</keycap></entry> +<entry><action>Move the cursor one page upwards.</action></entry> +</row> + +<row> +<entry><keycap>Page Down</keycap></entry> +<entry><action>Move the cursor one page downwards.</action></entry> +</row> + +<row> +<entry><keycap>Backspace</keycap></entry> +<entry><action>Delete the character to the left of the cursor.</action></entry> +</row> + +<row> +<entry><keycap>Home</keycap></entry> +<entry><action>Move the cursor to the beginning of the line.</action></entry> +</row> + +<row> +<entry><keycap>End</keycap></entry> +<entry><action>Move the cursor to the end of the line.</action></entry> +</row> + +<row> +<entry><keycap>Delete</keycap></entry> +<entry><action>Delete the character to the right of the cursor.</action></entry> +</row> + +<row> +<entry><keycombo action="simul">&Shift;<keycap>Left +Arrow</keycap></keycombo></entry> +<entry><action>Mark text one character leftwards.</action></entry> +</row> + +<row> +<entry><keycombo action="simul">&Shift;<keycap>Right +Arrow</keycap></keycombo></entry> +<entry><action>Mark text one character rightwards.</action></entry> +</row> + +<row> +<entry><keycombo +action="simul">&Ctrl;<keycap>A</keycap></keycombo></entry> +<entry><action>Select all the text in the document.</action></entry> +</row> + +<row> +<entry><keycombo +action="simul">&Ctrl;<keycap>B</keycap></keycombo></entry> +<entry><action>Move the cursor one character leftwards.</action></entry> +</row> + +<row> +<entry><keycombo action="simul"> +&Ctrl;<keycap>C</keycap></keycombo></entry> +<entry><action>Copy the marked text to the clipboard.</action></entry> +</row> + +<row> +<entry><keycombo action="simul">&Ctrl; +<keycap>D</keycap></keycombo></entry> +<entry><action>Delete the character to the right of the +cursor.</action></entry> +</row> + +<row> +<entry><keycombo +action="simul">&Ctrl;<keycap>E</keycap></keycombo></entry> +<entry><action>Move the cursor to the end of the line.</action></entry> +</row> + +<row> +<entry><keycombo +action="simul">&Ctrl;<keycap>F</keycap></keycombo></entry> +<entry><action>Search for text in the document.</action></entry> +</row> + +<row> +<entry><keycombo +action="simul">&Ctrl;<keycap>G</keycap></keycombo></entry> +<entry><action>Go to line.</action></entry> +</row> + + +<row> +<entry><keycombo +action="simul">&Ctrl;<keycap>H</keycap></keycombo></entry> +<entry><action>Delete the character to the left of the +cursor.</action></entry> +</row> + +<row> +<entry><keycombo +action="simul">&Ctrl;<keycap>K</keycap></keycombo></entry> +<entry><action>Create a new document</action></entry> +</row> + +<row> +<entry><keycombo action="simul">&Ctrl; +<keycap>N</keycap></keycombo></entry> +<entry><action>Move the cursor one line downwards.</action></entry> +</row> + +<row> +<entry><keycombo action="simul">&Ctrl; +<keycap>P</keycap></keycombo></entry> +<entry><action>Print.</action></entry> +</row> + +<row> +<entry><keycombo +action="simul">&Ctrl;<keycap>V</keycap></keycombo></entry> +<entry><action>Paste the clipboard text into the document at the text +cursor position.</action></entry> +</row> + +<row> +<entry><keycombo action="simul"> +&Ctrl;<keycap>X</keycap></keycombo></entry> +<entry><action>Cut the marked text, copying it to the +clipboard.</action></entry> +</row> + +<row> +<entry><keycombo action="simul">&Ctrl; +<keycap>Y</keycap></keycombo></entry> +<entry><action>Yank (paste) the content of the kill-buffer (clipboard) +into the document, at the current cursor position.</action></entry> +</row> +</tbody> +</tgroup> +</informaltable> + +</sect1> + +</chapter> + +<chapter id="the-menu-entries"> +<title>The Menu Entries</title> + +<sect1 id="file"> +<title>The <guimenu>File</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term><anchor id="new"/><menuchoice> <shortcut><keycombo +action="simul">&Ctrl;<keycap>N</keycap></keycombo></shortcut> +<guimenu>File</guimenu><guimenuitem>New</guimenuitem></menuchoice></term> +<listitem> +<para><action>This starts a new Document in a new instance of the +editor.</action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><anchor id="open"/><menuchoice> <shortcut><keycombo +action="simul">&Ctrl;<keycap>O</keycap></keycombo></shortcut> +<guimenu>File</guimenu><guimenuitem>Open...</guimenuitem> +</menuchoice></term> +<listitem> +<para><action>This command opens a file.</action> It does this by means +of a dialog box which allows the user to navigate the file +system.</para> + +<para>The dialog operates like a small file manager. Clicking on +folders displayed in the central window directs the dialog to enter +that folder - displaying its contents. There is an entry/drop down +box which can be used to directly type in the location and name of the +file or by clicking the arrow at the side choose from a drop down list of +recently used locations.</para> + +<para> Below this is a filter which similarly may have data entered +directly or chosen from a drop down list of recent filter types. The +filter facility lets only files that meet its specifications be +displayed in the central window. If the filter contained text such as +<literal role="extension">*.txt</literal> then only files with the txt +extension would be visible in the selection window.</para> + +<para>The toolbar has left and right arrow buttons that let the user +move back and forth through previously selected folders as well as +an up arrow button for moving up the folder tree. The button with the +little house takes the user to his or her home folder, and the one +with the two arrows curved in on each other updates the view of the +current folder. The flag button lets the user set a new bookmark at +the current folder or go to one that was previously set. The icon of +the folder with the sparkle on it, allows you to create a new +folder. Finally there is drop down box on the toolbar with a list of +some commonly frequented folders.</para></listitem> +</varlistentry> + +<varlistentry> +<term><anchor id="open-recent"/><menuchoice> +<guimenu>File</guimenu><guimenuitem>Open +Recent</guimenuitem></menuchoice> +</term> + +<listitem> +<para><action>This is a shortcut to open recently saved +documents.</action> Clicking on this item opens a list to the side of +the menu with a list of several of the most recently saved +files. Clicking on a specific file will open it in &kedit; - if the file +still resides at the same location. </para> +</listitem> +</varlistentry> + +<varlistentry> +<term><anchor id="save"/><menuchoice><shortcut><keycombo +action="simul">&Ctrl;<keycap>S</keycap></keycombo></shortcut> +<guimenu>File</guimenu><guimenuitem>Save</guimenuitem></menuchoice></term> +<listitem> +<para><action>This saves the current document.</action> If there has +already been a save of the document then this will overwrite the +previously saved file without asking for the user's consent.</para> + +<note> +<para>The editor can be configured to make a <link +linkend="backuppref">backup</link>.</para> +</note> + +<para>If it is the first save of a new document the save as dialog +(described below) will be invoked.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><anchor id="save-as"/><menuchoice> +<guimenu>File</guimenu><guimenuitem>Save +As...</guimenuitem></menuchoice></term> +<listitem> +<para><action>This allows a document to be saved with a new file +name.</action> This is done by means of the file dialog box described +above in the <link linkend="open">Open</link> section of this help +file.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><anchor id="print"/><menuchoice> +<shortcut><keycombo +action="simul">&Ctrl;<keycap>P</keycap></keycombo></shortcut> +<guimenu>File</guimenu><guimenuitem>Print...</guimenuitem></menuchoice></term> +<listitem> +<para><action>This opens a simple print dialog allowing the user to +specify what, where, and how to print.</action> The user can choose +between the standard <command>lpr</command> or a custom command as well +as whether to print the whole document or a selected section.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><anchor id="mail"/><menuchoice> +<guimenu>File</guimenu><guimenuitem>Mail...</guimenuitem></menuchoice></term> +<listitem> +<para><action>This is used to email the current document.</action> It +calls a mail dialog whereby the user can enter the address and subject +for the message.</para> + +<para>You may set your preferred mail client in &kcontrol;</para> + +</listitem> +</varlistentry> + +<varlistentry> +<term><anchor id="close"/><menuchoice> <shortcut><keycombo +action="simul">&Ctrl;<keycap>W</keycap> </keycombo></shortcut> +<guimenu>File</guimenu><guimenuitem>Close</guimenuitem></menuchoice></term> +<listitem> +<para><action>This will close the editor window</action>, if you have +more than one instance of &kedit; running, those instances will not be +closed.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><anchor id="quit"/><menuchoice> +<shortcut><keycombo action="simul">&Ctrl;<keycap>Q</keycap> +</keycombo></shortcut> +<guimenu>File</guimenu> +<guimenuitem>Quit</guimenuitem></menuchoice></term> +<listitem> +<para><action>This closes the editor.</action></para> +</listitem> +</varlistentry> +</variablelist> + +</sect1> + +<sect1 id="edit"> +<title>The <guimenu>Edit</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term><anchor id="undo"/><menuchoice> <shortcut><keycombo +action="simul">&Ctrl;<keycap>Z</keycap></keycombo></shortcut> +<guimenu>Edit</guimenu><guimenuitem>Undo</guimenuitem></menuchoice></term> +<listitem> +<para><action>This is used to eliminate or reverse the most recent user +action or operation.</action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><anchor id="redo"/><menuchoice> <shortcut><keycombo +action="simul">&Ctrl;&Shift;<keycap>Z</keycap></keycombo></shortcut> +<guimenu>Edit</guimenu><guimenuitem>Redo</guimenuitem></menuchoice></term> +<listitem> +<para><action>This will reverse the most recent change</action> (if any) +made using <guimenuitem>Undo</guimenuitem>.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><anchor id="cut"/><menuchoice> <shortcut><keycombo +action="simul">&Ctrl;<keycap>X</keycap></keycombo></shortcut> +<guimenu>Edit</guimenu><guimenuitem>Cut</guimenuitem></menuchoice></term> +<listitem> +<para><action>This command deletes the current selection and places it +on the clipboard.</action> The clipboard is a feature of &kde; that +works invisibly to provide a way to transfer data between +applications.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><anchor id="copy"/><menuchoice> <shortcut><keycombo +action="simul">&Ctrl;<keycap>C</keycap></keycombo></shortcut> +<guimenu>Edit</guimenu><guimenuitem>Copy</guimenuitem></menuchoice></term> +<listitem> +<para><action>This copies the currently selected text to the clipboard +so that it may be pasted elsewhere.</action> The clipboard is a feature +of &kde; that works invisibly to provide a way to transfer data between +applications.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><anchor id="paste"/><menuchoice> <shortcut><keycombo +action="simul">&Ctrl;<keycap>V</keycap></keycombo></shortcut> +<guimenu>Edit</guimenu><guimenuitem>Paste</guimenuitem></menuchoice></term> +<listitem> +<para><action>This will insert the contents of the clipboard at the +cursor position.</action> The clipboard is feature of &kde; that works +invisibly to provide a way to transfer data between applications.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><anchor id="select-all"/><menuchoice> +<shortcut><keycombo + action="simul">&Ctrl;<keycap>A</keycap></keycombo></shortcut> +<guimenu>Edit</guimenu><guimenuitem>Select +All</guimenuitem></menuchoice></term> +<listitem> +<para><action>This will select the entire document.</action> This could +be very useful for copying the entire file to another +application.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><anchor id="find"/><menuchoice> <shortcut><keycombo +action="simul">&Ctrl;<keycap>F</keycap></keycombo></shortcut> +<guimenu>Edit</guimenu><guimenuitem>Find...</guimenuitem></menuchoice></term> +<listitem> +<para><action>This opens the find dialog</action> which is used to +specify the text to <guilabel>Find</guilabel> in the document. There is +small text box for entering the search pattern. Two other options are +included to make the search more efficient. Selecting <guilabel>Case +sensitive</guilabel> will limit finds to entries that match the case +(upper or lower) of each of the characters in the search +pattern. <guilabel>Find backwards</guilabel> directs the search to +proceed in an upwardly direction.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><anchor id="find-again"/><menuchoice> <shortcut><keycombo +action="simul"><keycap>F3</keycap></keycombo></shortcut> +<guimenu>Edit</guimenu><guimenuitem>Find +Next</guimenuitem></menuchoice></term> +<listitem> +<para><action>This repeats the last find operation, if any, without +calling the find dialog box.</action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><anchor id="replace"/><menuchoice> <shortcut><keycombo +action="simul">&Ctrl;<keycap>R</keycap></keycombo></shortcut> +<guimenu>Edit</guimenu><guimenuitem>Replace...</guimenuitem></menuchoice></term> +<listitem> +<para><action>This command opens the replace dialog box.</action> The +replace dialog is similar to the above-mentioned find dialog but with +the addition of a <guilabel>Replace with:</guilabel> text box. Using +this dialog the user can specify both the text to be found and text with +which to replace it. This dialog also contains two additional buttons. +The <guilabel>Replace</guilabel> button allows the user to make one +replacement at a time which is useful when not all instances of the +searched for text should be replaced. The <guilabel>Replace +All</guilabel> button should be used with caution as it will immediately +replace every instance of the specified text.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><anchor id="insertfile"/> +<menuchoice> +<guimenu>Edit</guimenu><guimenuitem>Insert +File...</guimenuitem></menuchoice></term> +<listitem> +<para>This opens the <guimenu>File</guimenu><link +linkend="open"><guimenuitem>Open</guimenuitem></link> dialog box whereby +the user can <action>insert a complete file in the open +document.</action> The file will be entered at the position of the +blinking text cursor.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><anchor id="insertdate"/> +<menuchoice> +<guimenu>Edit</guimenu><guimenuitem>Insert +Date</guimenuitem></menuchoice></term> +<listitem> +<para><action>This will enter the current date at the position of the +blinking text cursor.</action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><anchor id="cleanspaces"/> +<menuchoice> +<guimenu>Edit</guimenu><guimenuitem>Clean +Spaces</guimenuitem></menuchoice></term> +<listitem> +<para>Choosing this item will remove from any <emphasis>selected +text</emphasis> any extra spaces and all carriage returns (the code for +the end of a paragraph brought about by pressing the +<keycap>Enter</keycap> key.)<action> In other words, any occurrences of +two or more spaces will be reduced to one space; and all paragraphs and +blank lines will be reduced to one single +paragraph.</action></para></listitem> +</varlistentry> +</variablelist> + +</sect1> + +<sect1 id="Go"> +<title>The <guimenu>Go</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term><anchor id="go-to-line"/><menuchoice> +<shortcut><keycombo action="simul"> +&Ctrl;<keycap>G</keycap></keycombo></shortcut> +<guimenu>Go</guimenu><guimenuitem>Go to +Line...</guimenuitem></menuchoice></term> +<listitem> +<para><action>This opens the goto line dialog box which is used to have +the cursor jump to a particular line (specified by number) in the +document.</action> The line number may be entered directly into the text +box or graphically by clicking on the up or down arrow spin controls at +the side of the text box. The little up arrow will increase the line +number and the down arrow decrease it.</para> +</listitem> +</varlistentry> +</variablelist> +</sect1> + +<sect1 id="tools"> +<title>The <guimenu>Tools</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term><anchor id="Spelling..."/><menuchoice> +<guimenu>Tools</guimenu><guimenuitem>Spelling...</guimenuitem></menuchoice></term> +<listitem> +<para><action>This initiates the spell checking program - a program +designed to help the user catch and correct any spelling +errors.</action> Clicking on this entry will start the checker and bring +up the speller dialog box through which the user can control the +process. There are three text boxes lined up vertically just to the +left of center with their corresponding labels further to the left. +Starting at the top they are:</para> + +<variablelist> +<varlistentry> +<term><guilabel>Misspelled word:</guilabel></term> +<listitem> +<para>Here, the spell checker indicates the word currently under +consideration. This happens when the checker encounters a word not in +its dictionary - a file containing a list of correctly spelled words +against which it compares each word in the editor.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Replacement:</guilabel></term> +<listitem> +<para> If the checker has any similar words in its dictionary the first +one will be listed here. The user can accept the suggestion, type in +his or her own correction, or choose a different suggestion from the +next box.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Suggestions:</guilabel></term> +<listitem> +<para>The checker may list here a number of possible replacements for +the word under consideration. Clicking on any one of the suggestions +will cause that word to be entered in the +<guilabel>Replacement:</guilabel> box, above.</para> +</listitem> +</varlistentry> +</variablelist> + +<para>On dialog box are 8 buttons that allow the user to control the +spell check process. They are:</para> + +<variablelist> +<varlistentry> +<term><guibutton>Replace</guibutton></term> +<listitem> +<para>This button has the checker replace the word under consideration +in the document with the word in the <guilabel>Replacement:</guilabel> +box.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guibutton>Replace All</guibutton></term> +<listitem> +<para>This button causes the checker to replace not only the current +<guilabel>Misspelled Word:</guilabel> but to automatically make the same +substitution for any other occurrences of this <guilabel>Misspelled +Word:</guilabel> in the document.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guibutton>Ignore</guibutton></term> +<listitem> +<para>Activating this button will have the checker move on without +making any changes.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guibutton>Ignore All</guibutton></term> +<listitem> +<para>This button tells the checker to do nothing with the current +<guilabel>Misspelled Word:</guilabel> and to pass over any other +instances of the same word.</para> + +<note> +<para>This only applies to the current spell check run. If the checker +is run again later it will stop on this same word.</para> +</note> +</listitem> +</varlistentry> + +<varlistentry> +<term><guibutton>Add</guibutton></term> +<listitem> +<para>Pressing this button adds the word in the <guilabel>Misspelled +Word:</guilabel> box to the checker's dictionary. This means that in the +future the checker will always consider this word to be correctly +spelled.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guibutton>Help</guibutton></term> +<listitem> +<para>This invokes the &kde; help system starting at the &kedit; help +pages (this document).</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guibutton>Stop</guibutton></term> +<listitem> +<para>This button stops the spell check process.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guibutton>Cancel</guibutton></term> +<listitem> +<para>This button cancels the spell check process.</para> +</listitem> +</varlistentry> +</variablelist> + +<para>Located horizontally along the bottom of the spell check dialog is +a progress bar. As the checking process proceeds the bar will fill from +left to right providing a graphical representation of how far along in +the document the process has reached.</para> + +<note> +<para>A numerical display of the spell check process is simultaneously +displayed in the status bar of the editor. The <link +linkend="show-statusbar">status bar</link> is the horizontal strip at +the bottom of the editor just outside of the text entry area.</para> +</note> +</listitem> +</varlistentry> +</variablelist> + +</sect1> + +<sect1 id="settings"> +<title>The <guimenu>Settings</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term><anchor id="show-toolbar"/><menuchoice> +<guimenu>Settings</guimenu><guimenuitem>Show +Toolbar</guimenuitem></menuchoice></term> +<listitem> +<para><action>When checked, this displays a movable toolbar containing +buttons used to initiate frequently used commands. The toolbar is most +commonly located at the top of the editor just under the menu. When +unchecked the toolbar is hidden.</action> Clicking on the striated grip +will hide or unhide the bar. Clicking and dragging on this grip allows +the user to move the bar.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><anchor id="show-statusbar"/><menuchoice> +<guimenu>Settings</guimenu><guimenuitem>Show +Statusbar</guimenuitem></menuchoice></term> +<listitem> +<para><action>When checked, this displays a small bar at the bottom of +the editor containing information about the status of the current +document. When unchecked the status bar is hidden.</action> </para> +</listitem> +</varlistentry> + +<varlistentry> +<term><anchor id="save-options"/><menuchoice> +<guimenu>Settings</guimenu><guimenuitem>Save +Settings</guimenuitem></menuchoice></term> +<listitem> +<para><action>This saves the current editor settings to be used for +future documents.</action></para> +</listitem> +</varlistentry> + +<varlistentry> +<term><anchor id="configure-keybindings"/><menuchoice> +<guimenu>Settings</guimenu><guimenuitem>Configure +Shortcuts...</guimenuitem></menuchoice></term> +<listitem> +<para>This command opens a dialog box whereby the <link +linkend="keybindings">key bindings</link> may be changed. A display +window at the top of the dialog box shows the list of commands +available. Below the display are three radio buttons. The user may +choose a modifier key from <guilabel>None</guilabel>, +<guilabel>Default</guilabel>, and <guilabel>Custom</guilabel>.</para> + +<note> +<para>Note that a set of radio buttons only allows the selection of one +of the offered items - in the way that buttons on a car radio only offer +the selection of one preset station. Also, the Default Key selection is +only available for those commands that actually have a +<quote>default</quote> shortcut.)</para> +</note> + +<para> +Selecting the Custom key option activates the three check boxes and key +button at the bottom of the dialog. The user may then select a +combination of keys for the command in question by means of the check +boxes and key button. For example, with the About &kde; command selected +in the display window, the user could select &Ctrl; and &Alt;, click on +the key button, and then press the <keycap>K</keycap> key on the +keyboard. This would mean that anytime he or she held down the &Ctrl; +and &Alt; buttons and pressed <keycap>K</keycap> (while using &kedit;) +the About &kde; display box would be called. </para> +</listitem> +</varlistentry> +<varlistentry> + +<term><anchor id="configure-toolbars"/><menuchoice> +<guimenu>Settings</guimenu><guimenuitem>Configure +Toolbars...</guimenuitem></menuchoice></term> + +<listitem> +<para><action>This will open the dialog whereby the toolbar +configuration may be changed.</action> The user can choose which +shortcut buttons should appear on the toolbar, as well as whether and +where any text should appear with the buttons. Other choices include +button (icon) size and toolbar location (top, left, right, floating, or +flat.) Flat causes the toolbar to be retracted. A click on the striated +grip icon will extend it for use and another click retract it again. A +display window on the left lists the commands available to be placed on +the toolbar. A display on the right lists those commands already on the +toolbar. A set of four arrow buttons between the two displays +manipulates the selections. The right pointing arrow places any command +selected in the left pane onto the right pane, &ie;, it is added to the +toolbar. The left arrow does just the opposite, removing any action +selected in the right window from the toolbar. The up and down pointing +arrows change the position of an action selected in the right window +which changes the position of its button in the toolbar.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><anchor id="preferences"/><menuchoice> +<guimenu>Settings</guimenu><guimenuitem>Configure KEdit...</guimenuitem></menuchoice></term> +<listitem> +<para>This menu item opens a dialog whereby several different <link +linkend="pref-dialog">settings</link> may be adjusted.</para> +</listitem> +</varlistentry> +</variablelist> + +</sect1> + +<sect1 id="help"> +<title>The <guimenuitem>Help</guimenuitem> Menu</title> + +&help.menu.documentation; + +</sect1> +</chapter> + +<chapter id="pref-dialog"> +<title>The Preferences Dialog</title> + +<para>Selecting +<menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure +KEdit</guimenuitem></menuchoice> from the menu brings up the preferences +dialog box. This dialog can be used to alter a number of different +settings. The settings available for change vary according to which +category the user chooses from a vertical list on the left side of the +dialog. By means of a row of five buttons along the bottom of the box +the user can control the process. She or he may invoke the +<guilabel>Help</guilabel> system, set the options to their +<guilabel>Default</guilabel> values, accept the current settings and +close the dialog by means of the <guibutton>OK</guibutton> button, +<guibutton>Apply</guibutton> the current choices to the document without +closing the dialog, or <guibutton>Cancel</guibutton> the process. The +categories <guilabel>Font</guilabel>, <guilabel>Color</guilabel>, +<guilabel>Spelling</guilabel>, and <guilabel>Miscellaneous</guilabel> +are detailed below.</para> + +<sect1 id="preffont"> +<title>Font</title> + +<para>The preferences dialog opens with this, the first category, +chosen. Here the user can change four settings and see the effects of +any changes in the text sample displayed in the rectangle at the bottom +or the box. The settings are:</para> + +<variablelist> + +<varlistentry> +<term><guilabel>Font:</guilabel></term> +<listitem> +<para>This scroll box allows the user to select by name from among the +various fonts available. The appearance of any selected font may be +seen in the sample text displayed in the rectangle at the bottom of the +dialog.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Font style:</guilabel></term> +<listitem> +<para>This, the center, selection box is used to choose between the four +basic styles of Regular, Italic, Bold, and Bold Italic. The appearance +of the selected style may be seen in the sample text displayed in the +rectangle at the bottom of the dialog. </para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Size:</guilabel></term> +<listitem> +<para>This, the rightmost scroll/selection box allows the user to change +font size. The larger the number chosen the larger the font size will +be. The sample text displayed in the rectangle at the bottom of the +dialog will reflect the choice of size.</para> +</listitem> +</varlistentry> + +</variablelist> + +</sect1> + +<sect1 id="prefcolors"> +<title>Color</title> + +<para>This section provides access to <link +linkend="pref-color-settings">two different color settings</link>, +described below. Each of these settings may be changed by clicking on +its corresponding button. These are special wide buttons that are the +color of the current setting. Clicking on one of the buttons calls a +special color dialog box used to change the setting.</para> + +<para>The color dialog box provides a convenient and graphical way to +select a color. In the upper left of the box is a rectangular display +of a spectrum of colors. To the immediate right of this, is a vertical +bar displaying a range of intensity from the most dark at the bottom to +the most light at the top. The user may select and adjust a color by +clicking in these two boxes. Clicking in the rectangular display selects +a particular mix of red, green, and blue colors and in the vertical bar +selects a level of intensity (value). The various color attributes are +displayed in numerical form in small text boxes located directly below +the spectral rectangle and the user can see them change as the color is +adjusted. These attributes include the mix of the basic color +components (red, green, and blue) as well as hue and saturation levels. +Alternatively the user can enter figures directly in these boxes. There +is also a square at the bottom center of the dialog box which displays +the color which is under consideration at any time. To the right of +this display is another text box labeled <guilabel>HTML</guilabel>: This +shows the user the color code that would be used to specify the +particular displayed color in <acronym>HTML</acronym> code which is +widely used for web pages.</para> + +<para>In addition to the above, the color dialog allows the capture of +any color currently displayed on the desktop or in another program. +Clicking on the button with the dropper icon (located on the right side +of the dialog box) changes the shape of the mouse cursor to a set of +cross hairs. Clicking again will pick up the color attributes of +whatever color is displayed under the cross hairs.</para> + +<para>Furthermore the user has the option of adding any color to a +personal palette of <guilabel>Use custom colors</guilabel> by clicking on +the wide button labeled <guibutton>Add to Custom Colors</guibutton> +(which is located above the display square.) This adds the current +color to the custom color palette. This palette and any other available +palettes can be displayed using the drop down selection box located +directly above the palette display at the top right of the dialog box. +Besides the custom colors, the user can access a number of pre-prepared +palettes.</para> + +<variablelist> +<varlistentry> +<term><guilabel>Use custom colors</guilabel></term> +<listitem> +<para>By default &kedit; will use your system color scheme. If this +is enabled, you may choose a Foreground and background color below.</para> +</listitem> +</varlistentry> + +<varlistentry id="pref-color-settings"> +<term><guilabel>Foreground color:</guilabel></term> +<listitem> +<para>Here the user can specify a color for the text used in +&kedit;.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Background color:</guilabel></term> +<listitem> +<para>Here the user can specify a color for the general background of +&kedit;.</para> +</listitem> +</varlistentry> + +</variablelist> + +</sect1> + +<sect1 id="prefspellchecker"> +<title>Spelling</title> + +<para>A spell checker is a program designed to help the user catch and +correct any spelling errors. This section of the preferences dialog +allows certain key settings to be adjusted in this regard.</para> + +<variablelist> +<varlistentry> +<term><guilabel>Create root/affix combinations not in +dictionary</guilabel></term> +<listitem> +<para>Selecting this option allows the spell checker to register as +<quote>correct</quote> combinations of root words with suffixes or +prefixes even if the particular combination is not listed in its +dictionary database of words. </para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Consider run-together words as spelling +errors</guilabel></term> +<listitem> +<para>Selecting this will cause the spell checker to register as +<quote>misspelled</quote> two or more correctly spelled words that are +<quote>run-together</quote>, &ie;, that do not have spaces separating +them.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Dictionary:</guilabel></term> +<listitem> +<para>Depending on the user's installation, one or more different +language spelling dictionaries may be available. This drop down box +allows the user to choose which language the spell checker should +use.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Encoding:</guilabel></term> +<listitem> +<para>There are different coding systems used to associate particular +codes with particular characters and symbols. If the user knows which +code he or she is using this drop down box allows this code to be +specified so that the spell checker can do its job correctly. </para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Client:</guilabel></term> +<listitem> +<para>Since &kedit; does not contain its own spell checker, an external +one must be chosen. This is where the user may specify which spell check +program to use.</para> +</listitem> +</varlistentry> +</variablelist> + +</sect1> + +<sect1 id="prefmisc"> +<title>Miscellaneous</title> + +<para>This category deals with three different properties detailed +below.</para> + +<variablelist> +<varlistentry> +<term><guilabel>Word wrap:</guilabel></term> +<listitem> +<para>Word wrap is a feature that causes the editor to automatically +start a new line of text and move (wrap) the cursor to the beginning of +that new line. The drop down box at the top of the dialog provides the +following three word wrap choices:</para> + +<variablelist> +<varlistentry> +<term>Disable Wrapping</term> +<listitem> +<para>Choosing this will keep the editor from doing any wrapping. The +user will have to start new lines manually (with the +<keycap>Enter</keycap> key.)</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>Soft wrapping</term> +<listitem> +<para>This choice has the editor automatically adjust the line lengths +to fit its current width. In other words, the wider the user makes the +editor the longer the lines will be; and the narrower the editor, the +shorter the lines will be. These line breaks are not saved in the file.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>At specified column</term> +<listitem> +<para>Choosing this activates a text box immediately below, labeled +<guilabel>Wrap column:</guilabel>. Here the user may specify the +maximum number of characters in a line of text. +</para> + +<note> +<para>Each character including spaces fills one column.</para> +</note> +</listitem> + +</varlistentry> +</variablelist> +</listitem> +</varlistentry> + +<varlistentry> +<term id="backuppref"><guilabel>Make backup when saving a +file</guilabel></term> +<listitem> +<para>This check box tells the editor to rename the last saved version of +the current document before carrying out a <command>save</command> +command. The editor does this by adding a tilde (<keycap>~</keycap>) at +the end of the name of the original file. In this way the user has a +chance to recover a document if she or he had mistakenly saved something +over it.</para> +</listitem> +</varlistentry> + +</variablelist> +</sect1> + +</chapter> + +<chapter id="credits"> +<title>Credits and Licenses</title> + +<para>&kedit; Copyright 2000 by Bernd Johannes Wuebben +<email>wuebben@math.cornell.edu</email></para> + +<para>Documentation Copyright 2000 by Thad McGinnis +<email>ctmcginnis@compuserve.com</email>.</para> + +<para>This version of the &kedit; Handbook is based on the original by: +Bernd Johannes Wuebben <email>wuebben@math.cornell.edu</email></para> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + +&underFDL; +&underGPL; + +</chapter> + +<appendix id="installation"> +<title>Installation</title> + +&install.intro.documentation; +&install.compile.documentation; + +</appendix> + +</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 +--> diff --git a/doc/kfloppy/Makefile.am b/doc/kfloppy/Makefile.am new file mode 100644 index 0000000..085981d --- /dev/null +++ b/doc/kfloppy/Makefile.am @@ -0,0 +1,4 @@ + +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/kfloppy/index.docbook b/doc/kfloppy/index.docbook new file mode 100644 index 0000000..9915f80 --- /dev/null +++ b/doc/kfloppy/index.docbook @@ -0,0 +1,614 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY kappname "&kfloppy;"> + <!ENTITY package "kdeutils"> + <!ENTITY % English "INCLUDE" > <!-- change language only here --> + <!ENTITY % addindex "IGNORE"> + <!ENTITY BSD "<trademark>BSD</trademark>"> + <!ENTITY Minix "<trademark>Minix</trademark>"> +]> +<!-- ### TODO Is BSD a trademark or a registrated trademark ? --> +<!-- ### TODO Is Minix a trademark or a registrated trademark ? --> + +<!-- ### TODO Unify use of "disk", "floppy", "diskette", "floppy disk" (and "floppy drive") --> + +<book lang="&language;"> +<bookinfo> + +<title>The &kfloppy; Formatter Handbook</title> + +<authorgroup> +<author> +<firstname>Thad</firstname> +<surname>McGinnis</surname> +<affiliation><address><email>ctmcginnis@compuserve.com</email> +</address></affiliation> </author> + +<author> +<firstname>Nicolas</firstname> +<surname>Goutte</surname> +<affiliation><address><email>goutte@kde.org</email> +</address></affiliation> </author> + +<othercredit role="developer"> +<firstname>Bernd</firstname> +<othername>Johannes</othername> +<surname>Wuebben</surname> +<affiliation><address><email>wuebben@math.cornell.edu</email></address></affiliation> +<contrib>Developer</contrib> +</othercredit> + +<othercredit role="developer"> +<firstname>Chris</firstname> +<surname>Howells</surname> +<affiliation><address><email>howells@kde.org</email></address></affiliation> +<contrib>Developer (User Interface re-design)</contrib> +</othercredit> + +<othercredit role="developer"> +<firstname>Adriaan</firstname> +<surname>de Groot</surname> +<affiliation><address><email>groot@kde.org</email></address></affiliation> +<contrib>Developer (Add BSD support)</contrib> +</othercredit> + +<othercredit role="reviewer"> +<firstname>Lauri</firstname> +<surname>Watts</surname> +<contrib>Reviewer</contrib> +<affiliation><address><email>lauri@kde.org</email></address></affiliation> +</othercredit> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2005-06-01</date> +<releaseinfo>3.5</releaseinfo> + +<copyright> +<year>2000</year> +<holder>Thad McGinnis</holder> +</copyright> + +<copyright> +<year>2005</year> +<holder>Nicolas Goutte</holder> +</copyright> + +<legalnotice>&FDLNotice;</legalnotice> + +<abstract><para>&kfloppy; Formatter is a utility that provides a +straightforward graphical means to format 3.5" and 5.25" floppy +disks.</para></abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>kfloppy</keyword> +<keyword>floppy</keyword> +<keyword>format</keyword> +</keywordset> + +</bookinfo> + +<chapter id="introduction"> +<title>Introduction</title> + +<para>&kfloppy; Formatter is a utility that provides a straightforward +graphical means to format 3.5" and 5.25" floppy disks. </para> + +<note><para>&kfloppy; depends on external programs and therefore +currently works <emphasis>only</emphasis> with &Linux; and &BSD;. Depending if you are +using &kfloppy; on &Linux; or on &BSD;, &kfloppy; has slightly different +features.</para></note> + +<caution><para>Make sure that your floppy disk is <emphasis>not</emphasis> +mounted. &kfloppy; cannot format a mounted floppy disk.</para></caution> + +</chapter> + +<chapter id="usingkfloppy"> +<title>Using &kfloppy;</title> + +<para>Starting &kfloppy; opens a single window by which the user may +choose appropriate settings and control the formatting process. These +options and controls are detailed below.</para> + +<caution><para>Make sure that your floppy disk is <emphasis>not</emphasis> +mounted. &kfloppy; cannot format a mounted floppy disk.</para></caution> + +<sect1 id="controlsettings"> +<title>Control Settings</title> + +<para>The settings are chosen by means of three drop down boxes located +at the top left center of &kfloppy;.</para> + +<sect2 id="selectdrive"> +<title>Floppy Drive</title> + +<para>Clicking on the top drop down box, which is labeled +<guilabel>Floppy drive:</guilabel>, offers the user the following +two choices:</para> + +<itemizedlist> +<listitem><para>Primary</para></listitem> +<listitem><para>Secondary</para></listitem> +</itemizedlist> + +<para>Clicking on the second drop down box from the top, which is labeled +<guilabel>Size:</guilabel>, offers the user the following +four choices:</para> + +<itemizedlist> +<listitem><para>3.5" 1.44MB</para></listitem> +<listitem><para>3.5" 720KB</para></listitem> +<listitem><para>5.25" 1.2MB</para></listitem> +<listitem><para>5.25" 360KB</para></listitem> +</itemizedlist> + +<para>The &Linux; version of &kfloppy; has also a choice of size named:</para> + +<itemizedlist> +<listitem><para>Auto-Detect</para></listitem> +</itemizedlist> + +<!-- ### TODO: typical floppy disk of a PC has not the hardware to support +Mac 800KB floppies at all, not only formatting. --> +<note> +<para>The 800KB disk format used by <hardware>&Mac; floppy drives</hardware> cannot be +supported on <hardware>PC floppy drives</hardware> since they are not capable of formatting +disks in that fashion.</para> +</note> +</sect2> + +<sect2 id="filesystems"> +<title><guilabel>File Systems</guilabel></title> + +<para>The third drop down box, labeled File System, offers the user the +following choices, if they are applicable:</para> + +<variablelist> +<varlistentry> +<term>Dos</term> +<listitem> +<para>This selection will have &kfloppy; place the MS-DOS/&Windows; type +of file system on the diskette. The user will most likely want to +choose this system if she or he will be using the diskette with those +operating systems as they do not recognize other system types. +(This is supported for &Linux; and &BSD;.)</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>ext2</term> +<listitem> +<para>This selection will have &kfloppy; place the type of file system +on the diskette which is most commonly used with &Linux;, however +seldomly on floppy disks. +(This is supported for &Linux; and &BSD;.)</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>UFS</term> +<listitem> +<para>This selection will have &kfloppy; place the type of file system +on the diskette which is most commonly used with <trademark class="registered">FreeBSD</trademark>. The user will +likely want to choose this system if he or she will only be using the +floppy disk with <trademark class="registered">FreeBSD</trademark>. +(This is supported for &BSD; only.)</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>Minix</term> +<listitem> +<para>This selection will have &kfloppy; place the type of file system +on the diskette which often used on floppy disks used with &Linux;, +(This is supported for &Linux; only.)</para> +</listitem> +</varlistentry> +</variablelist> + +</sect2> +</sect1> + +<sect1 id="formatting-options"> +<title>Formatting Options</title> +<para>Within the outline of a box in the left center of &kfloppy; the user +may find a set of five formatting options. The top two are a pair of radio +buttons.</para> <note><para>This term (radio buttons) indicates a set of options among +which only one can be selected - in the same way that only one preset +channel selection may be set on a car radio.</para></note><para>The +bottom two options are for labeling the diskette. All are explained +below:</para> + +<sect2> +<title>Formatting Method</title> +<para>&kfloppy; can format a disk in the following two ways:</para> +<para> +<variablelist> +<varlistentry> +<term><guilabel>Quick Format</guilabel></term> +<listitem> +<para>This simply puts the new file system on the disk.</para> +<warning><para>All data on the disk will be lost, even if the data itself will not erased.</para></warning> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Zero out and quick format</guilabel></term> +<listitem> +<para>This format first puts zeros on the disk and then creates the new file system.</para> +<warning><para>All data on the disk will be erased.</para></warning> +</listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Full Format</guilabel></term> +<listitem> +<para>A full format reallocates the tracks and sectors, puts the selected +file system on the disk, and then verifies the format, blocking out any bad +sectors it finds.</para> +<warning><para>All data on the disk will be erased.</para></warning> +</listitem> +</varlistentry> +</variablelist> +</para> +</sect2> + +<sect2> +<title>Verify Integrity</title> + +<para>This tells &kfloppy; to check that the formatting was correctly +written to the floppy. This allows bad sectors to be identified. +</para> + +<note><para>If bad sectors a found during the verify phase of a Full Format, +the formatting is aborted and the file system is not written! +</para></note> + +</sect2> + +<sect2> +<title>Volume Label</title> + +<para>The bottom two features allow the user to add (or change) a +label to the diskette. If the <guilabel>Volume label:</guilabel> check +box is selected then the user can enter a name (label) for the +diskette that is to be formatted in the text box located immediately +below. When the diskette is subsequently formatted the label will be +written to the diskette.</para> + +<note><para>Due to a limitation of the DOS file system, a label can only be +at most 11 characters long. For simplification, &kfloppy; assumes that +this limit is true for all file systems.</para></note> + +<note><para>The file system &Minix; cannot have any volume label. In this +case, &kfloppy; will ignore the volume label.</para></note> + +</sect2> + +</sect1> + +<sect1 id="buttons"> +<title>The Buttons</title> +<para>There are three buttons located vertically along the right side of +&kfloppy;. </para> + +<variablelist> +<varlistentry> +<term><guibutton>Format</guibutton></term> +<listitem> +<para>This button +initiates the formatting process. Once the user is sure that all the +settings are correct he or she may begin the process by clicking on +this button. +There will be a change in the two long rectangular boxes +that span the bottom of &kfloppy;.</para> + +<para>The upper box is a status indicator that gives information about the +process underway, especially the error encountered during the processing.</para> + +<para>The lower box is a progress bar. This displays both graphically +and numerically the progress of first the formatting and then the +verification. Before starting it appears to be empty - showing only +the figure 0% in the center. As each process +takes place the progress is tracked graphically as the box fills from +left to right. At the same time the number in the center will +increase reflecting the precise percentage of the process that has +been completed.</para> + +<note><para>As &kfloppy; uses external programs to format the floppy disk, +it has to rely on these programs to give the right information for +being able to display the progress bar. Unfortunately, this is not the +case. Especially, the programs writing the file systems do not return +enough data, so that the progress bar will remain at 0%.</para></note> + +<important> +<para>Make sure that your floppy disk is <emphasis>not</emphasis> mounted. +&kfloppy; cannot format a mounted floppy disk.</para> +</important> + +<note><para>&kfloppy; does <emphasis>not</emphasis> unmount the +floppy by itself, as this could mean that the user may overwrite a floppy +disk with important data on it.</para></note> +</listitem> +</varlistentry> + +<varlistentry> +<term><guibutton>Help</guibutton></term> +<listitem> +<para>This invokes the &kde; help system starting at the &kfloppy; help pages +(this document).</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guibutton>Report Bug</guibutton></term> +<listitem> +<para>Report a problem to the &kde; team.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guibutton>About KFloppy</guibutton></term> +<listitem> +<para>This displays version and author information of &kfloppy;.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guibutton>About KDE</guibutton></term> +<listitem> +<para>This displays version and author information of KDE.</para> +</listitem> +</varlistentry> + + +<varlistentry> +<term><guibutton>Quit</guibutton></term> +<listitem> +<para>Clicking on this button will close &kfloppy;.</para> +</listitem> +</varlistentry> + +</variablelist> + +</sect1> +</chapter> + +<chapter id="command-line"> +<title>Command line options</title> + +<para>Though &kfloppy; may most often be started from the &kde; program menu, +or a desktop icon, it can also be opened at the command line prompt of a +terminal window. There are a few options that are available when doing +this. They are:</para> + +<variablelist> +<varlistentry> +<term><command>kfloppy <option>--help</option></command></term> +<listitem><para>This lists the most basic options available at the command +line.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><command>kfloppy <option>--help-qt</option></command></term> +<listitem><para>This lists the options available for changing the way +&kfloppy; interacts with &Qt;.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><command>kfloppy <option>--help-kde</option></command></term> +<listitem> +<para>This lists the options available for changing the way &kfloppy; +interacts with KDE.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><command>kfloppy <option>--help-all</option></command></term> +<listitem> +<para>This lists all of the command line options.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><command>kfloppy <option>--author</option></command></term> +<listitem> +<para>Lists &kfloppy;'s author in the terminal window</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><command>kfloppy <option>--version</option></command></term> +<listitem> +<para>Lists version information for &Qt;, &kde;, and &kfloppy;. Also available +through <command>kfloppy <option>-V</option></command> </para> +</listitem> +</varlistentry> +</variablelist> + +</chapter> + +<chapter id="credits"> +<title>Credits and Licenses</title> + +<!-- ### TODO: verify the copyright dates --> +<!-- ### TODO: make the copyright list prettier --> +<para>&kfloppy; Formatter Program Copyright 1997 - 2000 Bernd Johannes Wuebben +<email>wuebben@math.cornell.edu</email></para> + +<para>&kfloppy; Formatter Program Copyright 2002 Adriaan de Groot +<email>groot@kde.org</email></para> + +<para>&kfloppy; Formatter Program Copyright 2004, 2005 Nicolas Goutte +<email>goutte@kde.org</email></para> + +<para>Documentation Copyright 2000 by Thad McGinnis +<email>ctmcginnis@compuserve.com</email>.</para> + +<para>Documentation Copyright 2005 by Nicolas Goutte +<email>goutte@kde.org</email>.</para> + +<para>This version of the &kfloppy; Handbook is based on the original by +David Rugge <email>davidrugge@mindspring.com</email></para> + +&underFDL; +&underGPL; + +</chapter> + +<appendix id="neededprogs"> +<title>Needed External Programs</title> + +<para>As already written earlier in this handbook, &kfloppy; works +with the help of external programs to do the different formatting tasks.</para> + +<note><para>If one of the programs is missing, &kfloppy; tries to work nevertheless. +However the corresponding option will not be available.</para></note> + +<variablelist> +<varlistentry> +<term><command>fdformat</command></term> +<listitem><para>This program is needed for low-level formatting, +on &Linux; and on &BSD;. If it is missing, +<guilabel>Full format</guilabel> will be disabled. +</para></listitem> +</varlistentry> +<varlistentry> +<term><command>dd</command></term> +<listitem><para>This program is needed for zeroing-out, +on &Linux; and on &BSD;. If it is missing, +<guilabel>Zero out and quick format</guilabel> will be disabled. +</para></listitem> +</varlistentry> +<varlistentry> +<term><command>mkdosfs</command></term> +<listitem><para>This program is needed for DOS formatting, +on &Linux;. +</para></listitem> +</varlistentry> +<varlistentry> +<term><command>newfs_msdos</command></term> +<listitem><para>This program is needed for DOS formatting, +on &BSD;. +</para></listitem> +</varlistentry> +<varlistentry> +<term><command>newfs</command></term> +<listitem><para>This program is needed for UFS formatting, +on &BSD;. +</para></listitem> +</varlistentry> +<varlistentry> +<term><command>mke2fs</command></term> +<listitem><para>This program is needed for ext2 formatting, +on &Linux; and on &BSD;. +</para></listitem> +</varlistentry> +<varlistentry> +<term><command>mkfs.minix</command></term> +<listitem><para>This program is needed for &Minix; formatting, +on &Linux;. +</para></listitem> +</varlistentry> +</variablelist> + +</appendix> +<appendix id="usergivendevices"> +<title>User-Given Devices</title> + +<sect1 id="ugdintro"> +<title>Introduction</title> + +<para>"User Given Devices" is the work title of a still experimental feature of +&kfloppy;. It allows the user to give a device name and to use it nearly +as if it was a <hardware>floppy drive</hardware>.</para> + +<para>This feature is mainly intended as a work-around for users having +<hardware>USB floppy drives</hardware> of any kind +(including <trademark>ZIP</trademark> disk drives) or any other non-legacy +<hardware>floppy drives</hardware>.</para> + +<note><para>Unfortunately at the time of writing this documentation, the feature +is not very user friendly, as it does not offer any help to the user on how +a device is called and &kfloppy; does not even remember the device name from +call to call. (This is partially a security, as the device of the +<hardware>floppy drive</hardware> might change between reboots.)</para></note> + +<note><para>As this feature was developed under &Linux;, the &BSD; version +of &kfloppy; offers less choices than &kfloppy; under &Linux;.</para></note> + +</sect1> + +<sect1 id="ugdmain"> +<title>Using It</title> + +<!-- Note to reviewers: "PRimary" and "Secondary" are the default items in the combobox --> +<para>Using "User Given Devices" is quite simple, you just need to enter +a device name, for example <replaceable>/dev/sdz4</replaceable> +in the <guilabel>Floppy drive:</guilabel> combobox instead of +selecting Primary or Secondary.</para> + +<note> +<para>You need to enter the <filename class="directory">/dev/</filename> +part of the device for two reasons:</para> +<itemizedlist> +<listitem> +<para>It is how &kfloppy; recognizes the "User Given Devices" mode.</para> +</listitem> +<listitem> +<para>It is a security, to avoid that the user writes anything in the combobox +that is by change a device name.</para> +</listitem> +</itemizedlist> +</note> + +<para>Unfortunately, using any device instead of a floppy device has a few +consequences. The major one is that <guilabel>Full Format</guilabel> cannot be +selected anymore. Doing so will result in a error message box when trying to +start the format. However you can use <guilabel>Zero out and quick format</guilabel> +instead. It will not format the device, just zeroing it out, but in practice it is +nearly the same; especially all data on the device will be erased.</para> + +<warning><para>Be careful when entering the device name. &kfloppy; will pass +the device name as is to the external programs. Especially it does not check +(and the external programs do not check either) if the device is a +<hardware>floppy drive</hardware> device. If you give your any of your main +disk partitions as device, it will be accepted. (If the partition is mounted +or if you cannot write on this device, you +will probably get an error message nevertheless, avoiding the worst.)</para></warning> + +<note><para>Even if you can specify a floppy device like +<filename>/dev/fd0u2880</filename>, &kfloppy; will refuse to make a +<guilabel>Full Format</guilabel> on it.</para></note> + +<para>On &Linux;, you can select any file system that you want. On &BSD;, +only UFS is currently supported (and not tested at time of writing this +documentation).</para> + +<para>When you are ready to format, click on the <guibutton>Format</guibutton> +button as usual. You will get a message box asking you to verify the device name. +</para> + +<warning><para>This is the last chance to check the device name before formating. +After it, it is too late.</para></warning> + +</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: + +// vim:ts=2:sw=2:tw=78:noet +--> diff --git a/doc/kgpg/Makefile.am b/doc/kgpg/Makefile.am new file mode 100644 index 0000000..5271453 --- /dev/null +++ b/doc/kgpg/Makefile.am @@ -0,0 +1,4 @@ + +KDE_LANG=en +KDE_DOCS=kgpg + diff --git a/doc/kgpg/editor.png b/doc/kgpg/editor.png Binary files differnew file mode 100644 index 0000000..f435ac8 --- /dev/null +++ b/doc/kgpg/editor.png diff --git a/doc/kgpg/index.docbook b/doc/kgpg/index.docbook new file mode 100644 index 0000000..2f8f983 --- /dev/null +++ b/doc/kgpg/index.docbook @@ -0,0 +1,354 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.1.2-Based Variant V1.0//EN" +"dtd/kdex.dtd" [ + <!ENTITY kgpg "<application>Kgpg</application>"> + <!ENTITY package "kdeutils"> + <!ENTITY kappname "&kgpg;"> + <!ENTITY % addindex "IGNORE"> + <!ENTITY % English "INCLUDE"> +]> + +<book 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> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> + +</authorgroup> + +<copyright> +<year>2002</year> +<holder>Jean-Baptiste Mardelle</holder> +</copyright> + +<legalnotice>&FDLNotice;</legalnotice> + +<date>2002-03-01</date> +<releaseinfo>0.02.00</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/(en)/documentation/howtos.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="kicker.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. +You can also drop files or text on the applet icon to encrypt or decrypt it. +</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 Key Manager window, &LMB; on &kgpg;'s applet. +You can import, export, sign and edit your keys. Most actions can be performed with a &LMB; 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 editor, &RMB; on &kgpg;'s applet. +</para> +</listitem> +</varlistentry> + + +<varlistentry> +<term>Konqueror Integration</term> +<listitem> + +<para>&kgpg; is integrated in &konqueror;. 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 plece, 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 key 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 Expert mode button, which +will bring up a &konsole; window with all of gpg's options.</para> + +</sect1> + +<sect1 id="encryption"> +<title>Encrypting Your Data</title> + +<sect2 id="konqui"> + +<title>Encrypting a File From &konqueror;</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 ASCII encryption or not.</para> + +</sect2> + +<sect2 id="drop"> +<title>Encrypting a File or Text With &kgpg;'s Applet</title> + +<para>Simply drop your file on the &kgpg; system tray applet. If it is +an unencrypted file, &kgpg; will pop up the key selection dialog (see +below). Select the encryption key, and the encrypted file will be +saved. If you drop text, the encrypted text will be pasted to the +clipboard. You can also encrypt clipboard by selecting the +<guimenuitem>Encrypt clipboard</guimenuitem> item in applet +menu.</para> + +<screenshot> +<screeninfo>Here's a screen shot of the key selection window</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="keys.png" format="PNG"/></imageobject> +</mediaobject> +</screenshot> + +<para>For more information on the encryption options <quote>ASCII +armor</quote>, <quote>Allow encryption with untrusted keys</quote> and +<quote>Symmetrical encryption</quote>, please refer to gpg's +documentation or man pages.</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>Encrypt</guibutton> again. The encrypted message will +appear in the editor window.</para> +</sect2> + +</sect1> + +<sect1 id="decryption"> +<title>Decrypting Your Data</title> + + +<sect2 id="konq-dec"> +<title>Decrypting a File From &konqueror;</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="kicker-dec"> +<title>Decrypting Text or a File With the &kgpg; applet</title> + +<para>You can drop an encrypted file or selected text on the &kgpg; +system tray applet. You will then be prompted for passphrase, and the +decrypted file/text will be saved or opened in the &kgpg; editor +depending from how you configured the applet. You can also decrypt +clipboard with the <guimenuitem>decrypt clipboard</guimenuitem> menu +entry of the &kgpg; applet </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 &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> + +<screenshot> +<screeninfo>Here's a screen shot of key management</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="keymanage.png" format="PNG"/></imageobject> +</mediaobject> +</screenshot> + +</sect1> + +<sect1 id="options"> +<title>Configuring &kgpg;</title> + +<para>Configuration is accessible through the &kgpg; applet menu (&RMB; +click on the applet). 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 man page. </para> + +<screenshot> +<screeninfo>Here's a screen shot of the option dialog</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="options.png" format="PNG"/></imageobject> +</mediaobject> +</screenshot> + +</sect1> + +</chapter> + + +<chapter id="credits"> + +<title>Credits and License</title> + +<para> +&kgpg; +</para> + +<para>Program copyright © 2002-2003 Jean-Baptiste Mardelle +<email>bj@altern.org</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: +--> + + diff --git a/doc/kgpg/keygen.png b/doc/kgpg/keygen.png Binary files differnew file mode 100644 index 0000000..6bad563 --- /dev/null +++ b/doc/kgpg/keygen.png diff --git a/doc/kgpg/keymanage.png b/doc/kgpg/keymanage.png Binary files differnew file mode 100644 index 0000000..4dcd05b --- /dev/null +++ b/doc/kgpg/keymanage.png diff --git a/doc/kgpg/keys.png b/doc/kgpg/keys.png Binary files differnew file mode 100644 index 0000000..5977ddc --- /dev/null +++ b/doc/kgpg/keys.png diff --git a/doc/kgpg/kicker.png b/doc/kgpg/kicker.png Binary files differnew file mode 100644 index 0000000..359b143 --- /dev/null +++ b/doc/kgpg/kicker.png diff --git a/doc/kgpg/options.png b/doc/kgpg/options.png Binary files differnew file mode 100644 index 0000000..40a2776 --- /dev/null +++ b/doc/kgpg/options.png diff --git a/doc/khexedit/Makefile.am b/doc/khexedit/Makefile.am new file mode 100644 index 0000000..085981d --- /dev/null +++ b/doc/khexedit/Makefile.am @@ -0,0 +1,4 @@ + +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/khexedit/index.docbook b/doc/khexedit/index.docbook new file mode 100644 index 0000000..fc03585 --- /dev/null +++ b/doc/khexedit/index.docbook @@ -0,0 +1,1063 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY kappname "&khexedit;" > <!-- this only *seems* redundant --> + <!ENTITY package "kdeutils"> + <!ENTITY % English "INCLUDE"> + <!ENTITY % addindex "IGNORE"> +]> +<book lang="&language;"> + +<bookinfo> +<title>The &khexedit; Handbook</title> + +<authorgroup> +<author> +<firstname>Jonathan</firstname> +<surname>Singer</surname> +<affiliation> +<address><email>jsinger@leeta.net</email></address> +</affiliation> +</author> + +<othercredit role="developer"> +<firstname>Espen</firstname> +<surname>Sand</surname> +<affiliation> +<address><email>espensa@online.no</email></address> +</affiliation> +<contrib>Developer</contrib> +</othercredit> + +<othercredit role="reviewer"> +<firstname>Lauri</firstname> +<surname>Watts</surname> +<affiliation> +<address><email>lauri@kde.org</email></address> +</affiliation> +<contrib>Reviewer</contrib> +</othercredit> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<copyright> +<year>1999-2000</year> +<holder>Jonathan Singer</holder> +</copyright> + +<legalnotice>&FDLNotice;</legalnotice> + +<date>2001-07-06</date> +<releaseinfo>0.08.05</releaseinfo> + +<abstract><para>&khexedit; is a hexadecimal editor for the &kde; +environment.</para></abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>Kapp</keyword> +<keyword>edit</keyword> +<keyword>binary</keyword> +<keyword>hexadecimal</keyword> +</keywordset> +</bookinfo> + +<chapter id="introduction"> +<title>Introduction</title> + +<para>&khexedit; is an editor for the raw data of binary files. It +includes find/replace functions, bookmarks, many configuration options, +drag and drop support and other powerful features.</para> + +</chapter> + +<chapter id="starting-khexedit"> +<title>Starting &khexedit;</title> +<para>Type <userinput><command>khexedit</command></userinput> at a command +prompt or select <guimenuitem>Binary Editor</guimenuitem> from the +<guisubmenu>Utilities</guisubmenu> group in the <guimenu>KDE start +menu</guimenu>.</para> + +<para>The standard &Qt; and &kde; command line +options are available, and can be listed by entering +<userinput><command>khexedit</command> <option>--help</option></userinput>. </para> + +<para>Other command line options are:</para> + +<para><option><replaceable><file></replaceable></option> - open the +specified file</para> + +<para><option>--offset</option> +<replaceable><offset></replaceable> jump to position +<replaceable><offset></replaceable> in the opened file.</para> + +</chapter> + +<chapter id="nutshell"> +<title>&khexedit; In A Nutshell</title> + +<para>The main &khexedit; window has the following components: menu bar, toolbar, +offset column, data editor window, text field, search bar, conversion field and +status bar. </para> + +<screenshot> +<screeninfo>&khexedit; Screen</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="khexedit1.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>&khexedit; Screen</phrase> + </textobject> + </mediaobject> +</screenshot> + +<para>When a document is opened, the bytes are displayed in hexadecimal format +in the data editor window. The data can be edited, cut, copied, pasted, dragged +and dropped much as text is in an text editor or word processor. A cursor marks +the current position. Pressing the <keycap>Insert</keycap> key toggles between +overwrite and insert text entry modes. The data can also be displayed as octal, +binary or decimal values, by choosing the desired format in the +<guimenu>View</guimenu> menu.</para> + +<para>The offset column on the left indicates the position of a particular byte +in the file. The text field on the right displays the <acronym>ASCII</acronym> +encoding of the file. The cursor position and edits in the data editor window +are reflected in the text field. The text field can also be edited, and those +changes are reflected in the data editor window.</para> + +<para>The search bar allows the user to search for a specific value -- +hexadecimal, octal, binary, decimal or text.</para> + +<para>The conversion field displays the value of the byte at the cursor position +in a variety of bases. It also displays the value of all standard data types +starting at the cursor.</para> + +<para>Multiple documents can be open at the same time but only one can be +active. Use the <guimenu>Documents</guimenu> menu to select which document will +be active.</para> + +</chapter> + +<chapter id="menu-commands"> +<title>Menu Commands</title> + +<para>Note that most menu commands also have a keyboard shortcut.</para> + +<sect1 id="file-menu"> +<title><guimenu>File</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo> +</shortcut> +<guimenu>File</guimenu> +<guimenuitem>New</guimenuitem> +</menuchoice></term> +<listitem><para><action>Open a new file.</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>O</keycap></keycombo> +</shortcut> +<guimenu>File</guimenu> +<guimenuitem>Open...</guimenuitem> +</menuchoice></term> +<listitem><para><action>Open an existing file.</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>I</keycap></keycombo> +</shortcut> +<guimenu>File</guimenu> +<guimenuitem>Insert...</guimenuitem> +</menuchoice></term> +<listitem><para><action>Insert an exiting file in the current +document.</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>File</guimenu> +<guisubmenu>Open Recent</guisubmenu> +</menuchoice></term> +<listitem><para><action>Choose from a list of the last opened +files.</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>File</guimenu> +<guimenuitem>Revert</guimenuitem> +</menuchoice></term> +<listitem><para><action>Return edited document to the last saved +state.</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>S</keycap></keycombo> +</shortcut> +<guimenu>File</guimenu> +<guimenuitem>Save</guimenuitem> +</menuchoice></term> +<listitem><para><action>Save document.</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>File</guimenu> +<guimenuitem>Save As...</guimenuitem> +</menuchoice></term> +<listitem><para><action>Save document with a new name.</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>W</keycap></keycombo> +</shortcut> +<guimenu>File</guimenu> +<guimenuitem>Close</guimenuitem> +</menuchoice></term> +<listitem><para><action>Close the current document.</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>P</keycap></keycombo> +</shortcut> +<guimenu>File</guimenu> +<guimenuitem>Print...</guimenuitem> +</menuchoice></term> +<listitem><para><action>Print the current document.</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>File</guimenu> +<guimenuitem>Export...</guimenuitem> +</menuchoice></term> +<listitem><para><action>Export the selected document or a portion of +it.</action></para><para>Opens a dialog box with these options:</para> +<variablelist> +<varlistentry> +<term><guilabel>Format</guilabel></term> +<listitem><para>Plain text, <acronym>HTML</acronym> table, rich text +format, C array. Use the <guilabel>Options</guilabel> tab to select +details for a C array or an <acronym>HTML</acronym> table.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Destination</guilabel></term> +<listitem><para>The file to which the data will be +exported</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Export Range</guilabel></term> +<listitem><para>Selects which data will be exported -- the entire document, the +selected portion or the range between two specified +offsets.</para></listitem> +</varlistentry> +</variablelist> +</listitem></varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>File</guimenu> +<guimenuitem>Cancel Operation</guimenuitem> +</menuchoice></term> +<listitem><para>Stop the current operation</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>File</guimenu> +<guimenuitem>Permissions</guimenuitem> +</menuchoice></term> +<listitem><para>Set write privileges:</para> +<variablelist> + +<varlistentry> +<term><guilabel>Read only</guilabel></term> +<listitem><para>When set, changes may not be made to the displayed +file.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Allow Resize</guilabel></term> +<listitem><para>When off, individual bytes may be edited but the total number of +bytes may not be changed.</para></listitem> +</varlistentry> +</variablelist> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>File</guimenu> +<guimenuitem>New Window</guimenuitem> +</menuchoice></term> +<listitem><para><action>Open an additional</action> &khexedit; +window</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>File</guimenu> +<guimenuitem>Close Window</guimenuitem> +</menuchoice></term> +<listitem><para><action>Close the current</action> &khexedit; +window</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>Close all &khexedit; windows</para></listitem> +</varlistentry> +</variablelist> + +</sect1> + +<sect1 id="edit-menu"> +<title><guimenu>Edit</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>Z</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Undo</guimenuitem> +</menuchoice></term> +<listitem><para><action>Undo the last action.</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;&Shift;<keycap>Z</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Redo</guimenuitem> +</menuchoice></term> +<listitem><para><action>Redo the last undone action.</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>X</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Cut</guimenuitem> +</menuchoice></term> +<listitem><para><action>Delete the selected bytes and copy them to the +clipboard.</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>C</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Copy</guimenuitem> +</menuchoice></term> +<listitem><para><action>Copy the selected bytes to the +clipboard.</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>V</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Paste</guimenuitem> +</menuchoice></term> +<listitem><para><action>Insert the cut or copied bytes in the +clipboard.</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Edit</guimenu> +<guisubmenu>Special</guisubmenu> +</menuchoice></term> +<listitem><para>Variations on <guimenuitem>Copy</guimenuitem> and +<guimenuitem>Paste</guimenuitem>:</para> +<itemizedlist> +<listitem><para><guimenuitem>Copy as Text</guimenuitem>: Copies +the selected bytes as <acronym>ASCII</acronym> characters.</para></listitem> +<listitem><para><guimenuitem>Paste into New +File</guimenuitem>.</para></listitem> +<listitem><para><guimenuitem>Paste into new +window.</guimenuitem></para></listitem> +</itemizedlist> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>A</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Select All</guimenuitem> +</menuchoice></term> +<listitem><para><action>Select entire document.</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Edit</guimenu> +<guimenuitem>Unselect</guimenuitem> +</menuchoice></term> +<listitem><para><action>Unselect entire document.</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>F</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Find...</guimenuitem> +</menuchoice></term> +<listitem><para><action>Find a specified pattern in the document.</action> +Hexadecimal,decimal, octal, binary or text patterns can be searched for.</para> +<para>Options in the dialog box allow you to specify the starting point, +direction and range of the search.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul"><keycap>F3</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Find Next</guimenuitem> +</menuchoice></term> +<listitem><para><action>Find the next instance</action> of the +<guimenuitem>Find</guimenuitem> pattern.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Shift;<keycap>F3</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Find Previous</guimenuitem> +</menuchoice></term> +<listitem><para><action>Find the previous instance</action> of the +<guimenuitem>Find</guimenuitem> pattern.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>R</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Replace...</guimenuitem> +</menuchoice></term> +<listitem><para><action>Replace</action> the find pattern with a different +pattern.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>G</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Goto Offset...</guimenuitem> +</menuchoice></term> +<listitem><para><action>Move the cursor to a specified +offset.</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>Ins</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Insert Pattern...</guimenuitem> +</menuchoice></term> +<listitem><para><action>Insert a specified string of bytes.</action></para> +<para>Options in the dialog box allow you to specify the length of the pattern, +its format (hexadecimal, decimal, octal, binary or text) and the insertion +point.</para> +<para>If <guilabel>Repeat pattern</guilabel> is checked, the specified pattern +will be inserted repeatedly to reach the length set in +<guilabel>Size</guilabel>.</para></listitem> +</varlistentry> +</variablelist> +</sect1> + +<sect1 id="view-menu"> +<title><guimenu>View</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term><menuchoice> +<guimenu>View</guimenu><guimenuitem>Hexadecimal</guimenuitem> +<guimenu>View</guimenu><guimenuitem>Decimal</guimenuitem> +<guimenu>View</guimenu><guimenuitem>Octal</guimenuitem> +<guimenu>View</guimenu><guimenuitem>Binary</guimenuitem> +<guimenu>View</guimenu><guimenuitem>Text</guimenuitem> +</menuchoice></term> +<listitem><para>The first five choices <action>select the format displayed in the data +editor window</action>: hexadecimal, decimal, octal, binary or text. When text +display is selected, the extra text field is not displayed.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>View</guimenu> +<guimenuitem>Show Offset Column</guimenuitem> +</menuchoice></term> +<listitem><para><action>Toggles display of offset column on and +off.</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>View</guimenu> +<guimenuitem>Show Text Field</guimenuitem> +</menuchoice></term> +<listitem><para><action>Toggles display of text field on and +off.</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>View</guimenu> +<guimenuitem>Offset as Decimal</guimenuitem> +</menuchoice></term> +<listitem><para>When set, <action>all offsets are displayed and interpreted as +decimal numbers</action> rather than as hexadecimals.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>View</guimenu> +<guimenuitem>Upper Case (Data)</guimenuitem> +</menuchoice></term> +<listitem><para>When set, <action>hexadecimal digits in the data are displayed +in upper case.</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>View</guimenu> +<guimenuitem>Upper Case (Offset)</guimenuitem> +</menuchoice></term> +<listitem><para>When set, <action>hexadecimal digits in the offset value are +displayed in upper case.</action></para></listitem> +</varlistentry> + +<varlistentry id="view-encoding"> +<term><menuchoice> +<guimenu>View</guimenu> +<guisubmenu>Document Encoding</guisubmenu> +</menuchoice></term> +<listitem><para>Select the encoding used for display in the text field. +Alternative encodings like <acronym>EBCDIC</acronym> and 7-bit +<acronym>ASCII</acronym> can be used. Additional encodings can be added by the +user (not implemented yet.)</para></listitem> +</varlistentry> +</variablelist> + +</sect1> + +<sect1 id="bookmarks"> +<title><guimenu>Bookmarks</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>B</keycap></keycombo> +</shortcut> +<guimenu>Bookmarks</guimenu> +<guimenuitem>Add Bookmark</guimenuitem> +</menuchoice></term> +<listitem><para>Bookmark a location within the document. </para> +<para>Multiple bookmarks can be set for a single document. Each document has its +own set of bookmarks and the appropriate set is displayed at the bottom of the +<guimenu>Bookmarks</guimenu> menu when a document is selected. Choose a bookmark +from the menu to go to it.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>E</keycap></keycombo> +</shortcut> +<guimenu>Bookmarks</guimenu> +<guimenuitem>Replace Bookmark</guimenuitem> +</menuchoice></term> +<listitem><para><action>Reset an existing bookmark to the current cursor +location.</action> A dialog will be opened with the list of available bookmarks; +select the one you wish to change.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>U</keycap></keycombo> +</shortcut> +<guimenu>Bookmarks</guimenu> +<guimenuitem>Remove Bookmark</guimenuitem> +</menuchoice></term> +<listitem><para><action>Remove an existing bookmark.</action> A dialog will be +opened with a list of available bookmarks; select the one you wish to +remove.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Bookmarks</guimenu> +<guimenuitem>Remove All</guimenuitem> +</menuchoice></term> +<listitem><para><action>Clear the bookmark list.</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Alt;<keycap>Down</keycap></keycombo> +</shortcut> +<guimenu>Bookmarks</guimenu> +<guimenuitem>Goto Next Bookmark</guimenuitem> +</menuchoice></term> +<listitem><para><action>Move the cursor to the next +bookmark.</action></para></listitem> +</varlistentry> +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Alt;<keycap>Up</keycap></keycombo> +</shortcut> +<guimenu>Bookmarks</guimenu> +<guimenuitem>Goto Previous Bookmark</guimenuitem> +</menuchoice></term> +<listitem><para><action>Move the cursor to the previous +bookmark.</action></para></listitem> +</varlistentry> +</variablelist> +</sect1> + +<sect1 id="tools-menu"> +<title><guimenu>Tools</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term><menuchoice> +<guimenu>Tools</guimenu> +<guimenuitem>Extract Strings...</guimenuitem> +</menuchoice></term> +<listitem><para>Locate <acronym>ASCII</acronym> strings in the data. Minimum +string length, case sensitivity and a pattern to match can be +specified.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Tools</guimenu> +<guimenuitem>Binary Filter...</guimenuitem> +</menuchoice></term> +<listitem><para><action>Perform a binary operation on the data.</action> The +operation (AND, OR, ROTATE..) and an operand can be specified in the dialog +box. Check boxes in the dialog allow the operation to be limited to selected +bytes or the region before or after the cursor.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Tools</guimenu> +<guimenuitem>Character Table</guimenuitem> +</menuchoice></term> +<listitem><para>Open a list of values and their <acronym>ASCII</acronym> +equivalents and <action>insert the selected value at the +cursor.</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Tools</guimenu> +<guimenuitem>Converter</guimenuitem> +</menuchoice></term> +<listitem><para><action>Enter a value in any of the fields and see its +equivalent in hexadecimal, decimal, octal, binary or text</action>. A check box +allows viewing of the value at the cursor instead.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Tools</guimenu> +<guimenuitem>Statistics</guimenuitem> +</menuchoice></term> +<listitem><para><action>Display the frequency of occurrence of values in the +document.</action></para></listitem> +</varlistentry> +</variablelist> + +</sect1> + +<sect1 id="document-menu"> +<title><guimenu>Documents</guimenu> Menu</title> + +<para>Provides a list of the open documents. Selecting one makes it +active.</para> + +</sect1> + +<sect1 id="settings-menu"> +<title><guimenu>Settings</guimenu> Menu</title> + +<variablelist> +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Show Toolbar</guimenuitem> +</menuchoice></term> +<listitem><para><action>Toggle display of the toolbar below the +menu bar.</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Show Statusbar</guimenuitem> +</menuchoice></term> +<listitem><para><action>Toggle display of the status bar</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Show Full Path</guimenuitem> +</menuchoice></term> +<listitem><para><action>Toggle display of the full file path in the +titlebar</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guisubmenu>Document Tabs</guisubmenu> +</menuchoice></term> +<listitem><para>Change display of tabs for all current documents. The tab can be +displayed above or below the editor window, or hidden. You may find the tabs +more convenient than the document menu for switching documents.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guisubmenu>Conversion Field</guisubmenu> +</menuchoice></term> +<listitem><para><action>Change display of the value conversion field.</action> +It can be embedded in the main window, made a floating window or +hidden.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Searchbar</guimenuitem> +</menuchoice></term> +<listitem><para><action>Change display of the value search bar</action>. It can be +displayed above or below the editor window, or hidden.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Save Options</guimenuitem> +</menuchoice></term> +<listitem><para><action>Save the current state of the +options.</action></para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Preferences...</guimenuitem> +</menuchoice></term> +<listitem><para>Change these settings:</para> +<variablelist> +<varlistentry> +<term><guilabel>Layout</guilabel></term> +<listitem><para>Line and column size (in bytes). These can be set separately for +different modes. Fixed number of bytes per line. Lock column at end of +line. Grid lines between rows and columns. Width of field separators, spacing and +margins.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Cursor</guilabel></term> +<listitem><para>Blink rate and shape of the cursor. Behavior of the cursor when +the window loses focus.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Font</guilabel></term> +<listitem><para>Font name, style and size. Character used to display +non printing +characters in the text field.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Colors</guilabel></term> +<listitem><para> All colors in &khexedit; can be customized, including odd and +even lines and columns, bookmarks, separators and grid lines. The one exception +is the selection color, which uses the setting chosen in the KDE Control +Center.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Files</guilabel></term> +<listitem><para>Opening of the last, or all recent documents on +startup. Restoration of cursor position. Write protection enabled by +default. Make a backup upon saving files. Saving of <quote>Recent +Documents</quote> list on exit. The <quote>Recent Documents</quote> list can +also be cleared in this dialog.</para></listitem> +</varlistentry> +<varlistentry> +<term><guilabel>Miscellaneous</guilabel></term> +<listitem><para>Automatic copy to clipboard upon selection. Startup in insert +mode, rather than overwrite. Confirmation required for wrapping to the beginning +or end during searches. Cursor jumps to nearest byte when moved in binary +mode. Sound on typing input or fatal failure. Display of bookmarks in the offset +column and editor fields. Warning when number of printable pages exceeds a +settable limit. Maximum number of undos.</para></listitem> +</varlistentry> +</variablelist> +</listitem> +</varlistentry> +</variablelist> + +</sect1> + +<sect1 id="help-menu"> +<title><guimenu>Help</guimenu> Menu</title> + +&help.menu.documentation; + +</sect1> + +<sect1 id="toolbar"><title>Toolbar</title> +<para>The toolbar contains icons for the following commands:</para> + +<note><para>(Except for <guiicon>Drag document</guiicon> and +<guiicon>Toggle</guiicon> write protection, all behave identically to the menu +command.)</para></note> + +<itemizedlist> +<listitem><para><guiicon>Drag document</guiicon> -- Click this button and drag +to a text editor or a new &khexedit; window.</para></listitem> +<listitem><para><guiicon>New</guiicon></para></listitem> +<listitem><para><guiicon>Open</guiicon></para></listitem> +<listitem><para><guiicon>Revert</guiicon></para></listitem> +<listitem><para><guiicon>Save</guiicon></para></listitem> +<listitem><para><guiicon>Print</guiicon></para></listitem> +<listitem><para><guiicon>Find</guiicon></para></listitem> +<listitem><para><guiicon>Find Next</guiicon></para></listitem> +<listitem><para><guiicon>Find Previous</guiicon></para></listitem> +<listitem><para><guiicon>Cut</guiicon></para></listitem> +<listitem><para><guiicon>Copy</guiicon></para></listitem> +<listitem><para><guiicon>Paste</guiicon></para></listitem> +<listitem><para><guiicon>Undo</guiicon></para></listitem> +<listitem><para><guiicon>Redo</guiicon></para></listitem> +<listitem><para><guiicon>Cancel Operation</guiicon></para></listitem> +<listitem><para><guiicon>Help</guiicon></para></listitem> +</itemizedlist> + +<para>..and at the right of the toolbar..</para> +<para><guiicon>Toggle write protection</guiicon> - switch between read-only and +read/write modes.</para> + +<sect2 id="searchbar"> +<title>Search bar</title> + +<para>The search bar is used to locate a specific value in the document. Enter a +value in the box, select the desired representation (hexadecimal, octal, binary, +decimal or text) and hit the <guibutton>Find</guibutton> button. Check the +<guilabel>Backwards</guilabel> box to search backwards from the cursor point or +check <guilabel>Ignore case</guilabel> for a case-insensitive text search. Click +the button on the right of the bar (<guiicon>X</guiicon>) to hide the search bar; +go to <guimenuitem>Searchbar</guimenuitem> in the <guimenu>Settings</guimenu> +menu to restore it.</para> + +</sect2> + +<sect2 id="conversion-field"> +<title>Conversion field</title> + +<para>The conversion field displays the values of various data types at the +selected byte. For 8 bit types, it displays the value of the byte under the +cursor; for larger types, it displays the value starting at that byte. The +rightmost column displays various encodings of the current byte. Options in the +conversion field are:</para> + +<variablelist> +<varlistentry> +<term><guilabel>Show little endian decoding</guilabel></term> +<listitem><para>When checked, causes multibyte types to be calculated using the +little-endian method used by x86 and Alpha processors. In this scheme, the first +byte represents the least significant part of the value. (0a 4e = 0x4e0a = +19978) When unchecked, causes multibyte types to be calculated using the +big-endian method used by PowerPC and Sparc processors. (0a 4e = 0x0a4e = +2638)</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Show unsigned as hexadecimal</guilabel></term> +<listitem><para>When checked, causes unsigned types to be displayed in +hexadecimal, rather than decimal format.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Stream length</guilabel></term> +<listitem><para>Determines the number of bits used to calculate the values in +the fields above it.</para></listitem> +</varlistentry> +</variablelist> + +</sect2> + +<sect2 id="status-bar"> +<title>Status Bar</title> + +<para>The status bar displays the following information:</para> + +<variablelist> +<varlistentry> +<term>Encoding/Selection</term> <!-- fix this --> +<listitem><para>When there is +no selection, this field shows the encoding option used. (See <link +linkend="view-encoding"><menuchoice> <guimenu>View</guimenu> +<guimenuitem>Document Encoding</guimenuitem> </menuchoice></link> for more +information on encoding.) The start point and the length of the selection are +shown.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>File Modified</term> +<listitem><para>A <computeroutput>!</computeroutput> in this box indicates the +current file was modified.</para></listitem> +</varlistentry> + +<varlistentry> +<term>Insert/Overwrite</term> +<listitem><para>Indicates whether values entered at the keyboard are +inserted at the cursor point (<guilabel>INS</guilabel>) or overwrite the +existing data starting at the cursor(<guilabel>OVR</guilabel>). Use the +<keycap>Insert</keycap> key to toggle between the two modes.</para></listitem> +</varlistentry> + +<varlistentry> +<term>Size</term> +<listitem><para>Displays the total size of the current +document.</para></listitem> +</varlistentry> + +<varlistentry> +<term>Offset</term> +<listitem><para>Indicates the position of the cursor within the +document.</para></listitem> +</varlistentry> + +<varlistentry> +<term>Display mode</term> +<listitem><para>Indicates whether data editor window is displaying values in +hexadecimal, octal, binary, decimal or text mode. Switch between modes with +the View menu.</para></listitem> +</varlistentry> + +<varlistentry> +<term>Write Protection</term> +<listitem><para>Indicates whether the document can be edited +(<guilabel>RW</guilabel>) or is being viewed read-only +(<guilabel>R</guilabel>). Switch between modes with the button on the far-right +of the toolbar or the <guimenuitem>Permissions</guimenuitem> command in the +<guimenu>File</guimenu> menu.</para></listitem> +</varlistentry> +</variablelist> + +</sect2> + +</sect1> + +</chapter> + +<chapter id="credits"> +<title>Credits and License</title> + +<para> +&khexedit; +</para> + +<para>Program copyright 1999-2000 Espen Sand +<email>espensa@online.no</email></para> + +<para>Contributors:</para> + +<itemizedlist> +<listitem><para>Leon Lessing <email>leon@irlabs.com</email></para></listitem> +<listitem><para>Craig Graham +<email>c_graham@hinge.mistral.co.uk</email></para></listitem> +<listitem><para>Dima Rogozin +<email>dima@mercury.co.il</email></para></listitem> +<listitem><para>Edward Livingstone-Blade +<email>sbcs@bigfoot.com</email></para></listitem> +</itemizedlist> + +<para>Documentation copyright 2000 Jonathan Singer +<email>jsinger@leeta.net</email></para> +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + +&underFDL; +&underGPL; + +</chapter> + + +<appendix id="installation"> +<title>Compilation and Installation</title> + +&install.intro.documentation; +&install.compile.documentation; + +</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 +--> diff --git a/doc/khexedit/khexedit1.png b/doc/khexedit/khexedit1.png Binary files differnew file mode 100644 index 0000000..9a61bdc --- /dev/null +++ b/doc/khexedit/khexedit1.png diff --git a/doc/kinfocenter/Makefile.am b/doc/kinfocenter/Makefile.am new file mode 100644 index 0000000..251280f --- /dev/null +++ b/doc/kinfocenter/Makefile.am @@ -0,0 +1,6 @@ + +SUBDIRS = $(AUTODIRS) + +KDE_LANG= en +KDE_DOCS = AUTO + diff --git a/doc/kinfocenter/blockdevices/Makefile.am b/doc/kinfocenter/blockdevices/Makefile.am new file mode 100644 index 0000000..36550bf --- /dev/null +++ b/doc/kinfocenter/blockdevices/Makefile.am @@ -0,0 +1,3 @@ + +KDE_LANG= en +KDE_DOCS = kinfocenter/blockdevices diff --git a/doc/kinfocenter/blockdevices/index.docbook b/doc/kinfocenter/blockdevices/index.docbook new file mode 100644 index 0000000..e6c44db --- /dev/null +++ b/doc/kinfocenter/blockdevices/index.docbook @@ -0,0 +1,89 @@ +<?xml version="1.0" ?> +<!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" +"dtd/kdex.dtd" [ +<!ENTITY % addindex "IGNORE"> +<!ENTITY % English "INCLUDE" > <!-- change language only here --> +]> + +<article lang="&language;"> +<articleinfo> + +<authorgroup> +<author> +<firstname>Mike</firstname> +<surname>McBride</surname> +</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<date>2002-02-12</date> +<releaseinfo>3.00.00</releaseinfo> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KControl</keyword> +<keyword>Block Devices</keyword> +<keyword>Disk space</keyword> +</keywordset> +</articleinfo> + +<sect1> +<title>Block Devices</title> + +<para> +The module window displays the available file devices and some +information about each device. It also allows you to control mount +points, and mount/unmount devices. +</para> + +<para> +Normally, the following pieces of information are shown in this tab: +</para> + +<itemizedlist> +<listitem><para>an icon depicting the type of storage</para></listitem> +<listitem><para>file format</para></listitem> +<listitem><para>total size</para></listitem> +<listitem><para>mount point</para></listitem> +<listitem><para>free disk space</para></listitem> +<listitem><para>the percentage of space used as a number and as a +graph.</para></listitem> +</itemizedlist> + +<para> +<mousebutton>Left</mousebutton> clicking on the header of a particular +column sorts the devices according to that variable. A second +<mousebutton>left</mousebutton> click sorts in the opposite order. +</para> + +<para> +<mousebutton>Right</mousebutton> clicking on a row pops up a menu. If +that device is not currently mounted, the <guimenuitem>Mount +device</guimenuitem> option is available. If the device is mounted, it +can be unmounted by choosing <guimenuitem>Unmount +device</guimenuitem>. Selecting <guimenuitem>Open +filemanager</guimenuitem> opens a new window with a graphical view of +the files on that device. +</para> + +<para> +The appropriate mount and unmount commands, and how the file manager is +opened from the context menu, can be configured from the &kdiskfree; +application. +</para> + +<sect2> +<title>Section Author</title> + +<para>This section is modified from the <application>kdf</application> +documentation which was authored by Jonathan Singer +<email>jsinger@leeta.net</email></para> + +<para>Modified for KDE 2.0 by Mike McBride +<email>mpmcbride7@yahoo.com</email></para> +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + +</sect2> +</sect1> +</article> + diff --git a/doc/kjots/Makefile.am b/doc/kjots/Makefile.am new file mode 100644 index 0000000..085981d --- /dev/null +++ b/doc/kjots/Makefile.am @@ -0,0 +1,4 @@ + +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/kjots/index.docbook b/doc/kjots/index.docbook new file mode 100644 index 0000000..78e5620 --- /dev/null +++ b/doc/kjots/index.docbook @@ -0,0 +1,552 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!-- nothing below must be removed --> + <!ENTITY kappname "&kjots;"> + <!ENTITY package "kdeutils"> + <!ENTITY % addindex "IGNORE"> + <!ENTITY % English "INCLUDE"> +]> +<book lang="&language;"> + +<bookinfo> +<title>The &kjots; Handbook</title> + +<authorgroup> +<author> +<firstname>Matt</firstname> +<surname>Johnston</surname> +<affiliation> +<address><email>matt.kde@caifex.org</email></address> +</affiliation> +</author> + +<othercredit role="developer"> +<firstname>Christoph</firstname> +<surname>Neerfield</surname> +<affiliation> +<address><email>Christoph.Neerfield@home.ivm.de</email></address> +</affiliation> +<contrib>Developer</contrib> +</othercredit> + +<othercredit role="reviewer"> +<firstname>Lauri</firstname> +<surname>Watts</surname> +<affiliation> +<address><email>lauri@kde.org</email></address> +</affiliation> +<contrib>Reviewer</contrib> +</othercredit> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<copyright> +<year>2000</year> +<holder>Matt Johnston</holder> +</copyright> + +<legalnotice>&FDLNotice;</legalnotice> + +<date>2004-10-17</date> +<releaseinfo>0.05.00</releaseinfo> + +<abstract><para>This handbook describes how to use &kjots; 0.5, a small +program which is handy for keeping miscellaneous +notes.</para></abstract> + +<keywordset> +<keyword>KDE</keyword> +<keyword>KJots</keyword> +<keyword>kdeutils</keyword> +<keyword>notes</keyword> +<keyword>organizer</keyword> +</keywordset> + +</bookinfo> + +<chapter id="introduction"> +<title>Introduction</title> + +<para>&kjots; is a small program that helps you to write down some short +notes and organizes them for you.</para> + +</chapter> + +<chapter id="using-kjots"> +<title>Using &kjots;</title> + +<para>&kjots; has two basic items used to organize your notes - +<quote>Books</quote> and <quote>Pages</quote>.</para> + +<para>You can create a number of books in &kjots;, and each book can +contain a number of pages, where you actually type your notes. Each book +should be given a name (so you can find what you are looking for), as +should each page. Although you aren't forced to give a page a name, it +is sensible to do so.</para> + +<sect1 id="kjots-books"> +<title>Using Books</title> + +<para>To create a new book, use <keycombo action="simul">&Ctrl;&Shift; +<keycap>N</keycap></keycombo> or the menu entry +<menuchoice><guimenu>File</guimenu><guimenuitem>New +Book</guimenuitem></menuchoice>, and you will be prompted to enter a +name for the new book.</para> + +<para>The name of the new book should now appear in the left part of +the window. If you want the book to be in your +<quote>Bookmarks</quote>, use <keycombo action="simul">&Ctrl; +<keycap>B</keycap></keycombo> or the menu entry <menuchoice> +<guimenu>Bookmarks</guimenu><guimenuitem>Add Bookmark</guimenuitem> +</menuchoice>. You can even organize your bookmarks in separate folders +just as you probably do in &konqueror;.</para> + +<tip><para>If you want to have your books in a different order, you can +simply drag and drop the book to the place where you want it to be. +</para></tip> + +<para>Maybe you have noticed that there is no <quote>Save</quote> anywhere. +This is not an error, &kjots; saves your books and pages automatically, +so you will never lose that small note you write when you are on the phone +and need to write down something in a hurry.</para> + +<para>You can also export an entire book as a text file or as a html file, +using <menuchoice><guimenu>File</guimenu> <guimenuitem>Export book... +</guimenuitem></menuchoice>. You will be then prompted to enter a +location for the file to be saved. The format of an example saved book +is shown below:</para> + +<screen>############ +# First page +############ +Remember to go to the shops! + +############# +# Useful code +############# +10 PRINT "HELLO WORLD" +20 GOTO 10 + +################ +# The third page +################ +This is the third page and is an example for KJots.</screen> + +<para>Remember that the dialog where you are prompted for a filename is +a standard &kde; dialog. That means it is just as easy to store the file +on your local hard disk as it is to save it on a web server, ftp server +or USB memory stick. So you can export as html and save it on a webserver, +this way you always have your notes available to you.</para> +</sect1> + +<sect1 id="kjots-pages"> +<title>Using Pages</title> + +<para>Pages are where you actually write whatever you are going to +write. Once you have created a book, you can type text in the main text +box.</para> + +<para>To create additional pages, you can use <keycombo action="simul">&Ctrl; +<keycap>N</keycap></keycombo> or the menu entry +<menuchoice><guimenu>File</guimenu><guimenuitem>New Page</guimenuitem> +</menuchoice>, which will create a new page. Similarly, the current page +can be removed using <menuchoice><guimenu>File</guimenu> +<guimenuitem>Delete Page</guimenuitem></menuchoice>.</para> + +<tip><para>If you need to insert the current date and time while you are +writing a note, you can use <keycombo action="simul">&Ctrl;<keycap>I +</keycap></keycombo>.</para></tip> + +<para>So that you can get to the page you want to see, pages can (and +should) be given a name. This can be done in the way you are used to: +select the page you want to rename, wait a second and click it once more. +You are then able to rename the page. Of course there is also a keyboard +shortcut, you can use that at any time while writing a note. The shortcut +is: <keycombo action="simul">&Ctrl;<keycap>M</keycap></keycombo>.</para> + +<para>An other way of renaming the page is by selecting a part of your note +and then press <keycombo action="simul">&Ctrl;<keycap>T</keycap></keycombo>, +the selected text will instantly become the title of the page.</para> + +<tip><para>If you want fast access to a particular page, you +can assign a keyboard shortcut to that page. Go to <menuchoice> +<guimenu>Settings</guimenu><guimenuitem>Configure Shortcuts... +</guimenuitem></menuchoice>.</para></tip> +</sect1> +</chapter> + +<chapter id="commands"> +<title>Command Reference</title> + +<sect1 id="menu-file"> +<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 Page...</guimenuitem> +</menuchoice></term> +<listitem><para><action>Creates</action> a new Page.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;&Shift;<keycap>N</keycap></keycombo> +</shortcut> +<guimenu>File</guimenu> +<guimenuitem>New Book...</guimenuitem> +</menuchoice></term> +<listitem><para><action>Creates</action> a new Book.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>File</guimenu> +<guimenuitem>Export Page</guimenuitem> +</menuchoice></term> +<listitem><para><action>Saves</action> the current page to a text file +or a html file.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>File</guimenu> +<guimenuitem>Export Book</guimenuitem> +</menuchoice></term> +<listitem><para><action>Saves</action> the current book to a text file +or a html file.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>File</guimenu> +<guimenuitem>Delete Page</guimenuitem> +</menuchoice></term> +<listitem><para><action>Deletes</action> the current page.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>File</guimenu> +<guimenuitem>Delete Book</guimenuitem> +</menuchoice></term> +<listitem><para><action>Deletes</action> the current book.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>P</keycap></keycombo> +</shortcut> +<guimenu>File</guimenu> +<guimenuitem>Print</guimenuitem> +</menuchoice></term> +<listitem><para><action>Prints</action> the current book or page.</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</action> &kjots;.</para></listitem> +</varlistentry> +</variablelist> +</sect1> + +<sect1 id="menu-edit"> +<title>The <guimenu>Edit</guimenu> Menu</title> +<variablelist> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>X</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Cut</guimenuitem> +</menuchoice></term> +<listitem><para><action>Cuts</action> the currently selected +text in the main textbox and places it on the clipboard.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>C</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Copy</guimenuitem> +</menuchoice></term> +<listitem><para><action>Copies</action> the currently selected +text in the main textbox and places it on the clipboard.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>V</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Paste</guimenuitem> +</menuchoice></term> +<listitem><para><action>Pastes</action> text from the clipboard +to the main textbox.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>T</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Paste as Page Title</guimenuitem> +</menuchoice></term> +<listitem><para><action>Renames</action> the page to the text on the +clipboard.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>F</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Find...</guimenuitem> +</menuchoice></term> +<listitem><para><action>Searches</action> for text in the main +textbox. Note that this only searches the current page. +</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo><keycap>F3</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Find Next</guimenuitem> +</menuchoice></term> +<listitem><para><action>Searches</action> for the next occurrence +of the search text (specified with Find).</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>R</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Replace...</guimenuitem> +</menuchoice></term> +<listitem><para><action>Replaces</action> one bit of text with another, +only on the current page. +</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>M</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Rename...</guimenuitem> +</menuchoice></term> +<listitem><para>Gives the possibility to <action>rename</action> the +current page.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>I</keycap></keycombo> +</shortcut> +<guimenu>Edit</guimenu> +<guimenuitem>Insert Date</guimenuitem> +</menuchoice></term> +<listitem><para><action>Inserts</action> the date and time in the +current page.</para></listitem> +</varlistentry> +</variablelist> +</sect1> + +<sect1 id="menu-bookmarks"> +<title>The <guimenu>Bookmarks</guimenu> Menu</title> +<variablelist> + +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo action="simul">&Ctrl;<keycap>B</keycap></keycombo> +</shortcut> +<guimenu>Bookmarks</guimenu> +<guimenuitem>Add bookmark</guimenuitem> +</menuchoice></term> +<listitem><para><action>Adds</action> the current page to the list of +bookmarks. See <link linkend="kjots-books">Using Books</link>. +</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Bookmarks</guimenu> +<guimenuitem>Edit bookmarks</guimenuitem> +</menuchoice></term> +<listitem><para><action>Edits</action> the bookmarks. Here you can +search bookmarks, make comments, organize them in different folders and +much more. +</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Bookmarks</guimenu> +<guimenuitem>New Bookmark Folder</guimenuitem> +</menuchoice></term> +<listitem><para><action>Makes</action> a new folder where you can store +your bookmarks.</para></listitem> +</varlistentry> + +</variablelist> +</sect1> + +<sect1 id="menu-settings"> +<title>The <guimenu>Settings</guimenu> Menu</title> +<variablelist> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Hide/Show Toolbar</guimenuitem> +</menuchoice></term> +<listitem><para><action>Toggles</action> display of the toolbar below the +menu bar.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Shortcuts...</guimenuitem> +</menuchoice></term> +<listitem><para><action>Choose</action> shortcut keys for various +menu items.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure Toolbars...</guimenuitem> +</menuchoice></term> +<listitem><para><action>Choose</action> which items are present in the +toolbar.</para></listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice> +<guimenu>Settings</guimenu> +<guimenuitem>Configure KJots...</guimenuitem> +</menuchoice></term> +<listitem><para><action>Configure</action> options for &kjots;, including +the font to use and the settings for autosaving. +</para></listitem> +</varlistentry> + +</variablelist> +</sect1> + +<sect1 id="menu-help"> +<title>The <guimenu>Help</guimenu> Menu</title> + +&help.menu.documentation; + +</sect1> + +</chapter> + +<chapter id="credits"> + +<title>Credits and License</title> + +<para> +&kjots; +</para> +<para> +Program copyright 1997 Christoph Neerfeld <email>Christoph.Neerfeld@home.ivm.de</email> +</para> +<para> +Based on the <command>jots</command> program included in the <application>tkgoodstuff</application> package. +The <application>tkgoodstuff</application> package is +copyright 1995-96 Mark Crimmins <email>markcrim@umich.edu</email> +</para> + +<para> +Documentation copyright 2000 Matt Johnston <email>matt.kde@caifex.org</email> +</para> +<para> +Some parts taken from documentation copyright 1998 Christoph Neerfeld +<email>Christoph.Neerfeld@home.ivm.de</email> +</para> +&underFDL; <!-- FDL: do not remove --> + +&underGPL; <!-- GPL License --> + +</chapter> + +<appendix id="installation"> +<title>Installation</title> + +<sect1 id="getting-kjots"> +<title>How to obtain &kjots;</title> + +&install.intro.documentation; + +</sect1> + +<sect1 id="requirements"> +<title>Requirements</title> + +<para>In order to successfully use &kjots;, you need &kde; 2.x. There are +no other requirements.</para> + +</sect1> + +<sect1 id="compilation"> +<title>Compilation and Installation</title> + +&install.compile.documentation; + +</sect1> + +<sect1 id="configuration"> +<title>Configuration</title> + +<para>&kjots; is a nice small program, and you don't have do do anything +before running it.</para> + +</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 +--> diff --git a/doc/ksim/Makefile.am b/doc/ksim/Makefile.am new file mode 100644 index 0000000..085981d --- /dev/null +++ b/doc/ksim/Makefile.am @@ -0,0 +1,4 @@ + +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/ksim/index.docbook b/doc/ksim/index.docbook new file mode 100644 index 0000000..02ecfee --- /dev/null +++ b/doc/ksim/index.docbook @@ -0,0 +1,66 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY kappname "&ksim;"> + <!ENTITY package "kdeutils"> + <!ENTITY % English "INCLUDE"> + <!ENTITY % addindex "IGNORE"> +]> + +<book lang="&language;"> + +<bookinfo> +<title>The &ksim; Handbook</title> + +<authorgroup> +<author> +<firstname></firstname> +<othername></othername> +<surname></surname> +<affiliation> +<address><email></email></address> +</affiliation> +</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<legalnotice>&FDLNotice;</legalnotice> + +<date>2001-01-20</date> +<releaseinfo>0.00.00</releaseinfo> + +<abstract> +<para> +&ksim; is part of the kdeutils package. +</para> +</abstract> + + +<keywordset> +<keyword>KDE</keyword> +<keyword>kdeutils</keyword> +<keyword>ksim</keyword> +</keywordset> + +</bookinfo> + +<chapter id="introduction"> +<title>Introduction</title> +<para>The documentation for &kappname; was not finished when &kde; was installed on this computer.</para> +<para>If you need help, please check <ulink url="http://www.kde.org">The KDE Website</ulink> for updates, or by submitting your question to <ulink url="mailto:kde@kde.org">The &kde; User Mailing list</ulink>.</para> +<para><emphasis>The &kde; Team</emphasis></para> + +&underFDL; +&underGPL; + +</chapter> + +&documentation.index; +</book> +<!-- +Local Variables: +mode: sgml +sgml-minimize-attributes: nil +sgml-general-insert-case: lower +End: +--> + diff --git a/doc/ktimer/Makefile.am b/doc/ktimer/Makefile.am new file mode 100644 index 0000000..085981d --- /dev/null +++ b/doc/ktimer/Makefile.am @@ -0,0 +1,4 @@ + +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/ktimer/index.docbook b/doc/ktimer/index.docbook new file mode 100644 index 0000000..5474ea9 --- /dev/null +++ b/doc/ktimer/index.docbook @@ -0,0 +1,66 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY kappname "&ktimer;"> + <!ENTITY package "kdeutils"> + <!ENTITY % English "INCLUDE"> + <!ENTITY % addindex "IGNORE"> +]> + +<book lang="&language;"> + +<bookinfo> +<title>The &ktimer; Handbook</title> + +<authorgroup> +<author> +<firstname></firstname> +<othername></othername> +<surname></surname> +<affiliation> +<address><email></email></address> +</affiliation> +</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<legalnotice>&FDLNotice;</legalnotice> + +<date>2001-01-20</date> +<releaseinfo>0.00.00</releaseinfo> + +<abstract> +<para> +&ktimer; is part of the kdeutils package. +</para> +</abstract> + + +<keywordset> +<keyword>KDE</keyword> +<keyword>kdeutils</keyword> +<keyword>ktimer</keyword> +</keywordset> + +</bookinfo> + +<chapter id="introduction"> +<title>Introduction</title> +<para>The documentation for &kappname; was not finished when &kde; was installed on this computer.</para> +<para>If you need help, please check <ulink url="http://www.kde.org">The KDE Website</ulink> for updates, or by submitting your question to <ulink url="mailto:kde@kde.org">The &kde; User Mailing list</ulink>.</para> +<para><emphasis>The &kde; Team</emphasis></para> + +&underFDL; +&underGPL; + +</chapter> + +&documentation.index; +</book> +<!-- +Local Variables: +mode: sgml +sgml-minimize-attributes: nil +sgml-general-insert-case: lower +End: +--> + diff --git a/doc/kwallet/Makefile.am b/doc/kwallet/Makefile.am new file mode 100644 index 0000000..085981d --- /dev/null +++ b/doc/kwallet/Makefile.am @@ -0,0 +1,4 @@ + +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/kwallet/cr22-action-wallet_closed.png b/doc/kwallet/cr22-action-wallet_closed.png Binary files differnew file mode 100644 index 0000000..57558ac --- /dev/null +++ b/doc/kwallet/cr22-action-wallet_closed.png diff --git a/doc/kwallet/cr22-action-wallet_open.png b/doc/kwallet/cr22-action-wallet_open.png Binary files differnew file mode 100644 index 0000000..55a447f --- /dev/null +++ b/doc/kwallet/cr22-action-wallet_open.png diff --git a/doc/kwallet/edit1.png b/doc/kwallet/edit1.png Binary files differnew file mode 100644 index 0000000..1d0fe7c --- /dev/null +++ b/doc/kwallet/edit1.png diff --git a/doc/kwallet/edit2.png b/doc/kwallet/edit2.png Binary files differnew file mode 100644 index 0000000..05b6dd8 --- /dev/null +++ b/doc/kwallet/edit2.png diff --git a/doc/kwallet/edit3.png b/doc/kwallet/edit3.png Binary files differnew file mode 100644 index 0000000..9292870 --- /dev/null +++ b/doc/kwallet/edit3.png diff --git a/doc/kwallet/index.docbook b/doc/kwallet/index.docbook new file mode 100644 index 0000000..34b779e --- /dev/null +++ b/doc/kwallet/index.docbook @@ -0,0 +1,396 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ + <!ENTITY kwallet "<application>KWallet</application>"> + <!ENTITY kwalletmanager "<application>KWallet Manager</application>"> + <!ENTITY package "kdeutils"> + <!ENTITY kappname "&kwallet;"> + <!ENTITY % addindex "IGNORE"> + <!ENTITY % English "INCLUDE"> +]> + +<book lang="&language;"> +<bookinfo> +<title>The &kwallet; Handbook</title> + +<authorgroup> +<author> +&George.Staikos; &George.Staikos.mail; +</author> +<author> +&Lauri.Watts; &Lauri.Watts.mail; +</author> +<othercredit role="developer"> +<firstname>George</firstname><surname>Staikos</surname> +<affiliation><address><email>staikos@kde.org</email></address></affiliation> +<contrib>Developer</contrib> +</othercredit> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<legalnotice>&FDLNotice;</legalnotice> + +<date>2005-06-15</date> +<releaseinfo>1.0</releaseinfo> + +<abstract> +<para> +The wallet subsytem provides a convenient and secure way to manage all your +passwords.</para> + +</abstract> + + +<keywordset> +<keyword>KDE</keyword> +<keyword>Kwallet</keyword> +<keyword>passwords</keyword> +<keyword>forms</keyword> +</keywordset> + +</bookinfo> + +<chapter id="introduction"> +<title>Introduction</title> + +<para>Computer users have a very large amount of data to manage, some of +which is sensitive. In particular, you will typically have many passwords +to manage. Remembering them is difficult, writing them down on paper or in +a text file is insecure, and using tools such at PGP is tedious and +inconvenient.</para> + +<para>&kwallet; saves this sensitive data for you in a strongly encrypted +file, accessible by all applications, and protected with a master +password that you define.</para> + +<tip> +<para>&kwallet; supports multiple wallets, so +for the most secure operation, you should use one wallet for local +passwords, and another for network passwords and form data. You can +configure this behavior in the &kwallet; &kcontrolcenter; module, however +the default setting is to store everything in one wallet.</para> +</tip> + +<para>A wallet is by default closed, which means that you must supply +a password to open it. Once the wallet is opened, the contents can +be accessed.</para> + +</chapter> + +<chapter id="kwalletmanager"> +<title>&kwalletmanager;</title> + +<para>&kwalletmanager; serves a number of functions. Firstly it allows you to see if +any wallets are open, which wallets those are, and which applications are +using each wallet. You can disconnect an application's access to a wallet +from within the &kwalletmanager;.</para> + +<para>You may also manage the wallets installed on the system, creating and +deleting wallets and manipulating their contents (changing keys, ...).</para> + +<para>Normally the &kwalletmanager; application is launched when +&kde; starts and remains in iconic form in the system tray. Alternatively, +when a wallet is opened, the &kwalletmanager; application will be +launched. A system tray icon indicates that a wallet is open: + <mediaobject> + <imageobject> + <imagedata fileref="cr22-action-wallet_open.png"/> + </imageobject> + </mediaobject> + +When all +wallets are closed, the icon will reflect this by showing a closed +wallet: +<mediaobject> + <imageobject> + <imagedata fileref="cr22-action-wallet_closed.png"/> + </imageobject> + </mediaobject> + +</para> + +<para>Click once on the system tray wallet icon to display the &kwalletmanager; +window showing all available wallets as icons which reflect their +current status, either open or closed.</para> +<para> +<mediaobject> + <imageobject> + <imagedata fileref="kwalletmanager.png"/> + </imageobject> + </mediaobject></para> + + +<sect1 id="kwalletmanager-context-menu"> +<title>The &kwalletmanager; Context Menu</title> + +<para><mousebutton>Right</mousebutton> clicking on a wallet in the +&kwalletmanager; window offers +the following functions:</para> + +<variablelist> + +<varlistentry> +<term><guimenuitem>New Wallet...</guimenuitem></term> +<listitem> +<para>Create a new wallet. A dialog box will ask you +for the name of the new wallet that you want to create.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><shortcut>&Enter;</shortcut> +<guisubmenu>Open...</guisubmenu></menuchoice></term> +<listitem> +<para>Open the wallet. Opening the wallet causes the contents +of the wallet to be displayed in a new window where you can +add, delete, or modify the contents of the wallet. You may also +double click the wallet icon to cause it to open. If the wallet +is not already open, you will be requested to enter the password. +See below for details of using the wallet window. +</para> +<para> +<mediaobject> + <imageobject> + <imagedata fileref="edit1.png"/> + </imageobject> + </mediaobject></para> + +</listitem> +</varlistentry> + +<varlistentry> +<term><guimenuitem>Change Password</guimenuitem></term> +<listitem> +<para>Change the master password for the wallet.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guisubmenu>Disconnect</guisubmenu></term> +<listitem><para>Disconnect an application from the wallet. Currently +connected applications will appear in a submenu.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guimenuitem>Close</guimenuitem></term> +<listitem><para>Force the wallet to be closed.</para></listitem> +</varlistentry> + +<varlistentry> +<term><guimenuitem>Delete</guimenuitem></term> +<listitem> +<para>Delete the wallet</para> +</listitem> +</varlistentry> +</variablelist> +</sect1> + +<sect1 id="kwalletmanager-wallet-window"> +<title>The Wallet Window</title> + +<para>Double clicking on a wallet in the &kwalletmanager; window will open a new +window displaying that wallet's contents. A wallet may contain any number +of folders, which allow storing of password information. By default a wallet +will contain folders named Form Data and Passwords. +</para> + +<para>The window has four panes:</para> +<para> +<mediaobject> + <imageobject> + <imagedata fileref="edit1.png"/> + </imageobject> + </mediaobject></para> + + +<itemizedlist> +<listitem><para>A summary of the contents of the current +folder</para></listitem> +<listitem><para>The folders contained in the wallet</para></listitem> +<listitem><para>The entries in the currently selected +folder</para></listitem> +<listitem><para>The contents of the selected folder entry</para></listitem> +</itemizedlist> + +<para>Folders may be added or deleted, and selecting a folder will update +the folder entry list and the summary display. Selecting a folder entry +will update the entry contents pane, and allow you to edit that +entry.</para> +<para> +<mediaobject> + <imageobject> + <imagedata fileref="edit2.png"/> + </imageobject> + </mediaobject></para> + + +<para>Entries may also be created or deleted via the context menu for the +folder contents.</para> + +<para>All folders and entries may be dragged and dropped into other wallets +or folders respectively. This allows a user to easily package up a new +wallet for transfer to another environment. For instance, a new wallet +could be created and copied onto a removable flash memory device. Important +passwords could be transferred there, so you have them available in other +locations.</para> + +</sect1> + +</chapter> + +<chapter id="kwallet-kcontrol-module"> +<title>Configuring &kwallet;</title> + +<sect1 id="wallet-preferences"> +<title><guilabel>Wallet Preferences</guilabel></title> + +<para>&kwallet; contains a small configuration panel with several options +that allow you to tune &kwallet; to your personal preferences. The +default settings for &kwallet; are sufficient for most users.</para> + +<para>Check the box to enable or disable the &kde; wallet subsystem +entirely. If this box is unchecked, then &kwallet; is entirely disabled and +none of the other options here have any effect, nor will &kwallet; record +any information, or offer to fill in forms for you.</para> + +<variablelist> +<title><guilabel>Close Wallet</guilabel></title> +<varlistentry> +<term><guilabel>Close when unused for:</guilabel></term> +<listitem> +<para>Close the current wallet after a period of inactivity. If you check this +option, set the period in the box, default is 10 minutes. When a wallet is +closed, the password is needed to access it again.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Close when screen saver starts</guilabel></term> +<listitem> +<para>Close the wallet as soon as the screensaver starts. When a wallet is +closed, the password is needed to access it again.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Close when last application stops using it</guilabel></term> +<listitem> +<para>Close the wallet as soon as applications that use it have stopped. Note +that your wallets will only be closed when all the applications that use it have +stopped. When a wallet is closed, the password is needed to access it +again.</para> +</listitem> +</varlistentry> +</variablelist> + +<variablelist> +<title><guilabel>Automatic Wallet Selection</guilabel></title> +<varlistentry> +<term><guilabel>Select wallet to use as default:</guilabel></term> +<listitem> +<para>Select which wallet you want to use as default wallet.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Different wallet for local passwords:</guilabel></term> +<listitem> +<para>If checked, choose a different wallet for local passwords.</para> +</listitem> +</varlistentry> +</variablelist> + +<variablelist> +<title><guilabel>Wallet Manager</guilabel></title> +<varlistentry> +<term><guilabel>Show manager in system tray</guilabel></term> +<listitem> +<para>Enable the wallet manager to have its icon in the system tray.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Hide System tray icon when last wallet +closes</guilabel></term> +<listitem> +<para>When there is no wallet in use anymore, remove the wallet icon from the +system tray.</para> +</listitem> +</varlistentry> +</variablelist> + +<para>Finally, there is a button labelled <guibutton>Launch Wallet +Manager</guibutton>, which does precisely that.</para> +</sect1> + +<sect1 id="wallet-access-control"> +<title><guilabel>Access Control</guilabel></title> + +<para>There is only one option on this page:</para> + +<variablelist> +<varlistentry> +<term><guilabel>Prompt when an application accesses an open wallet</guilabel></term> +<listitem> +<para>Signal you when an application gains access to an open wallet.</para> +</listitem> +</varlistentry> +</variablelist> + +<para>Next there is a tree style view of the access controls for your wallets.</para> + +<para>&LMB; click on the <guiicon>+</guiicon> symbol beside a wallet name to +expand the tree. You will see the name of each application that has asked +for access to the wallet, and the policy you set for it. You cannot edit +policies here, or add them, but it is possible to delete an entry by &RMB; +clicking on it and choosing <guimenuitem>Delete</guimenuitem> From the +context menu that appears, or by simply selecting it and pressing the +<keycap>Delete</keycap> key.</para> + +</sect1> + +</chapter> + +<chapter id="advanced-features"> +<title>Advanced Features</title> + +<para>Wallets can be dragged from the &kwalletmanager; window. This allows +you to drag the wallet to a file browser window, where you can choose to +copy, move, or link the wallet, as desired.</para> + +<para>You might use this to save a wallet to portable media, such as a +USB keychain, so that you can take your passwords with you to work or +on a vacation, and still have easy access to important sites.</para> + +<para>Future versions will have built-in functions for easy export or +copying of data to portable devices.</para> + +</chapter> + +<chapter id="credits-and-licenses"> +<title>Credits and Licenses</title> + +<para>&kwallet; © 2003 &George.Staikos;</para> +<para>Documentation © &Lauri.Watts; and &George.Staikos;</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: + +// vim:ts=2:sw=2:tw=78:noet +--> diff --git a/doc/kwallet/kwalletmanager.png b/doc/kwallet/kwalletmanager.png Binary files differnew file mode 100644 index 0000000..67c7220 --- /dev/null +++ b/doc/kwallet/kwalletmanager.png diff --git a/doc/kwallet/password1.png b/doc/kwallet/password1.png Binary files differnew file mode 100644 index 0000000..d5cb22a --- /dev/null +++ b/doc/kwallet/password1.png diff --git a/doc/kwallet/password2.png b/doc/kwallet/password2.png Binary files differnew file mode 100644 index 0000000..c116e93 --- /dev/null +++ b/doc/kwallet/password2.png diff --git a/doc/superkaramba/Makefile.am b/doc/superkaramba/Makefile.am new file mode 100644 index 0000000..085981d --- /dev/null +++ b/doc/superkaramba/Makefile.am @@ -0,0 +1,4 @@ + +KDE_LANG = en +KDE_DOCS = AUTO + diff --git a/doc/superkaramba/index.docbook b/doc/superkaramba/index.docbook new file mode 100644 index 0000000..df175f0 --- /dev/null +++ b/doc/superkaramba/index.docbook @@ -0,0 +1,261 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" +"dtd/kdex.dtd" [ + <!ENTITY superkaramba "<application>SuperKaramba</application>"> + <!ENTITY kappname "&superkaramba;"> + <!ENTITY packagename "kdeutils"> + <!ENTITY % addindex "IGNORE"> + <!ENTITY % English "INCLUDE" > <!-- change language only here --> +]> +<book lang="&language;"> + +<bookinfo> +<title>The &superkaramba; Handbook</title> +<authorgroup> +<author> +<personname><firstname>Hans</firstname> +<surname>Karlsson</surname></personname> +<email>karlsson.h@home.se</email> +</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<copyright> +<year>2005</year> +<holder>Hans Karlsson</holder> +</copyright> + +<date>2005-08-04</date> +<releaseinfo>0.3.5</releaseinfo> +<legalnotice>&FDLNotice;</legalnotice> + +<abstract> +<para>&superkaramba; is a tool that allows you to easily create interactive +widgets on your &kde; desktop.</para> +</abstract> +<keywordset> +<keyword>KDE</keyword> +<keyword>desktop</keyword> +<keyword>karamba</keyword> +</keywordset> +</bookinfo> + +<!-- FIXME: Needs writing, but can't have empty elements in translateable --> +<!-- documents. Uncomment only when there is content --> +<!-- +<chapter id="introduction"> +<title>Quickstart</title> + +<para> </para> + +</chapter> + + +<chapter id="using-karamba"> +<title>Using &superkaramba;</title> +<para>How to use &superkaramba;</para> +</chapter> + +--> + +<chapter id="questionsanswersandtips"> +<title>Questions, Answers, and Tips</title> + +<qandaset id="faq"> +<title>Frequently asked questions</title> +<qandadiv> +<title>Installation</title> +<qandaentry> +<question> +<para>Where can I find &superkaramba; <acronym>RPM</acronym>'s?</para> +</question> +<answer> +<!-- FIXME: Now part of KDE, this should point users at their distribution --> +<!-- for the next release --> +<para>The SuperKaramba web site (http://netdragon.sourceforge.net) has a list of user-submitted RPMs for several distributions. Other user-subm +itted RPMs have been posted to kde-look.org and to the SuperKaramba Help +forum.</para> +</answer> +</qandaentry> +<qandaentry> +<question><para>When I try to compile, I get this error:</para> +<screen><computeroutput>Python.h: No such file or directory</computeroutput></screen> +</question> +<answer><para>You will need to install the <literal>python-devel</literal> +package. Once that package is installed you should run +<command>./configure</command> and <command>make</command> again.</para> +</answer> +</qandaentry> +<qandaentry> +<question><para>When I try to compile, I get this error:</para> +<screen><computeroutput>cannot find -lselinux</computeroutput></screen> +</question> +<answer> +<para>You will need to install the <literal>libselinux-devel</literal> +package. Once that package is installed you should run +<command>./configure</command> and <command>make</command> again.</para> +</answer> +</qandaentry> +<qandaentry> +<question> +<para>After running <command>./configure</command>, <command>make</command> +and <command>make install</command>, the &superkaramba; executable is not +where I expected it to be. When I try to run <command>superkaramba</command> +from the command line it says <computeroutput>command not +found</computeroutput>.</para> +</question> +<answer> +<para>In some distributions ./configure has a default prefix path that +differs to what you might expect. For example, in Mandrake the default +prefix is <filename class="directory">/usr/local/kde</filename> and the +executable is installed in <filename +class="directory">/usr/local/kde/bin</filename>.</para> +<para>There are a few things you can do to fix this.</para> +<para>You could run <command>./configure +<parameter>--prefix=/usr</parameter></command> to specify the prefix that +you prefer and then try <command>make</command> and <command>make +install</command> again. Or you could create a symbolic link in your +preferred directory that links to the executable. Or you could add the +install directory to your $<envar>PATH</envar>.</para> +</answer> +</qandaentry> +</qandadiv> + +<qandadiv> +<title>General</title> +<qandaentry> +<question> +<para>How do I get rid of the &kde; panel? Do I have to keep &kicker; +running?</para> +</question> +<answer><para>Many themes depend on &kicker; and will not work well without +it. If you don't want &kicker; to show on your desktop, you can set it to +auto-hide. Another solution is to change the auto-hide setting in a +<filename>~/.kde</filename> file. For more information see the wiki page about +<ulink +url="http://wiki.kdenews.org/tiki-print.php?page=Secret+Config+Settings">secret +configuration settings</ulink>.</para> +</answer> +</qandaentry> +<qandaentry> +<question> +<para>Can I run a system tray theme while the &kicker; system tray is +running?</para> +</question> +<answer><para>It's better not to. If you run a theme with a SysTray on it +while a regular kicker systray is running, the theme will +<quote>steal</quote> all the icons from the first systray. This is because +in &kde; and Gnome, the systray icons are really little windows and there is +only one copy of each running. If you want to run a system tray theme, you can +remove the system tray from &kicker;.</para> +</answer> +</qandaentry> +<qandaentry> +<question> +<para>How do I set up my themes to run automatically on startup?</para> +</question> +<answer> +<para>Turn on &kde; session support in the &kcontrolcenter;. When session +support is enabled, any theme that is left running when you logout will +automatically start on startup. For some themes you will also need to &RMB; +click and reload the theme at least once after running it so that the config +file will get written to your home directory.</para> +<para>Another solution is to create a desktop config file in the &kde; +autostart directory.</para> +<para>To create a desktop config file, open an editor and enter the +following:</para> +<screen><userinput>[Desktop Entry] +Exec=superkaramba {location of theme file}.theme +Name={theme name} +Type=Application +X-KDE-StartupNotify=false</userinput></screen> +<para>Then save it as +<filename><replaceable>themename</replaceable>.desktop</filename> into the +autostart directory at <filename +class="directory">$<envar>KDEHOME</envar>/Autostart/</filename>.</para> +</answer> +</qandaentry> +<qandaentry> +<question><para>Why is the <guimenuitem>Edit Script</guimenuitem> option +disabled when I &RMB; click on a theme?</para></question> +<answer><para>Some &superkaramba; themes don't include a +<application>Python</application> script. This is normal and those themes +will still work fine without one. However, if the theme does use a +<application>Python</application> script, &superkaramba; may have not been +able to load the script. This is usually due to +<application>Python</application> errors. Run the theme from the command line +to find out the specific error message.</para> +</answer> +</qandaentry> +<qandaentry> +<question> +<para>Why is the <guimenuitem>Configure Theme</guimenuitem> menu disabled +when I &RMB; click on a theme?</para> +</question> +<answer> +<para>The <guimenuitem>Configure Theme</guimenuitem> menu is only enabled if +the theme has added options to it. Some themes do not have any configuration +options or use a different configuration method.</para> +</answer> +</qandaentry> +</qandadiv> + +<qandadiv> +<title>Troubleshooting</title> +<qandaentry> +<question> +<para>My themes start up in different locations each time I start +&kde;.</para> +</question> +<answer> +<para>Close all &superkaramba; themes and then delete any session files in +<filename +class="directory">$<envar>KDEHOME</envar>/share/config/session/</filename> +that begin with &superkaramba;. Restart &kde; and start your themes again. Now +they will stay in the right place.</para> +</answer> +</qandaentry> +<qandaentry> +<question> +<para>The backgrounds of my themes are black instead of transparent.</para> +</question> +<answer><para>In &kde;, transparency only works when the desktop background +is a wallpaper image that is centered or scaled. If the background is a +plain color or a tiled image then &superkaramba; themes will not be +transparent. In Gnome, there is a known issue that themes will have a black +background even when a wallpaper is set. Unfortunately there is no current +solution. Your theme should work fine otherwise.</para> +</answer> +</qandaentry> +</qandadiv> +</qandaset> + +</chapter> + +<chapter> +<title>Credits and Licenses</title> + +<para>&superkaramba; is written by +<personname><firstname>Adam</firstname><surname>Geitgey</surname></personname> +<email>adam@rootnode.org</email> and +<personname><firstname>Hans</firstname><surname>Karlsson</surname></personname> <email>karlsson.h@home.se</email></para> + +<!-- FIXME: Add other contributors here, probably in an itemized list, look --> +<!-- at say, konqueror-credits for an example --> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + +&underFDL; +&underGPL; + +</chapter> + +</book> +<!-- +Local Variables: +mode: sgml +sgml-omittag: nil +sgml-shorttag: t +sgml-general-insert-case: lower +End: +--> |
