Fix crash if key bindings specified in profile cannot be found. Improve
[personal-kdebase.git] / apps / doc / konsole / index.docbook
blob84d560f13bce2757b5c1ca3ba952767140595ac7
1 <?xml version="1.0" ?>
2 <!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN"
3 "dtd/kdex.dtd" [
4 <!ENTITY kappname "&konsole;">
5 <!ENTITY package "kdebase">
6 <!ENTITY % English "INCLUDE">
7 <!ENTITY % addindex "IGNORE">
8 ]>
10 <book lang="&language;">
12 <bookinfo>
13 <title>The &konsole; Handbook</title>
14 <authorgroup>
15 <author>&Jonathan.Singer; &Jonathan.Singer.mail;</author>
16 <author>&Kurt.Hindenburg; &Kurt.Hindenburg.mail;</author>
18 <othercredit role="developer">
19 &Robert.Knight; &Robert.Knight.mail;
20 </othercredit>
22 <othercredit role="developer">
23 &Kurt.Hindenburg; &Kurt.Hindenburg.mail;
24 </othercredit>
26 <othercredit role="developer">
27 &Waldo.Bastian; &Waldo.Bastian.mail;
28 </othercredit>
30 <othercredit role="reviewer">
31 &Mike.McBride; &Mike.McBride.mail;
32 </othercredit>
34 <!-- TRANS:ROLES_OF_TRANSLATORS -->
36 </authorgroup>
38 <copyright>
39 <year>2000</year><year>2001</year><year>2002</year>
40 <holder>&Jonathan.Singer;</holder>
41 </copyright>
42 <copyright>
43 <year>2005</year><year>2008</year>
44 <holder>&Kurt.Hindenburg;</holder>
45 </copyright>
47 <legalnotice>&FDLNotice;</legalnotice>
49 <date>2008-09-07</date>
50 <releaseinfo>2.1.0</releaseinfo>
52 <abstract><para>&konsole; is &kde;'s terminal emulator.</para></abstract>
54 <keywordset>
55 <keyword>KDE</keyword>
56 <keyword>konsole</keyword>
57 <keyword>kdebase</keyword>
58 <keyword>command</keyword>
59 <keyword>line</keyword>
60 <keyword>terminal</keyword>
61 <keyword>cli</keyword>
62 </keywordset>
64 </bookinfo>
66 <chapter id="introduction">
67 <title>Introduction</title>
69 <sect1 id="terminal">
70 <title>What is a terminal?</title>
72 <para>&konsole; is an X terminal
73 emulator, often referred to as a terminal or a shell. It emulates a command line interface in a text only window.
74 </para>
76 <para>Explaining the use of the &UNIX; <acronym>CLI</acronym> is beyond the scope of this document. A search of the web for these terms will produce more information.
77 </para>
78 </sect1>
80 <sect1 id="scrollback">
81 <title>Scrollback</title>
83 <para>&konsole; uses the notion of scrollback
84 to allow user's to view previously displayed output.
85 By default, scrollback is on
86 and set to save 1000 lines of
87 output in addition to what is currently displayed on the screen.
88 As lines of text scroll off the top of the screen, they can be reviewed
89 by moving the scroll bar upwards, scrolling with a mouse wheel or through
90 the use of the
91 <keycombo action="simul">&Shift;<keycap>Page Up</keycap></keycombo> (to move
92 back a page),
93 <keycombo action="simul">&Shift;<keycap>Page Down</keycap></keycombo> (to move forward a page),
94 <keycombo action="simul">&Shift;<keycap>Up Arrow</keycap></keycombo> (to move up a line) and
95 <keycombo action="simul">&Shift;<keycap>Down Arrow</keycap></keycombo> (to move down a line) keys.
96 </para>
98 <para>When the <keycap>scrolllock</keycap> is on,
99 ordinary input and output from the shell is suspended, and you can
100 scroll through the history with
101 <keycap>Page Up</keycap>,
102 <keycap>Page Down</keycap>,
103 <keycap>Up Arrow</keycap> and
104 <keycap>Down Arrow</keycap>.
105 </para>
107 <para>&konsole; provides a number of actions located in the
108 <link linkend="scrollback-menu">
109 <menuchoice><guimenu>
110 Scrollback
111 </guimenu></menuchoice>
112 </link>menu.
113 </para>
115 </sect1>
117 <sect1 id="profiles">
118 <title>Profiles</title>
119 <para>Profiles allow the user to quickly and easily automate the running
120 of common commands. Examples could include:
122 <itemizedlist>
123 <listitem><para>ssh into another machine</para></listitem>
124 <listitem><para>starting an irc session</para></listitem>
125 <listitem><para>use tail to watch a file</para></listitem>
126 </itemizedlist>
128 </para>
130 <para>
131 Procedure to create a new profile:
132 <orderedlist>
133 <listitem><para>Click on the menu entry <menuchoice><guimenu>Settings</guimenu><guimenuitem>Manage Profiles...</guimenuitem>
134 </menuchoice></para></listitem>
136 <listitem><para>Click on the button <guibutton>New Profile...</guibutton>.</para></listitem>
138 <listitem><para>Fill in the first entry with a name. This is the
139 name that will show in the menu, and will be the default label instead
140 of <guilabel>Shell</guilabel> when you start a session of this type.
141 </para></listitem>
143 <listitem><para>Enter a command just as you normally would if you opened a new
144 shell and were going to issue that command. For our first example above, you
145 might type <userinput><command>ssh</command> <replaceable>administration</replaceable></userinput>.</para></listitem>
147 <listitem><para>On the other tabs of the dialog, configure this session's appearance.
148 You can configure a different font, colour scheme, $<envar>TERM</envar> type and many
149 other settings for each session.</para></listitem>
151 <listitem><para>Press the <guibutton>OK</guibutton> button. The new session
152 is now available in the <guilabel>Manage Profiles...</guilabel> dialog.
153 </para></listitem>
155 </orderedlist>
156 </para>
158 <para>
159 After creating profiles, they are listed by their name in the
160 <menuchoice><guimenu>File</guimenu></menuchoice> menu
161 underneath the default <guimenuitem>Shell</guimenuitem> item.
162 </para>
164 </sect1>
166 <sect1 id="mousebuttons">
168 <title>Mouse Buttons</title>
170 <para>This section details the use of the mouse buttons for the common
171 right handed mouse button order.
172 For the left handed mouse button order, swap left and right in the text below.
173 </para>
175 <variablelist>
177 <varlistentry>
178 <term><mousebutton>Left</mousebutton></term>
180 <listitem><para> All &LMB; clicks will be sent to a mouse-aware
181 application running in &konsole;.
182 If an application will react on mouse clicks, &konsole;
183 indicates this by showing an arrow cursor. If not, an I-beam (bar)
184 cursor is shown.</para>
186 <para>Holding the &LMB; down and
187 dragging the mouse over the screen with a mouse-unaware application
188 running will mark a region of the text. While dragging, the marked
189 text is displayed reversed for visual feedback. Select <guimenuitem>Copy</guimenuitem>
190 from the <guimenu>Edit</guimenu> menu to copy the marked text to the clipboard for further use
191 within &konsole; or another application. The selected text can also be
192 dragged and dropped into compatible applications. Click on the selected
193 text and drag it to the desired location. Depending on your &kde; settings,
194 you may need to hold the &Ctrl; key while dragging.</para>
196 <para>Normally, new-line characters are inserted at the end of each
197 line selected. This is best for cut and paste of source code, or the output
198 of a particular command. For ordinary text, the line breaks are often
199 not important. One might prefer, however, for the text to be a stream
200 of characters that will be automatically re-formatted when pasted into
201 another application. To select in text-stream mode, hold down the
202 &Ctrl; key while selecting normally.</para>
204 <para>Pressing the &Ctrl; and &Alt; keys along with the &LMB;
205 will select a column of text.
206 </para>
208 <para>Double-click with the &LMB; to select a word;
209 triple-click to select an entire line.</para>
211 <para>If the upper or lower edge of the text area is touched while
212 marking, &konsole; scrolls up or down, eventually exposing text within
213 the history buffer. The scrolling stops when the mouse stops
214 moving.</para>
216 <para>After the mouse is released, &konsole; attempts to keep the text
217 in the clipboard visible by holding the marked area reversed. The
218 marked area reverts back to normal as soon as the contents of the
219 clipboard change, the text within the marked area is altered or the
220 &LMB; is clicked.</para>
222 <para>To mark text on a mouse-aware application (Midnight Commander, for example)
223 the &Shift; key has to be pressed when clicking.</para>
225 </listitem>
226 </varlistentry>
228 <varlistentry>
229 <term><mousebutton>Middle</mousebutton></term>
231 <listitem><para>Pressing the &MMB;
232 pastes text currently in the clipboard. Holding down the &Ctrl; key as you
233 press the &MMB; pastes the text and sends
234 it to &konsole;.</para>
236 <note><para>If you have a mouse with only two buttons, pressing both
237 the &LMB; and &RMB; together emulates the &MMB; of a three button mouse.</para></note>
239 <para>If you have a <mousebutton>wheel</mousebutton> as the middle button,
240 rolling it in a mouse unaware program will move &konsole;'s scrollbar.</para>
242 </listitem>
243 </varlistentry>
245 <varlistentry>
246 <term><mousebutton>Right</mousebutton></term>
247 <listitem>
248 <para>These items appear in the menu when the &RMB;
249 is pressed:
251 <guimenuitem>Copy</guimenuitem>,
252 <guimenuitem>Paste</guimenuitem>,
253 <guimenuitem>Clear Scrollback &amp; Reset</guimenuitem>,
254 <guimenuitem>Open Browser Here</guimenuitem>,
255 <guimenuitem>Change Profile</guimenuitem>,
256 <guimenuitem>Edit Current Profile...</guimenuitem>,
257 <guimenuitem>Show MenuBar</guimenuitem>,
258 <guimenuitem>Character Encoding</guimenuitem>
259 and <guimenuitem>Close Tab</guimenuitem>
260 </para>
262 <para>In a mouse aware application, press the &Shift; key along with the
263 &RMB; to get the popup menu.
264 </para>
266 </listitem>
267 </varlistentry>
268 </variablelist>
270 </sect1>
271 </chapter>
273 <chapter id="commandreference">
274 <title>Command Reference</title>
276 <sect1 id="menubar">
277 <title>The Menubar</title>
279 <para>The menubar is at the top of the &konsole; window.
280 If the menubar is hidden,
281 <guimenuitem>Show Menu Bar</guimenuitem> can be reached by
282 <mousebutton>right</mousebutton> clicking in the window
283 (as long as no full screen application is running in that
284 window such as vi, minicom, etc.). The default shortcut
285 is listed after each menu item.
286 </para>
288 <sect2 id="file-menu">
289 <title><guimenu>File</guimenu> Menu</title>
291 <variablelist>
292 <varlistentry>
293 <term><menuchoice>
294 <shortcut><keycombo action="simul">&Ctrl;&Shift;<keycap>N</keycap></keycombo></shortcut>
295 <guimenu>File</guimenu><guimenuitem>New Tab</guimenuitem>
296 </menuchoice>
297 </term>
298 <listitem><para><action>Opens a new tab with the default profile</action>
299 </para></listitem></varlistentry>
301 <varlistentry>
302 <term><menuchoice>
303 <shortcut><keycombo action="simul">&Ctrl;&Shift;<keycap>M</keycap></keycombo></shortcut>
304 <guimenu>File</guimenu><guimenuitem>New Window</guimenuitem></menuchoice>
305 </term>
306 <listitem><para><action>Opens a new seperate &konsole; window with the default profile</action>
307 </para></listitem></varlistentry>
309 <varlistentry>
310 <term><menuchoice><guimenu>File</guimenu><guimenuitem>Shell</guimenuitem></menuchoice></term>
311 <listitem><para><action>Opens a new tab with the Shell profile</action></para>
312 <note><para>&konsole; ships with the Shell profile as the default.
313 Any new profiles added by the user will have its own menu item
314 below <menuchoice><guimenu>File</guimenu><guimenuitem>Shell</guimenuitem></menuchoice>.
315 </para></note>
316 </listitem>
317 </varlistentry>
319 <varlistentry>
320 <term><menuchoice><guimenu>File</guimenu>
321 <guimenuitem>Open Browser Here</guimenuitem></menuchoice>
322 </term>
323 <listitem><para><action>Opens &kde;'s file manager
324 at the current directory</action>. By default, that is
325 <ulink url="help:/dolphin/index.html">&dolphin;</ulink>.
326 </para></listitem>
327 </varlistentry>
329 <varlistentry>
330 <term><menuchoice>
331 <shortcut><keycombo action="simul">&Ctrl;&Shift;<keycap>W</keycap></keycombo></shortcut>
332 <guimenu>File</guimenu>
333 <guimenuitem>Close Tab</guimenuitem></menuchoice>
334 </term>
335 <listitem><para><action>Closes the current tab</action>
336 </para></listitem>
337 </varlistentry>
339 <varlistentry>
340 <term><menuchoice>
341 <shortcut><keycombo action="simul">&Ctrl;&Shift;<keycap>Q</keycap></keycombo></shortcut>
342 <guimenu>File</guimenu>
343 <guimenuitem>Quit</guimenuitem></menuchoice>
344 </term>
345 <listitem><para><action>Quits &konsole;</action></para>
346 <note><para>&konsole; will display a window if there is more than one
347 tab open. This window can be disabled by clicking on the <guibutton>Do not ask again</guibutton> checkbox.
348 </para></note>
349 </listitem>
350 </varlistentry>
352 </variablelist>
354 </sect2>
356 <sect2 id="edit-menu">
357 <title><guimenu>Edit</guimenu> Menu</title>
358 <variablelist>
360 <varlistentry>
361 <term><menuchoice>
362 <shortcut><keycombo action="simul">&Ctrl;&Shift;<keycap>C</keycap></keycombo></shortcut>
363 <guimenu>Edit</guimenu>
364 <guimenuitem>Copy</guimenuitem></menuchoice></term>
365 <listitem><para><action>Copies the selected text to the clipboard</action></para></listitem>
366 </varlistentry>
368 <varlistentry>
369 <term><menuchoice>
370 <shortcut><keycombo
371 action="simul">&Ctrl;&Shift;<keycap>V</keycap></keycombo></shortcut>
372 <guimenu>Edit</guimenu><guimenuitem>Paste
373 </guimenuitem></menuchoice></term>
374 <listitem><para><action>Pastes text from the clipboard at the cursor
375 location</action></para></listitem>
376 </varlistentry>
378 <varlistentry>
379 <term><menuchoice>
380 <shortcut><keycombo
381 action="simul">&Ctrl;&Alt;<keycap>S</keycap></keycombo></shortcut>
382 <guimenu>Edit</guimenu><guimenuitem>Rename Tab...</guimenuitem></menuchoice></term>
383 <listitem><para><action>Opens a dialog box allowing you to change
384 the name of the current tab</action></para></listitem>
385 </varlistentry>
387 <varlistentry>
388 <term><menuchoice><guimenu>Edit</guimenu><guimenuitem>Copy Input To...</guimenuitem></menuchoice></term>
389 <listitem><para><action>Allows input from the current session to be inputted simultaneously to other sessions</action></para>
390 </listitem>
391 </varlistentry>
393 <varlistentry>
394 <term><menuchoice><guimenu>Edit</guimenu><guimenuitem>Clear Display</guimenuitem></menuchoice></term>
395 <listitem><para><action>Clears all text from the tab</action></para>
396 <para>All the text cleared will be stored in the
397 <link linkend="scrollback">Scrollback</link>.
398 </para>
399 </listitem>
400 </varlistentry>
402 <varlistentry>
403 <term><menuchoice><guimenu>Edit</guimenu><guimenuitem>Clear &amp; Reset</guimenuitem></menuchoice></term>
404 <listitem><para><action>Clears all text from the tab and reset the session</action></para>
405 <para>All the text cleared will be stored in the
406 <link linkend="scrollback">Scrollback</link>.
407 </para>
408 </listitem>
409 </varlistentry>
411 </variablelist>
412 </sect2>
414 <sect2 id="view-menu">
415 <title><guimenu>View</guimenu> Menu</title>
416 <variablelist>
418 <varlistentry>
419 <term><menuchoice>
420 <shortcut><keycombo action="simul">&Ctrl;&Shift;<keycap>L</keycap></keycombo></shortcut>
421 <guimenu>View</guimenu><guisubmenu>Split View</guisubmenu><guimenuitem>Split
422 View Left/Right</guimenuitem></menuchoice>
423 </term>
424 <listitem><para><action>Splits all the tabs into left and right views</action>
425 </para><para>
426 Any output on one view is duplicated in the other view.
427 </para></listitem>
428 </varlistentry>
430 <varlistentry>
431 <term><menuchoice>
432 <shortcut><keycombo action="simul">&Ctrl;&Shift;<keycap>T</keycap></keycombo></shortcut>
433 <guimenu>View</guimenu><guisubmenu>Split View</guisubmenu><guimenuitem>Split
434 View Top/Bottom</guimenuitem></menuchoice>
435 </term>
436 <listitem><para><action>Splits all the tabs into top and bottom views</action>
437 </para><para>
438 Any output on one view is duplicated in the other view.
439 </para></listitem>
440 </varlistentry>
442 <varlistentry>
443 <term><menuchoice>
444 <shortcut><keycombo action="simul">&Ctrl;&Shift;<keycap>S</keycap></keycombo></shortcut>
445 <guimenu>View</guimenu><guisubmenu>Split View</guisubmenu><guimenuitem>
446 Close Active</guimenuitem></menuchoice>
447 </term>
448 <listitem><para><action>Closes the current view</action>
449 </para></listitem>
450 </varlistentry>
452 <varlistentry>
453 <term><menuchoice>
454 <shortcut><keycombo action="simul">&Ctrl;&Shift;<keycap>O</keycap></keycombo></shortcut>
455 <guimenu>View</guimenu><guisubmenu>Split View</guisubmenu><guimenuitem>
456 Close Others</guimenuitem></menuchoice>
457 </term>
458 <listitem><para><action>Closes the non-current view</action>
459 </para></listitem>
460 </varlistentry>
462 <varlistentry>
463 <term><menuchoice>
464 <shortcut><keycombo action="simul">&Ctrl;&Shift;<keycap>]</keycap></keycombo></shortcut>
465 <guimenu>View</guimenu><guisubmenu>Split View</guisubmenu><guimenuitem>Expand View</guimenuitem></menuchoice>
466 </term>
467 <listitem><para><action>Makes the current view larger</action>
468 </para></listitem>
469 </varlistentry>
471 <varlistentry>
472 <term><menuchoice>
473 <shortcut><keycombo action="simul">&Ctrl;&Shift;<keycap>[</keycap></keycombo></shortcut>
474 <guimenu>View</guimenu><guisubmenu>Split View</guisubmenu><guimenuitem>Shrink View</guimenuitem></menuchoice>
475 </term>
476 <listitem><para><action>Makes the current view smaller</action>
477 </para></listitem>
478 </varlistentry>
481 <varlistentry>
482 <term><menuchoice>
483 <shortcut><keycombo action="simul">&Ctrl;&Shift;<keycap>H</keycap></keycombo></shortcut>
484 <guimenu>View</guimenu><guimenuitem>Detach
485 View</guimenuitem></menuchoice>
486 </term>
487 <listitem><para><action>Opens the current tab in a
488 separate window</action>
489 </para><para>
490 Quiting the previous &konsole; window will not
491 affect the newly created window.
492 </para></listitem>
493 </varlistentry>
495 <varlistentry>
496 <term><menuchoice><guimenu>View</guimenu><guimenuitem>Show
497 Menu Bar</guimenuitem></menuchoice></term>
498 <listitem><para><action>Toggles the menubar being visible</action></para></listitem>
499 </varlistentry>
501 <varlistentry>
502 <term><menuchoice>
503 <shortcut><keycombo
504 action="simul">&Ctrl;&Shift;<keycap>F11</keycap></keycombo></shortcut>
505 <guimenu>View</guimenu><guimenuitem>Full Screen Mode</guimenuitem></menuchoice></term>
506 <listitem><para><action>Toggles &konsole; filling the entire screen</action></para></listitem>
507 </varlistentry>
509 <varlistentry>
510 <term><menuchoice>
511 <shortcut><keycombo action="simul">&Ctrl;&Shift;<keycap>I</keycap></keycombo></shortcut>
512 <guimenu>View</guimenu><guimenuitem>Monitor for
513 Silence</guimenuitem></menuchoice></term>
514 <listitem><para><action>Toggles the monitoring of the current tab for
515 lack of activity</action>
516 </para><para>
517 By default, after 10 seconds of inactivity, an info icon will appear on
518 the session's tab.
519 The type of alerts can be changed through
520 <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure Notifications</guimenuitem><guimenuitem>Silence in monitored session</guimenuitem></menuchoice>.
521 </para></listitem>
522 </varlistentry>
524 <varlistentry>
525 <term><menuchoice>
526 <shortcut><keycombo action="simul">&Ctrl;&Shift;<keycap>A</keycap></keycombo></shortcut>
527 <guimenu>View</guimenu><guimenuitem>Monitor for
528 Activity</guimenuitem></menuchoice></term>
529 <listitem><para><action>Toggles the monitoring of the current tab for
530 activity</action>
531 </para><para>
532 Upon any activity, an info icon will appear on the session's tab.
533 The type of alerts can be changed through
534 <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure Notifications</guimenuitem><guimenuitem>Activity in monitored session</guimenuitem></menuchoice>.
535 </para></listitem>
536 </varlistentry>
538 <varlistentry>
539 <term><menuchoice><guimenu>View</guimenu>
540 <guimenuitem>Set Character Encoding</guimenuitem></menuchoice></term>
541 <listitem><para><action>Sets the character encoding</action></para></listitem>
542 </varlistentry>
544 <varlistentry>
545 <term><menuchoice>
546 <shortcut><keycombo
547 action="simul">&Ctrl;<keycap>+</keycap></keycombo></shortcut>
548 <guimenu>View</guimenu><guimenuitem>Increase Text Size</guimenuitem></menuchoice></term>
549 <listitem><para><action>Increases the text font size</action></para></listitem>
550 </varlistentry>
552 <varlistentry>
553 <term><menuchoice>
554 <shortcut><keycombo
555 action="simul">&Ctrl;<keycap>-</keycap></keycombo></shortcut>
556 <guimenu>View</guimenu><guimenuitem>Decrease Text Size</guimenuitem></menuchoice></term>
557 <listitem><para><action>Decreases the text font size</action></para></listitem>
558 </varlistentry>
560 </variablelist>
561 </sect2>
563 <sect2 id="scrollback-menu">
564 <title><guimenu>Scrollback</guimenu> Menu</title>
565 <variablelist>
567 <varlistentry>
568 <term><menuchoice>
569 <shortcut><keycombo action="simul">&Ctrl;&Shift;<keycap>F</keycap></keycombo></shortcut>
570 <guimenu>Scrollback</guimenu><guimenuitem>Search
571 Output...</guimenuitem></menuchoice></term>
572 <listitem><para><action>Opens a search bar at the bottom of &konsole;'s window
573 </action></para>
574 <para>This allows for case sensitive, forward or backwards, and regular expressions searches.</para>
575 </listitem>
576 </varlistentry>
578 <varlistentry>
579 <term><menuchoice>
580 <shortcut><keycombo><keycap>F3</keycap></keycombo></shortcut>
581 <guimenu>Scrollback</guimenu><guimenuitem>Find
582 Next</guimenuitem></menuchoice></term>
583 <listitem><para><action>Moves to the next search instance
584 </action></para></listitem>
585 </varlistentry>
587 <varlistentry>
588 <term><menuchoice>
589 <shortcut><keycombo action="simul">&Shift;<keycap>F3</keycap></keycombo></shortcut>
590 <guimenu>Scrollback</guimenu><guimenuitem>Find
591 Previous</guimenuitem></menuchoice></term>
592 <listitem><para><action>Moves to the previous search instance
593 </action></para></listitem>
594 </varlistentry>
596 <varlistentry>
597 <term><menuchoice><guimenu>Scrollback</guimenu><guimenuitem>Save
598 Output...</guimenuitem></menuchoice></term>
599 <listitem><para><action>Saves the current scrollback as a text
600 file</action></para></listitem>
601 </varlistentry>
603 <varlistentry>
604 <term><menuchoice><guimenu>Scrollback</guimenu><guimenuitem>Scrollback
605 Options...</guimenuitem></menuchoice></term>
606 <listitem><para><action>Opens a dialog to configure number of lines to save</action>
607 </para></listitem>
608 </varlistentry>
610 <varlistentry>
611 <term><menuchoice><guimenu>Scrollback</guimenu><guimenuitem>Clear
612 Scrollback</guimenuitem></menuchoice></term>
613 <listitem><para><action>Clears all text saved in current tab</action></para></listitem>
614 </varlistentry>
616 <varlistentry>
617 <term><menuchoice>
618 <shortcut><keycombo action="simul">&Ctrl;&Shift;<keycap>X</keycap></keycombo></shortcut>
619 <guimenu>Scrollback</guimenu><guimenuitem>Clear
620 Scrollback &amp; Reset</guimenuitem></menuchoice></term>
621 <listitem><para><action>Clears all text saved in current tab
622 and resets the terminal</action></para></listitem>
623 </varlistentry>
625 </variablelist>
626 </sect2>
628 <sect2 id="bookmarks-menu">
629 <title><guimenu>Bookmarks</guimenu> Menu</title>
631 <variablelist>
633 <varlistentry>
634 <term><menuchoice>
635 <shortcut><keycombo action="simul">&Ctrl;<keycap>B</keycap></keycombo></shortcut>
636 <guimenu>Bookmarks</guimenu><guimenuitem>Add Bookmark</guimenuitem></menuchoice></term>
637 <listitem><para><action>Adds the current location</action></para></listitem>
638 </varlistentry>
640 <varlistentry>
641 <term><menuchoice><guimenu>Bookmarks</guimenu><guimenuitem>Bookmark Tabs as Folder...</guimenuitem></menuchoice></term>
642 <listitem><para><action>Adds all tabs to a bookmark folder</action>
643 </para><para>
644 A dialog will open for the bookmark folder name.
645 </para></listitem>
646 </varlistentry>
648 <varlistentry>
649 <term><menuchoice><guimenu>Bookmarks</guimenu><guimenuitem>New Bookmark Folder...</guimenuitem></menuchoice></term>
650 <listitem><para><action>Adds a new folder to the bookmark list</action>
651 </para><para>
652 A dialog will open for the bookmark folder name.
653 </para></listitem>
654 </varlistentry>
656 <varlistentry>
657 <term><menuchoice><guimenu>Bookmarks</guimenu><guimenuitem>Edit Bookmarks</guimenuitem></menuchoice></term>
658 <listitem><para><action>Opens the bookmark editor</action></para>
660 <note><para>You can use the bookmark editor to manually add URLs
661 like ssh://user@host or telnet://host to open remote connections.</para></note>
662 </listitem>
663 </varlistentry>
665 </variablelist>
666 </sect2>
668 <sect2 id="settings-menu">
669 <title><guimenu>Settings</guimenu> Menu</title>
670 <variablelist>
672 <varlistentry>
673 <term><menuchoice><guimenu>Settings</guimenu><guimenuitem>Change
674 Profile</guimenuitem></menuchoice></term>
675 <listitem><para><action>Changes the profile for the current tab</action></para>
676 </listitem>
677 </varlistentry>
679 <varlistentry>
680 <term><menuchoice><guimenu>Settings</guimenu><guimenuitem>Edit
681 Current Profile...</guimenuitem></menuchoice></term>
682 <listitem><para><action>Opens the profile editor for the current tab</action></para>
683 </listitem>
684 </varlistentry>
686 <varlistentry>
687 <term><menuchoice><guimenu>Settings</guimenu><guimenuitem>Manage
688 Profiles...</guimenuitem></menuchoice></term>
689 <listitem><para><action>Opens a editor for managing profiles</action>
690 </para>
691 </listitem>
692 </varlistentry>
694 <varlistentry>
695 <term><menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure
696 Shortcuts...</guimenuitem></menuchoice></term>
697 <listitem><para><action>Opens the keyboard shortcut editor</action></para>
698 </listitem>
699 </varlistentry>
701 <varlistentry>
702 <term><menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure
703 Notifications...</guimenuitem></menuchoice></term>
704 <listitem><para><action>Opens the notifications editor</action></para>
705 </listitem>
706 </varlistentry>
708 </variablelist>
709 </sect2>
711 <sect2 id="help-menu">
712 <title><guimenu>Help</guimenu> Menu</title>
713 <!-- Only negative to using this is it shows shortcut F1 for Handbook -->
714 &help.menu.documentation;
715 </sect2>
716 </sect1>
718 </chapter>
720 <chapter id="command-line-options">
721 <title>Command-line Options</title>
723 <para>When &konsole; is started from the command line, various options
724 can be specified to modify its behavior.</para>
726 <variablelist>
727 <varlistentry>
728 <term><option>--help</option></term>
729 <listitem><para><action>List the various options</action>.</para></listitem>
730 </varlistentry>
732 <varlistentry>
733 <term><option>--profile</option> <parameter>file</parameter></term>
734 <listitem><para><action>Start &konsole;</action> using a saved set of sessions.</para></listitem>
735 </varlistentry>
737 <varlistentry>
738 <term><option>--list-profiles</option></term>
739 <listitem><para><action>List</action> all of the available profiles.
740 </para></listitem>
741 </varlistentry>
743 <varlistentry>
744 <term><option>--background-mode</option></term>
745 <listitem><para><action>Start &konsole;</action> in the background and bring to the front when the F12 key is pressed.
746 </para></listitem>
747 </varlistentry>
749 <varlistentry>
750 <term><option>--new-tab</option></term>
751 <listitem><para><action>Create a new tab</action> in an existing window rather than creating a new window.
752 </para></listitem>
753 </varlistentry>
755 <varlistentry>
756 <term><option>--workdir</option> <parameter>dir</parameter></term>
757 <listitem><para><action>Open with</action>
758 <parameter>dir</parameter> as the working (starting) directory.</para></listitem>
759 </varlistentry>
761 <varlistentry>
762 <term><option>--notransparency</option></term>
763 <listitem><para><action>Disable</action> transparent backgrounds, even if the system supports them.
764 </para></listitem>
765 </varlistentry>
767 <varlistentry>
768 <term><option>--force-transparency</option></term>
769 <listitem><para><action>Try to enable transparency</action>, even if the system does not appear to support it.
770 </para></listitem>
771 </varlistentry>
773 <varlistentry>
774 <term><option>--hold, --noclose</option></term>
775 <listitem><para><action>Do not close</action> the initial session automatically when it ends.
776 </para></listitem>
777 </varlistentry>
779 <varlistentry>
780 <term><option>-p</option> <parameter>property=value</parameter></term>
781 <listitem><para><action>Change</action> the value of a profile property.</para>
782 </listitem>
783 </varlistentry>
785 <varlistentry>
786 <term><option>-e</option> <parameter>command</parameter></term>
787 <listitem><para><action>Execute</action>
788 <parameter>command</parameter> instead of the normal shell.</para>
789 <note><para>Any arguments after <parameter>command</parameter> will be passed to
790 <parameter>command</parameter>, not &konsole;.</para></note>
791 </listitem>
792 </varlistentry>
794 </variablelist>
796 <para>&konsole; also accepts generic &Qt; and &kde; options:</para>
798 <variablelist>
799 <varlistentry>
800 <term><option>--help-qt</option></term>
801 <listitem><para><action>List &Qt;-specific options</action></para></listitem>
802 </varlistentry>
803 </variablelist>
805 <caution><para>The following &Qt; options have no effect on &konsole;:
806 <informalexample>
807 <variablelist>
809 <varlistentry>
810 <term><option>--fn</option>, <option>--font</option>
811 <parameter>fontname</parameter></term>
812 <listitem><para><action>Defines the application font</action></para></listitem>
813 </varlistentry>
815 <varlistentry>
816 <term><option>--bg</option>, <option>--background</option>
817 <parameter>color</parameter></term>
818 <listitem><para><action>Sets the default background color</action></para></listitem>
819 </varlistentry>
821 <varlistentry>
822 <term><option>--fg</option>, <option>--foreground</option>
823 <parameter>color</parameter></term>
824 <listitem><para><action>Sets the default foreground color</action></para></listitem>
825 </varlistentry>
827 <varlistentry>
828 <term><option>--btn</option>, <option>--button</option>
829 <parameter>color</parameter></term>
830 <listitem><para><action>Sets the default button color</action></para></listitem>
831 </varlistentry>
833 </variablelist>
835 </informalexample>
836 </para></caution>
838 <variablelist>
839 <varlistentry>
840 <term><option>--help-kde</option></term>
841 <listitem><para><action>List &kde;-specific options</action></para></listitem>
842 </varlistentry>
843 <varlistentry>
844 <term><option>--help-all</option></term>
845 <listitem><para><action>List all options</action></para></listitem>
846 </varlistentry>
847 <varlistentry>
848 <term><option>--author</option></term>
849 <listitem><para><action>Show the authors' names</action></para></listitem>
850 </varlistentry>
851 <varlistentry>
852 <term><option>-v,--version</option></term>
853 <listitem><para><action>Show the version number</action></para></listitem>
854 </varlistentry>
855 <varlistentry>
856 <term><option>--license</option></term>
857 <listitem><para><action>Show license information</action></para></listitem>
858 </varlistentry>
859 </variablelist>
861 </chapter>
863 <chapter id="scripting">
864 <title>Scripting &konsole;</title>
866 <para>For &kde; 4, the old &DCOP; has been replaced with &DBus;.
867 However, &konsole; has not been updated yet to handle this.
868 </para>
869 <para>For a somewhat primitive, non-user friendly &GUI; for &DBus;, try &Qt;'s qdbusviewer.
870 </para>
871 <para> More info to follow...</para>
874 </chapter>
876 <chapter id="credits">
877 <title>Credits and Copyright</title>
879 <para>&konsole; is currently maintained by &Robert.Knight; &Robert.Knight.mail;</para>
881 <para>Previous &konsole; maintainers include: &Kurt.Hindenburg; &Kurt.Hindenburg.mail; and &Waldo.Bastian; &Waldo.Bastian.mail;</para>
883 <para>The application &konsole; Copyright &copy; 1997-2008
884 &Lars.Doelle; &Lars.Doelle.mail;</para>
886 <para>This document was written by &Jonathan.Singer;
887 &Jonathan.Singer.mail;</para>
889 <para>This document was updated for &kde; 3.4 by
890 &Kurt.Hindenburg; &Kurt.Hindenburg.mail;</para>
892 <para>This document was updated for &kde; 4.1 by
893 &Kurt.Hindenburg; &Kurt.Hindenburg.mail;</para>
895 <para>Originally converted to DocBook <acronym>SGML</acronym> by
896 &Mike.McBride; and &Lauri.Watts;</para>
898 <!-- TRANS:CREDIT_FOR_TRANSLATORS -->
900 &underFDL;
901 &underGPL;
902 </chapter>
904 <appendix id="links">
905 <title>Links</title>
907 <para>For more information please visit these websites:</para>
908 <itemizedlist>
909 <listitem><para><ulink url="http://konsole.kde.org/">&konsole;'s homepage</ulink></para></listitem>
910 <listitem><para><ulink url="http://mail.kde.org/mailman/listinfo/konsole-devel">&konsole;'s mailing list</ulink></para></listitem>
911 <listitem><para><ulink url="http://freebsd.kde.org/">&kde; on
912 FreeBSD</ulink></para></listitem>
913 <listitem><para><ulink url="http://solaris.kde.org/">&kde; on &Solaris;</ulink></para></listitem>
914 </itemizedlist>
916 </appendix>
918 &documentation.index;
920 </book>
922 <!--
923 Local Variables:
924 mode: sgml
925 sgml-omittag: nil
926 sgml-shorttag: t
927 sgml-general-insert-case: lower
928 End: