From 2bda8f7717adf28da4af0d34fb82f63d2868c31d Mon Sep 17 00:00:00 2001 From: toma Date: Wed, 25 Nov 2009 17:56:58 +0000 Subject: 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 --- doc/KRegExpEditor/Makefile.am | 5 + doc/KRegExpEditor/altn.png | Bin 0 -> 310 bytes doc/KRegExpEditor/altntool.png | Bin 0 -> 1282 bytes doc/KRegExpEditor/anychar.png | Bin 0 -> 616 bytes doc/KRegExpEditor/anychartool.png | Bin 0 -> 531 bytes doc/KRegExpEditor/begline.png | Bin 0 -> 244 bytes doc/KRegExpEditor/boundarytools.png | Bin 0 -> 861 bytes doc/KRegExpEditor/characters.png | Bin 0 -> 240 bytes doc/KRegExpEditor/charactertool.png | Bin 0 -> 983 bytes doc/KRegExpEditor/compound.png | Bin 0 -> 285 bytes doc/KRegExpEditor/compoundtool.png | Bin 0 -> 1432 bytes doc/KRegExpEditor/endline.png | Bin 0 -> 245 bytes doc/KRegExpEditor/index.docbook | 652 +++++++++++++++ doc/KRegExpEditor/linestartendtool.png | Bin 0 -> 817 bytes doc/KRegExpEditor/lookaheadtools.png | Bin 0 -> 774 bytes doc/KRegExpEditor/neglookahead.png | Bin 0 -> 297 bytes doc/KRegExpEditor/nonwordboundary.png | Bin 0 -> 225 bytes doc/KRegExpEditor/poslookahead.png | Bin 0 -> 297 bytes doc/KRegExpEditor/repeat.png | Bin 0 -> 632 bytes doc/KRegExpEditor/repeattool.png | Bin 0 -> 1160 bytes doc/KRegExpEditor/select.png | Bin 0 -> 742 bytes doc/KRegExpEditor/text.png | Bin 0 -> 338 bytes doc/KRegExpEditor/texttool.png | Bin 0 -> 396 bytes doc/KRegExpEditor/theEditor.png | Bin 0 -> 10004 bytes doc/KRegExpEditor/wordboundary.png | Bin 0 -> 210 bytes doc/Makefile.am | 5 + doc/ark/Makefile.am | 5 + doc/ark/index.docbook | 793 ++++++++++++++++++ doc/ark/man-ark.1.docbook | 174 ++++ doc/kcalc/Makefile.am | 4 + doc/kcalc/commands.docbook | 254 ++++++ doc/kcalc/index.docbook | 774 +++++++++++++++++ doc/kcalc/kcalc_on_Aix.txt | 123 +++ doc/kcalc/kcalc_on_OSF.txt | 62 ++ doc/kcharselect/Makefile.am | 4 + doc/kcharselect/index.docbook | 66 ++ doc/kcontrol/Makefile.am | 6 + doc/kcontrol/kcmlowbatcrit/Makefile.am | 2 + doc/kcontrol/kcmlowbatcrit/index.docbook | 47 ++ doc/kcontrol/kcmlowbatwarn/Makefile.am | 2 + doc/kcontrol/kcmlowbatwarn/index.docbook | 104 +++ doc/kcontrol/laptop/Makefile.am | 2 + doc/kcontrol/laptop/index.docbook | 111 +++ doc/kcontrol/powerctrl/Makefile.am | 2 + doc/kcontrol/powerctrl/index.docbook | 77 ++ doc/kdelirc/Makefile.am | 5 + doc/kdelirc/irkick/Makefile.am | 4 + doc/kdelirc/irkick/index.docbook | 131 +++ doc/kdelirc/kcmlirc/Makefile.am | 4 + doc/kdelirc/kcmlirc/index.docbook | 165 ++++ doc/kdf/Makefile.am | 4 + doc/kdf/index.docbook | 266 ++++++ doc/kdf/kdf.png | Bin 0 -> 22869 bytes doc/kdf/kdf_config.png | Bin 0 -> 32396 bytes doc/kedit/Makefile.am | 4 + doc/kedit/index.docbook | 1255 ++++++++++++++++++++++++++++ doc/kfloppy/Makefile.am | 4 + doc/kfloppy/index.docbook | 614 ++++++++++++++ doc/kgpg/Makefile.am | 4 + doc/kgpg/editor.png | Bin 0 -> 15541 bytes doc/kgpg/index.docbook | 354 ++++++++ doc/kgpg/keygen.png | Bin 0 -> 9522 bytes doc/kgpg/keymanage.png | Bin 0 -> 23651 bytes doc/kgpg/keys.png | Bin 0 -> 13790 bytes doc/kgpg/kicker.png | Bin 0 -> 4582 bytes doc/kgpg/options.png | Bin 0 -> 18367 bytes doc/khexedit/Makefile.am | 4 + doc/khexedit/index.docbook | 1063 +++++++++++++++++++++++ doc/khexedit/khexedit1.png | Bin 0 -> 3266 bytes doc/kinfocenter/Makefile.am | 6 + doc/kinfocenter/blockdevices/Makefile.am | 3 + doc/kinfocenter/blockdevices/index.docbook | 89 ++ doc/kjots/Makefile.am | 4 + doc/kjots/index.docbook | 552 ++++++++++++ doc/ksim/Makefile.am | 4 + doc/ksim/index.docbook | 66 ++ doc/ktimer/Makefile.am | 4 + doc/ktimer/index.docbook | 66 ++ doc/kwallet/Makefile.am | 4 + doc/kwallet/cr22-action-wallet_closed.png | Bin 0 -> 997 bytes doc/kwallet/cr22-action-wallet_open.png | Bin 0 -> 1098 bytes doc/kwallet/edit1.png | Bin 0 -> 19314 bytes doc/kwallet/edit2.png | Bin 0 -> 26113 bytes doc/kwallet/edit3.png | Bin 0 -> 59244 bytes doc/kwallet/index.docbook | 396 +++++++++ doc/kwallet/kwalletmanager.png | Bin 0 -> 11282 bytes doc/kwallet/password1.png | Bin 0 -> 19088 bytes doc/kwallet/password2.png | Bin 0 -> 21999 bytes doc/superkaramba/Makefile.am | 4 + doc/superkaramba/index.docbook | 261 ++++++ 90 files changed, 8614 insertions(+) create mode 100644 doc/KRegExpEditor/Makefile.am create mode 100644 doc/KRegExpEditor/altn.png create mode 100644 doc/KRegExpEditor/altntool.png create mode 100644 doc/KRegExpEditor/anychar.png create mode 100644 doc/KRegExpEditor/anychartool.png create mode 100644 doc/KRegExpEditor/begline.png create mode 100644 doc/KRegExpEditor/boundarytools.png create mode 100644 doc/KRegExpEditor/characters.png create mode 100644 doc/KRegExpEditor/charactertool.png create mode 100644 doc/KRegExpEditor/compound.png create mode 100644 doc/KRegExpEditor/compoundtool.png create mode 100644 doc/KRegExpEditor/endline.png create mode 100644 doc/KRegExpEditor/index.docbook create mode 100644 doc/KRegExpEditor/linestartendtool.png create mode 100644 doc/KRegExpEditor/lookaheadtools.png create mode 100644 doc/KRegExpEditor/neglookahead.png create mode 100644 doc/KRegExpEditor/nonwordboundary.png create mode 100644 doc/KRegExpEditor/poslookahead.png create mode 100644 doc/KRegExpEditor/repeat.png create mode 100644 doc/KRegExpEditor/repeattool.png create mode 100644 doc/KRegExpEditor/select.png create mode 100644 doc/KRegExpEditor/text.png create mode 100644 doc/KRegExpEditor/texttool.png create mode 100644 doc/KRegExpEditor/theEditor.png create mode 100644 doc/KRegExpEditor/wordboundary.png create mode 100644 doc/Makefile.am create mode 100644 doc/ark/Makefile.am create mode 100644 doc/ark/index.docbook create mode 100644 doc/ark/man-ark.1.docbook create mode 100644 doc/kcalc/Makefile.am create mode 100644 doc/kcalc/commands.docbook create mode 100644 doc/kcalc/index.docbook create mode 100644 doc/kcalc/kcalc_on_Aix.txt create mode 100644 doc/kcalc/kcalc_on_OSF.txt create mode 100644 doc/kcharselect/Makefile.am create mode 100644 doc/kcharselect/index.docbook create mode 100644 doc/kcontrol/Makefile.am create mode 100644 doc/kcontrol/kcmlowbatcrit/Makefile.am create mode 100644 doc/kcontrol/kcmlowbatcrit/index.docbook create mode 100644 doc/kcontrol/kcmlowbatwarn/Makefile.am create mode 100644 doc/kcontrol/kcmlowbatwarn/index.docbook create mode 100644 doc/kcontrol/laptop/Makefile.am create mode 100644 doc/kcontrol/laptop/index.docbook create mode 100644 doc/kcontrol/powerctrl/Makefile.am create mode 100644 doc/kcontrol/powerctrl/index.docbook create mode 100644 doc/kdelirc/Makefile.am create mode 100644 doc/kdelirc/irkick/Makefile.am create mode 100644 doc/kdelirc/irkick/index.docbook create mode 100644 doc/kdelirc/kcmlirc/Makefile.am create mode 100644 doc/kdelirc/kcmlirc/index.docbook create mode 100644 doc/kdf/Makefile.am create mode 100644 doc/kdf/index.docbook create mode 100644 doc/kdf/kdf.png create mode 100644 doc/kdf/kdf_config.png create mode 100644 doc/kedit/Makefile.am create mode 100644 doc/kedit/index.docbook create mode 100644 doc/kfloppy/Makefile.am create mode 100644 doc/kfloppy/index.docbook create mode 100644 doc/kgpg/Makefile.am create mode 100644 doc/kgpg/editor.png create mode 100644 doc/kgpg/index.docbook create mode 100644 doc/kgpg/keygen.png create mode 100644 doc/kgpg/keymanage.png create mode 100644 doc/kgpg/keys.png create mode 100644 doc/kgpg/kicker.png create mode 100644 doc/kgpg/options.png create mode 100644 doc/khexedit/Makefile.am create mode 100644 doc/khexedit/index.docbook create mode 100644 doc/khexedit/khexedit1.png create mode 100644 doc/kinfocenter/Makefile.am create mode 100644 doc/kinfocenter/blockdevices/Makefile.am create mode 100644 doc/kinfocenter/blockdevices/index.docbook create mode 100644 doc/kjots/Makefile.am create mode 100644 doc/kjots/index.docbook create mode 100644 doc/ksim/Makefile.am create mode 100644 doc/ksim/index.docbook create mode 100644 doc/ktimer/Makefile.am create mode 100644 doc/ktimer/index.docbook create mode 100644 doc/kwallet/Makefile.am create mode 100644 doc/kwallet/cr22-action-wallet_closed.png create mode 100644 doc/kwallet/cr22-action-wallet_open.png create mode 100644 doc/kwallet/edit1.png create mode 100644 doc/kwallet/edit2.png create mode 100644 doc/kwallet/edit3.png create mode 100644 doc/kwallet/index.docbook create mode 100644 doc/kwallet/kwalletmanager.png create mode 100644 doc/kwallet/password1.png create mode 100644 doc/kwallet/password2.png create mode 100644 doc/superkaramba/Makefile.am create mode 100644 doc/superkaramba/index.docbook (limited to 'doc') 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 new file mode 100644 index 0000000..900a1e9 Binary files /dev/null and b/doc/KRegExpEditor/altn.png differ diff --git a/doc/KRegExpEditor/altntool.png b/doc/KRegExpEditor/altntool.png new file mode 100644 index 0000000..2d450e8 Binary files /dev/null and b/doc/KRegExpEditor/altntool.png differ diff --git a/doc/KRegExpEditor/anychar.png b/doc/KRegExpEditor/anychar.png new file mode 100644 index 0000000..11048ca Binary files /dev/null and b/doc/KRegExpEditor/anychar.png differ diff --git a/doc/KRegExpEditor/anychartool.png b/doc/KRegExpEditor/anychartool.png new file mode 100644 index 0000000..08425d3 Binary files /dev/null and b/doc/KRegExpEditor/anychartool.png differ diff --git a/doc/KRegExpEditor/begline.png b/doc/KRegExpEditor/begline.png new file mode 100644 index 0000000..3465a9e Binary files /dev/null and b/doc/KRegExpEditor/begline.png differ diff --git a/doc/KRegExpEditor/boundarytools.png b/doc/KRegExpEditor/boundarytools.png new file mode 100644 index 0000000..c93d764 Binary files /dev/null and b/doc/KRegExpEditor/boundarytools.png differ diff --git a/doc/KRegExpEditor/characters.png b/doc/KRegExpEditor/characters.png new file mode 100644 index 0000000..7f218bf Binary files /dev/null and b/doc/KRegExpEditor/characters.png differ diff --git a/doc/KRegExpEditor/charactertool.png b/doc/KRegExpEditor/charactertool.png new file mode 100644 index 0000000..1690018 Binary files /dev/null and b/doc/KRegExpEditor/charactertool.png differ diff --git a/doc/KRegExpEditor/compound.png b/doc/KRegExpEditor/compound.png new file mode 100644 index 0000000..a56c9bb Binary files /dev/null and b/doc/KRegExpEditor/compound.png differ diff --git a/doc/KRegExpEditor/compoundtool.png b/doc/KRegExpEditor/compoundtool.png new file mode 100644 index 0000000..d1ad43c Binary files /dev/null and b/doc/KRegExpEditor/compoundtool.png differ diff --git a/doc/KRegExpEditor/endline.png b/doc/KRegExpEditor/endline.png new file mode 100644 index 0000000..29b512e Binary files /dev/null and b/doc/KRegExpEditor/endline.png differ 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 @@ + + + +]> + + + + + The Regular Expression Editor Manual + + + + Jesper K. + Pedersen +
blackie@kde.org
 + + + + 2001-07-03 + 0.1 + + &underFDL; + + + 2001 + Jesper K. Pedersen + + + + This Handbook describes the Regular Expression Editor widget + + + + KDE + regular expression + + + + + + + + Introduction + + + + The regular expression editor is an editor for editing regular expression + in a graphical style (in contrast to the ASCII syntax). Traditionally + regular expressions have been typed in the ASCII syntax, which for example + looks like ^.*kde\b. The major drawbacks of + this style are: + + It is hard to understand for + non-programmers. + + It requires that you escape + certain symbols (to match a star for example, you need to type + \*). + + It requires that you remember rules for + precedence (What does x|y* + match? a single x or a number of + y, OR a number of + x and y's mixed?) + + + + + The regular expression editor, on the other hand, lets you + draw 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 + let me know. + + + + + + + + + What is a Regular Expression + + A regular expression is a way to specify + conditions to be fulfilled for a situation + in mind. Normally when you search in a text editor you specify + the text to search for literally, using a + regular expression, on the other hand, you tell what a given + match would look like. Examples of this include I'm + searching for the word KDE, but only at the beginning of the + line, or I'm searching for the word + the, but it must stand on its own, + or I'm searching for files starting with the word + test, followed by a number of digits, for + example test12, test107 + and test007 + + 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. + + + Searching for normal text. + 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: .*|$. Thus if you want to + search for the text kde. (i.e. the characters + kde followed by a period), then you would need to + specify this as kde\.The regular + expression editor solves this problem by taking care of escape rules for + you. Writing \. rather than just + . is called escaping. + + + + + Matching URLs + When you select something looking like a URL in KDE, then the + program klipper will offer to start + konqueror with the selected URL. + + Klipper does this by matching the selection + against several different regular expressions, when one of the regular + expressions matches, the accommodating command will be offered. + + The regular expression for URLs says (among other things), that the + selection must start with the text http://. This is + described using regular expressions by prefixing the text + http:// with a hat (the ^ + character). + + The above is an example of matching positions using regular + expressions. Similar, the position end-of-line can + be matched using the character $ (i.e. a dollar + sign). + + + + 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> + Two extra position types can be matches in the above way, + namely the position at a word boundary, and + the position at a non-word + boundary. The positions are specified using the text + \b (for word-boundary) and \B (for + non-word boundary) + + Thus, searching for the word the can be done + using the regular expression \bthe\b. This specifies + that we are searching for the with no letters on each + side of it (i.e. with a word boundary on each side) + + The four position matching regular expressions are inserted in the + regular expression editor using four + different positions tool + + + + Searching for either <literal>this</literal> or <literal>that</literal> + Imagine that you want to run through your document searching for + either the word this or the word + that. With a normal search method you could do this in + two sweeps, the first time around, you would search for + this, and the second time around you would search for + that. + + Using regular expression searches you would search for both in the + same sweep. You do this by searching for + this|that. I.e. separating the two words with a + vertical bar.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. + + In the regular expression editor you do not write the vertical bar + yourself, but instead select the alternative + tool, and insert the smaller regular expressions above each other. + + + + Matching anything + 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: + + ls *.txt - here *.txt is + the shell wildcard matching every file ending with the + .txt extension. + cat test??.res - matching every file starting with + test followed by two arbitrary characters, and finally + followed by the test .res + + + + In the shell the asterisk matches any character any number of + times. In other words, the asterisk matches anything. + This is written like .* with regular expression + syntax. The dot matches any single character, i.e. just + one 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. + + 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: a. The letter a on its + own is a regular expression that matches a single letter, namely the + letter a. If we combine this with the asterisk, + i.e. a*, then we have a regular expression matching + any number of a's. + + We can combine several regular expression after each + other, for example ba(na)*. + (na)* just says that what is inside + the parenthesis is repeated any number of times. + 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): ba, bana, + banana, bananananananana + + + Given the information above, it hopefully isn't hard for you to write the + shell wildcard test??.res as a regular expression + Answer: test..\.res. The dot on its own is any + character. To match a single dot you must write + \.This is called escaping. In + other word, the regular expression \. matches a dot, + while a dot on its own matches any character. + + In the regular expression editor, a repeated regular expression is + created using the repeat tool + + + + Replacing <literal>&</literal> with + <literal>&amp;</literal> in a HTML document In + HTML the special character & must be + written as &amp; - this is similar to + escaping in regular expressions. + + 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 + & with &amp;. + + This can easily be done using normal search and replace, + there is, however, one glitch. Imagine that you did remember + this rule - just a bit - and did it right + in some places. Replacing unconditionally would result in + &amp; being replaced with + &amp;amp; + + What you really want to say is that & should + only be replaced if it is not followed by the letters + amp;. You can do this using regular expressions using + positive lookahead. + + The regular expression, which only matches an ampersand if it is + not followed by the letters amp; looks as follows: + &(?!amp;). This is, of course, easier to read using + the regular expression editor, where you would use the + lookahead tools. + + + + + + + + + Using the Regular Expression Editor + + + This chapter will tell you about how the regular expression editor works. + + + + + + + The organization of the screen + + + + + + 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. + + Above the editing area you have two Toolbars, the first one + contains the editing actions - + much like drawing tools in a drawing program. The second Toolbar + contains the whats this button, and buttons + for undo and redo. + + 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. + + 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 nicer 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 + user defined regular + expressions to learn how to save your own regular expressions. + + + + + + + Editing Tools + The text in this section expects that you have read the chapter + on what a regular expression + is, or have previous knowledge on this subject. + + All the editing tools are located in the tool bar above + editing area. Each of them will be described in the following. + + + + + Selection Tool + + + + 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. + + + + + Text Tool + + + + + + + + + + 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: abc\*\\\) + + + + + Character Tool + + + + + + + + Using this tool you insert + character ranges. Examples includes what in ASCII text says + [0-9], [^a-zA-Z,_]. When + inserting an item with this tool a dialog will appear, in which + you specify the character ranges. + + See description of repeated + regular expressions. + + + + + Any Character Tool + + + + + + + This is the regular expression "dot" (.). It matches any + single character. + + + + + + + + Repeat Tool + + + + + + + + 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. + + You specify what to repeat by drawing the repeated content + inside the box which this tool inserts. + + 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. + + See description on the repeated + regular expressions. + + + + + + Alternative Tool + + + + + + + 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. + + See description on alternative + regular expressions + + + + + + Compound Tool + + + + + + + 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. + + + + + + + Line Start/End Tools + + + + + + + + + + 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. + + See description of position + regular expressions. + + + + + + + Word (Non)Boundary Tools + + + + + + + + + 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 the. The word + the itself is, however, not matched. + + See description of boundary + regular expressions. + + + + + + + Positive/Negative Lookahead + Tools + + + + + + + + + The look ahead tools either specify a positive or negative + regular expression to match. The match is, however, not part of + the total match. + + Note: You are only allowed to place lookaheads at the end + of the regular expressions. The Regular Expression Editor widget + does not enforce this. + + See description of look ahead + regular expressions. + + + + + + + + User Defined Regular Expressions + 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. + + These regular expression serves two purposes + (see detailed + description), namely (1) to offer you a set of building + block and (2) to make common regular expressions prettier. + + You can save your own regular expressions by right clicking the + mouse button in the editing area, and choosing Save Regular + Expression. + + If the regular expression you save is within a + compound container then the + regular expression will take part in making subsequent regular + expressions prettier. + + 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. + + + + + + + + Reporting bugs and Suggesting Features + Bug reports and feature requests should be submitted through the + KDE Bug Tracking System. Before you report a bug or suggest a feature, + please check that it hasn't already been + reported/suggested. + + + + + + + Frequently Asked Questions + + Does the regular expression editor support back references? + No currently this is not supported. It is planned for the next + version. + + + + Does the regular expression editor support showing matches? + No, hopefully this will be available in the next version. + + + + I'm the author of a KDE program, how can I use this widget in + my application? + See The documentation for the class KRegExpEditorInterface. + + + + I can't find the <emphasis>Edit Regular expression</emphasis> button in for example + konqueror on another KDE3 installation, why? + The regular expression widget is located in the package + KDE-utils. If you do not have this package installed, then the + edit regular expressions buttons will not + appear in the programs. + + + + + + + + Credits and Licenses + + + Documentation is copyright 2001, Jesper K. Pedersen + blackie@kde.org + + + + &underGPL; + &underFDL; + + + + + + + diff --git a/doc/KRegExpEditor/linestartendtool.png b/doc/KRegExpEditor/linestartendtool.png new file mode 100644 index 0000000..e7c1bd8 Binary files /dev/null and b/doc/KRegExpEditor/linestartendtool.png differ diff --git a/doc/KRegExpEditor/lookaheadtools.png b/doc/KRegExpEditor/lookaheadtools.png new file mode 100644 index 0000000..a986f50 Binary files /dev/null and b/doc/KRegExpEditor/lookaheadtools.png differ diff --git a/doc/KRegExpEditor/neglookahead.png b/doc/KRegExpEditor/neglookahead.png new file mode 100644 index 0000000..3cc0291 Binary files /dev/null and b/doc/KRegExpEditor/neglookahead.png differ diff --git a/doc/KRegExpEditor/nonwordboundary.png b/doc/KRegExpEditor/nonwordboundary.png new file mode 100644 index 0000000..b22f4d4 Binary files /dev/null and b/doc/KRegExpEditor/nonwordboundary.png differ diff --git a/doc/KRegExpEditor/poslookahead.png b/doc/KRegExpEditor/poslookahead.png new file mode 100644 index 0000000..492692b Binary files /dev/null and b/doc/KRegExpEditor/poslookahead.png differ diff --git a/doc/KRegExpEditor/repeat.png b/doc/KRegExpEditor/repeat.png new file mode 100644 index 0000000..2646111 Binary files /dev/null and b/doc/KRegExpEditor/repeat.png differ diff --git a/doc/KRegExpEditor/repeattool.png b/doc/KRegExpEditor/repeattool.png new file mode 100644 index 0000000..5d525e9 Binary files /dev/null and b/doc/KRegExpEditor/repeattool.png differ diff --git a/doc/KRegExpEditor/select.png b/doc/KRegExpEditor/select.png new file mode 100644 index 0000000..e04ab17 Binary files /dev/null and b/doc/KRegExpEditor/select.png differ diff --git a/doc/KRegExpEditor/text.png b/doc/KRegExpEditor/text.png new file mode 100644 index 0000000..8b256ca Binary files /dev/null and b/doc/KRegExpEditor/text.png differ diff --git a/doc/KRegExpEditor/texttool.png b/doc/KRegExpEditor/texttool.png new file mode 100644 index 0000000..8c92526 Binary files /dev/null and b/doc/KRegExpEditor/texttool.png differ diff --git a/doc/KRegExpEditor/theEditor.png b/doc/KRegExpEditor/theEditor.png new file mode 100644 index 0000000..4e2468f Binary files /dev/null and b/doc/KRegExpEditor/theEditor.png differ diff --git a/doc/KRegExpEditor/wordboundary.png b/doc/KRegExpEditor/wordboundary.png new file mode 100644 index 0000000..0e89a6b Binary files /dev/null and b/doc/KRegExpEditor/wordboundary.png differ 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 @@ + + + + + +]> + + + + +The &ark; Handbook + + + +&Matt.Johnston; &Matt.Johnston.mail; + + + + + + +2000 +Matt Johnston + + + +2004 +Henrique Pinto + + + +&FDLNotice; + +2004-06-19 +2.3.1 + + +&ark; is an archive manager for &kde;. + + +KDE +gzip +gunzip +tar +archive +zip +compression +lha +kdeutils +ark + + + + +Introduction + +&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 tar, gzip, +bzip2, zip, rar and +lha (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. + + + + +Using &ark; + + +Opening Archives + +To open an archive in &ark;, choose +Open from the File +menu. You can also open archive files by dragging and dropping from +&konqueror;. Archive files should be associated with &ark;, so you can +also right click a file in &konqueror; and +select &ark; to open it. + + + + +Working with Files + +Once an archive has been opened, you can perform various +operations on the files inside the archive. By +right clicking on a file within the +archive, or selecting a file and using the Action +menu, you can choose what you want to do: + + + +Extract will extract the file to a location you +specify on disk. + + +Delete will remove the currently +selected file(s) from the archive. + + +View 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. + + +Open With... allows you to open the +file in a program you choose. + + +Edit With... will open the file a +program you choose. The difference between this and Open +With... is that any changes you make will be saved to the +file in the archive. + + + + + + +Extracting Archives + +Once an archive has been opened in &ark;, it can be extracted. To +extract files from an archive, you can either select +Extract... from the +Action menu or right click on the file. The Extract +dialog allows you to select where you will extract files to. You can +also select which files to extract: + + + +Current extracts the most recently +selected file. If multiple files are selected, only the most recently +selected one will be extracted. + + +All extracts the entire contents of the +archive. + + +Selected Files extracts all the files +which have been selected. + + +Pattern allows you to specify which +files will be extracted, corresponding to certain patterns, ⪚ +*.txt or *.jpg. Note that you can only use one +pattern at a time. + + + +You can specify the folder to extract files to in the +Extract to: 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. + + + + +Creating Archives and Adding Files + +To create a new archive in &ark;, choose +New from the File +menu. + +You can then type the name of the archive, with the appropriate +extension (tar.gz, zip, bz2 +&etc;). To add files to the archive, choose Add +File... from the Action menu. If you +want to add an entire folder to an archive, choose Add +Folder... from the Action menu. + +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. + + + + + + +Configuring &ark; + + +General Settings + + + + +Use integrated viewer + +Use the integrated viewer to view files, if possible. + + + + +Enable Konqueror integration + +Enable the plugin for extracting or adding files to archives through Konqueror context menus. +This option only works if the Konqueror integration plugin from kdeaddons is installed on your system. + + + + + + + + +File Addition Settings + +Many of these options are only configurable for specific archive +formats. Other formats may behave either way and are not +configurable. + + + +Replace old files only with newer +files + +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. + + + + +Force MS-DOS short filenames (Zip) + +Force names to the DOS 8.3 format. +Affects only zip files + + + + +Translate LF to DOS CRLF (Zip) + +Convert the line endings in text files to DOS format from UNIX +format. +Affects only zip files + + + + +Store symlinks as links (Zip, Rar) + +Save links inside the archive, instead of following them and +including the files being linked to. +Affects zip and rar archives. + + + + +Recursively add subfolders (Zip, +Rar) + +If you add a folder to an archive, also add any +subfolders inside. Affects zip and rar archives + + + + + + + +Extraction Settings + +Many of these options are only configurable for specific archive +formats. Other formats may behave either way and are not +configurable. + + + +Overwrite files (Zip, Tar, Zoo, Rar) + +Overwrite any files that have matching names on disk with the +one from the archive. + + + + +Preserve permissions (Tar) + +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. + + + + +Ignore folder names (Zip) + +Extract all the files into the extraction folder, ignoring +any folder structure in the archive. + + + + +Convert filenames to lowercase (Zip, Rar) +Convert filenames to uppercase (Rar) + +Extract all files with all lowercase (or uppercase) names. + + + + + + + + +Folders + + + +Folders + +This shows the Folders dialog box, so you + can choose the default folders. You can configure a Common folder that will be used for all options, use the last used folder, or a custom folder. + + + + + + + + + +Command Reference + + +The <guimenu>File</guimenu> Menu + + + + &Ctrl;N +File +New + +Creates a new archive + + + + + &Ctrl;O +File +Open + +Opens an archive + + + + + +File +Open Recent + + +Shows a list of recent archives to choose +from + + + + + +File +New Window + + +Opens a new &ark; window + + + + + +F5 +File +Reload + + +Loads the current archive again from disk. This will +refresh &ark;'s view if another program has made changes to the +archive. + + + + + +File +Save As + + +Allows you to save the current archive under a new file +name + + + + + + +&Ctrl;W + + +File +Close + + +Closes the current archive + + + + + +&Ctrl; +Q +File +Quit + + +Closes &ark; + + + + + + +The <guimenu>Edit</guimenu> Menu + + + + + +Edit +Select... + + +Lets you select files according to their +filename. For example, you could use *.txt to select all text files. Note that you +can't use more than one filter at a time. + + + + + +&Ctrl; +A +Edit +Select All + + +Selects all the files in the archive + + + + + +Edit +Deselect All + + +Unselects all the files in the archive + + + + + +Edit +Invert Selection + + +Reverses which files are selected. Selected files become +unselected, and unselected files are selected. + + + + + +Edit +View Shell Output + + +Displays the Shell Output box, which +shows you the output of the most recent command(s) run +by &ark;. This is sometimes useful if you are having problems and want +to troubleshoot. + + + + + + + + +The <guimenu>Action</guimenu> Menu + + + + + +Action +Add File... + + +Shows the Select Files to Add dialog box, +where you can select files. Hold down &Ctrl; and click to select +multiple files. To go up a folder, +right click the folder box, and you can +choose Up (this will probably be improved +soon). The Advanced tab has options which are +specific to the type or archive you are working with. + + + + + +Action +Add Folder... + + +Shows the Add Folder... dialog box, where you +can choose a folder to add. Just choose a folder +and choose Open. + + + + + +Action +Delete + + +Removes the currently selected files from the +archive. + + + + + +Action +Extract + + +Shows the Extract dialog box, which allows +you to select where you will extract files to. You can +also select which files to extract: + + + +Current extracts the most recently selected +file. If multiple files are selected, only the most recently selected +one will be extracted. + + +All extracts the entire contents of the +archive. + + +Selected Files extracts all the files which +have been selected. + + +Pattern allows you to specify which files +will be extracted, corresponding to certain patterns, ⪚ +*.txt or *.jpg Note that you can only use one +pattern at a time. + + + + +You can specify the folder to extract files to in the +Extract to: 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. + + + + + +Action +View + + +Opens the currently selected file in the associated viewer +program. + + + + + +Action +Open With... + + +Opens the currently selected file in a program you +choose. The Open With... dialog box lets +you choose which program to use. + + + + + +Action +Edit With... + + +Opens the currently selected file in a program you +choose. Any changes you make in the editor program will be +reflected in the archive, as it will be updated. + + + + + + + + +The <guimenu>Settings</guimenu> Menu + + + + + +Settings +Show/Hide Toolbar + + +Toggles whether the toolbar is displayed. + + + + + +Settings +Show/Hide Statusbar + + +Toggles whether the status bar is +displayed. + + + + + +Settings +Show/Hide Search Bar + + +Toggles whether the search bar is +displayed. + + + + + +Settings +Configure Shortcuts... + + +Displays the Configure Shortcuts dialog +box. This lets you choose shortcut keys for various menu +items. To change a shortcut, select an action from the list, +and then choose which keystroke to use. Clicking on the bottom right +hand Key button lets you choose which specific +key to use. Just press the new key. + + + + + +Settings +Configure Toolbars... + + +Displays a &kde; standard dialog where you can configure the +toolbar icons. + + + + + +Settings +Configure Ark... + + + +This opens the &ark; configuration dialog. The dialog contains four +modules (General, Addition, Extraction and Folders). Configuring &ark; is covered in the section Configuration + + + + + + + +The <guimenu>Help</guimenu> Menu + +&help.menu.documentation; + + + + + + + +Credits and License + +&ark; is Copyright © 1997-2004, The Various &ark; Developers + + +Authors: +Helio Chissini de Castro +helio@conectiva.com.br +Georg Robbers +Georg.Robbers@urz.uni-hd.de +Henrique Pinto +henrique.pinto@kdemail.net +Roberto Selbach Teixeira +maragato@kde.org +Robert Palmbos +palm9744@kettering.edu +Francois-Xavier Duranceau +duranceau@kde.org +Corel Corporation (author: Emily Ezust) +emilye@corel.com + + +Documentation Copyright © 2000 Matt Johnston +mattj@flashmail.com + +Documentation updated for &kde; 3.3 by Henrique Pinto +henrique.pinto@kdemail.net. + +&underFDL; +&underGPL; + + + + +Installation + + +How to obtain &ark; + +&install.intro.documentation; + + + + +Requirements + +In order to successfully use &ark;, you need &kde; +3.3. GNU Tar v1.12 and a recent +gzip 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 +zip, unzip, ar, rar +and lha. + + + + +Compilation and Installation + +&install.compile.documentation; + + + + + +&documentation.index; + + + + 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 @@ + + + +]> + + + +KDE User's Manual + +Lauri +Watts + +&Lauri.Watts.mail; +February 25, 2005 +K Desktop Environment + + + +&kappname; +1 + + + +ark +A &kde; archiving tool + + + + +ark + + + + + + + +folder +files +archive +KDE Generic Options +Qt Generic Options + + + + +Description +&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 tar, +gzip, bzip2, +zip, rar and +lha (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. + + + + +Options + + + + + +Open extract dialog, quit when finished + + + + +Extract archive to +folder. Quit when finished. +folder will be created if it does not +exist. + + + + + +Ask for the name of the archive to add +files to. Quit when finished. + + + + + +Add files to +archive. Quit when finished. +archive will be created if it does not +exist. + + + + + +Used with . When specified, +archive will be extracted to a +subfolder of folder whose name will be +the name of archive without the +filename extension. + + + + + + + +Environment + + +$PATH + +The commandline programs to deal with the archives you wish to +handle in &kappname; must be available in your +$PATH. + + + + + + +Examples + + + +ark . +An-Archive.tar.bz2 + +Will extract An-Archive.tar.bz2 into a +folder named An-Archive in the +current directory. + + + +ark +*.jpg pictures.tar.bz2 + +Add all files ending in *.jpg to an archive named +pictures.tar.bz2, creating it if it doesn't +already exist. + + + + + + +See Also +tar(1), gzip(1), bzip2(1), zip(1), rar(1), lha(1) + +More detailed user documentation is available from help:/ark +(either enter this URL into &konqueror;, or run +khelpcenter +help:/ark). + + + + +Authors +&ark; is maintained by +HenriquePinto stampede@coltec.ufmg.br +This man page was written by &Lauri.Watts; +&Lauri.Watts.mail; for &kde; 3.4. + + + 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 @@ + + +Command Reference + + +The <guimenu>File</guimenu> Menu + + + + + + +&Ctrl;Q + +File +Quit + +Quit &kcalc;. + + + + + + + +The <guimenu>Edit</guimenu> Menu + + + + + + +&Ctrl;Z + +Edit +Undo + +Go back in the result +stack. + + + + + +&Ctrl;&Shift;Z + +Edit +Redo + +Go forward in the result +stack. + + + + + + +&Ctrl;X + +Edit +Cut + +Delete the displayed result and copy it to the +clipboard. + + + + + +&Ctrl;C + +Edit +Copy + +Copy the displayed result to the +clipboard. + + + + + +&Ctrl;V + +Edit +Paste + +Insert the cut or copied result in the +display. + + + + + + + +The <guimenu>Constants</guimenu> Menu + + + + + +Constants +Mathematics + +Display Pi, Euler Number or Golder Ratio. + + + + + +Constants +Electromagnetism + +Display Light Speed, Elementary Charge, +Impedance of Vacuum, Permeability of Vacuum or Permittivity of Vacuum. + + + + + +Constants +Atomic & Nuclear + +Display Planck's Constant, Elementary Charge or +Fine-Structure Constant. + + + + + +Constants +Thermodynamics + +Display Boltzmann Constant, Atomic Mass Unit, Molar Gas +Constant, Stefan-Boltzmann Constant or Avogadro's Number. + + + + + +Constants +Gravitation + +Display Constant of Gravitation or Earth Acceleration. + + + + + + + + +The <guimenu>Settings</guimenu> Menu + + + + +Settings +Science/Engineering Buttons + +Display science and engineering buttons. + + + + + +Settings +Statistic Buttons + +Display statistic +buttons. + + + + + +Settings +Logic Buttons + +Display logic +buttons. + + + + + +Settings +Constants Buttons + +Display constants buttons. + + + + + +Settings +Show All + +Display all buttons available. + + + + + +Settings +Hide All + +Hide all extra buttons and display only +standard default buttons. + + + + + +Settings +Configure Shortcuts... + +Configure the keyboard shortcuts used by &kcalc;. + + + + + + +Settings +Configure &kcalc;... + +Display the &kcalc; settings dialog. + + + + + + + + +The <guimenu>Help</guimenu> Menu + +&help.menu.documentation; + + + + + + 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 @@ + + + + + + +]> + + + +The &kcalc; Handbook + + + +&Bernd.Johannes.Wuebben; &Bernd.Johannes.Wuebben.mail; + + + +&Pamela.Roberts;&Pamela.Roberts.mail; + + + +&Anne-Marie.Mahfouf;&Anne-Marie.Mahfouf.mail; + + + + + + +2001 2002 2005 2006 +&Bernd.Johannes.Wuebben;, &Pamela.Roberts;, +&Anne-Marie.Mahfouf; + + +&FDLNotice; + +2006-02-13 +2.0.2 + +&kcalc; is a scientific calculator for &kde; + + +KDE +KCalc +calculator + + + + +Introduction + +This document describes &kcalc; version 1.8. + +&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. + +In addition to the usual functionality offered by most scientific +calculators, &kcalc; offers a number of features, which I think are +worthwhile pointing out: + + + +&kcalc; provides trigonometric functions, logic operations, and it is +able to do statistical calculations. + + +&kcalc; allows you to cut and paste numbers from/into its display. + + +&kcalc; features a results-stack which lets +you conveniently recall previous results. + + +You can configure &kcalc;'s display colors and font. + + +You can configure &kcalc;'s precision and the number +of digits after the period. + + + &kcalc; offers a great number of useful +key-bindings, which make using &kcalc; without using a pointing device easy. +Hint: pressing (and holding) the &Ctrl;-key, displays on +every button, +the corresponding key-binding. + + + +Have fun with &kcalc;! + +Bernd Johannes Wuebben + + + + + +Usage + +General Usage + +General usage is straight forward and similar to the way most +simple scientific calculators operate, but take note of the following +special &kcalc; features: + + + +Result Stack +Each time you &LMB; click on the += button or press your keyboard's +Enter or = keys, the display result is +written to &kcalc;'s result stack. You can navigate through the result +stack with your keyboard's +&Ctrl;Z +and &Ctrl; &Shift;Z +keys. + + + + +Percent Function + +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 percent function for further details. + + + +Cut and Paste + + + +Pressing &Ctrl;C +will place the displayed number on to the clipboard. + + +Pressing &Ctrl;V +will paste the clipboard content into the display if the content of the +clipboard is a valid floating point number. + + +It is still possible to copy/paste by clicking on &kcalc;'s display, +but this may disappear in future versions. + + + + + +Advanced functions + +When you start &kcalc; for the first time, the calculator will only +display buttons for basic arithmetic computations. +Under the menu entry Settings it is possible to +open extra buttons for &kcalc;: +it is for example possible to choose +Statistical or +Trigonometric buttons. + + + + + + +Statistical Mode + +In this mode the left column of buttons is allocated to statistical +functions: + Most of the functionality in this mode is centered around the Dat + button. To create a data list of numbers, enter a number into the calculator and press + Dat. A sequentially increasing number is shown on the display indicating + which position in the Data list 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. + + + + +Buttons +Function + + +N +Recall the number of data items entered + +Inv N +Display the sum of all data items entered + +Mea +Display the mean of the data items entered + +Inv Mea +Display the sum of the square of all data items entered + +Std +Display the standard deviation (n) + +Inv Std +Display the population standard deviation (n-1) + +Med +Display the median + +Dat +Enter a data item + +Inv Dat +Clear last data item entered + +Cst +Clear the store of all data item entered + + + + + + + +Trigonometric Mode + +In this mode the left column of buttons is allocated to trigonometric +functions: + + + +Buttons +Function + + +Hyp +Enter Hyperbolic sub mode. Hyp Sin for example is the hyperbolic sine: +sinh(x) + +Sin +Compute the sine + +Inv Sin +Compute the inverse sine + +Cos +Compute the cosine + +Inv Cos +Compute the inverse cosine + +Tan +Compute the tangent + +Inv Tan +Compute the inverse tangent + +Log +Compute the Log base 10 + +Inv Log +Compute 10 to the power of x + +Ln +Compute the natural logarithm. That is the log to base e + +Inv Ln +Compute e to the power of x + + + + + + +Memory Operations + +&kcalc; supports the memory operations given by standard +calculators plus six slots to hold constants. + + + Standard Memory Operations + +&kcalc; can remember results of operations for you, and re-use them in +later calculations. You can access these functions via several buttons +labelled MR, MS, +M+ and MC. + + + +MS +The MS button stores the currently +displayed result in memory. + + + +M+ +The M+ 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 MS and simply stores the +result. + + + +MR +The MR button gets the value stored +in memory and puts it in the display. + + + +MC +The MC button clears the +memory. + + + +If a value is stored in memory a M will appear in +the status bar, next to the calculator mode indicator + + + +Constants + +The six constants buttons C1 to +C6 will only be visible after activating the +item Constants Buttons in the menu +Settings of the menu bar. + +To store the number shown in the &kcalc; display in one of the +six constants, first press Inv followed +by the desired button key C1 up to +C6. + +To use the value stored in any of the contants in a calculation, just + press the desired button (C1 to C6), + and the corresponding number will appear in the display. + +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 C1 to + C6. A popup menu appears, in which you select + Set Name. + +There are many (mostly physical) predefined constants, which can +be put on any of the six buttons C1 - +C6 by selecting the desired constant in the +popup menu that appears after right clicking on one of the constant +buttons and selecting Choose from List. Though +the predefined constants can also be accessed via the +Constants in the menu bar, storing it on a +constants button is very handy, if the number is used +frequently. + + + + + + +Single Key Accelerators + +To simplify entering calculations from the keyboard &kcalc; has single key +accelerators for most functions. For example entering 7R +or 7r will calculate the reciprocal of 7 (1/7). + +During a computation, you can always press &Ctrl; to make each +button display its key-binding. + + + +Key +Function +Notes + + + +H +Hyp +Hyperbolic as in Hyp Sin, +the sinh(x) + +S +Sin + + +C +Cos + + +T +Tan + + +N +Ln +log base e + +L +Log +log base 10 + +I + Inv +Inverse, ⪚ if +you want arcsin(x) type i s + +\ ++/- +Change sign + +[ +x^2 + + +^ +x^y + + +! +x! +Factorial + +< +Lsh +Left shift. Note: Inv +Lsh is Right shift + +& +And +Logical AND + +* +X +Multiply + +/ +/ +Divide + +D +Dat +Enter data item in statistical mode + +O +Or +Logical OR. Note: Inv +Or is XOR + +R +1/x +Reciprocal + += += + + +Enter += + + +Return += + + +Page Up +C +Clear + +Esc +C +Clear + +Prior +C +Clear + +Page Down +AC +Clear all + +Next +AC +Clear all + +Del +AC +Clear all + + + + + + + +Comments on Specific Functions + + +Mod and Inv Mod + + + +Mod gives the remainder of dividing the displayed +number by the next input number. +22 Mod 8 = will give the result +6 +22.345 Mod 8 = will give the result +6.345 + + + +Inv Mod does integer +division of the displayed number by the next input number. +22 Inv Mod 8 = will give the result +2 +22.345 Inv Mod 8 = also gives 2 + + + + + + + +% + +Used instead of the = key, +% interprets the final operation carried out in the +current calculation as follows: + + + +If the final operator is + or - the second argument is interpreted as percentage of the first operand. + + + +If the final operator is * divide the result of the multiplication by 100. + + + +If the final operator is / give the left operand +as a percentage of the right operand. + + + + In all other cases the % key gives identical results to the = key. + + + + + + +Examples: + +150 + 50 % gives 225 (150 plus 50 percent of this amount) +42 * 3 % gives +1.26 (42 * 3 / 100) +45 / 55 % gives +81.81... (45 is 81.81.. percent of 55) + + + + + + + +Lsh and Inv Lsh + + +Lsh 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: +10 Lsh 3 = gives 80 +(10 multiplied by 2 three times). +10.345 Lsh 3 = also gives +80. + + + +Inv Lsh right shifts the +value (performs an integer divide by 2) n times. +16 Inv Lsh 2 = gives +4 (16 divided by 2 twice). +16.999 Inv Lsh 2 = also gives +4. + + + + + + + +Cmp, And, Or and Xor + +The Cmp, And and +Or functions perform bitwise logical operations and +therefore appear more meaningful if the Base is set to +Hex, Oct or Bin +rather than Dec. In the following +examples Base is set to Bin. + + + +Cmp performs a 1's complement (inverts the +bits). +101 Cmp gives +111...111010 + + + +And does a logical AND. +101 And 110 = gives +100 + + + +Or does the logical OR. +101 Or 110 = gives +111 + + + +Xor performs the logical +XOR (exclusive OR) operation. +101 Xor 110 = gives +11 + + + + + + + + +Questions and Answers + + + + + +How do I get e, the Euler number? +Type 1 Inv Ln. + + + +How do I get two fixed digits after the period? +Click on the Configure button, this will +bring up the configuration dialog. Check Set fixed +precision and adjust the spin control so that it shows a +2. + + +What about Precision? +The main factor determining the precision of &kcalc; is whether your libc and libmath +supports the C data type long double. If this is the case, &kcalc; will detect this +at compile time and use it as its fundamental data type to represent numbers. + + +Adjust the Precision in &kcalc;'s +Configure 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 long double, otherwise 8 or 10. + +Higher precision doesn't necessarily lead to better results. Play with +the precision and you will see what I mean. + + + + + + +&commands; + + +Credits and License + +&kcalc; Program Copyright ©: +Bernd Johannes Wuebben 1996-2000 +The &kde; Team 2000-2004 + + +&Bernd.Johannes.Wuebben; &Bernd.Johannes.Wuebben.mail; +&Evan.Teran; &Evan.Teran.mail; +&Espen.Sand; &Espen.Sand.mail; +&Chris.Howells; &Chris.Howells.mail; +&Aaron.J.Seigo; &Aaron.J.Seigo.mail; +&Charles.Samuels; &Charles.Samuels.mail; + + +&kcalc; was inspired by Martin Bartlett's xfrmcalc, +whose stack engine is still part of &kcalc;. + +Documentation Copyright © 2001,2002,2005, 2006: + +&Bernd.Johannes.Wuebben; &Bernd.Johannes.Wuebben.mail; +&Pamela.Roberts; &Pamela.Roberts.mail; +&J.Hall; &J.Hall.mail; +&Anne-Marie.Mahfouf;&Anne-Marie.Mahfouf.mail; + + +&underFDL; +&underGPL; + + + + +Installation + +&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 http://www.kde.org. + + + + +Compilation and Installation + +&install.intro.documentation; +&install.compile.documentation; + + + + +How to enable long double precision for &kcalc; + +If your machine supports the C data type long double +and if you have a working libc you can enable long double +precision for &kcalc;. + +Here is what to do: + + + + Check ../config.h and see whether +HAVE_LONG_DOUBLE is defined, &ie; you should be able to locate a +line saying: + +#define HAVE_LONG_DOUBLE 1 + +If you can't find such a line your system doesn't support long +double IEEE precision. + + +Edit the files kcalctype.h, +configdlg.cpp, kcalc.cpp and +kcalc_core.cpp and remove the lines: + + +#ifdef HAVE_LONG_DOUBLE +#undef HAVE_LONG_DOUBLE +#endif + + + + + Recompile &kcalc;. + + + + + + + + + + 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: +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 + ; 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 + ; 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 +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: +References: <9708101509.AA13824@mail.schoeck.de> +X-Mailer: Pegasus Mail for Win32 (v2.52) +XFMstatus: 0000 +From: "Jochen Diehl" +To: Bernd Johannes Wuebben +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 +40a40 +> #include +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: +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 + ; 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 + ; 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 + ; 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: +Mime-Version: 1.0 +Content-Type: TEXT/PLAIN; charset=US-ASCII +XFMstatus: 0002 +From: Lars Knoll +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 @@ + + + + + +]> + + + + +The &kcharselect; Handbook + + + + + + + +
+ + + + + +&FDLNotice; + +2001-01-20 +0.00.00 + + + +&kcharselect; is part of the kdeutils package. + + + + + +KDE +kdeutils +kcharselect + + + + + +Introduction +The documentation for &kappname; was not finished when &kde; was installed on this computer. +If you need help, please check The KDE Web site for updates, or by submitting your question to The &kde; User Mailing list. +The &kde; Team + +&underFDL; +&underGPL; + + + +&documentation.index; + + + 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 @@ + + + +]> + +
+ + + + +&Mike.McBride; &Mike.McBride.mail; + + + + +2002-02-12 +3.00.00 + + +KDE +KControl +Battery +Power + + + + + +Low Battery Critical + + +Use +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. + + +Section Author +This section written by &Paul.Campbell; &Paul.Campbell.mail; +Converted to Docbook by &Mike.McBride; &Mike.McBride.mail; + + + + +
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 @@ + + + +]> + +
+ + + + +&Mike.McBride; &Mike.McBride.mail; + + + + +2002-02-12 +3.00.00 + + +KDE +KControl +Battery +Power + + + + + + +The Low Battery Warning and Low Battery Critical Panels + + + +Introduction + + +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. + + + + + + +Use + +Low trigger + +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 + + + +Run Command +This is a shell command that will be executed when the battery +low is detected. By default, this is turned off. + + +Play Sound +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. + + +System Beep +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. + + +Notify +Enabling this will cause Battery to pop up a window when the +battery becomes low. + + +Suspend +If you have set up /usr/bin/apm to be run +setuid (see the instructions for the Power panel) then this check box will +appear - if checked it will cause your computer to be put into Suspend +mode. + + +Standby +Like Suspend above, but it puts your computer into Standby +mode. + + + + + +Section Author +This section written by &Paul.Campbell; &Paul.Campbell.mail; +Converted to Docbook by &Mike.McBride; &Mike.McBride.mail; + + + + +
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 @@ + + + +]> + +
+ + + + + + +&Mike.McBride; &Mike.McBride.mail; + + + + +2002-02-12 +3.00.00 + + +KDE +KControl +Battery +level + + + + + +The Battery Monitor Panel + + + + +Introduction + +This panel controls whether or not a battery state icon appears +in &kde;'s panel. + +Once enabled a battery will appear in your docking bar as one of +3 icons - a battery with a red X through it +indicates that APM has not been installed (in +particular /proc/apm can't be read). + +The other two icons indicate the battery state - a +small plug with a bar beside it indicates your +batteries are charging - the height of the blue portion of the bar +indicate how full your batteries are. A small +battery in the dock indicates you are running on +batteries, the amount of blue in the battery indicates how full your +batteries are. + +If you left click on the docked icon a +pop-up will tell you how much time you have left in minutes. + +If you right 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. + +All features of Battery are configured from the Setup dialog. + + + +Use + +The configuration window can be divided into 3 parts. + + + +Show Battery Monitor +This controls whether or not the battery icon appears. This is +disabled by default. + + +Poll +This setting controls how often, in seconds, the battery is +updated. +The default is 20 seconds. + + +Icons +The battery monitor uses three icons to represent the three +states: No APM, Charging, and Not Charging. The icons shown are the large +icons. To select new ones, click on the buttons and a icon loader dialog will +pop up. +If you create your own icons - they will work with the battery +monitor - but be careful. +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. +The author does not claim to be a graphic artist and would love for +someone to donate some better looking icons to the cause. + + + + + + +Section Author +This section written by &Paul.Campbell; &Paul.Campbell.mail; +Converted to Docbook by &Mike.McBride; &Mike.McBride.mail; + + + + +
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 @@ + + + +]> + +
+ + + + +&Mike.McBride; &Mike.McBride.mail; + + + + +2002-10-16 +3.1 + + +KDE +KControl +Laptop +Power + + + + +Laptop Power Control + + +Introduction + +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. + +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. + + + +Use + +This panel configures the power-down feature of your laptop. It works as +a sort of extreme screen saver. +You can configure different timeouts and behavior depending on whether +your computer is plugged in or running on battery power. +For both the Powered and Not Powered, you should select one of the +following options: + +Standby - Puts your laptop into standby state +Suspend - Puts your laptop into suspend state +Off - Nothing happens at the specified time. + + +Below that, is a text box labeled Wait for. Enter +the time in minutes, that your computer should remain unused, before the laptop +is powered down. + + + +Section Author +This section written by &Paul.Campbell; &Paul.Campbell.mail; +Converted to Docbook by &Mike.McBride; &Mike.McBride.mail; + + + + +
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 @@ + +IRKick"> + KDE LIRC"> + + + + +]> + + + + +&irkick;: The KDE LIRC Server Handbook + + + +Gav +Wood + +
gav@kde.org
+ + + + + +2004-01-02 +1.0 + + +2004 +Gav Wood + + +&FDLNotice; + +&kdelirc; is the infrastructure for the KDE's +Infrared Remote Control functionality; &irkick; is the server +component of that infrastructure. + + +KDE +irkick +kdelirc +kcmlirc +lirc + + + + + +Introduction + + +&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. + + + +It has a configuration tool, which may be accessed either by the +KDE Control Center or directly from the menu of &irkick;. + + + +Requirements + + +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. + + + +For more information about LIRC, visit their website at http://www.lirc.org. + + + + + + +Using &irkick; + + +&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. + + + +Using the right-mouse-button menu, you can configure the KDE infrared remote +control framework. + + + + + +Credits and Licenses + +&kdelirc;: The KDE LIRC Framework Copyright (c) 2004 Gav Wood +gav@kde.org. + + + +&underFDL; +&underGPL; + + + + +Installation + +&install.intro.documentation; +&install.compile.documentation; + + + + + 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 @@ + +KDE LIRC Control Center Module"> + KDE LIRC"> + + + +]> + + + + +KDE Infrared Remote Control Configuration + + + +Gav +Wood + +
gav@kde.org
+ + + + + +2004-01-02 +1.0 + + +2004 +Gav Wood + + +&FDLNotice; + +&kdelirc; configuration: The infrastructure for the KDE's +Infrared Remote Control functionality. + + +KDE +irkick +kdelirc +kcmlirc +lirc + + + + + +Introduction + + + + + +Requirements + + +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. + + + +For more information about LIRC, visit their website at http://www.lirc.org. + + + + + + +Usage + + +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. + + + +Remote Controls and Modes + + +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. + + + +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. + + + +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. + + + + + +Action-Button Bindings + + +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). + + + +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. + + + +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. + + + +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. + + + + + +Loaded Extensions + + +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). + + + +By clicking on an entry you can see information on it such as the author's details. + + + + + + + +Credits and Licenses + +&kdelirc; KDE LIRC Framework Copyright (c) 2004 Gav Wood +gav@kde.org. + +Documentation Copyright (c) 2004 by Gav Wood +gav@kde.org. + +&underFDL; +&underGPL; + + + + +Installation + +&install.intro.documentation; +&install.compile.documentation; + + + + + 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 @@ + + + + + +]> + + + + +The &kdiskfree; Handbook + + + +&Jonathan.Singer; &Jonathan.Singer.mail; + + + +&Michael.Kropfberger; &Michael.Kropfberger.mail; + + + + + + + +2000-2002 +&Jonathan.Singer; + + +&FDLNotice; + +2003-09-16 +0. + +&kdiskfree; displays available file devices, along with +information about them. + + + + +KDE +kdf +kdeutils +disks +devices +mount +unmount + + + + + +Introduction + +&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. + +&kdiskfree; is similar to the &kcontrol; Disk-Free module , but takes up less screen +space. It is useful if you want to keep a &kdiskfree; window available at +all times. + + + + +Using &kdiskfree; + + +Starting &kdiskfree; + +Type kdf at a command +prompt or select Disk Free from the +System group in the K +menu. The standard &Qt; and &kde; command options are available, and +can be listed by entering kdf + at the command prompt. + + + + +The Main window + +The main &kdiskfree; window displays the available file devices. + +Normally, the following pieces of information are included: + +&kdiskfree; Screen + + + + + + &kdiskfree; Screen + + + + + +an icon depicting the type of storage +device name +filesystem type +total size +mount point +free disk space +the percentage of space used as a number and as a +graph. + + +In the picture above, four devices are shown: one reiserfs-formatted +hard drive partition mounted at the filesystem root (/), two &CD-ROM;'s, and a floppy drive. + +Left clicking on the header of a +particular column sorts the devices according to that variable. A +second left click sorts in the opposite +order. + +Clicking on a row pops up a menu. If that device is not +currently mounted, the Mount Device option +is available. If the device is mounted, it can be unmounted by +choosing Unmount Device. Selecting +Open in File Manager opens a new window with a +graphical view of the files on that device. + + + + +The &kdiskfree; menu bar + + +The <guimenu>File</guimenu> Menu + + + + + +File +Update + +Immediately updates the display to reflect the current +status + + + + + + +&Ctrl;Q + +File +Quit + +Closes &kdiskfree; + + + + + + +The <guimenu>Settings</guimenu> menu and dialog + + + + +Settings +Configure Shortcuts... + + +The standard &kde; dialog for setting shortcuts. + + + + + + +Settings +Configure KDiskFree... + + +Opens a configuration dialog. + +Configure &kdiskfree; Screen + + + + + + Configure &kdiskfree; Screen + + + + +This dialog has two tabbed windows, General Settings +and Mount Commands + + +General Settings Click on the word +visible or hidden to turn +display of an data field on or off. 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. The File Manager setting +controls the command executed when the Open +Filemanager pop-up menu item is selected. +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. + + + +Mount Commands +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 mount (type +man at the +command prompt). + + + + + + + + +The <guimenu>Help</guimenu> menu + +&help.menu.documentation; + + + + + + + +Credits and License + +&kdiskfree; + +Program Copyright © 1998-2000 &Michael.Kropfberger; &Michael.Kropfberger.mail; + +Documentation Copyright © 2000 &Jonathan.Singer; &Jonathan.Singer.mail; + +&underFDL; +&underGPL; + + + +&documentation.index; + + + diff --git a/doc/kdf/kdf.png b/doc/kdf/kdf.png new file mode 100644 index 0000000..737ec7c Binary files /dev/null and b/doc/kdf/kdf.png differ diff --git a/doc/kdf/kdf_config.png b/doc/kdf/kdf_config.png new file mode 100644 index 0000000..09c9c91 Binary files /dev/null and b/doc/kdf/kdf_config.png differ 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 @@ + + + + + +]> + + + +The &kedit; Handbook + + +ThadMcGinnis + +
ctmcginnis@compuserve.com
+ + + + +Lauri +Watts +
lauri@kde.org
 +Reviewer + + + +2003-09-16 +1.3 + +&FDLNotice; + +This Handbook describes &kedit;, a simple +text editor for &kde; + + +KDE +KEdit +text editor + + + +2000 +Thad McGinnis + + + + + +Introduction + +&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;, XEmacs or +Emacs. &kedit;'s functionality will +intentionally remain rather limited to ensure a reasonably fast +start. + + + + +Some Fundamentals + +&kedit; is very simple to use. Anyone that has used a text editor +should have no problems. + + +Drag and Drop + +&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. + + + + +Command Line Options + +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. + + +Specify a File + +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: + + +%kedit /home/myhome/docs/myfile.txt + + + + + +Specify a file on the Internet + +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: + + +%kedit ftp://ftp.kde.org/pub/kde/Welcome.msg + + + + + +Other Command Line Options + +The following command line help options are available + + + +kedit + +This lists the most basic options available at the command +line. + + + + +kedit + +This lists the options available for changing the way &kedit; +interacts with &Qt;. + + + + +kedit + +This lists the options available for changing the way &kedit; +interacts with &kde;. + + + + +kedit + +This lists all of the command line options. + + + + +kedit + +Lists &kedit;'s authors in the terminal window + + + + +kedit + +Lists version information for &Qt;, &kde;, and &kedit;. Also +available through kedit + + + + + + + + + +Key Bindings + +Many of the key bindings (shortcuts) are configurable by way of +the Settings menu. By default &kedit; +honors the following key bindings. + + + + + +Key Binding +Action + + + + + +Left Arrow +Move the cursor one character leftwards. + + + +Right Arrow +Move the cursor one character rightwards. + + + +Up Arrow +Move the cursor one line upwards + + + +Down Arrow +Move the cursor one line downwards. + + + +Page Up +Move the cursor one page upwards. + + + +Page Down +Move the cursor one page downwards. + + + +Backspace +Delete the character to the left of the cursor. + + + +Home +Move the cursor to the beginning of the line. + + + +End +Move the cursor to the end of the line. + + + +Delete +Delete the character to the right of the cursor. + + + +&Shift;Left +Arrow +Mark text one character leftwards. + + + +&Shift;Right +Arrow +Mark text one character rightwards. + + + +&Ctrl;A +Select all the text in the document. + + + +&Ctrl;B +Move the cursor one character leftwards. + + + + +&Ctrl;C +Copy the marked text to the clipboard. + + + +&Ctrl; +D +Delete the character to the right of the +cursor. + + + +&Ctrl;E +Move the cursor to the end of the line. + + + +&Ctrl;F +Search for text in the document. + + + +&Ctrl;G +Go to line. + + + + +&Ctrl;H +Delete the character to the left of the +cursor. + + + +&Ctrl;K +Create a new document + + + +&Ctrl; +N +Move the cursor one line downwards. + + + +&Ctrl; +P +Print. + + + +&Ctrl;V +Paste the clipboard text into the document at the text +cursor position. + + + + +&Ctrl;X +Cut the marked text, copying it to the +clipboard. + + + +&Ctrl; +Y +Yank (paste) the content of the kill-buffer (clipboard) +into the document, at the current cursor position. + + + + + + + + + + +The Menu Entries + + +The <guimenu>File</guimenu> Menu + + + + &Ctrl;N +FileNew + +This starts a new Document in a new instance of the +editor. + + + + + &Ctrl;O +FileOpen... + + +This command opens a file. It does this by means +of a dialog box which allows the user to navigate the file +system. + +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. + + 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 +*.txt then only files with the txt +extension would be visible in the selection window. + +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. + + + + +FileOpen +Recent + + + +This is a shortcut to open recently saved +documents. 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. + + + + +&Ctrl;S +FileSave + +This saves the current document. 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. + + +The editor can be configured to make a backup. + + +If it is the first save of a new document the save as dialog +(described below) will be invoked. + + + + + +FileSave +As... + +This allows a document to be saved with a new file +name. This is done by means of the file dialog box described +above in the Open section of this help +file. + + + + + +&Ctrl;P +FilePrint... + +This opens a simple print dialog allowing the user to +specify what, where, and how to print. The user can choose +between the standard lpr or a custom command as well +as whether to print the whole document or a selected section. + + + + + +FileMail... + +This is used to email the current document. It +calls a mail dialog whereby the user can enter the address and subject +for the message. + +You may set your preferred mail client in &kcontrol; + + + + + + &Ctrl;W +FileClose + +This will close the editor window, if you have +more than one instance of &kedit; running, those instances will not be +closed. + + + + + +&Ctrl;Q + +File +Quit + +This closes the editor. + + + + + + + +The <guimenu>Edit</guimenu> Menu + + + + &Ctrl;Z +EditUndo + +This is used to eliminate or reverse the most recent user +action or operation. + + + + + &Ctrl;&Shift;Z +EditRedo + +This will reverse the most recent change (if any) +made using Undo. + + + + + &Ctrl;X +EditCut + +This command deletes the current selection and places it +on the clipboard. The clipboard is a feature of &kde; that +works invisibly to provide a way to transfer data between +applications. + + + + + &Ctrl;C +EditCopy + +This copies the currently selected text to the clipboard +so that it may be pasted elsewhere. The clipboard is a feature +of &kde; that works invisibly to provide a way to transfer data between +applications. + + + + + &Ctrl;V +EditPaste + +This will insert the contents of the clipboard at the +cursor position. The clipboard is feature of &kde; that works +invisibly to provide a way to transfer data between applications. + + + + + +&Ctrl;A +EditSelect +All + +This will select the entire document. This could +be very useful for copying the entire file to another +application. + + + + + &Ctrl;F +EditFind... + +This opens the find dialog which is used to +specify the text to Find 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 Case +sensitive will limit finds to entries that match the case +(upper or lower) of each of the characters in the search +pattern. Find backwards directs the search to +proceed in an upwardly direction. + + + + + F3 +EditFind +Next + +This repeats the last find operation, if any, without +calling the find dialog box. + + + + + &Ctrl;R +EditReplace... + +This command opens the replace dialog box. The +replace dialog is similar to the above-mentioned find dialog but with +the addition of a Replace with: 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 Replace 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 Replace +All button should be used with caution as it will immediately +replace every instance of the specified text. + + + + + + +EditInsert +File... + +This opens the FileOpen dialog box whereby +the user can insert a complete file in the open +document. The file will be entered at the position of the +blinking text cursor. + + + + + + +EditInsert +Date + +This will enter the current date at the position of the +blinking text cursor. + + + + + + +EditClean +Spaces + +Choosing this item will remove from any selected +text any extra spaces and all carriage returns (the code for +the end of a paragraph brought about by pressing the +Enter key.) 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. + + + + + + +The <guimenu>Go</guimenu> Menu + + + + + +&Ctrl;G +GoGo to +Line... + +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. 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. + + + + + + +The <guimenu>Tools</guimenu> Menu + + + + +ToolsSpelling... + +This initiates the spell checking program - a program +designed to help the user catch and correct any spelling +errors. 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: + + + +Misspelled word: + +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. + + + + +Replacement: + + 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. + + + + +Suggestions: + +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 +Replacement: box, above. + + + + +On dialog box are 8 buttons that allow the user to control the +spell check process. They are: + + + +Replace + +This button has the checker replace the word under consideration +in the document with the word in the Replacement: +box. + + + + +Replace All + +This button causes the checker to replace not only the current +Misspelled Word: but to automatically make the same +substitution for any other occurrences of this Misspelled +Word: in the document. + + + + +Ignore + +Activating this button will have the checker move on without +making any changes. + + + + +Ignore All + +This button tells the checker to do nothing with the current +Misspelled Word: and to pass over any other +instances of the same word. + + +This only applies to the current spell check run. If the checker +is run again later it will stop on this same word. + + + + + +Add + +Pressing this button adds the word in the Misspelled +Word: box to the checker's dictionary. This means that in the +future the checker will always consider this word to be correctly +spelled. + + + + +Help + +This invokes the &kde; help system starting at the &kedit; help +pages (this document). + + + + +Stop + +This button stops the spell check process. + + + + +Cancel + +This button cancels the spell check process. + + + + +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. + + +A numerical display of the spell check process is simultaneously +displayed in the status bar of the editor. The status bar is the horizontal strip at +the bottom of the editor just outside of the text entry area. + + + + + + + + +The <guimenu>Settings</guimenu> Menu + + + + +SettingsShow +Toolbar + +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. Clicking on the striated grip +will hide or unhide the bar. Clicking and dragging on this grip allows +the user to move the bar. + + + + + +SettingsShow +Statusbar + +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. + + + + + +SettingsSave +Settings + +This saves the current editor settings to be used for +future documents. + + + + + +SettingsConfigure +Shortcuts... + +This command opens a dialog box whereby the key bindings 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 None, +Default, and Custom. + + +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 +default shortcut.) + + + +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 K key on the +keyboard. This would mean that anytime he or she held down the &Ctrl; +and &Alt; buttons and pressed K (while using &kedit;) +the About &kde; display box would be called. + + + + + +SettingsConfigure +Toolbars... + + +This will open the dialog whereby the toolbar +configuration may be changed. 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. + + + + + +SettingsConfigure KEdit... + +This menu item opens a dialog whereby several different settings may be adjusted. + + + + + + + +The <guimenuitem>Help</guimenuitem> Menu + +&help.menu.documentation; + + + + + +The Preferences Dialog + +Selecting +SettingsConfigure +KEdit 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 +Help system, set the options to their +Default values, accept the current settings and +close the dialog by means of the OK button, +Apply the current choices to the document without +closing the dialog, or Cancel the process. The +categories Font, Color, +Spelling, and Miscellaneous +are detailed below. + + +Font + +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: + + + + +Font: + +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. + + + + +Font style: + +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. + + + + +Size: + +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. + + + + + + + + +Color + +This section provides access to two different color settings, +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. + +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 HTML: This +shows the user the color code that would be used to specify the +particular displayed color in HTML code which is +widely used for web pages. + +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. + +Furthermore the user has the option of adding any color to a +personal palette of Use custom colors by clicking on +the wide button labeled Add to Custom Colors +(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. + + + +Use custom colors + +By default &kedit; will use your system color scheme. If this +is enabled, you may choose a Foreground and background color below. + + + + +Foreground color: + +Here the user can specify a color for the text used in +&kedit;. + + + + +Background color: + +Here the user can specify a color for the general background of +&kedit;. + + + + + + + + +Spelling + +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. + + + +Create root/affix combinations not in +dictionary + +Selecting this option allows the spell checker to register as +correct combinations of root words with suffixes or +prefixes even if the particular combination is not listed in its +dictionary database of words. + + + + +Consider run-together words as spelling +errors + +Selecting this will cause the spell checker to register as +misspelled two or more correctly spelled words that are +run-together, &ie;, that do not have spaces separating +them. + + + + +Dictionary: + +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. + + + + +Encoding: + +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. + + + + +Client: + +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. + + + + + + + +Miscellaneous + +This category deals with three different properties detailed +below. + + + +Word wrap: + +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: + + + +Disable Wrapping + +Choosing this will keep the editor from doing any wrapping. The +user will have to start new lines manually (with the +Enter key.) + + + + +Soft wrapping + +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. + + + + +At specified column + +Choosing this activates a text box immediately below, labeled +Wrap column:. Here the user may specify the +maximum number of characters in a line of text. + + + +Each character including spaces fills one column. + + + + + + + + + +Make backup when saving a +file + +This check box tells the editor to rename the last saved version of +the current document before carrying out a save +command. The editor does this by adding a tilde (~) 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. + + + + + + + + + +Credits and Licenses + +&kedit; Copyright 2000 by Bernd Johannes Wuebben +wuebben@math.cornell.edu + +Documentation Copyright 2000 by Thad McGinnis +ctmcginnis@compuserve.com. + +This version of the &kedit; Handbook is based on the original by: +Bernd Johannes Wuebben wuebben@math.cornell.edu + + + +&underFDL; +&underGPL; + + + + +Installation + +&install.intro.documentation; +&install.compile.documentation; + + + + + + 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 @@ + + + + + + BSD"> + Minix"> +]> + + + + + + + + +The &kfloppy; Formatter Handbook + + + +Thad +McGinnis +
