Warning, /utilities/konsole/doc/manual/index.docbook is written in an unsupported language. File is not indexed.

0001 <?xml version="1.0" ?>
0002 <!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN"
0003  "dtd/kdedbx45.dtd" [
0004 <!ENTITY % English "INCLUDE">
0005 <!ENTITY % addindex "IGNORE">
0006 <!ENTITY Ahmad.Samir '<personname><firstname>Ahmad</firstname><surname>Samir</surname></personname>'>
0007 <!ENTITY Ahmad.Samir.mail '<email>a.samirh78@gmail.com</email>'>
0008 ]>
0009 
0010 <book id="konsole" lang="&language;">
0011 
0012 <bookinfo>
0013 <title>The &konsole; Handbook</title>
0014 <authorgroup>
0015 <author>&Jonathan.Singer; &Jonathan.Singer.mail;</author>
0016 <author>&Kurt.Hindenburg; &Kurt.Hindenburg.mail;</author>
0017 <author>&Ahmad.Samir; &Ahmad.Samir.mail;</author>
0018 
0019 <othercredit role="developer">
0020 &Robert.Knight; &Robert.Knight.mail;
0021 </othercredit>
0022 
0023 <othercredit role="developer">
0024 &Kurt.Hindenburg; &Kurt.Hindenburg.mail;
0025 </othercredit>
0026 
0027 <othercredit role="developer">
0028 &Waldo.Bastian; &Waldo.Bastian.mail;
0029 </othercredit>
0030 
0031 <othercredit role="reviewer">
0032 &Mike.McBride; &Mike.McBride.mail;
0033 </othercredit>
0034 
0035 <!-- TRANS:ROLES_OF_TRANSLATORS -->
0036 
0037 </authorgroup>
0038 
0039 <copyright>
0040 <year>2000</year><year>2001</year><year>2002</year>
0041 <holder>&Jonathan.Singer;</holder>
0042 </copyright>
0043 <copyright>
0044     <year>2005</year><year>2008</year><year>2009</year><year>2010</year><year>2011</year><year>2014</year><year>2016</year><year>2017</year><year>2018</year><year>2020</year><year>2021</year>
0045 <holder>&Kurt.Hindenburg;</holder>
0046 </copyright>
0047 
0048 <copyright>
0049     <year>2018</year>
0050 <holder>&Ahmad.Samir;</holder>
0051 </copyright>
0052 
0053 <legalnotice>&FDLNotice;</legalnotice>
0054 
0055 <date>2023-04-25</date>
0056 <releaseinfo>KDE Gear 23.08</releaseinfo>
0057 
0058 <abstract><para>&konsole; is &kde;'s terminal emulator.</para></abstract>
0059 
0060 <keywordset>
0061 <keyword>KDE</keyword>
0062 <keyword>konsole</keyword>
0063 <keyword>kdebase</keyword>
0064 <keyword>command</keyword>
0065 <keyword>line</keyword>
0066 <keyword>terminal</keyword>
0067 <keyword>cli</keyword>
0068 </keywordset>
0069 
0070 </bookinfo>
0071 <chapter id="introduction">
0072 <title>Introduction</title>
0073 
0074 <sect1 id="terminal">
0075 <title>What is a terminal?</title>
0076 
0077 <para>&konsole; is an X terminal
0078 emulator, often referred to as a terminal or a shell. It emulates a command line interface in a text only window.
0079 </para>
0080 
0081 <para>&konsole; typically runs a command shell, an application that executes commands that you type.
0082 The shell the &konsole; runs depends on your account settings.
0083 Consult your operating system documentation to know what the shell is, how to configure it and how to use it.
0084 </para>
0085 </sect1>
0086 
0087 <sect1 id="scrollback">
0088 <title>Scrollback</title>
0089 
0090 <para>&konsole; uses the notion of scrollback
0091 to allow users to view previously displayed output.
0092 By default, scrollback is on
0093 and set to save 1000 lines of
0094 output in addition to what is currently displayed on the screen.
0095 </para>
0096 <para>As lines of text scroll off the top of the screen, they can be reviewed
0097 by moving the scroll bar upwards, scrolling with a mouse wheel or through
0098 the use of the
0099 <keycombo action="simul">&Shift;<keycap>Page Up</keycap></keycombo> (to move
0100 back),
0101 <keycombo action="simul">&Shift;<keycap>Page Down</keycap></keycombo> (to move forward),
0102 <keycombo action="simul">&Shift;<keycap>Up Arrow</keycap></keycombo> (to move up a line) and
0103 <keycombo action="simul">&Shift;<keycap>Down Arrow</keycap></keycombo> (to move down a line) keys.
0104 </para>
0105 <para>The amount of scrolling using <keycombo action="simul">&Shift;<keycap>Page Up/Down</keycap></keycombo>
0106 can be switched between half and full page in the <guilabel>Scrolling</guilabel> tab of the profile configuration
0107 window (use <menuchoice><guimenu>Settings</guimenu><guimenuitem>Edit Current Profile...</guimenuitem></menuchoice>
0108 to open this window).
0109 </para>
0110 
0111 </sect1>
0112 
0113 <sect1 id="selection">
0114 <title>Selection Mode</title>
0115 <para>&konsole; has a selection by keyboard mode. In this mode it is possible to move around the scrollback and select text
0116 without the mouse.</para>
0117 
0118 <para>
0119 Enter and leave this mode by using the keyboard shortcut (<keycombo action="simul">&Ctrl;&Shift;<keycap>D</keycap></keycombo> by default).
0120 </para>
0121 
0122 <para>
0123 <keycap>Esc</keycap> also leaves the keyboard selection mode.
0124 </para>
0125 
0126 <para>
0127 Moving the cursor: Arrows, <keycap>PageUp</keycap>, <keycap>PageDown</keycap>, <keycap>Home</keycap>, <keycap>End</keycap>.
0128 </para>
0129 
0130 <para>Moving the cursor <application>vi</application> style: h,j,k,l, to move one character, <keycap>Ctrl</keycap>+b,f,u,d for page up/down or half page up/down.</para>
0131 
0132 <para>
0133 Select text by using <keycap>Ctrl</keycap> or <keycap>Shift</keycap> with arrows, or by using <keycap>V</keycap> to start selection, moving the cursor and then <keycap>V</keycap> again to end selection.
0134 <keycombo>&Shift;<keycap>V</keycap></keycombo> selects whole lines, instead of characters.
0135 </para>
0136 
0137 </sect1>
0138 
0139 
0140 <sect1 id="profiles">
0141 <title>Profiles</title>
0142 <para>Profiles allow the user to quickly and easily automate the running
0143 of common commands.  Examples could include:
0144 
0145 <itemizedlist>
0146 <listitem><para>ssh into another machine</para></listitem>
0147 <listitem><para>starting an irc session</para></listitem>
0148 <listitem><para>use tail to watch a file</para></listitem>
0149 </itemizedlist>
0150 
0151 </para>
0152 
0153 <para>All new and changed profiles are saved in the user's local home folder in <filename>$<envar>XDG_DATA_HOME</envar>/konsole</filename>.</para>
0154 
0155 <para>
0156 Procedure to create a new profile:
0157 <orderedlist>
0158 <listitem><para>Click on the menu entry <menuchoice><guimenu>Settings</guimenu><guimenuitem>Manage Profiles...</guimenuitem>
0159 </menuchoice></para></listitem>
0160 
0161 <listitem><para>Switch to the <guibutton>Profiles</guibutton> page.</para></listitem>
0162 
0163 <listitem><para>Click on the button <guibutton>New Profile...</guibutton>.</para></listitem>
0164 
0165 <listitem><para>Fill in the first entry with a name.  This is the
0166 name that will show in the menu, and will be the default label instead
0167 of <guilabel>Shell</guilabel> when you start a session of this type.
0168 </para></listitem>
0169 
0170 <listitem><para>Enter a command just as you normally would if you opened a new
0171 shell and were going to issue that command.  For our first example above, you
0172 might type <userinput><command>ssh</command> <replaceable>administration</replaceable></userinput>.</para></listitem>
0173 
0174 <listitem><para>On the other tabs of the dialog, configure this session's appearance.
0175 You can configure a different font, color scheme, $<envar>TERM</envar> type and many
0176 other settings for each session.</para></listitem>
0177 
0178 <listitem><para>Press the <guibutton>OK</guibutton> button. The new session
0179 is now available in the <guilabel>Manage Profiles...</guilabel> dialog.
0180 </para></listitem>
0181 
0182 </orderedlist>
0183 </para>
0184 
0185 </sect1>
0186 
0187 <sect1 id="mousebuttons">
0188 
0189 <title>Mouse Buttons</title>
0190 
0191 <para>This section details the use of the mouse buttons for the common
0192 right handed mouse button order.
0193 For the left handed mouse button order, swap left and right in the text below.
0194 </para>
0195 
0196 <variablelist>
0197 
0198 <varlistentry>
0199 <term><mousebutton>Left</mousebutton></term>
0200 
0201 <listitem><para> All &LMB; clicks will be sent to a mouse-aware
0202 application running in &konsole;.
0203 If an application will react on mouse clicks, &konsole;
0204 indicates this by showing an arrow cursor. If not, an I-beam (bar)
0205 cursor is shown.</para>
0206 
0207 <para>Holding the &LMB; down and
0208 dragging the mouse over the screen with a mouse-unaware application
0209 running will mark a region of the text. While dragging the mouse, the marked
0210 text is displayed in reversed color for visual feedback. Select <guimenuitem>Copy</guimenuitem>
0211 from the <guimenu>Edit</guimenu> menu to copy the marked text to the clipboard for further use
0212 within &konsole; or another application. The selected text can also be
0213 dragged and dropped into compatible applications. Hold the &Ctrl; key and
0214 drag the selected text to the desired location.</para>
0215 
0216 <para>Normally, new-line characters are inserted at the end of each
0217 line selected. This is best for cut and paste of source code, or the output
0218 of a particular command. For ordinary text, the line breaks are often
0219 not important. One might prefer, however, for the text to be a stream
0220 of characters that will be automatically re-formatted when pasted into
0221 another application. To select in text-stream mode, hold down the
0222 &Ctrl; key while selecting normally.</para>
0223 
0224 <para>Pressing the &Ctrl; and &Alt; keys along with the &LMB;
0225 will select text in columns.
0226 </para>
0227 
0228 <para>Double-click with the &LMB; to select a word;
0229 triple-click to select an entire line.</para>
0230 
0231 <para>If the upper or lower edge of the text area is touched while
0232 marking, &konsole; scrolls up or down, eventually exposing text within
0233 the history buffer. The scrolling stops when the mouse stops
0234 moving.</para>
0235 
0236 <para>After the mouse is released, &konsole; attempts to keep the text
0237 in the clipboard visible by holding the marked area reversed. The
0238 marked area reverts back to normal as soon as the contents of the
0239 clipboard change, the text within the marked area is altered or the
0240 &LMB; is clicked.</para>
0241 
0242 <para>To mark text in a mouse-aware application (Midnight Commander, for example)
0243 the &Shift; key has to be pressed when clicking.</para>
0244 
0245 </listitem>
0246 </varlistentry>
0247 
0248 <varlistentry>
0249 <term><mousebutton>Middle</mousebutton></term>
0250 
0251 <listitem><para>Pressing the &MMB;
0252 pastes text currently in the clipboard. Holding down the &Ctrl; key as you
0253 press the &MMB; pastes the text and appends a new-line. That is convenient
0254 for executing pasted command quickly, but it can be dangerous so use it
0255 with caution.
0256 </para>
0257 
0258 <note><para>If you have a mouse with only two buttons, pressing both
0259 the &LMB; and &RMB; together emulates the &MMB; of a three button mouse.</para></note>
0260 
0261 <para>If you have a <mousebutton>wheel</mousebutton> as the middle button,
0262 rolling it in a mouse-unaware program will move &konsole;'s scrollbar.</para>
0263 
0264 </listitem>
0265 </varlistentry>
0266 
0267 <varlistentry>
0268 <term><mousebutton>Right</mousebutton></term>
0269 <listitem>
0270 <para>These items appear in the menu when the &RMB;
0271     is pressed:</para>
0272 <itemizedlist>
0273 <listitem><para><guimenuitem>Copy</guimenuitem></para></listitem>
0274 <listitem><para><guimenuitem>Paste</guimenuitem></para></listitem>
0275 <listitem><para>With a text selection a submenu <guisubmenu>Search for</guisubmenu> with a list of the preferred Web Shortcuts and an option to configure web shortcuts.</para></listitem>
0276 <listitem><para><guimenuitem>Open File Manager</guimenuitem></para></listitem>
0277 <listitem><para><guimenuitem>Set Encoding</guimenuitem></para></listitem>
0278 <listitem><para><guimenuitem>Clear Scrollback</guimenuitem></para></listitem>
0279 <listitem><para><guimenuitem>Adjust Scrollback...</guimenuitem></para></listitem>
0280 <listitem><para><guimenuitem>Show Menu Bar</guimenuitem>, only when the menubar is hidden</para></listitem>
0281 <listitem><para><guimenuitem>Switch Profile</guimenuitem></para></listitem>
0282 <listitem><para><guimenuitem>Edit Current Profile...</guimenuitem></para></listitem>
0283 <listitem><para><guimenuitem>Close Tab</guimenuitem></para></listitem>
0284 </itemizedlist>
0285 
0286 <para>In a mouse aware application, press the &Shift; key along with the
0287 &RMB; to get the popup menu.
0288 </para>
0289 
0290 </listitem>
0291 </varlistentry>
0292 </variablelist>
0293 
0294 </sect1>
0295 
0296 <sect1 id="drag-and-drop">
0297 <title>Drag and Drop</title>
0298 <para>If you drop a file, folder or &URL; on a &konsole; window, a context
0299 menu appears with these actions:
0300 </para>
0301 <screenshot>
0302 <screeninfo>Drag and Drop Context Menu</screeninfo>
0303 <mediaobject>
0304 <imageobject>
0305 <imagedata fileref="draganddrop-contextmenu.png" format="PNG" />
0306 </imageobject>
0307 <textobject>
0308 <phrase>Drag and Drop Context Menu</phrase>
0309 </textobject>
0310 </mediaobject>
0311 </screenshot>
0312 
0313 <variablelist>
0314 <varlistentry>
0315 <term><menuchoice>
0316 <shortcut>&Shift;</shortcut><guimenuitem>Move Here</guimenuitem> </menuchoice>
0317 </term> <listitem>
0318 <para>Move the dropped item into the current folder. This item only appears in
0319 the context menu, if you have the rights to delete the dropped file or folder.
0320 </para></listitem>
0321 </varlistentry>
0322 
0323 <varlistentry>
0324 <term><menuchoice>
0325 <shortcut>&Ctrl;</shortcut><guimenuitem>Copy Here</guimenuitem> </menuchoice>
0326 </term> <listitem>
0327 <para>Copy the dropped item into the current folder.</para></listitem>
0328 </varlistentry>
0329 
0330 <varlistentry>
0331 <term><menuchoice>
0332 <shortcut><keycombo>&Ctrl;&Shift;</keycombo></shortcut><guimenuitem>Link Here</guimenuitem> </menuchoice>
0333 </term> <listitem>
0334 <para>Insert a symbolic link to the dropped item.</para></listitem>
0335 </varlistentry>
0336 
0337 <varlistentry>
0338 <term><menuchoice>
0339 <guimenuitem>Paste Location</guimenuitem> </menuchoice>
0340 </term> <listitem>
0341 <para>Insert the full file path of the dropped item at the cursor.</para></listitem>
0342 </varlistentry>
0343 
0344 <varlistentry>
0345 <term><menuchoice>
0346 <guimenuitem>Change Directory To</guimenuitem> </menuchoice>
0347 </term> <listitem>
0348 <para>If a folder is dropped, this action appears in the context menu and allows you to
0349 change the working folder of the &konsole; session.</para></listitem>
0350 </varlistentry>
0351 
0352 <varlistentry>
0353 <term><menuchoice>
0354 <shortcut>&Esc;</shortcut><guimenuitem>Cancel</guimenuitem> </menuchoice>
0355 </term> <listitem>
0356 <para>Break the drag and drop action.</para></listitem>
0357 </varlistentry>
0358 
0359 </variablelist>
0360 
0361 <para>If you press the shortcuts before releasing the &LMB; during drag and drop, no context menu appears and
0362 the actions will be executed immediately.
0363 </para>
0364 
0365 <para>If you want to use the &Ctrl; key for drag and drop or disable the context
0366 menu to insert &URL;s as text by default, enable the corresponding options
0367 on the <guilabel>Mouse</guilabel> tab in the profile settings dialog.
0368 </para>
0369 
0370 </sect1>
0371 
0372 <sect1 id="semantic-shell-integration">
0373 <title>Semantic Shell Integration</title>
0374 
0375 <para>A shell program running in Konsole may emit escape sequences that partition the text
0376 displayed into three types: shell prompt, user input and command output. Using this semantic information enables
0377 various enhancements in Konsole.
0378 
0379 <itemizedlist>
0380 <listitem><para>
0381 <keycombo action="simul">&Ctrl;&Shift;<keycap>PgUp</keycap></keycombo>
0382 and
0383 <keycombo action="simul">&Ctrl;&Shift;<keycap>PgDown</keycap></keycombo>
0384 scroll up/down to previous/next command prompt.</para></listitem>
0385 <listitem><para>Visual hints:</para>
0386 <itemizedlist>
0387 <listitem><para>
0388 A line is displayed above each prompt, prompt colors are less intense,
0389 and output colors are more intense.
0390 </para></listitem>
0391 <listitem><para>
0392 A red bar is displayed to the left of input and output lines of commands that resulted in error
0393 </para></listitem>
0394 <listitem><para>
0395 A red background for input and output lines of commands that resulted in error
0396 </para></listitem>
0397 <listitem><para>
0398 A gray bar is displayed to the left of the input and output lines of every other command.
0399 </para></listitem>
0400 <listitem><para>
0401 A gray background for the input and output lines of every other command.
0402 </para></listitem>
0403 </itemizedlist>
0404 <para>
0405 Each of those may be configured to never show, always show, or only when URL hints are shown. The configuration is in the
0406 <guilabel>Semantic Integration</guilabel> tab of the <guilabel>General</guilabel> page of the profile configuration
0407 window.
0408 </para></listitem>
0409 
0410 <listitem><para>
0411 Context menu options
0412 <guimenuitem>Copy user input</guimenuitem>,
0413 <guimenuitem>Copy command output</guimenuitem>, and
0414 <guimenuitem>Copy except prompt</guimenuitem>
0415 may be used to filter selection when it is copied to the clipboard.
0416 </para></listitem>
0417 <listitem><para>When selection is empty, copy to clipboard action copies the current input line if it is not empty,
0418 or the last output if there is no current input.
0419 </para></listitem>
0420 <listitem><para>Pressing Up/Down arrow when editing a long input, will instead place the cursor one line up/down by
0421 sending the appropriate number of Left/Right key events to the shell. Configurable in the profile settings.</para></listitem>
0422 <listitem><para>Clicking the mouse on text input will place the cursor in the clicked location. Configurable in the profile settings.</para></listitem>
0423 <listitem><para>Pressing the &Ctrl; key while triple clicking the mouse on the output of a command, selects the whole output of that command.</para></listitem>
0424 </itemizedlist>
0425 </para>
0426 
0427 <para>
0428 Semantic shell integration needs to be setup in the shell.
0429 Pressing <keycombo>&Ctrl;&Alt;<keycap>]</keycap></keycombo> will paste the necessary commands needed in bash.
0430 For other shells, such as fish, zsh, python, etc. consult the relevant program's documentation.
0431 </para>
0432 
0433 </sect1>
0434 
0435 
0436 <sect1 id="complex-text-rendering">
0437 <title>Complex Text Layout</title>
0438 
0439 <para>
0440 In the <guilabel>Complex Text Layout</guilabel> page of the <guilabel>Edit Profile</guilabel> dialog, you will find options that control
0441 the rendering of text.
0442 </para>
0443 
0444 <para>
0445 <itemizedlist>
0446 <listitem><para>
0447 <guilabel>Word mode</guilabel> - in this mode (some) strings are displayed in the screen as a whole, instead of a character at a time.
0448 This allows Qt to render text correctly when the shape of a character depends on the characters before or after it. This might result in incorrect position of some characters.
0449 </para><para>
0450 Spaces always break strings, so they are always in the correct positions. This ensures that characters are never too far from their correct position.
0451 </para></listitem>
0452 
0453 <listitem><para>
0454 <guilabel>Use the same attributes for each whole word</guilabel> - When this is enabled, words are rendered with the same attributes (text color, bold, italic, etc.). If an attribute changes mid-word, it will only take effect after the end of the word. When this is disabled, a new word starts when attributes change. This results in characters changing shape and position when moving the cursor or selecting text.
0455 </para></listitem>
0456 
0457 <listitem><para>
0458 <guilabel>ASCII characters</guilabel> -
0459 Group ASCII characters into words as described above. The most noticeable effect of this option is that enabling this shows programming ligatures
0460 (for fonts that support them). E.g. the string &lt;= may be displayed as ⩽.
0461 </para></listitem>
0462 
0463 <listitem><para>
0464 <guilabel>Brahmic scripts characters</guilabel> -
0465 Group Brahmic characters as described above. Without this option (depending on the font) some words may not be connected as they should. With this enabled Brahmic characters may appear out of position. E.g. the third character in the second line might not appear directly under the third character in the first line.
0466 </para></listitem>
0467 
0468 <listitem><para>
0469 <guilabel>Emoji Font:</guilabel> -
0470 This allows specifying the font to use for Unicode Emoji characters. If not set, the default profile font will be used, or some fallback font may be used by the system if the glyphs are missing from this font.
0471 </para></listitem>
0472 
0473 <listitem><para>
0474 <guilabel>Bi-Directional text rendering</guilabel> -
0475 Reorder right to left characters so Arabic and Hebrew texts appear correctly.
0476 </para></listitem>
0477 
0478 <listitem><para>
0479 <guilabel>force LTR line direction</guilabel> -
0480 Lines are always Left to right. Without this, each line's direction is determined by the first character with strong directionality.
0481 </para></listitem>
0482 
0483 <listitem><para>
0484 <guilabel>Table characters BiDi mode override</guilabel> -
0485 Consider graphic table characters as strong LTR characters. This allows table containing RTL characters to display correctly, but might cause incorrect order if those characters are used in RTL texts.
0486 </para></listitem>
0487 
0488 <listitem><para>
0489 <guilabel>Override wcwidth</guilabel> -
0490 Problematic characters follow Unicode standard, rather than glibc's wcwidth(). Currently only soft hyphen (Unicode 0x00AD) which has wcwidth of 1 and Unicode width of 0 is affected by this option. Generally, this option should be disabled when mainly using those characters on the command line, and enabled when they are only displayed.
0491 </para></listitem>
0492 
0493 
0494 </itemizedlist>
0495 </para>
0496 </sect1>
0497 
0498 </chapter>
0499 
0500 <chapter id="commandreference">
0501 <title>Command Reference</title>
0502 
0503 <sect1 id="menubar">
0504 <title>The Menubar</title>
0505 
0506 <para>The menubar is at the top of the &konsole; window.
0507 If the menubar is hidden,
0508 <guimenuitem>Show Menu Bar</guimenuitem> can be reached by
0509 <mousebutton>right</mousebutton> clicking in the window
0510 (as long as no full screen application is running in that
0511 window such as vi, minicom, etc.).  The default shortcut
0512 is listed after each menu item.
0513 </para>
0514 <para>Alternatively you can use the shortcut
0515 <keycombo action="simul">&Ctrl;&Shift;<keycap>M</keycap></keycombo>
0516 to show or hide the menubar.
0517 </para>
0518 <sect2 id="file-menu">
0519 <title>File Menu</title>
0520 
0521 <variablelist>
0522 <varlistentry>
0523 <term><menuchoice>
0524 <shortcut><keycombo action="simul">&Ctrl;&Shift;<keycap>N</keycap></keycombo></shortcut>
0525 <guimenu>File</guimenu><guimenuitem>New Window</guimenuitem>
0526 </menuchoice>
0527 </term>
0528 <listitem><para><action>Opens a new separate &konsole; window with the default profile</action>
0529 </para></listitem></varlistentry>
0530 
0531 <varlistentry>
0532 <term><menuchoice>
0533 <shortcut><keycombo action="simul">&Ctrl;&Shift;<keycap>T</keycap></keycombo></shortcut>
0534 <guimenu>File</guimenu><guimenuitem>New Tab</guimenuitem></menuchoice>
0535 </term>
0536 <listitem><para><action>Opens a new tab with the default profile</action>
0537 <note><para>
0538 The first profile in the submenu will always be "Default" which is the
0539 built-in profile.
0540 All other profiles will be listed below that in alphabetical order.
0541 The user specified default profile will be in bold type.
0542 </para></note>
0543 </para></listitem></varlistentry>
0544 
0545 <varlistentry>
0546 <term><menuchoice>
0547 <guimenu>File</guimenu>
0548 <guimenuitem>Clone Tab</guimenuitem></menuchoice>
0549 </term>
0550 <listitem><para><action>Attempts to clone the current tab in a new tab</action>
0551 </para></listitem>
0552 </varlistentry>
0553 
0554 <varlistentry>
0555 <term><menuchoice>
0556 <shortcut><keycombo action="simul">&Ctrl;&Shift;<keycap>S</keycap></keycombo></shortcut>
0557 <guimenu>File</guimenu>
0558 <guimenuitem>Save Output As...</guimenuitem></menuchoice></term>
0559 <listitem><para><action>Saves the current scrollback as a text or html
0560  file</action></para></listitem>
0561 </varlistentry>
0562 
0563 <varlistentry>
0564 <term><menuchoice>
0565 <shortcut><keycombo action="simul">&Ctrl;&Shift;<keycap>P</keycap></keycombo></shortcut>
0566 <guimenu>File</guimenu>
0567 <guimenuitem>Print Screen ...</guimenuitem></menuchoice></term>
0568 <listitem><para><action>Print the current screen.</action> By default the output is scaled to fit the size of the paper
0569 being printed on with black text color and no background. In the print dialog these options can be changed on the
0570 <guilabel>Output Options</guilabel> tab.</para></listitem>
0571 </varlistentry>
0572 
0573 <varlistentry>
0574 <term><menuchoice><guimenu>File</guimenu>
0575 <guimenuitem>Open File Manager</guimenuitem></menuchoice>
0576 </term>
0577 <listitem><para><action>Opens &kde;'s file manager
0578 at the current directory</action>.  By default, that is
0579 <ulink url="help:/dolphin/index.html">&dolphin;</ulink>.
0580 </para></listitem>
0581 </varlistentry>
0582 
0583 <varlistentry>
0584 <term><menuchoice>
0585 <shortcut><keycombo action="simul">&Ctrl;&Shift;<keycap>W</keycap></keycombo></shortcut>
0586 <guimenu>File</guimenu>
0587 <guimenuitem>Close Session</guimenuitem></menuchoice>
0588 </term>
0589 <listitem><para><action>Closes the current session</action>
0590 </para></listitem>
0591 </varlistentry>
0592 
0593 <varlistentry>
0594 <term><menuchoice>
0595 <shortcut><keycombo action="simul">&Ctrl;&Shift;<keycap>Q</keycap></keycombo></shortcut>
0596 <guimenu>File</guimenu>
0597 <guimenuitem>Close Window</guimenuitem></menuchoice>
0598 </term>
0599 <listitem><para><action>Quits &konsole;</action></para>
0600 <note><para>&konsole; will display a confirmation dialog if there is more than one
0601 session open or if there are certain programs running in any session.
0602 These dialogs can be disabled by clicking on the <guibutton>Do not ask again</guibutton> checkbox.
0603 </para>
0604 </note>
0605 </listitem>
0606 </varlistentry>
0607 
0608 </variablelist>
0609 
0610 </sect2>
0611 
0612 <sect2 id="edit-menu">
0613 <title>Edit Menu</title>
0614 <variablelist>
0615 
0616 <varlistentry>
0617 <term><menuchoice>
0618 <shortcut><keycombo action="simul">&Ctrl;&Shift;<keycap>C</keycap></keycombo></shortcut>
0619 <guimenu>Edit</guimenu>
0620 <guimenuitem>Copy</guimenuitem></menuchoice></term>
0621 <listitem><para><action>Copies the selected text to the clipboard</action></para></listitem>
0622 </varlistentry>
0623 
0624 <varlistentry>
0625 <term><menuchoice>
0626 <shortcut><keycombo
0627  action="simul">&Ctrl;&Shift;<keycap>V</keycap></keycombo></shortcut>
0628 <guimenu>Edit</guimenu><guimenuitem>Paste</guimenuitem></menuchoice></term>
0629 <listitem><para><action>Pastes text from the clipboard at the cursor
0630 location</action></para></listitem>
0631 </varlistentry>
0632 
0633 <varlistentry>
0634 <term><menuchoice>
0635 <guimenu>Edit</guimenu><guimenuitem>Select All</guimenuitem></menuchoice></term>
0636 <listitem><para><action>Selects all</action> the text in current window
0637 </para></listitem>
0638 </varlistentry>
0639 
0640 <varlistentry>
0641 <term><menuchoice>
0642 <guimenu>Edit</guimenu><guisubmenu>Copy Input To</guisubmenu><guimenuitem>All Tabs in Current Window</guimenuitem></menuchoice></term>
0643 <listitem><para><action>Allows input from the current session to be sent simultaneously to all sessions in current window</action>
0644 </para>
0645 </listitem>
0646 </varlistentry>
0647 
0648 <varlistentry>
0649 <term><menuchoice>
0650 <shortcut><keycombo
0651  action="simul">&Ctrl;&Shift;<keycap>.</keycap></keycombo></shortcut>
0652 <guimenu>Edit</guimenu><guisubmenu>Copy Input To</guisubmenu><guimenuitem>Select Tabs...</guimenuitem></menuchoice></term>
0653 <listitem><para><action>Allows input from the current session to be sent simultaneously to sessions picked by user</action>
0654 </para>
0655 </listitem>
0656 </varlistentry>
0657 
0658 <varlistentry>
0659 <term><menuchoice>
0660 <shortcut><keycombo
0661  action="simul">&Ctrl;&Shift;<keycap>/</keycap></keycombo></shortcut>
0662 <guimenu>Edit</guimenu><guisubmenu>Copy Input To</guisubmenu><guimenuitem>None</guimenuitem></menuchoice></term>
0663 <listitem><para><action>Stop sending input from current session into other sessions</action>
0664 </para>
0665 </listitem>
0666 </varlistentry>
0667 
0668 <varlistentry>
0669 <term><menuchoice><guimenu>Edit</guimenu>
0670 <guisubmenu>Send Signal</guisubmenu></menuchoice></term>
0671 <listitem><para><action>Send the specified signal to the shell
0672 process, or other process, that was launched when the new session was
0673 started</action>.</para><para>Currently available signals are:</para>
0674 
0675 <informaltable>
0676 <tgroup cols="2">
0677 <tbody>
0678 <row>
0679 <entry><errorcode>STOP</errorcode></entry>
0680 <entry>to stop process</entry>
0681 </row>
0682 <row>
0683 <entry><errorcode>CONT</errorcode></entry>
0684 <entry>continue if stopped</entry>
0685 </row>
0686 <row>
0687 <entry><errorcode>HUP</errorcode></entry>
0688 <entry>hangup detected on controlling terminal, or death of controlling
0689 process</entry>
0690 </row>
0691 <row>
0692 <entry><errorcode>INT</errorcode></entry>
0693 <entry>interrupt from keyboard</entry>
0694 </row>
0695 <row>
0696 <entry><errorcode>TERM</errorcode></entry>
0697 <entry>termination signal</entry>
0698 </row>
0699 <row>
0700 <entry><errorcode>KILL</errorcode></entry>
0701 <entry>kill signal</entry>
0702 </row>
0703 <row>
0704 <entry><errorcode>USR1</errorcode></entry>
0705 <entry>user signal 1</entry>
0706 </row>
0707 <row>
0708 <entry><errorcode>USR2</errorcode></entry>
0709 <entry>user signal 2</entry>
0710 </row>
0711 </tbody>
0712 </tgroup>
0713 </informaltable>
0714 
0715 <para>Refer to your system manual pages for further details by giving the
0716 command <userinput><command>man</command> <option>7
0717 signal</option></userinput>.</para></listitem>
0718 </varlistentry>
0719 
0720 <varlistentry>
0721 <term><menuchoice>
0722 <shortcut><keycombo
0723  action="simul">&Ctrl;&Alt;<keycap>S</keycap></keycombo></shortcut>
0724 <guimenu>Edit</guimenu><guimenuitem>Configure Tab Settings...</guimenuitem></menuchoice></term>
0725 <listitem><para><action>Opens a dialog box allowing you to change
0726 the name format, the remote tab title format and the color of the current tab</action>
0727 (<link linkend="configure-tab-settings-dialog">more info</link>)
0728 </para></listitem>
0729 </varlistentry>
0730 
0731 <varlistentry>
0732 <term><menuchoice>
0733 <shortcut><keycombo
0734  action="simul">&Ctrl;&Alt;<keycap>U</keycap></keycombo></shortcut>
0735 <guimenu>Edit</guimenu><guimenuitem>ZModem Upload...</guimenuitem></menuchoice></term>
0736 <listitem><para><action>Opens up a dialog to select a file to be uploaded if the required software is installed</action>
0737 </para>
0738 </listitem>
0739 </varlistentry>
0740 
0741 <varlistentry>
0742 <term><menuchoice>
0743 <shortcut><keycombo action="simul">&Ctrl;&Shift;<keycap>F</keycap></keycombo></shortcut>
0744 <guimenu>Edit</guimenu><guimenuitem>Find...</guimenuitem></menuchoice></term>
0745 <listitem><para><action>Opens a search bar at the bottom of &konsole;'s window
0746 </action></para>
0747 <para>This allows for case sensitive, forward or backwards, and regular expressions searches.</para>
0748 </listitem>
0749 </varlistentry>
0750 <!--FIXME 4.12
0751 Various search improvements
0752   - Do not automatically reset the search start line on search hits
0753  This was causing the annoying behavior that if you were to pause while typing
0754  in a search term, and it would actually find a hit, then you would be searching
0755  for the term a second time once you finish typing.
0756 
0757  This commit introduces two new behaviors:
0758  1. When you show the search bar, all searching will be done from the first
0759  visible line in the terminal.
0760  2. This start position is only reset when you
0761  advance to the next result, by pressing "next", "previous", or the shortcuts
0762  RETURN or SHIFT-RETURN
0763 
0764  - When the view scrolls to a result, it will appear centered.
0765  - When showing the search bar, do not invoke a search, only apply the highlight filters
0766  - Add "search from beginning/end" button
0767  This will scroll to the top/bottom before searching
0768  Ctrl+return is also bound to this action
0769  - Text highlighted by mouse will be set as the current search text when the incremental
0770  search bar is opened
0771  - Add "Search backwards" to search bar options
0772  Button text is swapped according to reverse search switch
0773 -->
0774 <varlistentry>
0775 <term><menuchoice>
0776 <shortcut><keycombo><keycap>F3</keycap></keycombo></shortcut>
0777 <guimenu>Edit</guimenu><guimenuitem>Find
0778 Next</guimenuitem></menuchoice></term>
0779 <listitem><para><action>Moves to the next search instance
0780 </action>. If the search bar has the focus, you can use the shortcut &Enter; as well.</para></listitem>
0781 </varlistentry>
0782 
0783 <varlistentry>
0784 <term><menuchoice>
0785 <shortcut><keycombo action="simul">&Shift;<keycap>F3</keycap></keycombo></shortcut>
0786 <guimenu>Edit</guimenu><guimenuitem>Find
0787 Previous</guimenuitem></menuchoice></term>
0788 <listitem><para><action>Moves to the previous search instance
0789 </action>. If the search bar has the focus, you can use the shortcut <keycombo action="simul">&Shift;&Enter;</keycombo> as well.</para></listitem>
0790 </varlistentry>
0791 
0792 
0793 </variablelist>
0794 </sect2>
0795 
0796 <sect2 id="view-menu">
0797 <title>View Menu</title>
0798 <variablelist>
0799 
0800 <varlistentry>
0801 <term><menuchoice>
0802 <shortcut><keycombo action="simul">&Ctrl;<keycap>(</keycap></keycombo></shortcut>
0803 <guimenu>View</guimenu><guisubmenu>Split View</guisubmenu><guimenuitem>Split
0804 View Left/Right</guimenuitem></menuchoice>
0805 </term>
0806 <listitem><para><action>Splits all the tabs into left and right views</action>
0807 </para><para>
0808 Any output on one view is duplicated in the other view.
0809 </para></listitem>
0810 </varlistentry>
0811 
0812 <varlistentry>
0813 <term><menuchoice>
0814 <shortcut><keycombo action="simul">&Ctrl;<keycap>)</keycap></keycombo></shortcut>
0815 <guimenu>View</guimenu><guisubmenu>Split View</guisubmenu><guimenuitem>Split
0816 View Top/Bottom</guimenuitem></menuchoice>
0817 </term>
0818 <listitem><para><action>Splits all the tabs into top and bottom views</action>
0819 </para><para>
0820 Any output on one view is duplicated in the other view.
0821 </para></listitem>
0822 </varlistentry>
0823 
0824 <varlistentry>
0825 <term><menuchoice>
0826 <shortcut><keycombo action="simul">&Ctrl;&Shift;<keycap>]</keycap></keycombo></shortcut>
0827 <guimenu>View</guimenu><guisubmenu>Split View</guisubmenu><guimenuitem>Expand View</guimenuitem></menuchoice>
0828 </term>
0829 <listitem><para><action>Makes the current view larger</action>
0830 </para></listitem>
0831 </varlistentry>
0832 
0833 <varlistentry>
0834 <term><menuchoice>
0835 <shortcut><keycombo action="simul">&Ctrl;&Shift;<keycap>[</keycap></keycombo></shortcut>
0836 <guimenu>View</guimenu><guisubmenu>Split View</guisubmenu><guimenuitem>Shrink View</guimenuitem></menuchoice>
0837 </term>
0838 <listitem><para><action>Makes the current view smaller</action>
0839 </para></listitem>
0840 </varlistentry>
0841 
0842 <varlistentry>
0843 <term><menuchoice>
0844 <shortcut><keycombo action="simul">&Ctrl;&Shift;<keycap>E</keycap></keycombo></shortcut>
0845 <guimenu>View</guimenu><guisubmenu>Split View</guisubmenu><guimenuitem>Toggle maximize current view</guimenuitem></menuchoice>
0846 </term>
0847 <listitem><para><action>Toggles the current view between current size and the maximize size</action>
0848 </para></listitem>
0849 </varlistentry>
0850 
0851 <varlistentry>
0852 <term><menuchoice>
0853 <shortcut><keycombo action="simul">&Ctrl;&Shift;<keycap>\</keycap></keycombo></shortcut>
0854 <guimenu>View</guimenu><guisubmenu>Split View</guisubmenu><guimenuitem>Equal size to all views</guimenuitem></menuchoice>
0855 </term>
0856 <listitem><para><action>Sets the same size for all views</action>
0857 </para></listitem>
0858 </varlistentry>
0859 
0860 <varlistentry>
0861 <term><menuchoice>
0862 <shortcut><keycombo action="simul">&Ctrl;&Shift;<keycap>L</keycap></keycombo></shortcut>
0863 <guimenu>View</guimenu><guimenuitem>Detach Current Tab</guimenuitem></menuchoice>
0864 </term>
0865 <listitem><para><action>Opens the current tab in a
0866 separate window</action>
0867 </para><para>
0868 Quitting the previous &konsole; window will not
0869 affect the newly created window.
0870 </para></listitem>
0871 </varlistentry>
0872 
0873 <varlistentry>
0874 <term><menuchoice>
0875 <shortcut><keycombo action="simul">&Ctrl;&Shift;<keycap>H</keycap></keycombo></shortcut>
0876 <guimenu>View</guimenu><guimenuitem>Detach Current View</guimenuitem></menuchoice>
0877 </term>
0878 <listitem><para><action>Opens the current split view in a
0879 separate window</action>
0880 </para></listitem>
0881 </varlistentry>
0882 
0883 <varlistentry id="save-layout">
0884 <term><menuchoice>
0885 <guimenu>View</guimenu><guimenuitem>Save tab layout to file</guimenuitem></menuchoice>
0886 </term>
0887 <listitem><para><action>Allows you to save the tab layout of the current view in a specialized
0888 &konsole; layout file which can then be loaded to restore one of your favorite layouts.</action>
0889 </para></listitem>
0890 </varlistentry>
0891 
0892 <varlistentry>
0893 <term><menuchoice>
0894 <guimenu>View</guimenu><guimenuitem>Load tab layout from file</guimenuitem></menuchoice>
0895 </term>
0896 <listitem><para><action>Allows you to load one of your favorite view layouts from the layout file that
0897             has been saved using the <menuchoice><guimenu>View</guimenu><guimenuitem>Save tab layout to file</guimenuitem></menuchoice>
0898 menu item earlier.</action> The default layouts (2x2, 2x1, and 1x2) can be loaded via toolbar.
0899 </para></listitem>
0900 </varlistentry>
0901 
0902 <varlistentry>
0903 <term><menuchoice>
0904 <guimenu>View</guimenu><guimenuitem>One-shot monitors</guimenuitem></menuchoice></term>
0905 <listitem><para><action>The following monitors only notify once, and are then disabled.  </action>
0906 </para></listitem>
0907 </varlistentry>
0908 
0909 <varlistentry>
0910 <term><menuchoice>
0911 <shortcut><keycombo action="simul">&Ctrl;&Shift;<keycap>R</keycap></keycombo></shortcut>
0912 <guimenu>View</guimenu><guimenuitem>Monitor for
0913 Prompt</guimenuitem></menuchoice></term>
0914 <listitem><para><action>Toggles the monitoring of the current tab for
0915 a shell prompt.</action>
0916 </para><para>
0917 When a shell prompt is displayed, &konsole; will show a notification. This option is shown only when semantic integration is enabled in the shell.
0918 </para></listitem>
0919 </varlistentry>
0920 
0921 <varlistentry>
0922 <term><menuchoice>
0923 <shortcut><keycombo action="simul">&Ctrl;&Shift;<keycap>I</keycap></keycombo></shortcut>
0924 <guimenu>View</guimenu><guimenuitem>Monitor for
0925 Silence</guimenuitem></menuchoice></term>
0926 <listitem><para><action>Toggles the monitoring of the current tab for
0927 lack of activity</action>
0928 </para><para>
0929 By default, after 10 seconds of inactivity, an info icon will appear on
0930 the session's tab.
0931 The type of alerts can be changed through
0932 <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure Notifications</guimenuitem><guimenuitem>Silence in monitored session</guimenuitem></menuchoice>.
0933 </para></listitem>
0934 </varlistentry>
0935 
0936 <varlistentry>
0937 <term><menuchoice>
0938 <shortcut><keycombo action="simul">&Ctrl;&Shift;<keycap>A</keycap></keycombo></shortcut>
0939 <guimenu>View</guimenu><guimenuitem>Monitor for
0940 Activity</guimenuitem></menuchoice></term>
0941 <listitem><para><action>Toggles the monitoring of the current tab for
0942 activity</action>
0943 </para><para>
0944 Upon any activity, an info icon will appear on the session's tab.
0945 The type of alerts can be changed through
0946 <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure Notifications</guimenuitem><guimenuitem>Activity in monitored session</guimenuitem></menuchoice>.
0947 </para></listitem>
0948 </varlistentry>
0949 
0950 <varlistentry>
0951 <term><menuchoice>
0952 <guimenu>View</guimenu><guimenuitem>Monitor for
0953 Process Finishing</guimenuitem></menuchoice></term>
0954 <listitem><para><action>Toggles the monitoring of the current tab for
0955 the process finishing</action>.
0956 </para><para>
0957 If checked, upon finishing the current process, &konsole; will show a notification <guilabel>The process '<replaceable>name of the process</replaceable>' has finished running in session '<replaceable>name of the session</replaceable>'</guilabel>.
0958 </para></listitem>
0959 </varlistentry>
0960 
0961 <varlistentry>
0962 <term><menuchoice>
0963 <guimenu>View</guimenu><guimenuitem>Read-only</guimenuitem></menuchoice></term>
0964 <listitem><para><action>Toggles the session to be read-only: no input is accepted,
0965 drag and drop is disabled.
0966 </action></para></listitem>
0967 </varlistentry>
0968 
0969 <varlistentry>
0970 <term><menuchoice>
0971 <shortcut><keycombo action="simul">&Ctrl;<keycap>+</keycap></keycombo></shortcut>
0972 <guimenu>View</guimenu><guimenuitem>Enlarge Font</guimenuitem></menuchoice></term>
0973 <listitem><para><action>Increases the text font size</action></para></listitem>
0974 </varlistentry>
0975 
0976 <varlistentry>
0977 <term><menuchoice>
0978 <shortcut><keycombo action="simul">&Ctrl;<keycap>0</keycap></keycombo></shortcut>
0979 <guimenu>View</guimenu><guimenuitem>Reset Font Size</guimenuitem></menuchoice></term>
0980 <listitem><para><action>Reset the text font size to the profile default</action></para></listitem>
0981 </varlistentry>
0982 
0983 
0984 <varlistentry>
0985 <term><menuchoice>
0986 <shortcut><keycombo action="simul">&Ctrl;<keycap>-</keycap></keycombo></shortcut>
0987 <guimenu>View</guimenu><guimenuitem>Shrink Font</guimenuitem></menuchoice></term>
0988 <listitem><para><action>Decreases the text font size</action></para></listitem>
0989 </varlistentry>
0990 
0991 <varlistentry>
0992 <term><menuchoice><guimenu>View</guimenu>
0993 <guimenuitem>Set Encoding</guimenuitem></menuchoice></term>
0994 <listitem><para><action>Sets the character encoding</action></para></listitem>
0995 </varlistentry>
0996 
0997 <varlistentry>
0998 <term><menuchoice><guimenu>View</guimenu><guimenuitem>Clear Scrollback</guimenuitem></menuchoice></term>
0999 <listitem><para><action>Clears the text in the scrollback</action></para>
1000 </listitem>
1001 </varlistentry>
1002 
1003 <varlistentry>
1004 <term><menuchoice>
1005 <shortcut><keycombo action="simul">&Ctrl;&Shift;<keycap>K</keycap></keycombo></shortcut>
1006 <guimenu>View</guimenu><guimenuitem>Clear
1007 Scrollback and Reset</guimenuitem></menuchoice></term>
1008 <listitem><para><action>Clears the text in the current tab and scrollback
1009 and resets the terminal</action></para></listitem>
1010 </varlistentry>
1011 
1012 <varlistentry>
1013 <term><menuchoice>
1014 <shortcut><keycap>F11</keycap></shortcut>
1015 <guimenu>View</guimenu><guimenuitem>Full Screen Mode</guimenuitem></menuchoice></term>
1016 <listitem><para><action>Toggles &konsole; filling the entire screen</action></para></listitem>
1017 </varlistentry>
1018 
1019 </variablelist>
1020 </sect2>
1021 
1022 <sect2 id="bookmarks-menu">
1023 <title>Bookmarks Menu</title>
1024 
1025 <variablelist>
1026 
1027 <varlistentry>
1028 <term><menuchoice>
1029 <shortcut><keycombo action="simul">&Ctrl;&Shift;<keycap>B</keycap></keycombo></shortcut>
1030 <guimenu>Bookmarks</guimenu><guimenuitem>Add Bookmark</guimenuitem></menuchoice></term>
1031 <listitem><para><action>Adds the current location</action></para></listitem>
1032 </varlistentry>
1033 
1034 <varlistentry>
1035 <term><menuchoice><guimenu>Bookmarks</guimenu><guimenuitem>Bookmark Tabs as Folder...</guimenuitem></menuchoice></term>
1036 <listitem><para><action>Adds all tabs to a bookmark folder</action>
1037 </para><para>
1038 A dialog will open for the bookmark folder name.
1039 </para></listitem>
1040 </varlistentry>
1041 
1042 <varlistentry>
1043 <term><menuchoice><guimenu>Bookmarks</guimenu><guimenuitem>New Bookmark Folder...</guimenuitem></menuchoice></term>
1044 <listitem><para><action>Adds a new folder to the bookmark list</action>
1045 </para><para>
1046 A dialog will open for the bookmark folder name.
1047 </para></listitem>
1048 </varlistentry>
1049 
1050 <varlistentry>
1051 <term><menuchoice><guimenu>Bookmarks</guimenu><guimenuitem>Edit Bookmarks</guimenuitem></menuchoice></term>
1052 <listitem><para><action>Opens the bookmark editor</action></para>
1053 <note><para>The keditbookmarks program must be installed for this menu item to appear.</para>
1054 <para>You can use the bookmark editor to manually add URLs.
1055 Currently, &konsole; accepts the following:
1056 <itemizedlist mark="opencircle">
1057 <listitem><para>ssh://user@host:port</para></listitem>
1058 <listitem><para>telnet://user@host:port</para></listitem>
1059 </itemizedlist>
1060 </para></note>
1061 
1062 </listitem>
1063 </varlistentry>
1064 
1065 </variablelist>
1066 </sect2>
1067 
1068 <sect2 id="plugins-menu">
1069 <title>Plugins Menu</title>
1070 
1071 <para>Any installed plugins will be listed or
1072 "No plugins available"
1073 </para>
1074 
1075 </sect2>
1076 
1077 
1078 <sect2 id="settings-menu">
1079 <title>Settings Menu</title>
1080 <variablelist>
1081 
1082 <varlistentry>
1083 <term><menuchoice><guimenu>Settings</guimenu><guimenuitem>Edit
1084 Current Profile...</guimenuitem></menuchoice></term>
1085 <listitem><para><action>Opens a dialog to configure current profile</action>
1086 </para>
1087 </listitem>
1088 </varlistentry>
1089 
1090 <varlistentry>
1091 <term><menuchoice><guimenu>Settings</guimenu><guimenuitem>Switch Profile
1092 </guimenuitem></menuchoice></term>
1093 <listitem><para><action>Switch current profile to a listed profile</action>
1094 </para>
1095 </listitem>
1096 </varlistentry>
1097 
1098 <varlistentry>
1099 <term><menuchoice><guimenu>Settings</guimenu><guimenuitem>Manage
1100 Profiles...</guimenuitem></menuchoice></term>
1101 <listitem><para><action>Opens an editor for managing profiles</action>
1102 </para>
1103 </listitem>
1104 </varlistentry>
1105 
1106 <varlistentry>
1107 <term><menuchoice><guimenu>Settings</guimenu><guimenuitem>Window
1108 Color Scheme</guimenuitem></menuchoice></term>
1109 <listitem><para><action>Change &konsole;'s &GUI; to the specified scheme</action>
1110 </para>
1111 </listitem>
1112 </varlistentry>
1113 
1114 <varlistentry>
1115 <term><menuchoice>
1116 <shortcut><keycombo
1117  action="simul">&Ctrl;&Shift;<keycap>M</keycap></keycombo></shortcut>
1118 <guimenu>Settings</guimenu><guimenuitem>Show
1119 Menu Bar</guimenuitem></menuchoice></term>
1120 <listitem><para><action>Toggles the menubar being visible</action></para></listitem>
1121 </varlistentry>
1122 
1123 <varlistentry>
1124 <term><menuchoice><guimenu>Settings</guimenu><guimenuitem>Toolbars Shown</guimenuitem></menuchoice></term>
1125 <listitem><para><action>Allows visibility toggling of the &konsole; toolbars</action></para>
1126 </listitem>
1127 </varlistentry>
1128 
1129 <varlistentry>
1130 <term><menuchoice>
1131 <guimenu>Settings</guimenu><guimenuitem>Show Statusbar</guimenuitem></menuchoice></term>
1132 <listitem><para><action>Toggles the statusbar being visible</action></para></listitem>
1133 </varlistentry>
1134 
1135 <varlistentry>
1136 <term><menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure Language...
1137 </guimenuitem></menuchoice></term>
1138 <listitem><para><action>Opens window to choose an interface translation of &konsole;.</action>
1139 </para>
1140 </listitem>
1141 </varlistentry>
1142 
1143 <varlistentry>
1144 <term><menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure Keyboard
1145 Shortcuts...</guimenuitem></menuchoice></term>
1146 <listitem><para><action>Opens the keyboard shortcut editor.</action> More on shortcuts configuration
1147 can be found in the <ulink url="help:/fundamentals/shortcuts.html">&kde; Fundamentals</ulink>.</para>
1148 
1149 <para>Additionally &konsole; has a few special shortcuts with no corresponding menu item:</para>
1150 
1151 <informaltable>
1152 <tgroup cols="2">
1153 <thead>
1154 <row>
1155 <entry>Shortcut</entry>
1156 <entry>Description</entry>
1157 </row>
1158 </thead>
1159 <tbody>
1160 <row>
1161 <entry><keycombo action="simul">&Shift;<keysym>Right</keysym></keycombo></entry>
1162 <entry>Next Tab</entry>
1163 </row>
1164 <row>
1165 <entry><keycombo action="simul">&Shift;<keysym>Left</keysym></keycombo></entry>
1166 <entry>Previous Tab</entry>
1167 </row>
1168 <row>
1169 <entry><keycombo action="simul">&Ctrl;&Alt;<keysym>Left</keysym></keycombo></entry>
1170 <entry>Move Tab Left</entry>
1171 </row>
1172 <row>
1173 <entry><keycombo action="simul">&Ctrl;&Alt;<keysym>Right</keysym></keycombo></entry>
1174 <entry>Move Tab Right</entry>
1175 </row>
1176 <row>
1177 <entry><keycombo action="simul">&Ctrl;&Shift;<keysym>Ins</keysym></keycombo></entry>
1178 <entry>Paste Selection</entry>
1179 </row>
1180 </tbody>
1181 </tgroup>
1182 </informaltable>
1183 
1184 </listitem>
1185 </varlistentry>
1186 
1187 <varlistentry>
1188 <term><menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure
1189 Toolbars...</guimenuitem></menuchoice></term>
1190 <listitem><para><action>Opens <ulink url="help:/fundamentals/config.html#toolbars-items">the toolbar configuration window</ulink></action></para>
1191 </listitem>
1192 </varlistentry>
1193 
1194 <varlistentry>
1195 <term><menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure
1196 Notifications...</guimenuitem></menuchoice></term>
1197 <listitem><para><action>Opens the notifications editor</action></para>
1198 </listitem>
1199 </varlistentry>
1200 
1201 <varlistentry>
1202 <term><menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure
1203 &konsole;...</guimenuitem></menuchoice></term>
1204 <listitem><para><action>Opens the &konsole; settings editor</action></para>
1205 <para>
1206     This dialog has options influencing the appearance and behaviour of the &konsole; window.
1207 </para>
1208 <itemizedlist>
1209     <listitem>
1210         <para>
1211             The <guilabel>General</guilabel> page allows configuring the menubar visibility,
1212             remembering the &konsole; window size, running all &konsole; windows in a single process,
1213             enabling menu accelerators, showing window title on the titlebar, removing window titlebar and frame, and focusing terminals when the mouse pointer is moved over them.
1214             It is also possible to configure the search case sensitivity, usage of the regular expression,
1215             highlighting all matches, and the search direction (<guilabel>Search backwards</guilabel> is the default).
1216             The <guilabel>General</guilabel> page is also the place where you can <guibutton>Enable all "Don't Ask Again" messages</guibutton>
1217             again if they were switched off before.
1218         </para>
1219     </listitem>
1220     <listitem>
1221         <para>
1222             The <guilabel>Profiles</guilabel> page is meant for creating and handling <link linkend="profiles">profiles</link>.
1223         </para>
1224     </listitem>
1225     <listitem>
1226         <para>
1227             Using the <guilabel>Tab Bar/Splitters</guilabel> page you can configure the visibility and
1228             placement of tab bar, define tabs behavior and fine-tune the tab buttons options. It is possible to configure if you want to
1229             <guilabel>Show 'New Tab' button</guilabel> and <guilabel>Expand individual tab widths to full window</guilabel>
1230             or configure <guilabel>Use user-defined stylesheet</guilabel>. The <guilabel>Behavior</guilabel> tab can
1231             be used to define the place for the new tabs (<guilabel>At the end</guilabel> or <guilabel>After current tab</guilabel>)
1232             and closing of tabs with a &MMB; click.
1233         </para>
1234         <para>
1235             It is also possible to configure visibility of the split headers (<guilabel>When needed</guilabel> (default), <guilabel>Always</guilabel>, or <guilabel>Never</guilabel>) and define the drag handle size for splits (<guilabel>Small</guilabel> (default), <guilabel>Medium</guilabel>, or <guilabel>Large</guilabel>) using the <guilabel>Splits</guilabel> tab of this configuration page.
1236         </para>
1237     </listitem>
1238     <listitem>
1239         <para>
1240             The <guilabel>Temporary Files</guilabel> page is used to define the <link linkend="scrollback">scrollback</link> file location.
1241         </para>
1242     </listitem>
1243     <listitem>
1244         <para>
1245             The <guilabel>Thumbnails</guilabel> page can be used to define the thumbnail size and activation options
1246             (you can choose the activation control key from &Shift;, &Alt;, and &Ctrl;).
1247         </para>
1248         <note>
1249             <para>
1250                 To use the thumbnails feature showing image thumbnails in popups when hovering image items with the mouse pointer, you should enable file underlining for your current profile: <menuchoice><guimenu>Settings</guimenu><guimenuitem>Edit Current Profile...</guimenuitem><guimenuitem>Mouse</guimenuitem><guimenuitem>Miscellaneous</guimenuitem><guimenuitem>Underline files</guimenuitem></menuchoice>.
1251             </para>
1252         </note>
1253     </listitem>
1254 </itemizedlist>
1255 </listitem>
1256 </varlistentry>
1257 
1258 </variablelist>
1259 </sect2>
1260 
1261 <sect2 id="help-menu">
1262 <title>Help Menu</title>
1263 <para>&konsole; has the some of the common &kde; <guimenu>Help</guimenu>
1264 menu items, for more information read the section about the <ulink url="help:/fundamentals/menus.html#menus-help">Help Menu</ulink>
1265 of the &kde; Fundamentals.
1266 </para><!-- Only negative to using this is that it shows shortcut F1 for Handbook -->
1267 </sect2>
1268 
1269 </sect1>
1270 
1271 <sect1 id="console-dialogs">
1272 <title>&konsole; Dialogs</title>
1273 
1274 <sect2 id="configure-tab-settings-dialog">
1275 <title>Configure Tab Settings Dialog</title>
1276 
1277 <para>The name format, the remote tab title format, and the color of the current tab can be changed from this dialog.
1278 The dialog can be displayed via the menu, the shortcut <keycombo
1279  action="simul">&Ctrl;&Alt;<keycap>S</keycap></keycombo> or by
1280 double-clicking on the tab in the tab bar.
1281 These changes are temporary and can be made permanent by editing the current profile.
1282 </para>
1283 
1284 <para>
1285 &konsole; will substitute these tokens for local tabs:
1286 </para>
1287 <itemizedlist mark="opencircle">
1288 <listitem><para>%n : program name</para></listitem>
1289 <listitem><para>%d : current directory (short)</para></listitem>
1290 <listitem><para>%D : current directory (long)</para></listitem>
1291 <listitem><para>%h : local host (short)</para></listitem>
1292 <listitem><para>%u : user name</para></listitem>
1293 <listitem><para>%B : user's Bourne prompt sigil ($ = normal user, # = superuser)</para></listitem>
1294 <listitem><para>%w : window title set by shell</para></listitem>
1295 <listitem><para>%# : session number</para></listitem>
1296 </itemizedlist>
1297 
1298 <para>
1299 &konsole; will substitute these tokens for remote tabs:
1300 <itemizedlist mark="opencircle">
1301     <listitem><para>%c : current program</para></listitem>
1302     <listitem><para>%h : remote host (short)</para></listitem>
1303     <listitem><para>%H : remote host (long)</para></listitem>
1304     <listitem><para>%u : user name</para></listitem>
1305     <listitem><para>%U : user name@ (if given)</para></listitem>
1306     <listitem><para>%w : window title set by shell</para></listitem>
1307     <listitem><para>%# : session number</para></listitem>
1308 </itemizedlist>
1309 
1310 </para>
1311 <para>
1312 Examples:
1313 <itemizedlist mark="opencircle">
1314 
1315 <listitem><para>
1316 <userinput>%d : %n</userinput>
1317  with /usr/src as current directory and running
1318 <application>bash</application> will display
1319 <guibutton>src : bash</guibutton>
1320 </para></listitem>
1321 
1322 <listitem><para>
1323 <userinput>%D : %n</userinput>
1324  with /usr/src as current directory and running
1325 <application>top</application> will display
1326 <guibutton>/usr/src : top</guibutton>
1327 </para></listitem>
1328 
1329 <listitem><para>
1330 <userinput>%w (%#)</userinput>
1331  with ~ as current directory and running
1332 <application>vim</application> in the first tab will display
1333 <guibutton>[No Name] (~) - VIM(1)</guibutton>
1334 </para></listitem>
1335 
1336 </itemizedlist>
1337 
1338 </para>
1339 
1340 </sect2>
1341 
1342 <sect2 id="copy-input-dialog">
1343 <title>Copy Input Dialog</title>
1344 
1345 <para>The text entered in one tab can simultaneously be sent to other tabs.
1346 This dialog allows you to select which tabs will get that input.
1347 The current tab will be greyed out.
1348 <!--
1349 <screenshot>
1350 <screeninfo>A picture of the copy input dialog</screeninfo>
1351 <mediaobject>
1352 <imageobject>
1353 <imagedata fileref="copyinputdialog.png" format="PNG" />
1354 </imageobject>
1355 <textobject>
1356 <phrase>A picture of the copy input dialog</phrase>
1357 </textobject>
1358 </mediaobject>
1359 </screenshot>
1360 -->
1361 
1362 </para>
1363 
1364 </sect2>
1365 
1366 <sect2 id="scrollback-options-dialog">
1367 <title>Adjust Scrollback Dialog</title>
1368 
1369 <para>The
1370 <link linkend="scrollback">scrollback</link>
1371 options for the history size can be changed in this dialog.  Any changes are
1372 for the current tab only and will not be saved to the profile.
1373 </para>
1374 
1375 </sect2>
1376 
1377 </sect1>
1378 
1379 </chapter>
1380 
1381 <chapter id="command-line-options">
1382 <title>Command-line Options</title>
1383 
1384 <para>When &konsole; is started from the command line, various options
1385 can be specified to modify its behavior.</para>
1386 
1387 <variablelist>
1388 <varlistentry>
1389 <term><option>--help</option></term>
1390 <listitem><para><action>List various options</action>.</para></listitem>
1391 </varlistentry>
1392 
1393 <varlistentry>
1394 <term><option>--profile</option> <parameter>file</parameter></term>
1395 <listitem><para><action>Start &konsole;</action> using the specified profile
1396 instead of the default profile.</para></listitem>
1397 </varlistentry>
1398 
1399 <varlistentry>
1400 <term><option>--layout</option> <parameter>file</parameter></term>
1401 <listitem><para><action>Start &konsole;</action> using a <link linkend="save-layout">saved &JSON; layout file</link>.</para></listitem>
1402 </varlistentry>
1403 
1404 <varlistentry>
1405 <term><option>--builtin-profile</option></term>
1406 <listitem><para>Use the built-in profile instead of the current default profile.</para></listitem>
1407 </varlistentry>
1408 
1409 <varlistentry>
1410 <term><option>--workdir</option> <parameter>dir</parameter></term>
1411 <listitem><para><action>Open with</action>
1412 <parameter>dir</parameter> as the initial working directory.</para></listitem>
1413 </varlistentry>
1414 
1415 <varlistentry>
1416 <term><option>--hold, --noclose</option></term>
1417 <listitem><para><action>Do not close</action> the initial session automatically when it ends.
1418 </para></listitem>
1419 </varlistentry>
1420 
1421 <varlistentry>
1422 <term><option>--new-tab</option></term>
1423 <listitem><para><action>Create a new tab</action> in an existing window rather than creating a new window.
1424 </para></listitem>
1425 </varlistentry>
1426 
1427 <varlistentry>
1428 <term><option>--tabs-from-file </option><parameter>file</parameter></term>
1429 <listitem><para><action>Create tabs</action> as specified in the given tabs configuration file.
1430 </para>
1431 <note><para>The file has one tab per line in the following format:</para>
1432 <para>Each line specifies a tab to open using up to 4 fields specifying how it is to open.
1433 Fields are delimited with <userinput>;;</userinput> and a field name must have a <userinput>:</userinput> appended.
1434 Empty lines or lines with <userinput>#</userinput> at the beginning are ignored, so you can use line beginning with
1435 <userinput>#</userinput> to add comments.
1436 </para>
1437 
1438 <simplelist>
1439 <member><userinput>title:</userinput> a name for this tab, tab default if blank or not specified</member>
1440 <member><userinput>workdir:</userinput> working directory, <filename class="directory"> ~</filename> if blank or not specified</member>
1441 <member><userinput>profile:</userinput> a &konsole; profile to use, the default if blank or not specified</member>
1442 <member><userinput>command:</userinput> a command to run</member>
1443 </simplelist>
1444 <para>Each line should contain at least one of <userinput>command</userinput> or <userinput>profile</userinput> field.
1445 </para>
1446 <para>Example: <userinput>title: %n;; command: /usr/bin/top ;; profile: Shell</userinput></para>
1447 </note>
1448 </listitem>
1449 </varlistentry>
1450 
1451 <varlistentry>
1452 <term><option>--background-mode</option></term>
1453 <listitem><para><action>Start &konsole;</action> in the background and bring to the front when <keycombo action="simul">&Ctrl;&Shift;<keycap>F12</keycap></keycombo> (by default) is pressed.
1454 </para></listitem>
1455 </varlistentry>
1456 
1457 <varlistentry>
1458 <term><option>--separate</option></term>
1459 <term><option>--nofork</option></term>
1460 <listitem><para><action>Run</action> the new instance of &konsole; in a separate process.
1461 </para></listitem>
1462 </varlistentry>
1463 
1464 <varlistentry>
1465 <term><option>--show-menubar</option></term>
1466 <listitem><para><action>Show</action> the menubar, overriding the default behavior.
1467 </para></listitem>
1468 </varlistentry>
1469 
1470 <varlistentry>
1471 <term><option>--hide-menubar</option></term>
1472 <listitem><para><action>Hide</action> the menubar, overriding the default behavior.
1473 </para></listitem>
1474 </varlistentry>
1475 
1476 <varlistentry>
1477 <term><option>--show-tabbar</option></term>
1478 <listitem><para><action>Show</action> the tabbar, overriding the default behavior.
1479 </para></listitem>
1480 </varlistentry>
1481 
1482 <varlistentry>
1483 <term><option>--hide-tabbar</option></term>
1484 <listitem><para><action>Hide</action> the tabbar, overriding the default behavior.
1485 </para></listitem>
1486 </varlistentry>
1487 
1488 <varlistentry>
1489 <term><option>--fullscreen</option></term>
1490 <listitem><para><action>Start &konsole; in fullscreen mode</action>.</para></listitem>
1491 </varlistentry>
1492 
1493 <varlistentry>
1494 <term><option>--notransparency</option></term>
1495 <listitem><para><action>Disable</action> transparent backgrounds, even if the system supports them.
1496 </para></listitem>
1497 </varlistentry>
1498 
1499 <varlistentry>
1500 <term><option>--list-profiles</option></term>
1501 <listitem><para><action>List</action> all available profiles.
1502 </para></listitem>
1503 </varlistentry>
1504 
1505 <varlistentry>
1506 <term><option>--list-profile-properties</option></term>
1507 <listitem>
1508 <para><action>List</action> all possible properties with name and type. See option <option>-p</option>.
1509 </para>
1510 <para>
1511 For more information, please visit
1512 <ulink url="https://api.kde.org/4.14-api/applications-apidocs/konsole/html/classKonsole_1_1Profile.html">&konsole; API Reference</ulink>.
1513 <!--FIXME update url to kf5 when available on api.kde.org-->
1514 </para>
1515 </listitem>
1516 </varlistentry>
1517 
1518 <varlistentry>
1519 <term><option>-p</option> <parameter>property=value</parameter></term>
1520 <listitem><para><action>Change</action> the value of a profile property.</para>
1521 </listitem>
1522 </varlistentry>
1523 
1524 <varlistentry>
1525 <term><option>-e</option> <parameter>command</parameter></term>
1526 <listitem><para><action>Execute</action>
1527 <parameter>command</parameter> instead of the normal shell.</para>
1528 <note><para>This option will catch all following arguments passed to &konsole;, and execute it as <parameter>command</parameter>. So this option should always be used as the last option.</para></note>
1529 </listitem>
1530 </varlistentry>
1531 
1532 </variablelist>
1533 
1534 <para>&konsole; also accepts generic &Qt; and &kf5-full; options, see man pages qt5options and kf5options.</para>
1535 
1536 </chapter>
1537 
1538 <chapter id="scripting">
1539 <title>Scripting &konsole;</title>
1540 
1541 <para>&konsole; does support numerous methods that can be used with &DBus;.
1542 </para>
1543 <para>There are two ways to use the &DBus; interface: &Qt;'s &GUI;
1544 <application>qdbusviewer</application>
1545 and the command line
1546 <application>qdbus</application>.
1547 </para>
1548 
1549 <para>
1550 Examples:
1551 <itemizedlist mark='opencircle'>
1552 
1553 <listitem><para>
1554 <prompt>&percnt;</prompt>
1555 <command>qdbus</command>
1556 will display all services available.
1557 </para></listitem>
1558 
1559 <listitem><para>
1560 <prompt>&percnt;</prompt>
1561 <command>qdbus</command>
1562 <option>org.kde.konsole</option>
1563 will display the &DBus; interface for &konsole;.
1564 </para></listitem>
1565 
1566 <listitem><para>
1567 <prompt>&percnt;</prompt>
1568 <command>qdbus</command>
1569 <option>org.kde.konsole /Windows/1</option>
1570 will display methods for controlling window 1.
1571 </para>
1572 </listitem>
1573 
1574 <listitem><para>
1575 <prompt>&percnt;</prompt>
1576 <command>qdbus</command>
1577 <option>org.kde.konsole $KONSOLE_DBUS_WINDOW</option>
1578 will display methods for controlling the current window.
1579 </para></listitem>
1580 
1581 <listitem><para>
1582 <prompt>&percnt;</prompt>
1583 <command>qdbus</command>
1584 <option>org.kde.konsole /Sessions/1</option>
1585 will display methods for controlling session 1.
1586 </para></listitem>
1587 
1588 <listitem><para>
1589 <prompt>&percnt;</prompt>
1590 <command>qdbus</command>
1591 <option>org.kde.konsole $KONSOLE_DBUS_SESSION</option>
1592 will display methods for controlling the current session.
1593 </para></listitem>
1594 
1595 <listitem><para>
1596 <prompt>&percnt;</prompt>
1597 <command>qdbus</command>
1598 <option>$KONSOLE_DBUS_SERVICE $KONSOLE_DBUS_SESSION</option>
1599 will display methods for controlling the current &konsole;'s session.
1600 </para></listitem>
1601 
1602 </itemizedlist>
1603 </para>
1604 
1605 <para>
1606 If any of the above commands outputs:
1607 Service 'org.kde.konsole' does not exist, change
1608 <option>org.kde.konsole</option> to one of the following:
1609 
1610 <itemizedlist>
1611 
1612 <listitem><para>
1613 <option>org.kde.konsole-`pidof -s konsole`</option>
1614 (will select first pid)
1615 </para></listitem>
1616 <listitem><para>
1617 <option>$KONSOLE_DBUS_SERVICE</option>
1618 (this can be used from the current &konsole;)
1619 </para></listitem>
1620 <listitem><para>
1621 <option>select one from the output of 'qdbus | grep konsole'</option>
1622 </para></listitem>
1623 
1624 </itemizedlist>
1625 </para>
1626 
1627 <para>
1628 For more information, please visit
1629 <ulink url="https://techbase.kde.org/Development/Tutorials/D-Bus/Introduction">&DBus; tutorial</ulink>.
1630 </para>
1631 
1632 </chapter>
1633 
1634 <chapter id="key-bindings">
1635 <title>Terminal Key Bindings</title>
1636 
1637 <sect1>
1638 <title>How &konsole; Uses Key Bindings</title>
1639 
1640 <sect2 id="intro">
1641 <title>Introduction</title>
1642 <para>&konsole; uses *.keytab files to translate key combinations into control characters and escape sequences that are sent to the shell or to interactive programs (typically programs that use the Alternate Screen buffer, &eg; <application>vim</application>, <application>less</application>, <application>screen</application>) running in the shell.</para>
1643 
1644 <para>Users can customize the key bindings settings in &konsole; using the Key Bindings Editor. A key combination can be configured to send a specific control or escape sequence to the terminal.</para>
1645 
1646 <para>You can open the Key Bindings Editor from the menu entry <menuchoice><guimenu>Settings</guimenu><guimenuitem>Edit Current Profile</guimenuitem></menuchoice>, and going to the <guilabel>Keyboard</guilabel> tab. Listed there are the Key Bindings schemas that come by default with &konsole;.</para>
1647 </sect2>
1648 
1649 <sect2 id="table-fields">
1650 <title>Key Combinations and Modes</title>
1651 
1652 <para>Key combinations follow the pattern:
1653 <programlisting>Key (+|-) Modes</programlisting>
1654 </para>
1655 
1656 <para>for example:
1657 <programlisting>
1658 Up+Shift+AppScreen
1659 Down+Shift-AppScreen
1660 Space+Ctrl
1661 </programlisting>
1662 </para>
1663 
1664 <para>Key names are defined in the qnamespace.h header file, with the <quote>Qt::Key_</quote> prefix removed, for a list of key names check the <ulink url="https://doc.qt.io/qt-5/qt.html#Key-enum">Qt::Key enumeration in the &Qt; documentation</ulink>.</para>
1665 
1666 <para>A <quote>+</quote> preceding a Mode name means that mode is <emphasis>set</emphasis>; for a modifier key, that means it's pressed, whereas for all other modes it means that particular mode is in effect (&ie; active). For example <quote>+Ctrl</quote> means the key combination will work only if the &Ctrl; key is pressed.</para>
1667 
1668 <para>A <quote>-</quote> preceding a Mode name means that mode is <emphasis>reset</emphasis>; basically this is the opposite of putting <quote>+</quote> before a Mode name, so for a modifier key that means the key isn't pressed, whereas for all other modes it means that particular mode is inactive. For example <quote>-Ctrl</quote> means the key combination will work only if the &Ctrl; key is <emphasis>not</emphasis> pressed.</para>
1669 
1670 <note>
1671 <para>If a Mode name isn't present in a key combination, its state is ignored.</para>
1672 </note>
1673 
1674 <para>The supported Key Bindings modes are listed below:</para>
1675 
1676 <variablelist>
1677 
1678 <varlistentry>
1679 <term>Alt, Ctrl, Shift</term>
1680 <listitem>
1681 <para>One or more of these Modes can be used in a key combination, if any of them is set, the key combination uses that modifier key, respectively; and vice versa if it's reset</para>
1682 </listitem>
1683 </varlistentry>
1684 
1685 <varlistentry>
1686 <term>AnyModifier</term>
1687 <listitem>
1688 <para>If this mode is set, the key combination uses any modifier key (any of the previous three modifier keys); and vice versa if it's reset</para>
1689 </listitem>
1690 </varlistentry>
1691 
1692 <varlistentry>
1693 <term>Ansi</term>
1694 <listitem>
1695 <para>If this mode is set, &konsole; will send ANSI escape and control sequences</para>
1696 <para>If this mode is reset &konsole; will send VT52 escape and control sequences</para>
1697 </listitem>
1698 </varlistentry>
1699 
1700 <varlistentry>
1701 <term>AppScreen</term>
1702 <listitem>
1703 <para>If this mode is set, the key combination will only affect interactive programs that use the Alternate Screen buffer</para>
1704 <para>If this mode is reset the key combination will only affect the terminal when it's using the Normal Screen buffer</para>
1705 
1706 <note>
1707 <para>&konsole; makes use of two screen buffers:</para>
1708 <itemizedlist>
1709 <listitem>
1710 <para>The Normal Screen buffer (default): allows you to scroll back to view previous lines of output, this is the default buffer you usually use to execute commands... &etc;</para>
1711 </listitem>
1712 <listitem>
1713 <para>The Alternate Screen buffer: the terminal switches to this buffer when you run an interactive program (&eg; <application>less</application>, <application>vim</application>, <application>screen</application>, <application>tmux</application>... &etc;)</para>
1714 </listitem>
1715 </itemizedlist>
1716 </note>
1717 
1718 </listitem>
1719 </varlistentry>
1720 
1721 <varlistentry>
1722 <term>KeyPad</term>
1723 <listitem>
1724 <para>If this mode is set, the key combination uses a key on the Keypad (Number Pad). This mode is useful to distinguish between keys on the keyboard and keys on the Keypad. For example when Num Lock is <emphasis>on</emphasis> you can configure two separate key combinations, one using the key labelled <quote>1</quote> on the keyboard (usually under the <keycap>F1</keycap> key) and the other using the key labelled <quote>1</quote> on the Keypad. The same concept applies when Num Lock is <emphasis>off</emphasis> for the End, Home, Cursor Keys ...etc on the Keypad</para>
1725 </listitem>
1726 </varlistentry>
1727 
1728 <varlistentry>
1729 <term>AppCursorKeys</term>
1730 <listitem>
1731 <para>This mode implements the VT100 <ulink url="https://www.vt100.net/docs/vt100-ug/chapter3.html#DECCKM">Cursor Keys Mode (DECCKM)</ulink>. It controls the escape sequences each Cursor Key (<keycap>Up</keycap>, <keycap>Down</keycap>, <keycap>Right</keycap>, <keycap>Left</keycap>) sends, depending on whether this mode is set or reset</para>
1732 <para>By default &konsole; follows the XTerm behavior of treating the <keycap>Home</keycap> and <keycap>End</keycap> keys as cursor keys with respect to DECCKM</para>
1733 </listitem>
1734 </varlistentry>
1735 
1736 <varlistentry>
1737 <term>AppKeyPad</term>
1738 <listitem>
1739 <para>If this mode is set, the key combination will only work when the Keypad is in Application Mode (DECKPAM)</para>
1740 <para>If this mode is reset, the key combination will only work when the Keypad is in Numeric Mode (DECKPNM)</para>
1741 </listitem>
1742 </varlistentry>
1743 
1744 <varlistentry>
1745 <term>NewLine</term>
1746 <listitem>
1747 <para>If this mode is set, the <keycap>Return</keycap> (Enter) key on the keyboard will send both Carriage Return "\r" and New Line "\n" control characters</para>
1748 <para>If this mode is reset, the <keycap>Return</keycap> key will send only a Carriage Return "\r"</para>
1749 <para>The same applies to the <keycap>Enter</keycap> key on the Keypad</para>
1750 <para>This mode emulates the <ulink url="https://www.vt100.net/docs/vt100-ug/chapter3.html#LNM">LNM - Line Feed/New Line Mode</ulink></para>
1751 </listitem>
1752 </varlistentry>
1753 
1754 </variablelist>
1755 
1756 <para>Note that each combination of Key and Modes (set/reset) must be unique. For example, consider the following two rules:</para>
1757 
1758 <itemizedlist>
1759 <listitem><para>A+Shift : <quote>A</quote></para></listitem>
1760 <listitem><para>a       : <quote>a</quote></para></listitem>
1761 </itemizedlist>
1762 <para>&konsole; will <emphasis>not</emphasis> accept the small letter <quote>a</quote> rule, you have to add a <quote>-Shift</quote> to that rule to make it work.</para>
1763 </sect2>
1764 
1765 <sect2 id="output-field">
1766 <title>The Output Field</title>
1767 
1768 <para>In the Output field you can add the escape sequences or control characters that you want &konsole; to send to the terminal when the associated key combination is pressed.</para>
1769 
1770 <para>You can also use any of the following keywords, each of which has a special meaning in &konsole;:</para>
1771 
1772 <itemizedlist>
1773 <listitem><para>scrollUpLine       : scroll up one line in the shell history scrollback buffer</para></listitem>
1774 <listitem><para>scrollUpPage       : scroll up one page in the shell history scrollback buffer</para></listitem>
1775 <listitem><para>scrollDownLine     : scroll down one line in the shell history scrollback buffer</para></listitem>
1776 <listitem><para>scrollDownPage     : scroll down one page in the shell history scrollback buffer</para></listitem>
1777 <listitem><para>scrollUpToTop      : scroll up to the begining of the shell history scrollback buffer</para></listitem>
1778 <listitem><para>scrollDownToBottom : scroll down to the end of the shell history scrollback buffer</para></listitem>
1779 </itemizedlist>
1780 
1781 <para>You can also use strings with C-string syntax; you may use the following escapes sequences:</para>
1782 
1783 <itemizedlist>
1784 <listitem><para>\E   : Escape</para></listitem>
1785 <listitem><para>\\   : Backslash</para></listitem>
1786 <listitem><para>\"   : Double quote</para></listitem>
1787 <listitem><para>\t   : Tab</para></listitem>
1788 <listitem><para>\r   : Carriage Return</para></listitem>
1789 <listitem><para>\n   : New line</para></listitem>
1790 <listitem><para>\b   : Backspace</para></listitem>
1791 <listitem>
1792 <para>\xHH : where HH are two hex digits</para>
1793 <tip>
1794 <para>This can be used to send &ASCII; control characters, &eg; <quote>\x00</quote> which is the NUL character</para>
1795 </tip>
1796 </listitem>
1797 </itemizedlist>
1798 
1799 </sect2>
1800 
1801 <sect2 id="other-factors">
1802 <title>Other System Resources</title>
1803 <para>There are other system resources that can affect terminal Key Bindings:</para>
1804 <itemizedlist>
1805 <listitem>
1806 <para>Consult the <ulink url="man:terminfo(5)">terminfo</ulink> or <ulink url="man:termcap(5)">termcap</ulink> database for the expected escape sequences and control characters that each key combination is supposed to send.</para>
1807 </listitem>
1808 <listitem>
1809 <para>It is likely that your system has other keyboard databases which have to be in sync too, (&eg; <ulink url="man:bash(1)">/etc/inputrc and readline</ulink> for the <application>BASH shell</application>) as they affect the operations (interactions) bound to key combinations.</para>
1810 </listitem>
1811 </itemizedlist>
1812 </sect2>
1813 
1814 <sect2 id="further-reading">
1815 <title>Further Reading</title>
1816 <para>For more information on escape sequences and control characters, check the following documentation:</para>
1817 <itemizedlist>
1818 <listitem>
1819 <para><ulink url="https://www.vt100.net/docs/vt100-ug/">The VT100 user guide</ulink></para>
1820 </listitem>
1821 <listitem>
1822 <para><ulink url="https://vt100.net/docs/vt102-ug/">The VT102 user guide</ulink></para>
1823 </listitem>
1824 <listitem>
1825 <para>The comprehensive and indispensable <ulink url="https://invisible-island.net/xterm/ctlseqs/ctlseqs.html">XTerm Control Sequences</ulink> documentation</para>
1826 </listitem>
1827 </itemizedlist>
1828 </sect2>
1829 </sect1>
1830 
1831 </chapter>
1832 
1833 <chapter id="tabbarstylsheet">
1834 <title>Using Style Sheet for the Tab Bar</title>
1835 <para>
1836 The default style sheet for the tab bar sets the minimum and maximum tab
1837 widths.  The user can create a <filename role="extension">.css</filename> file and have &konsole; use that as the
1838 style sheet for the tab bar.  In the <filename role="extension">.css</filename> file, the widget to use is
1839 <userinput>QTabBar::tab</userinput>.
1840 </para>
1841 <para>
1842 For more information, consider reading
1843 <ulink url="https://doc.qt.io/qt-5/stylesheet.html">&Qt; Style Sheets</ulink>
1844 </para>
1845 
1846 <para>
1847 Examples:
1848 
1849 </para>
1850 
1851 <para>
1852 <itemizedlist mark='opencircle'>
1853 
1854 <listitem><para>
1855 Change the selected tab's background to a light gray
1856 <programlisting>
1857 QTabBar::tab:selected {
1858     background: #999999
1859 }
1860 </programlisting>
1861 </para></listitem>
1862 
1863 
1864 <listitem><para>
1865 Change the selected tab's text to red
1866 <programlisting>
1867 QTabBar::tab:selected {
1868     color: red
1869 }
1870 </programlisting>
1871 </para></listitem>
1872 
1873 <listitem><para>
1874 All tabs will be at least 200 pixels in width
1875 <programlisting>
1876 QTabBar::tab {
1877     min-width: 200px
1878 }
1879 </programlisting>
1880 </para></listitem>
1881 
1882 <listitem><para>
1883 Only the selected tab will be at least 200 pixels in width
1884 <programlisting>
1885 QTabBar::tab::selected {
1886     min-width: 200px
1887 }
1888 </programlisting>
1889 </para></listitem>
1890 
1891 <listitem><para>
1892 Any of these can be combined in one file
1893 <programlisting>
1894 QTabBar::tab::selected {
1895     background: #999999;
1896     color: red;
1897     min-width: 200px;
1898 }
1899 QTabBar::tab {
1900     min-width: 100px
1901 }
1902 </programlisting>
1903 </para></listitem>
1904 
1905 
1906 </itemizedlist>
1907 </para>
1908 
1909 </chapter>
1910 
1911 <chapter id="faqtips">
1912 <title>Did You Know?, Common Issues and More</title>
1913 
1914 <sect1 id="didyouknow">
1915 <title>Did You Know?</title>
1916 <para>
1917 <itemizedlist mark='opencircle'>
1918 
1919 <listitem><para>
1920 Pressing &Ctrl; while selecting text will cause lines breaks to be converted to spaces when pasted.
1921 </para></listitem>
1922 
1923 <listitem><para>
1924 Pressing the <keycombo action="simul">&Ctrl;&Alt;</keycombo> keys while selecting text will select columns.
1925 </para></listitem>
1926 
1927 <listitem><para>
1928 The <keycombo action="simul">&Ctrl;<mousebutton>Wheel</mousebutton></keycombo> combination will zoom text size, like in konqueror and firefox.
1929 </para></listitem>
1930 
1931 <listitem><para>
1932 When a program evaluates either mouse button, pressing the &Shift; key will allow the popup menu to appear.
1933 </para></listitem>
1934 
1935 <listitem><para>
1936 The <keycombo action="simul">&Ctrl;&Shift;<keycap>F10</keycap></keycombo> shortcut will activate the menu.
1937 </para></listitem>
1938 
1939 <listitem><para>
1940 The <keycombo action="simul">&Shift;<keycap>Insert</keycap></keycombo> keys will insert the clipboard.
1941 </para></listitem>
1942 
1943 <listitem><para>
1944 Double-clicking will select a whole word. Continuing to hold the mouse button and moving the mouse will extend the selection.
1945 </para></listitem>
1946 
1947 <listitem><para>
1948 Triple-clicking will select a whole line. Continuing to hold the mouse button and moving the mouse will extend the selection.
1949 </para></listitem>
1950 
1951 <listitem><para>
1952 There is a hidden feature for the "%d" formatter in tab title. You can tell &konsole; to abbreviate a directory name into its first character. For example, "/path/to/konsole/src" can be abbreviated into "konsole/s". If you want to enable and control this hidden feature, open <filename>konsolerc</filename>
1953 in <userinput><command>qtpaths</command> <option>--paths GenericConfigLocation</option></userinput> and add following lines:</para>
1954 
1955 <para><programlisting>
1956 [ProcessInfo]
1957 CommonDirNames=name1,name2,name3...
1958 </programlisting>
1959 
1960 <note><para>If you are using <application>Yakuake</application>, you need to edit <filename>yakuakerc</filename>
1961 in <userinput><command>qtpaths</command> <option>--paths GenericConfigLocation</option></userinput> instead.</para></note>
1962 
1963 </para></listitem>
1964 
1965 </itemizedlist>
1966 </para>
1967 
1968 </sect1>
1969 
1970 <sect1 id="commonissues">
1971 <title>Common Issues</title>
1972 <itemizedlist>
1973 
1974 <listitem>
1975 <para>Some fonts might be unavailable for usage in &konsole;, although they are available in other applications. That doesn't mean there is a bug in &konsole;. &konsole; requires monospaced fonts to provide the best visual result, so it asks &Qt; to only list monospaced fonts.</para>
1976 
1977 <para>Starting with version 16.08 (August 2016), &konsole; can be configured to allow selecting any font with the caveat that the display may not be correct.</para>
1978 </listitem>
1979 
1980 <listitem><para>
1981 Since KDE4 all the tabs use the same process ID. This has the side-effect that if one tab's process has issues, all the other tabs may experience issues as well.
1982 </para>
1983 <para>
1984 This is most noticeable when a command that connects to an external device or system (ssh, nfs) has issues.
1985 </para></listitem>
1986 
1987 <listitem><para>
1988 &konsole; treats arguments after the <option>-e</option> option as one command and runs it directly, instead  of parsing it and possibly dividing it into sub-commands for execution. This is different from xterm.
1989 </para>
1990 
1991 <para>
1992     <itemizedlist mark='opencircle'>
1993 
1994     <listitem><para>
1995 <command>konsole -e "command1 ; command2"</command> does not work
1996     </para></listitem>
1997 
1998     <listitem><para>
1999 <command>konsole -e $SHELL -c "command1 ; command2"</command> works
2000     </para></listitem>
2001 
2002     </itemizedlist>
2003 </para>
2004 </listitem>
2005 
2006 <listitem><para>
2007 &konsole; doesn't provide convenience for running login shell, because developers don't like the idea of running login shell in a terminal emulator.
2008 </para>
2009 <para>
2010 Of course, users still can run login shell in &konsole; if they really need to. Edit the profile in use and modify its command to the form of starting a login shell explicitly, such as "<command>bash -l</command>" and "<command>zsh -l</command>".
2011 </para>
2012 </listitem>
2013 
2014 <listitem><para>
2015 The <option>--new-tab</option> option sometimes behaves strangely. It may create new window, or it may create new tab in another existing &konsole; window instead of the current &konsole; window.
2016 </para>
2017 <para>
2018 Those behaviors feel strange, but they are not necessarily bugs. The <option>--new-tab</option> option tries to reuse existing &konsole; windows, but not all &konsole; windows are reusable. All &konsole; windows opened through &krunner; are reusable, while most &konsole; windows opened from command line are not.
2019 </para>
2020 </listitem>
2021 
2022 </itemizedlist>
2023 
2024 </sect1>
2025 
2026 </chapter>
2027 
2028 <chapter id="credits">
2029 <title>Credits and Copyright</title>
2030 
2031 <para>&konsole; is currently maintained by &Kurt.Hindenburg;  &Kurt.Hindenburg.mail;</para>
2032 
2033 <para>Previous &konsole; maintainers include: &Robert.Knight; &Robert.Knight.mail; and &Waldo.Bastian; &Waldo.Bastian.mail;</para>
2034 
2035 <para>The application &konsole; Copyright &copy; 1997-2008
2036 &Lars.Doelle; &Lars.Doelle.mail;</para>
2037 
2038 <para>This document was originally written by &Jonathan.Singer;
2039 &Jonathan.Singer.mail;</para>
2040 
2041 <para>This document was updated for &kde; 4.x by
2042 &Kurt.Hindenburg; &Kurt.Hindenburg.mail;</para>
2043 
2044 <para>This document was updated for &kde; 3.4 by
2045 &Kurt.Hindenburg; &Kurt.Hindenburg.mail;</para>
2046 
2047 <para>Originally converted to DocBook <acronym>SGML</acronym> by
2048 &Mike.McBride; and &Lauri.Watts;</para>
2049 
2050 <!-- TRANS:CREDIT_FOR_TRANSLATORS -->
2051 
2052 &underFDL;
2053 &underGPL;
2054 </chapter>
2055 
2056 <appendix id="links">
2057 <title>Links</title>
2058 
2059 <para>For more information please visit these websites:</para>
2060 <itemizedlist>
2061 <listitem><para><ulink url="https://userbase.kde.org/Konsole">&konsole;'s homepage on &kde;'s UserBase</ulink>&nbsp;</para></listitem>
2062 <listitem><para><ulink url="https://konsole.kde.org/">&konsole;'s homepage</ulink></para></listitem>
2063 <listitem><para><ulink url="https://mail.kde.org/mailman/listinfo/konsole-devel">&konsole;'s mailing list</ulink></para></listitem>
2064 <listitem><para><ulink url="https://freebsd.kde.org/">&kde; on
2065 FreeBSD</ulink></para></listitem>
2066 <listitem><para><ulink url="https://solaris.kde.org/">&kde; on &Solaris;</ulink></para></listitem>
2067 </itemizedlist>
2068 
2069 </appendix>
2070 
2071 &documentation.index;
2072 
2073 </book>
2074 
2075 <!--
2076 Local Variables:
2077 mode: sgml
2078 sgml-omittag: nil
2079 sgml-shorttag: t
2080 sgml-general-insert-case: lower
2081 End:
2082 -->
2083 
2084