[d2a8a1]: doc / geany.txt Maximize Restore History

Download this file

geany.txt    5666 lines (4132 with data), 230.3 kB

   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
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
.. |(version)| replace:: 1.23
=======
Geany
=======
-------------------------
A fast, light, GTK+ IDE
-------------------------
:Authors: Enrico TrĂśger,
Nick Treleaven,
Frank Lanitz,
Colomban Wendling,
Matthew Brush
:Date: 2012-06-18
:Version: |(version)|
Copyright Š 2005-2012
This document is distributed under the terms of the GNU General Public
License as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version. A copy of this
license can be found in the file COPYING included with the source code
of this program, and also in the chapter `GNU General Public License`_.
.. contents::
Introduction
============
About Geany
-----------
Geany is a small and lightweight Integrated Development Environment. It
was developed to provide a small and fast IDE, which has only a few
dependencies on other packages. Another goal was to be as independent
as possible from a particular Desktop Environment like KDE or GNOME -
Geany only requires the GTK2 runtime libraries.
Some basic features of Geany:
* Syntax highlighting
* Code folding
* Autocompletion of symbols/words
* Construct completion/snippets
* Auto-closing of XML and HTML tags
* Calltips
* Many supported filetypes including C, Java, PHP, HTML, Python, Perl,
Pascal, and others
* Symbol lists
* Code navigation
* Build system to compile and execute your code
* Simple project management
* Plugin interface
Where to get it
---------------
You can obtain Geany from http://www.geany.org/ or perhaps also from
your distribution. For a list of available packages, please see
http://www.geany.org/Download/ThirdPartyPackages.
License
-------
Geany is distributed under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2 of
the License, or (at your option) any later version. A copy of this
license can be found in the file COPYING included with the source
code of this program and in the chapter, `GNU General Public License`_.
The included Scintilla library (found in the subdirectory
``scintilla/``) has its own license, which can be found in the chapter,
`License for Scintilla and SciTE`_.
About this document
-------------------
This documentation is available in HTML and text formats.
The latest version can always be found at http://www.geany.org/.
If you want to contribute to it, see `Contributing to this document`_.
Installation
============
Requirements
------------
You will need the GTK (>= 2.16.0) libraries and their dependencies
(Pango, GLib and ATK). Your distro should provide packages for these,
usually installed by default. For Windows, you can download an installer
from the website which bundles these libraries.
Binary packages
---------------
There are many binary packages available. For an up-to-date but maybe
incomplete list see http://www.geany.org/Download/ThirdPartyPackages.
Source compilation
------------------
Compiling Geany is quite easy.
To do so, you need the GTK (>= 2.16.0) libraries and header files.
You also need the Pango, GLib and ATK libraries and header files.
All these files are available at http://www.gtk.org, but very often
your distro will provide development packages to save the trouble of
building these yourself.
Furthermore you need, of course, a C and C++ compiler. The GNU versions
of these tools are recommended.
Autotools based build system
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The Autotools based build system is very mature and has been well tested.
To use it, you just need the Make tool, preferably GNU Make.
Then run the following commands::
$ ./configure
$ make
Then as root::
% make install
Waf based build system
^^^^^^^^^^^^^^^^^^^^^^
The Waf build system is still quite young and under heavy development but already in a
usable state. In contrast to the Autotools system, Waf needs Python. So before using Waf, you need
to install Python on your system.
The advantage of the Waf build system over the Autotools based build system is that the whole
build process might be a bit faster. Especially when you use the Waf
cache feature for repetitive builds (e.g. when changing only a few source files
to test something) will become much faster since Waf will cache and re-use the
unchanged built files and only compile the changed code again. See `Waf Cache`_ for details.
To build Geany with Waf as run::
$ ./waf configure
$ ./waf build
Then as root::
% ./waf install
Waf cache
`````````
The Waf build system has a nice and interesting feature which can help to avoid
a lot of unnecessary rebuilding of unchanged code. This often happens when developing new features
or trying to debug something in Geany.
Waf is able to store and retrieve the object files from a cache. This cache is declared
using the environment variable ``WAFCACHE``.
A possible location of the cache directory could be ``~/.cache/waf``. In order to make use of
this, you first need to create this directory::
$ mkdir -p ~/.cache/waf
then add the environment variable to your shell configuration (the following example is for
Bash and should be adjusted to your used shell)::
export WAFCACHE=/home/username/.cache/waf
Remember to replace ``username`` with your actual username.
More information about the Waf cache feature are available at
http://code.google.com/p/waf/wiki/CacheObjectFiles.
Cleaning the cache
******************
You should be careful about the size of the cache directory as it may
grow rapidly over time.
Waf doesn't do any cleaning or other house-keeping of the cache yet, so you need to keep it
clean by yourself.
An easy way to keep it clean is to run the following command regularly to remove old
cached files::
$ find /home/username/.cache/waf -mtime +14 -exec rm {} \;
This will delete all files in the cache directory which are older than 14 days.
For details about the ``find`` command and its options, check its manual page.
Custom installation
^^^^^^^^^^^^^^^^^^^
The configure script supports several common options, for a detailed
list, type::
$ ./configure --help
or::
$ ./waf --help
(depending on which build system you use).
You may also want to read the INSTALL file for advanced installation
options.
* See also `Compile-time options`_.
Dynamic linking loader support and VTE
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
In the case that your system lacks dynamic linking loader support, you
probably want to pass the option ``--disable-vte`` to the ``configure``
script. This prevents compiling Geany with dynamic linking loader
support for automatically loading ``libvte.so.4`` if available.
Build problems
^^^^^^^^^^^^^^
If there are any errors during compilation, check your build
environment and try to find the error, otherwise contact the mailing
list or one the authors. Sometimes you might need to ask for specific
help from your distribution.
Installation prefix
-------------------
If you want to find Geany's system files after installation you may
want to know the installation prefix.
Pass the ``--print-prefix`` option to Geany to check this - see
`Command line options`_. The first path is the prefix.
On Unix-like systems this is commonly ``/usr`` if you installed from
a binary package, or ``/usr/local`` if you build from source.
.. note::
Editing system files is not necessary as you should use the
per-user configuration files instead, which don't need root
permissions. See `Configuration files`_.
Usage
=====
Getting started
---------------
You can start Geany in the following ways:
* From the Desktop Environment menu:
Choose in your application menu of your used Desktop Environment:
Development --> Geany.
* From the command line:
To start Geany from a command line, type the following and press
Return::
% geany
The Geany workspace
-------------------
The Geany window is shown in the following figure:
.. image:: ./images/main_window.png
The workspace has the following parts:
* The menu.
* An optional toolbar.
* An optional sidebar that can show the following tabs:
* Documents - A document list, and
* Symbols - A list of symbols in your code.
* The main editor window.
* An optional message window which can show the following tabs:
* Status - A list of status messages.
* Compiler - The output of compiling or building programs.
* Messages - Results of 'Find Usage', 'Find in Files' and other actions
* Scribble - A text scratchpad for any use.
* Terminal - An optional terminal window.
* A status bar
Most of these can be configured in the `Interface preferences`_, the
`View menu`_, or the popup menu for the relevant area.
Additional tabs may be added to the sidebar and message window by plugins.
The position of the tabs can be selected in the interface preferences.
The sizes of the sidebar and message window can be adjusted by
dragging the dividers.
Command line options
--------------------
============ ======================= =================================================
Short option Long option Function
============ ======================= =================================================
*none* +number Set initial line number for the first opened file
(same as --line, do not put a space between the + sign
and the number). E.g. "geany +7 foo.bar" will open the
file foo.bar and place the cursor in line 7.
*none* --column Set initial column number for the first opened file.
-c dir_name --config=directory_name Use an alternate configuration directory. The default
configuration directory is ``~/.config/geany/`` and that
is where ``geany.conf`` and other configuration files
reside.
*none* --ft-names Print a list of Geany's internal filetype names (useful
for snippets configuration).
-g --generate-tags Generate a global tags file (see
`Generating a global tags file`_).
-P --no-preprocessing Don't preprocess C/C++ files when generating tags.
-i --new-instance Do not open files in a running instance, force opening
a new instance. Only available if Geany was compiled
with support for Sockets.
-l --line Set initial line number for the first opened file.
*none* --list-documents Return a list of open documents in a running Geany
instance.
This can be used to read the currently opened documents in
Geany from an external script or tool. The returned list
is separated by newlines (LF) and consists of the full,
UTF-8 encoded filenames of the documents.
Only available if Geany was compiled with support for
Sockets.
-m --no-msgwin Do not show the message window. Use this option if you
do not need compiler messages or VTE support.
-n --no-ctags Do not load symbol completion and call tip data. Use this
option if you do not want to use them.
-p --no-plugins Do not load plugins or plugin support.
*none* --print-prefix Print installation prefix, the data directory, the lib
directory and the locale directory (in that order) to
stdout, one line each. This is mainly intended for plugin
authors to detect installation paths.
-r --read-only Open all files given on the command line in read-only mode.
This only applies to files opened explicitly from the command
line, so files from previous sessions or project files are
unaffected.
-s --no-session Do not load the previous session's files.
-t --no-terminal Do not load terminal support. Use this option if you do
not want to load the virtual terminal emulator widget
at startup. If you do not have ``libvte.so.4`` installed,
then terminal-support is automatically disabled. Only
available if Geany was compiled with support for VTE.
*none* --socket-file Use this socket filename for communication with a
running Geany instance. This can be used with the following
command to execute Geany on the current workspace::
geany --socket-file=/tmp/geany-sock-$(xprop -root _NET_CURRENT_DESKTOP | awk '{print $3}')
*none* --vte-lib Specify explicitly the path including filename or only
the filename to the VTE library, e.g.
``/usr/lib/libvte.so`` or ``libvte.so``. This option is
only needed when the auto-detection does not work. Only
available if Geany was compiled with support for VTE.
-v --verbose Be verbose (print useful status messages).
-V --version Show version information and exit.
-? --help Show help information and exit.
*none* [files ...] Open all given files at startup. This option causes
Geany to ignore loading stored files from the last
session (if enabled).
Geany also recognizes line and column information when
appended to the filename with colons, e.g.
"geany foo.bar:10:5" will open the file foo.bar and
place the cursor in line 10 at column 5.
Projects can also be opened but a project file (\*.geany)
must be the first non-option argument. All additionally
given files are ignored.
============ ======================= =================================================
You can also pass line number and column number information, e.g.::
geany some_file.foo:55:4
Geany supports all generic GTK options, a list is available on the
help screen.
General
-------
Startup
^^^^^^^
At startup, Geany loads all files from the last time Geany was
launched. You can disable this feature in the preferences dialog
(see `General Startup preferences`_).
You can start several instances of Geany, but only the first will
load files from the last session. In the subsequent instances, you
can find these files in the file menu under the "Recent files" item.
By default this contains the last 10 recently opened files. You can
change the number of recently opened files in the preferences dialog.
To run a second instance of Geany, do not specify any filenames on
the command-line, or disable opening files in a running instance
using the appropriate command line option.
Opening files from the command-line in a running instance
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Geany detects if there is an an instance of itself already running and opens files
from the command-line in that instance. So, Geany can
be used to view and edit files by opening them from other programs
such as a file manager.
You can also pass line number and column number information, e.g.::
geany some_file.foo:55:4
This would open the file ``some_file.foo`` with the cursor on line 55,
column 4.
If you do not like this for some reason, you can disable using the first
instance by using the appropriate command line option -- see the section
called `Command line options`_.
Virtual terminal emulator widget (VTE)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you have installed ``libvte.so`` on your system, it is loaded
automatically by Geany, and you will have a terminal widget in the
notebook at the bottom.
If Geany cannot find any ``libvte.so`` at startup, the terminal widget
will not be loaded. So there is no need to install the package containing
this file in order to run Geany. Additionally, you can disable the use
of the terminal widget by command line option, for more information
see the section called `Command line options`_.
You can use this terminal (from now on called VTE) much as you would
a terminal program like xterm. There is basic clipboard support. You
can paste the contents of the clipboard by pressing the right mouse
button to open the popup menu, and choosing Paste. To copy text from
the VTE, just select the desired text and then press the right mouse
button and choose Copy from the popup menu. On systems running the
X Window System you can paste the last selected text by pressing the
middle mouse button in the VTE (on 2-button mice, the middle button
can often be simulated by pressing both mouse buttons together).
In the preferences dialog you can specify a shell which should be
started in the VTE. To make the specified shell a login shell just
use the appropriate command line options for the shell. These options
should be found in the manual page of the shell. For zsh and bash
you can use the argument ``--login``.
.. note::
Geany tries to load ``libvte.so``. If this fails, it tries to load
some other filenames. If this fails too, you should check whether you
installed libvte correctly. Again note, Geany will run without this
library.
It could be, that the library is called something else than
``libvte.so`` (e.g. on FreeBSD 6.0 it is called ``libvte.so.8``). If so
please set a link to the correct file (as root)::
# ln -s /usr/lib/libvte.so.X /usr/lib/libvte.so
Obviously, you have to adjust the paths and set X to the number of your
``libvte.so``.
You can also specify the filename of the VTE library to use on the command
line (see the section called `Command line options`_) or at compile time
by specifying the command line option ``--with-vte-module-path`` to
./configure.
Defining own widget styles using .gtkrc-2.0
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
You can define your widget style for many of Geany's GUI parts. To
do this, just edit your ``.gtkrc-2.0`` (usually found in your home
directory on UNIX-like systems and in the etc subdirectory of your
Geany installation on Windows).
To have a defined style used by Geany you must assign it to
at least one of Geany's widgets. For example use the following line::
widget "Geany*" style "geanyStyle"
This would assign your style "geany_style" to all Geany
widgets. You can also assign styles only to specific widgets. At the
moment you can use the following widgets:
* GeanyMainWindow
* GeanyEditMenu
* GeanyToolbarMenu
* GeanyDialog
* GeanyDialogPrefs
* GeanyDialogProject
* GeanyDialogSearch
* GeanyMenubar
* GeanyToolbar
An example of a simple ``.gtkrc-2.0``::
style "geanyStyle"
{
font_name="Sans 12"
}
widget "GeanyMainWindow" style "geanyStyle"
style "geanyStyle"
{
font_name="Sans 10"
}
widget "GeanyPrefsDialog" style "geanyStyle"
Documents
---------
Switching between documents
^^^^^^^^^^^^^^^^^^^^^^^^^^^
The documents list and the editor tabs are two different ways
to switch between documents using the mouse. When you hit the key
combination to move between tabs, the order is determined by the tab
order. It is not alphabetical as shown in the documents list
(regardless of whether or not editor tabs are visible).
See the `Notebook tab keybindings`_ section for useful
shortcuts including for Most-Recently-Used document switching.
Cloning documents
^^^^^^^^^^^^^^^^^
The `Document->Clone` menu item copies the current document's text,
cursor position and properties into a new untitled document. If
there is a selection, only the selected text is copied. This can be
useful when making temporary copies of text or for creating
documents with similar or identical contents.
Character sets and Unicode Byte-Order-Mark (BOM)
------------------------------------------------
Using character sets
^^^^^^^^^^^^^^^^^^^^
Geany provides support for detecting and converting character sets. So
you can open and save files in different character sets, and even
convert a file from one character set to another. To do this,
Geany uses the character conversion capabilities of the GLib library.
Only text files are supported, i.e. opening files which contain
NULL-bytes may fail. Geany will try to open the file anyway but it is
likely that the file will be truncated because it can only be read up
to the first occurrence of a NULL-byte. All characters after this
position are lost and are not written when you save the file.
Geany tries to detect the encoding of a file while opening it, but
auto-detecting the encoding of a file is not easy and sometimes an
encoding might not be detected correctly. In this case you have to
set the encoding of the file manually in order to display it
correctly. You can this in the file open dialog by selecting an
encoding in the drop down box or by reloading the file with the
file menu item "Reload as". The auto-detection works well for most
encodings but there are also some encodings where it is known that
auto-detection has problems.
There are different ways to set different encodings in Geany:
* Using the file open dialog
This opens the file with the encoding specified in the encoding drop
down box. If the encoding is set to "Detect from file" auto-detection
will be used. If the encoding is set to "Without encoding (None)" the
file will be opened without any character conversion and Geany will
not try to auto-detect the encoding (see below for more information).
* Using the "Reload as" menu item
This item reloads the current file with the specified encoding. It can
help if you opened a file and found out that the wrong encoding was used.
* Using the "Set encoding" menu item
Contrary to the above two options, this will not change or reload
the current file unless you save it. It is useful when you want to
change the encoding of the file.
* Specifying the encoding in the file itself
As mentioned above, auto-detecting the encoding of a file may fail on
some encodings. If you know that Geany doesn't open a certain file,
you can add the specification line, described in the next section,
to the beginning of the file to force Geany to use a specific
encoding when opening the file.
In-file encoding specification
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Geany detects meta tags of HTML files which contain charset information
like::
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-15" />
and the specified charset is used when opening the file. This is useful if the
encoding of the file cannot be detected properly.
For non-HTML files you can also define a line like::
/* geany_encoding=ISO-8859-15 */
or::
# geany_encoding=ISO-8859-15 #
to force an encoding to be used. The #, /\* and \*/ are examples
of filetype-specific comment characters. It doesn't matter which
characters are around the string " geany_encoding=ISO-8859-15 " as long
as there is at least one whitespace character before and after this
string. Whitespace characters are in this case a space or tab character.
An example to use this could be you have a file with ISO-8859-15
encoding but Geany constantly detects the file encoding as ISO-8859-1.
Then you simply add such a line to the file and Geany will open it
correctly the next time.
Since Geany 0.15 you can also use lines which match the
regular expression used to find the encoding string:
``coding[\t ]*[:=][\t ]*([a-z0-9-]+)[\t ]*``
.. note::
These specifications must be in the first 512 bytes of the file.
Anything after the first 512 bytes will not be recognized.
Some examples are::
# encoding = ISO-8859-15
or::
# coding: ISO-8859-15
Special encoding "None"
^^^^^^^^^^^^^^^^^^^^^^^
There is a special encoding "None" which uses no
encoding. It is useful when you know that Geany cannot auto-detect
the encoding of a file and it is not displayed correctly. Especially
when the file contains NULL-bytes this can be useful to skip auto
detection and open the file properly at least until the occurrence
of the first NULL-byte. Using this encoding opens the file as it is
without any character conversion.
Unicode Byte-Order-Mark (BOM)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Furthermore, Geany detects a Unicode Byte Order Mark (see
http://en.wikipedia.org/wiki/Byte_Order_Mark for details). Of course,
this feature is only available if the opened file is in a Unicode
encoding. The Byte Order Mark helps to detect the encoding of a file,
e.g. whether it is UTF-16LE or UTF-16BE and so on. On Unix-like systems
using a Byte Order Mark could cause some problems for programs not
expecting it, e.g. the compiler gcc stops
with stray errors, PHP does not parse a script containing a BOM and
script files starting with a she-bang maybe cannot be started. In the
status bar you can easily see whether the file starts with a BOM or
not.
If you want to set a BOM for a file or if you want to remove it
from a file, just use the document menu and toggle the checkbox.
.. note::
If you are unsure what a BOM is or if you do not understand where
to use it, then it is probably not important for you and you can
safely ignore it.
Editing
-------
Folding
^^^^^^^
Geany provides basic code folding support. Folding means the ability to
show and hide parts of the text in the current file. You can hide
unimportant code sections and concentrate on the parts you are working on
and later you can show hidden sections again. In the editor window there is
a small grey margin on the left side with [+] and [-] symbols which
show hidden parts and hide parts of the file respectively. By
clicking on these icons you can simply show and hide sections which are
marked by vertical lines within this margin. For many filetypes nested
folding is supported, so there may be several fold points within other
fold points.
.. note::
You can customize the folding icon and line styles - see the
filetypes.common `Folding Settings`_.
If you don't like it or don't need it at all, you can simply disable
folding support completely in the preferences dialog.
The folding behaviour can be changed with the "Fold/Unfold all children of
a fold point" option in the preference dialog. If activated, Geany will
unfold all nested fold points below the current one if they are already
folded (when clicking on a [+] symbol).
When clicking on a [-] symbol, Geany will fold all nested fold points
below the current one if they are unfolded.
This option can be inverted by pressing the Shift
key while clicking on a fold symbol. That means, if the "Fold/Unfold all
children of a fold point" option is enabled, pressing Shift will disable
it for this click and vice versa.
Column mode editing (rectangular selections)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
There is basic support for column mode editing. To use it, create a
rectangular selection by holding down the Control and Shift keys
(or Alt and Shift on Windows) while selecting some text.
Once a rectangular selection exists you can start editing the text within
this selection and the modifications will be done for every line in the
selection.
It is also possible to create a zero-column selection - this is
useful to insert text on multiple lines.
Drag and drop of text
^^^^^^^^^^^^^^^^^^^^^
If you drag selected text in the editor widget of Geany the text is
moved to the position where the mouse pointer is when releasing the
mouse button. Holding Control when releasing the mouse button will
copy the text instead. This behaviour was changed in Geany 0.11 -
before the selected text was copied to the new position.
Indentation
^^^^^^^^^^^
Geany allows each document to indent either with a tab character,
multiple spaces or a combination of both. The default indent
settings are set in `Editor Indentation preferences`_ (see the link
for more information).
The default settings can be overridden per-document using the
Document menu. They can also be overridden by projects - see
`Project management`_.
The indent mode for the current document is shown on the status bar
as follows:
TAB
Indent with Tab characters.
SP
Indent with spaces.
T/S
Indent with tabs and spaces, depending on how much indentation is
on a line.
Applying new indentation settings
`````````````````````````````````
After changing the default settings you may wish to apply the new
settings to every document in the current session. To do this use the
*Project->Apply Default Indentation* menu item.
Detecting indent type
`````````````````````
The *Detect from file* indentation preference can be used to
scan each file as it's opened and set the indent type based on
how many lines start with a tab vs. 2 or more spaces.
Auto-indentation
^^^^^^^^^^^^^^^^
When enabled, auto-indentation happens when pressing *Enter* in the
Editor. It adds a certain amount of indentation to the new line so the
user doesn't always have to indent each line manually.
Geany has four types of auto-indentation:
None
Disables auto-indentation completely.
Basic
Adds the same amount of whitespace on a new line as on the last line.
Current chars
Does the same as *Basic* but also indents a new line after an opening
brace '{', and de-indents when typing a closing brace '}'. For Python,
a new line will be indented after typing ':' at the end of the
previous line.
Match braces
Similar to *Current chars* but the closing brace will be aligned to
match the indentation of the line with the opening brace.
There is also XML-tag auto-indentation. This is enabled when the
mode is more than just Basic, and is also controlled by a filetype
setting - see `xml_indent_tags`_.
Bookmarks
^^^^^^^^^
Geany provides a handy bookmarking feature that lets you mark one
or more lines in a document, and return the cursor to them using a
key combination.
To place a mark on a line, either left-mouse-click in the left margin
of the editor window, or else use Ctrl-m. This will
produce a small green plus symbol in the margin. You can have as many
marks in a document as you like. Click again (or use Ctrl-m again)
to remove the bookmark. To remove all the marks in a given document,
use "Remove Markers" in the Document menu.
To navigate down your document, jumping from one mark to the next,
use Ctrl-. (control period). To go in the opposite direction on
the page, use Ctrl-, (control comma). Using the bookmarking feature
together with the commands to switch from one editor tab to another
(Ctrl-PgUp/PgDn and Ctrl-Tab) provides a particularly fast way to
navigate around multiple files.
Code navigation history
^^^^^^^^^^^^^^^^^^^^^^^
To ease navigation in source files and especially between
different files, Geany lets you jump between different navigation
points. Currently, this works for the following:
* `Go to tag declaration`_
* `Go to tag definition`_
* Symbol list items
* Build errors
* Message items
When using one of these actions, Geany remembers your current position
and jumps to the new one. If you decide to go back to your previous
position in the file, just use "Navigate back a location". To
get back to the new position again, just use "Navigate forward a
location". This makes it easier to navigate in e.g. foreign code
and between different files.
Sending text through custom commands
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
You can define several custom commands in Geany and send the current
selection to one of these commands using the *Edit->Format->Send
Selection to* menu or keybindings. The output of the command will be
used to replace the current selection. This makes it possible to use
text formatting tools with Geany in a general way.
The selected text will be sent to the standard input of the executed
command, so the command should be able to read from it and it should
print all results to its standard output which will be read by
Geany. To help finding errors in executing the command, the output
of the program's standard error will be printed on Geany's standard
output.
If there is no selection, the whole current line is used instead.
To add a custom command, use the *Send Selection to->Set Custom
Commands* menu item. Click on *Add* to get a new item and type the
command. You can also specify some command line options. Empty
commands are not saved.
Normal shell quoting is supported, so you can do things like:
* ``sed 's/\./(dot)/g'``
The above example would normally be done with the `Replace all`_
function, but it can be handy to have common commands already set up.
Context actions
^^^^^^^^^^^^^^^
You can execute the context action command on the current word at the
cursor position or the available selection. This word or selection
can be used as an argument to the command.
The context action is invoked by a menu entry in the popup menu of the
editor and also a keyboard shortcut (see the section called
`Keybindings`_).
The command can be specified in the preferences dialog and also for
each filetype (see "context_action_cmd" in the section called
`Filetype configuration`_). When the context action is invoked, the filetype
specific command is used if available, otherwise the command
specified in the preferences dialog is executed.
The current word or selection can be referred with the wildcard "%s"
in the command, it will be replaced by the current word or
selection before the command is executed.
For example a context action can be used to open API documentation
in a browser window, the command to open the PHP API documentation
would be::
firefox "http://www.php.net/%s"
when executing the command, the %s is substituted by the word near
the cursor position or by the current selection. If the cursor is at
the word "echo", a browser window will open(assumed your browser is
called firefox) and it will open the address: http://www.php.net/echo.
Autocompletion
^^^^^^^^^^^^^^
Geany can offer a list of possible completions for symbols defined in the
tags and for all words in a document.
The autocompletion list for symbols is presented when the first few
characters of the symbol are typed (configurable, see `Editor Completions
preferences`_, default 4) or when the *Complete word*
keybinding is pressed (configurable, see `Editor keybindings`_,
default Ctrl-Space).
When the defined keybinding is typed and the *Autocomplete all words in
document* preference (in `Editor Completions preferences`_)
is selected then the autocompletion list will show all matching words
in the document, if there are no matching symbols.
If you don't want to use autocompletion it can be dismissed until
the next symbol by pressing Escape. The autocompletion list is updated
as more characters are typed so that it only shows completions that start
with the characters typed so far. If no symbols begin with the sequence,
the autocompletion window is closed.
The up and down arrows will move the selected item. The highlighted
item on the autocompletion list can be chosen from the list by pressing
Enter/Return. You can also double-click to select an item. The sequence
will be completed to match the chosen item, and if the *Drop rest of
word on completion* preference is set (in `Editor Completions
preferences`_) then any characters after the cursor that match
a symbol or word are deleted.
Word part completion
````````````````````
By default, pressing Tab will complete the selected item by word part;
useful e.g. for adding the prefix ``gtk_combo_box_entry_`` without typing it
manually:
* gtk_com<TAB>
* gtk_combo_<TAB>
* gtk_combo_box_<e><TAB>
* gtk_combo_box_entry_<s><ENTER>
* gtk_combo_box_entry_set_text_column
The key combination can be changed from Tab - See `Editor keybindings`_.
If you clear/change the key combination for word part completion, Tab
will complete the whole word instead, like Enter.
Scope autocompletion
````````````````````
E.g.::
struct
{
int i;
char c;
} foo;
When you type ``foo.`` it will show an autocompletion list with 'i' and
'c' symbols.
It only works for languages that set parent scope names for e.g. struct
members. Currently this means C-like languages. The C tag parser only
parses global scopes, so this won't work for structs or objects declared
in local scope.
User-definable snippets
^^^^^^^^^^^^^^^^^^^^^^^
Snippets are small strings or code constructs which can be replaced or
completed to a more complex string. So you can save a lot of time when
typing common strings and letting Geany do the work for you.
To know what to complete or replace Geany reads a configuration file
called ``snippets.conf`` at startup.
Maybe you need to often type your name, so define a snippet like this::
[Default]
myname=Enrico TrĂśger
Every time you write ``myname`` <TAB> in Geany, it will replace "myname"
with "Enrico TrĂśger". The key to start autocompletion can be changed
in the preferences dialog, by default it is TAB. The corresponding keybinding
is called `Complete snippet`.
**Paths**
You can override the default snippets using the user
``snippets.conf`` file. Use the *Tools->Configuration
Files->snippets.conf* menu item. See also `Configuration file paths`_.
This adds the default settings to the user file if the file doesn't
exist. Alternatively the file can be created manually, adding only
the settings you want to change. All missing settings will be read
from the system snippets file.
**Snippet groups**
The file ``snippets.conf`` contains sections defining snippets that
are available for particular filetypes and in general.
The two sections "Default" and "Special" apply to all filetypes.
"Default" contains all snippets which are available for every
filetype and "Special" contains snippets which can only be used in
other snippets. So you can define often used parts of snippets and
just use the special snippet as a placeholder (see the
``snippets.conf`` for details).
You can define sections with the name of a filetype eg "C++". The
snippets in that section are only available for use in files with that
filetype. Snippets in filetype sections will hide snippets with the
same name in the "Default" section when used in a file of that
filetype.
**Substitution sequences for snippets**
To define snippets you can use several special character sequences which
will be replaced when using the snippet:
================ =========================================================
\\n or %newline% Insert a new line (it will be replaced by the used EOL
char(s): LF, CR/LF, or CR).
\\t or %ws% Insert an indentation step, it will be replaced according
to the current document's indent mode.
\\s \\s to force whitespace at beginning or end of a value
('key= value' won't work, use 'key=\\svalue')
%cursor% Place the cursor at this position after completion has
been done. You can define multiple %cursor% wildcards
and use the keybinding `Move cursor in snippet` to jump
to the next defined cursor position in the completed
snippet.
%...% "..." means the name of a key in the "Special" section.
If you have defined a key "brace_open" in the "Special"
section you can use %brace_open% in any other snippet.
================ =========================================================
Snippet names must not contain spaces otherwise they won't
work correctly. But beside that you can define almost any
string as a snippet and use it later in Geany. It is not limited
to existing contructs of certain programming languages(like ``if``,
``for``, ``switch``). Define whatever you need.
**Template wildcards**
Since Geany 0.15 you can also use most of the available templates wildcards
listed in `Template wildcards`_. All wildcards which are listed as
`available in snippets` can be used. For instance to improve the above example::
[Default]
myname=My name is {developer}
mysystem=My system: {command:uname -a}
this will replace ``myname`` with "My name is " and the value of the template
preference ``developer``.
**Word characters**
You can change the way Geany recognizes the word to complete,
that is how the start and end of a word is recognised when the
snippet completion is requested. The section "Special" may
contain a key "wordchars" which lists all characters a string may contain
to be recognized as a word for completion. Leave it commented to use
default characters or define it to add or remove characters to fit your
needs.
Snippet keybindings
```````````````````
Normally you would type the snippet name and press Tab. However, you
can define keybindings for snippets under the *Keybindings* group in
``snippets.conf``::
[Keybindings]
for=<Ctrl>7
block_cursor=<Ctrl>8
.. note::
Snippet keybindings may be overridden by Geany's configurable
keybindings.
Inserting Unicode characters
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
You can insert Unicode code points by hitting Ctrl-Shift-u, then still holding
Ctrl-Shift, type some hex digits representing the code point for the character
you want and hit Enter or Return (still holding Ctrl-Shift). If you release
Ctrl-Shift before hitting Enter or Return (or any other character), the code
insertion is completed, but the typed character is also entered. In the case
of Enter/Return, it is a newline, as you might expect.
In some earlier versions of Geany, you might need to first unbind Ctrl-Shift-u
in the `keybinding preferences`_, then select *Tools->Reload Configuration*
or restart Geany. Note that it works slightly differently from other GTK
applications, in that you'll need to continue to hold down the Ctrl and Shift
keys while typing the code point hex digits (and the Enter or Return to finish the code point).
Search, replace and go to
-------------------------
This section describes search-related commands from the Search menu
and the editor window's popup menu:
* Find
* Find selection
* Find usage
* Find in files
* Replace
* Go to tag definition
* Go to tag declaration
* Go to line
See also `Search`_ preferences.
Toolbar entries
^^^^^^^^^^^^^^^
There are also two toolbar entries:
* Search bar
* Go to line entry
There are keybindings to focus each of these - see `Focus
keybindings`_. Pressing Escape will then focus the editor.
Search bar
``````````
The quickest way to find some text is to use the search bar entry in
the toolbar. This performs a case-insensitive search in the current
document whilst you type. Pressing Enter will search again, and pressing
Shift-Enter will search backwards.
Find
^^^^
The Find dialog is used for finding text in one or more open documents.
.. image:: ./images/find_dialog.png
Matching options
````````````````
The syntax for the *Use regular expressions* option is shown in
`Regular expressions`_.
.. note::
*Use escape sequences* is implied for regular expressions.
The *Use escape sequences* option will transform any escaped characters
into their UTF-8 equivalent. For example, \\t will be transformed into
a tab character. Other recognized symbols are: \\\\, \\n, \\r, \\uXXXX
(Unicode characters).
Find all
````````
To find all matches, click on the Find All expander. This will reveal
several options:
* In Document
* In Session
* Mark
Find All In Document will show a list of matching lines in the
current document in the Messages tab of the Message Window. *Find All
In Session* does the same for all open documents.
Mark will highlight all matches in the current document with a
colored box. These markers can be removed by selecting the
Remove Markers command from the Document menu.
Change font in search dialog text fields
````````````````````````````````````````
All search related dialogs use a Monospace for the text input fields to
increase the readability of input text. This is useful when you are
typing input such as regular expressions with spaces, periods and commas which
might it hard to read with a proportional font.
If you want to change the font, you can do this easily
by inserting the following style into your ``.gtkrc-2.0``
(usually found in your home directory on UNIX-like systems and in the
etc subdirectory of your Geany installation on Windows)::
style "search_style"
{
font_name="Monospace 8"
}
widget "GeanyDialogSearch.*.GtkEntry" style:highest "search_style"
Please note the addition of ":highest" in the last line which sets the priority
of this style to the highest available. Otherwise, the style is ignored
for the search dialogs.
Find selection
^^^^^^^^^^^^^^
The *Find Next/Previous Selection* commands perform a search for the
current selected text. If nothing is selected, by default the current
word is used instead. This can be customized by the
*find_selection_type* preference - see `Various preferences`_.
===== =============================================
Value *find_selection_type* behaviour
===== =============================================
0 Use the current word (default).
1 Try the X selection first, then current word.
2 Repeat last search.
===== =============================================
Find usage
^^^^^^^^^^
Find usage searches all open files. It is similar to the Find All In
Session option in the Find dialog.
If there is a selection, then it is used as the search text; otherwise
the current word is used. The current word is either taken from the
word nearest the edit cursor, or the word underneath the popup menu
click position when the popup menu is used. The search results are
shown in the Messages tab of the Message Window.
Find in files
^^^^^^^^^^^^^
Find in files is a more powerful version of Find usage that searches
all files in a certain directory using the Grep tool. The Grep tool
must be correctly set in Preferences to the path of the system's Grep
utility. GNU Grep is recommended (see note below).
.. image:: ./images/find_in_files_dialog.png
The *Search* field is initially set to the current word in the editor
(depending on `Search`_ preferences).
The *Files* setting allows to choose which files are included in the
search, depending on the mode:
All
Search in all files;
Project
Use the current project's patterns, see `Project properties`_;
Custom
Use custom patterns.
Both project and custom patterns use a glob-style syntax, each
pattern separated by a space. To search all ``.c`` and ``.h`` files,
use: ``*.c *.h``.
Note that an empty pattern list searches in all files rather
than none.
The *Directory* field is initially set to the current document's directory,
unless this field has already been edited and the current document has
not changed. Otherwise, the current document's directory is prepended to
the drop-down history. This can be disabled - see `Search`_ preferences.
The *Encoding* field can be used to define the encoding of the files
to be searched. The entered search text is converted to the chosen encoding
and the search results are converted back to UTF-8.
The *Extra options* field is used to pass any additional arguments to
the grep tool.
.. note::
The *Files* setting uses ``--include=`` when searching recursively,
*Recurse in subfolders* uses ``-r``; both are GNU Grep options and may
not work with other Grep implementations.
Filtering out version control files
```````````````````````````````````
When using the *Recurse in subfolders* option with a directory that's
under version control, you can set the *Extra options* field to filter
out version control files.
If you have GNU Grep >= 2.5.2 you can use the ``--exclude-dir``
argument to filter out CVS and hidden directories like ``.svn``.
Example: ``--exclude-dir=.svn --exclude-dir=CVS``
If you have an older Grep, you can try using the ``--exclude`` flag
to filter out filenames.
SVN Example: ``--exclude=*.svn-base``
The --exclude argument only matches the file name part, not the path.
Replace
^^^^^^^
The Replace dialog is used for replacing text in one or more open
documents.
.. image:: ./images/replace_dialog.png
The Replace dialog has the same options for matching text as the Find
dialog. See the section `Matching options`_.
The *Use regular expressions* option allows regular expressions to
be used in the search string and back references in the replacement
text -- see the entry for '\\n' in `Regular expressions`_.
Replace all
```````````
To replace several matches, click on the *Replace All* expander. This
will reveal several options:
* In Document
* In Session
* In Selection
*Replace All In Document* will replace all matching text in the
current document. *Replace All In Session* does the same for all open
documents. *Replace All In Selection* will replace all matching text
in the current selection of the current document.
Go to tag definition
^^^^^^^^^^^^^^^^^^^^
If the current word or selection is the name of a tag definition
(e.g. a function name) and the file containing the tag definition is
open, this command will switch to that file and go to the
corresponding line number. The current word is either the word
nearest the edit cursor, or the word underneath the popup menu click
position when the popup menu is used.
.. note::
If the corresponding tag is on the current line, Geany will first
look for a tag declaration instead, as this is more useful.
Likewise *Go to tag declaration* will search for a tag definition
first in this case also.
Go to tag declaration
^^^^^^^^^^^^^^^^^^^^^
Like *Go to tag definition*, but for a forward declaration such as a
C function prototype or ``extern`` declaration instead of a function
body.
Go to line
^^^^^^^^^^
Go to a particular line number in the current file.
Regular expressions
^^^^^^^^^^^^^^^^^^^
You can use regular expressions in the Find and Replace dialogs
by selecting the *Use regular expressions* check box (see `Matching
options`_). The syntax is Perl compatible. Basic syntax is described
in the table below. For full details, see
http://www.geany.org/manual/gtk/glib/glib-regex-syntax.html.
.. note::
1. The *Use escape sequences* dialog option always applies for regular
expressions.
2. Searching backwards with regular expressions is not supported.
**In a regular expression, the following characters are interpreted:**
======= ============================================================
. Matches any character.
( This marks the start of a region for tagging a match.
) This marks the end of a tagged region.
\\n Where n is 1 through 9 refers to the first through ninth tagged
region when searching or replacing.
Searching for (Wiki)\\1 matches WikiWiki.
If the search string was Fred([1-9])XXX and the
replace string was Sam\\1YYY, when applied to Fred2XXX this
would generate Sam2YYY.
\\0 When replacing, the whole matching text.
\\b This matches a word boundary.
\\c A backslash followed by d, D, s, S, w or W, becomes a
character class (both inside and outside sets []).
* d: decimal digits
* D: any char except decimal digits
* s: whitespace (space, \\t \\n \\r \\f \\v)
* S: any char except whitespace (see above)
* w: alphanumeric & underscore
* W: any char except alphanumeric & underscore
\\x This allows you to use a character x that would otherwise have
a special meaning. For example, \\[ would be interpreted as [
and not as the start of a character set. Use \\\\ for a literal
backslash.
[...] Matches one of the characters in the set. If the first
character in the set is ^, it matches the characters NOT in
the set, i.e. complements the set. A shorthand S-E (start
dash end) is used to specify a set of characters S up to E,
inclusive.
The special characters ] and - have no special
meaning if they appear first in the set. - can also be last
in the set. To include both, put ] first: []A-Z-].
Examples::
[]|-] matches these 3 chars
[]-|] matches from ] to | chars
[a-z] any lowercase alpha
[^]-] any char except - and ]
[^A-Z] any char except uppercase alpha
[a-zA-Z] any alpha
^ This matches the start of a line (unless used inside a set, see
above).
$ This matches the end of a line.
\* This matches 0 or more times. For example, Sa*m matches Sm, Sam,
Saam, Saaam and so on.
\+ This matches 1 or more times. For example, Sa+m matches Sam,
Saam, Saaam and so on.
\? This matches 0 or 1 time(s). For example, Joh?n matches John, Jon.
======= ============================================================
.. note::
This table is adapted from Scintilla and SciTE documentation,
distributed under the `License for Scintilla and SciTE`_.
View menu
---------
The View menu allows various elements of the main window to be shown
or hidden, and also provides various display-related editor options.
Color schemes menu
^^^^^^^^^^^^^^^^^^
The Color schemes menu is available under the *View->Editor* submenu.
It lists various color schemes for editor highlighting styles,
including the default scheme first. Other items are available based
on what color scheme files Geany found at startup.
Color scheme files are read from the `Configuration file paths`_ under
the ``colorschemes`` subdirectory. They should have the extension
``.conf``. The default color scheme
is read from ``filetypes.common``.
The `[named_styles] section`_ and `[named_colors] section`_ are the
same as for ``filetypes.common``.
The ``[theme_info]`` section can contain information about the
theme. The ``name`` and ``description`` keys are read to set the
menu item text and tooltip, respectively. These keys can have
translations, e.g.::
key=Hello
key[de]=Hallo
key[fr_FR]=Bonjour
Tags
----
Tags are information that relates symbols in a program with the
source file location of the declaration and definition.
Geany has built-in functionality for generating tag information (aka
"workspace tags") for supported filetypes when you open a file. You
can also have Geany automatically load external tag files (aka "global
tags files") upon startup, or manually using *Tools --> Load Tags*.
Geany uses its own tag file format, similar to what ``ctags`` uses
(but is incompatible with ctags). You use Geany to generate global
tags files, as described below.
Workspace tags
^^^^^^^^^^^^^^
Tags for each document are parsed whenever a file is loaded, saved or
modified (see *Symbol list update frequency* preference in the `Editor
Completions preferences`_). These are shown in the Symbol list in the
Sidebar. These tags are also used for autocompletion of symbols and calltips
for all documents open in the current session that have the same filetype.
The *Go to Tag* commands can be used with all workspace tags. See
`Go to tag definition`_.
Global tags
^^^^^^^^^^^
Global tags are used to provide autocompletion of symbols and calltips
without having to open the corresponding source files. This is intended
for library APIs, as the tags file only has to be updated when you upgrade
the library.
You can load a custom global tags file in two ways:
* Using the *Load Tags* command in the Tools menu.
* By moving or symlinking tags files to the ``tags`` subdirectory of
one of the `configuration file paths`_ before starting Geany.
You can either download these files or generate your own. They have
the format::
name.lang_ext.tags
*lang_ext* is one of the extensions set for the filetype associated
with the tags. See the section called `Filetype extensions`_ for
more information.
Default global tags files
`````````````````````````
For some languages, a list of global tags is loaded when the
corresponding filetype is first used. Currently these are for:
* C
* Pascal
* PHP
* HTML -- &symbol; completion, e.g. for ampersand, copyright, etc.
* LaTeX
* Python
Global tags file format
```````````````````````
Global tags files can have two different formats:
* Tagmanager format
* Pipe-separated format
The first line of global tags files should be a comment, introduced
by ``#`` followed by a space and a string like ``format=pipe``
or ``format=tagmanager`` respectively, these are case-sensitive.
This helps Geany to read the file properly. If this line
is missing, Geany tries to auto-detect the used format but this
might fail.
The Tagmanager format is a bit more complex and is used for files
created by the ``geany -g`` command. There is one tag per line.
Different tag attributes like the return value or the argument list
are separated with different characters indicating the type of the
following argument.
Pipe-separated format
*********************
The Pipe-separated format is easier to read and write.
There is one tag per line and different tag attributes are separated
by the pipe character (``|``). A line looks like::
basename|string|(string path [, string suffix])|
| The first field is the tag name (usually a function name).
| The second field is the type of the return value.
| The third field is the argument list for this tag.
| The fourth field is the description for this tag but
currently unused and should be left empty.
Except for the first field (tag name), all other field can be left
empty but the pipe separator must appear for them.
You can easily write your own global tag files using this format.
Just save them in your tags directory, as described earlier in the
section `Global tags`_.
Generating a global tags file
`````````````````````````````
You can generate your own global tags files by parsing a list of
source files. The command is::
geany -g [-P] <Tag File> <File list>
* Tag File filename should be in the format described earlier --
see the section called `Global tags`_.
* File list is a list of filenames, each with a full path (unless
you are generating C/C++ tags and have set the CFLAGS environment
variable appropriately).
* ``-P`` or ``--no-preprocessing`` disables using the C pre-processor
to process ``#include`` directives for C/C++ source files. Use this
option if you want to specify each source file on the command-line
instead of using a 'master' header file. Also can be useful if you
don't want to specify the CFLAGS environment variable.
Example for the wxD library for the D programming language::
geany -g wxd.d.tags /home/username/wxd/wx/*.d
Generating C/C++ tag files
**************************
You may need to first setup the `C ignore.tags`_ file.
For C/C++ tag files gcc is required by default, so that header files
can be preprocessed to include any other headers they depend upon. If
you do not want this, use the ``-P`` option described above.
For preprocessing, the environment variable CFLAGS should be set with
appropriate ``-I/path`` include paths. The following example works with
the bash shell, generating tags for the GnomeUI library::
CFLAGS=`pkg-config --cflags libgnomeui-2.0` geany -g gnomeui.c.tags \
/usr/include/libgnomeui-2.0/gnome.h
You can adapt this command to use CFLAGS and header files appropriate
for whichever libraries you want.
Generating tag files on Windows
*******************************
This works basically the same as on other platforms::
"c:\program files\geany\bin\geany" -g c:\mytags.php.tags c:\code\somefile.php
C ignore.tags
^^^^^^^^^^^^^
You can ignore certain tags for C-based languages if they would lead
to wrong parsing of the code. Use the *Tools->Configuration
Files->ignore.tags* menu item to open the user ``ignore.tags`` file.
See also `Configuration file paths`_.
List all tag names you want to ignore in this file, separated by spaces
and/or newlines.
Example::
G_GNUC_NULL_TERMINATED
G_GNUC_PRINTF
G_GNUC_WARN_UNUSED_RESULT
This will parse code like:
``gchar **utils_strv_new(const gchar *first, ...)
G_GNUC_NULL_TERMINATED;``
More detailed information about ignore tags usage from the Exuberant Ctags
manual page:
Specifies a list of identifiers which are to be specially handled
while parsing C and C++ source files. This option is specifically
provided to handle special cases arising through the use of
pre-processor macros. When the identifiers listed are simple identifiers,
these identifiers will be ignored during parsing of the source files.
If an identifier is suffixed with a '+' character, ctags will also
ignore any parenthesis-enclosed argument list which may immediately
follow the identifier in the source files.
If two identifiers are separated with the '=' character, the first
identifiers is replaced by the second identifiers for parsing purposes.
For even more detailed information please read the manual page of
Exuberant Ctags.
Geany extends Ctags with a '*' character suffix - this means use
prefix matching, e.g. G_GNUC_* will match G_GNUC_NULL_TERMINATED, etc.
Note that prefix match items should be put after other items to ensure
that items like G_GNUC_PRINTF+ get parsed correctly.
Preferences
-----------
You may adjust Geany's settings using the Edit --> Preferences
dialog. Any changes you make there can be applied by hitting either
the Apply or the OK button. These settings will persist between Geany
sessions. Note that most settings here have descriptive popup bubble
help -- just hover the mouse over the item in question to get help
on it.
You may also adjust some View settings (under the View menu) that
persist between Geany sessions. The settings under the Document menu,
however, are only for the current document and revert to defaults
when restarting Geany.
.. note::
In the paragraphs that follow, the text describing a dialog tab
comes after the screenshot of that tab.
General Startup preferences
^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. image:: ./images/pref_dialog_gen_startup.png
Startup
```````
Load files from the last session
On startup, load the same files you had open the last time you
used Geany.
Load virtual terminal support
Load the library for running a terminal in the message window area.
Enable plugin support
Allow plugins to be used in Geany.
Shutdown
````````
Save window position and geometry
Save the current position and size of the main window so next time
you open Geany it's in the same location.
Confirm Exit
Have a dialog pop up to confirm that you really want to quit Geany.
Paths
`````
Startup path
Path to start in when opening or saving files.
It must be an absolute path.
Project files
Path to start in when opening project files.
Extra plugin path
By default Geany looks in the system installation and the user
configuration - see `Plugins`_. In addition the path entered here will be
searched.
Usually you do not need to set an additional path to search for
plugins. It might be useful when Geany is installed on a multi-user machine
and additional plugins are available in a common location for all users.
Leave blank to not set an additional lookup path.
General Miscellaneous preferences
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. image:: ./images/pref_dialog_gen_misc.png
Miscellaneous
`````````````
Beep on errors when compilation has finished
Have the computer make a beeping sound when compilation of your program
has completed or any errors occurred.
Switch status message list at new message
Switch to the status message tab (in the notebook window at the bottom)
once a new status message arrives.
Suppress status messages in the status bar
Remove all messages from the status bar. The messages are still displayed
in the status messages window.
.. tip::
Another option is to use the *Switch to Editor* keybinding - it
reshows the document statistics on the status bar. See `Focus
keybindings`_.
Use Windows File Open/Save dialogs
Defines whether to use the native Windows File Open/Save dialogs or
whether to use the GTK default dialogs.
Auto-focus widgets (focus follows mouse)
Give the focus automatically to widgets below the mouse cursor.
This works for the main editor widget, the scribble, the toolbar search field
goto line fields and the VTE.
Search
``````
Always wrap search
Always wrap search around the document when finding a match.
Hide the Find dialog
Hide the `Find`_ dialog after clicking Find Next/Previous.
Use the current word under the cursor for Find dialogs
Use current word under the cursor when opening the Find, Find in Files or Replace dialog and
there is no selection. When this option is disabled, the search term last used in the
appropriate Find dialog is used.
Use the current file's directory for Find in Files
When opening the Find in Files dialog, set the directory to search to the directory of the current
active file. When this option is disabled, the directory of the last use of the Find in Files
dialog is used. See `Find in Files`_ for details.
Projects
````````
Use project-based session files
Save your current session when closing projects. You will be able to
resume different project sessions, automatically opening the files
you had open previously.
Store project file inside the project base directory
When creating new projects, the default path for the project file contains
the project base path. Without this option enabled, the default project file
path is one level above the project base path.
In either case, you can easily set the final project file path in the
*New Project* dialog. This option provides the more common
defaults automatically for convenience.
Interface preferences
^^^^^^^^^^^^^^^^^^^^^
.. image:: ./images/pref_dialog_interface_interface.png
Sidebar
```````
Show sidebar
Whether to show the sidebar at all.
Show symbol list
Show the list of functions, variables, and other information in the
current document you are editing.
Show documents list
Show all the documents you have open currently. This can be used to
change between documents (see `Switching between documents`_) and
to perform some common operations such as saving, closing and reloading.
Position
Whether to place the sidebar on the left or right of the editor window.
Fonts
`````
Editor
Change the font used to display documents.
Symbol list
Change the font used for the Symbols sidebar tab.
Message window
Change the font used for the message window area.
Miscellaneous
`````````````
Show status bar
Show the status bar at the bottom of the main window. It gives information about
the file you are editing like the line and column you are on, whether any
modifications were done, the file encoding, the filetype and other information.
Interface Notebook tab preferences
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. image:: ./images/pref_dialog_interface_notebook.png
Editor tabs
```````````
Show editor tabs
Show a notebook tab for all documents so you can switch between them
using the mouse (instead of using the Documents window).
Show close buttons
Make each tab show a close button so you can easily close open
documents.
Placement of new file tabs
Whether to create a document with its notebook tab to the left or
right of all existing tabs.
Next to current
Whether to place file tabs next to the current tab
rather than at the edges of the notebook.
Double-clicking hides all additional widgets
Whether to call the View->Toggle All Additional Widgets command
when double-clicking on a notebook tab.
Tab positions
`````````````
Editor
Set the positioning of the editor's notebook tabs to the right,
left, top, or bottom of the editing window.
Sidebar
Set the positioning of the sidebar's notebook tabs to the right,
left, top, or bottom of the sidebar window.
Message window
Set the positioning of the message window's notebook tabs to the
right, left, top, or bottom of the message window.
Interface Toolbar preferences
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Affects the main toolbar underneath the menu bar.
.. image:: ./images/pref_dialog_interface_toolbar.png
Toolbar
```````
Show Toolbar
Whether to show the toolbar.
Append Toolbar to the Menu
Allows to append the toolbar to the main menu bar instead of placing it below.
This is useful to save vertical space.
Customize Toolbar
See `Customizing the toolbar`_.
Appearance
``````````
Icon Style
Select the toolbar icon style to use - either icons and text, just
icons or just text.
The choice System default uses whatever icon style is set by GTK.
Icon size
Select the size of the icons you see (large, small or very small).
The choice System default uses whatever icon size is set by GTK.
Editor Features preferences
^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. image:: ./images/pref_dialog_edit_features.png
Features
````````
Line wrapping
Show long lines wrapped around to new display lines.
.. _smart_home_key:
"Smart" home key
Whether to move the cursor to the first non-whitespace character
on the line when you hit the home key on your keyboard. Pressing it
again will go to the very start of the line.
Disable Drag and Drop
Do not allow the dragging and dropping of selected text in documents.
Code folding
Allow groups of lines in a document to be collapsed for easier
navigation/editing.
Fold/Unfold all children of a fold point
Whether to fold/unfold all child fold points when a parent line
is folded.
Use indicators to show compile errors
Underline lines with compile errors using red squiggles to indicate
them in the editor area.
Newline strips trailing spaces
Remove any whitespace at the end of the line when you hit the
Enter/Return key. See also `Strip trailing spaces`_.
Line breaking column
The editor column number to insert a newline at when Line Breaking
is enabled for the current document.
Comment toggle marker
A string which is added when toggling a line comment in a source file.
It is used to mark the comment as toggled.
Editor Indentation preferences
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. image:: ./images/pref_dialog_edit_indentation.png
Indentation group
`````````````````
See `Indentation`_ for more information.
Width
The width of a single indent size in spaces. By default the indent
size is equivalent to 4 spaces.
Detect width from file
Try to detect and set the indent width based on file content, when
a file is opened.
Type
When Geany inserts indentation, whether to use:
* Just Tabs
* Just Spaces
* Tabs and Spaces, depending on how much indentation is on a line
The *Tabs and Spaces* indent type is also known as *Soft tab
support* in some other editors.
Detect type from file
Try to detect and set the indent type based on file content, when
a file is opened.
Auto-indent mode
The type of auto-indentation you wish to use after pressing Enter,
if any.
Basic
Just add the indentation of the previous line.
Current chars
Add indentation based on the current filetype and any characters at
the end of the line such as ``{``, ``}`` for C, ``:`` for Python.
Match braces
Like *Current chars* but for C-like languages, make a closing
``}`` brace line up with the matching opening brace.
Tab key indents
If set, pressing tab will indent the current line or selection, and
unindent when pressing Shift-tab. Otherwise, the tab key will
insert a tab character into the document (which can be different
from indentation, depending on the indent type).
.. note::
There are also separate configurable keybindings for indent &
unindent, but this preference allows the tab key to have different
meanings in different contexts - e.g. for snippet completion.
Editor Completions preferences
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. image:: ./images/pref_dialog_edit_completions.png
Completions
```````````
Snippet Completion
Whether to replace special keywords after typing Tab into a
pre-defined text snippet.
See `User-definable snippets`_.
XML/HTML tag auto-closing
When you open an XML/HTML tag automatically generate its
completion tag.
Automatic continuation multi-line comments
Continue automatically multi-line comments in languages like C, C++
and Java when a new line is entered inside such a comment.
With this option enabled, Geany will insert a ``*`` on every new line
inside a multi-line comment, for example when you press return in the
following C code::
/*
* This is a C multi-line comment, press <Return>
then Geany would insert::
*
on the next line with the correct indentation based on the previous line,
as long as the multi-line is not closed by ``*/``.
Autocomplete symbols
When you start to type a symbol name, look for the full string to
allow it to be completed for you.
Autocomplete all words in document
When you start to type a word, Geany will search the whole document for
words starting with the typed part to complete it, assuming there
are no tag names to show.
Drop rest of word on completion
Remove any word part to the right of the cursor when choosing a
completion list item.
Characters to type for autocompletion
Number of characters of a word to type before autocompletion is
displayed.
Completion list height
The number of rows to display for the autocompletion window.
Max. symbol name suggestions
The maximum number of items in the autocompletion list.
Symbol list update frequency
The minimum delay (in milliseconds) between two symbol list updates.
This option determines how frequently the tag list is updated for the
current document. The smaller the delay, the more up-to-date the symbol
list (and then the completions); but rebuilding the symbol list has a
cost in performance, especially with large files.
The default value is 250ms, which means the symbol list will be updated
at most four times per second, even if the document changes continuously.
A value of 0 disables automatic updates, so the symbol list will only be
updated upon document saving.
Auto-close quotes and brackets
``````````````````````````````
Geany can automatically insert a closing bracket and quote characters when
you open them. For instance, you type a ``(`` and Geany will automatically
insert ``)``. With the following options, you can define for which
characters this should work.
Parenthesis ( )
Auto-close parenthesis when typing an opening one
Curly brackets { }
Auto-close curly brackets (braces) when typing an opening one
Square brackets [ ]
Auto-close square brackets when typing an opening one
Single quotes ' '
Auto-close single quotes when typing an opening one
Double quotes " "
Auto-close double quotes when typing an opening one
Editor Display preferences
^^^^^^^^^^^^^^^^^^^^^^^^^^
This is for visual elements displayed in the editor window.
.. image:: ./images/pref_dialog_edit_display.png
Display
```````
Invert syntax highlighting colors
Invert all colors, by default this makes white text on a black
background.
Show indendation guides
Show vertical lines to help show how much leading indentation there
is on each line.
Show whitespaces
Mark all tabs with an arrow "-->" symbol and spaces with dots to
show which kinds of whitespace are used.
Show line endings
Display a symbol everywhere that a carriage return or line feed
is present.
Show line numbers
Show or hide the Line Number margin.
Show markers margin
Show or hide the small margin right of the line numbers, which is used
to mark lines.
Stop scrolling at last line
When enabled Geany stops scrolling when at the last line of the document.
Otherwise you can scroll one more page even if there are no real lines.
Long line marker
````````````````
The long line marker helps to indicate overly-long lines, or as a hint
to the user for when to break the line.
Type
Line
Show a thin vertical line in the editor window at the given column
position.
Background
Change the background color of characters after the given column
position to the color set below. (This is recommended over the
*Line* setting if you use proportional fonts).
Disabled
Don't mark long lines at all.
Long line marker
Set this value to a value greater than zero to specify the column
where it should appear.
Long line marker color
Set the color of the long line marker.
Virtual spaces
``````````````
Virtual space is space beyond the end of each line.
The cursor may be moved into virtual space but no real space will be
added to the document until there is some text typed or some other
text insertion command is used.
Disabled
Do not show virtual spaces
Only for rectangular selections
Only show virtual spaces beyond the end of lines when drawing a rectangular selection
Always
Always show virtual spaces beyond the end of lines
Files preferences
^^^^^^^^^^^^^^^^^
.. image:: ./images/pref_dialog_files.png
New files
`````````
Open new documents from the command-line
Whether to create new documents when passing filenames that don't
exist from the command-line.
Default encoding (new files)
The type of file encoding you wish to use when creating files.
Used fixed encoding when opening files
Assume all files you are opening are using the type of encoding specified below.
Default encoding (existing files)
Opens all files with the specified encoding instead of auto-detecting it.
Use this option when it's not possible for Geany to detect the exact encoding.
Default end of line characters
The end of line characters to which should be used for new files.
On Windows systems, you generally want to use CR/LF which are the common
characters to mark line breaks.
On Unix-like systems, LF is default and CR is used on MAC systems.
Saving files
````````````
Perform formatting operations when a document is saved. These
can each be undone with the Undo command.
Ensure newline at file end
Add a newline at the end of the document if one is missing.
Ensure consistent line endings
Ensures that newline characters always get converted before
saving, avoiding mixed line endings in the same file.
.. _Strip trailing spaces:
Strip trailing spaces
Remove any whitespace at the end of each document line.
.. note::
This does not apply to Diff documents, e.g. patch files.
Replace tabs by space
Replace all tabs in the document with the equivalent number of spaces.
.. note::
It is better to use spaces to indent than use this preference - see
`Indentation`_.
Miscellaneous
`````````````
Recent files list length
The number of files to remember in the recently used files list.
Disk check timeout
The number of seconds to periodically check the current document's
file on disk in case it has changed. Setting it to 0 will disable
this feature.
.. note::
These checks are only performed on local files. Remote files are
not checked for changes due to performance issues
(remote files are files in ``~/.gvfs/``).
Tools preferences
^^^^^^^^^^^^^^^^^
.. image:: ./images/pref_dialog_tools.png
Tool paths
``````````
Terminal
The location of your terminal executable.
Browser
The location of your web browser executable.
Grep
The location of the grep executable.
.. note::
For Windows users: at the time of writing it is recommended to use
the grep.exe from the UnxUtils project
(http://sourceforge.net/projects/unxutils). The grep.exe from the
Mingw project for instance might not work with Geany at the moment.
Commands
````````
Context action
Set this to a command to execute on the current word.
You can use the "%s" wildcard to pass the current word below the cursor
to the specified command.
Template preferences
^^^^^^^^^^^^^^^^^^^^
This data is used as meta data for various template text to insert into
a document, such as the file header. You only need to set fields that
you want to use in your template files.
.. image:: ./images/pref_dialog_templ.png
Template data
`````````````
Developer
The name of the developer who will be creating files.
Initials
The initials of the developer.
Mail address
The email address of the developer.
.. note::
You may wish to add anti-spam markup, e.g. ``name<at>site<dot>ext``.
Company
The company the developer is working for.
Initial version
The initial version of files you will be creating.
Year
Specify a format for the the {year} wildcard. You can use any conversion specifiers
which can be used with the ANSI C strftime function. For details please see
http://man.cx/strftime.
Date
Specify a format for the the {date} wildcard. You can use any conversion specifiers
which can be used with the ANSI C strftime function. For details please see
http://man.cx/strftime.
Date & Time
Specify a format for the the {datetime} wildcard. You can use any conversion specifiers
which can be used with the ANSI C strftime function. For details please see
http://man.cx/strftime.
Keybinding preferences
^^^^^^^^^^^^^^^^^^^^^^
.. image:: ./images/pref_dialog_keys.png
There are some commands listed in the keybinding dialog that are not, by default,
bound to a key combination, and may not be available as a menu item.
.. note::
For more information see the section `Keybindings`_.
Printing preferences
^^^^^^^^^^^^^^^^^^^^
.. image:: ./images/pref_dialog_printing.png
Use external command for printing
Use a system command to print your file out.
Use native GTK printing
Let the GTK GUI toolkit handle your print request.
Print line numbers
Print the line numbers on the left of your paper.
Print page number
Print the page number on the bottom right of your paper.
Print page header
Print a header on every page that is sent to the printer.
Use base name of the printed file
Don't use the entire path for the header, only the filename.
Date format
How the date should be printed. You can use the same format
specifiers as in the ANSI C function strftime(). For details please
see http://man.cx/strftime.
Various preferences
^^^^^^^^^^^^^^^^^^^
.. image:: ./images/pref_dialog_various.png
Rarely used preferences, explained in the table below. A few of them require
restart to take effect, and a few other will only affect newly opened or created
documents before restart.
================================ ========================================= ========== ===========
Key Description Default Applies
================================ ========================================= ========== ===========
**Editor related**
use_gtk_word_boundaries Whether to look for the end of a word true to new
when using word-boundary related documents
Scintilla commands (see `Scintilla
keyboard commands`_).
brace_match_ltgt Whether to highlight <, > angle brackets. false immediately
complete_snippets_whilst_editing Whether to allow completion of snippets false immediately
when editing an existing line (i.e. there
is some text after the current cursor
position on the line). Only used when the
keybinding `Complete snippet` is set to
``Space``.
show_editor_scrollbars Whether to display scrollbars. If set to true immediately
false, the horizontal and vertical
scrollbars are hidden completely.
indent_hard_tab_width The size of a tab character. Don't change 8 immediately
it unless you really need to; use the
indentation settings instead.
**Interface related**
show_symbol_list_expanders Whether to show or hide the small true to new
expander icons on the symbol list documents
treeview.
allow_always_save Whether files can be saved always, even false immediately
if they don't have any changes.
By default, the Save button and menu
item are disabled when a file is
unchanged. When setting this option to
true, the Save button and menu item are
always active and files can be saved.
compiler_tab_autoscroll Whether to automatically scroll to the true immediately
last line of the output in the Compiler
tab.
statusbar_template The status bar statistics line format. See below. immediately
(Search in src/ui_utils.c for details).
new_document_after_close Whether to open a new document after all false immediately
documents have been closed.
msgwin_status_visible Whether to show the Status tab in the true immediately
Messages Window
msgwin_compiler_visible Whether to show the Compiler tab in the true immediately
Messages Window
msgwin_messages_visible Whether to show the Messages tab in the true immediately
Messages Window
msgwin_scribble_visible Whether to show the Scribble tab in the true immediately
Messages Window
use_geany_icon Whether to use the Geany icon on the false on restart
window instead of the theme's icon
================================ ========================================= ========== ===========
By default, statusbar_template is empty. This tells Geany to use its
internal default, which is currently:
``line: %l / %L\t col: %c\t sel: %s\t %w %t %mmode: %M encoding: %e filetype: %f scope: %S``
Note that ``\t`` = tab.
================================ =========================================== ========== ===========
Key Description Default Applies
================================ =========================================== ========== ===========
**VTE related**
emulation Terminal emulation mode. Only change this xterm immediately
if you have VTE termcap files other than
``vte/termcap/xterm``.
send_selection_unsafe By default, Geany strips any trailing false immediately
newline characters from the current
selection before sending it to the terminal
to not execute arbitrary code. This is
mainly a security feature.
If, for whatever reasons, you really want
it to be executed directly, set this option
to true.
send_cmd_prefix String with which prefix the commands sent Empty immediately
to the shell. This may be used to tell
some shells (BASH with ``HISTCONTROL`` set
to ``ignorespace``, ZSH with
``HIST_IGNORE_SPACE`` enabled, etc.) from
putting these commands in their history by
setting this to a space. Note that leading
spaces must be escaped using `\s` in the
configuration file.
**File related**
use_atomic_file_saving Defines the mode how Geany saves files to false immediately
disk. If disabled, Geany directly writes
the content of the document to disk. This
might cause loss of data when there is
no more free space on disk to save the
file. When set to true, Geany first saves
the contents into a temporary file and if
this succeeded, the temporary file is
moved to the real file to save.
This gives better error checking in case of
no more free disk space. But it also
destroys hard links of the original file
and its permissions (e.g. executable flags
are reset). Use this with care as it can
break things seriously.
The better approach would be to ensure your
disk won't run out of free space.
use_gio_unsafe_file_saving Whether to use GIO as the unsafe file true immediately
saving backend. It is better on most
situations but is known not to work
correctly on some complex setups.
gio_unsafe_save_backup Make a backup when using GIO unsafe file false immediately
saving. Backup is named `filename~`.
**Filetype related**
extract_filetype_regex Regex to extract filetype name from file See below. immediately
via capture group one.
**Search related**
find_selection_type See `Find selection`_. 0 immediately
**Build Menu related**
number_ft_menu_items The maximum number of menu items in the 2 on restart
filetype section of the Build menu.
number_non_ft_menu_items The maximum number of menu items in the 3 on restart
independent section of the Build menu.
number_exec_menu_items The maximum number of menu items in the 2 on restart
execute section of the Build menu.
================================ =========================================== ========== ===========
The extract_filetype_regex has the default value GEANY_DEFAULT_FILETYPE_REGEX.
Terminal (VTE) preferences
^^^^^^^^^^^^^^^^^^^^^^^^^^
See also: `Virtual terminal emulator widget (VTE)`_.
.. image:: ./images/pref_dialog_vte.png
Terminal widget
```````````````
Terminal font
Select the font that will be used in the terminal emulation control.
Foreground color
Select the font color.
Background color
Select the background color of the terminal.
Scrollback lines
The number of lines buffered so that you can scroll though the history.
Shell
The location of the shell on your system.
Scroll on keystroke
Scroll the terminal to the prompt line when pressing a key.
Scroll on output
Scroll the output down.
Cursor blinks
Let the terminal cursor blink.
Override Geany keybindings
Allow the VTE to receive keyboard shortcuts (apart from focus commands).
Disable menu shortcut key (F10 by default)
Disable the menu shortcut when you are in the virtual terminal.
Follow path of the current file
Make the path of the terminal change according to the path of the
current file.
Execute programs in VTE
Execute programs in the virtual terminal instead of using the external
terminal tool. Note that if you run multiple execute commands at once
the output may become mixed together in the VTE.
Don't use run script
Don't use the simple run script which is usually used to display
the exit status of the executed program.
This can be useful if you already have a program running in the VTE
like a Python console (e.g. ipython). Use this with care.
Project management
------------------
Project management is optional in Geany. Currently it can be used for:
* Storing and opening session files on a project basis.
* Overriding default settings with project equivalents.
* Configuring the Build menu on a project basis.
A list of session files can be stored and opened with the project
when the *Use project-based session files* preference is enabled,
in the *Project* group of the `Preferences`_ dialog.
As long as a project is open, the Build menu will use
the items defined in project's settings, instead of the defaults.
See `Build Menu Configuration`_ for information on configuring the menu.
The current project's settings are saved when it is closed, or when
Geany is shutdown. When restarting Geany, the previously opened project
file that was in use at the end of the last session will be reopened.
The project menu items are detailed below.
New project
^^^^^^^^^^^
To create a new project, fill in the *Name* field. By default this
will setup a new project file ``~/projects/name.geany``. Usually it's
best to store all your project files in the same directory (they are
independent of any source directory trees).
The Base path text field is setup to use ``~/projects/name``. This
can safely be set to any existing path -- it will not touch the file
structure contained in it.
Project properties
^^^^^^^^^^^^^^^^^^
You can set an optional description for the project. Currently it's
only used for a template wildcard - see `Template wildcards`_.
The *Base path* field is used as the directory to run the Build menu commands.
The specified path can be an absolute path or it is considered to be
relative to the project's file name.
The *File patterns* field allows to specify a list of file patterns for the
project, which can be used in the `Find in files`_ dialog.
The *Indentation* tab allows you to override the default
`Indentation`_ settings.
Open project
^^^^^^^^^^^^
The Open command displays a standard file chooser, starting in
``~/projects``. Choose a project file named with the ``.geany``
extension.
When project session support is enabled, Geany will close the currently
open files and open the session files associated with the project.
Close project
^^^^^^^^^^^^^
Project file settings are saved when the project is closed.
When project session support is enabled, Geany will close the project
session files and open any previously closed default session files.
Build menu
----------
After editing code with Geany, the next step is to compile, link, build,
interpret, run etc. As Geany supports many languages each with a different
approach to such operations, and as there are also many language independent
software building systems, Geany does not have a built-in build system, nor
does it limit which system you can use. Instead the build menu provides
a configurable and flexible means of running any external commands to
execute your preferred build system.
This section provides a description of the default configuration of the
build menu and then covers how to configure it, and where the defaults fit in.
Running the commands from within Geany has two benefits:
* The current file is automatically saved before the command is run.
* The output is captured in the Compiler notebook tab and parsed for
warnings or errors.
Warnings and errors that can be parsed for line numbers will be shown in
red in the Compiler tab and you can click on them to switch to the relevant
source file (or open it) and mark the line number. Also lines with
warnings or errors are marked in the source, see `Indicators`_ below.
.. tip::
If Geany's default error message parsing does not parse errors for
the tool you're using, you can set a custom regex in the Build Commands
Dialog, see `Build Menu Configuration`_.
Indicators
^^^^^^^^^^
Indicators are red squiggly underlines which are used to highlight
errors which occurred while compiling the current file. So you can
easily see where your code failed to compile. You can remove them by
selecting *Remove Error Indicators* in the Document menu.
If you do not like this feature, you can disable it - see `Editor Features
preferences`_.
Default build menu items
^^^^^^^^^^^^^^^^^^^^^^^^
Depending on the current file's filetype, the default Build menu will contain
the following items:
* Compile
* Build
* Make All
* Make Custom Target
* Make Object
* Next Error
* Previous Error
* Execute
* Set Build Menu Commands
Compile
```````
The Compile command has different uses for different kinds of files.
For compilable languages such as C and C++, the Compile command is
set up to compile the current source file into a binary object file.
Java source files will be compiled to class file bytecode.
Interpreted languages such as Perl, Python, Ruby will compile to
bytecode if the language supports it, or will run a syntax check,
or if that is not available will run the file in its language interpreter.
Build
`````
For compilable languages such as C and C++, the Build command will link
the current source file's equivalent object file into an executable. If
the object file does not exist, the source will be compiled and linked
in one step, producing just the executable binary.
Interpreted languages do not use the Build command.
.. note::
If you need complex settings for your build system, or several
different settings, then writing a Makefile and using the Make
commands is recommended; this will also make it easier for users to
build your software.
Make
````
This runs "make" in the same directory as the
current file.
Make custom target
``````````````````
This is similar to running 'Make' but you will be prompted for
the make target name to be passed to the Make tool. For example,
typing 'clean' in the dialog prompt will run "make clean".
Make object
```````````
Make object will run "make current_file.o" in the same directory as
the current file, using the filename for 'current_file'. It is useful
for building just the current file without building the whole project.
Next error
``````````
The next error item will move to the next detected error in the file.
Previous error
``````````````
The previous error item will move to the previous detected error in the file.
Execute
```````
Execute will run the corresponding executable file, shell script or
interpreted script in a terminal window. Note that the Terminal tool
path must be correctly set in the Tools tab of the Preferences dialog -
you can use any terminal program that runs a Bourne compatible shell
and accept the "-e" command line argument to start a command or can be
selected to use the built-in VTE if it is available - see
`Virtual terminal emulator widget (VTE)`_.
After your program or script has finished executing, you will be
prompted to press the return key. This allows you to review any text
output from the program before the terminal window is closed.
.. note::
The execute command output is not parsed for errors.
Stopping running processes
``````````````````````````
When there is a running program, the Execute menu item in the menu and
the Run button in the toolbar
each become a stop button so you can stop the current running program (and
any child processes). This works by sending the SIGQUIT signal to the process.
Depending on the process you started it is possible that the process
cannot be stopped. For example this can happen when the process creates
more than one child process.
Terminal emulators
******************
Xterm is known to work properly. If you are using "Terminal"
(the terminal program of Xfce), you should add the command line
option ``--disable-server`` otherwise the started process cannot be
stopped. Just add this option in the preferences dialog on the Tools
tab in the terminal field.
Set build commands
``````````````````
By default Compile, Build and Execute are fairly basic commands. You
may wish to customise them using *Set Build Commands*.
E.g. for C you can add any include paths and compile flags for the
compiler, any library names and paths for the linker, and any
arguments you want to use when running Execute.
Build menu configuration
^^^^^^^^^^^^^^^^^^^^^^^^
The build menu has considerable flexibility and configurability, allowing
both menu labels the commands they execute and the directory they execute
in to be configured.
For example, if you change one of the default make commands to run say 'waf'
you can also change the label to match.
These settings are saved automatically when Geany is shut down.
The build menu is divided into four groups of items each with different
behaviors:
* Filetype build commands - are configurable and depend on the filetype of the
current document; they capture output in the compiler tab and parse it for
errors.
* Independent build commands - are configurable and mostly don't depend on the
filetype of the current document; they also capture output in the
compiler tab and parse it for errors.
* Execute commands - are configurable and intended for executing your
program or other long running programs. The output is not parsed for errors
and is directed to the terminal selected in preferences.
* Fixed commands - these perform built-in actions:
* Go to the next error.
* Go to the previous error.
* Show the build menu commands dialog.
The maximum numbers of items in each of the configurable groups can be
configured in the `Various preferences`_. Even though the maximum number of
items may have been increased, only those menu items that have values
configured are shown in the menu.
The groups of menu items obtain their configuration from four potential
sources. The highest priority source that has the menu item defined will
be used. The sources in decreasing priority are:
* A project file if open
* The user preferences
* The system filetype definitions
* The defaults
The detailed relationships between sources and the configurable menu item groups
is shown in the following table.
+--------------+---------------------+--------------------------+-------------------+-------------------------------+
| Group | Project File | Preferences | System Filetype | Defaults |
+==============+=====================+==========================+===================+===============================+
| Filetype | Loads From: project | Loads From: | Loads From: | None |
| | file | filetypes.xxx file in | filetypes.xxx in | |
| | | ~/.config/geany/filedefs | Geany install | |
| | Saves To: project | | | |
| | file | Saves to: as above, | Saves to: as user | |
| | | creating if needed. | preferences left. | |
+--------------+---------------------+--------------------------+-------------------+-------------------------------+
| Filetype | Loads From: project | Loads From: | Loads From: | 1: |
| Independent | file | geany.conf file in | filetypes.xxx in | Label: _Make |
| | | ~/.config/geany | Geany install | Command: make |
| | Saves To: project | | | |
| | file | Saves to: as above, | Saves to: as user | 2: |
| | | creating if needed. | preferences left. | Label: Make Custom _Target |
| | | | | Command: make |
| | | | | |
| | | | | 3: |
| | | | | Label: Make _Object |
| | | | | Command: make %e.o |
+--------------+---------------------+--------------------------+-------------------+-------------------------------+
| Execute | Loads From: project | Loads From: | Loads From: | Label: _Execute |
| | file or else | geany.conf file in | filetypes.xxx in | Command: ./%e |
| | filetype defined in | ~/.config/geany or else | Geany install | |
| | project file | filetypes.xxx file in | | |
| | | ~/.config/geany/filedefs | Saves To: as user | |
| | Saves To: | | preferences left. | |
| | project file | Saves To: | | |
| | | filetypes.xxx file in | | |
| | | ~/.config/geany/filedefs | | |
+--------------+---------------------+--------------------------+-------------------+-------------------------------+
The following notes on the table reference cells by coordinate as (group,source):
* General - for filetypes.xxx substitute the appropriate extension for
the filetype of the current document for xxx - see `filenames`_.
* System Filetypes - Labels loaded from these sources are locale sensitive
and can contain translations.
* (Filetype, Project File) and (Filetype, Preferences) - preferences use a full
filetype file so that users can configure all other filetype preferences
as well. Projects can only configure menu items per filetype. Saving
in the project file means that there is only one file per project not
a whole directory.
* (Filetype-Independent, System Filetype) - although conceptually strange, defining
filetype-independent commands in a filetype file, this provides the ability to
define filetype dependent default menu items.
* (Execute, Project File) and (Execute, Preferences) - the project independent
execute and preferences independent execute commands can only be set by hand
editing the appropriate file, see `Preferences file format`_ and `Project file
format`_.
Build menu commands dialog
^^^^^^^^^^^^^^^^^^^^^^^^^^
Most of the configuration of the build menu is done through the Build Menu
Commands Dialog. You edit the configuration sourced from preferences in the
dialog opened from the Build->Build Menu Commands item and you edit the
configuration from the project in the build tab of the project preferences
dialog. Both use the same form shown below.
.. image:: ./images/build_menu_commands_dialog.png
The dialog is divided into three sections:
* Filetype build commands (selected based on the current document's filetype).
* Independent build commands (available regardless of filetype).
* Filetype execute commands.
The filetype and independent sections also each contain a field for the regular
expression used for parsing command output for error and warning messages.
The columns in the first three sections allow setting of the label, command,
and working directory to run the command in.
An item with an empty label will not be shown in the menu.
An empty working directory will default to the directory of the current document.
If there is no current document then the command will not run.
The dialog will always show the command selected by priority, not just the
commands configured in this configuration source. This ensures that you always
see what the menu item is going to do if activated.
If the current source of the menu item is higher priority than the
configuration source you are editing then the command will be shown
in the dialog but will be insensitive (greyed out). This can't happen
with the project source but can with the preferences source dialog.
The clear buttons remove the definition from the configuration source you are editing.
When you do this the command from the next lower priority source will be shown.
To hide lower priority menu items without having anything show in the menu
configure with a nothing in the label but at least one character in the command.
Substitutions in commands and working directories
`````````````````````````````````````````````````
The first occurence of each of the following character sequences in each of the
command and working directory fields is substituted by the items specified below
before the command is run.
* %d - substituted by the absolute path to the directory of the current file.
* %e - substituted by the name of the current file without the extension or path.
* %f - substituted by the name of the current file without the path.
* %p - if a project is open, substituted by the base path from the project.
.. note::
If the basepath set in the project preferences is not an absolute path , then it is
taken as relative to the directory of the project file. This allows a project file
stored in the source tree to specify all commands and working directories relative
to the tree itself, so that the whole tree including the project file, can be moved
and even checked into and out of version control without having to re-configure the
build menu.
Build menu keyboard shortcuts
`````````````````````````````
Keyboard shortcuts can be defined for the first two filetype menu items, the first three
independent menu items, the first two execute menu items and the fixed menu items.
In the keybindings configuration dialog (see `Keybinding preferences`_)
these items are identified by the default labels shown in the `Build Menu`_ section above.
It is currently not possible to bind keyboard shortcuts to more than these menu items.
You can also use underlines in the labels to set mnemonic characters.
Old settings
````````````
The configurable Build Menu capability was introduced in Geany 0.19 and
required a new section to be added to the configuration files (See
`Preferences file format`_). Geany will still load older format project,
preferences and filetype file settings and will attempt to map them into the new
configuration format. There is not a simple clean mapping between the formats.
The mapping used produces the most sensible results for the majority of cases.
However, if they do not map the way you want, you may have to manually
configure some settings using the Build Commands
Dialog or the Build tab of the project preferences dialog.
Any setting configured in either of these dialogs will override settings mapped from
older format configuration files.
Printing support
----------------
Since Geany 0.13 there has been printing support using GTK's printing API.
The printed page(s) will look nearly the same as on your screen in Geany.
Additionally, there are some options to modify the printed page(s).
.. note::
The background text color is set to white, except for text with
a white foreground. This allows dark color schemes to save ink
when printing.
You can define whether to print line numbers, page numbers at the bottom of
each page and whether to print a page header on each page. This header
contains the filename of the printed document, the current page number and
the date and time of printing. By default, the file name of the document
with full path information is added to the header. If you prefer to add
only the basename of the file(without any path information) you can set it
in the preferences dialog. You can also adjust the format of the date and
time added to the page header. The available conversion specifiers are the
same as the ones which can be used with the ANSI C strftime function.
All of these settings can also be changed in the print dialog just before
actual printing is done.
On Unix-like systems the provided print dialog offers a print preview. The
preview file is opened with a PDF viewer and by default GTK uses ``evince``
for print preview. If you have not installed evince or just want to use
another PDF viewer, you can change the program to use in the file
``.gtkrc-2.0`` (usually found in your home directory). Simply add a line
like::
gtk-print-preview-command = "epdfview %f"
at the end of the file. Of course, you can also use xpdf, kpdf or whatever
as the print preview command.
Geany also provides an alternative basic printing support using a custom
print command. However, the printed document contains no syntax highlighting.
You can adjust the command to which the filename is passed in the preferences
dialog. The default command is::
% lpr %f
``%f`` will be substituted by the filename of the current file. Geany
will not show errors from the command itself, so you should make
sure that it works before(e.g. by trying to execute it from the
command line).
A nicer example, which many prefer is::
% a2ps -1 --medium=A4 -o - %f | xfprint4
But this depends on a2ps and xfprint4. As a replacement for xfprint4,
gtklp or similar programs can be used.
Plugins
-------
Plugins are loaded at startup, if the *Enable plugin support*
general preference is set. There is also a command-line option,
``-p``, which prevents plugins being loaded. Plugins are scanned in
the following directories:
* ``$prefix/lib/geany`` on Unix-like systems (see `Installation prefix`_)
* The ``lib`` subfolder of the installation path on Windows.
* The ``plugins`` subfolder of the user configuration directory - see
`Configuration file paths`_.
* The `Extra plugin path` preference (usually blank) - see `Paths`_.
Most plugins add menu items to the *Tools* menu when they are loaded.
See also `Plugin documentation`_ for information about single plugins
which are included in Geany.
Plugin manager
^^^^^^^^^^^^^^
The Plugin Manager dialog lets you choose which plugins
should be loaded at startup. You can also load and unload plugins on the
fly using this dialog. Once you click the checkbox for a specific plugin
in the dialog, it is loaded or unloaded according to its previous state.
By default, no plugins are loaded at startup until you select some.
You can also configure some plugin specific options if the plugin
provides any.
Keybindings
-----------
Geany supports the default keyboard shortcuts for the Scintilla
editing widget. For a list of these commands, see `Scintilla
keyboard commands`_. The Scintilla keyboard shortcuts will be overridden
by any custom keybindings with the same keyboard shortcut.
Switching documents
^^^^^^^^^^^^^^^^^^^
There are some non-configurable bindings to switch between documents,
listed below. These can also be overridden by custom keybindings.
=============== ==================================
Key Action
=============== ==================================
Alt-[1-9] Select left-most tab, from 1 to 9.
Alt-0 Select right-most tab.
=============== ==================================
See also `Notebook tab keybindings`_.
Configurable keybindings
^^^^^^^^^^^^^^^^^^^^^^^^
For all actions listed below you can define your own keybindings. Open
the Preferences dialog, select the desired action and click on
change. In the resulting dialog you can press the key combination you
want to assign to the action and it will be saved when you press OK.
You can define only one key combination for each action and each key
combination can only be defined for one action.
Some of the default key combinations are common across many
applications, for example *Ctrl-N* for New and *Ctrl-O* for Open.
Because they are so common it is not advisable to change these, but
you can add other key combinations for these actions. For example
*Ctrl-O* is set to execute menu_open by default, but you can also
define *Alt-O*, so that the file open dialog is shown by pressing
either *Ctrl-O* or *Alt-O*.
The following tables list all customizable keyboard shortcuts, those
which are common to many applications are marked with (C) after the
shortcut.
File keybindings
````````````````
=============================== ========================= ==================================================
Action Default shortcut Description
=============================== ========================= ==================================================
New Ctrl-N (C) Creates a new file.
Open Ctrl-O (C) Opens a file.
Open selected file Ctrl-Shift-O Opens the selected filename.
Re-open last closed tab Re-opens the last closed document tab.
Save Ctrl-S (C) Saves the current file.
Save As Saves the current file under a new name.
Save all Ctrl-Shift-S Saves all open files.
Close all Ctrl-Shift-W Closes all open files.
Close Ctrl-W (C) Closes the current file.
Reload file Ctrl-R (C) Reloads the current file. All unsaved changes
will be lost.
Print Ctrl-P (C) Prints the current file.
=============================== ========================= ==================================================
Editor keybindings
``````````````````
=============================== ========================= ==================================================
Action Default shortcut Description
=============================== ========================= ==================================================
Undo Ctrl-Z (C) Un-does the last action.
Redo Ctrl-Y Re-does the last action.
Delete current line(s) Ctrl-K Deletes the current line (and any lines with a
selection).
Delete to line end Ctrl-Shift-Delete Deletes from the current caret position to the
end of the current line.
Duplicate line or selection Ctrl-D Duplicates the current line or selection.
Transpose current line Transposes the current line with the previous one.
Scroll to current line Ctrl-Shift-L Scrolls the current line into the centre of the
view. The cursor position and or an existing
selection will not be changed.
Scroll up by one line Alt-Up Scrolls the view.
Scroll down by one line Alt-Down Scrolls the view.
Complete word Ctrl-Space Shows the autocompletion list. If already showing
tag completion, it shows document word completion
instead, even if it is not enabled for automatic
completion. Likewise if no tag suggestions are
available, it shows document word completion.
Show calltip Ctrl-Shift-Space Shows a calltip for the current function or
method.
Show macro list Ctrl-Return Shows a list of available macros and variables in
the workspace.
Complete snippet Tab If you type a construct like if or for and press
this key, it will be completed with a matching
template.
Suppress snippet completion If you type a construct like if or for and press
this key, it will not be completed, and a space or
tab will be inserted, depending on what the
construct completion keybinding is set to. For
example, if you have set the construct completion
keybinding to space, then setting this to
Shift+space will prevent construct completion and
insert a space.
Context Action Executes a command and passes the current word
(near the cursor position) or selection as an
argument. See the section called `Context
actions`_.
Move cursor in snippet Jumps to the next defined cursor positions in a
completed snippets if multiple cursor positions
where defined.
Word part completion Tab When the autocompletion list is visible, complete
the currently selected item up to the next word
part.
Move line(s) up Alt-PageUp Move the current line or selected lines up by
one line.
Move line(s) down Alt-PageDown Move the current line or selected lines down by
one line.
=============================== ========================= ==================================================
Clipboard keybindings
`````````````````````
=============================== ========================= ==================================================
Action Default shortcut Description
=============================== ========================= ==================================================
Cut Ctrl-X (C) Cut the current selection to the clipboard.
Copy Ctrl-C (C) Copy the current selection to the clipboard.
Paste Ctrl-V (C) Paste the clipboard text into the current document.
Cut current line(s) Ctrl-Shift-X Cuts the current line (and any lines with a
selection) to the clipboard.
Copy current line(s) Ctrl-Shift-C Copies the current line (and any lines with a
selection) to the clipboard.
=============================== ========================= ==================================================
Select keybindings
``````````````````
=============================== ========================= ==================================================
Action Default shortcut Description
=============================== ========================= ==================================================
Select all Ctrl-A (C) Makes a selection of all text in the current
document.
Select current word Alt-Shift-W Selects the current word under the cursor.
Select current paragraph Alt-Shift-P Selects the current paragraph under the cursor
which is defined by two empty lines around it.
Select current line(s) Alt-Shift-L Selects the current line under the cursor (and any
partially selected lines).
Select to previous word part (Extend) selection to previous word part boundary.
Select to next word part (Extend) selection to next word part boundary.
=============================== ========================= ==================================================
Insert keybindings
``````````````````
=============================== ========================= ==================================================
Action Default shortcut Description
=============================== ========================= ==================================================
Insert date Shift-Alt-D Inserts a customisable date.
Insert alternative whitespace Inserts a tab character when spaces should
be used for indentation and inserts space
characters of the amount of a tab width when
tabs should be used for indentation.
Insert New Line Before Current Inserts a new line with indentation.
Insert New Line After Current Inserts a new line with indentation.
=============================== ========================= ==================================================
Format keybindings
``````````````````
=============================== ========================= ==================================================
Action Default shortcut Description
=============================== ========================= ==================================================
Toggle case of selection Ctrl-Alt-U Changes the case of the selection. A lowercase
selection will be changed into uppercase and vice
versa. If the selection contains lower- and
uppercase characters, all will be converted to
lowercase.
Comment line Comments current line or selection.
Uncomment line Uncomments current line or selection.
Toggle line commentation Ctrl-E Comments a line if it is not commented or removes
a comment if the line is commented.
Increase indent Ctrl-I Indents the current line or selection by one tab
or by spaces in the amount of the tab width
setting.
Decrease indent Ctrl-U Removes one tab or the amount of spaces of
the tab width setting from the indentation of the
current line or selection.
Increase indent by one space Indents the current line or selection by one
space.
Decrease indent by one space Deindents the current line or selection by one
space.
Smart line indent Indents the current line or all selected lines
with the same indentation as the previous line.
Send to Custom Command 1 (2,3) Ctrl-1 (2,3) Passes the current selection to a configured
external command (available for the first
three configured commands, see
`Sending text through custom commands`_ for
details).
Send Selection to Terminal Sends the current selection or the current
line (if there is no selection) to the
embedded Terminal (VTE).
Reflow lines/block Reformat selected lines or current
(indented) text block,
breaking lines at the long line marker or the
line breaking column if line breaking is
enabled for the current document.
=============================== ========================= ==================================================
Settings keybindings
````````````````````
=============================== ========================= ==================================================
Action Default shortcut Description
=============================== ========================= ==================================================
Preferences Ctrl-Alt-P Opens preferences dialog.
Plugin Preferences Opens plugin preferences dialog.
=============================== ========================= ==================================================
Search keybindings
``````````````````
=============================== ========================= ==================================================
Action Default shortcut Description
=============================== ========================= ==================================================
Find Ctrl-F (C) Opens the Find dialog.
Find Next Ctrl-G Finds next result.
Find Previous Ctrl-Shift-G Finds previous result.
Find Next Selection Finds next occurence of selected text.
Find Previous Selection Finds previous occurence of selected text.
Replace Ctrl-H (C) Opens the Replace dialog.
Find in files Ctrl-Shift-F Opens the Find in files dialog.
Next message Jumps to the line with the next message in
the Messages window.
Previous message Jumps to the line with the previous message
in the Messages window.
Find Usage Ctrl-Shift-E Finds all occurrences of the current word (near
the keyboard cursor) or selection in all open
documents and displays them in the messages
window.
Find Document Usage Ctrl-Shift-D Finds all occurrences of the current word (near
the keyboard cursor) or selection in the current
document and displays them in the messages
window.
Mark All Ctrl-Shift-M Highlight all matches of the current
word/selection in the current document
with a colored box. If there's nothing to
find, or the cursor is next to an existing match,
the highlighted matches will be cleared.
=============================== ========================= ==================================================
Go to keybindings
`````````````````
=============================== ========================= ==================================================
Action Default shortcut Description
=============================== ========================= ==================================================
Navigate forward a location Alt-Right (C) Switches to the next location in the navigation
history. See the section called `Code Navigation
History`_.
Navigate back a location Alt-Left (C) Switches to the previous location in the
navigation history. See the section called
`Code navigation history`_.
Go to line Ctrl-L Focuses the Go to Line entry (if visible) or
shows the Go to line dialog.
Goto matching brace Ctrl-B If the cursor is ahead or behind a brace, then it
is moved to the brace which belongs to the current
one. If this keyboard shortcut is pressed again,
the cursor is moved back to the first brace.
Toggle marker Ctrl-M Set a marker on the current line, or clear the
marker if there already is one.
Goto next marker Ctrl-. Goto the next marker in the current document.
Goto previous marker Ctrl-, Goto the previous marker in the current document.
Go to tag definition Ctrl-T Jump to the definition of the current word or
selection. See `Go to tag definition`_.
Go to tag declaration Ctrl-Shift-T Jump to the declaration of the current word or
selection. See `Go to tag declaration`_.
Go to Start of Line Home Move the caret to the start of the line.
Behaves differently if smart_home_key_ is set.
Go to End of Line End Move the caret to the end of the line.
Go to Start of Display Line Alt-Home Move the caret to the start of the display line.
This is useful when you use line wrapping and
want to jump to the start of the wrapped, virtual
line, not the real start of the whole line.
If the line is not wrapped, it behaves like
`Go to Start of Line`.
Go to End of Display Line Alt-End Move the caret to the end of the display line.
If the line is not wrapped, it behaves like
`Go to End of Line`.
Go to Previous Word Part Ctrl-/ Goto the previous part of the current word.
Go to Next Word Part Ctrl-\\ Goto the next part of the current word.
=============================== ========================= ==================================================
View keybindings
````````````````
=============================== ========================= ==================================================
Action Default shortcut Description
=============================== ========================= ==================================================
Fullscreen F11 (C) Switches to fullscreen mode.
Toggle Messages Window Toggles the message window (status and compiler
messages) on and off.
Toggle Sidebar Shows or hides the sidebar.
Toggle all additional widgets Hide and show all additional widgets like the
notebook tabs, the toolbar, the messages window
and the status bar.
Zoom In Ctrl-+ (C) Zooms in the text.
Zoom Out Ctrl-- (C) Zooms out the text.
Zoom Reset Ctrl-0 Reset any previous zoom on the text.
=============================== ========================= ==================================================
Focus keybindings
`````````````````
================================ ========================= ==================================================
Action Default shortcut Description
================================ ========================= ==================================================
Switch to Editor F2 Switches to editor widget.
Also reshows the document statistics line
(after a short timeout).
Switch to Search Bar F7 Switches to the search bar in the toolbar (if
visible).
Switch to Message Window Focus the Message Window's current tab.
Switch to Compiler Focus the Compiler message window tab.
Switch to Messages Focus the Messages message window tab.
Switch to Scribble F6 Switches to scribble widget.
Switch to VTE F4 Switches to VTE widget.
Switch to Sidebar Focus the Sidebar.
Switch to Sidebar Symbol List Focus the Symbol list tab in the Sidebar
(if visible).
Switch to Sidebar Document List Focus the Document list tab in the Sidebar
(if visible).
================================ ========================= ==================================================
Notebook tab keybindings
````````````````````````
=============================== ========================= ==================================================
Action Default shortcut Description
=============================== ========================= ==================================================
Switch to left document Ctrl-PageUp (C) Switches to the previous open document.
Switch to right document Ctrl-PageDown (C) Switches to the next open document.
Switch to last used document Ctrl-Tab Switches to the previously shown document (if it's
still open).
Holding Ctrl (or another modifier if the keybinding
has been changed) will show a dialog, then repeated
presses of the keybinding will switch to the 2nd-last
used document, 3rd-last, etc. Also known as
Most-Recently-Used documents switching.
Move document left Ctrl-Shift-PageUp Changes the current document with the left hand
one.
Move document right Ctrl-Shift-PageDown Changes the current document with the right hand
one.
Move document first Moves the current document to the first position.
Move document last Moves the current document to the last position.
=============================== ========================= ==================================================
Document keybindings
````````````````````
==================================== ==================== ==================================================
Action Default shortcut Description
==================================== ==================== ==================================================
Clone See `Cloning documents`_.
Replace tabs by space Replaces all tabs with the right amount of spaces.
Replace spaces by tabs Replaces leading spaces with tab characters.
Toggle current fold Toggles the folding state of the current code block.
Fold all Folds all contractible code blocks.
Unfold all Unfolds all contracted code blocks.
Reload symbol list Ctrl-Shift-R Reloads the tag/symbol list.
Toggle Line wrapping Enables or disables wrapping of long lines.
Toggle Line breaking Enables or disables automatic breaking of long
lines at a configurable column.
Remove Markers Remove any markers on lines or words which
were set by using 'Mark All' in the
search dialog or by manually marking lines.
Remove Error Indicators Remove any error indicators in the
current document.
Remove Markers and Error Indicators Combines ``Remove Markers`` and
``Remove Error Indicators``.
==================================== ==================== ==================================================
Project keybindings
```````````````````
=============================== ========================= ==================================================
Action Default shortcut Description
=============================== ========================= ==================================================
New Create a new project.
Open Opens a project file.
Properties Shows project properties.
Close Close the current project.
=============================== ========================= ==================================================
Build keybindings
`````````````````
=============================== ========================= ==================================================
Action Default shortcut Description
=============================== ========================= ==================================================
Compile F8 Compiles the current file.
Build F9 Builds (compiles if necessary and links) the
current file.
Make all Shift-F9 Builds the current file with the Make tool.
Make custom target Ctrl-Shift-F9 Builds the current file with the Make tool and a
given target.
Make object Shift-F8 Compiles the current file with the Make tool.
Next error Jumps to the line with the next error from the
last build process.
Previous error Jumps to the line with the previous error from
the last build process.
Run F5 Executes the current file in a terminal emulation.
Set Build Commands Opens the build commands dialog.
=============================== ========================= ==================================================
Tools keybindings
`````````````````
=============================== ========================= ==================================================
Action Default shortcut Description
=============================== ========================= ==================================================
Show Color Chooser Opens the Color Chooser dialog.
=============================== ========================= ==================================================
Help keybindings
````````````````
=============================== ========================= ==================================================
Action Default shortcut Description
=============================== ========================= ==================================================
Help F1 (C) Opens the manual.
=============================== ========================= ==================================================
Configuration files
===================
.. warning::
You must use UTF-8 encoding *without BOM* for configuration files.
Configuration file paths
------------------------
Geany has default configuration files installed for the system and
also per-user configuration files.
The system files should not normally be edited because they will be
overwritten when upgrading Geany.
The user configuration directory can be overridden with the ``-c``
switch, but this is not normally done. See `Command line options`_.
.. note::
Any missing subdirectories in the user configuration directory
will be created when Geany starts.
You can check the paths Geany is using with *Help->Debug Messages*.
Near the top there should be 2 lines with something like::
Geany-INFO: System data dir: /usr/share/geany
Geany-INFO: User config dir: /home/username/.config/geany
Paths on Unix-like systems
^^^^^^^^^^^^^^^^^^^^^^^^^^
The system path is ``$prefix/share/geany``, where ``$prefix`` is the
path where Geany is installed (see `Installation prefix`_).
The user configuration directory is normally:
``/home/username/.config/geany``
Paths on Windows
^^^^^^^^^^^^^^^^
The system path is the ``data`` subfolder of the installation path
on Windows.
The user configuration directory might vary, but on Windows XP it's:
``C:\Documents and Settings\UserName\Application Data\geany``
Tools menu items
----------------
There's a *Configuration files* submenu in the *Tools* menu that
contains items for some of the available user configuration files.
Clicking on one opens it in the editor for you to update. Geany will
reload the file after you have saved it.
.. note::
Other configuration files not shown here will need to be opened
manually, and will not be automatically reloaded when saved.
(see *Reload Configuration* below).
There's also a *Reload Configuration* item which can be used if you
updated one of the other configuration files, or modified or added
template files.
*Reload Configuration* is also necessary to update syntax highlighting colors.
.. note::
Syntax highlighting colors aren't updated in open documents after
saving filetypes.common as this may take a significant
amount of time.
Global configuration file
-------------------------
System administrators can add a global configuration file for Geany
which will be used when starting Geany and a user configuration file
does not exist.
The global configuration file is read from ``geany.conf`` in the
system configuration path - see `Configuration file paths`_. It can
contain any settings which are found in the usual configuration file
created by Geany, but does not have to contain all settings.
.. note::
This feature is mainly intended for package maintainers or system
admins who want to set up Geany in a multi user environment and
set some sane default values for this environment. Usually users won't
need to do that.
Filetype definition files
-------------------------
All color definitions and other filetype specific settings are
stored in the filetype definition files. Those settings are colors
for syntax highlighting, general settings like comment characters or
word delimiter characters as well as compiler and linker settings.
See also `Configuration file paths`_.
Filenames
^^^^^^^^^
Each filetype has a corresponding filetype definition file. The format
for built-in filetype `Foo` is::
filetypes.foo
The extension is normally just the filetype name in lower case.
However there are some exceptions:
=============== =========
Filetype Extension
=============== =========
C++ cpp
C# cs
Make makefile
Matlab/Octave matlab
=============== =========
There is also the `special file filetypes.common`_.
For `custom filetypes`_, the filename for `Foo` is different::
filetypes.Foo.conf
See the link for details.
System files
^^^^^^^^^^^^
The system-wide filetype configuration files can be found in the
system configuration path and are called ``filetypes.$ext``,
where $ext is the name of the filetype. For every
filetype there is a corresponding definition file. There is one
exception: ``filetypes.common`` -- this file is for general settings,
which are not specific to a certain filetype.
.. warning::
It is not recommended that users edit the system-wide files,
because they will be overridden when Geany is updated.
User files
^^^^^^^^^^
To change the settings, copy a file from the system configuration
path to the subdirectory ``filedefs`` in your user configuration
directory. Then you can edit the file and the changes will still be
available after an update of Geany.
Alternatively, you can create the file yourself and add only the
settings you want to change. All missing settings will be read from
the corresponding system configuration file.
Custom filetypes
^^^^^^^^^^^^^^^^
At startup Geany looks for ``filetypes.*.conf`` files in the system and
user filetype paths, adding any filetypes found with the name matching
the '``*``' wildcard - e.g. ``filetypes.Bar.conf``.
Custom filetypes are not as powerful as built-in filetypes, but
support for the following has been implemented:
* Recognizing and setting the filetype (after the user has manually edited
``filetype_extensions.conf``).
* Reading filetype settings in the ``[settings]`` section, including:
* Using an existing syntax highlighting lexer (`lexer_filetype`_ key).
* Using an existing tag parser (``tag_parser`` key).
* Build commands (``[build-menu]`` section).
* Loading global tags files (sharing the ``tag_parser`` namespace).
See `Filetype configuration`_ for details on each setting.
Creating a custom filetype from an existing filetype
````````````````````````````````````````````````````
Because most filetype settings will relate to the syntax
highlighting (e.g. styling, keywords, ``lexer_properties``
sections), it is best to copy an existing filetype file that uses
the lexer you wish to use as the basis of a custom filetype, using
the correct filename extension format shown above, e.g.::
cp filetypes.foo filetypes.Bar.conf
Then add the ``lexer_filetype=Foo`` setting (if not already present)
and add/adjust other settings.
.. warning::
The ``[styling]`` and ``[keywords]`` sections have key names
specific to each filetype/lexer. You must follow the same
names - in particular, some lexers only support one keyword
list, or none.
Filetype configuration
^^^^^^^^^^^^^^^^^^^^^^
As well as the sections listed below, each filetype file can contain
a [build-menu] section as described in `[build-menu] section`_.
[styling] section
`````````````````
In this section the colors for syntax highlighting are defined. The
manual format is:
* ``key=foreground_color;background_color;bold_flag;italic_flag``
Colors have to be specified as RGB hex values prefixed by
0x or # similar to HTML/CSS hex triplets. For example, all of the following
are valid values for pure red; 0xff0000, 0xf00, #ff0000, or #f00. The
values are case-insensitive but it is a good idea to use lower-case.
Note that you can also use *named colors* as well by substituting the
color value with the name of a color as defined in the ``[named_colors]``
section, see the `[named_colors] Section`_ for more information.
Bold and italic are flags and should only be "true" or "false". If their
value is something other than "true" or "false", "false" is assumed.
You can omit fields to use the values from the style named ``"default"``.
E.g. ``key=0xff0000;;true``
This makes the key style have red foreground text, default background
color text and bold emphasis.
Using a named style
*******************
The second format uses a *named style* name to reference a style
defined in filetypes.common.
* ``key=named_style``
* ``key2=named_style2,bold,italic``
The bold and italic parts are optional, and if present are used to
toggle the bold or italic flags to the opposite of the named style's
flags. In contrast to style definition booleans, they are a literal
",bold,italic" and commas are used instead of semi-colons.
E.g. ``key=comment,italic``
This makes the key style match the ``"comment"`` named style, but with
italic emphasis.
To define named styles, see the filetypes.common `[named_styles]
Section`_.
Reading styles from another filetype
************************************
You can automatically copy all of the styles from another filetype
definition file by using the following syntax for the ``[styling]``
group::
[styling=Foo]
Where Foo is a filetype name. The corresponding ``[styling]``
section from ``filetypes.foo`` will be read.
This is useful when the same lexer is being used for multiple
filetypes (e.g. C/C++/C#/Java/etc). For example, to make the C++
styling the same as the C styling, you would put the following in
``filetypes.cpp``::
[styling=C]
[keywords] section
``````````````````
This section contains keys for different keyword lists specific to
the filetype. Some filetypes do not support keywords, so adding a
new key will not work. You can only add or remove keywords to/from
an existing list.
.. important::
The keywords list must be in one line without line ending characters.
[lexer_properties] section
``````````````````````````
Here any special properties for the Scintilla lexer can be set in the
format ``key.name.field=some.value``.
Properties Geany uses are listed in the system filetype files. To find
other properties you need Geany's source code::
egrep -o 'GetProperty\w*\("([^"]+)"[^)]+\)' scintilla/Lex*.cxx
[settings] section
``````````````````
extension
This is the default file extension used when saving files, not
including the period character (``.``). The extension used should
match one of the patterns associated with that filetype (see
`Filetype extensions`_).
*Example:* ``extension=cxx``
wordchars
These characters define word boundaries when making selections
and searching using word matching options.
*Example:* (look at system filetypes.\* files)
.. note::
This overrides the *whitespace_chars* filetypes.common setting.
comment_single
A character or string which is used to comment code. If you want to use
multiline comments only, don't set this but rather comment_open and
comment_close.
Single-line comments are used in priority over multiline comments to
comment a line, e.g. with the `Comment/Uncomment line` command.
*Example:* ``comment_single=//``
comment_open
A character or string which is used to comment code. You need to also
set comment_close to really use multiline comments. If you want to use
single-line comments, prefer setting comment_single.
Multiline comments are used in priority over single-line comments to
comment a block, e.g. template comments.
*Example:* ``comment_open=/*``
comment_close
If multiline comments are used, this is the character or string to
close the comment.
*Example:* ``comment_close=*/``
comment_use_indent
Set this to false if a comment character or string should start at
column 0 of a line. If set to true it uses any indentation of the
line.
Note: Comment indentation
``comment_use_indent=true`` would generate this if a line is
commented (e.g. with Ctrl-D)::
#command_example();
``comment_use_indent=false`` would generate this if a line is
commented (e.g. with Ctrl-D)::
# command_example();
Note: This setting only works for single line comments (like '//',
'#' or ';').
*Example:* ``comment_use_indent=true``
context_action_cmd
A command which can be executed on the current word or the current
selection.
Example usage: Open the API documentation for the
current function call at the cursor position.
The command can
be set for every filetype or if not set, a global command will
be used. The command itself can be specified without the full
path, then it is searched in $PATH. But for security reasons,
it is recommended to specify the full path to the command. The
wildcard %s will be replaced by the current word at the cursor
position or by the current selection.
Hint: for PHP files the following could be quite useful:
context_action_cmd=firefox "http://www.php.net/%s"
*Example:* ``context_action_cmd=devhelp -s "%s"``
tag_parser
The TagManager language name, e.g. "C". Usually the same as the
filetype name.
.. _lexer_filetype:
lexer_filetype
A filetype name to setup syntax highlighting from another filetype.
This must not be recursive, i.e. it should be a filetype name that
doesn't use the *lexer_filetype* key itself, e.g.::
lexer_filetype=C
#lexer_filetype=C++
The second line is wrong, because ``filetypes.cpp`` itself uses
``lexer_filetype=C``, which would be recursive.
symbol_list_sort_mode
What the default symbol list sort order should be.
===== =====================================
Value Meaning
===== =====================================
0 Sort tags by name
1 Sort tags by appearance (line number)
===== =====================================
.. _xml_indent_tags:
xml_indent_tags
If this setting is set to *true*, a new line after a line ending with an
unclosed XML/HTML tag will be automatically indented. This only applies
to filetypes for which the HTML or XML lexer is used. Such filetypes have
this setting in their system configuration files.
[indentation] section
`````````````````````
This section allows definition of default indentation settings specific to
the file type, overriding the ones configured in the preferences. This can
be useful for file types requiring specific indentation settings (e.g. tabs
only for Makefile). These settings don't override auto-detection if activated.
width
The forced indentation width.
type
The forced indentation type.
===== =======================
Value Indentation type
===== =======================
0 Spaces only
1 Tabs only
2 Mixed (tabs and spaces)
===== =======================
[build_settings] section
````````````````````````
As of Geany 0.19 this section is supplemented by the `[build-menu] section`_.
Values that are set in the [build-menu] section will override those in this section.
error_regex
This is a regular expression to parse a filename
and line number from build output. If undefined, Geany will fall
back to its default error message parsing.
Only the first two matches will be read by Geany. Geany will look for
a match that is purely digits, and use this for the line number. The
remaining match will be used as the filename.
*Example:* ``error_regex=(.+):([0-9]+):[0-9]+``
This will parse a message such as:
``test.py:7:24: E202 whitespace before ']'``
**Build commands**
If any build menu item settings have been configured in the Build Menu Commands
dialog or the Build tab of the project preferences dialog then these
settings are stored in the [build-menu] section and override the settings in
this section for that item.
compiler
This item specifies the command to compile source code files. But
it is also possible to use it with interpreted languages like Perl
or Python. With these filetypes you can use this option as a kind of
syntax parser, which sends output to the compiler message window.
You should quote the filename to also support filenames with
spaces. The following wildcards for filenames are available:
* %f -- complete filename without path
* %e -- filename without path and without extension
*Example:* ``compiler=gcc -Wall -c "%f"``
linker
This item specifies the command to link the file. If the file is not
already compiled, it will be compiled while linking. The -o option
is automatically added by Geany. This item works well with GNU gcc,
but may be problematic with other compilers (esp. with the linker).
*Example:* ``linker=gcc -Wall "%f"``
run_cmd
Use this item to execute your file. It has to have been built
already. Use the %e wildcard to have only the name of the executable
(i.e. without extension) or use the %f wildcard if you need the
complete filename, e.g. for shell scripts.
*Example:* ``run_cmd="./%e"``
Special file filetypes.common
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
There is a special filetype definition file called
filetypes.common. This file defines some general non-filetype-specific
settings.
You can open the user filetypes.common with the
*Tools->Configuration Files->filetypes.common* menu item. This adds
the default settings to the user file if the file doesn't exist.
Alternatively the file can be created manually, adding only the
settings you want to change. All missing settings will be read from
the system file.
.. note::
See the `Filetype configuration`_ section for how to define styles.
[named_styles] section
``````````````````````
Named styles declared here can be used in the [styling] section of any
filetypes.* file.
For example:
*In filetypes.common*::
[named_styles]
foo=0xc00000;0xffffff;false;true
bar=foo
*In filetypes.c*::
[styling]
comment=foo
This saves copying and pasting the whole style definition into several
different files.
.. note::
You can define aliases for named styles, as shown with the ``bar``
entry in the above example, but they must be declared after the
original style.
[named_colors] section
``````````````````````
Named colors declared here can be used in the ``[styling]`` or
``[named_styles]`` section of any filetypes.* file or color scheme.
For example::
[named_colors]
my_red_color=#FF0000
my_blue_color=#0000FF
[named_styles]
foo=my_red_color;my_blue_color;false;true
This allows to define a color pallete by name so that to change a color
scheme-wide only involves changing the hex value in a single location.
[styling] section
`````````````````
default
This is the default style. It is used for styling files without a
filetype set.
*Example:* ``default=0x000000;0xffffff;false;false``
selection
The style for coloring selected text. The format is:
* Foreground color
* Background color
* Use foreground color
* Use background color
The colors are only set if the 3rd or 4th argument is true. When
the colors are not overridden, the default is a dark grey
background with syntax highlighted foreground text.
*Example:* ``selection=0xc0c0c0;0x00007F;true;true``
brace_good
The style for brace highlighting when a matching brace was found.
*Example:* ``brace_good=0xff0000;0xFFFFFF;true;false``
brace_bad
The style for brace highlighting when no matching brace was found.
*Example:* ``brace_bad=0x0000ff;0xFFFFFF;true;false``
caret
The style for coloring the caret(the blinking cursor). Only first
and third argument is interpreted.
Set the third argument to true to change the caret into a block caret.
*Example:* ``caret=0x000000;0x0;false;false``
caret_width
The width for the caret(the blinking cursor). Only the first
argument is interpreted. The width is specified in pixels with
a maximum of three pixel. Use the width 0 to make the caret
invisible.
*Example:* ``caret=1;0;false;false``
current_line
The style for coloring the background of the current line. Only
the second and third arguments are interpreted. The second argument
is the background color. Use the third argument to enable or
disable background highlighting for the current line (has to be
true/false).
*Example:* ``current_line=0x0;0xe5e5e5;true;false``
indent_guide
The style for coloring the indentation guides. Only the first and
second arguments are interpreted.
*Example:* ``indent_guide=0xc0c0c0;0xffffff;false;false``
white_space
The style for coloring the white space if it is shown. The first
both arguments define the foreground and background colors, the
third argument sets whether to use the defined foreground color
or to use the color defined by each filetype for the white space.
The fourth argument defines whether to use the background color.
*Example:* ``white_space=0xc0c0c0;0xffffff;true;true``
margin_linenumber
Line number margin foreground and background colors.
.. _Folding Settings:
margin_folding
Fold margin foreground and background colors.
fold_symbol_highlight
Highlight color of folding symbols.
folding_style
The style of folding icons. Only first and second arguments are
used.
Valid values for the first argument are:
* 1 -- for boxes
* 2 -- for circles
* 3 -- for arrows
* 4 -- for +/-
Valid values for the second argument are:
* 0 -- for no lines
* 1 -- for straight lines
* 2 -- for curved lines
*Default:* ``folding_style=1;1;``
*Arrows:* ``folding_style=3;0;``
folding_horiz_line
Draw a thin horizontal line at the line where text is folded. Only
first argument is used.
Valid values for the first argument are:
* 0 -- disable, do not draw a line
* 1 -- draw the line above folded text
* 2 -- draw the line below folded text
*Example:* ``folding_horiz_line=0;0;false;false``
line_wrap_visuals
First argument: drawing of visual flags to indicate a line is wrapped.
This is a bitmask of the values:
* 0 -- No visual flags
* 1 -- Visual flag at end of subline of a wrapped line
* 2 -- Visual flag at begin of subline of a wrapped line. Subline is
indented by at least 1 to make room for the flag.
Second argument: wether the visual flags to indicate a line is wrapped
are drawn near the border or near the text. This is a bitmask of the values:
* 0 -- Visual flags drawn near border
* 1 -- Visual flag at end of subline drawn near text
* 2 -- Visual flag at begin of subline drawn near text
Only first and second arguments are interpreted.
*Example:* ``line_wrap_visuals=3;0;false;false``
line_wrap_indent
First argument: sets the size of indentation of sublines for wrapped lines
in terms of the width of a space, only used when the second argument is ``0``.
Second argument: wrapped sublines can be indented to the position of their
first subline or one more indent level. Possible values:
* 0 - Wrapped sublines aligned to left of window plus amount set by the first argument
* 1 - Wrapped sublines are aligned to first subline indent (use the same indentation)
* 2 - Wrapped sublines are aligned to first subline indent plus one more level of indentation
Only first and second arguments are interpreted.
*Example:* ``line_wrap_indent=0;1;false;false``
translucency
Translucency for the current line (first argument) and the selection
(second argument). Values between 0 and 256 are accepted.
Note for Windows 95, 98 and ME users:
keep this value at 256 to disable translucency otherwise Geany might crash.
Only the first and second arguments are interpreted.
*Example:* ``translucency=256;256;false;false``
marker_line
The style for a highlighted line (e.g when using Goto line or goto tag).
The foreground color (first argument) is only used when the Markers margin
is enabled (see View menu).
Only the first and second arguments are interpreted.
*Example:* ``marker_line=0x000000;0xffff00;false;false``
marker_search
The style for a marked search results (when using "Mark" in Search dialogs).
The second argument sets the background color for the drawn rectangle.
Only the second argument is interpreted.
*Example:* ``marker_search=0x000000;0xb8f4b8;false;false``
marker_mark
The style for a marked line (e.g when using the "Toggle Marker" keybinding
(Ctrl-M)). The foreground color (first argument) is only used
when the Markers margin is enabled (see View menu).
Only the first and second arguments are interpreted.
*Example:* ``marker_mark=0x000000;0xb8f4b8;false;false``
marker_translucency
Translucency for the line marker (first argument) and the search marker
(second argument). Values between 0 and 256 are accepted.
Note for Windows 95, 98 and ME users:
keep this value at 256 to disable translucency otherwise Geany might crash.
Only the first and second arguments are interpreted.
*Example:* ``marker_translucency=256;256;false;false``
line_height
Amount of space to be drawn above and below the line's baseline.
The first argument defines the amount of space to be drawn above the line, the second
argument defines the amount of space to be drawn below.
Only the first and second arguments are interpreted.
*Example:* ``line_height=0;0;false;false``
calltips
The style for coloring the calltips. The first two arguments
define the foreground and background colors, the third and fourth
arguments set whether to use the defined colors.
*Example:* ``calltips=0xc0c0c0;0xffffff;false;false``
[settings] section
``````````````````
whitespace_chars
Characters to treat as whitespace. These characters are ignored
when moving, selecting and deleting across word boundaries
(see `Scintilla keyboard commands`_).
This should include space (\\s) and tab (\\t).
*Example:* ``whitespace_chars=\s\t!\"#$%&'()*+,-./:;<=>?@[\\]^`{|}~``
Filetype extensions
-------------------
To change the default filetype extension used when saving a new file,
see `Filetype definition files`_.
You can override the list of file extensions that Geany uses to detect
filetypes using the user ``filetype_extensions.conf`` file. Use the
*Tools->Configuration Files->filetype_extensions.conf* menu item. See
also `Configuration file paths`_.
You should only list lines for filetype extensions that you want to
override in the user configuration file and remove or comment out
others. The patterns are listed after the ``=`` sign, using a
semi-colon separated list of patterns which should be matched for
that filetype.
For example, to override the filetype extensions for Make, the file
should look like::
[Extensions]
Make=Makefile*;*.mk;Buildfile;
Filetype group membership
-------------------------
Group membership is also stored in ``filetype_extensions.conf``. This
file is used to store information Geany needs at startup, whereas the
separate filetype definition files hold information only needed when
a document with their filetype is used.
The format looks like::
[Groups]
Programming=C;C++;
Script=Perl;Python;
Markup=HTML;XML;
Misc=Diff;Conf;
None=None;
The key names cannot be configured.
.. note::
Group membership is only read at startup.
Preferences file format
-----------------------
The user preferences file ``geany.conf`` holds settings for all the items configured
in the preferences dialog. This file should not be edited while Geany is running
as the file will be overwritten when the preferences in Geany are changed or Geany
is quit.
[build-menu] section
^^^^^^^^^^^^^^^^^^^^
The [build-menu] section contains the configuration of the build menu.
This section can occur in filetype, preferences and project files and
always has the format described here. Different menu items are loaded
from different files, see the table in the `Build Menu Configuration`_
section for details. All the settings can be configured from the dialogs
except the execute command in filetype files and filetype definitions in
the project file, so these are the only ones which need hand editing.
The build-menu section stores one entry for each setting for each menu item that
is configured. The keys for these settings have the format:
``GG_NN_FF``
where:
* GG - is the menu item group,
- FT for filetype
- NF for independent (non-filetype)
- EX for execute
* NN - is a two decimal digit number of the item within the group,
starting at 00
* FF - is the field,
- LB for label
- CM for command
- WD for working directory
Project file format
-------------------
The project file contains project related settings and possibly a
record of the current session files.
[build-menu] additions
^^^^^^^^^^^^^^^^^^^^^^
The project file also can have extra fields in the [build-menu] section
in addition to those listed in `[build-menu] section`_ above.
When filetype menu items are configured for the project they are stored
in the project file.
The ``filetypes`` entry is a list of the filetypes which exist in the
project file.
For each filetype the entries for that filetype have the format defined in
`[build-menu] section`_ but the key is prefixed by the name of the filetype
as it appears in the ``filetypes`` entry, eg the entry for the label of
filetype menu item 0 for the C filetype would be
``CFT_00_LB=Label``
Templates
---------
Geany supports the following templates:
* ChangeLog entry
* File header
* Function description
* Short GPL notice
* Short BSD notice
* File templates
To use these templates, just open the Edit menu or open the popup menu
by right-clicking in the editor widget, and choose "Insert Comments"
and insert templates as you want.
Some templates (like File header or ChangeLog entry) will always be
inserted at the top of the file.
To insert a function description, the cursor must be inside
of the function, so that the function name can be determined
automatically. The description will be positioned correctly one line
above the function, just check it out. If the cursor is not inside
of a function or the function name cannot be determined, the inserted
function description won't contain the correct function name but "unknown"
instead.
.. note::
Geany automatically reloads template information when it notices you
save a file in the user's template configuration directory. You can
also force this by selecting *Tools->Reload Configuration*.
Template meta data
^^^^^^^^^^^^^^^^^^
Meta data can be used with all templates, but by default user set
meta data is only used for the ChangeLog and File header templates.
In the configuration dialog you can find a tab "Templates" (see
`Template preferences`_). You can define the default values
which will be inserted in the templates.
File templates
^^^^^^^^^^^^^^
File templates are templates used as the basis of a new file. To
use them, choose the *New (with Template)* menu item from the *File*
menu.
By default, file templates are installed for some filetypes. Custom
file templates can be added by creating the appropriate template file. You can
also edit the default file templates.
The file's contents are just the text to place in the document, with
optional template wildcards like ``{fileheader}``. The fileheader
wildcard can be placed anywhere, but it's usually put on the first
line of the file, followed by a blank line.
Adding file templates
`````````````````````
File templates are read from ``templates/files`` under the
`Configuration file paths`_.
The filetype to use is detected from the template file's extension, if
any. For example, creating a file ``module.c`` would add a menu item
which created a new document with the filetype set to 'C'.
The template file is read from disk when the corresponding menu item is
clicked.
Customizing templates
^^^^^^^^^^^^^^^^^^^^^
Each template can be customized to your needs. The templates are
stored in the ``~/.config/geany/templates/`` directory (see the section called
`Command line options`_ for further information about the configuration
directory). Just open the desired template with an editor (ideally,
Geany ;-) ) and edit the template to your needs. There are some
wildcards which will be automatically replaced by Geany at startup.
Template wildcards
``````````````````
All wildcards must be enclosed by "{" and "}", e.g. {date}.
**Wildcards for character escaping**
============== ============================================= =======================================
Wildcard Description Available in
============== ============================================= =======================================
ob { Opening Brace (used to prevent other file templates, file header, snippets.
wildcards being expanded).
cb } Closing Brace. file templates, file header, snippets.
pc \% Percent (used to escape e.g. %block% in
snippets). snippets.
============== ============================================= =======================================
**Global wildcards**
These are configurable, see `Template preferences`_.
============== ============================================= =======================================
Wildcard Description Available in
============== ============================================= =======================================
developer The name of the developer. file templates, file header,
function description, ChangeLog entry,
bsd, gpl, snippets.
initial The developer's initials, e.g. "ET" for file templates, file header,
Enrico TrĂśger or "JFD" for John Foobar Doe. function description, ChangeLog entry,
bsd, gpl, snippets.
mail The email address of the developer. file templates, file header,
function description, ChangeLog entry,
bsd, gpl, snippets.
company The company the developer is working for. file templates, file header,
function description, ChangeLog entry,
bsd, gpl, snippets.
version The initial version of a new file. file templates, file header,
function description, ChangeLog entry,
bsd, gpl, snippets.
============== ============================================= =======================================
**Date & time wildcards**
The format for these wildcards can be changed in the preferences
dialog, see `Template preferences`_. You can use any conversion
specifiers which can be used with the ANSI C strftime function.
For details please see http://man.cx/strftime.
============== ============================================= =======================================
Wildcard Description Available in
============== ============================================= =======================================
year The current year. Default format is: YYYY. file templates, file header,
function description, ChangeLog entry,
bsd, gpl, snippets.
date The current date. Default format: file templates, file header,
YYYY-MM-DD. function description, ChangeLog entry,
bsd, gpl, snippets.
datetime The current date and time. Default format: file templates, file header,
DD.MM.YYYY HH:mm:ss ZZZZ. function description, ChangeLog entry,
bsd, gpl, snippets.
============== ============================================= =======================================
**Dynamic wildcards**
============== ============================================= =======================================
Wildcard Description Available in
============== ============================================= =======================================
untitled The string "untitled" (this will be file templates, file header,
translated to your locale), used in function description, ChangeLog entry,
file templates. bsd, gpl, snippets.
geanyversion The actual Geany version, e.g. file templates, file header,
"Geany |(version)|". function description, ChangeLog entry,
bsd, gpl, snippets.
filename The filename of the current file. file header, snippets, file
For new files, it's only replaced when templates.
first saving if found on the first 3 lines
of the file.
project The current project's name, if any. file header, snippets, file templates.
description The current project's description, if any. file header, snippets, file templates.
functionname The function name of the function at the function description.
cursor position. This wildcard will only be
replaced in the function description
template.
command:path Executes the specified command and replace file templates, file header,
the wildcard with the command's standard function description, ChangeLog entry,
output. See `Special {command:} wildcard`_ bsd, gpl, snippets.
for details.
============== ============================================= =======================================
**Template insertion wildcards**
============== ============================================= =======================================
Wildcard Description Available in
============== ============================================= =======================================
gpl This wildcard inserts a short GPL notice. file header.
bsd This wildcard inserts a BSD licence notice. file header.
fileheader The file header template. This wildcard snippets, file templates.
will only be replaced in file templates.
============== ============================================= =======================================
Special {command:} wildcard
***************************
The {command:} wildcard is a special one because it can execute
a specified command and put the command's output (stdout) into
the template.
Example::
{command:uname -a}
will result in::
Linux localhost 2.6.9-023stab046.2-smp #1 SMP Mon Dec 10 15:04:55 MSK 2007 x86_64 GNU/Linux
Using this wildcard you can insert nearly any arbitrary text into the
template.
In the environment of the executed command the variables
``GEANY_FILENAME``, ``GEANY_FILETYPE`` and ``GEANY_FUNCNAME`` are set.
The value of these variables is filled in only if Geany knows about it.
For example, ``GEANY_FUNCNAME`` is only filled within the function
description template. However, these variables are ``always`` set,
just maybe with an empty value.
You can easily access them e.g. within an executed shell script using::
$GEANY_FILENAME
.. note::
If the specified command could not be found or not executed, the wildcard is substituted
by an empty string. In such cases, you can find the occurred error message on Geany's
standard error and in the Help->Debug Messages dialog.
Customizing the toolbar
-----------------------
You can add, remove and reorder the elements in the toolbar by using
the toolbar editor, or by manually editing the configuration file
``ui_toolbar.xml``.
The toolbar editor can be opened from the preferences editor on the Toolbar tab or
by right-clicking on the toolbar itself and choosing it from the menu.
Manually editing the toolbar layout
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
To override the system-wide configuration file, copy it to your user
configuration directory (see `Configuration file paths`_).
For example::
% cp /usr/local/share/geany/ui_toolbar.xml /home/username/.config/geany/
Then edit it and add any of the available elements listed in the file or remove
any of the existing elements. Of course, you can also reorder the elements as
you wish and add or remove additional separators.
This file must be valid XML, otherwise the global toolbar UI definition
will be used instead.
Your changes are applied once you save the file.
.. note::
(1) You cannot add new actions which are not listed below.
(2) Everything you add or change must be inside the /ui/toolbar/ path.
Available toolbar elements
^^^^^^^^^^^^^^^^^^^^^^^^^^
================== ==============================================================================
Element name Description
================== ==============================================================================
New Create a new file
Open Open an existing file
Save Save the current file
SaveAll Save all open files
Reload Reload the current file from disk
Close Close the current file
CloseAll Close all open files
Print Print the current file
Cut Cut the current selection
Copy Copy the current selection
Paste Paste the contents of the clipboard
Delete Delete the current selection
Undo Undo the last modification
Redo Redo the last modification
NavBack Navigate back a location
NavFor Navigate forward a location
Compile Compile the current file
Build Build the current file, includes a submenu for Make commands. Geany
remembers the last chosen action from the submenu and uses this as default
action when the button itself is clicked.
Run Run or view the current file
Color Open a color chooser dialog, to interactively pick colors from a palette
ZoomIn Zoom in the text
ZoomOut Zoom out the text
UnIndent Decrease indentation
Indent Increase indentation
Replace Replace text in the current document
SearchEntry The search field belonging to the 'Search' element (can be used alone)
Search Find the entered text in the current file (only useful if you also
use 'SearchEntry')
GotoEntry The goto field belonging to the 'Goto' element (can be used alone)
Goto Jump to the entered line number (only useful if you also use 'GotoEntry')
Preferences Show the preferences dialog
Quit Quit Geany
================== ==============================================================================
Plugin documentation
====================
HTML Characters
---------------
The HTML Characters plugin helps when working with special
characters in XML/HTML, e.g. German Umlauts ß and ä.
Insert entity dialog
^^^^^^^^^^^^^^^^^^^^
When the plugin is enabled, you can insert special character
entities using *Tools->Insert Special HTML Characters*.
This opens up a dialog where you can find a huge amount of special
characters sorted by category that you might like to use inside your
document. You can expand and collapse the categories by clicking on
the little arrow on the left hand side. Once you have found the
desired character click on it and choose "Insert". This will insert
the entity for the character at the current cursor position. You
might also like to double click the chosen entity instead.
Replace special chars by its entity
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
To help make a XML/HTML document valid the plugin supports
replacement of special chars known by the plugin. Both bulk
replacement and immediate replacement during typing are supported.
A few characters will not be replaced. These are
* "
* &
* <
* >
* (`&nbsp;`)
At typing time
``````````````
You can activate/deactivate this feature using the *Tools->HTML
Replacement->Auto-replace Special Characters* menu item. If it's
activated, all special characters (beside the given exceptions from
above) known by the plugin will be replaced by their entities.
You could also set a keybinding for the plugin to toggle the status
of this feature.
Bulk replacement
````````````````
After inserting a huge amount of text, e.g. by using copy & paste, the
plugin allows bulk replacement of all known characters (beside the
mentioned exceptions). You can find the function under the same
menu at *Tools->HTML Replacement->Replace Characters in Selection*, or
configure a keybinding for the plugin.
Save Actions
------------
Instant Save
^^^^^^^^^^^^
This plugin sets on every new file (*File->New* or *File->New (with template)*)
a randomly chosen filename and set its filetype appropriate to the used template
or when no template was used, to a configurable default filetype.
This enables you to quickly compile, build and/or run the new file without the
need to give it an explicit filename using the Save As dialog. This might be
useful when you often create new files just for testing some code or something
similar.
Backup Copy
^^^^^^^^^^^
This plugin creates a backup copy of the current file in Geany when it is
saved. You can specify the directory where the backup copy is saved and
you can configure the automatically added extension in the configure dialog
in Geany's plugin manager.
After the plugin was loaded in Geany's plugin manager, every file is
copied into the configured backup directory when the file is saved in Geany.
Contributing to this document
=============================
This document (``geany.txt``) is written in `reStructuredText`__
(or "reST"). The source file for it is located in Geany's ``doc``
subdirectory. If you intend on making changes, you should grab the
source right from Git to make sure you've got the newest version. After
editing the file, to build the HTML document to see how your changes
look, run "``make doc``" in the subdirectory ``doc`` of Geany's source
directory. This regenerates the ``geany.html`` file. To generate a PDF
file, use the command "``make pdf``" which should generate a file called
geany-|(version)|.pdf.
__ http://docutils.sourceforge.net/rst.html
After you are happy with your changes, create a patch e.g. by using::
% git diff geany.txt > foo.patch
or even better, by creating a Git-formatted patch which will keep authoring
and description data, by first committing your changes (doing so in a fresh
new branch is recommended for `matser` not to diverge from upstream) and then
using git format-patch::
% git checkout -b my-documentation-changes # create a fresh branch
% git commit geany.txt
Write a good commit message...
% git format-patch HEAD^
% git checkout master # go back to master
and then submit that file to the mailing list for review.
Also you can clone the Geany repository at GitHub and send a pull request.
Note, you will need the Python docutils software package installed
to build the docs. The package is named ``python-docutils`` on Debian
and Fedora systems.
Scintilla keyboard commands
===========================
Copyright Š 1998, 2006 Neil Hodgson <neilh(at)scintilla(dot)org>
This appendix is distributed under the terms of the License for
Scintilla and SciTE. A copy of this license can be found in the file
``scintilla/License.txt`` included with the source code of this
program and in the appendix of this document. See `License for
Scintilla and SciTE`_.
20 June 2006
Keyboard commands
-----------------
Keyboard commands for Scintilla mostly follow common Windows and GTK+
conventions. All move keys (arrows, page up/down, home and end)
allows to extend or reduce the stream selection when holding the
Shift key, and the rectangular selection when holding the
appropriate keys (see `Column mode editing (rectangular selections)`_).
Some keys may not be available with some national keyboards
or because they are taken by the system such as by a window manager
or GTK. Keyboard equivalents of menu commands are listed in the
menus. Some less common commands with no menu equivalent are:
============================================= ======================
Action Shortcut key
============================================= ======================
Magnify text size. Ctrl-Keypad+
Reduce text size. Ctrl-Keypad-
Restore text size to normal. Ctrl-Keypad/
Indent block. Tab
Dedent block. Shift-Tab
Delete to start of word. Ctrl-BackSpace
Delete to end of word. Ctrl-Delete
Delete to start of line. Ctrl-Shift-BackSpace
Go to start of document. Ctrl-Home
Extend selection to start of document. Ctrl-Shift-Home
Go to start of display line. Alt-Home
Extend selection to start of display line. Alt-Shift-Home
Go to end of document. Ctrl-End
Extend selection to end of document. Ctrl-Shift-End
Extend selection to end of display line. Alt-Shift-End
Previous paragraph. Shift extends selection. Ctrl-Up
Next paragraph. Shift extends selection. Ctrl-Down
Previous word. Shift extends selection. Ctrl-Left
Next word. Shift extends selection. Ctrl-Right
============================================= ======================
Tips and tricks
===============
Document notebook
-----------------
* Double-click on empty space in the notebook tab bar to open a
new document.
* Middle-click on a document's notebook tab to close the document.
* Hold `Ctrl` and click on any notebook tab to switch to the last used
document.
* Double-click on a document's notebook tab to toggle all additional
widgets (to show them again use the View menu or the keyboard
shortcut). The interface pref must be enabled for this to work.
Editor
------
* Alt-scroll wheel moves up/down a page.
* Ctrl-scroll wheel zooms in/out.
* Shift-scroll wheel scrolls 8 characters right/left.
* Ctrl-click on a word in a document to perform *Go to Tag Definition*.
* Ctrl-click on a bracket/brace to perform *Go to Matching Brace*.
Interface
---------
* Double-click on a symbol-list group to expand or compact it.
GTK-related
-----------
* Scrolling the mouse wheel over a notebook tab bar will switch
notebook pages.
The following are derived from X-Windows features (but GTK still supports
them on Windows):
* Middle-click pastes the last selected text.
* Middle-click on a scrollbar moves the scrollbar to that
position without having to drag it.
Compile-time options
====================
There are some options which can only be changed at compile time,
and some options which are used as the default for configurable
options. To change these options, edit the appropriate source file
in the ``src`` subdirectory. Look for a block of lines starting with
``#define GEANY_*``. Any definitions which are not listed here should
not be changed.
.. note::
Most users should not need to change these options.
src/geany.h
-----------
============================== ============================================ ==================
Option Description Default
============================== ============================================ ==================
GEANY_STRING_UNTITLED A string used as the default name for new untitled
files. Be aware that the string can be
translated, so change it only if you know
what you are doing.
GEANY_WINDOW_MINIMAL_WIDTH The minimal width of the main window. 620
GEANY_WINDOW_MINIMAL_HEIGHT The minimal height of the main window. 440
GEANY_WINDOW_DEFAULT_WIDTH The default width of the main window at the 900
first start.
GEANY_WINDOW_DEFAULT_HEIGHT The default height of the main window at the 600
first start.
**Windows specific**
GEANY_USE_WIN32_DIALOG Set this to 1 if you want to use the default 0
Windows file open and save dialogs instead
GTK's file open and save dialogs. The
default Windows file dialogs are missing
some nice features like choosing a filetype
or an encoding. *Do not touch this setting
when building on a non-Win32 system.*
============================== ============================================ ==================
project.h
---------
============================== ============================================ ==================
Option Description Default
============================== ============================================ ==================
GEANY_PROJECT_EXT The default filename extension for Geany geany
project files. It is used when creating new
projects and as filter mask for the project
open dialog.
============================== ============================================ ==================
filetypes.c
-----------
============================== ============================================ ==================
Option Description Default
============================== ============================================ ==================
GEANY_FILETYPE_SEARCH_LINES The number of lines to search for the 2
filetype with the extract filetype regex.
============================== ============================================ ==================
editor.h
--------
============================== ============================================ ==================
Option Description Default
============================== ============================================ ==================
GEANY_WORDCHARS These characters define word boundaries when a string with:
making selections and searching using word a-z, A-Z, 0-9 and
matching options. underscore.
============================== ============================================ ==================
keyfile.c
---------
These are default settings that can be overridden in the `Preferences`_ dialog.
============================== ============================================ ==================
Option Description Default
============================== ============================================ ==================
GEANY_MIN_SYMBOLLIST_CHARS How many characters you need to type to 4
trigger the autocompletion list.
GEANY_DISK_CHECK_TIMEOUT Time in seconds between checking a file for 30
external changes.
GEANY_DEFAULT_TOOLS_MAKE The make tool. This can also include a path. "make"
GEANY_DEFAULT_TOOLS_TERMINAL A terminal emulator. It has to accept the "xterm"
command line option "-e". This can also
include a path.
GEANY_DEFAULT_TOOLS_BROWSER A web browser. This can also include a path. "firefox"
GEANY_DEFAULT_TOOLS_PRINTCMD A printing tool. It should be able to accept "lpr"
and process plain text files. This can also
include a path.
GEANY_DEFAULT_TOOLS_GREP A grep tool. It should be compatible with "grep"
GNU grep. This can also include a path.
GEANY_DEFAULT_MRU_LENGTH The length of the "Recent files" list. 10
GEANY_DEFAULT_FONT_SYMBOL_LIST The font used in sidebar to show symbols and "Sans 9"
open files.
GEANY_DEFAULT_FONT_MSG_WINDOW The font used in the messages window. "Sans 9"
GEANY_DEFAULT_FONT_EDITOR The font used in the editor window. "Monospace 10"
GEANY_TOGGLE_MARK A string which is used to mark a toggled "~ "
comment.
GEANY_MAX_AUTOCOMPLETE_WORDS How many autocompletion suggestions should 30
Geany provide.
GEANY_DEFAULT_FILETYPE_REGEX The default regex to extract filetypes from See below.
files.
============================== ============================================ ==================
The GEANY_DEFAULT_FILETYPE_REGEX default value is -\\*-\\s*([^\\s]+)\\s*-\\*- which finds Emacs filetypes.
build.c
-------
============================== ============================================ ==================
Option Description Default
============================== ============================================ ==================
GEANY_BUILD_ERR_HIGHLIGHT_MAX Amount of build error indicators to 50
be shown in the editor window.
This affects the special coloring
when Geany detects a compiler output line as
an error message and then highlights the
corresponding line in the source code.
Usually only the first few messages are
interesting because following errors are
just after-effects.
All errors in the Compiler window are parsed
and unaffected by this value.
PRINTBUILDCMDS Every time a build menu item priority FALSE
calculation is run, print the state of the
menu item table in the form of the table
in `Build Menu Configuration`_. May be
useful to debug configuration file
overloading. Warning produces a lot of
output. Can also be enabled/disabled by the
debugger by setting printbuildcmds to 1/0
overriding the compile setting.
============================== ============================================ ==================
GNU General Public License
==========================
::
GNU GENERAL PUBLIC LICENSE
Version 2, June 1991
Copyright (C) 1989, 1991 Free Software Foundation, Inc.
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The licenses for most software are designed to take away your
freedom to share and change it. By contrast, the GNU General Public
License is intended to guarantee your freedom to share and change free
software--to make sure the software is free for all its users. This
General Public License applies to most of the Free Software
Foundation's software and to any other program whose authors commit to
using it. (Some other Free Software Foundation software is covered by
the GNU Library General Public License instead.) You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
this service if you wish), that you receive source code or can get it
if you want it, that you can change the software or use pieces of it
in new free programs; and that you know you can do these things.
To protect your rights, we need to make restrictions that forbid
anyone to deny you these rights or to ask you to surrender the rights.
These restrictions translate to certain responsibilities for you if you
distribute copies of the software, or if you modify it.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must give the recipients all the rights that
you have. You must make sure that they, too, receive or can get the
source code. And you must show them these terms so they know their
rights.
We protect your rights with two steps: (1) copyright the software, and
(2) offer you this license which gives you legal permission to copy,
distribute and/or modify the software.
Also, for each author's protection and ours, we want to make certain
that everyone understands that there is no warranty for this free
software. If the software is modified by someone else and passed on, we
want its recipients to know that what they have is not the original, so
that any problems introduced by others will not reflect on the original
authors' reputations.
Finally, any free program is threatened constantly by software
patents. We wish to avoid the danger that redistributors of a free
program will individually obtain patent licenses, in effect making the
program proprietary. To prevent this, we have made it clear that any
patent must be licensed for everyone's free use or not licensed at all.
The precise terms and conditions for copying, distribution and
modification follow.
GNU GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License applies to any program or other work which contains
a notice placed by the copyright holder saying it may be distributed
under the terms of this General Public License. The "Program", below,
refers to any such program or work, and a "work based on the Program"
means either the Program or any derivative work under copyright law:
that is to say, a work containing the Program or a portion of it,
either verbatim or with modifications and/or translated into another
language. (Hereinafter, translation is included without limitation in
the term "modification".) Each licensee is addressed as "you".
Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope. The act of
running the Program is not restricted, and the output from the Program
is covered only if its contents constitute a work based on the
Program (independent of having been made by running the Program).
Whether that is true depends on what the Program does.
1. You may copy and distribute verbatim copies of the Program's
source code as you receive it, in any medium, provided that you
conspicuously and appropriately publish on each copy an appropriate
copyright notice and disclaimer of warranty; keep intact all the
notices that refer to this License and to the absence of any warranty;
and give any other recipients of the Program a copy of this License
along with the Program.
You may charge a fee for the physical act of transferring a copy, and
you may at your option offer warranty protection in exchange for a fee.
2. You may modify your copy or copies of the Program or any portion
of it, thus forming a work based on the Program, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:
a) You must cause the modified files to carry prominent notices
stating that you changed the files and the date of any change.
b) You must cause any work that you distribute or publish, that in
whole or in part contains or is derived from the Program or any
part thereof, to be licensed as a whole at no charge to all third
parties under the terms of this License.
c) If the modified program normally reads commands interactively
when run, you must cause it, when started running for such
interactive use in the most ordinary way, to print or display an
announcement including an appropriate copyright notice and a
notice that there is no warranty (or else, saying that you provide
a warranty) and that users may redistribute the program under
these conditions, and telling the user how to view a copy of this
License. (Exception: if the Program itself is interactive but
does not normally print such an announcement, your work based on
the Program is not required to print an announcement.)
These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the Program,
and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works. But when you
distribute the same sections as part of a whole which is a work based
on the Program, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote it.
Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Program.
In addition, mere aggregation of another work not based on the Program
with the Program (or with a work based on the Program) on a volume of
a storage or distribution medium does not bring the other work under
the scope of this License.
3. You may copy and distribute the Program (or a work based on it,
under Section 2) in object code or executable form under the terms of
Sections 1 and 2 above provided that you also do one of the following:
a) Accompany it with the complete corresponding machine-readable
source code, which must be distributed under the terms of Sections
1 and 2 above on a medium customarily used for software interchange; or,
b) Accompany it with a written offer, valid for at least three
years, to give any third party, for a charge no more than your
cost of physically performing source distribution, a complete
machine-readable copy of the corresponding source code, to be
distributed under the terms of Sections 1 and 2 above on a medium
customarily used for software interchange; or,
c) Accompany it with the information you received as to the offer
to distribute corresponding source code. (This alternative is
allowed only for noncommercial distribution and only if you
received the program in object code or executable form with such
an offer, in accord with Subsection b above.)
The source code for a work means the preferred form of the work for
making modifications to it. For an executable work, complete source
code means all the source code for all modules it contains, plus any
associated interface definition files, plus the scripts used to
control compilation and installation of the executable. However, as a
special exception, the source code distributed need not include
anything that is normally distributed (in either source or binary
form) with the major components (compiler, kernel, and so on) of the
operating system on which the executable runs, unless that component
itself accompanies the executable.
If distribution of executable or object code is made by offering
access to copy from a designated place, then offering equivalent
access to copy the source code from the same place counts as
distribution of the source code, even though third parties are not
compelled to copy the source along with the object code.
4. You may not copy, modify, sublicense, or distribute the Program
except as expressly provided under this License. Any attempt
otherwise to copy, modify, sublicense or distribute the Program is
void, and will automatically terminate your rights under this License.
However, parties who have received copies, or rights, from you under
this License will not have their licenses terminated so long as such
parties remain in full compliance.
5. You are not required to accept this License, since you have not
signed it. However, nothing else grants you permission to modify or
distribute the Program or its derivative works. These actions are
prohibited by law if you do not accept this License. Therefore, by
modifying or distributing the Program (or any work based on the
Program), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Program or works based on it.
6. Each time you redistribute the Program (or any work based on the
Program), the recipient automatically receives a license from the
original licensor to copy, distribute or modify the Program subject to
these terms and conditions. You may not impose any further
restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties to
this License.
7. If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues),
conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot
distribute so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you
may not distribute the Program at all. For example, if a patent
license would not permit royalty-free redistribution of the Program by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Program.
If any portion of this section is held invalid or unenforceable under
any particular circumstance, the balance of the section is intended to
apply and the section as a whole is intended to apply in other
circumstances.
It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the
integrity of the free software distribution system, which is
implemented by public license practices. Many people have made
generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot
impose that choice.
This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License.
8. If the distribution and/or use of the Program is restricted in
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Program under this License
may add an explicit geographical distribution limitation excluding
those countries, so that distribution is permitted only in or among
countries not thus excluded. In such case, this License incorporates
the limitation as if written in the body of this License.
9. The Free Software Foundation may publish revised and/or new versions
of the General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the Program
specifies a version number of this License which applies to it and "any
later version", you have the option of following the terms and conditions
either of that version or of any later version published by the Free
Software Foundation. If the Program does not specify a version number of
this License, you may choose any version ever published by the Free Software
Foundation.
10. If you wish to incorporate parts of the Program into other free
programs whose distribution conditions are different, write to the author
to ask for permission. For software which is copyrighted by the Free
Software Foundation, write to the Free Software Foundation; we sometimes
make exceptions for this. Our decision will be guided by the two goals
of preserving the free status of all derivatives of our free software and
of promoting the sharing and reuse of software generally.
NO WARRANTY
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
REPAIR OR CORRECTION.
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
convey the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
Also add information on how to contact you by electronic and paper mail.
If the program is interactive, make it output a short notice like this
when it starts in an interactive mode:
Gnomovision version 69, Copyright (C) year name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, the commands you use may
be called something other than `show w' and `show c'; they could even be
mouse-clicks or menu items--whatever suits your program.
You should also get your employer (if you work as a programmer) or your
school, if any, to sign a "copyright disclaimer" for the program, if
necessary. Here is a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
`Gnomovision' (which makes passes at compilers) written by James Hacker.
<signature of Ty Coon>, 1 April 1989
Ty Coon, President of Vice
This General Public License does not permit incorporating your program into
proprietary programs. If your program is a subroutine library, you may
consider it more useful to permit linking proprietary applications with the
library. If this is what you want to do, use the GNU Library General
Public License instead of this License.
License for Scintilla and SciTE
===============================
Copyright 1998-2003 by Neil Hodgson <neilh(at)scintilla(dot)org>
All Rights Reserved
Permission to use, copy, modify, and distribute this software and
its documentation for any purpose and without fee is hereby granted,
provided that the above copyright notice appear in all copies and
that both that copyright notice and this permission notice appear in
supporting documentation.
NEIL HODGSON DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN
NO EVENT SHALL NEIL HODGSON BE LIABLE FOR ANY SPECIAL, INDIRECT OR
CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE
USE OR PERFORMANCE OF THIS SOFTWARE.