ctmcginnis@compuserve.com +
 + + +Nicolas +Goutte +
goutte@kde.org +
 + + +Bernd +Johannes +Wuebben +
wuebben@math.cornell.edu
 +Developer + + + +Chris +Howells +
howells@kde.org
 +Developer (User Interface re-design) + + + +Adriaan +de Groot +
groot@kde.org
 +Developer (Add BSD support) + + + +Lauri +Watts +Reviewer +
lauri@kde.org
 + + + + + +2005-06-01 +3.5 + + +2000 +Thad McGinnis + + + +2005 +Nicolas Goutte + + +&FDLNotice; + +&kfloppy; Formatter is a utility that provides a +straightforward graphical means to format 3.5" and 5.25" floppy +disks. + + +KDE +kfloppy +floppy +format + + + + + +Introduction + +&kfloppy; Formatter is a utility that provides a straightforward +graphical means to format 3.5" and 5.25" floppy disks. + +&kfloppy; depends on external programs and therefore +currently works only with &Linux; and &BSD;. Depending if you are +using &kfloppy; on &Linux; or on &BSD;, &kfloppy; has slightly different +features. + +Make sure that your floppy disk is not +mounted. &kfloppy; cannot format a mounted floppy disk. + + + + +Using &kfloppy; + +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. + +Make sure that your floppy disk is not +mounted. &kfloppy; cannot format a mounted floppy disk. + + +Control Settings + +The settings are chosen by means of three drop down boxes located +at the top left center of &kfloppy;. + + +Floppy Drive + +Clicking on the top drop down box, which is labeled +Floppy drive:, offers the user the following +two choices: + + +Primary +Secondary + + +Clicking on the second drop down box from the top, which is labeled +Size:, offers the user the following +four choices: + + +3.5" 1.44MB +3.5" 720KB +5.25" 1.2MB +5.25" 360KB + + +The &Linux; version of &kfloppy; has also a choice of size named: + + +Auto-Detect + + + + +The 800KB disk format used by &Mac; floppy drives cannot be +supported on PC floppy drives since they are not capable of formatting +disks in that fashion. + + + + +<guilabel>File Systems</guilabel> + +The third drop down box, labeled File System, offers the user the +following choices, if they are applicable: + + + +Dos + +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;.) + + + + +ext2 + +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;.) + + + + +UFS + +This selection will have &kfloppy; place the type of file system +on the diskette which is most commonly used with FreeBSD. The user will +likely want to choose this system if he or she will only be using the +floppy disk with FreeBSD. +(This is supported for &BSD; only.) + + + + +Minix + +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.) + + + + + + + + +Formatting Options +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. 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.The +bottom two options are for labeling the diskette. All are explained +below: + + +Formatting Method +&kfloppy; can format a disk in the following two ways: + + + +Quick Format + +This simply puts the new file system on the disk. +All data on the disk will be lost, even if the data itself will not erased. + + + +Zero out and quick format + +This format first puts zeros on the disk and then creates the new file system. +All data on the disk will be erased. + + + +Full Format + +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. +All data on the disk will be erased. + + + + + + + +Verify Integrity + +This tells &kfloppy; to check that the formatting was correctly +written to the floppy. This allows bad sectors to be identified. + + +If bad sectors a found during the verify phase of a Full Format, +the formatting is aborted and the file system is not written! + + + + + +Volume Label + +The bottom two features allow the user to add (or change) a +label to the diskette. If the Volume label: 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. + +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. + +The file system &Minix; cannot have any volume label. In this +case, &kfloppy; will ignore the volume label. + + + + + + +The Buttons +There are three buttons located vertically along the right side of +&kfloppy;. + + + +Format + +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;. + +The upper box is a status indicator that gives information about the +process underway, especially the error encountered during the processing. + +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. + +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%. + + +Make sure that your floppy disk is not mounted. +&kfloppy; cannot format a mounted floppy disk. + + +&kfloppy; does not unmount the +floppy by itself, as this could mean that the user may overwrite a floppy +disk with important data on it. + + + + +Help + +This invokes the &kde; help system starting at the &kfloppy; help pages +(this document). + + + + +Report Bug + +Report a problem to the &kde; team. + + + + +About KFloppy + +This displays version and author information of &kfloppy;. + + + + +About KDE + +This displays version and author information of KDE. + + + + + +Quit + +Clicking on this button will close &kfloppy;. + + + + + + + + + +Command line options + +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: + + + +kfloppy +This lists the most basic options available at the command +line. + + + + +kfloppy +This lists the options available for changing the way +&kfloppy; interacts with &Qt;. + + + + +kfloppy + +This lists the options available for changing the way &kfloppy; +interacts with KDE. + + + + +kfloppy + +This lists all of the command line options. + + + + +kfloppy + +Lists &kfloppy;'s author in the terminal window + + + + +kfloppy + +Lists version information for &Qt;, &kde;, and &kfloppy;. Also available +through kfloppy + + + + + + + +Credits and Licenses + + + +&kfloppy; Formatter Program Copyright 1997 - 2000 Bernd Johannes Wuebben +wuebben@math.cornell.edu + +&kfloppy; Formatter Program Copyright 2002 Adriaan de Groot +groot@kde.org + +&kfloppy; Formatter Program Copyright 2004, 2005 Nicolas Goutte +goutte@kde.org + +Documentation Copyright 2000 by Thad McGinnis +ctmcginnis@compuserve.com. + +Documentation Copyright 2005 by Nicolas Goutte +goutte@kde.org. + +This version of the &kfloppy; Handbook is based on the original by +David Rugge davidrugge@mindspring.com + +&underFDL; +&underGPL; + + + + +Needed External Programs + +As already written earlier in this handbook, &kfloppy; works +with the help of external programs to do the different formatting tasks. + +If one of the programs is missing, &kfloppy; tries to work nevertheless. +However the corresponding option will not be available. + + + +fdformat +This program is needed for low-level formatting, +on &Linux; and on &BSD;. If it is missing, +Full format will be disabled. + + + +dd +This program is needed for zeroing-out, +on &Linux; and on &BSD;. If it is missing, +Zero out and quick format will be disabled. + + + +mkdosfs +This program is needed for DOS formatting, +on &Linux;. + + + +newfs_msdos +This program is needed for DOS formatting, +on &BSD;. + + + +newfs +This program is needed for UFS formatting, +on &BSD;. + + + +mke2fs +This program is needed for ext2 formatting, +on &Linux; and on &BSD;. + + + +mkfs.minix +This program is needed for &Minix; formatting, +on &Linux;. + + + + + + +User-Given Devices + + +Introduction + +"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 floppy drive. + +This feature is mainly intended as a work-around for users having +USB floppy drives of any kind +(including ZIP disk drives) or any other non-legacy +floppy drives. + +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 +floppy drive might change between reboots.) + +As this feature was developed under &Linux;, the &BSD; version +of &kfloppy; offers less choices than &kfloppy; under &Linux;. + + + + +Using It + + +Using "User Given Devices" is quite simple, you just need to enter +a device name, for example /dev/sdz4 +in the Floppy drive: combobox instead of +selecting Primary or Secondary. + + +You need to enter the /dev/ +part of the device for two reasons: + + +It is how &kfloppy; recognizes the "User Given Devices" mode. + + +It is a security, to avoid that the user writes anything in the combobox +that is by change a device name. + + + + +Unfortunately, using any device instead of a floppy device has a few +consequences. The major one is that Full Format cannot be +selected anymore. Doing so will result in a error message box when trying to +start the format. However you can use Zero out and quick format +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. + +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 +floppy drive 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.) + +Even if you can specify a floppy device like +/dev/fd0u2880, &kfloppy; will refuse to make a +Full Format on it. + +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). + +When you are ready to format, click on the Format +button as usual. You will get a message box asking you to verify the device name. + + +This is the last chance to check the device name before formating. +After it, it is too late. + + + + + + + + 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 new file mode 100644 index 0000000..f435ac8 Binary files /dev/null and b/doc/kgpg/editor.png differ 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 @@ + +Kgpg"> + + + + +]> + + + + +The &kgpg; Handbook + + + +Jean-Baptiste +Mardelle + +
bj@altern.org
+ + + + + + + + +2002 +Jean-Baptiste Mardelle + + +&FDLNotice; + +2002-03-01 +0.02.00 + + + +&kgpg; is a simple graphical interface for GnuPG (http://gnupg.org) + + + + +KDE +Kgpg +encryption +gpg +pgp +security + + + + + +Introduction + + +&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 http://gnupg.org. + +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 gnupg's web site. + + +With &kgpg;, you don't need to remember gpg's command lines and options. Almost everything can be done with a few mouse clicks. + + + + +Getting Started + +Here is a list of &kgpg;'s main components: + + + + +System Tray Icon + + + +&kgpg; system tray applet + + + + + + + +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. + + + + + + +Key Manager Window + + + +Key manager window + + + + + + +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. + + + + + +Editor Window + + + +Editor window + + + + + + +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. + + + + + + +Konqueror Integration + + +&kgpg; is integrated in &konqueror;. It means that when you right click on a file, you can choose + ActionsEncrypt +File to encrypt a file. You can decrypt a file with a &LMB; click. + + + + + + + + + +Using &kgpg; + + +There are two ways to encrypt your data: + +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. +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. + + +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. + + +Generating a key + +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 +KeysGenerate Key +Pair. + + +Key generation dialog + + + + + + +Simply enter your name, Email address and click +Ok. 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. + + + + +Encrypting Your Data + + + +Encrypting a File From &konqueror; + +Click on the file you want to +encrypt with the &RMB;. Choose ActionsEncrypt +File in the pop up +menu. You will then be prompted with the Public key selection +dialog. Choose the key of the recipient and click Encrypt. The +encrypted file will be saved with a .asc or .gpg extension depending on whether you +chose ASCII encryption or not. + + + + +Encrypting a File or Text With &kgpg;'s Applet + +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 +Encrypt clipboard item in applet +menu. + + +Here's a screen shot of the key selection window + + + + + + +For more information on the encryption options ASCII +armor, Allow encryption with untrusted keys and +Symmetrical encryption, please refer to gpg's +documentation or man pages. + + + + +Encrypting Text From &kgpg;'s editor + +This is as simple as clicking on the +Encrypt button. You will then be prompted with +the Public key selection dialog. Choose your key and click +Encrypt again. The encrypted message will +appear in the editor window. + + + + + +Decrypting Your Data + + + +Decrypting a File From &konqueror; +Left 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 +FileDecrypt +File and choose a file to decrypt. + + + + +Decrypting Text or a File With the &kgpg; applet + +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 decrypt clipboard menu +entry of the &kgpg; applet + + + + +Decrypting a text from the editor + +Copy or Drag and Drop the text you want to decrypt, and click on +the Decrypt button. You will be prompted for the +passphrase. + + + + + + +Key Management + +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 right click on a key. +To import/export public keys, you can use drag +and drop or the Copy/Paste keyboard shortcuts. + + +Here's a screen shot of key management + + + + + + + + + +Configuring &kgpg; + +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. + + +Here's a screen shot of the option dialog + + + + + + + + + + + + + +Credits and License + + +&kgpg; + + +Program copyright © 2002-2003 Jean-Baptiste Mardelle +bj@altern.org. + + + +&underFDL; +&underGPL; + + + +&documentation.index; + + + + + + diff --git a/doc/kgpg/keygen.png b/doc/kgpg/keygen.png new file mode 100644 index 0000000..6bad563 Binary files /dev/null and b/doc/kgpg/keygen.png differ diff --git a/doc/kgpg/keymanage.png b/doc/kgpg/keymanage.png new file mode 100644 index 0000000..4dcd05b Binary files /dev/null and b/doc/kgpg/keymanage.png differ diff --git a/doc/kgpg/keys.png b/doc/kgpg/keys.png new file mode 100644 index 0000000..5977ddc Binary files /dev/null and b/doc/kgpg/keys.png differ diff --git a/doc/kgpg/kicker.png b/doc/kgpg/kicker.png new file mode 100644 index 0000000..359b143 Binary files /dev/null and b/doc/kgpg/kicker.png differ diff --git a/doc/kgpg/options.png b/doc/kgpg/options.png new file mode 100644 index 0000000..40a2776 Binary files /dev/null and b/doc/kgpg/options.png differ 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 @@ + + + + + +]> + + + +The &khexedit; Handbook + + + +Jonathan +Singer + +
jsinger@leeta.net
+ + + + +Espen +Sand + +
espensa@online.no
+ +Developer + + + +Lauri +Watts + +
lauri@kde.org
+ +Reviewer + + + + + + +1999-2000 +Jonathan Singer + + +&FDLNotice; + +2001-07-06 +0.08.05 + +&khexedit; is a hexadecimal editor for the &kde; +environment. + + +KDE +Kapp +edit +binary +hexadecimal + + + + +Introduction + +&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. + + + + +Starting &khexedit; +Type khexedit at a command +prompt or select Binary Editor from the +Utilities group in the KDE start +menu. + +The standard &Qt; and &kde; command line +options are available, and can be listed by entering +khexedit . + +Other command line options are: + + - open the +specified file + + +<offset> jump to position +<offset> in the opened file. + + + + +&khexedit; In A Nutshell + +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. + + +&khexedit; Screen + + + + + + &khexedit; Screen + + + + +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 Insert 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 +View menu. + +The offset column on the left indicates the position of a particular byte +in the file. The text field on the right displays the ASCII +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. + +The search bar allows the user to search for a specific value -- +hexadecimal, octal, binary, decimal or text. + +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. + +Multiple documents can be open at the same time but only one can be +active. Use the Documents menu to select which document will +be active. + + + + +Menu Commands + +Note that most menu commands also have a keyboard shortcut. + + +<guimenu>File</guimenu> Menu + + + + + +&Ctrl;N + +File +New + +Open a new file. + + + + + +&Ctrl;O + +File +Open... + +Open an existing file. + + + + + +&Ctrl;I + +File +Insert... + +Insert an exiting file in the current +document. + + + + +File +Open Recent + +Choose from a list of the last opened +files. + + + + +File +Revert + +Return edited document to the last saved +state. + + + + + +&Ctrl;S + +File +Save + +Save document. + + + + +File +Save As... + +Save document with a new name. + + + + + +&Ctrl;W + +File +Close + +Close the current document. + + + + + +&Ctrl;P + +File +Print... + +Print the current document. + + + + +File +Export... + +Export the selected document or a portion of +it.Opens a dialog box with these options: + + +Format +Plain text, HTML table, rich text +format, C array. Use the Options tab to select +details for a C array or an HTML table. + + +Destination +The file to which the data will be +exported + + +Export Range +Selects which data will be exported -- the entire document, the +selected portion or the range between two specified +offsets. + + + + + + +File +Cancel Operation + +Stop the current operation + + + + +File +Permissions + +Set write privileges: + + + +Read only +When set, changes may not be made to the displayed +file. + + +Allow Resize +When off, individual bytes may be edited but the total number of +bytes may not be changed. + + + + + + + +File +New Window + +Open an additional &khexedit; +window + + + + +File +Close Window + +Close the current &khexedit; +window + + + + + +&Ctrl;Q + +File +Quit + +Close all &khexedit; windows + + + + + + +<guimenu>Edit</guimenu> Menu + + + + + +&Ctrl;Z + +Edit +Undo + +Undo the last action. + + + + + +&Ctrl;&Shift;Z + +Edit +Redo + +Redo the last undone action. + + + + + +&Ctrl;X + +Edit +Cut + +Delete the selected bytes and copy them to the +clipboard. + + + + + +&Ctrl;C + +Edit +Copy + +Copy the selected bytes to the +clipboard. + + + + + +&Ctrl;V + +Edit +Paste + +Insert the cut or copied bytes in the +clipboard. + + + + +Edit +Special + +Variations on Copy and +Paste: + +Copy as Text: Copies +the selected bytes as ASCII characters. +Paste into New +File. +Paste into new +window. + + + + + + + +&Ctrl;A + +Edit +Select All + +Select entire document. + + + + +Edit +Unselect + +Unselect entire document. + + + + + +&Ctrl;F + +Edit +Find... + +Find a specified pattern in the document. +Hexadecimal,decimal, octal, binary or text patterns can be searched for. +Options in the dialog box allow you to specify the starting point, +direction and range of the search. + + + + + +F3 + +Edit +Find Next + +Find the next instance of the +Find pattern. + + + + + +&Shift;F3 + +Edit +Find Previous + +Find the previous instance of the +Find pattern. + + + + + +&Ctrl;R + +Edit +Replace... + +Replace the find pattern with a different +pattern. + + + + + +&Ctrl;G + +Edit +Goto Offset... + +Move the cursor to a specified +offset. + + + + + +&Ctrl;Ins + +Edit +Insert Pattern... + +Insert a specified string of bytes. +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. +If Repeat pattern is checked, the specified pattern +will be inserted repeatedly to reach the length set in +Size. + + + + + +<guimenu>View</guimenu> Menu + + + + +ViewHexadecimal +ViewDecimal +ViewOctal +ViewBinary +ViewText + +The first five choices select the format displayed in the data +editor window: hexadecimal, decimal, octal, binary or text. When text +display is selected, the extra text field is not displayed. + + + + +View +Show Offset Column + +Toggles display of offset column on and +off. + + + + +View +Show Text Field + +Toggles display of text field on and +off. + + + + +View +Offset as Decimal + +When set, all offsets are displayed and interpreted as +decimal numbers rather than as hexadecimals. + + + + +View +Upper Case (Data) + +When set, hexadecimal digits in the data are displayed +in upper case. + + + + +View +Upper Case (Offset) + +When set, hexadecimal digits in the offset value are +displayed in upper case. + + + + +View +Document Encoding + +Select the encoding used for display in the text field. +Alternative encodings like EBCDIC and 7-bit +ASCII can be used. Additional encodings can be added by the +user (not implemented yet.) + + + + + + +<guimenu>Bookmarks</guimenu> Menu + + + + + +&Ctrl;B + +Bookmarks +Add Bookmark + +Bookmark a location within the document. +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 +Bookmarks menu when a document is selected. Choose a bookmark +from the menu to go to it. + + + + + +&Ctrl;E + +Bookmarks +Replace Bookmark + +Reset an existing bookmark to the current cursor +location. A dialog will be opened with the list of available bookmarks; +select the one you wish to change. + + + + + +&Ctrl;U + +Bookmarks +Remove Bookmark + +Remove an existing bookmark. A dialog will be +opened with a list of available bookmarks; select the one you wish to +remove. + + + + +Bookmarks +Remove All + +Clear the bookmark list. + + + + + +&Alt;Down + +Bookmarks +Goto Next Bookmark + +Move the cursor to the next +bookmark. + + + + +&Alt;Up + +Bookmarks +Goto Previous Bookmark + +Move the cursor to the previous +bookmark. + + + + + +<guimenu>Tools</guimenu> Menu + + + + +Tools +Extract Strings... + +Locate ASCII strings in the data. Minimum +string length, case sensitivity and a pattern to match can be +specified. + + + + +Tools +Binary Filter... + +Perform a binary operation on the data. 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. + + + + +Tools +Character Table + +Open a list of values and their ASCII +equivalents and insert the selected value at the +cursor. + + + + +Tools +Converter + +Enter a value in any of the fields and see its +equivalent in hexadecimal, decimal, octal, binary or text. A check box +allows viewing of the value at the cursor instead. + + + + +Tools +Statistics + +Display the frequency of occurrence of values in the +document. + + + + + + +<guimenu>Documents</guimenu> Menu + +Provides a list of the open documents. Selecting one makes it +active. + + + + +<guimenu>Settings</guimenu> Menu + + + + +Settings +Show Toolbar + +Toggle display of the toolbar below the +menu bar. + + + + +Settings +Show Statusbar + +Toggle display of the status bar + + + + +Settings +Show Full Path + +Toggle display of the full file path in the +titlebar + + + + +Settings +Document Tabs + +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. + + + + +Settings +Conversion Field + +Change display of the value conversion field. +It can be embedded in the main window, made a floating window or +hidden. + + + + +Settings +Searchbar + +Change display of the value search bar. It can be +displayed above or below the editor window, or hidden. + + + + +Settings +Save Options + +Save the current state of the +options. + + + + +Settings +Preferences... + +Change these settings: + + +Layout +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. + + +Cursor +Blink rate and shape of the cursor. Behavior of the cursor when +the window loses focus. + + +Font +Font name, style and size. Character used to display +non printing +characters in the text field. + + +Colors + 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. + + +Files +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 Recent +Documents list on exit. The Recent Documents list can +also be cleared in this dialog. + + +Miscellaneous +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. + + + + + + + + + +<guimenu>Help</guimenu> Menu + +&help.menu.documentation; + + + +Toolbar +The toolbar contains icons for the following commands: + +(Except for Drag document and +Toggle write protection, all behave identically to the menu +command.) + + +Drag document -- Click this button and drag +to a text editor or a new &khexedit; window. +New +Open +Revert +Save +Print +Find +Find Next +Find Previous +Cut +Copy +Paste +Undo +Redo +Cancel Operation +Help + + +..and at the right of the toolbar.. +Toggle write protection - switch between read-only and +read/write modes. + + +Search bar + +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 Find button. Check the +Backwards box to search backwards from the cursor point or +check Ignore case for a case-insensitive text search. Click +the button on the right of the bar (X) to hide the search bar; +go to Searchbar in the Settings +menu to restore it. + + + + +Conversion field + +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: + + + +Show little endian decoding +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) + + + +Show unsigned as hexadecimal +When checked, causes unsigned types to be displayed in +hexadecimal, rather than decimal format. + + + +Stream length +Determines the number of bits used to calculate the values in +the fields above it. + + + + + + +Status Bar + +The status bar displays the following information: + + + +Encoding/Selection +When there is +no selection, this field shows the encoding option used. (See View +Document Encoding for more +information on encoding.) The start point and the length of the selection are +shown. + + + + +File Modified +A ! in this box indicates the +current file was modified. + + + +Insert/Overwrite +Indicates whether values entered at the keyboard are +inserted at the cursor point (INS) or overwrite the +existing data starting at the cursor(OVR). Use the +Insert key to toggle between the two modes. + + + +Size +Displays the total size of the current +document. + + + +Offset +Indicates the position of the cursor within the +document. + + + +Display mode +Indicates whether data editor window is displaying values in +hexadecimal, octal, binary, decimal or text mode. Switch between modes with +the View menu. + + + +Write Protection +Indicates whether the document can be edited +(RW) or is being viewed read-only +(R). Switch between modes with the button on the far-right +of the toolbar or the Permissions command in the +File menu. + + + + + + + + + + +Credits and License + + +&khexedit; + + +Program copyright 1999-2000 Espen Sand +espensa@online.no + +Contributors: + + +Leon Lessing leon@irlabs.com +Craig Graham +c_graham@hinge.mistral.co.uk +Dima Rogozin +dima@mercury.co.il +Edward Livingstone-Blade +sbcs@bigfoot.com + + +Documentation copyright 2000 Jonathan Singer +jsinger@leeta.net + + +&underFDL; +&underGPL; + + + + + +Compilation and Installation + +&install.intro.documentation; +&install.compile.documentation; + + + +&documentation.index; + + + diff --git a/doc/khexedit/khexedit1.png b/doc/khexedit/khexedit1.png new file mode 100644 index 0000000..9a61bdc Binary files /dev/null and b/doc/khexedit/khexedit1.png differ 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 @@ + + + +]> + +
+ + + + +Mike +McBride + + + + +2002-02-12 +3.00.00 + + +KDE +KControl +Block Devices +Disk space + + + + +Block Devices + + +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. + + + +Normally, the following pieces of information are shown in this tab: + + + +an icon depicting the type of storage +file format +total size +mount point +free disk space +the percentage of space used as a number and as a +graph. + + + +Left clicking on the header of a particular +column sorts the devices according to that variable. A second +left click sorts in the opposite order. + + + +Right clicking on a row pops up a menu. If +that device is not currently mounted, the Mount +device option is available. If the device is mounted, it +can be unmounted by choosing Unmount +device. Selecting Open +filemanager opens a new window with a graphical view of +the files on that device. + + + +The appropriate mount and unmount commands, and how the file manager is +opened from the context menu, can be configured from the &kdiskfree; +application. + + + +Section Author + +This section is modified from the kdf +documentation which was authored by Jonathan Singer +jsinger@leeta.net + +Modified for KDE 2.0 by Mike McBride +mpmcbride7@yahoo.com + + + + +
+ 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 @@ + + + + + + +]> + + + +The &kjots; Handbook + + + +Matt +Johnston + +
matt.kde@caifex.org
+ + + + +Christoph +Neerfield + +
Christoph.Neerfield@home.ivm.de
+ +Developer + + + +Lauri +Watts + +
lauri@kde.org
+ +Reviewer + + + + + + +2000 +Matt Johnston + + +&FDLNotice; + +2004-10-17 +0.05.00 + +This handbook describes how to use &kjots; 0.5, a small +program which is handy for keeping miscellaneous +notes. + + +KDE +KJots +kdeutils +notes +organizer + + + + + +Introduction + +&kjots; is a small program that helps you to write down some short +notes and organizes them for you. + + + + +Using &kjots; + +&kjots; has two basic items used to organize your notes - +Books and Pages. + +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. + + +Using Books + +To create a new book, use &Ctrl;&Shift; +N or the menu entry +FileNew +Book, and you will be prompted to enter a +name for the new book. + +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 +Bookmarks, use &Ctrl; +B or the menu entry +BookmarksAdd Bookmark +. You can even organize your bookmarks in separate folders +just as you probably do in &konqueror;. + +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. + + +Maybe you have noticed that there is no Save 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. + +You can also export an entire book as a text file or as a html file, +using File Export book... +. 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: + +############ +# 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. + +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. + + + +Using Pages + +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. + +To create additional pages, you can use &Ctrl; +N or the menu entry +FileNew Page +, which will create a new page. Similarly, the current page +can be removed using File +Delete Page. + +If you need to insert the current date and time while you are +writing a note, you can use &Ctrl;I +. + +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: &Ctrl;M. + +An other way of renaming the page is by selecting a part of your note +and then press &Ctrl;T, +the selected text will instantly become the title of the page. + +If you want fast access to a particular page, you +can assign a keyboard shortcut to that page. Go to +SettingsConfigure Shortcuts... +. + + + + +Command Reference + + +The <guimenu>File</guimenu> Menu + + + + + +&Ctrl;N + +File +New Page... + +Creates a new Page. + + + + + +&Ctrl;&Shift;N + +File +New Book... + +Creates a new Book. + + + + +File +Export Page + +Saves the current page to a text file +or a html file. + + + + +File +Export Book + +Saves the current book to a text file +or a html file. + + + + +File +Delete Page + +Deletes the current page. + + + + +File +Delete Book + +Deletes the current book. + + + + + +&Ctrl;P + +File +Print + +Prints the current book or page. + + + + + +&Ctrl;Q + +File +Quit + +Quits &kjots;. + + + + + +The <guimenu>Edit</guimenu> Menu + + + + + +&Ctrl;X + +Edit +Cut + +Cuts the currently selected +text in the main textbox and places it on the clipboard. + + + + + +&Ctrl;C + +Edit +Copy + +Copies the currently selected +text in the main textbox and places it on the clipboard. + + + + + +&Ctrl;V + +Edit +Paste + +Pastes text from the clipboard +to the main textbox. + + + + + +&Ctrl;T + +Edit +Paste as Page Title + +Renames the page to the text on the +clipboard. + + + + + +&Ctrl;F + +Edit +Find... + +Searches for text in the main +textbox. Note that this only searches the current page. + + + + + + +F3 + +Edit +Find Next + +Searches for the next occurrence +of the search text (specified with Find). + + + + + +&Ctrl;R + +Edit +Replace... + +Replaces one bit of text with another, +only on the current page. + + + + + + +&Ctrl;M + +Edit +Rename... + +Gives the possibility to rename the +current page. + + + + + +&Ctrl;I + +Edit +Insert Date + +Inserts the date and time in the +current page. + + + + + +The <guimenu>Bookmarks</guimenu> Menu + + + + + +&Ctrl;B + +Bookmarks +Add bookmark + +Adds the current page to the list of +bookmarks. See Using Books. + + + + + +Bookmarks +Edit bookmarks + +Edits the bookmarks. Here you can +search bookmarks, make comments, organize them in different folders and +much more. + + + + + +Bookmarks +New Bookmark Folder + +Makes a new folder where you can store +your bookmarks. + + + + + + +The <guimenu>Settings</guimenu> Menu + + + + +Settings +Hide/Show Toolbar + +Toggles display of the toolbar below the +menu bar. + + + + +Settings +Configure Shortcuts... + +Choose shortcut keys for various +menu items. + + + + +Settings +Configure Toolbars... + +Choose which items are present in the +toolbar. + + + + +Settings +Configure KJots... + +Configure options for &kjots;, including +the font to use and the settings for autosaving. + + + + + + + +The <guimenu>Help</guimenu> Menu + +&help.menu.documentation; + + + + + + + +Credits and License + + +&kjots; + + +Program copyright 1997 Christoph Neerfeld Christoph.Neerfeld@home.ivm.de + + +Based on the jots program included in the tkgoodstuff package. +The tkgoodstuff package is +copyright 1995-96 Mark Crimmins markcrim@umich.edu + + + +Documentation copyright 2000 Matt Johnston matt.kde@caifex.org + + +Some parts taken from documentation copyright 1998 Christoph Neerfeld +Christoph.Neerfeld@home.ivm.de + +&underFDL; + +&underGPL; + + + + +Installation + + +How to obtain &kjots; + +&install.intro.documentation; + + + + +Requirements + +In order to successfully use &kjots;, you need &kde; 2.x. There are +no other requirements. + + + + +Compilation and Installation + +&install.compile.documentation; + + + + +Configuration + +&kjots; is a nice small program, and you don't have do do anything +before running it. + + + + + +&documentation.index; + + + 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 @@ + + + + + +]> + + + + +The &ksim; Handbook + + + + + + + +
+ + + + + +&FDLNotice; + +2001-01-20 +0.00.00 + + + +&ksim; is part of the kdeutils package. + + + + + +KDE +kdeutils +ksim + + + + + +Introduction +The documentation for &kappname; was not finished when &kde; was installed on this computer. +If you need help, please check The KDE Website for updates, or by submitting your question to The &kde; User Mailing list. +The &kde; Team + +&underFDL; +&underGPL; + + + +&documentation.index; + + + 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 @@ + + + + + +]> + + + + +The &ktimer; Handbook + + + + + + + +
+ + + + + +&FDLNotice; + +2001-01-20 +0.00.00 + + + +&ktimer; is part of the kdeutils package. + + + + + +KDE +kdeutils +ktimer + + + + + +Introduction +The documentation for &kappname; was not finished when &kde; was installed on this computer. +If you need help, please check The KDE Website for updates, or by submitting your question to The &kde; User Mailing list. +The &kde; Team + +&underFDL; +&underGPL; + + + +&documentation.index; + + + 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 new file mode 100644 index 0000000..57558ac Binary files /dev/null and b/doc/kwallet/cr22-action-wallet_closed.png differ diff --git a/doc/kwallet/cr22-action-wallet_open.png b/doc/kwallet/cr22-action-wallet_open.png new file mode 100644 index 0000000..55a447f Binary files /dev/null and b/doc/kwallet/cr22-action-wallet_open.png differ diff --git a/doc/kwallet/edit1.png b/doc/kwallet/edit1.png new file mode 100644 index 0000000..1d0fe7c Binary files /dev/null and b/doc/kwallet/edit1.png differ diff --git a/doc/kwallet/edit2.png b/doc/kwallet/edit2.png new file mode 100644 index 0000000..05b6dd8 Binary files /dev/null and b/doc/kwallet/edit2.png differ diff --git a/doc/kwallet/edit3.png b/doc/kwallet/edit3.png new file mode 100644 index 0000000..9292870 Binary files /dev/null and b/doc/kwallet/edit3.png differ 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 @@ + +KWallet"> + KWallet Manager"> + + + + +]> + + + +The &kwallet; Handbook + + + +&George.Staikos; &George.Staikos.mail; + + +&Lauri.Watts; &Lauri.Watts.mail; + + +GeorgeStaikos +
staikos@kde.org
 +Developer + + + + +&FDLNotice; + +2005-06-15 +1.0 + + + +The wallet subsytem provides a convenient and secure way to manage all your +passwords. + + + + + +KDE +Kwallet +passwords +forms + + + + + +Introduction + +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. + +&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. + + +&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. + + +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. + + + + +&kwalletmanager; + +&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;. + +You may also manage the wallets installed on the system, creating and +deleting wallets and manipulating their contents (changing keys, ...). + +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: + + + + + + +When all +wallets are closed, the icon will reflect this by showing a closed +wallet: + + + + + + + + +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. + + + + + + + + + +The &kwalletmanager; Context Menu + +Right clicking on a wallet in the +&kwalletmanager; window offers +the following functions: + + + + +New Wallet... + +Create a new wallet. A dialog box will ask you +for the name of the new wallet that you want to create. + + + + +&Enter; +Open... + +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. + + + + + + + + + + + + +Change Password + +Change the master password for the wallet. + + + + +Disconnect +Disconnect an application from the wallet. Currently +connected applications will appear in a submenu. + + + +Close +Force the wallet to be closed. + + + +Delete + +Delete the wallet + + + + + + +The Wallet Window + +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. + + +The window has four panes: + + + + + + + + + +A summary of the contents of the current +folder +The folders contained in the wallet +The entries in the currently selected +folder +The contents of the selected folder entry + + +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. + + + + + + + + +Entries may also be created or deleted via the context menu for the +folder contents. + +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. + + + + + + +Configuring &kwallet; + + +<guilabel>Wallet Preferences</guilabel> + +&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. + +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. + + +<guilabel>Close Wallet</guilabel> + +Close when unused for: + +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. + + + + +Close when screen saver starts + +Close the wallet as soon as the screensaver starts. When a wallet is +closed, the password is needed to access it again. + + + + +Close when last application stops using it + +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. + + + + + +<guilabel>Automatic Wallet Selection</guilabel> + +Select wallet to use as default: + +Select which wallet you want to use as default wallet. + + + + +Different wallet for local passwords: + +If checked, choose a different wallet for local passwords. + + + + + +<guilabel>Wallet Manager</guilabel> + +Show manager in system tray + +Enable the wallet manager to have its icon in the system tray. + + + + +Hide System tray icon when last wallet +closes + +When there is no wallet in use anymore, remove the wallet icon from the +system tray. + + + + +Finally, there is a button labelled Launch Wallet +Manager, which does precisely that. + + + +<guilabel>Access Control</guilabel> + +There is only one option on this page: + + + +Prompt when an application accesses an open wallet + +Signal you when an application gains access to an open wallet. + + + + +Next there is a tree style view of the access controls for your wallets. + +&LMB; click on the + 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 Delete From the +context menu that appears, or by simply selecting it and pressing the +Delete key. + + + + + + +Advanced Features + +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. + +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. + +Future versions will have built-in functions for easy export or +copying of data to portable devices. + + + + +Credits and Licenses + +&kwallet; © 2003 &George.Staikos; +Documentation © &Lauri.Watts; and &George.Staikos; + + + +&underFDL; +&underGPL; + + + +&documentation.index; + + + + diff --git a/doc/kwallet/kwalletmanager.png b/doc/kwallet/kwalletmanager.png new file mode 100644 index 0000000..67c7220 Binary files /dev/null and b/doc/kwallet/kwalletmanager.png differ diff --git a/doc/kwallet/password1.png b/doc/kwallet/password1.png new file mode 100644 index 0000000..d5cb22a Binary files /dev/null and b/doc/kwallet/password1.png differ diff --git a/doc/kwallet/password2.png b/doc/kwallet/password2.png new file mode 100644 index 0000000..c116e93 Binary files /dev/null and b/doc/kwallet/password2.png differ 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 @@ + +SuperKaramba"> + + + + +]> + + + +The &superkaramba; Handbook + + +Hans +Karlsson +karlsson.h@home.se + + + + + +2005 +Hans Karlsson + + +2005-08-04 +0.3.5 +&FDLNotice; + + +&superkaramba; is a tool that allows you to easily create interactive +widgets on your &kde; desktop. + + +KDE +desktop +karamba + + + + + + + + +Questions, Answers, and Tips + + +Frequently asked questions + +Installation + + +Where can I find &superkaramba; RPM's? + + + + +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. + + + +When I try to compile, I get this error: +Python.h: No such file or directory + +You will need to install the python-devel +package. Once that package is installed you should run +./configure and make again. + + + +When I try to compile, I get this error: +cannot find -lselinux + + +You will need to install the libselinux-devel +package. Once that package is installed you should run +./configure and make again. + + + + +After running ./configure, make +and make install, the &superkaramba; executable is not +where I expected it to be. When I try to run superkaramba +from the command line it says command not +found. + + +In some distributions ./configure has a default prefix path that +differs to what you might expect. For example, in Mandrake the default +prefix is /usr/local/kde and the +executable is installed in /usr/local/kde/bin. +There are a few things you can do to fix this. +You could run ./configure +--prefix=/usr to specify the prefix that +you prefer and then try make and make +install 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 $PATH. + + + + + +General + + +How do I get rid of the &kde; panel? Do I have to keep &kicker; +running? + +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 +~/.kde file. For more information see the wiki page about +secret +configuration settings. + + + + +Can I run a system tray theme while the &kicker; system tray is +running? + +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 +steal 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;. + + + + +How do I set up my themes to run automatically on startup? + + +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. +Another solution is to create a desktop config file in the &kde; +autostart directory. +To create a desktop config file, open an editor and enter the +following: +[Desktop Entry] +Exec=superkaramba {location of theme file}.theme +Name={theme name} +Type=Application +X-KDE-StartupNotify=false +Then save it as +themename.desktop into the +autostart directory at $KDEHOME/Autostart/. + + + +Why is the Edit Script option +disabled when I &RMB; click on a theme? +Some &superkaramba; themes don't include a +Python script. This is normal and those themes +will still work fine without one. However, if the theme does use a +Python script, &superkaramba; may have not been +able to load the script. This is usually due to +Python errors. Run the theme from the command line +to find out the specific error message. + + + + +Why is the Configure Theme menu disabled +when I &RMB; click on a theme? + + +The Configure Theme 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. + + + + + +Troubleshooting + + +My themes start up in different locations each time I start +&kde;. + + +Close all &superkaramba; themes and then delete any session files in +$KDEHOME/share/config/session/ +that begin with &superkaramba;. Restart &kde; and start your themes again. Now +they will stay in the right place. + + + + +The backgrounds of my themes are black instead of transparent. + +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. + + + + + + + + +Credits and Licenses + +&superkaramba; is written by +AdamGeitgey +adam@rootnode.org and +HansKarlsson karlsson.h@home.se + + + + + + +&underFDL; +&underGPL; + + + + + -- cgit v1.2.1