1
<chapter id="on-screen-fundamentals">
2
<title>Some Fundamentals</title>
5
&kwrite; is very simple to use. Anyone that has used a text editor
6
should have no problems.
9
<sect1 id="drag-and-drop">
10
<title>Drag and Drop</title>
13
&kwrite; uses the &kde; Drag and Drop protocol. Files may be dragged and
14
dropped onto &kwrite; from the Desktop, the filemanager &dolphin;, or some remote &FTP;
15
site opened in one of &dolphin;'s windows.
19
<sect1 id="command-line-options">
20
<title>Command Line Options</title>
23
Though &kwrite; may most often be started from the &kde; program menu, or
24
a desktop icon, it can also be opened at the command line prompt of a
25
terminal window. There are a few useful options that are available when
29
<sect2 id="specify-a-file">
30
<title>Specify a File</title>
32
<para>By specifying the path and name of a particular file the user can
33
have &kwrite; open (or create) that file immediately upon startup. This
34
option might look something like the following:</para>
36
<informalexample><screen>
37
<prompt>%</prompt> <userinput><command>kwrite</command>
38
<option><replaceable>/home/myhome/docs/myfile.txt</replaceable></option>
43
<sect2 id="editing-files-on-the-internet">
44
<title>Specify a file on the Internet</title>
46
<para>The above-mentioned method could even be used to open files on the
47
Internet (if the user has an active connection at the time.) An example of
48
this might look like the following:</para>
50
<informalexample><screen>
51
<prompt>%</prompt> <userinput><command>kwrite</command>
52
<option><replaceable>ftp://ftp.kde.org/pub/kde/README</replaceable>
59
<sect2 id="other-command-line-options">
60
<title>Other Command Line Options</title>
62
<para>The following command line help options are available</para>
66
<term><userinput><command>kwrite</command>
67
<option>--help</option></userinput></term>
68
<listitem><para>This lists the most basic options available at the command
69
line.</para></listitem>
72
<term><userinput><command>kwrite</command>
73
<option>--help-qt</option></userinput></term>
74
<listitem><para>This lists the options available for changing the way
75
&kwrite; interacts with &Qt;.</para></listitem>
78
<term><userinput><command>kwrite</command>
79
<option>--help-kde</option></userinput></term>
80
<listitem><para>This lists the options available for changing the way
81
&kwrite; interacts with &kde;.</para></listitem>
84
<term><userinput><command>kwrite</command>
85
<option>--help-all</option></userinput></term>
86
<listitem><para>This lists all of the command line options.</para></listitem>
89
<term><userinput><command>kwrite</command>
90
<option>--author</option></userinput></term>
91
<listitem><para>Lists &kwrite;'s authors in the terminal
92
window</para></listitem>
95
<term><userinput><command>kwrite</command>
96
<option>-v, --version</option></userinput></term>
97
<listitem><para>Lists version information for &Qt;, &kde;, and &kwrite;. Also
98
available through <userinput><command>kwrite</command>
99
<option>-v</option></userinput> </para></listitem>
102
<term><userinput><command>&kwrite;</command>
103
<option>--license</option></userinput></term>
105
<para>Shows license information.</para>
109
<term><userinput><command>kwrite</command>
110
<option>--stdin</option></userinput></term>
111
<listitem><para>Causes &kwrite; to read the document content from STDIN. This
112
is similar to the common option <option>-</option> used in many command line
113
programs, and allows you to pipe command output into &kwrite;.</para></listitem>
116
<term><userinput><command>kwrite</command>
117
<option>--encoding</option> <parameter>encoding</parameter>
118
<parameter>&URL;</parameter></userinput></term>
119
<listitem><para>Causes &kwrite; to use the specified encoding for the document.
123
<term><userinput><command>kwrite</command>
124
<option>--line</option> <parameter>line</parameter>
125
<parameter>&URL;</parameter></userinput></term>
126
<listitem><para>Navigate to the specified line after opening the document.
130
<term><userinput><command>kwrite</command>
131
<option>--column</option> <parameter>column</parameter>
132
<parameter>&URL;</parameter></userinput></term>
133
<listitem><para>Navigate to the specified column after opening the document.
141
<sect1 id="keybindings"> <!--60 shortcuts here and 4.4.63 has 89 lueck
142
missing ctrl+6,7,8,9,T,Home,End
143
ctrl+shift+O,Home,End,PgUp,Left,Right,PgDown
146
<title>Shortcuts</title>
148
<para>Many of the shortcuts are configurable by way of the <link
149
linkend="settings">Settings</link> menu. By default &kwrite; honors the
150
following shortcuts:</para>
155
<row><entry><para><keycombo
156
action="simul"><keycap>Ins</keycap></keycombo></para></entry>
157
<entry><para> Toggle between Insert and Overwrite mode. When in insert mode the
158
editor will add any typed characters to the text while pushing along any data to
159
the right of the text cursor. Overwrite mode causes the entry of each character
160
to eliminate the character immediately to the right of the text
161
cursor.</para></entry>
164
<entry><para><keycombo action="simul"><keycap>Left
165
Arrow</keycap></keycombo></para></entry>
166
<entry><para>Move the cursor one character to the left </para></entry>
169
<entry><para><keycombo action="simul"><keycap>Right
170
Arrow</keycap></keycombo></para></entry>
171
<entry><para> Move the cursor one character to the right </para></entry>
174
<entry><para><keycombo action="simul"><keycap>Up
175
Arrow</keycap></keycombo></para></entry>
176
<entry><para> Move the cursor up one line </para></entry>
179
<entry><para><keycombo action="simul"><keycap>Down
180
Arrow</keycap></keycombo></para></entry>
181
<entry><para> Move the cursor down one line </para></entry>
184
<entry><para><keycombo action="simul"><keycap>Page
185
Up</keycap></keycombo></para></entry>
186
<entry><para> Move the cursor up one page </para></entry>
189
<entry><para><keycombo action="simul">&Alt;<keycap>Page
190
Up</keycap></keycombo></para></entry>
191
<entry><para>Previous Bookmark</para></entry>
194
<entry><para><keycombo action="simul"><keycap>Page
195
Down</keycap></keycombo></para></entry>
196
<entry><para>Move the cursor down one page </para></entry>
199
<entry><para><keycombo action="simul">&Alt;<keycap>Page
200
Down</keycap></keycombo></para></entry>
201
<entry><para>Next Bookmark</para></entry>
204
<entry><para><keycombo
205
action="simul">&Backspace;</keycombo></para></entry>
206
<entry><para> Delete the character to the left of the cursor </para></entry>
209
<entry><para><keycombo
210
action="simul"><keycap>Home</keycap></keycombo></para></entry>
211
<entry><para> Move the cursor to the beginning of the line </para></entry>
214
<entry><para><keycombo
215
action="simul"><keycap>End</keycap></keycombo></para></entry>
216
<entry><para> Move the cursor to the end of the line </para></entry>
219
<entry><para><keycombo
220
action="simul"><keycap>Delete</keycap></keycombo></para></entry>
221
<entry><para>Delete the character to the right of the cursor (or any selected
225
<entry><para><keycombo action="simul">&Shift;&Enter;</keycombo></para></entry>
226
<entry><para>Insert newline including leading characters of the current line which are not letters or numbers.
227
It is useful ⪚ to write comments in the code: At the end of the line <quote>// some text</quote> press
228
this shortcut and the next line starts already with <quote>// </quote>. So you do not have to enter the comment
229
characters at the beginning of each new line with comments.</para></entry>
232
<entry><para><keycombo action="simul">&Shift;<keycap>Left
233
Arrow</keycap></keycombo></para></entry>
234
<entry><para> Mark text one character to the left </para></entry>
237
<entry><para><keycombo action="simul">&Shift;<keycap>Right
238
Arrow</keycap></keycombo></para></entry>
239
<entry><para> Mark text one character to the right </para></entry>
242
<entry><para><keycombo
243
action="simul"><keycap>F1</keycap></keycombo></para></entry>
244
<entry><para> Help</para></entry>
247
<entry><para><keycombo
248
action="simul">&Shift;<keycap>F1</keycap></keycombo></para></entry>
249
<entry><para>What's this?</para></entry>
252
<entry><para><keycombo
253
action="simul"><keycap>F3</keycap></keycombo></para></entry>
254
<entry><para><link linkend="find-again"> Find Next</link></para></entry>
257
<entry><para><keycombo
258
action="simul">&Shift;<keycap>F3</keycap></keycombo></para></entry>
259
<entry><para><link linkend="find-previous"> Find Previous</link></para></entry>
262
<entry><para><keycombo
263
action="simul">&Ctrl;<keycap>H</keycap></keycombo></para></entry>
264
<entry><para><link linkend="find-selected">Find Selected</link></para></entry>
267
<entry><para><keycombo
268
action="simul">&Ctrl;&Shift;<keycap>H</keycap></keycombo></para></entry>
269
<entry><para><link linkend="find-selected-backwards">Find Selected Backwards</link></para></entry>
272
<entry><para><keycombo
273
action="simul">&Ctrl;<keycap>A</keycap></keycombo></para></entry>
274
<entry><para>Select All</para></entry>
277
<entry><para><keycombo
278
action="simul">&Ctrl;&Shift;<keycap>A</keycap></keycombo></para></entry>
279
<entry><para>Deselect</para></entry>
282
<entry><para><keycombo
283
action="simul">&Ctrl;&Shift;<keycap>B</keycap></keycombo></para></entry>
284
<entry><para>Block Selection Mode</para></entry>
287
<entry><para><keycombo
288
action="simul">&Ctrl;<keycap>B</keycap></keycombo></para></entry>
289
<entry><para>Set a Bookmark</para></entry>
292
<entry><para><keycombo
293
action="simul">&Ctrl;<keycap>C</keycap></keycombo></para></entry>
294
<entry><para> Copy the marked text to the clipboard. </para></entry>
297
<entry><para><keycombo
298
action="simul">&Ctrl;<keycap>D</keycap></keycombo></para></entry>
299
<entry><para> Comment</para></entry>
302
<entry><para><keycombo
303
action="simul">&Ctrl;&Shift;<keycap>D</keycap></keycombo></para></entry>
304
<entry><para> Uncomment</para></entry>
307
<entry><para><keycombo
308
action="simul">&Ctrl;<keycap>F</keycap></keycombo></para></entry>
309
<entry><para><link linkend="find"> Find</link></para></entry>
312
<entry><para><keycombo
313
action="simul">&Ctrl;<keycap>G</keycap></keycombo></para></entry>
314
<entry><para> Go to line...</para></entry>
317
<entry><para><keycombo
318
action="simul">&Ctrl;<keycap>I</keycap></keycombo></para></entry>
319
<entry><para> Indent selection</para></entry>
322
<entry><para><keycombo
323
action="simul">&Ctrl;&Shift;<keycap>I</keycap></keycombo></para></entry>
324
<entry><para> Unindent selection</para></entry>
327
<entry><para><keycombo
328
action="simul">&Ctrl;<keycap>J</keycap></keycombo></para></entry>
329
<entry><para>Join Lines</para></entry>
332
<entry><para><keycombo
333
action="simul">&Ctrl;<keycap>N</keycap></keycombo></para></entry>
334
<entry><para> <link linkend="new">New</link> document</para></entry>
337
<entry><para><keycombo
338
action="simul">&Ctrl;<keycap>O</keycap></keycombo></para></entry>
339
<entry><para><link linkend="open">Open a document</link> </para></entry>
342
<entry><para><keycombo
343
action="simul">&Ctrl;<keycap>P</keycap></keycombo></para></entry>
344
<entry><para><link linkend="print">Print</link> </para></entry>
347
<entry><para><keycombo
348
action="simul">&Ctrl;<keycap>Q</keycap></keycombo></para></entry>
349
<entry><para>Quit - close active copy of editor </para></entry>
352
<entry><para><keycombo
353
action="simul">&Ctrl;<keycap>R</keycap></keycombo></para></entry>
354
<entry><para><link linkend="replace"> Replace</link></para></entry>
357
<entry><para><keycombo
358
action="simul">&Ctrl;<keycap>S</keycap></keycombo></para></entry>
359
<entry><para>Invokes the <link
360
linkend="save"><guilabel>Save</guilabel></link> command.</para></entry>
363
<entry><para><keycombo
364
action="simul">&Ctrl;<keycap>U</keycap></keycombo></para></entry>
365
<entry><para>Uppercase</para></entry>
368
<entry><para><keycombo
369
action="simul">&Ctrl;&Shift;<keycap>U</keycap></keycombo></para></entry>
370
<entry><para>Lowercase</para></entry>
373
<entry><para><keycombo
374
action="simul">&Ctrl;&Alt;<keycap>U</keycap></keycombo></para></entry>
375
<entry><para>Capitalize</para></entry>
378
<entry><para><keycombo
379
action="simul">&Ctrl;<keycap>V</keycap></keycombo></para></entry>
380
<entry><para> Paste the clipboard text into line edit. </para></entry>
383
<entry><para><keycombo
384
action="simul">&Ctrl;<keycap>W</keycap></keycombo></para></entry>
385
<entry><para><link linkend="close">Close</link> </para></entry>
388
<entry><para><keycombo
389
action="simul">&Ctrl;<keycap>X</keycap></keycombo></para></entry>
390
<entry><para>Delete the marked text and copy it to the clipboard.
394
<entry><para><keycombo
395
action="simul">&Ctrl;<keycap>Z</keycap></keycombo></para></entry>
396
<entry><para><link linkend="undo">Undo</link></para></entry>
399
<entry><para><keycombo
400
action="simul">&Ctrl;&Shift;<keycap>Z</keycap></keycombo></para></entry>
401
<entry><para><link linkend="redo">Redo</link></para></entry>
404
<entry><para><keycombo
405
action="simul">&Ctrl;<keycap>-</keycap></keycombo></para></entry>
406
<entry><para>Collapse One Local Level</para></entry>
409
<entry><para><keycombo
410
action="simul">&Ctrl;&Shift;<keycap>-</keycap></keycombo></para></entry>
411
<entry><para>Collapse Toplevel</para></entry>
414
<entry><para><keycombo
415
action="simul">&Ctrl;<keycap>+</keycap></keycombo></para></entry>
416
<entry><para>Expand One Local Level</para></entry>
419
<entry><para><keycombo
420
action="simul">&Ctrl;&Shift;<keycap>+</keycap></keycombo></para></entry>
421
<entry><para>Expand Toplevel</para></entry>
424
<entry><para><keycombo
425
action="simul"><keysym>Meta</keysym>&Ctrl;<keycap>V</keycap></keycombo></para></entry>
426
<entry><para>VI input mode</para></entry>
429
<entry><para><keycombo
430
action="simul">&Ctrl;<keycap>Space</keycap></keycombo></para></entry>
431
<entry><para>Invoke Code Completion</para></entry>
434
<entry><para><keycombo
435
action="simul"><keycap>F5</keycap></keycombo></para></entry>
436
<entry><para><link linkend="reload"> Reload</link></para></entry>
439
<entry><para><keycombo
440
action="simul"><keycap>F6</keycap></keycombo></para></entry>
441
<entry><para>Show/Hide Icon Border</para></entry>
444
<entry><para><keycombo
445
action="simul"><keycap>F7</keycap></keycombo></para></entry>
446
<entry><para> Switch to Command Line</para></entry>
449
<entry><para><keycombo
450
action="simul"><keycap>F9</keycap></keycombo></para></entry>
451
<entry><para> Show/Hide Folding Markers</para></entry>
454
<entry><para><keycombo
455
action="simul"><keycap>F10</keycap></keycombo></para></entry>
456
<entry><para> Dynamic Word Wrap</para></entry>
459
<entry><para><keycombo
460
action="simul"><keycap>F11</keycap></keycombo></para></entry>
461
<entry><para> Show/Hide Line Numbers</para></entry>
b'\\ No newline at end of file'
added
removed
doc/kwrite/fundamentals.docbook
