summaryrefslogtreecommitdiffstats
path: root/tde-i18n-en_GB/docs/tdebase/konsole/index.docbook
blob: 0a94326cbf75a130eea7fd272402d3b1c69dab19 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
<?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN"
 "dtd/kdex.dtd" [
<!ENTITY kappname "&konsole;">
<!ENTITY package "tdebase">
<!ENTITY % British-English "INCLUDE">
<!ENTITY % addindex "IGNORE">
]>

<book lang="&language;">

<bookinfo>
<title
>The &konsole; Handbook</title>
<authorgroup>
<author
>&Jonathan.Singer; &Jonathan.Singer.mail;</author>

<othercredit role="developer"
>&Waldo.Bastian; &Waldo.Bastian.mail; </othercredit>

<othercredit role="reviewer"
>&Mike.McBride; &Mike.McBride.mail; </othercredit>

<othercredit role="translator"
><firstname
>John</firstname
><surname
>Knight</surname
><affiliation
><address
><email
>anarchist_tomato@herzeleid.net</email
></address
></affiliation
><contrib
>Conversion to British English</contrib
></othercredit
> 

</authorgroup>

<copyright>
<year
>2000</year
><year
>2001</year
><year
>2002</year>
<holder
>&Jonathan.Singer;</holder>
</copyright>

<legalnotice
>&FDLNotice;</legalnotice>

<date
>2002-10-05</date>
<releaseinfo
>1.20.00</releaseinfo>

<abstract
><para
>This document is the user handbook for the &konsole; application.</para>
<para
>&konsole; is an X terminal emulator for &kde;.</para
></abstract>

<keywordset>
<keyword
>KDE</keyword>
<keyword
>konsole</keyword>
<keyword
>tdebase</keyword>
<keyword
>command</keyword>
<keyword
>line</keyword>
</keywordset>

</bookinfo>

<chapter id="introduction">
<title
>Introduction to &konsole;</title>

<sect1 id="terminal">
<title
>What is a terminal?</title
> <para
>&UNIX; operating systems were originally designed as text-only systems, controlled by keyboard commands -- what is known as a command-line interface (<acronym
>CLI</acronym
>). The &X-Window; and &kde; and other projects have since added the graphical interface you are now using. However, the underlying <acronym
>CLI</acronym
> system is still there, and is frequently the easiest, fastest and most powerful way to perform many tasks.</para
> <para
>&konsole; is what is known as an X terminal emulator, often referred to as a terminal or a shell. It gives you the equivalent of an old-fashioned text screen on your desktop, but one which can easily share the screen with your graphical applications. Windows users may be familiar with the <application
> MS-DOS Prompt</application
> utility, which has the analogous function of offering a <trademark
>DOS</trademark
> command-line under &Windows;. (Although the &UNIX; <acronym
>CLI</acronym
>s offer far more power and ease of use than does <acronym
>DOS</acronym
>!)</para>

<para
>Explaining the use of the &UNIX; <acronym
>CLI</acronym
> is beyond the scope of this document, as it would require a lengthy book. Fortunately, many such books are available in every language in any good bookstore or library. There are also tutorials available on the Internet. Enjoy &kde;, but don't be shy about learning to use the command-line! You will find that even learning just the basics will make your computer use much more efficient and enjoyable.</para>
</sect1>

<sect1 id="features">
<title
>What makes &konsole; special?</title
> <para
>&konsole;'s advanced features include simple configuration and the ability to use multiple terminal shells in a single window, making for a less cluttered desktop.</para>

<para
>Using &konsole;, a user can open:</para>
<itemizedlist>
<listitem
><para
>&Linux; console sessions</para
></listitem>
<listitem
><para
>Shell sessions</para
></listitem>
<listitem
><para
><application
>Screen</application
> sessions</para
></listitem>
<listitem
><para
><application
>Midnight Commander</application
> file manager sessions</para
></listitem>
<listitem
><para
><systemitem class="username"
>Root</systemitem
> console sessions</para
></listitem>
<listitem
><para
><systemitem class="username"
>Root</systemitem
> <application
>Midnight Commander</application
> sessions</para
></listitem>
</itemizedlist>

<para
>These sessions can be renamed to help you keep track of all your shells, or signalled (<errorcode
>STOP</errorcode
>, <errorcode
>CONT</errorcode
>, <errorcode
>HUP</errorcode
>, <errorcode
>INT</errorcode
>, <errorcode
>TERM</errorcode
>, <errorcode
>KILL</errorcode
>).</para>

<para
>For more control over &konsole;, a user can:</para>
<itemizedlist>
<listitem
><para
>hide/show the menubar, toolbar, scrollbar and/or frame</para
></listitem>
<listitem
><para
>select the size of a &konsole; window, fonts, colour schemes, and key mapping</para
></listitem>
<listitem
><para
>change location of the scrollbar or hide the scrollbar</para
></listitem>
</itemizedlist>

<para
>All chosen settings can be made the default for forthcoming sessions by saving them. </para>

<para
>For those with a deep interest in the taxonomy of free X terminals, there are two others of this kind: <application
>xterm</application
>, the original, written even before X itself (a month or two), and <application
>xvt</application
>, a lightweight <application
>xterm</application
> clone, on which most other currently available derivatives (notably <application
>eterm</application
>) are based.</para>

<para
>After a decade, &konsole; is the first rewrite from the ground up. While <application
>xterm</application
> has definitely been hacked to death (its <filename
>README</filename
> begins with the words <quote
>Abandon All Hope, Ye Who Enter Here</quote
>), &konsole; offers a fresh start using contemporary technologies and understanding of X.</para>

</sect1>
</chapter>

<chapter id="use-of-konsole">
<title
>Use of &konsole;</title>

<sect1 id="startup">
<title
>Startup</title>

<para
>When &konsole; is started, an application (typically a &UNIX; shell) runs in the window. Simply type at the prompt.</para>

<screenshot>
<screeninfo
>&konsole; Screen</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="konsole.png" format="PNG"/>
</imageobject>
<textobject>
<phrase
>&konsole; Screen</phrase>
</textobject>
</mediaobject>
</screenshot>
<para
>A <quote
>Tip of the Day</quote
> window may also appear on startup, offering hints on the use of &konsole;. If you do not wish to receive tips, uncheck the <guilabel
>Show tips on startup</guilabel
> box.</para>
</sect1>

<sect1 id="history-option">
<title
>History</title>

<para
>As lines scroll off the top of the screen, they can be reviewed by moving the scroll bar upwards, scrolling with a mouse wheel or through the use of the <keycombo action="simul"
>&Shift;<keycap
>Page Up</keycap
></keycombo
> (to move back a page), <keycombo action="simul"
>&Shift;<keycap
>Page Down</keycap
></keycombo
> (to move forward a page), <keycombo action="simul"
>&Shift;<keycap
>Up</keycap
></keycombo
> (to move up a line) and <keycombo action="simul"
>&Shift;<keycap
>Down</keycap
></keycombo
> (to move down a line) keys (provided the <link linkend="settings-menu"
>History</link
> option is on).</para>

<para
>In addition, &konsole; mimics the FreeBSD console when <keycap
>scroll lock</keycap
> is pressed. When scroll lock is on, ordinary in- and output from the shell is suspended, and you can scroll through the history with <keycap
>Page Up</keycap
>, <keycap
>Page down</keycap
>, and <keycap
>Up Arrow</keycap
> and <keycap
>Down Arrow</keycap
>.</para>

</sect1>

<sect1 id="sessions">
<title
>Sessions</title>
<para
>If you often have to log into remote machines, or always run a similar set of terminal applications, you can use &konsole;'s <quote
>Session</quote
> feature along with &kde;'s session management to automate a lot of this for you. Let's take the following example: You often have open an <application
>ssh</application
> session to the machine <replaceable
>administration</replaceable
> ready for generic administration tasks. You may have noticed the <guibutton
>New</guibutton
> button on &konsole;'s tab bar contains a menu if you click and hold on it, and you can choose new session types here. We are going to add new entries to this menu. <orderedlist>
<listitem
><para
>Click on the menu entry <menuchoice
><guimenu
>Settings</guimenu
><guimenuitem
>Configure Konsole</guimenuitem
> </menuchoice
></para
></listitem>
<listitem
><para
>Choose the <guilabel
>Session</guilabel
> tab.</para>
</listitem
> 

<listitem
><para
>Fill in the first entry with a name. This is the name that will show in the menu, and will be the default label instead of <guilabel
>Shell</guilabel
> when you start a session of this type. </para
></listitem
>  

<listitem
><para
>Enter a command just as you normally would if you opened a new shell and were going to issue that command. For our first example above, you might type <userinput
><command
>ssh</command
> <replaceable
>administration</replaceable
></userinput
>.</para
></listitem>

<listitem
><para
>On the lower part of the panel, configure this session's appearance. You can have a different font, colour scheme, and $<envar
>TERM</envar
> type for each session.</para
></listitem>

<listitem
><para
>Press the <guibutton
>Save Session...</guibutton
> button. A dialogue will ask you to confirm the filename. </para
></listitem>

<listitem
><para
>Press <guibutton
>OK</guibutton
>. </para
></listitem>

</orderedlist>
</para>
<para
>You should now be able to press and hold the <guibutton
>New</guibutton
> button on the tab bar, and select your new session type from the list. A new shell session will open within the &konsole; window, with the result of your executed command. In our example, you will be at an <application
>ssh</application
> passphrase prompt, and when you provide your passphrase, you will be logged into the remote machine. <footnote id="use-ssh-agent"
><para
>You can avoid this step also, by using ssh-agent, but that is a topic for another goodie.</para
></footnote
> Perhaps you want to remotely tail your <acronym
>http</acronym
> error logs on a webserver, you could use a commandline something like <userinput
><command
>ssh</command
> <option
>-f</option
> <replaceable
>webserver</replaceable
> <command
>tail</command
> <option
>-f</option
> <filename
><replaceable
>/var/log/httpd-error.log</replaceable
></filename
></userinput
>. </para>
<para
>You can use this to execute local commands as well. Try creating a session where the command is <userinput
><command
>tail</command
> <option
>-f</option
> <filename
><replaceable
>/var/log/messages</replaceable
></filename
></userinput
>. In this case, exiting the running application will close the shell session as well. </para>
<para
>One really nice use of this feature is if you find you always have the same set of open sessions, &kde; can open them all for you automatically when you start a new &kde; session. Simply have them open as you like when you exit &kde;, and they will be saved with your &kde; session, and restored just like any other application when you restart &kde;. </para>

</sect1>

<sect1 id="mousebuttons">

<title
>Mouse Buttons</title>

<variablelist>

<varlistentry>
<term
><mousebutton
>Left</mousebutton
></term>

<listitem
><para
>Clicking the <mousebutton
>left</mousebutton
> button is passed as an event to the application running in the emulation, if it is mouse-aware. If a program will react on mouse clicks, &konsole; indicates this by showing an arrow cursor. If not, an I-beam (bar) cursor is shown.</para>

<para
>Holding the <mousebutton
>left</mousebutton
> button down and dragging the mouse over the screen with a mouse-unaware application running will mark a region of the text. While dragging, the marked text is displayed reversed for visual feedback. Select <guimenuitem
>Copy</guimenuitem
> from the <guimenu
>Edit</guimenu
> menu to copy the marked text to the clipboard for further use within &konsole; or another application. The selected text can also be dragged and dropped into compatible applications. Click on the selected text and drag it to the desired location. (Depending on your &kde; settings, you may need to hold the &Ctrl; key while dragging.</para>

<para
>Normally, new-line characters are inserted at the end of each line selected. This is best for cut and paste of source code, or the output of a particular command. For ordinary text, the line breaks are often not important. One might prefer, however, for the text to be a stream of characters that will be automatically re-formatted when pasted into another application. To select in text-stream mode, hold down the &Ctrl; key while selecting normally.</para>

<para
>Double-click with the <mousebutton
>left</mousebutton
> button to select a word; triple-click to select an entire line.</para>

<para
>If the upper or lower edge of the text area is touched while marking, &konsole; scrolls up or down, eventually exposing text within the history buffer. The scrolling stops when the mouse stops moving.</para>

<para
>After the mouse is released, &konsole; attempts to keep the text in the clipboard visible by holding the marked area reversed. The marked area reverts back to normal as soon as the contents of the clipboard change, the text within the marked area is altered or the <mousebutton
>left</mousebutton
> mouse button is clicked.</para>

<para
>To mark text on a mouse-aware application (Midnight Commander, for example) the &Shift; key has to be pressed when clicking.</para>

</listitem>
</varlistentry>

<varlistentry>
<term
><mousebutton
>Middle</mousebutton
></term>

<listitem
><para
>Pressing the <mousebutton
>middle</mousebutton
> button pastes text currently in the clipboard. Holding down the &Ctrl; key as you press the <mousebutton
>middle</mousebutton
> button pastes the text and sends it to &konsole;.</para>

<note
><para
>If you have a mouse with only two buttons, pressing both the <mousebutton
>left</mousebutton
> and <mousebutton
>right</mousebutton
> buttons together emulates the <mousebutton
>middle</mousebutton
> button of a three button mouse.</para
></note>

</listitem>
</varlistentry>

<varlistentry>
<term
><mousebutton
>Right</mousebutton
></term>
<listitem>
<para
>The <mousebutton
>right</mousebutton
> button brings up a menu with the <guimenuitem
>Show Menubar</guimenuitem
>, <guimenuitem
>Copy</guimenuitem
>, <guimenuitem
>Paste</guimenuitem
>, <guimenuitem
>Send Signal</guimenuitem
>, <guimenuitem
>Detach (or Attach) Session</guimenuitem
>, <guimenuitem
>Rename Session...</guimenuitem
>, <guimenuitem
>Bookmarks</guimenuitem
> <guimenuitem
>Settings</guimenuitem
> and <guimenuitem
>Close Session</guimenuitem
> menu items. The <keycombo action="simul"
>&Ctrl; <mousebutton
>right</mousebutton
></keycombo
> button brings up the <guimenu
>Session</guimenu
> menu. </para>
</listitem>
</varlistentry>
</variablelist>

</sect1>

<sect1 id="menubar">
<title
>Menu Bar</title>

<para
>The menubar is at the top of the &konsole; window. It can be hidden and restored by toggling <guimenuitem
>Show Menubar</guimenuitem
> in the <guimenu
>Settings</guimenu
> menu. When the menubar is hidden, <guimenuitem
>Show Menubar</guimenuitem
> can be reached by <mousebutton
>right</mousebutton
> clicking in the window or by <keycombo action="simul"
>&Alt;&Ctrl;<keycap
>M</keycap
> </keycombo
>.</para>

<sect2 id="session-menu">
<title
><guimenu
>Session</guimenu
> Menu</title>

<variablelist>
<varlistentry>
<term
><menuchoice
><guimenu
>Session</guimenu
><guimenuitem
>New Shell</guimenuitem
></menuchoice
></term>
<listitem
><para
><action
>Open a new session</action
> with a terminal shell. <keycombo action="simul"
>&Alt;&Ctrl;<keycap
>N</keycap
> </keycombo
> can also be used, as described in more detail below. </para
></listitem
></varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>Session</guimenu
><guimenuitem
>New Linux Console</guimenuitem
></menuchoice
></term>
<listitem
><para
><action
>Open a new session emulating a text-only &Linux; system.</action
></para>
<note
><para
>See the file <filename
>README.linux.console</filename
> in the &konsole; source package for detailed information on how the &Linux; console differs from a typical &UNIX; console. If this doesn't mean anything to you, you almost certainly don't need to worry about it.</para
></note>
</listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>Session</guimenu
><guimenuitem
>New Midnight Commander</guimenuitem
></menuchoice
></term>
<listitem
><para
><action
>Open a new session</action
> with the <application
>Midnight Commander</application
> file browser.</para
></listitem>
</varlistentry>

<varlistentry>
<term>
<menuchoice
><guimenu
>Session</guimenu
> <guimenuitem
>New Root Console</guimenuitem
></menuchoice>
</term>
<listitem>
<para
><action
>Open a new session with a terminal shell</action
>, as the <systemitem class="username"
>root</systemitem
> user. </para>

<para
>After being prompted for the <systemitem class="username"
>root</systemitem
> password, the <prompt
>#</prompt
> prompt appears, indicating that the user is working with <systemitem class="username"
>root</systemitem
> privileges. This is frequently necessary for installing new software and other system maintenance, but care should be taken to avoid accidental damage. </para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<menuchoice
><guimenu
>Session</guimenu
> <guimenuitem
>New Root Midnight Commander</guimenuitem
></menuchoice>
</term>
<listitem>
<para
><action
>Open a new session</action
> with the <application
>Midnight Commander</application
> file browser, as the <systemitem class="username"
>root</systemitem
> user. </para>
<para
>After being prompted for the <systemitem class="username"
>root</systemitem
> password, the <prompt
>#</prompt
> prompt appears under the browser window, indicating that the user is working with <systemitem class="username"
>root</systemitem
> privileges. Again, working as <systemitem class="username"
>root</systemitem
> is frequently necessary but care should be taken to avoid accidental damage. </para>
</listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>Session</guimenu
><guimenuitem
>New Screen Session</guimenuitem
></menuchoice
></term>
<listitem
><para
><action
>Open a new session</action
> with the <application
>Screen</application
> virtual terminal manager. See <userinput
><command
>man</command
> <option
>screen</option
> </userinput
>for more information. </para
></listitem
></varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>Session</guimenu
> <guimenuitem
>New Shell at Bookmark</guimenuitem
></menuchoice
></term>
<listitem
><para
><action
>Start</action
> a new terminal shell, in a folder chosen from the bookmark list.</para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>Session</guimenu
> <guimenuitem
>Close Session</guimenuitem
></menuchoice
></term>
<listitem
><para
><action
>Close</action
> the current session. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>Session</guimenu
> <guimenuitem
>Quit</guimenuitem
></menuchoice
></term>
<listitem
><para
><action
>Quit</action
> &konsole;, closing all sessions and any applications launched from them.</para
></listitem>
</varlistentry>

</variablelist>

<para
>You can also open a new session with a key shortcut. By default, <keycombo action="simul"
>&Alt;&Ctrl;<keycap
>N</keycap
> </keycombo
> is used. You can also define your own key shortcuts through the <menuchoice
><guimenu
>Settings</guimenu
> <guimenuitem
>Configure Shortcuts...</guimenuitem
></menuchoice
> menu command.</para>

<para
>The files with a <literal role="extension"
>*.keytab</literal
> extension in <filename class="directory"
>$<envar
>KDEDIR</envar
>/share/apps/konsole</filename
> also define keyboard shortcuts. Use the <menuchoice
><guimenu
>Settings</guimenu
> <guimenuitem
>Keyboard</guimenuitem
></menuchoice
> menu command to choose a keytab file. The file <filename
>README.KeyTab</filename
> contains more information on defining shortcuts. </para>

<para
>The list of available sessions may differ from those listed here. &konsole; detects your installed programs and customises the list to reflect the available options.</para>

<para
>Finally, note that the session types can be modified, and new types created, by using the configuration dialogue, reached from the <menuchoice
><guimenu
>Settings</guimenu
> <guimenuitem
>Configure Konsole...</guimenuitem
></menuchoice
> menu entry.</para>

</sect2>
<sect2 id="edit-menu">
<title
><guimenu
>Edit</guimenu
> Menu</title>
<variablelist>

<varlistentry>
<term
><menuchoice
><guimenu
>Edit</guimenu
><guimenuitem
>Copy </guimenuitem
></menuchoice
></term>
<listitem
><para
><action
>Copy the selected text to the clipboard.</action
></para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>Edit</guimenu
><guimenuitem
>Paste </guimenuitem
></menuchoice
></term>
<listitem
><para
><action
>Paste text from the clipboard at the cursor location.</action
></para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>Edit</guimenu
> <guisubmenu
>Send Signal</guisubmenu
></menuchoice
></term>
<listitem
><para
><action
>Send Signal - Send the specified signal to the shell process, or other process, that was launched when the new session was started.</action
></para
><para
>Currently available signals are:</para>

<informaltable>
<tgroup cols="2">
<tbody>
<row>
<entry
><errorcode
>STOP</errorcode
></entry>
<entry
>to stop process</entry>
</row>
<row>
<entry
><errorcode
>CONT</errorcode
></entry>
<entry
>continue if stopped</entry>
</row>
<row>
<entry
><errorcode
>HUP</errorcode
></entry>
<entry
>hangup detected on controlling terminal, or death of controlling process</entry>
</row>
<row>
<entry
><errorcode
>INT</errorcode
></entry>
<entry
>interrupt from keyboard</entry>
</row>
<row>
<entry
><errorcode
>TERM</errorcode
></entry>
<entry
>termination signal</entry>
</row>
<row>
<entry
><errorcode
>KILL</errorcode
></entry>
<entry
>kill signal</entry>
</row>
<row>
<entry
><errorcode
>USR1</errorcode
></entry>
<entry
>user signal 1</entry>
</row>
<row>
<entry
><errorcode
>USR2</errorcode
></entry>
<entry
>user signal 2</entry>
</row>
</tbody>
</tgroup>
</informaltable>

<para
>Refer to your system manual pages for further details by giving the command <userinput
><command
>man</command
> <option
>7 signal</option
></userinput
>.</para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>Edit</guimenu
><guimenuitem
>Clear Terminal</guimenuitem
></menuchoice
></term>
<listitem
><para
><action
>Clear all text from the session window.</action
>.</para
></listitem>
</varlistentry>


<varlistentry>
<term
><menuchoice
><guimenu
>Edit</guimenu
><guimenuitem
>Reset and Clear Terminal</guimenuitem
></menuchoice
></term>
<listitem
><para
><action
>Start a new session in the window.</action
>.</para
></listitem>
</varlistentry>


<varlistentry>
<term
><menuchoice
><guimenu
>Edit</guimenu
><guimenuitem
>Find in History...</guimenuitem
></menuchoice
></term>
<listitem
><para
><action
>Find a word or string of text</action
> in the current history. Options allow case sensitive or backwards searches, and the use of regular expressions in searches. Press the <guibutton
>Edit</guibutton
> button to use the &kde; graphical editor to create a regular expression.</para
></listitem>
</varlistentry>


<varlistentry>
<term
><menuchoice
><guimenu
>Edit</guimenu
><guimenuitem
>Find Next</guimenuitem
></menuchoice
></term>
<listitem
><para
><action
>Move to the next instance of the text for which you are searching.</action>
</para
></listitem>
</varlistentry>


<varlistentry>
<term
><menuchoice
><guimenu
>Edit</guimenu
><guimenuitem
>Find Previous</guimenuitem
></menuchoice
></term>
<listitem
><para
><action
>Move to the previous instance of the text for which you are searching.</action>
</para
></listitem>
</varlistentry>


<varlistentry>
<term
><menuchoice
><guimenu
>Edit</guimenu
><guimenuitem
>Save History As...</guimenuitem
></menuchoice
></term>
<listitem
><para
><action
>Save the current history</action
> as a text file.</para
></listitem>
</varlistentry>


<varlistentry>
<term
><menuchoice
><guimenu
>Edit</guimenu
><guimenuitem
>Clear History </guimenuitem
></menuchoice
></term>
<listitem
><para
><action
>Clear the history for the current session.</action
></para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>Edit</guimenu
><guimenuitem
>Clear All Histories </guimenuitem
></menuchoice
></term>
<listitem
><para
><action
>Clear the history for all sessions.</action>
</para
></listitem>
</varlistentry>

</variablelist>
</sect2>

<sect2 id="view-menu">
<title
><guimenu
>View</guimenu
> Menu</title>
<variablelist>

<varlistentry>
<term
><menuchoice
><guimenu
>View</guimenu
><guimenuitem
>Detach Session</guimenuitem
></menuchoice
></term>
<listitem
><para
><action
>Open the current session in a separate window.</action
> The name of the session is displayed on the titlebar of the new window. Close the new window to restore the session to its original place, or <mousebutton
>right</mousebutton
>-click on the new window and select <guimenuitem
>Attach Session</guimenuitem
>. Note that if the main window is closed, any detached sessions will be closed with it. </para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>View</guimenu
><guimenuitem
>Rename Session...</guimenuitem
></menuchoice
></term>
<listitem
><para
><action
>Open a dialogue box allowing you to change the name of the current session.</action
> The name is displayed on the session tab. <keycombo action="simul"
>&Alt;&Ctrl;<keycap
>S</keycap
> </keycombo
> can also be used.</para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>View</guimenu
><guimenuitem
>Monitor for Activity</guimenuitem
></menuchoice
></term>
<listitem
><para
><action
>Flag the current session so it will show an alert if activity occurs.</action
> An icon of a lit light bulb will appear in the session's tab. Use this to alert you if something happens while you are working in another session. The time before an alert can be modified in the &konsole; preferences.</para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>View</guimenu
><guimenuitem
>Monitor for Silence</guimenuitem
></menuchoice
></term>
<listitem
><para
><action
>Flag the current session so it will show an alert if no activity occurs for 10 seconds.</action
> An icon of a dark light bulb will appear in the session's tab. Use this to alert you if a task stops while you are working in another session. The time before an alert can be modified in the &konsole; preferences.</para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>View</guimenu
><guimenuitem
>Send Input to All Sessions</guimenuitem
></menuchoice
></term>
<listitem
><para
><action
>Flag the current session so any commands entered into it will be sent to all sessions.</action
> The session will have a small icon in its tab to remind you to be careful of what you enter! <userinput
><command
>rm </command
><parameter
>-rf *</parameter
></userinput
>, for instance, is probably not a good idea.</para
></listitem>
</varlistentry>


<varlistentry>
<term
><menuchoice
><guimenu
>View</guimenu
><guimenuitem
>Move Session Left</guimenuitem
></menuchoice
></term>
<listitem
><para
><action
>Move the tab of the current session one tab to the left.</action
></para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>View</guimenu
><guimenuitem
>Move Session Right</guimenuitem
></menuchoice
></term>
<listitem
><para
><action
>Move the tab of the current session one tab to the right.</action
></para>
<para
><keycombo action="simul"
>&Shift; <keycap
>Left</keycap
></keycombo
> and <keycombo action="simul"
>&Shift; <keycap
>Right</keycap
></keycombo
> can be also be used to move between sessions.</para
></listitem
></varlistentry>


<varlistentry>
<term
><menuchoice
><guimenu
>View</guimenu
> <guimenuitem
>Session icons...</guimenuitem
></menuchoice
></term>
<listitem
><para
>At the bottom of the menu is a list of the available sessions. Selecting one makes that session active.</para
><para
>You can also use the <keycombo action="simul"
>&Shift;<keycap
>Left</keycap
></keycombo
>/<keycombo action="simul"
>&Shift;<keycap
>Right</keycap
></keycombo
> keys to cycle through the available sessions.</para>
</listitem>
</varlistentry>

</variablelist>
</sect2>

<sect2 id="bookmarks-menu">
<title
><guimenu
>Bookmarks</guimenu
> Menu</title>

<variablelist>

<varlistentry>
<term
><menuchoice
><guimenu
>Bookmarks</guimenu
><guimenuitem
>Add Bookmark</guimenuitem
></menuchoice
></term>
<listitem
><para
><action
>Add the current location </action
>to the bookmark list.</para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>Bookmarks</guimenu
><guimenuitem
>Edit Bookmarks</guimenuitem
></menuchoice
></term>
<listitem
><para
><action
>Edit </action
>the bookmark list.</para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>Bookmarks</guimenu
><guimenuitem
>New Bookmark Folder...</guimenuitem
></menuchoice
></term>
<listitem
><para
><action
>Add a new folder </action
>to the bookmark list.</para
></listitem>
</varlistentry>

</variablelist>

<para
>The bookmark list is displayed at the bottom of the menu. Select a bookmark to change to that location.</para>

<note
><para
>You can use the bookmark editor to manually add URLs like ssh://user@host or telnet://host to open remote connections.</para
></note>


</sect2>



<sect2 id="settings-menu">
<title
><guimenu
>Settings</guimenu
> Menu</title>

<variablelist>

<varlistentry>
<term
><menuchoice
><guimenu
>Settings</guimenu
><guimenuitem
>Show Menubar</guimenuitem
></menuchoice
></term>
<listitem
><para
><action
>Show or hide the menubar.</action
></para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>Settings</guimenu
><guimenuitem
>Show Toolbar</guimenuitem
></menuchoice
></term>
<listitem
><para
><action
>Show or hide the toolbar.</action
></para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>Settings</guimenu
> <guisubmenu
>Scrollbar</guisubmenu
></menuchoice
></term>
<listitem
><para
><action
>Control location of scrollbar</action
>: <guimenuitem
>none</guimenuitem
>, <guimenuitem
>left</guimenuitem
>, or <guimenuitem
>right</guimenuitem
>.</para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>Settings</guimenu
> <guimenuitem
>Fullscreen</guimenuitem
></menuchoice
></term>
<listitem
><para
><action
>Toggle window between full-screen and normal size.</action
></para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>Settings</guimenu
> <guimenuitem
>Bell</guimenuitem
></menuchoice
></term>
<listitem
><para
><action
>Set the system bell to a &kde; System Notification or a visible flash, or turns it off. </action
></para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>Settings</guimenu
> <guisubmenu
>Font</guisubmenu
></menuchoice
></term>
<listitem
><para
><action
>Set font and font size</action
></para>
<para
>Select the <guimenuitem
>Custom</guimenuitem
> option to use any combination of font, size and style. The <filename
>README.fonts</filename
> file in the &konsole; source package gives tips on which fonts will work well.</para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>Settings</guimenu
> <guimenuitem
>Keyboard</guimenuitem
></menuchoice
></term>
<listitem
><para
><action
>Choose desired keymapping.</action
></para>
<para
>The list of these keymappings is taken from <filename
>$KDEDIR/share/apps/konsole/*.keytab</filename
>. The file <filename
>$KDEDIR/share/apps/konsole/README.KeyTab</filename
> describes the keytab format in more detail. Add to or modify these files to match your needs.</para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>Settings</guimenu
> <guimenuitem
>Schema</guimenuitem
></menuchoice
></term>
<listitem
><para
><action
>Set colours of text and background.</action
></para>
<para
>The list of these schemata is taken from <filename
>$KDEDIR/share/apps/konsole/*.schema</filename
>. The file <filename
>$KDEDIR/share/apps/konsole/README.Schema</filename
> describes the schema format in more detail. Add to or modify these files to match your needs. You can also create custom schema through the preferences dialogue at <menuchoice
><guisubmenu
>Settings</guisubmenu
> <guimenuitem
>Configure Konsole...</guimenuitem
></menuchoice
>. </para>
</listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>Settings</guimenu
> <guisubmenu
>Size</guisubmenu
></menuchoice
></term>
<listitem
><para
><action
>Set size of text area (given in columns x rows).</action
></para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>Settings</guimenu
> <guimenuitem
>History...</guimenuitem
></menuchoice
></term>
<listitem
><para
><anchor id="configure-history"/><action
>Open a dialogue where you can configure the history.</action
> The <guilabel
>Enable</guilabel
> checkbox toggles saving of lines that have scrolled off the top of the window. You can enter the <guilabel
>Number of lines</guilabel
> to remember in the text field, or use the spinner buttons to increase or decrease the number in steps of 100 lines. The <guibutton
>Defaults</guibutton
> button will reset the history to 1000 lines. Setting this value to 0 will cause all history to be saved. Press <guibutton
>OK</guibutton
> to save your changes, or <guibutton
>Cancel</guibutton
> to close the dialogue without saving your settings. The <guibutton
>Help</guibutton
> button will open this manual, and display the text you're reading right now.</para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>Settings</guimenu
><guimenuitem
>Save Settings</guimenuitem
></menuchoice
></term>
<listitem
><para
><action
>Save the current settings as the new defaults.</action
></para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>Settings</guimenu
><guimenuitem
>Save Sessions Profile...</guimenuitem
></menuchoice
></term>
<listitem
><para
><action
>Save the current set of sessions </action
>under a name you choose. The profile can then be used by starting &konsole; from the command-line with the <parameter
>--profile</parameter
> and the name of the profile.</para>
</listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>Settings</guimenu
><guimenuitem
>Configure Shortcuts...</guimenuitem
></menuchoice
></term>
<listitem
><para
><action
>Customise keyboard shortcuts for &konsole; commands.</action
></para>
</listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>Settings</guimenu
><guimenuitem
>Configure &konsole;...</guimenuitem
></menuchoice
></term>
<listitem
><para
><action
>Open the &kcontrolcenter; module, allowing many additional changes to &konsole;'s interface and behaviour, including the creation of custom schemas and modification of the available sessions.</action
></para>
</listitem>
</varlistentry>

</variablelist>
</sect2>

<sect2 id="help-menu">
<title
><guimenu
>Help</guimenu
> Menu</title>

<variablelist>
<varlistentry>
<term
><menuchoice
><shortcut
> <keycap
>F1</keycap
></shortcut
><guimenu
>Help</guimenu
> <guimenuitem
>Konsole Handbook</guimenuitem
></menuchoice
></term>
<listitem
><para
><action
>Open the table of contents of this document.</action
></para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>Help</guimenu
> <guimenuitem
>Tip of the Day...</guimenuitem
></menuchoice
></term>
<listitem
><para
><action
>Display a helpful tip about the use of &konsole;. </action
>Check the <guilabel
>Show on start</guilabel
> box to display a tip each time &konsole; is started.</para
></listitem>
</varlistentry>
<varlistentry>
<term
><menuchoice
><guimenu
>Help</guimenu
><guimenuitem
>Report Bug...</guimenuitem
></menuchoice
></term>
<listitem
><para
><action
>Submit a bug report or a feature request</action
> for &konsole;.</para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>Help</guimenu
><guimenuitem
>About Konsole...</guimenuitem
></menuchoice
></term>
<listitem
><para
><action
>Information about</action
> &konsole;'s author</para
></listitem>
</varlistentry>

<varlistentry>
<term
><menuchoice
><guimenu
>Help</guimenu
><guimenuitem
>About KDE...</guimenuitem
></menuchoice
></term>
<listitem
><para
><action
>Information about the KDE project</action
></para
></listitem>
</varlistentry>
</variablelist>

</sect2>

</sect1>

<sect1 id="toolbar">
<title
>Toolbar</title>

<para
>The toolbar is at the bottom of the &konsole; window.</para>

<para
>It can be hidden and restored by toggling <guimenuitem
>Show Toolbar</guimenuitem
> in the <guimenu
>Settings</guimenu
> menu or by clicking the textured <quote
>handle</quote
> at the side of the bar. The bar contains a <guiicon
>New</guiicon
> icon and icons for the current sessions. Clicking <guiicon
>New</guiicon
> opens a new <quote
>Shell</quote
> session.</para>
<para
>Double-clicking a session tab opens a dialogue box enabling you to change the name of that session. <keycombo action="simul"
>&Alt;&Ctrl;<keycap
>S</keycap
> </keycombo
> can also be used to rename the active session.</para>
<para
>Clicking an existing session's icon makes that session active.</para
> <para
>When the toolbar is hidden, <keycombo action="simul"
>&Shift; <keycap
>Left</keycap
></keycombo
> and <keycombo action="simul"
>&Shift; <keycap
>Right</keycap
></keycombo
> can be used to move between sessions.</para>

</sect1>

<sect1 id="command-line-options">
<title
>Command-line Options</title>

<para
>When &konsole; is started from the command-line, various options can be specified to modify its behaviour.</para>

<variablelist>

<varlistentry>
<term
><option
>--help</option
></term>
<listitem
><para
><action
>List the various options</action
></para
></listitem>
</varlistentry>

<varlistentry>
<term
><option
>--name</option
> <parameter
>name</parameter
></term>
<listitem
><para
><action
>Set the name that appears in the titlebar</action
></para
></listitem>
</varlistentry>

<varlistentry>
<term
><option
>--ls</option
></term>
<listitem
><para
><action
>Start with a login shell environment.</action
> What that does varies depending on your system, but generally it means that files such as <filename
>~/.profile</filename
> or <filename
>~/.bash_profile</filename
> will be read. (If that doesn't mean anything to you, don't worry about it, but keep in the back of your mind for when you realise you need it.)</para
></listitem>
</varlistentry>

<varlistentry>
<term
><option
>-T</option
> <parameter
>title</parameter
></term>
<listitem
><para
><action
>Set the window title</action
></para
></listitem>
</varlistentry>

<varlistentry>
<term
><option
>--tn</option
> <parameter
>terminal</parameter
></term>
<listitem
><para
><action
>Sets the environment variable TERM to the specified value.</action
> Read <userinput
><command
>man</command
> <option
>xterm</option
> </userinput
> for more information on TERM.</para
></listitem>
</varlistentry>

<varlistentry>
<term
><option
>--xwin</option
></term>
<listitem
><para
><action
>Ignored</action
></para
></listitem>
</varlistentry>

<varlistentry>
<term
><option
>--noclose</option
></term>
<listitem
><para
><action
>Prevent &konsole; from closing</action
> when an <userinput
><command
>exit</command
></userinput
> command is issued in the only session window.</para
></listitem>
</varlistentry>

<varlistentry>
<term
><option
>--nohist</option
></term>
<listitem
><para
><action
>Disable the saving of lines that scroll off the top of the window</action
></para
></listitem>
</varlistentry>

<varlistentry>
<term
><option
>--nomenubar</option
></term>
<listitem
><para
><action
>Start &konsole; without a menubar</action
></para
></listitem>
</varlistentry>

<varlistentry>
<term
><option
>--notoolbar</option
></term>
<listitem
><para
><action
>Start &konsole; without a toolbar</action
></para
></listitem>
</varlistentry>

<varlistentry>
<term
><option
>--noframe</option
></term>
<listitem
><para
><action
>Start &konsole; without a frame</action
></para
></listitem>
</varlistentry>

<varlistentry>
<term
><option
>--noscrollbar</option
></term>
<listitem
><para
><action
>Start &konsole; without a scrollbar</action
></para
></listitem>
</varlistentry>

<varlistentry>
<term
><option
>--noxft</option
></term>
<listitem
><para
><action
>Start &konsole; without Xft antialiasing.</action
> Antialiasing of a small font may be difficult to read.</para
></listitem>
</varlistentry>

<varlistentry>
<term
><option
>--vt_sz</option
> <parameter
>CCxLL</parameter
></term>
<listitem
><para
><action
>Start a terminal window of CC Columns and LL lines</action
></para
></listitem>
</varlistentry>

<varlistentry>
<term
><option
>--type</option
> <parameter
>type</parameter
></term>
<listitem
><para
><action
>Start a session of the given type rather than the default.</action
></para
></listitem>
</varlistentry>

<varlistentry>
<term
><option
>--keytab</option
> <parameter
>file</parameter
></term>
<listitem
><para
><action
>Start &konsole; using a specified .keytab file</action
> to customise key bindings.</para
></listitem>
</varlistentry>

<varlistentry>
<term
><option
>--profile</option
> <parameter
>file</parameter
></term>
<listitem
><para
><action
>Start &konsole; using a saved set of sessions.</action
></para
></listitem>
</varlistentry>

<varlistentry>
<term
><option
>--schema</option
> <parameter
>file</parameter
></term>
<listitem
><para
><action
>Start &konsole; using a specified .schema file</action
> to customise appearance.</para
></listitem>
</varlistentry>

<varlistentry>
<term
><option
>--script</option
> <parameter
>file</parameter
></term>
<listitem
><para
><action
>Allow the use of extended DCOP commands to paste text into sessions.</action
></para
></listitem>
</varlistentry>

<varlistentry>
<term
><option
>--workdir</option
> <parameter
>dir</parameter
></term>
<listitem
><para
><action
>Open with</action
> <parameter
>dir</parameter
> as the working folder.</para
></listitem>
</varlistentry>

<varlistentry>
<term
><option
>-e</option
> <parameter
>command</parameter
></term>
<listitem
><para
><action
>Execute</action
> <parameter
>command</parameter
> instead of shell.</para
></listitem>
</varlistentry>
</variablelist>

<para
>For instance:</para>

<informalexample>
<screen
><prompt
>bash$</prompt>
 <userinput
><command
>konsole</command
><option
> --vt_sz</option>
 <parameter
> 90x25</parameter
><option
> --nohist</option
></userinput
></screen>

<para
>starts a &konsole; window with 90 columns and 25 rows, with no history</para>
</informalexample>

<para
>&konsole; also accepts generic &Qt; and &kde; options:</para>

<variablelist>
<varlistentry>
<term
><option
>--help-qt</option
></term>
<listitem
><para
><action
>List Qt-specific options</action
></para
></listitem>
</varlistentry>
<varlistentry>
<term
><option
>--help-kde</option
></term>
<listitem
><para
><action
>List KDE-specific options</action
></para
></listitem>
</varlistentry>
<varlistentry>
<term
><option
>--help-all</option
></term>
<listitem
><para
><action
>List all options</action
></para
></listitem>
</varlistentry>
<varlistentry>
<term
><option
>--author</option
></term>
<listitem
><para
><action
>Show the authors' names</action
></para
></listitem>
</varlistentry>
<varlistentry>
<term
><option
>-v,--version</option
></term>
<listitem
><para
><action
>Show the version number</action
></para
></listitem>
</varlistentry>
<varlistentry>
<term
><option
>--license</option
></term>
<listitem
><para
><action
>Show licence information</action
></para
></listitem>
</varlistentry>
</variablelist>

</sect1>

</chapter>

<chapter id="credits">
<title
>Credits and Copyright</title>

<para
>&konsole; is maintained by &Waldo.Bastian; &Waldo.Bastian.mail;</para>

<para
>The application &konsole; Copyright &copy; 1997-2002 &Lars.Doelle; &Lars.Doelle.mail;</para>

<para
>This document was written by &Jonathan.Singer; &Jonathan.Singer.mail;</para>

<para
>Originally converted to DocBook <acronym
>SGML</acronym
> by &Mike.McBride; and &Lauri.Watts;</para>

<para
>Conversion to British English: John Knight <email
>anarchist_tomato@herzeleid.net</email
></para
> 
&underFDL; &underGPL; </chapter>

<appendix id="porting">
<title
>&konsole; on non-&Linux; platforms</title>

<para
>Information on building &konsole; on platforms other than &Linux; is available in the <filename
>README.ports</filename
> file in the &konsole; source package. It provides a list of experts for certain platforms (Tru64, &Solaris;, OpenBSD) and requests volunteers from other &UNIX; platforms.</para>

</appendix>

&documentation.index;

</book>

<!--
Local Variables:
mode: sgml
sgml-omittag: nil
sgml-shorttag: t
sgml-general-insert-case: lower
End:
-->