This file is indexed.

/usr/share/doc/fdroidserver/html/fdroid.html is in fdroidserver 0.2.1-4.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

   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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- This manual is for the F-Droid repository server tools.

Copyright (C) 2010, 2011, 2012, 2013 Ciaran Gultnieks

Copyright (C) 2011 Henrik Tunedal, Michael Haas, John Sullivan

Copyright (C) 2013 David Black

Copyright (C) 2013, 2014 Daniel Martí

Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3
or any later version published by the Free Software Foundation;
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
A copy of the license is included in the section entitled "GNU
Free Documentation License". -->
<!-- Created by GNU Texinfo 5.2, http://www.gnu.org/software/texinfo/ -->
<head>
<title>F-Droid Server Manual</title>

<meta name="description" content="F-Droid Server Manual">
<meta name="keywords" content="F-Droid Server Manual">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="#Top" rel="start" title="Top">
<link href="#Index" rel="index" title="Index">
<link href="#SEC_Contents" rel="contents" title="Table of Contents">
<link href="dir.html#Top" rel="up" title="(dir)">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.indentedblock {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
div.smalllisp {margin-left: 3.2em}
kbd {font-style:oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nocodebreak {white-space:nowrap}
span.nolinebreak {white-space:nowrap}
span.roman {font-family:serif; font-weight:normal}
span.sansserif {font-family:sans-serif; font-weight:normal}
ul.no-bullet {list-style: none}
-->
</style>


</head>

<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
<h1 class="settitle" align="center">F-Droid Server Manual</h1>



<a name="SEC_Contents"></a>
<h2 class="contents-heading">Table of Contents</h2>

<div class="contents">

<ul class="no-bullet">
  <li><a name="toc-Overview-1" href="#Overview">1 Overview</a></li>
  <li><a name="toc-System-Requirements-1" href="#System-Requirements">2 System Requirements</a></li>
  <li><a name="toc-Setup-1" href="#Setup">3 Setup</a>
  <ul class="no-bullet">
    <li><a name="toc-Data" href="#Data">3.1 Data</a></li>
  </ul></li>
  <li><a name="toc-Simple-Binary-Repository-1" href="#Simple-Binary-Repository">4 Simple Binary Repository</a></li>
  <li><a name="toc-Building-Applications-1" href="#Building-Applications">5 Building Applications</a>
  <ul class="no-bullet">
    <li><a name="toc-More-about-_0022fdroid-build_0022" href="#More-about-_0022fdroid-build_0022">5.1 More about &quot;fdroid build&quot;</a></li>
    <li><a name="toc-Direct-Installation" href="#Direct-Installation">5.2 Direct Installation</a></li>
  </ul></li>
  <li><a name="toc-Importing-Applications-1" href="#Importing-Applications">6 Importing Applications</a></li>
  <li><a name="toc-Metadata-1" href="#Metadata">7 Metadata</a>
  <ul class="no-bullet">
    <li><a name="toc-Categories-1" href="#Categories">7.1 Categories</a></li>
    <li><a name="toc-License-1" href="#License">7.2 License</a></li>
    <li><a name="toc-Auto-Name-1" href="#Auto-Name">7.3 Auto Name</a></li>
    <li><a name="toc-Name-1" href="#Name">7.4 Name</a></li>
    <li><a name="toc-Provides-1" href="#Provides">7.5 Provides</a></li>
    <li><a name="toc-Web-Site-1" href="#Web-Site">7.6 Web Site</a></li>
    <li><a name="toc-Source-Code-1" href="#Source-Code">7.7 Source Code</a></li>
    <li><a name="toc-Issue-Tracker-1" href="#Issue-Tracker">7.8 Issue Tracker</a></li>
    <li><a name="toc-Donate-1" href="#Donate">7.9 Donate</a></li>
    <li><a name="toc-FlattrID-1" href="#FlattrID">7.10 FlattrID</a></li>
    <li><a name="toc-Bitcoin-1" href="#Bitcoin">7.11 Bitcoin</a></li>
    <li><a name="toc-Litecoin-1" href="#Litecoin">7.12 Litecoin</a></li>
    <li><a name="toc-Summary-1" href="#Summary">7.13 Summary</a></li>
    <li><a name="toc-Description-1" href="#Description">7.14 Description</a></li>
    <li><a name="toc-Maintainer-Notes-1" href="#Maintainer-Notes">7.15 Maintainer Notes</a></li>
    <li><a name="toc-Repo-Type-1" href="#Repo-Type">7.16 Repo Type</a></li>
    <li><a name="toc-Repo-1" href="#Repo">7.17 Repo</a></li>
    <li><a name="toc-Build-1" href="#Build">7.18 Build</a></li>
    <li><a name="toc-AntiFeatures-1" href="#AntiFeatures">7.19 AntiFeatures</a></li>
    <li><a name="toc-Disabled-1" href="#Disabled">7.20 Disabled</a></li>
    <li><a name="toc-Requires-Root-1" href="#Requires-Root">7.21 Requires Root</a></li>
    <li><a name="toc-Archive-Policy-1" href="#Archive-Policy">7.22 Archive Policy</a></li>
    <li><a name="toc-Update-Check-Mode-1" href="#Update-Check-Mode">7.23 Update Check Mode</a></li>
    <li><a name="toc-Vercode-Operation-1" href="#Vercode-Operation">7.24 Vercode Operation</a></li>
    <li><a name="toc-Update-Check-Ignore-1" href="#Update-Check-Ignore">7.25 Update Check Ignore</a></li>
    <li><a name="toc-Update-Check-Data-1" href="#Update-Check-Data">7.26 Update Check Data</a></li>
    <li><a name="toc-Auto-Update-Mode-1" href="#Auto-Update-Mode">7.27 Auto Update Mode</a></li>
    <li><a name="toc-Current-Version-1" href="#Current-Version">7.28 Current Version</a></li>
    <li><a name="toc-Current-Version-Code-1" href="#Current-Version-Code">7.29 Current Version Code</a></li>
    <li><a name="toc-No-Source-Since-1" href="#No-Source-Since">7.30 No Source Since</a></li>
  </ul></li>
  <li><a name="toc-Update-Processing-1" href="#Update-Processing">8 Update Processing</a>
  <ul class="no-bullet">
    <li><a name="toc-Detecting" href="#Detecting">8.1 Detecting</a></li>
    <li><a name="toc-Adding" href="#Adding">8.2 Adding</a></li>
  </ul></li>
  <li><a name="toc-Build-Server-1" href="#Build-Server">9 Build Server</a>
  <ul class="no-bullet">
    <li><a name="toc-Overview-2" href="#Overview-2">9.1 Overview</a></li>
    <li><a name="toc-Setting-up-a-build-server" href="#Setting-up-a-build-server">9.2 Setting up a build server</a></li>
  </ul></li>
  <li><a name="toc-Signing-1" href="#Signing">10 Signing</a>
  <ul class="no-bullet">
    <li><a name="toc-Repo-Index-Signing" href="#Repo-Index-Signing">10.1 Repo Index Signing</a></li>
    <li><a name="toc-Package-Signing" href="#Package-Signing">10.2 Package Signing</a></li>
  </ul></li>
  <li><a name="toc-GNU-Free-Documentation-License-1" href="#GNU-Free-Documentation-License">Appendix A GNU Free Documentation License</a></li>
  <li><a name="toc-Index-1" href="#Index">Index</a></li>
</ul>
</div>


<a name="Top"></a>
<div class="header">
<p>
Next: <a href="#Overview" accesskey="n" rel="next">Overview</a>, Up: <a href="dir.html#Top" accesskey="u" rel="up">(dir)</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="F_002dDroid-Server"></a>
<h1 class="top">F-Droid Server</h1>

<p>This manual is for the F-Droid repository server tools.
</p>
<p>Copyright &copy; 2010, 2011, 2012, 2013 Ciaran Gultnieks
</p>
<p>Copyright &copy; 2011 Henrik Tunedal, Michael Haas, John Sullivan
</p>
<p>Copyright &copy; 2013 David Black
</p>
<p>Copyright &copy; 2013, 2014 Daniel Martí
</p>
<blockquote>
<p>Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3
or any later version published by the Free Software Foundation;
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
A copy of the license is included in the section entitled &quot;GNU
Free Documentation License&quot;.
</p></blockquote>


<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top">&bull; <a href="#Overview" accesskey="1">Overview</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="#System-Requirements" accesskey="2">System Requirements</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="#Setup" accesskey="3">Setup</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="#Simple-Binary-Repository" accesskey="4">Simple Binary Repository</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="#Building-Applications" accesskey="5">Building Applications</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="#Importing-Applications" accesskey="6">Importing Applications</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="#Metadata" accesskey="7">Metadata</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="#Update-Processing" accesskey="8">Update Processing</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="#Build-Server" accesskey="9">Build Server</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="#Signing">Signing</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="#GNU-Free-Documentation-License">GNU Free Documentation License</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="#Index">Index</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
</table>

<hr>
<a name="Overview"></a>
<div class="header">
<p>
Next: <a href="#System-Requirements" accesskey="n" rel="next">System Requirements</a>, Previous: <a href="#Top" accesskey="p" rel="prev">Top</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Overview-1"></a>
<h2 class="chapter">1 Overview</h2>

<p>The F-Droid server tools provide various scripts and tools that are used
to maintain the main F-Droid application repository. You can use these same
tools to create your own additional or alternative repository for publishing,
or to assist in creating, testing and submitting metadata to the main
repository.
</p>

<hr>
<a name="System-Requirements"></a>
<div class="header">
<p>
Next: <a href="#Setup" accesskey="n" rel="next">Setup</a>, Previous: <a href="#Overview" accesskey="p" rel="prev">Overview</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="System-Requirements-1"></a>
<h2 class="chapter">2 System Requirements</h2>

<a name="index-installation"></a>

<p>The system requirements for using the tools will vary depending on your
intended usage. At the very least, you&rsquo;ll need:
</p>
<ul>
<li> GNU/Linux
</li><li> Python 2.x
</li><li> The Android SDK Tools and Build-tools.
Note that F-Droid does not assume that you have the Android SDK in your
<code>PATH</code>: these directories will be specified in your repository
configuration. Recent revisions of the SDK have <code>aapt</code> located in
android-sdk/build-tools/ and it may be necessary to make a symlink to it in
android-sdk/platform-tools/
</li></ul>

<p>If you intend to build applications from source you&rsquo;ll also need most, if not
all, of the following:
</p>
<ul>
<li> JDK (Debian package openjdk-6-jdk): openjdk-6 is recommended though openjdk-7
should work too
</li><li> VCS clients: svn, git, git-svn, hg, bzr
</li><li> A keystore for holding release keys. (Safe, secure and well backed up!)
</li></ul>

<p>If you intend to use the &rsquo;Build Server&rsquo; system, for secure and clean builds
(highly recommended), you will also need:
</p>
<ul>
<li> VirtualBox (debian package virtualbox)
</li><li> Ruby (debian packages ruby and rubygems)
</li><li> Vagrant (unpackaged) Be sure to use 1.3.x because 1.4.x is completely broken
(at the time of writing, the forthcoming 1.4.3 might work)
</li><li> Paramiko (debian package python-paramiko)
</li><li> Imaging (debian package python-imaging)
</li><li> Magic (debian package python-magic)
</li></ul>

<p>On the other hand, if you want to build the apps directly on your system
without the &rsquo;Build Server&rsquo; system, you may need:
</p>
<ul>
<li> All SDK platforms requested by the apps you want to build
(The Android SDK is made available by Google under a proprietary license but
within that, the SDK platforms, support library and some other components are
under the Apache license and source code is provided.
Google APIs, used for building apps using Google Maps, are free to the extent
that the library comes pre-installed on the device.
Google Play Services, Google Admob and others are proprietary and shouldn&rsquo;t be
included in the main F-Droid repository.)
</li><li> A version of the Android NDK
</li><li> Ant with Contrib Tasks (Debian packages ant and ant-contrib)
</li><li> Maven (Debian package maven)
</li><li> JavaCC (Debian package javacc)
</li><li> Miscellaneous packages listed in
buildserver/cookbooks/fdroidbuild-general/recipes/default.rb
of the F-Droid server repository
</li></ul>

<hr>
<a name="Setup"></a>
<div class="header">
<p>
Next: <a href="#Simple-Binary-Repository" accesskey="n" rel="next">Simple Binary Repository</a>, Previous: <a href="#System-Requirements" accesskey="p" rel="prev">System Requirements</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Setup-1"></a>
<h2 class="chapter">3 Setup</h2>

<a name="index-setup_002c-installation"></a>

<p>Because the tools and data will always change rapidly, you will almost
certainly want to work from a git clone of the tools at this stage. To
get started:
</p>
<div class="example">
<pre class="example">git clone https://gitlab.com/fdroid/fdroidserver.git
</pre></div>

<p>You now have lots of stuff in the fdroidserver directory, but the most
important is the &rsquo;fdroid&rsquo; command script which you run to perform all tasks.
This script is always run from a repository data directory, so the
most sensible thing to do next is to put your new fdroidserver directory
in your <code>PATH</code>.
</p>
<a name="Data"></a>
<h3 class="section">3.1 Data</h3>

<p>To do anything, you&rsquo;ll need at least one repository data directory. It&rsquo;s
from this directory that you run the <code>fdroid</code> command to perform all
repository management tasks. You can either create a brand new one, or
grab a copy of the data used by the main F-Droid repository:
</p>
<div class="example">
<pre class="example">git clone https://gitlab.com/fdroid/fdroiddata.git
</pre></div>

<p>Regardless of the intended usage of the tools, you will always need to set
up some basic configuration details. This is done by creating a file called
<code>config.py</code> in the data directory. You should do this by copying the
example file (<code>config.sample.py</code>) from the fdroidserver project to your
data directory and then editing according to the instructions within.
</p>
<p>Once configured in this way, all the functionality of the tools is accessed
by running the <code>fdroid</code> command. Run it on its own to get a list of the
available sub-commands.
</p>
<p>You can follow any command with <code>--help</code> to get a list of additional
options available for that command.
</p>
<div class="example">
<pre class="example">fdroid update --help
</pre></div>


<hr>
<a name="Simple-Binary-Repository"></a>
<div class="header">
<p>
Next: <a href="#Building-Applications" accesskey="n" rel="next">Building Applications</a>, Previous: <a href="#Setup" accesskey="p" rel="prev">Setup</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Simple-Binary-Repository-1"></a>
<h2 class="chapter">4 Simple Binary Repository</h2>

<a name="index-binary"></a>

<p>If you want to maintain a simple repository hosting only binary APKs obtained
and compiled elsewhere, the process is quite simple:
</p>
<ol>
<li> Set up the server tools, as described in Setup.
</li><li> Make a directory for your repository. This is the directory from which you
will do all the work with your repository. Create a config file there, called
<code>config.py</code>, by copying the <code>config.sample.py</code> from the server
project and editing it.
</li><li> Within that, make a directory called <code>repo</code> and put APK files in it.
</li><li> Run <code>fdroid update</code>.
</li><li> If it reports that any metadata files are missing, you can create them
in the <code>metadata</code> directory and run it again.
</li><li> To ease creation of metadata files, run <code>fdroid update</code> with the <code>-c</code>
option. It will create &rsquo;skeleton&rsquo; metadata files that are missing, and you can
then just edit them and fill in the details.
</li><li> Then, if you&rsquo;ve changed things, run <code>fdroid update</code> again.
</li><li> Running <code>fdroid update</code> adds an Icons directory into the repo directory,
and also creates the repository index (index.xml, and also index.jar if you&rsquo;ve
configured the system to use a signed index).
</li><li> Publish the resulting contents of the <code>repo</code> directory to your web server.
</li></ol>

<p>Following the above process will result in a <code>repo</code> directory, which you
simply need to push to any HTTP (or preferably HTTPS) server to make it
accessible.
</p>
<p>While some information about the applications (and versions thereof) is
retrieved directly from the APK files, most comes from the corresponding file
in the <code>metadata</code> directory. The metadata file covering ALL versions of a
particular application is named <code>package.id.txt</code> where package.id is the
unique identifier for that package.
</p>
<p>See the Metadata chapter for details of what goes in the metadata file. All
fields are relevant for binary APKs, EXCEPT for <code>Build:</code> entries, which
should be omitted.
</p>

<hr>
<a name="Building-Applications"></a>
<div class="header">
<p>
Next: <a href="#Importing-Applications" accesskey="n" rel="next">Importing Applications</a>, Previous: <a href="#Simple-Binary-Repository" accesskey="p" rel="prev">Simple Binary Repository</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Building-Applications-1"></a>
<h2 class="chapter">5 Building Applications</h2>

<p>Instead of (or as well as) including binary APKs from external sources in a
repository, you can build them directly from the source code.
</p>
<p>Using this method, it is is possible to verify that the application builds
correctly, corresponds to the source code, and contains only free software.
Unforunately, in the Android world, it seems to be very common for an
application supplied as a binary APK to present itself as Free Software
when in fact some or all of the following are true:
</p>
<ol>
<li> The source code (either for a particular version, or even all versions!) is
unavailable or incomplete.
</li><li> The source code is not capable of producing the actual binary supplied.
</li><li> The &rsquo;source code&rsquo; contains binary files of unknown origin, or with proprietary
licenses.
</li></ol>

<p>For this reason, source-built applications are the preferred method for the
main F-Droid repository, although occasionally for technical or historical
reasons, exceptions are made to this policy.
</p>
<p>When building applications from source, it should be noted that you will be
signing them (all APK files must be signed to be installable on Android) with
your own key. When an application is already installed on a device, it is not
possible to upgrade it in place to a new version signed with a different key
without first uninstalling the original. This may present an inconvenience to
users, as the process of uninstalling loses any data associated with the
previous installation.
</p>
<p>The process for managing a repository for built-from-source applications is
very similar to that described in the Simple Binary Repository chapter,
except now you need to:
</p>
<ol>
<li> Include Build entries in the metadata files.
</li><li> Run <code>fdroid build</code> to build any applications that are not already built.
</li><li> Run <code>fdroid publish</code> to finalise packaging and sign any APKs that have
been built.
</li></ol>


<a name="More-about-_0022fdroid-build_0022"></a>
<h3 class="section">5.1 More about &quot;fdroid build&quot;</h3>

<p>When run without any parameters, <code>fdroid build</code> will build any and all
versions of applications that you don&rsquo;t already have in the <code>repo</code>
directory (or more accurately, the <code>unsigned</code> directory). There are various
other things you can do. As with all the tools, the <code>--help</code> option is
your friend, but a few annotated examples and discussion of the more common
usage modes follows:
</p>
<p>To build a single version of a single application, you could run the
following:
</p>
<div class="example">
<pre class="example">./fdroid build org.fdroid.fdroid:16
</pre></div>

<p>This attempts to build version code 16 (which is version 0.25) of the F-Droid
client. Many of the tools recognise arguments as packages, allowing their
activity to be limited to just a limited set of packages.
</p>
<p>If the build above was successful, two files will have been placed in the
<code>unsigned</code> directory:
</p>
<div class="example">
<pre class="example">org.fdroid.fdroid_16.apk
org.fdroid.fdroid_16_src.tar.gz
</pre></div>

<p>The first is the (unsigned) APK. You could sign this with a debug key and push
it direct to your device or an emulator for testing. The second is a source
tarball containing exactly the source that was used to generate the binary.
</p>
<p>If you were intending to publish these files, you could then run:
</p>
<div class="example">
<pre class="example">./fdroid publish
</pre></div>

<p>The source tarball would move to the <code>repo</code> directory (which is the
directory you would push to your web server). A signed and zip-aligned version
of the APK would also appear there, and both files would be removed from the
<code>unsigned</code> directory.
</p>
<p>If you&rsquo;re building purely for the purposes of testing, and not intending to
push the results to a repository, at least yet, the <code>--test</code> option can be
used to direct output to the <code>tmp</code> directory instead of <code>unsigned</code>.
A similar effect could by achieved by simply deleting the output files from
<code>unsigned</code> after the build, but with the risk of forgetting to do so!
</p>
<p>Along similar lines (and only in conjunction with <code>--test</code>, you can use
<code>--force</code> to force a build of a Disabled application, where normally it
would be completely ignored. Similarly a version that was found to contain
ELFs or known non-free libraries can be forced to build. See also —
<code>scanignore=</code> and <code>scandelete=</code> in the <code>Build:</code> section.
</p>
<p>If the build was unsuccessful, you can find out why by looking at the output
in the logs/ directory. If that isn&rsquo;t illuminating, try building the app the
regular way, step by step: android update project, ndk-build, ant debug.
</p>
<p>Note that source code repositories often contain prebuilt libraries. If the
app is being considered for the main F-Droid repository, it is important that
all such prebuilts are built either via the metadata or by a reputable third
party.
</p>

<a name="Direct-Installation"></a>
<h3 class="section">5.2 Direct Installation</h3>

<p>You can also build and install directly to a connected device or emulator
using the <code>fdroid install</code> command. If you do this without passing
packages as arguments then all the latest built and signed version available
of each package will be installed . In most cases, this will not be what you
want to do, so execution will stop straight away. However, you can override
this if you&rsquo;re sure that&rsquo;s what you want, by using <code>--all</code>.  Note that
currently, no sanity checks are performed with this mode, so if the files in
the signed output directory were modified, you won&rsquo;t be notified.
</p>

<hr>
<a name="Importing-Applications"></a>
<div class="header">
<p>
Next: <a href="#Metadata" accesskey="n" rel="next">Metadata</a>, Previous: <a href="#Building-Applications" accesskey="p" rel="prev">Building Applications</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Importing-Applications-1"></a>
<h2 class="chapter">6 Importing Applications</h2>

<p>To help with starting work on including a new application, <code>fdroid import</code>
will take a URL and optionally some other parameters, and attempt to construct
as much information as possible by analysing the source code. Basic usage is:
</p>
<div class="example">
<pre class="example">./fdroid import --url=http://address.of.project
</pre></div>

<p>For this to work, the URL must point to a project format that the script
understands. Currently this is limited to one of the following:
</p>
<ol>
<li> Gitorious - <code>https://gitorious.org/PROJECTNAME/REPONAME</code>
</li><li> Github - <code>https://github.com/USER/PROJECT</code>
</li><li> Google Code - <code>http://code.google.com/p/PROJECT/</code>
Supports git, svn and hg repos.

<p>Some Google Code projects have multiple repositories, identified by a
dropdown list on the <code>source/checkout</code> page. To access one other than
the default, specify its name using the <code>--repo</code> switch.
</p></li><li> Bitbucket - <code>https://bitbucket.org/USER/PROJECT/</code>
</li><li> Git - <code>git://REPO</code>
</li></ol>

<p>Depending on the project type, more or less information may be gathered. For
example, the license will be retrieved from a Google Code project, but not a
GitHub one. A bare repo url, such as the git:// one, is the least preferable
optional of all, since you will have to enter much more information manually.
</p>
<p>If the import is successful, a metadata file will be created. You will need to
edit this further to check the information, and fill in the blanks.
</p>
<p>If it fails, you&rsquo;ll be told why. If it got as far as retrieving the source
code, you can inspect it further by looking in <code>tmp/importer</code> where a full
checkout will exist.
</p>
<p>A frequent cause of initial failure is that the project directory is actually
a subdirectory in the repository. In this case, run the importer again using
the <code>--subdir</code> option to tell it where. It will not attempt to determine
this automatically, since there may be several options.
</p>

<hr>
<a name="Metadata"></a>
<div class="header">
<p>
Next: <a href="#Update-Processing" accesskey="n" rel="next">Update Processing</a>, Previous: <a href="#Importing-Applications" accesskey="p" rel="prev">Importing Applications</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Metadata-1"></a>
<h2 class="chapter">7 Metadata</h2>

<a name="index-metadata"></a>

<p>Information used by update.py to compile the public index comes from two
sources:
</p>
<ol>
<li> the APK files in the repo directory, and
</li><li> the metadata files in the metadata directory.
</li></ol>

<p>The metadata files are simple, easy to edit text files, always named as the
application&rsquo;s package ID with &rsquo;.txt&rsquo; appended.
</p>
<p>Note that although the metadata files are designed to be easily read and
writable by humans, they are also processed and written by various scripts.
They are capable of rewriting the entire file when necessary. Even so,
the structure and comments will be preserved correctly, although the order
of fields will be standardised. (In the event that the original file was
in a different order, comments are considered as being attached to the field
following them). In fact, you can standardise all the metadata in a single
command, without changing the functional content, by running:
</p>
<div class="example">
<pre class="example">fdroid rewritemetadata
</pre></div>

<p>The following sections describe the fields recognised within the file.
</p>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top">&bull; <a href="#Categories" accesskey="1">Categories</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="#License" accesskey="2">License</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="#Auto-Name" accesskey="3">Auto Name</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="#Name" accesskey="4">Name</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="#Provides" accesskey="5">Provides</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="#Web-Site" accesskey="6">Web Site</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="#Source-Code" accesskey="7">Source Code</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="#Issue-Tracker" accesskey="8">Issue Tracker</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="#Donate" accesskey="9">Donate</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="#FlattrID">FlattrID</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="#Bitcoin">Bitcoin</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="#Litecoin">Litecoin</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="#Summary">Summary</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="#Description">Description</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="#Maintainer-Notes">Maintainer Notes</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="#Repo-Type">Repo Type</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="#Repo">Repo</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="#Build">Build</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="#AntiFeatures">AntiFeatures</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="#Disabled">Disabled</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="#Requires-Root">Requires Root</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="#Archive-Policy">Archive Policy</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="#Update-Check-Mode">Update Check Mode</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="#Update-Check-Ignore">Update Check Ignore</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="#Vercode-Operation">Vercode Operation</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="#Update-Check-Data">Update Check Data</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="#Auto-Update-Mode">Auto Update Mode</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="#Current-Version">Current Version</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="#Current-Version-Code">Current Version Code</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="#No-Source-Since">No Source Since</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
</table>

<hr>
<a name="Categories"></a>
<div class="header">
<p>
Next: <a href="#License" accesskey="n" rel="next">License</a>, Up: <a href="#Metadata" accesskey="u" rel="up">Metadata</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Categories-1"></a>
<h3 class="section">7.1 Categories</h3>

<p>Any number of categories for the application to be placed in. There is no
fixed list of categories - both the client and the web site will automatically
show any categories that exist in any applications. However, if your metadata
is intended for the main F-Droid repository, you should use one of the
existing categories (look at the site/client), or discuss the proposal to add
a new one.
</p>
<p>Categories must be separated by a single comma character, &rsquo;,&rsquo;. For backwards
compatibility, F-Droid will use the first category given as &lt;category&gt; element
for older clients to at least see one category.
</p>
<p>This is converted to (<code>&lt;categories&gt;</code>) in the public index file.
</p>
<hr>
<a name="License"></a>
<div class="header">
<p>
Next: <a href="#Auto-Name" accesskey="n" rel="next">Auto Name</a>, Previous: <a href="#Categories" accesskey="p" rel="prev">Categories</a>, Up: <a href="#Metadata" accesskey="u" rel="up">Metadata</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="License-1"></a>
<h3 class="section">7.2 License</h3>

<a name="index-license"></a>

<p>The overall license for the application, or in certain cases, for the
source code only.
</p>
<p>Common values:
</p>
<ul>
<li> &lsquo;<samp>GPLv2</samp>&rsquo;
GNU GPL version 2

</li><li> &lsquo;<samp>GPLv2+</samp>&rsquo;
GNU GPL version 2 or later

</li><li> &lsquo;<samp>GPLv3</samp>&rsquo;
GNU GPL version 3

</li><li> &lsquo;<samp>GPLv3+</samp>&rsquo;
GNU GPL version 3 or later

</li><li> &lsquo;<samp>GPL</samp>&rsquo;
An unspecified GPL version. Use this only as a last resort or if there is
some confusion over compatiblity of component licenses: particularly the use of
Apache libraries with GPLv2 source code.

</li><li> &lsquo;<samp>AGPL</samp>&rsquo;
Afferro GPL version 3.

</li><li> &lsquo;<samp>Apache2</samp>&rsquo;
Apache 2

</li><li> &lsquo;<samp>MIT</samp>&rsquo;
MIT X11 license

</li><li> &lsquo;<samp>BSD</samp>&rsquo;
BSD license - the original &rsquo;4-clause&rsquo; version.

</li><li> &lsquo;<samp>NewBSD</samp>&rsquo;
BSD license - the new, or modified, version.

</li></ul>

<p>This is converted to (<code>&lt;license&gt;</code>) in the public index file.
</p>
<hr>
<a name="Auto-Name"></a>
<div class="header">
<p>
Next: <a href="#Name" accesskey="n" rel="next">Name</a>, Previous: <a href="#License" accesskey="p" rel="prev">License</a>, Up: <a href="#Metadata" accesskey="u" rel="up">Metadata</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Auto-Name-1"></a>
<h3 class="section">7.3 Auto Name</h3>

<a name="index-Auto-Name"></a>

<p>The name of the application as can best be retrieved from the source code.
This is done so that the commitupdates script can put a familiar name in the
description of commits created when a new update of the application is
found. The Auto Name entry is generated automatically when <code>fdroid
checkupdates</code> is run.
</p>
<hr>
<a name="Name"></a>
<div class="header">
<p>
Next: <a href="#Provides" accesskey="n" rel="next">Provides</a>, Previous: <a href="#Auto-Name" accesskey="p" rel="prev">Auto Name</a>, Up: <a href="#Metadata" accesskey="u" rel="up">Metadata</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Name-1"></a>
<h3 class="section">7.4 Name</h3>

<a name="index-Name"></a>

<p>The name of the application. Normally, this field should not be present since
the application&rsquo;s correct name is retrieved from the APK file. However, in a
situation where an APK contains a bad or missing application name, it can be
overridden using this. Note that this only overrides the name in the list of
apps presented in the client; it doesn&rsquo;t changed the name or application label
in the source code.
</p>
<hr>
<a name="Provides"></a>
<div class="header">
<p>
Next: <a href="#Web-Site" accesskey="n" rel="next">Web Site</a>, Previous: <a href="#Name" accesskey="p" rel="prev">Name</a>, Up: <a href="#Metadata" accesskey="u" rel="up">Metadata</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Provides-1"></a>
<h3 class="section">7.5 Provides</h3>

<a name="index-Provides"></a>

<p>Comma-separated list of application IDs that this app provides. In other
words, if the user has any of these apps installed, F-Droid will show this app
as installed instead. It will also appear if the user clicks on urls linking
to the other app IDs. Useful when an app switches package name, or when you
want an app to act as multiple apps.
</p>
<hr>
<a name="Web-Site"></a>
<div class="header">
<p>
Next: <a href="#Source-Code" accesskey="n" rel="next">Source Code</a>, Previous: <a href="#Provides" accesskey="p" rel="prev">Provides</a>, Up: <a href="#Metadata" accesskey="u" rel="up">Metadata</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Web-Site-1"></a>
<h3 class="section">7.6 Web Site</h3>

<a name="index-Web-Site"></a>

<p>The URL for the application&rsquo;s web site. If there is no relevant web site, this
can be omitted (or left blank).
</p>
<p>This is converted to (<code>&lt;web&gt;</code>) in the public index file.
</p>
<hr>
<a name="Source-Code"></a>
<div class="header">
<p>
Next: <a href="#Issue-Tracker" accesskey="n" rel="next">Issue Tracker</a>, Previous: <a href="#Web-Site" accesskey="p" rel="prev">Web Site</a>, Up: <a href="#Metadata" accesskey="u" rel="up">Metadata</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Source-Code-1"></a>
<h3 class="section">7.7 Source Code</h3>

<a name="index-Source-Code"></a>

<p>The URL to view or obtain the application&rsquo;s source code. This should be
something human-friendly. Machine-readable source-code is covered in the
&rsquo;Repo&rsquo; field.
</p>
<p>This is converted to (<code>&lt;source&gt;</code>) in the public index file.
</p>
<hr>
<a name="Issue-Tracker"></a>
<div class="header">
<p>
Next: <a href="#Donate" accesskey="n" rel="next">Donate</a>, Previous: <a href="#Source-Code" accesskey="p" rel="prev">Source Code</a>, Up: <a href="#Metadata" accesskey="u" rel="up">Metadata</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Issue-Tracker-1"></a>
<h3 class="section">7.8 Issue Tracker</h3>

<a name="index-Issue-Tracker"></a>

<p>The URL for the application&rsquo;s issue tracker. Optional, since not all
applications have one.
</p>
<p>This is converted to (<code>&lt;tracker&gt;</code>) in the public index file.
</p>
<hr>
<a name="Donate"></a>
<div class="header">
<p>
Next: <a href="#FlattrID" accesskey="n" rel="next">FlattrID</a>, Previous: <a href="#Issue-Tracker" accesskey="p" rel="prev">Issue Tracker</a>, Up: <a href="#Metadata" accesskey="u" rel="up">Metadata</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Donate-1"></a>
<h3 class="section">7.9 Donate</h3>

<a name="index-Donate"></a>

<p>The URL to donate to the project. This should be the project&rsquo;s donate page
if it has one.
</p>
<p>It is possible to use a direct PayPal link here, if that is all that is
available. However, bear in mind that the developer may not be aware of
that direct link, and if they later changed to a different PayPal account,
or the PayPal link format changed, things could go wrong. It is always
best to use a link that the developer explicitly makes public, rather than
something that is auto-generated &rsquo;button code&rsquo;.
</p>
<p>This is converted to (<code>&lt;donate&gt;</code>) in the public index file.
</p>
<hr>
<a name="FlattrID"></a>
<div class="header">
<p>
Next: <a href="#Bitcoin" accesskey="n" rel="next">Bitcoin</a>, Previous: <a href="#Donate" accesskey="p" rel="prev">Donate</a>, Up: <a href="#Metadata" accesskey="u" rel="up">Metadata</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="FlattrID-1"></a>
<h3 class="section">7.10 FlattrID</h3>

<a name="index-FlattrID"></a>

<p>The project&rsquo;s Flattr (http://flattr.com) ID, if it has one. This should be
a numeric ID, such that (for example) https://flattr.com/thing/xxxx leads
directly to the page to donate to the project.
</p>
<p>This is converted to (<code>&lt;flattr&gt;</code>) in the public index file.
</p>
<hr>
<a name="Bitcoin"></a>
<div class="header">
<p>
Next: <a href="#Litecoin" accesskey="n" rel="next">Litecoin</a>, Previous: <a href="#FlattrID" accesskey="p" rel="prev">FlattrID</a>, Up: <a href="#Metadata" accesskey="u" rel="up">Metadata</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Bitcoin-1"></a>
<h3 class="section">7.11 Bitcoin</h3>

<a name="index-Bitcoin"></a>

<p>A bitcoin address for donating to the project.
</p>
<p>This is converted to (<code>&lt;bitcoin&gt;</code>) in the public index file.
</p>
<hr>
<a name="Litecoin"></a>
<div class="header">
<p>
Next: <a href="#Summary" accesskey="n" rel="next">Summary</a>, Previous: <a href="#Bitcoin" accesskey="p" rel="prev">Bitcoin</a>, Up: <a href="#Metadata" accesskey="u" rel="up">Metadata</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Litecoin-1"></a>
<h3 class="section">7.12 Litecoin</h3>

<a name="index-Litecoin"></a>

<p>A litecoin address for donating to the project.
</p>
<hr>
<a name="Summary"></a>
<div class="header">
<p>
Next: <a href="#Description" accesskey="n" rel="next">Description</a>, Previous: <a href="#Litecoin" accesskey="p" rel="prev">Litecoin</a>, Up: <a href="#Metadata" accesskey="u" rel="up">Metadata</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Summary-1"></a>
<h3 class="section">7.13 Summary</h3>

<a name="index-Summary"></a>

<p>A brief summary of what the application is. Since the summary is only allowed
one line on the list of the F-Droid client, keeping it to within 50 characters
will ensure it fits most screens.
</p>
<hr>
<a name="Description"></a>
<div class="header">
<p>
Next: <a href="#Maintainer-Notes" accesskey="n" rel="next">Maintainer Notes</a>, Previous: <a href="#Summary" accesskey="p" rel="prev">Summary</a>, Up: <a href="#Metadata" accesskey="u" rel="up">Metadata</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Description-1"></a>
<h3 class="section">7.14 Description</h3>

<a name="index-Description"></a>

<p>A full description of the application, relevant to the latest version.
This can span multiple lines (which should be kept to a maximum of 80
characters), and is terminated by a line containing a single &rsquo;.&rsquo;.
</p>
<p>Basic MediaWiki-style formatting can be used. Leaving a blank line starts a
new paragraph. Surrounding text with <code>''</code> make it italic, and with
<code>'''</code> makes it bold.
</p>
<p>You can link to another app in the repo by using <code>[[app.id]]</code>. The link
will be made appropriately whether in the Android client, the web repo
browser or the wiki. The link text will be the apps name.
</p>
<p>Links to web addresses can be done using <code>[http://example.com Text]</code>.
</p>
<p>For both of the above link formats, the entire link (from opening to closing
square bracket) must be on the same line.
</p>
<p>Bulletted lists are done by simply starting each item with a <code>*</code> on
a new line, and numbered lists are the same but using <code>#</code>. There is
currently no support for nesting lists - you can have one level only.
</p>
<p>It can be helpful to note information pertaining to updating from an
earlier version; whether the app contains any prebuilts built by the
upstream developers or whether non-free elements were removed; whether the
app is in rapid development or whether the latest version lags behind the
current version; whether the app supports multiple architectures or whether
there is a maximum SDK specified (such info not being recorded in the index).
</p>
<p>This is converted to (<code>&lt;desc&gt;</code>) in the public index file.
</p>
<hr>
<a name="Maintainer-Notes"></a>
<div class="header">
<p>
Next: <a href="#Repo-Type" accesskey="n" rel="next">Repo Type</a>, Previous: <a href="#Description" accesskey="p" rel="prev">Description</a>, Up: <a href="#Metadata" accesskey="u" rel="up">Metadata</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Maintainer-Notes-1"></a>
<h3 class="section">7.15 Maintainer Notes</h3>

<a name="index-Maintainer-Notes"></a>

<p>This is a multi-line field using the same rules and syntax as the description.
It&rsquo;s used to record notes for F-Droid maintainers to assist in maintaining and
updating the application in the repository.
</p>
<p>This information is also published to the wiki.
</p>
<hr>
<a name="Repo-Type"></a>
<div class="header">
<p>
Next: <a href="#Repo" accesskey="n" rel="next">Repo</a>, Previous: <a href="#Maintainer-Notes" accesskey="p" rel="prev">Maintainer Notes</a>, Up: <a href="#Metadata" accesskey="u" rel="up">Metadata</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Repo-Type-1"></a>
<h3 class="section">7.16 Repo Type</h3>

<a name="index-Repo-Type"></a>

<p>The type of repository - for automatic building from source. If this is not
specified, automatic building is disabled for this application. Possible
values are:
</p>
<ul>
<li> &lsquo;<samp>git</samp>&rsquo;
</li><li> &lsquo;<samp>svn</samp>&rsquo;
</li><li> &lsquo;<samp>git-svn</samp>&rsquo;
</li><li> &lsquo;<samp>hg</samp>&rsquo;
</li><li> &lsquo;<samp>bzr</samp>&rsquo;
</li><li> &lsquo;<samp>srclib</samp>&rsquo;
</li></ul>
<hr>
<a name="Repo"></a>
<div class="header">
<p>
Next: <a href="#Build" accesskey="n" rel="next">Build</a>, Previous: <a href="#Repo-Type" accesskey="p" rel="prev">Repo Type</a>, Up: <a href="#Metadata" accesskey="u" rel="up">Metadata</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Repo-1"></a>
<h3 class="section">7.17 Repo</h3>

<a name="index-Repo"></a>

<p>The repository location. Usually a git: or svn: URL, for example.
</p>
<p>The git-svn option connects to an SVN repository, and you specify the URL in
exactly the same way, but git is used as a back-end. This is preferable for
performance reasons, and also because a local copy of the entire history is
available in case the upstream repository disappears. (It happens!). In
order to use Tags as update check mode for this VCS type, the URL must have
the tags= special argument set. Likewise, if you intend to use the
RepoManifest/branch scheme, you would want to specify branches= as well.
Finally, trunk= can also be added. All these special arguments will be passed
to &quot;git svn&quot; in order, and their values must be relative paths to the svn repo
root dir.
Here&rsquo;s an example of a complex git-svn Repo URL:
http://svn.code.sf.net/p/project/code/svn;trunk=trunk;tags=tags;branches=branches
</p>
<p>For a Subversion repo that requires authentication, you can precede the repo
URL with username:password&nbsp;and those parameters will be passed as <samp>--username</samp>
and <samp>--password</samp> to the SVN checkout command. (This now works for both
svn and git-svn)
</p>
<p>If the Repo Type is <code>srclib</code>, then you must specify the name of the
according srclib .txt file. For example if <code>scrlibs/FooBar.txt</code> exist
and you want to use this srclib, then you have to set Repo to
<code>FooBar</code>.
</p>
<hr>
<a name="Build"></a>
<div class="header">
<p>
Next: <a href="#AntiFeatures" accesskey="n" rel="next">AntiFeatures</a>, Previous: <a href="#Repo" accesskey="p" rel="prev">Repo</a>, Up: <a href="#Metadata" accesskey="u" rel="up">Metadata</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Build-1"></a>
<h3 class="section">7.18 Build</h3>

<a name="index-Build"></a>

<p>Any number of these fields can be present, each specifying a version to
automatically build from source. The value is a comma-separated list.
For example:
</p>
<p>&lsquo;<samp>Build:1.2,12</samp>&rsquo;
</p>
<p>The above specifies to build version 1.2, which has a version code of 12.
The <code>commit=</code> parameter specifies the tag, commit or revision number from
which to build it in the source repository. It is the only mandatory flag,
which in this case could for example be <code>commit=v1.2</code>.
</p>
<p>In addition to the three, always required, parameters described above,
further parameters can be added (in name=value format) to apply further
configuration to the build. These are (roughly in order of application):
</p>
<dl compact="compact">
<dt><code>disable=&lt;message&gt;</code></dt>
<dd><p>Disables this build, giving a reason why. (For backwards compatibility, this
can also be achieved by starting the commit ID with &rsquo;!&rsquo;)
</p>
<p>The purpose of this feature is to allow non-buildable releases (e.g. the source
is not published) to be flagged, so the scripts don&rsquo;t generate repeated
messages about them. (And also to record the information for review later).
If an apk has already been built, disabling causes it to be deleted once
<code>fdroid update</code> is run; this is the procedure if ever a version has to
be replaced.
</p>
</dd>
<dt><code>subdir=&lt;path&gt;</code></dt>
<dd><p>Specifies to build from a subdirectory of the checked out source code.
Normally this directory is changed to before building,
</p>
</dd>
<dt><code>submodules=yes</code></dt>
<dd><p>Use if the project (git only) has submodules - causes <code>git submodule
update --init --recursive</code> to be executed after the source is cloned.
Submodules are reset and cleaned like the main app repository itself before
each build.
</p>
</dd>
<dt><code>init=xxxx</code></dt>
<dd><p>As for &rsquo;prebuild&rsquo;, but runs on the source code BEFORE any other processing
takes place.
</p>
<p>You can use $$SDK$$, $$NDK$$ and $$MVN3$$ to substitute the paths to the
android SDK and NDK directories, and maven 3 executable respectively.
</p>
</dd>
<dt><code>oldsdkloc=yes</code></dt>
<dd><p>The sdk location in the repo is in an old format, or the build.xml is
expecting such. The &rsquo;new&rsquo; format is sdk.dir while the VERY OLD format
is sdk-location. Typically, if you get a message along the lines of:
&quot;com.android.ant.SetupTask cannot be found&quot; when trying to build, then
try enabling this option.
</p>
</dd>
<dt><code>target=&lt;target&gt;</code></dt>
<dd><p>Specifies a particular SDK target for compilation, overriding the value
defined in the code by upstream.  This has different effects depending on what
build system used — this flag currently affects Ant, Maven and Gradle projects
only. Note that this does not change the target SDK in the
AndroidManifest.xml, which determines the level of features that can be
included in the build.
</p>
<p>In the case of an Ant project, it modifies project.properties of the app and
possibly sub-projects. This is likely to cause the whole build.xml to be
rewritten, which is fine if it&rsquo;s a &rsquo;standard&rsquo; android file or doesn&rsquo;t already
exist, but not a good idea if it&rsquo;s heavily customised.
</p>
</dd>
<dt><code>update=&lt;auto/dirs&gt;</code></dt>
<dd><p>By default, &rsquo;android update&rsquo; is used in Ant builds to generate or update the
project and all its referenced projects. Specifying update=no bypasses that.
Note that this is useless in builds that don&rsquo;t use Ant.
</p>
<p>Default value is &rsquo;<code>auto</code>&rsquo;, which recursively uses the paths in
project.properties to find all the subprojects to update.
</p>
<p>Otherwise, the value can be a comma-separated list of directories in which to
run &rsquo;android update&rsquo; relative to the application directory.
</p>
</dd>
<dt><code>encoding=xxxx</code></dt>
<dd><p>Adds a java.encoding property to local.properties with the given
value. Generally the value will be &rsquo;utf-8&rsquo;. This is picked up by the
SDK&rsquo;s ant rules, and forces the Java compiler to interpret source
files with this encoding. If you receive warnings during the compile
about character encodings, you probably need this.
</p>
</dd>
<dt><code>forceversion=yes</code></dt>
<dd><p>If specified, the package version in AndroidManifest.xml is replaced
with the version name for the build as specified in the metadata.
</p>
<p>This is useful for cases when upstream repo failed to update it for
specific tag; to build an arbitrary revision; to make it apparent that
the version differs significantly from upstream; or to make it apparent
which architecture or platform the apk is designed to run on.
</p>
</dd>
<dt><code>forcevercode=yes</code></dt>
<dd><p>If specified, the package version code in the AndroidManifest.xml is
replaced with the version code for the build. See also forceversion.
</p>
</dd>
<dt><code>rm=relpath1,relpath2,...</code></dt>
<dd><p>Specifies the relative paths of files or directories to delete before
the build is done. The paths are relative to the base of the build
directory - i.e. the root of the directory structure checked out from
the source respository - not necessarily the directory that contains
AndroidManifest.xml.
</p>
<p>Multiple files/directories can be specified by separating them with &rsquo;,&rsquo;.
Directories will be recursively deleted.
</p>
</dd>
<dt><code>extlibs=a,b,...</code></dt>
<dd><p>Comma-separated list of external libraries (jar files) from the
<code>build/extlib</code> library, which will be placed in the <code>libs</code> directory
of the project.
</p>
</dd>
<dt><code>srclibs=[n:]a@r,[n:]b@r1,...</code></dt>
<dd><p>Comma-separated list of source libraries or Android projects. Each item is of
the form name@rev where name is the predefined source library name and rev is
the revision or tag to use in the respective source control.
</p>
<p>For Ant projects, you can optionally append a number with a colon at the
beginning of a srclib item to automatically place it in project.properties as
a library under the specified number. For example, if you specify
<code>1:somelib@1.0</code>, f-droid will automatically do the equivalent of the
legacy practice <code>prebuild=echo &quot;android.library.reference.1=$$somelib$$&quot;
&gt;&gt; project.properties</code>.
</p>
<p>Each srclib has a metadata file under srclibs/ in the repository directory,
and the source code is stored in build/srclib/.
Repo Type: and Repo: are specified in the same way as for apps; Subdir: can be
a comma separated list, for when directories are renamed by upstream; Update
Project: updates the projects in the working directory and one level down;
Prepare: can be used for any kind of preparation: in particular if you need to
update the project with a particular target. You can then also use $$name$$ in
the init/prebuild/build command to substitute the relative path to the library
directory, but it could need tweaking if you&rsquo;ve changed into another directory.
</p>
</dd>
<dt><code>patch=x</code></dt>
<dd><p>Apply patch(es). &rsquo;x&rsquo; names one (or more - comma-seperated) files within a
directory below the metadata, with the same name as the metadata file but
without the extension. Each of these patches is applied to the code in turn.
</p>
</dd>
<dt><code>prebuild=xxxx</code></dt>
<dd><p>Specifies a shell command (or commands - chain with &amp;&amp;) to run before the
build takes place. Backslash can be used as an escape character to insert
literal commas, or as the last character on a line to join that line with the
next. It has no special meaning in other contexts; in particular, literal
backslashes should not be escaped.
</p>
<p>The command runs using bash.
</p>
<p>Note that nothing should be built during this prebuild phase - scanning of the
code and building of the source tarball, for example, take place after this.
For custom actions that actually build things or produce binaries, use &rsquo;build&rsquo;
instead.
</p>
<p>You can use $$name$$ to substitute the path to a referenced srclib - see
the <code>srclib</code> directory for details of this.
</p>
<p>You can use $$SDK$$, $$NDK$$ and $$MVN3$$ to substitute the paths to the
android SDK and NDK directories, and Maven 3 executable respectively e.g.
for when you need to run <code>android update project</code> explicitly.
</p>
</dd>
<dt><code>scanignore=path1,path2,...</code></dt>
<dd><p>Enables one or more files/paths to be excluded from the scan process.
This should only be used where there is a very good reason, and
probably accompanied by a comment explaining why it is necessary.
</p>
<p>When scanning the source tree for problems, matching files whose relative
paths start with any of the paths given here are ignored.
</p>
</dd>
<dt><code>scandelete=path1,path2,...</code></dt>
<dd><p>Similar to scanignore=, but instead of ignoring files under the given paths,
it tells f-droid to delete the matching files directly.
</p>
</dd>
<dt><code>build=xxxx</code></dt>
<dd><p>As for &rsquo;prebuild&rsquo;, but runs during the actual build phase (but before the
main Ant/Maven build). Use this only for actions that do actual building.
Any prepartion of the source code should be done using &rsquo;init&rsquo; or &rsquo;prebuild&rsquo;.
</p>
<p>Any building that takes place before build= will be ignored, as either Ant,
mvn or gradle will be executed to clean the build environment right before
build= (or the final build) is run.
</p>
<p>You can use $$SDK$$, $$NDK$$ and $$MVN3$$ to substitute the paths to the
android SDK and NDK directories, and Maven 3 executable respectively.
</p>
</dd>
<dt><code>buildjni=[yes|no|&lt;dir list&gt;]</code></dt>
<dd><p>Enables building of native code via the ndk-build script before doing
the main Ant build. The value may be a list of directories relative
to the main application directory in which to run ndk-build, or &rsquo;yes&rsquo;
which corresponds to &rsquo;.&rsquo; . Using explicit list may be useful to build
multi-component projects.
</p>
<p>The build and scan processes will complain (refuse to build) if this
parameter is not defined, but there is a <code>jni</code> directory present.
If the native code is being built by other means like a Gradle task, you
can specify <code>no</code> here to avoid that. However, if the native code is
actually not required or used, remove the directory instead (using
<code>rm=jni</code> for example). Using <code>buildjni=no</code> when the jni code
isn&rsquo;t used nor built will result in an error saying that native
libraries were expected in the resulting package.
</p>
</dd>
<dt><code>gradle=&lt;flavour&gt;</code></dt>
<dd><p>Build with Gradle instead of Ant, specifying what flavour to assemble.
If &lt;flavour&gt; is &rsquo;yes&rsquo; or &rsquo;main&rsquo;, no flavour will be used. Note
that this will not work on projects with flavours, since it will build
all flavours and there will be no &rsquo;main&rsquo; build.
</p>
</dd>
<dt><code>maven=yes[@&lt;dir&gt;]</code></dt>
<dd><p>Build with Maven instead of Ant. An extra @&lt;dir&gt; tells f-droid to run Maven
inside that relative subdirectory. Sometimes it is needed to use @.. so that
builds happen correctly.
</p>
</dd>
<dt><code>preassemble=&lt;task1&gt; &lt;task2&gt;</code></dt>
<dd><p>Space-separated list of Gradle tasks to be run before the assemble task
in a Gradle project build.
</p>
</dd>
<dt><code>antcommand=xxx</code></dt>
<dd><p>Specify an alternate Ant command (target) instead of the default
&rsquo;release&rsquo;. It can&rsquo;t be given any flags, such as the path to a build.xml.
</p>
</dd>
<dt><code>output=path/to/output.apk</code></dt>
<dd><p>To be used when app is built with a tool other than the ones natively
supported, like GNU Make. The given path will be where the build= set of
commands should produce the final unsigned release apk.
</p>
</dd>
<dt><code>novcheck=yes</code></dt>
<dd><p>Don&rsquo;t check that the version name and code in the resulting apk are
correct by looking at the build output - assume the metadata is
correct. This takes away a useful level of sanity checking, and should
only be used if the values can&rsquo;t be extracted.
</p>
</dd>
</dl>

<p>Another example, using extra parameters:
</p>
<p>&lsquo;<samp>Build Version:1.09.03,10903,45,subdir=Timeriffic,oldsdkloc=yes</samp>&rsquo;
</p>
<hr>
<a name="AntiFeatures"></a>
<div class="header">
<p>
Next: <a href="#Disabled" accesskey="n" rel="next">Disabled</a>, Previous: <a href="#Build" accesskey="p" rel="prev">Build</a>, Up: <a href="#Metadata" accesskey="u" rel="up">Metadata</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="AntiFeatures-1"></a>
<h3 class="section">7.19 AntiFeatures</h3>

<a name="index-AntiFeatures"></a>

<p>This is optional - if present, it contains a comma-separated list of any of
the following values, describing an anti-feature the application has.
Even though such apps won&rsquo;t be displayed unless a settings box is ticked,
it is a good idea to mention the reasons for the anti-feature(s) in the
description:
</p>
<ul>
<li> &lsquo;<samp>Ads</samp>&rsquo; - the application contains advertising.

</li><li> &lsquo;<samp>Tracking</samp>&rsquo; - the application tracks and reports your activity to
somewhere without your consent. It&rsquo;s commonly used for when developers
obtain crash logs without the user&rsquo;s consent, or when an app is useless
without some kind of authentication.

</li><li> &lsquo;<samp>NonFreeNet</samp>&rsquo; - the application relies on computational services that
are impossible to replace or that the replacement cannot be connected to
without major changes to the app.

</li><li> &lsquo;<samp>NonFreeAdd</samp>&rsquo; - the application promotes non-Free add-ons, such that the
app is effectively an advert for other non-free software and such software is
not clearly labelled as such.

</li><li> &lsquo;<samp>NonFreeDep</samp>&rsquo; - the application depends on a non-Free application (e.g.
Google Maps) - i.e. it requires it to be installed on the device, but does not
include it.

</li></ul>

<hr>
<a name="Disabled"></a>
<div class="header">
<p>
Next: <a href="#Requires-Root" accesskey="n" rel="next">Requires Root</a>, Previous: <a href="#AntiFeatures" accesskey="p" rel="prev">AntiFeatures</a>, Up: <a href="#Metadata" accesskey="u" rel="up">Metadata</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Disabled-1"></a>
<h3 class="section">7.20 Disabled</h3>

<a name="index-Disabled"></a>

<p>If this field is present, the application does not get put into the public
index. This allows metadata to be retained while an application is temporarily
disabled from being published. The value should be a description of why the
application is disabled. No apks or source code archives are deleted: to purge
an apk see the Build Version section or delete manually for developer builds.
The field is therefore used when an app has outlived it&rsquo;s usefulness, because
the source tarball is retained.
</p>
<hr>
<a name="Requires-Root"></a>
<div class="header">
<p>
Next: <a href="#Archive-Policy" accesskey="n" rel="next">Archive Policy</a>, Previous: <a href="#Disabled" accesskey="p" rel="prev">Disabled</a>, Up: <a href="#Metadata" accesskey="u" rel="up">Metadata</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Requires-Root-1"></a>
<h3 class="section">7.21 Requires Root</h3>

<a name="index-Requires-Root"></a>

<p>Set this optional field to &quot;Yes&quot; if the application requires root
privileges to be usable. This lets the client filter it out if the
user so desires. Whether root is required or not, it is good to give
a paragraph in the description to the conditions on which root may be
asked for and the reason for it.
</p>
<hr>
<a name="Archive-Policy"></a>
<div class="header">
<p>
Next: <a href="#Update-Check-Mode" accesskey="n" rel="next">Update Check Mode</a>, Previous: <a href="#Requires-Root" accesskey="p" rel="prev">Requires Root</a>, Up: <a href="#Metadata" accesskey="u" rel="up">Metadata</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Archive-Policy-1"></a>
<h3 class="section">7.22 Archive Policy</h3>

<a name="index-Archive-Policy"></a>

<p>This determines the policy for moving old versions of an app to the archive
repo, if one is configured. The configuration sets a default maximum number
of versions kept in the main repo, after which older ones are moved to the
archive. This app-specific policy setting can override that.
</p>
<p>Currently the only supported format is &quot;n versions&quot;, where n is the number
of versions to keep.
</p>
<hr>
<a name="Update-Check-Mode"></a>
<div class="header">
<p>
Next: <a href="#Vercode-Operation" accesskey="n" rel="next">Vercode Operation</a>, Previous: <a href="#Archive-Policy" accesskey="p" rel="prev">Archive Policy</a>, Up: <a href="#Metadata" accesskey="u" rel="up">Metadata</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Update-Check-Mode-1"></a>
<h3 class="section">7.23 Update Check Mode</h3>

<a name="index-Update-Check-Mode"></a>

<p>This determines the method using for determining when new releases are
available - in other words, the updating of the Current Version and Current
Version Code fields in the metadata by the <code>fdroid checkupdates</code> process.
</p>
<p>Valid modes are:
</p>
<ul>
<li> <code>None</code> - No checking is done because there&rsquo;s no appropriate automated way
of doing so. Updates should be checked for manually. Use this, for example,
when deploying betas or patched versions; when builds are done in a directory
different to where the AndroidManifest.xml is; if the developers use the
Gradle build system and store version info in a separate file; if the
developers make a new branch for each release and don&rsquo;t make tags; or if you&rsquo;ve
changed the package name or version code logic.
</li><li> <code>Static</code> - No checking is done - either development has ceased or new versions
are not desired. This method is also used when there is no other checking method
available and the upstream developer keeps us posted on new versions.
</li><li> <code>RepoManifest</code> - At the most recent commit, the AndroidManifest.xml file
is looked for in the directory where it was found in the the most recent build.
The appropriateness of this method depends on the development process used by
the application&rsquo;s developers. You should not specify this method unless you&rsquo;re
sure it&rsquo;s appropriate. For example, some developers bump the version when
commencing development instead of when publishing.
It will return an error if the AndroidManifest.xml has moved to a different
directory or if the package name has changed.
The current version that it gives may not be accurate, since not all
versions are fit to be published. Therefore, before building, it is often
necessary to check if the current version has been published somewhere by the
upstream developers, either by checking for apks that they distribute or for
tags in the source code repository.

<p>It currently works for every repository type to different extents, except
the srclib repo type. For git, git-svn and hg repo types, you may use
&quot;RepoManifest/yourbranch&quot; as UCM so that &quot;yourbranch&quot; would be the branch used
in place of the default one.  The default values are &quot;master&quot; for git,
&quot;default&quot; for hg and none for git-svn (it stays in the same branch).
On the other hand, branch support hasn&rsquo;t been implemented yet in bzr and svn,
but RepoManifest may still be used without it.
</p></li><li> <code>RepoTrunk</code> - For svn and git-svn repositories, especially those who
don&rsquo;t have a bundled AndroidManifest.xml file, the Tags and RepoManifest
checks will not work, since there is no version information to obtain. But,
for those apps who automate their build process with the commit ref that HEAD
points to, RepoTrunk will set the Current Version and Current Version Code to
that number.
</li><li> <code>Tags</code> - The AndroidManifest.xml file in all tagged revisions in the
source repository is checked, looking for the highest version code. The
appropriateness of this method depends on the development process used by the
application&rsquo;s developers. You should not specify this method unless you&rsquo;re sure
it&rsquo;s appropriate. It shouldn&rsquo;t be used if the developers like to tag betas or
are known to forget to tag releases. Like RepoManifest, it will not return the
correct value if the directory containing the AndroidManifest.xml has moved.
Despite these caveats, it is the often the favourite update check mode.

<p>It currently only works for git, hg, bzr and git-svn repositories. In the case
of the latter, the repo URL must contain the path to the trunk and tags or
else no tags will be found.
</p>
<p>Optionally append a regex pattern at the end - separated with a space - to
only check the tags matching said pattern. Useful when apps tag non-release
versions such as X.X-alpha, so you can filter them out with something like
<code>.*[0-9]$</code> which requires tag names to end with a digit.
</p></li><li> <code>HTTP</code> - HTTP requests are used to determine the current version code and
version name. This is controlled by the <code>Update Check Data</code> field, which
is of the form <code>urlcode|excode|urlver|exver</code>.

<p>Firstly, if <code>urlcode</code> is non-empty, the document from that URL is
retrieved, and matched against the regular expression <code>excode</code>, with the
first group becoming the version code.
</p>
<p>Secondly, if <code>urlver</code> is non-empty, the document from that URL is
retrieved, and matched against the regular expression <code>exver</code>, with the
first group becoming the version name. The <code>urlver</code> field can be set to
simply &rsquo;.&rsquo; which says to use the same document returned for the version code
again, rather than retrieving a different one.
</p></li></ul>

<hr>
<a name="Vercode-Operation"></a>
<div class="header">
<p>
Next: <a href="#Update-Check-Ignore" accesskey="n" rel="next">Update Check Ignore</a>, Previous: <a href="#Update-Check-Mode" accesskey="p" rel="prev">Update Check Mode</a>, Up: <a href="#Metadata" accesskey="u" rel="up">Metadata</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Vercode-Operation-1"></a>
<h3 class="section">7.24 Vercode Operation</h3>

<a name="index-Vercode-Operation"></a>

<p>Operation to be applied to the vercode obtained by the defined <code>Update
Check Mode</code>. <code>%c</code> will be replaced by the actual vercode, and the whole
string will be passed to python&rsquo;s <code>eval</code> function.
</p>
<p>Especially useful with apps that we want to compile for different ABIs, but
whose vercodes don&rsquo;t always have trailing zeros. For example, with
<code>Vercode Operation</code> set at something like <code>%c*10 + 4</code>, we will be
able to track updates and build up to four different versions of every
upstream version.
</p>
<hr>
<a name="Update-Check-Ignore"></a>
<div class="header">
<p>
Next: <a href="#Update-Check-Data" accesskey="n" rel="next">Update Check Data</a>, Previous: <a href="#Vercode-Operation" accesskey="p" rel="prev">Vercode Operation</a>, Up: <a href="#Metadata" accesskey="u" rel="up">Metadata</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Update-Check-Ignore-1"></a>
<h3 class="section">7.25 Update Check Ignore</h3>

<p>When checking for updates (via <code>Update Check Mode</code>) this can be used to
specify a regex which, if matched against the version name, causes that version
to be ignored. For example, &rsquo;beta&rsquo; could be specified to ignore version names
that include that text.
</p>
<hr>
<a name="Update-Check-Data"></a>
<div class="header">
<p>
Next: <a href="#Auto-Update-Mode" accesskey="n" rel="next">Auto Update Mode</a>, Previous: <a href="#Update-Check-Ignore" accesskey="p" rel="prev">Update Check Ignore</a>, Up: <a href="#Metadata" accesskey="u" rel="up">Metadata</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Update-Check-Data-1"></a>
<h3 class="section">7.26 Update Check Data</h3>

<a name="index-Update-Check-Data"></a>

<p>Used in conjunction with <code>Update Check Mode</code> for certain modes.
</p>
<hr>
<a name="Auto-Update-Mode"></a>
<div class="header">
<p>
Next: <a href="#Current-Version" accesskey="n" rel="next">Current Version</a>, Previous: <a href="#Update-Check-Data" accesskey="p" rel="prev">Update Check Data</a>, Up: <a href="#Metadata" accesskey="u" rel="up">Metadata</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Auto-Update-Mode-1"></a>
<h3 class="section">7.27 Auto Update Mode</h3>

<a name="index-Auto-Update-Mode"></a>

<p>This determines the method using for auto-generating new builds when new
releases are available - in other words, adding a new Build Version line to the
metadata.
This happens in conjunction with the &rsquo;Update Check Mode&rsquo; functionality - i.e.
when an update is detected by that, it is also processed by this.
</p>
<p>Valid modes are:
</p>
<ul>
<li> <code>None</code> - No auto-updating is done
</li><li> <code>Version</code> - Identifies the target commit (i.e. tag) for the new build based
on the given version specification, which is simply text in which %v and %c are
replaced with the required version name and version code respectively.

<p>For example, if an app always has a tag &quot;2.7.2&quot; corresponding to version 2.7.2,
you would simply specify &quot;Version %v&quot;. If an app always has a tag &quot;ver_1234&quot;
for a version with version code 1234, you would specify &quot;Version ver_%c&quot;.
</p>
<p>Additionally, a suffix can be added to the version name at this stage, to
differentiate F-Droid&rsquo;s build from the original. Continuing the first example
above, you would specify that as &quot;Version +-fdroid %v&quot; - &quot;-fdroid&quot; is the suffix.
</p></li></ul>


<hr>
<a name="Current-Version"></a>
<div class="header">
<p>
Next: <a href="#Current-Version-Code" accesskey="n" rel="next">Current Version Code</a>, Previous: <a href="#Auto-Update-Mode" accesskey="p" rel="prev">Auto Update Mode</a>, Up: <a href="#Metadata" accesskey="u" rel="up">Metadata</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Current-Version-1"></a>
<h3 class="section">7.28 Current Version</h3>

<a name="index-Current-Version"></a>

<p>The name of the version that is current. There may be newer versions of the
application than this (e.g. betas), and there will almost certainly be older
ones. This should be the one that is recommended for general use.
In the event that there is no source code for the current version, or that
non-free libraries are being used, this would ideally be the latest
version that is still free, though it may still be expedient to
retain the automatic update check — see No Source Since.
</p>
<p>This field is normally automatically updated - see Update Check Mode.
</p>
<p>This is converted to (<code>&lt;marketversion&gt;</code>) in the public index file.
</p>
<hr>
<a name="Current-Version-Code"></a>
<div class="header">
<p>
Next: <a href="#No-Source-Since" accesskey="n" rel="next">No Source Since</a>, Previous: <a href="#Current-Version" accesskey="p" rel="prev">Current Version</a>, Up: <a href="#Metadata" accesskey="u" rel="up">Metadata</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Current-Version-Code-1"></a>
<h3 class="section">7.29 Current Version Code</h3>

<a name="index-Current-Version-Code"></a>

<p>The version code corresponding to the Current Version field. Both these fields
must be correct and matching although it&rsquo;s the current version code that&rsquo;s
used by Android to determine version order and by F-Droid client to determine
which version should be recommended.
</p>
<p>This field is normally automatically updated - see Update Check Mode.
</p>
<p>This is converted to (<code>&lt;marketvercode&gt;</code>) in the public index file.
</p>
<hr>
<a name="No-Source-Since"></a>
<div class="header">
<p>
Previous: <a href="#Current-Version-Code" accesskey="p" rel="prev">Current Version Code</a>, Up: <a href="#Metadata" accesskey="u" rel="up">Metadata</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="No-Source-Since-1"></a>
<h3 class="section">7.30 No Source Since</h3>

<a name="index-No-Source-Since"></a>

<p>In case we are missing the source code for the Current Version reported by
Upstream, or that non-free elements have been introduced, this defines the
first version that began to miss source code.
Apps that are missing source code for just one or a few versions, but provide
source code for newer ones are not to be considered here - this field is
intended to illustrate which apps do not currently distribute source code, and
since when have they been doing so.
</p>
<hr>
<a name="Update-Processing"></a>
<div class="header">
<p>
Next: <a href="#Build-Server" accesskey="n" rel="next">Build Server</a>, Previous: <a href="#Metadata" accesskey="p" rel="prev">Metadata</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Update-Processing-1"></a>
<h2 class="chapter">8 Update Processing</h2>

<a name="Detecting"></a>
<h3 class="section">8.1 Detecting</h3>

<p>There are various mechanisms in place for automatically detecting that updates
are available for applications, with the <code>Update Check Mode</code> field in the
metadata determining which method is used for a particular application.
</p>
<p>Running the <code>fdroid checkupdates</code> command will apply this method to each
application in the repository and update the <code>Current Version</code> and
<code>Current Version Code</code> fields in the metadata accordingly.
</p>
<p>As usual, the <code>-p</code> option can be used with this, to restrict processing
to a particular application.
</p>
<p>Note that this only updates the metadata such that we know what the current
published/recommended version is. It doesn&rsquo;t make that version available in
the repository - for that, see the next section.
</p>
<a name="Adding"></a>
<h3 class="section">8.2 Adding</h3>

<p>Adding updates (i.e. new versions of applications already included in the
repository) happens in two ways. The simple case is applications where the
APK files are binaries, retrieved from a developer&rsquo;s published build. In this
case, all that&rsquo;s required is to place the new binary in the <code>Repo</code>
directory, and the next run of <code>fdroid update</code> will pick it up.
</p>
<p>For applications built from source, it is necessary to add a new
<code>Build Version</code> line to the metadata file. At the very least, the version
name, version code and commit will be different. It is also possible that the
additional build flags will change between versions.
</p>
<p>For processing multiple updates in the metadata at once, it can be useful to
run <code>fdroid update --interactive</code>. This will check all the applications
in the repository, and where updates are required you will be prompted to
[E]dit the metadata, [I]gnore the update, or [Q]uit altogether.
</p>
<hr>
<a name="Build-Server"></a>
<div class="header">
<p>
Next: <a href="#Signing" accesskey="n" rel="next">Signing</a>, Previous: <a href="#Update-Processing" accesskey="p" rel="prev">Update Processing</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Build-Server-1"></a>
<h2 class="chapter">9 Build Server</h2>

<p>The Build Server system isolates the builds for each package within a clean,
isolated and secure throwaway virtual machine environment.
</p>
<a name="Overview-2"></a>
<h3 class="section">9.1 Overview</h3>

<p>Building applications in this manner on a large scale, especially with the
involvement of automated and/or unattended processes, could be considered
a dangerous pastime from a security perspective. This is even more the case
when the products of the build are also distributed widely and in a
semi-automated (&quot;you have updates available&quot;) fashion.
</p>
<p>Assume that an upstream source repository is compromised. A small selection
of things that an attacker could do in such a situation:
</p>
<ol>
<li> Use custom Ant build steps to execute virtually anything as the user doing
the build.
</li><li> Access the keystore.
</li><li> Modify the built apk files or source tarballs for other applications in the
repository.
</li><li> Modify the metadata (which includes build scripts, which again, also includes
the ability to execute anything) for other applications in the repository.
</li></ol>

<p>Through complete isolation, the repurcussions are at least limited to the
application in question. Not only is the build environment fresh for each
build, and thrown away afterwards, but it is also isolated from the signing
environment.
</p>
<p>Aside from security issues, there are some applications which have strange
requirements such as custom versions of the NDK. It would be impractical (or
at least extremely messy) to start modifying and restoring the SDK on a
multi-purpose system, but within the confines of a throwaway single-use
virtual machine, anything is possible.
</p>
<p>All this is in addition to the obvious advantage of having a standardised
and completely reproducible environment in which builds are made. Additionally,
it allows for specialised custom build environments for particular
applications.
</p>
<a name="Setting-up-a-build-server"></a>
<h3 class="section">9.2 Setting up a build server</h3>

<p>In addition to the basic setup previously described, you will also need
a Vagrant-compatible Debian Testing base box called &rsquo;testing32&rsquo; (or testing64
for a 64-bit VM, if you want it to be much slower, and require more disk
space).
</p>
<p>You can use a different version or distro for the base box, so long as you
don&rsquo;t expect any help making it work. One thing to be aware of is that
working copies of source trees are moved from the host to the guest, so
for example, having subversion v1.6 on the host and v1.7 on the guest
would fail.
</p>
<p>Unless you&rsquo;re very trusting. you should create one of these for yourself
from verified standard Debian installation media. However, you could skip
over the next few paragraphs (and sacrifice some security) by downloading
<a href="https://f-droid.org/testing32.box">https://f-droid.org/testing32.box</a>.
</p>
<p>Documentation for creating a base box can be found at
<a href="http://docs.vagrantup.com/v1/docs/base_boxes.html">http://docs.vagrantup.com/v1/docs/base_boxes.html</a>.
</p>
<p>In addition to carefully following the steps described there, you should
consider the following:
</p>
<ol>
<li> It is advisable to disable udev network device persistence, otherwise any
movement of the VM between machines, or reconfiguration, will result in
broken networking.

<p>For a Debian/Ubuntu default install, just
<code>touch /etc/udev/rules.d/75-persistent-net-generator.rules</code> to turn
off rule generation, and at the same time, get rid of any rules it&rsquo;s
already created in <code>/etc/udev/rules.d/70-persistent-net.rules</code>.
</p></li><li> Unless you want the VM to become totally inaccessible following a failed
boot, you need to set <code>GRUB_RECORDFAIL_TIMEOUT</code> to a value other than
-1 in <code>/etc/grub/default</code> and then run <code>update-grub</code>.
</li></ol>


<p>With this base box available, you should then create <code>makebs.config.py</code>,
using <code>makebs.config.sample.py</code> as a reference - look at the settings and
documentation there to decide if any need changing to suit your environment.
There is a path for retrieving the base box if it doesn&rsquo;t exist, and an apt
proxy definition, both of which may need customising for your environment.
You can then go to the <code>fdroidserver</code> directory and run this:
</p>
<div class="example">
<pre class="example">./makebuildserver
</pre></div>

<p>This will take a long time, and use a lot of bandwidth - most of it spent
installing the necessary parts of the Android SDK for all the various
platforms. Luckily you only need to do it occasionally. Once you have a
working build server image, if the recipes change (e.g. when packages need
to be added) you can just run that script again and the existing one will
be updated in place.
</p>
<p>The main sdk/ndk downloads will automatically be cached to speed things
up the next time, but there&rsquo;s no easy way of doing this for the longer
sections which use the SDK&rsquo;s <code>android</code> tool to install platforms,
add-ons and tools. However, instead of allowing automatic caching, you
can supply a pre-populated cache directory which includes not only these
downloads, but also .tar.gz files for all the relevant additions. If the
provisioning scripts detect these, they will be used in preference to
running the android tools. For example, if you have
<code>buildserver/addons/cache/platforms/android-19.tar.gz</code> that will be
used when installing the android-19 platform, instead of re-downloading it
using <code>android update sdk --no-ui -t android-19</code>.
</p>
<p>Once it&rsquo;s complete you&rsquo;ll have a new base box called &rsquo;buildserver&rsquo; which is
what&rsquo;s used for the actual builds. You can then build packages as normal,
but with the addition of the <code>--server</code> flag to <code>fdroid build</code> to
instruct it to do all the hard work within the virtual machine.
</p>
<p>The first time a build is done, a new virtual machine is created using the
&rsquo;buildserver&rsquo; box as a base. A snapshot of this clean machine state is saved
for use in future builds, to improve performance. You can force discarding
of this snapshot and rebuilding from scratch using the <code>--resetserver</code>
switch with <code>fdroid build</code>.
</p>
<hr>
<a name="Signing"></a>
<div class="header">
<p>
Next: <a href="#GNU-Free-Documentation-License" accesskey="n" rel="next">GNU Free Documentation License</a>, Previous: <a href="#Build-Server" accesskey="p" rel="prev">Build Server</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Signing-1"></a>
<h2 class="chapter">10 Signing</h2>

<p>There are two kinds of signing involved in running a repository - the signing
of the APK files generated from source builds, and the signing of the repo
index itself. The latter is optional, but very strongly recommended.
</p>
<a name="Repo-Index-Signing"></a>
<h3 class="section">10.1 Repo Index Signing</h3>

<p>When setting up the repository, one of the first steps should be to generate
a signing key for the repository index. This will also create a keystore, which
is a file that can be used to hold this and all other keys used. Consider the
location, security and backup status of this file carefully, then create it as
follows:
</p>
<p><code>keytool -genkey -v -keystore my.keystore -alias repokey -keyalg RSA -keysize 2048 -validity 10000</code>
</p>
<p>In the above, replace &rsquo;my.keystore&rsquo; with the name of the keystore file to be
created, and &rsquo;repokey&rsquo; with a name to identify the repo index key by.
</p>
<p>You&rsquo;ll be asked for a password for the keystore, AND a password for the key.
They shouldn&rsquo;t be the same. In between, you&rsquo;ll be asked for some identifying
details which will go in the certificate.
</p>
<p>The two passwords entered go into <code>config.py</code>, as <code>keystorepass</code> and
<code>keypass</code> respectively. The path to the keystore file, and the alias you
chose for the key also go into that file, as <code>keystore</code> and
<code>repo_keyalias</code> respectively.
</p>
<a name="Package-Signing"></a>
<h3 class="section">10.2 Package Signing</h3>

<p>With the repo index signing configured, all that remains to be done for package
signing to work is to set the <code>keydname</code> field in <code>config.py</code> to
contain the same identifying details you entered before.
</p>
<p>A new key will be generated using these details, for each application that is
built. (If a specific key is required for a particular application, this system
can be overridden using the <code>keyaliases</code> config settings.
</p>

<hr>
<a name="GNU-Free-Documentation-License"></a>
<div class="header">
<p>
Next: <a href="#Index" accesskey="n" rel="next">Index</a>, Previous: <a href="#Signing" accesskey="p" rel="prev">Signing</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="GNU-Free-Documentation-License-1"></a>
<h2 class="appendix">Appendix A GNU Free Documentation License</h2>

<div align="center">Version 1.3, 3 November 2008
</div>

<div class="display">
<pre class="display">Copyright &copy; 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc.
<a href="http://fsf.org/">http://fsf.org/</a>

Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
</pre></div>

<ol>
<li> PREAMBLE

<p>The purpose of this License is to make a manual, textbook, or other
functional and useful document <em>free</em> in the sense of freedom: to
assure everyone the effective freedom to copy and redistribute it,
with or without modifying it, either commercially or noncommercially.
Secondarily, this License preserves for the author and publisher a way
to get credit for their work, while not being considered responsible
for modifications made by others.
</p>
<p>This License is a kind of &ldquo;copyleft&rdquo;, which means that derivative
works of the document must themselves be free in the same sense.  It
complements the GNU General Public License, which is a copyleft
license designed for free software.
</p>
<p>We have designed this License in order to use it for manuals for free
software, because free software needs free documentation: a free
program should come with manuals providing the same freedoms that the
software does.  But this License is not limited to software manuals;
it can be used for any textual work, regardless of subject matter or
whether it is published as a printed book.  We recommend this License
principally for works whose purpose is instruction or reference.
</p>
</li><li> APPLICABILITY AND DEFINITIONS

<p>This License applies to any manual or other work, in any medium, that
contains a notice placed by the copyright holder saying it can be
distributed under the terms of this License.  Such a notice grants a
world-wide, royalty-free license, unlimited in duration, to use that
work under the conditions stated herein.  The &ldquo;Document&rdquo;, below,
refers to any such manual or work.  Any member of the public is a
licensee, and is addressed as &ldquo;you&rdquo;.  You accept the license if you
copy, modify or distribute the work in a way requiring permission
under copyright law.
</p>
<p>A &ldquo;Modified Version&rdquo; of the Document means any work containing the
Document or a portion of it, either copied verbatim, or with
modifications and/or translated into another language.
</p>
<p>A &ldquo;Secondary Section&rdquo; is a named appendix or a front-matter section
of the Document that deals exclusively with the relationship of the
publishers or authors of the Document to the Document&rsquo;s overall
subject (or to related matters) and contains nothing that could fall
directly within that overall subject.  (Thus, if the Document is in
part a textbook of mathematics, a Secondary Section may not explain
any mathematics.)  The relationship could be a matter of historical
connection with the subject or with related matters, or of legal,
commercial, philosophical, ethical or political position regarding
them.
</p>
<p>The &ldquo;Invariant Sections&rdquo; are certain Secondary Sections whose titles
are designated, as being those of Invariant Sections, in the notice
that says that the Document is released under this License.  If a
section does not fit the above definition of Secondary then it is not
allowed to be designated as Invariant.  The Document may contain zero
Invariant Sections.  If the Document does not identify any Invariant
Sections then there are none.
</p>
<p>The &ldquo;Cover Texts&rdquo; are certain short passages of text that are listed,
as Front-Cover Texts or Back-Cover Texts, in the notice that says that
the Document is released under this License.  A Front-Cover Text may
be at most 5 words, and a Back-Cover Text may be at most 25 words.
</p>
<p>A &ldquo;Transparent&rdquo; copy of the Document means a machine-readable copy,
represented in a format whose specification is available to the
general public, that is suitable for revising the document
straightforwardly with generic text editors or (for images composed of
pixels) generic paint programs or (for drawings) some widely available
drawing editor, and that is suitable for input to text formatters or
for automatic translation to a variety of formats suitable for input
to text formatters.  A copy made in an otherwise Transparent file
format whose markup, or absence of markup, has been arranged to thwart
or discourage subsequent modification by readers is not Transparent.
An image format is not Transparent if used for any substantial amount
of text.  A copy that is not &ldquo;Transparent&rdquo; is called &ldquo;Opaque&rdquo;.
</p>
<p>Examples of suitable formats for Transparent copies include plain
<small>ASCII</small> without markup, Texinfo input format, LaTeX input
format, <acronym>SGML</acronym> or <acronym>XML</acronym> using a publicly available
<acronym>DTD</acronym>, and standard-conforming simple <acronym>HTML</acronym>,
PostScript or <acronym>PDF</acronym> designed for human modification.  Examples
of transparent image formats include <acronym>PNG</acronym>, <acronym>XCF</acronym> and
<acronym>JPG</acronym>.  Opaque formats include proprietary formats that can be
read and edited only by proprietary word processors, <acronym>SGML</acronym> or
<acronym>XML</acronym> for which the <acronym>DTD</acronym> and/or processing tools are
not generally available, and the machine-generated <acronym>HTML</acronym>,
PostScript or <acronym>PDF</acronym> produced by some word processors for
output purposes only.
</p>
<p>The &ldquo;Title Page&rdquo; means, for a printed book, the title page itself,
plus such following pages as are needed to hold, legibly, the material
this License requires to appear in the title page.  For works in
formats which do not have any title page as such, &ldquo;Title Page&rdquo; means
the text near the most prominent appearance of the work&rsquo;s title,
preceding the beginning of the body of the text.
</p>
<p>The &ldquo;publisher&rdquo; means any person or entity that distributes copies
of the Document to the public.
</p>
<p>A section &ldquo;Entitled XYZ&rdquo; means a named subunit of the Document whose
title either is precisely XYZ or contains XYZ in parentheses following
text that translates XYZ in another language.  (Here XYZ stands for a
specific section name mentioned below, such as &ldquo;Acknowledgements&rdquo;,
&ldquo;Dedications&rdquo;, &ldquo;Endorsements&rdquo;, or &ldquo;History&rdquo;.)  To &ldquo;Preserve the Title&rdquo;
of such a section when you modify the Document means that it remains a
section &ldquo;Entitled XYZ&rdquo; according to this definition.
</p>
<p>The Document may include Warranty Disclaimers next to the notice which
states that this License applies to the Document.  These Warranty
Disclaimers are considered to be included by reference in this
License, but only as regards disclaiming warranties: any other
implication that these Warranty Disclaimers may have is void and has
no effect on the meaning of this License.
</p>
</li><li> VERBATIM COPYING

<p>You may copy and distribute the Document in any medium, either
commercially or noncommercially, provided that this License, the
copyright notices, and the license notice saying this License applies
to the Document are reproduced in all copies, and that you add no other
conditions whatsoever to those of this License.  You may not use
technical measures to obstruct or control the reading or further
copying of the copies you make or distribute.  However, you may accept
compensation in exchange for copies.  If you distribute a large enough
number of copies you must also follow the conditions in section 3.
</p>
<p>You may also lend copies, under the same conditions stated above, and
you may publicly display copies.
</p>
</li><li> COPYING IN QUANTITY

<p>If you publish printed copies (or copies in media that commonly have
printed covers) of the Document, numbering more than 100, and the
Document&rsquo;s license notice requires Cover Texts, you must enclose the
copies in covers that carry, clearly and legibly, all these Cover
Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
the back cover.  Both covers must also clearly and legibly identify
you as the publisher of these copies.  The front cover must present
the full title with all words of the title equally prominent and
visible.  You may add other material on the covers in addition.
Copying with changes limited to the covers, as long as they preserve
the title of the Document and satisfy these conditions, can be treated
as verbatim copying in other respects.
</p>
<p>If the required texts for either cover are too voluminous to fit
legibly, you should put the first ones listed (as many as fit
reasonably) on the actual cover, and continue the rest onto adjacent
pages.
</p>
<p>If you publish or distribute Opaque copies of the Document numbering
more than 100, you must either include a machine-readable Transparent
copy along with each Opaque copy, or state in or with each Opaque copy
a computer-network location from which the general network-using
public has access to download using public-standard network protocols
a complete Transparent copy of the Document, free of added material.
If you use the latter option, you must take reasonably prudent steps,
when you begin distribution of Opaque copies in quantity, to ensure
that this Transparent copy will remain thus accessible at the stated
location until at least one year after the last time you distribute an
Opaque copy (directly or through your agents or retailers) of that
edition to the public.
</p>
<p>It is requested, but not required, that you contact the authors of the
Document well before redistributing any large number of copies, to give
them a chance to provide you with an updated version of the Document.
</p>
</li><li> MODIFICATIONS

<p>You may copy and distribute a Modified Version of the Document under
the conditions of sections 2 and 3 above, provided that you release
the Modified Version under precisely this License, with the Modified
Version filling the role of the Document, thus licensing distribution
and modification of the Modified Version to whoever possesses a copy
of it.  In addition, you must do these things in the Modified Version:
</p>
<ol>
<li> Use in the Title Page (and on the covers, if any) a title distinct
from that of the Document, and from those of previous versions
(which should, if there were any, be listed in the History section
of the Document).  You may use the same title as a previous version
if the original publisher of that version gives permission.

</li><li> List on the Title Page, as authors, one or more persons or entities
responsible for authorship of the modifications in the Modified
Version, together with at least five of the principal authors of the
Document (all of its principal authors, if it has fewer than five),
unless they release you from this requirement.

</li><li> State on the Title page the name of the publisher of the
Modified Version, as the publisher.

</li><li> Preserve all the copyright notices of the Document.

</li><li> Add an appropriate copyright notice for your modifications
adjacent to the other copyright notices.

</li><li> Include, immediately after the copyright notices, a license notice
giving the public permission to use the Modified Version under the
terms of this License, in the form shown in the Addendum below.

</li><li> Preserve in that license notice the full lists of Invariant Sections
and required Cover Texts given in the Document&rsquo;s license notice.

</li><li> Include an unaltered copy of this License.

</li><li> Preserve the section Entitled &ldquo;History&rdquo;, Preserve its Title, and add
to it an item stating at least the title, year, new authors, and
publisher of the Modified Version as given on the Title Page.  If
there is no section Entitled &ldquo;History&rdquo; in the Document, create one
stating the title, year, authors, and publisher of the Document as
given on its Title Page, then add an item describing the Modified
Version as stated in the previous sentence.

</li><li> Preserve the network location, if any, given in the Document for
public access to a Transparent copy of the Document, and likewise
the network locations given in the Document for previous versions
it was based on.  These may be placed in the &ldquo;History&rdquo; section.
You may omit a network location for a work that was published at
least four years before the Document itself, or if the original
publisher of the version it refers to gives permission.

</li><li> For any section Entitled &ldquo;Acknowledgements&rdquo; or &ldquo;Dedications&rdquo;, Preserve
the Title of the section, and preserve in the section all the
substance and tone of each of the contributor acknowledgements and/or
dedications given therein.

</li><li> Preserve all the Invariant Sections of the Document,
unaltered in their text and in their titles.  Section numbers
or the equivalent are not considered part of the section titles.

</li><li> Delete any section Entitled &ldquo;Endorsements&rdquo;.  Such a section
may not be included in the Modified Version.

</li><li> Do not retitle any existing section to be Entitled &ldquo;Endorsements&rdquo; or
to conflict in title with any Invariant Section.

</li><li> Preserve any Warranty Disclaimers.
</li></ol>

<p>If the Modified Version includes new front-matter sections or
appendices that qualify as Secondary Sections and contain no material
copied from the Document, you may at your option designate some or all
of these sections as invariant.  To do this, add their titles to the
list of Invariant Sections in the Modified Version&rsquo;s license notice.
These titles must be distinct from any other section titles.
</p>
<p>You may add a section Entitled &ldquo;Endorsements&rdquo;, provided it contains
nothing but endorsements of your Modified Version by various
parties&mdash;for example, statements of peer review or that the text has
been approved by an organization as the authoritative definition of a
standard.
</p>
<p>You may add a passage of up to five words as a Front-Cover Text, and a
passage of up to 25 words as a Back-Cover Text, to the end of the list
of Cover Texts in the Modified Version.  Only one passage of
Front-Cover Text and one of Back-Cover Text may be added by (or
through arrangements made by) any one entity.  If the Document already
includes a cover text for the same cover, previously added by you or
by arrangement made by the same entity you are acting on behalf of,
you may not add another; but you may replace the old one, on explicit
permission from the previous publisher that added the old one.
</p>
<p>The author(s) and publisher(s) of the Document do not by this License
give permission to use their names for publicity for or to assert or
imply endorsement of any Modified Version.
</p>
</li><li> COMBINING DOCUMENTS

<p>You may combine the Document with other documents released under this
License, under the terms defined in section 4 above for modified
versions, provided that you include in the combination all of the
Invariant Sections of all of the original documents, unmodified, and
list them all as Invariant Sections of your combined work in its
license notice, and that you preserve all their Warranty Disclaimers.
</p>
<p>The combined work need only contain one copy of this License, and
multiple identical Invariant Sections may be replaced with a single
copy.  If there are multiple Invariant Sections with the same name but
different contents, make the title of each such section unique by
adding at the end of it, in parentheses, the name of the original
author or publisher of that section if known, or else a unique number.
Make the same adjustment to the section titles in the list of
Invariant Sections in the license notice of the combined work.
</p>
<p>In the combination, you must combine any sections Entitled &ldquo;History&rdquo;
in the various original documents, forming one section Entitled
&ldquo;History&rdquo;; likewise combine any sections Entitled &ldquo;Acknowledgements&rdquo;,
and any sections Entitled &ldquo;Dedications&rdquo;.  You must delete all
sections Entitled &ldquo;Endorsements.&rdquo;
</p>
</li><li> COLLECTIONS OF DOCUMENTS

<p>You may make a collection consisting of the Document and other documents
released under this License, and replace the individual copies of this
License in the various documents with a single copy that is included in
the collection, provided that you follow the rules of this License for
verbatim copying of each of the documents in all other respects.
</p>
<p>You may extract a single document from such a collection, and distribute
it individually under this License, provided you insert a copy of this
License into the extracted document, and follow this License in all
other respects regarding verbatim copying of that document.
</p>
</li><li> AGGREGATION WITH INDEPENDENT WORKS

<p>A compilation of the Document or its derivatives with other separate
and independent documents or works, in or on a volume of a storage or
distribution medium, is called an &ldquo;aggregate&rdquo; if the copyright
resulting from the compilation is not used to limit the legal rights
of the compilation&rsquo;s users beyond what the individual works permit.
When the Document is included in an aggregate, this License does not
apply to the other works in the aggregate which are not themselves
derivative works of the Document.
</p>
<p>If the Cover Text requirement of section 3 is applicable to these
copies of the Document, then if the Document is less than one half of
the entire aggregate, the Document&rsquo;s Cover Texts may be placed on
covers that bracket the Document within the aggregate, or the
electronic equivalent of covers if the Document is in electronic form.
Otherwise they must appear on printed covers that bracket the whole
aggregate.
</p>
</li><li> TRANSLATION

<p>Translation is considered a kind of modification, so you may
distribute translations of the Document under the terms of section 4.
Replacing Invariant Sections with translations requires special
permission from their copyright holders, but you may include
translations of some or all Invariant Sections in addition to the
original versions of these Invariant Sections.  You may include a
translation of this License, and all the license notices in the
Document, and any Warranty Disclaimers, provided that you also include
the original English version of this License and the original versions
of those notices and disclaimers.  In case of a disagreement between
the translation and the original version of this License or a notice
or disclaimer, the original version will prevail.
</p>
<p>If a section in the Document is Entitled &ldquo;Acknowledgements&rdquo;,
&ldquo;Dedications&rdquo;, or &ldquo;History&rdquo;, the requirement (section 4) to Preserve
its Title (section 1) will typically require changing the actual
title.
</p>
</li><li> TERMINATION

<p>You may not copy, modify, sublicense, or distribute the Document
except as expressly provided under this License.  Any attempt
otherwise to copy, modify, sublicense, or distribute it is void, and
will automatically terminate your rights under this License.
</p>
<p>However, if you cease all violation of this License, then your license
from a particular copyright holder is reinstated (a) provisionally,
unless and until the copyright holder explicitly and finally
terminates your license, and (b) permanently, if the copyright holder
fails to notify you of the violation by some reasonable means prior to
60 days after the cessation.
</p>
<p>Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
</p>
<p>Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License.  If your rights have been terminated and not permanently
reinstated, receipt of a copy of some or all of the same material does
not give you any rights to use it.
</p>
</li><li> FUTURE REVISIONS OF THIS LICENSE

<p>The Free Software Foundation may publish new, revised versions
of the GNU Free Documentation 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.  See
<a href="http://www.gnu.org/copyleft/">http://www.gnu.org/copyleft/</a>.
</p>
<p>Each version of the License is given a distinguishing version number.
If the Document specifies that a particular numbered version of this
License &ldquo;or any later version&rdquo; applies to it, you have the option of
following the terms and conditions either of that specified version or
of any later version that has been published (not as a draft) by the
Free Software Foundation.  If the Document does not specify a version
number of this License, you may choose any version ever published (not
as a draft) by the Free Software Foundation.  If the Document
specifies that a proxy can decide which future versions of this
License can be used, that proxy&rsquo;s public statement of acceptance of a
version permanently authorizes you to choose that version for the
Document.
</p>
</li><li> RELICENSING

<p>&ldquo;Massive Multiauthor Collaboration Site&rdquo; (or &ldquo;MMC Site&rdquo;) means any
World Wide Web server that publishes copyrightable works and also
provides prominent facilities for anybody to edit those works.  A
public wiki that anybody can edit is an example of such a server.  A
&ldquo;Massive Multiauthor Collaboration&rdquo; (or &ldquo;MMC&rdquo;) contained in the
site means any set of copyrightable works thus published on the MMC
site.
</p>
<p>&ldquo;CC-BY-SA&rdquo; means the Creative Commons Attribution-Share Alike 3.0
license published by Creative Commons Corporation, a not-for-profit
corporation with a principal place of business in San Francisco,
California, as well as future copyleft versions of that license
published by that same organization.
</p>
<p>&ldquo;Incorporate&rdquo; means to publish or republish a Document, in whole or
in part, as part of another Document.
</p>
<p>An MMC is &ldquo;eligible for relicensing&rdquo; if it is licensed under this
License, and if all works that were first published under this License
somewhere other than this MMC, and subsequently incorporated in whole
or in part into the MMC, (1) had no cover texts or invariant sections,
and (2) were thus incorporated prior to November 1, 2008.
</p>
<p>The operator of an MMC Site may republish an MMC contained in the site
under CC-BY-SA on the same site at any time before August 1, 2009,
provided the MMC is eligible for relicensing.
</p>
</li></ol>


<hr>
<a name="Index"></a>
<div class="header">
<p>
Previous: <a href="#GNU-Free-Documentation-License" accesskey="p" rel="prev">GNU Free Documentation License</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="#Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="Index-1"></a>
<h2 class="unnumbered">Index</h2>

<table><tr><th valign="top">Jump to: &nbsp; </th><td><a class="summary-letter" href="#Index_cp_letter-A"><b>A</b></a>
 &nbsp; 
<a class="summary-letter" href="#Index_cp_letter-B"><b>B</b></a>
 &nbsp; 
<a class="summary-letter" href="#Index_cp_letter-C"><b>C</b></a>
 &nbsp; 
<a class="summary-letter" href="#Index_cp_letter-D"><b>D</b></a>
 &nbsp; 
<a class="summary-letter" href="#Index_cp_letter-F"><b>F</b></a>
 &nbsp; 
<a class="summary-letter" href="#Index_cp_letter-I"><b>I</b></a>
 &nbsp; 
<a class="summary-letter" href="#Index_cp_letter-L"><b>L</b></a>
 &nbsp; 
<a class="summary-letter" href="#Index_cp_letter-M"><b>M</b></a>
 &nbsp; 
<a class="summary-letter" href="#Index_cp_letter-N"><b>N</b></a>
 &nbsp; 
<a class="summary-letter" href="#Index_cp_letter-P"><b>P</b></a>
 &nbsp; 
<a class="summary-letter" href="#Index_cp_letter-R"><b>R</b></a>
 &nbsp; 
<a class="summary-letter" href="#Index_cp_letter-S"><b>S</b></a>
 &nbsp; 
<a class="summary-letter" href="#Index_cp_letter-U"><b>U</b></a>
 &nbsp; 
<a class="summary-letter" href="#Index_cp_letter-V"><b>V</b></a>
 &nbsp; 
<a class="summary-letter" href="#Index_cp_letter-W"><b>W</b></a>
 &nbsp; 
</td></tr></table>
<table class="index-cp" border="0">
<tr><td></td><th align="left">Index Entry</th><td>&nbsp;</td><th align="left"> Section</th></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Index_cp_letter-A">A</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-AntiFeatures">AntiFeatures</a>:</td><td>&nbsp;</td><td valign="top"><a href="#AntiFeatures">AntiFeatures</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Archive-Policy">Archive Policy</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Archive-Policy">Archive Policy</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Auto-Name">Auto Name</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Auto-Name">Auto Name</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Auto-Update-Mode">Auto Update Mode</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Auto-Update-Mode">Auto Update Mode</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Index_cp_letter-B">B</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-binary">binary</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Simple-Binary-Repository">Simple Binary Repository</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Bitcoin">Bitcoin</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Bitcoin">Bitcoin</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Build">Build</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Build">Build</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Index_cp_letter-C">C</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Current-Version">Current Version</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Current-Version">Current Version</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Current-Version-Code">Current Version Code</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Current-Version-Code">Current Version Code</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Index_cp_letter-D">D</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Description">Description</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Description">Description</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Disabled">Disabled</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Disabled">Disabled</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Donate">Donate</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Donate">Donate</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Index_cp_letter-F">F</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-FlattrID">FlattrID</a>:</td><td>&nbsp;</td><td valign="top"><a href="#FlattrID">FlattrID</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Index_cp_letter-I">I</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-installation">installation</a>:</td><td>&nbsp;</td><td valign="top"><a href="#System-Requirements">System Requirements</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Issue-Tracker">Issue Tracker</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Issue-Tracker">Issue Tracker</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Index_cp_letter-L">L</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-license">license</a>:</td><td>&nbsp;</td><td valign="top"><a href="#License">License</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Litecoin">Litecoin</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Litecoin">Litecoin</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Index_cp_letter-M">M</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Maintainer-Notes">Maintainer Notes</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Maintainer-Notes">Maintainer Notes</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-metadata">metadata</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Metadata">Metadata</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Index_cp_letter-N">N</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Name">Name</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Name">Name</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-No-Source-Since">No Source Since</a>:</td><td>&nbsp;</td><td valign="top"><a href="#No-Source-Since">No Source Since</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Index_cp_letter-P">P</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Provides">Provides</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Provides">Provides</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Index_cp_letter-R">R</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Repo">Repo</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Repo">Repo</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Repo-Type">Repo Type</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Repo-Type">Repo Type</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Requires-Root">Requires Root</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Requires-Root">Requires Root</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Index_cp_letter-S">S</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-setup_002c-installation">setup, installation</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Setup">Setup</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Source-Code">Source Code</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Source-Code">Source Code</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Summary">Summary</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Summary">Summary</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Index_cp_letter-U">U</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Update-Check-Data">Update Check Data</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Update-Check-Data">Update Check Data</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-Update-Check-Mode">Update Check Mode</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Update-Check-Mode">Update Check Mode</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Index_cp_letter-V">V</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Vercode-Operation">Vercode Operation</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Vercode-Operation">Vercode Operation</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
<tr><th><a name="Index_cp_letter-W">W</a></th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-Web-Site">Web Site</a>:</td><td>&nbsp;</td><td valign="top"><a href="#Web-Site">Web Site</a></td></tr>
<tr><td colspan="4"> <hr></td></tr>
</table>
<table><tr><th valign="top">Jump to: &nbsp; </th><td><a class="summary-letter" href="#Index_cp_letter-A"><b>A</b></a>
 &nbsp; 
<a class="summary-letter" href="#Index_cp_letter-B"><b>B</b></a>
 &nbsp; 
<a class="summary-letter" href="#Index_cp_letter-C"><b>C</b></a>
 &nbsp; 
<a class="summary-letter" href="#Index_cp_letter-D"><b>D</b></a>
 &nbsp; 
<a class="summary-letter" href="#Index_cp_letter-F"><b>F</b></a>
 &nbsp; 
<a class="summary-letter" href="#Index_cp_letter-I"><b>I</b></a>
 &nbsp; 
<a class="summary-letter" href="#Index_cp_letter-L"><b>L</b></a>
 &nbsp; 
<a class="summary-letter" href="#Index_cp_letter-M"><b>M</b></a>
 &nbsp; 
<a class="summary-letter" href="#Index_cp_letter-N"><b>N</b></a>
 &nbsp; 
<a class="summary-letter" href="#Index_cp_letter-P"><b>P</b></a>
 &nbsp; 
<a class="summary-letter" href="#Index_cp_letter-R"><b>R</b></a>
 &nbsp; 
<a class="summary-letter" href="#Index_cp_letter-S"><b>S</b></a>
 &nbsp; 
<a class="summary-letter" href="#Index_cp_letter-U"><b>U</b></a>
 &nbsp; 
<a class="summary-letter" href="#Index_cp_letter-V"><b>V</b></a>
 &nbsp; 
<a class="summary-letter" href="#Index_cp_letter-W"><b>W</b></a>
 &nbsp; 
</td></tr></table>

<hr>



</body>
</html>