1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
|
This is gnupg1.info, produced by makeinfo version 4.8 from gnupg1.texi.
This is the `The GNU Privacy Guard Manual' (1.4.6, 4 December 2006).
Copyright (C) 1998, 1999, 2000, 2001, 2002, 2004, 2005, 2006 Free
Software Foundation, Inc.
Permission is granted to copy, distribute and/or modify this
document under the terms of the GNU General Public License as
published by the Free Software Foundation; either version 2 of the
License, or (at your option) any later version. The text of the
license can be found in the section entitled "Copying".
INFO-DIR-SECTION GNU Utilities
START-INFO-DIR-ENTRY
* gpg: (gpg). OpenPGP encryption and signing tool (v1).
END-INFO-DIR-ENTRY
File: gnupg1.info, Node: Top, Next: Invoking GPG, Up: (dir)
Using the GnuPG Version 1.4
***************************
This is the `The GNU Privacy Guard Manual' (1.4.6, 4 December 2006).
Copyright (C) 1998, 1999, 2000, 2001, 2002, 2004, 2005, 2006 Free
Software Foundation, Inc.
Permission is granted to copy, distribute and/or modify this
document under the terms of the GNU General Public License as
published by the Free Software Foundation; either version 2 of the
License, or (at your option) any later version. The text of the
license can be found in the section entitled "Copying".
This manual documents how to use the standalone version of GNU Privacy
Guard.
* Menu:
* Invoking GPG:: Using the classic GPG protocol.
* Specify a User ID:: How to Specify a User Id.
* Copying:: GNU General Public License says
how you can copy and share GnuPG
* Option Index:: Index to command line options.
* Index:: Index of concepts and symbol names.
File: gnupg1.info, Node: Invoking GPG, Next: Specify a User ID, Prev: Top, Up: Top
1 Invoking GPG
**************
`gpg' is the OpenPGP part of the GNU Privacy Guard (GnuPG). It is a
tool to provide digital encryption and signing services using the
OpenPGP standard. `gpg' features complete key management and all bells
and whistles you can expect from a decent OpenPGP implementation.
This is the standalone version of `gpg'. For desktop use you should
consider using `gpg2'.
*Note Option Index::, for an index to `gpg''s commands and options.
* Menu:
* GPG Commands:: List of all commands.
* GPG Options:: List of all options.
* GPG Configuration:: Configuration files.
* GPG Examples:: Some usage examples.
Developer information:
File: gnupg1.info, Node: GPG Commands, Next: GPG Options, Up: Invoking GPG
1.1 Commands
============
Commands are not distinguished from options execpt for the fact that
only one command is allowed.
`gpg' may be run with no commands, in which case it will perform a
reasonable action depending on the type of file it is given as input
(an encrypted message is decrypted, a signature is verified, a file
containing keys is listed).
Please remember that option as well as command parsing stops as soon
as a non-option is encountered, you can explicitly stop parsing by
using the special option `--'.
* Menu:
* General GPG Commands:: Commands not specific to the functionality.
* Operational GPG Commands:: Commands to select the type of operation.
* OpenPGP Key Management:: How to manage your keys.
File: gnupg1.info, Node: General GPG Commands, Next: Operational GPG Commands, Up: GPG Commands
1.1.1 Commands not specific to the function
-------------------------------------------
`--version'
Print the program version and licensing information. Note that you
cannot abbreviate this command.
`--help'
`-h'
Print a usage message summarizing the most useful command line
options. Not that you cannot abbreviate this command.
`--warranty'
Print warranty information.
`--dump-options'
Print a list of all available options and commands. Note that you
cannot abbreviate this command.
File: gnupg1.info, Node: Operational GPG Commands, Next: OpenPGP Key Management, Prev: General GPG Commands, Up: GPG Commands
1.1.2 Commands to select the type of operation
----------------------------------------------
`--sign'
`-s'
Make a signature. This command may be combined with `--encrypt'
(for a signed and encrypted message), `--symmetric' (for a signed
and symmetrically encrypted message), or `--encrypt' and
`--symmetric' together (for a signed message that may be decrypted
via a secret key or a passphrase).
`--clearsign'
Make a clear text signature. The content in a clear text signature
is readable without any special software. OpenPGP software is only
needed to verify the signature. Clear text signatures may modify
end-of-line whitespace for platform independence and are not
intended to be reversible.
`--detach-sign'
`-b'
Make a detached signature.
`--encrypt'
`-e'
Encrypt data. This option may be combined with `--sign' (for a
signed and encrypted message), `--symmetric' (for a message that
may be decrypted via a secret key or a passphrase), or `--sign'
and `--symmetric' together (for a signed message that may be
decrypted via a secret key or a passphrase).
`--symmetric'
`-c'
Encrypt with a symmetric cipher using a passphrase. The default
symmetric cipher used is CAST5, but may be chosen with the
`--cipher-algo' option. This option may be combined with `--sign'
(for a signed and symmetrically encrypted message), `--encrypt'
(for a message that may be decrypted via a secret key or a
passphrase), or `--sign' and `--encrypt' together (for a signed
message that may be decrypted via a secret key or a passphrase).
`--store'
Store only (make a simple RFC1991 literal data packet).
`--decrypt'
`-d'
Decrypt the file given on the command line (or `stdin' if no file
is specified) and write it to stdout (or the file specified with
`--output'). If the decrypted file is signed, the signature is also
verified. This command differs from the default operation, as it
never writes to the filename which is included in the file and it
rejects files which don't begin with an encrypted message.
`--verify'
Assume that the first argument is a signed file or a detached
signature and verify it without generating any output. With no
arguments, the signature packet is read from stdin. If only a
sigfile is given, it may be a complete signature or a detached
signature, in which case the signed stuff is expected in a file
without the ".sig" or ".asc" extension. With more than 1
argument, the first should be a detached signature and the
remaining files are the signed stuff. To read the signed stuff
from stdin, use `-' as the second filename. For security reasons
a detached signature cannot read the signed material from stdin
without denoting it in the above way.
`--multifile'
This modifies certain other commands to accept multiple files for
processing on the command line or read from stdin with each
filename on a separate line. This allows for many files to be
processed at once. `--multifile' may currently be used along with
`--verify', `--encrypt', and `--decrypt'. Note that `--multifile
--verify' may not be used with detached signatures.
`--verify-files'
Identical to `--multifile --verify'.
`--encrypt-files'
Identical to `--multifile --encrypt'.
`--decrypt-files'
Identical to `--multifile --decrypt'.
`--list-keys'
`-k'
`--list-public-keys'
List all keys from the public keyrings, or just the keys given on
the command line. `-k' is slightly different from `--list-keys'
in that it allows only for one argument and takes the second
argument as the keyring to search. This is for command line
compatibility with PGP 2 and has been removed in `gpg2'.
Avoid using the output of this command in scripts or other
programs as it is likely to change as GnuPG changes. See
`--with-colons' for a machine-parseable key listing command that
is appropriate for use in scripts and other programs.
`--list-secret-keys'
`-K'
List all keys from the secret keyrings, or just the ones given on
the command line. A `#' after the letters `sec' means that the
secret key is not usable (for example, if it was created via
`--export-secret-subkeys').
`--list-sigs'
Same as `--list-keys', but the signatures are listed too.
For each signature listed, there are several flags in between the
"sig" tag and keyid. These flags give additional information about
each signature. From left to right, they are the numbers 1-3 for
certificate check level (see `--ask-cert-level'), "L" for a local
or non-exportable signature (see `--lsign-key'), "R" for a
nonRevocable signature (see the `--edit-key' command "nrsign"),
"P" for a signature that contains a policy URL (see
`--cert-policy-url'), "N" for a signature that contains a notation
(see `--cert-notation'), "X" for an eXpired signature (see
`--ask-cert-expire'), and the numbers 1-9 or "T" for 10 and above
to indicate trust signature levels (see the `--edit-key' command
"tsign").
`--check-sigs'
Same as `--list-sigs', but the signatures are verified.
`--fingerprint'
List all keys (or the specified ones) along with their
fingerprints. This is the same output as `--list-keys' but with
the additional output of a line with the fingerprint. May also be
combined with `--list-sigs' or `--check-sigs'. If this command is
given twice, the fingerprints of all secondary keys are listed too.
`--list-packets'
List only the sequence of packets. This is mainly useful for
debugging.
`--card-edit'
Present a menu to work with a smartcard. The subcommand "help"
provides an overview on available commands. For a detailed
description, please see the Card HOWTO at
http://www.gnupg.org/documentation/howtos.html#GnuPG-cardHOWTO .
`--card-status'
Show the content of the smart card.
`--change-pin'
Present a menu to allow changing the PIN of a smartcard. This
functionality is also available as the subcommand "passwd" with the
`--card-edit' command.
`--delete-key `name''
Remove key from the public keyring. In batch mode either `--yes' is
required or the key must be specified by fingerprint. This is a
safeguard against accidental deletion of multiple keys.
`--delete-secret-key `name''
Remove key from the secret and public keyring. In batch mode the
key must be specified by fingerprint.
`--delete-secret-and-public-key `name''
Same as `--delete-key', but if a secret key exists, it will be
removed first. In batch mode the key must be specified by
fingerprint.
`--export'
Either export all keys from all keyrings (default keyrings and
those registered via option `--keyring'), or if at least one name
is given, those of the given name. The new keyring is written to
stdout or to the file given with option `--output'. Use together
with `--armor' to mail those keys.
`--send-keys `key IDs''
Similar to `--export' but sends the keys to a keyserver.
Fingerprints may be used instead of key IDs. Option `--keyserver'
must be used to give the name of this keyserver. Don't send your
complete keyring to a keyserver -- select only those keys which
are new or changed by you.
`--export-secret-keys'
`--export-secret-subkeys'
Same as `--export', but exports the secret keys instead. This is
normally not very useful and a security risk. The second form of
the command has the special property to render the secret part of
the primary key useless; this is a GNU extension to OpenPGP and
other implementations can not be expected to successfully import
such a key. See the option `--simple-sk-checksum' if you want to
import such an exported key with an older OpenPGP implementation.
`--import'
`--fast-import'
Import/merge keys. This adds the given keys to the keyring. The
fast version is currently just a synonym.
There are a few other options which control how this command works.
Most notable here is the `--keyserver-options merge-only' option
which does not insert new keys but does only the merging of new
signatures, user-IDs and subkeys.
`--recv-keys `key IDs''
Import the keys with the given key IDs from a keyserver. Option
`--keyserver' must be used to give the name of this keyserver.
`--refresh-keys'
Request updates from a keyserver for keys that already exist on the
local keyring. This is useful for updating a key with the latest
signatures, user IDs, etc. Calling this with no arguments will
refresh the entire keyring. Option `--keyserver' must be used to
give the name of the keyserver for all keys that do not have
preferred keyservers set (see `--keyserver-options
honor-keyserver-url').
`--search-keys `names''
Search the keyserver for the given names. Multiple names given
here will be joined together to create the search string for the
keyserver. Option `--keyserver' must be used to give the name of
this keyserver. Keyservers that support different search methods
allow using the syntax specified in "How to specify a user ID"
below. Note that different keyserver types support different
search methods. Currently only LDAP supports them all.
`--fetch-keys `URIs''
Retrieve keys located at the specified URIs. Note that different
installations of GnuPG may support different protocols (HTTP, FTP,
LDAP, etc.)
`--update-trustdb'
Do trust database maintenance. This command iterates over all keys
and builds the Web of Trust. This is an interactive command
because it may have to ask for the "ownertrust" values for keys.
The user has to give an estimation of how far she trusts the owner
of the displayed key to correctly certify (sign) other keys. GnuPG
only asks for the ownertrust value if it has not yet been assigned
to a key. Using the `--edit-key' menu, the assigned value can be
changed at any time.
`--check-trustdb'
Do trust database maintenance without user interaction. From time
to time the trust database must be updated so that expired keys or
signatures and the resulting changes in the Web of Trust can be
tracked. Normally, GnuPG will calculate when this is required and
do it automatically unless `--no-auto-check-trustdb' is set. This
command can be used to force a trust database check at any time.
The processing is identical to that of `--update-trustdb' but it
skips keys with a not yet defined "ownertrust".
For use with cron jobs, this command can be used together with
`--batch' in which case the trust database check is done only if a
check is needed. To force a run even in batch mode add the option
`--yes'.
`--export-ownertrust'
Send the ownertrust values to stdout. This is useful for backup
purposes as these values are the only ones which can't be
re-created from a corrupted trust DB.
`--import-ownertrust'
Update the trustdb with the ownertrust values stored in `files' (or
stdin if not given); existing values will be overwritten.
`--rebuild-keydb-caches'
When updating from version 1.0.6 to 1.0.7 this command should be
used to create signature caches in the keyring. It might be handy
in other situations too.
`--print-md `algo''
`--print-mds'
Print message digest of algorithm ALGO for all given files or
stdin. With the second form (or a deprecated "*" as algo) digests
for all available algorithms are printed.
`--gen-random `0|1|2''
Emit COUNT random bytes of the given quality level. If count is
not given or zero, an endless sequence of random bytes will be
emitted. PLEASE, don't use this command unless you know what you
are doing; it may remove precious entropy from the system!
`--gen-prime `mode' `bits''
Use the source, Luke :-). The output format is still subject to
change.
`--enarmor'
`--dearmor'
Pack or unpack an arbitrary input into/from an OpenPGP ASCII armor.
This is a GnuPG extension to OpenPGP and in general not very
useful.
File: gnupg1.info, Node: OpenPGP Key Management, Prev: Operational GPG Commands, Up: GPG Commands
1.1.3 How to manage your keys
-----------------------------
This section explains the main commands for key management
`--gen-key'
Generate a new key pair. This command is normally only used
interactively.
There is an experimental feature which allows you to create keys in
batch mode. See the file `doc/DETAILS' in the source distribution
on how to use this.
`--gen-revoke `name''
Generate a revocation certificate for the complete key. To revoke
a subkey or a signature, use the `--edit' command.
`--desig-revoke `name''
Generate a designated revocation certificate for a key. This
allows a user (with the permission of the keyholder) to revoke
someone else's key.
`--edit-key'
Present a menu which enables you to do most of the key management
related tasks. It expects the specification of a key on the
command line.
sign
Make a signature on key of user `name' If the key is not yet
signed by the default user (or the users given with -u), the
program displays the information of the key again, together
with its fingerprint and asks whether it should be signed.
This question is repeated for all users specified with -u.
lsign
Same as "sign" but the signature is marked as non-exportable
and will therefore never be used by others. This may be used
to make keys valid only in the local environment.
nrsign
Same as "sign" but the signature is marked as non-revocable
and can therefore never be revoked.
tsign
Make a trust signature. This is a signature that combines the
notions of certification (like a regular signature), and
trust (like the "trust" command). It is generally only useful
in distinct communities or groups.
Note that "l" (for local / non-exportable), "nr" (for
non-revocable, and "t" (for trust) may be freely mixed and
prefixed to "sign" to create a signature of any type desired.
revsig
Revoke a signature. For every signature which has been
generated by one of the secret keys, GnuPG asks whether a
revocation certificate should be generated.
trust
Change the owner trust value. This updates the trust-db
immediately and no save is required.
disable
enable
Disable or enable an entire key. A disabled key can not
normally be used for encryption.
adduid
Create an alternate user id.
addphoto
Create a photographic user id. This will prompt for a JPEG
file that will be embedded into the user ID. Note that a very
large JPEG will make for a very large key. Also note that
some programs will display your JPEG unchanged (GnuPG), and
some programs will scale it to fit in a dialog box (PGP).
deluid
Delete a user id. Note that it is not possible to retract a
user id, once it has been send to the public (i.e. to a
keyserver). In that case you better use `revuid'.
delsig
Delete a signature. Note that it is not possible to retract a
signature, once it has been send to the public (i.e. to a
keyserver). In that case you better use `revsig'.
revuid
Revoke a user id.
addkey
Add a subkey to this key.
addcardkey
Generate a key on a card and add it to this key.
keytocard
Transfer the selected secret key (or the primary key if no
key has been selected) to a smartcard. The secret key in the
keyring will be replaced by a stub if the key could be stored
successfully on the card and you use the save command later.
Only certain key types may be transferred to the card. A sub
menu allows you to select on what card to store the key. Note
that it is not possible to get that key back from the card -
if the card gets broken your secret key will be lost unless
you have a backup somewhere.
bkuptocard `file'
Restore the given file to a card. This command may be used to
restore a backup key (as generated during card
initialization) to a new card. In almost all cases this will
be the encryption key. You should use this command only with
the corresponding public key and make sure that the file
given as argument is indeed the backup to restore. You should
then select 2 to restore as encryption key. You will first
be asked to enter the passphrase of the backup key and then
for the Admin PIN of the card.
delkey
Remove a subkey (secondart key). Note that it is not possible
to retract a subkey, once it has been send to the public
(i.e. to a keyserver). In that case you better use `revkey'.
addrevoker
Add a designated revoker. This takes one optional argument:
"sensitive". If a designated revoker is marked as sensitive,
it will not be exported by default (see export-options).
revkey
Revoke a subkey.
expire
Change the key expiration time. If a subkey is selected, the
expiration time of this subkey will be changed. With no
selection, the key expiration of the primary key is changed.
passwd
Change the passphrase of the secret key.
primary
Flag the current user id as the primary one, removes the
primary user id flag from all other user ids and sets the
timestamp of all affected self-signatures one second ahead.
Note that setting a photo user ID as primary makes it primary
over other photo user IDs, and setting a regular user ID as
primary makes it primary over other regular user IDs.
uid `n'
Toggle selection of user id with index `n'. Use 0 to
deselect all.
key `n'
Toggle selection of subkey with index `n'. Use 0 to deselect
all.
check
Check all selected user ids.
showphoto
Display the selected photographic user id.
pref
List preferences from the selected user ID. This shows the
actual preferences, without including any implied preferences.
showpref
More verbose preferences listing for the selected user ID.
This shows the preferences in effect by including the implied
preferences of 3DES (cipher), SHA-1 (digest), and
Uncompressed (compression) if they are not already included
in the preference list. In addition, the preferred keyserver
and signature notations (if any) are shown.
setpref `string'
Set the list of user ID preferences to `string' for all (or
just the selected) user IDs. Calling setpref with no
arguments sets the preference list to the default (either
built-in or set via `--default-preference-list'), and calling
setpref with "none" as the argument sets an empty preference
list. Use `gpg --version' to get a list of available
algorithms. Note that while you can change the preferences on
an attribute user ID (aka "photo ID"), GnuPG does not select
keys via attribute user IDs so these preferences will not be
used by GnuPG.
keyserver
Set a preferred keyserver for the specified user ID(s). This
allows other users to know where you prefer they get your key
from. See `--keyserver-options honor-keyserver-url' for more
on how this works. Setting a value of "none" removes an
existing preferred keyserver.
notation
Set a name=value notation for the specified user ID(s). See
`--cert-notation' for more on how this works. Setting a value
of "none" removes all notations, setting a notation prefixed
with a minus sign (-) removes that notation, and setting a
notation name (without the =value) prefixed with a minus sign
removes all notations with that name.
toggle
Toggle between public and secret key listing.
clean
Compact (by removing all signatures except the selfsig) any
user ID that is no longer usable (e.g. revoked, or expired).
Then, remove any signatures that are not usable by the trust
calculations. Specifically, this removes any signature that
does not validate, any signature that is superseded by a
later signature, revoked signatures, and signatures issued by
keys that are not present on the keyring.
minimize
Make the key as small as possible. This removes all
signatures from each user ID except for the most recent
self-signature.
cross-certify
Add cross-certification signatures to signing subkeys that
may not currently have them. Cross-certification signatures
protect against a subtle attack against signing subkeys. See
`--require-cross-certification'.
save
Save all changes to the key rings and quit.
quit
Quit the program without updating the key rings.
The listing shows you the key with its secondary keys and all user
ids. Selected keys or user ids are indicated by an asterisk. The
trust value is displayed with the primary key: the first is the
assigned owner trust and the second is the calculated trust value.
Letters are used for the values:
-
No ownertrust assigned / not yet calculated.
e
Trust calculation has failed; probably due to an expired key.
q
Not enough information for calculation.
n
Never trust this key.
m
Marginally trusted.
f
Fully trusted.
u
Ultimately trusted.
`--sign-key `name''
Signs a public key with your secret key. This is a shortcut
version of the subcommand "sign" from `--edit'.
`--lsign-key `name''
Signs a public key with your secret key but marks it as
non-exportable. This is a shortcut version of the subcommand
"lsign" from `--edit-key'.
File: gnupg1.info, Node: GPG Options, Next: GPG Configuration, Prev: GPG Commands, Up: Invoking GPG
1.2 Option Summary
==================
`gpg' comes features a bunch of options to control the exact behaviour
and to change the default configuration.
* Menu:
* GPG Configuration Options:: How to change the configuration.
* GPG Key related Options:: Key related options.
* GPG Input and Output:: Input and Output.
* OpenPGP Options:: OpenPGP protocol specific options.
* GPG Esoteric Options:: Doing things one usually don't want to do.
Long options can be put in an options file (default
"~/.gnupg/gpg.conf"). Short option names will not work - for example,
"armor" is a valid option for the options file, while "a" is not. Do not
write the 2 dashes, but simply the name of the option and any required
arguments. Lines with a hash ('#') as the first non-white-space
character are ignored. Commands may be put in this file too, but that is
not generally useful as the command will execute automatically with
every execution of gpg.
Please remember that option parsing stops as soon as a non-option is
encountered, you can explicitly stop parsing by using the special option
`--'.
File: gnupg1.info, Node: GPG Configuration Options, Next: GPG Key related Options, Up: GPG Options
1.2.1 How to change the configuration
-------------------------------------
These options are used to change the configuraton and are usually found
in the option file.
`--default-key NAME'
Use NAME as the default key to sign with. If this option is not
used, the default key is the first key found in the secret keyring.
Note that `-u' or `--local-user' overrides this option.
`--default-recipient NAME'
Use NAME as default recipient if option `--recipient' is not used
and don't ask if this is a valid one. NAME must be non-empty.
`--default-recipient-self'
Use the default key as default recipient if option `--recipient'
is not used and don't ask if this is a valid one. The default key
is the first one from the secret keyring or the one set with
`--default-key'.
`--no-default-recipient'
Reset `--default-recipient' and `--default-recipient-self'.
`-v, --verbose'
Give more information during processing. If used twice, the input
data is listed in detail.
`--no-verbose'
Reset verbose level to 0.
`-q, --quiet'
Try to be as quiet as possible.
`--list-options `parameters''
This is a space or comma delimited string that gives options used
when listing keys and signatures (that is, `--list-keys',
`--list-sigs', `--list-public-keys', `--list-secret-keys', and the
`--edit-key' functions). Options can be prepended with a `no-'
(after the two dashes) to give the opposite meaning. The options
are:
show-photos
Causes `--list-keys', `--list-sigs', `--list-public-keys',
and `--list-secret-keys' to display any photo IDs attached to
the key. Defaults to no. See also `--photo-viewer'.
show-policy-urls
Show policy URLs in the `--list-sigs' or `--check-sigs'
listings. Defaults to no.
show-notations
show-std-notations
show-user-notations
Show all, IETF standard, or user-defined signature notations
in the `--list-sigs' or `--check-sigs' listings. Defaults to
no.
show-keyserver-urls
Show any preferred keyserver URL in the `--list-sigs' or
`--check-sigs' listings. Defaults to no.
show-uid-validity
Display the calculated validity of user IDs during key
listings. Defaults to no.
show-unusable-uids
Show revoked and expired user IDs in key listings. Defaults
to no.
show-unusable-subkeys
Show revoked and expired subkeys in key listings. Defaults to
no.
show-keyring
Display the keyring name at the head of key listings to show
which keyring a given key resides on. Defaults to no.
show-sig-expire
Show signature expiration dates (if any) during `--list-sigs'
or `--check-sigs' listings. Defaults to no.
show-sig-subpackets
Include signature subpackets in the key listing. This option
can take an optional argument list of the subpackets to list.
If no argument is passed, list all subpackets. Defaults to
no. This option is only meaningful when using `--with-colons'
along with `--list-sigs' or `--check-sigs'.
`--verify-options `parameters''
This is a space or comma delimited string that gives options used
when verifying signatures. Options can be prepended with a `no-'
to give the opposite meaning. The options are:
show-photos
Display any photo IDs present on the key that issued the
signature. Defaults to no. See also `--photo-viewer'.
show-policy-urls
Show policy URLs in the signature being verified. Defaults to
no.
show-notations
show-std-notations
show-user-notations
Show all, IETF standard, or user-defined signature notations
in the signature being verified. Defaults to IETF standard.
show-keyserver-urls
Show any preferred keyserver URL in the signature being
verified. Defaults to no.
show-uid-validity
Display the calculated validity of the user IDs on the key
that issued the signature. Defaults to no.
show-unusable-uids
Show revoked and expired user IDs during signature
verification. Defaults to no.
pka-lookups
Enable PKA lookups to verify sender addresses. Note that PKA
is based on DNS, and so enabling this option may disclose
information on when and what signatures are verified or to
whom data is encrypted. This is similar to the "web bug"
described for the auto-key-retrieve feature.
pka-trust-increase
Raise the trust in a signature to full if the signature
passes PKA validation. This option is only meaningful if
pka-lookups is set.
`--enable-dsa2'
`--disable-dsa2'
Enables new-style DSA keys which (unlike the old style) may be
larger than 1024 bit and use hashes other than SHA-1 and
RIPEMD/160. Note that very few programs currently support these
keys and signatures from them.
`--photo-viewer `string''
This is the command line that should be run to view a photo ID.
"%i" will be expanded to a filename containing the photo. "%I"
does the same, except the file will not be deleted once the viewer
exits. Other flags are "%k" for the key ID, "%K" for the long key
ID, "%f" for the key fingerprint, "%t" for the extension of the
image type (e.g. "jpg"), "%T" for the MIME type of the image (e.g.
"image/jpeg"), and "%%" for an actual percent sign. If neither %i
or %I are present, then the photo will be supplied to the viewer
on standard input.
The default viewer is "xloadimage -fork -quiet -title 'KeyID 0x%k'
stdin". Note that if your image viewer program is not secure, then
executing it from GnuPG does not make it secure.
`--exec-path `string''
Sets a list of directories to search for photo viewers and
keyserver helpers. If not provided, keyserver helpers use the
compiled-in default directory, and photo viewers use the $PATH
environment variable. Note, that on W32 system this value is
ignored when searching for keyserver helpers.
`--keyring `file''
Add `file' to the current list of keyrings. If `file' begins with
a tilde and a slash, these are replaced by the $HOME directory. If
the filename does not contain a slash, it is assumed to be in the
GnuPG home directory ("~/.gnupg" if `--homedir' or $GNUPGHOME is
not used).
Note that this adds a keyring to the current list. If the intent
is to use the specified keyring alone, use `--keyring' along with
`--no-default-keyring'.
`--secret-keyring `file''
Same as `--keyring' but for the secret keyrings.
`--primary-keyring `file''
Designate `file' as the primary public keyring. This means that
newly imported keys (via `--import' or keyserver `--recv-from')
will go to this keyring.
`--trustdb-name `file''
Use `file' instead of the default trustdb. If `file' begins with a
tilde and a slash, these are replaced by the $HOME directory. If
the filename does not contain a slash, it is assumed to be in the
GnuPG home directory (`~/.gnupg' if `--homedir' or $GNUPGHOME is
not used).
`--homedir DIR'
Set the name of the home directory to DIR. If his option is not
used, the home directory defaults to `~/.gnupg'. It is only
recognized when given on the command line. It also overrides any
home directory stated through the environment variable `GNUPGHOME'
or (on W32 systems) by means on the Registry entry
HKCU\SOFTWARE\GNU\GNUPG:HOMEDIR.
`--pcsc-driver `file''
Use `file' to access the smartcard reader. The current default is
`libpcsclite.so.1' for GLIBC based systems,
`/System/Library/Frameworks/PCSC.framework/PCSC' for MAC OS X,
`winscard.dll' for Windows and `libpcsclite.so' for other systems.
`--disable-ccid'
Disable the integrated support for CCID compliant readers. This
allows to fall back to one of the other drivers even if the
internal CCID driver can handle the reader. Note, that CCID
support is only available if libusb was available at build time.
`--reader-port `number_or_string''
This option may be used to specify the port of the card terminal. A
value of 0 refers to the first serial device; add 32768 to access
USB devices. The default is 32768 (first USB device). PC/SC or CCID
readers might need a string here; run the program in verbose mode
to get a list of available readers. The default is then the first
reader found.
`--display-charset `name''
Set the name of the native character set. This is used to convert
some informational strings like user IDs to the proper UTF-8
encoding. Note that this has nothing to do with the character set
of data to be encrypted or signed; GnuPG does not recode user
supplied data. If this option is not used, the default character
set is determined from the current locale. A verbosity level of 3
shows the chosen set. Valid values for `name' are:
iso-8859-1
This is the Latin 1 set.
iso-8859-2
The Latin 2 set.
iso-8859-15
This is currently an alias for the Latin 1 set.
koi8-r
The usual Russian set (rfc1489).
utf-8
Bypass all translations and assume that the OS uses native
UTF-8 encoding.
`--utf8-strings'
`--no-utf8-strings'
Assume that command line arguments are given as UTF8 strings. The
default (`--no-utf8-strings') is to assume that arguments are
encoded in the character set as specified by `--display-charset'.
These options affect all following arguments. Both options may be
used multiple times.
`--options `file''
Read options from `file' and do not try to read them from the
default options file in the homedir (see `--homedir'). This option
is ignored if used in an options file.
`--no-options'
Shortcut for `--options /dev/null'. This option is detected before
an attempt to open an option file. Using this option will also
prevent the creation of a `~/.gnupg' homedir.
`-z `n''
`--compress-level `n''
`--bzip2-compress-level `n''
Set compression level to `n' for the ZIP and ZLIB compression
algorithms. The default is to use the default compression level of
zlib (normally 6). `--bzip2-compress-level' sets the compression
level for the BZIP2 compression algorithm (defaulting to 6 as
well). This is a different option from `--compress-level' since
BZIP2 uses a significant amount of memory for each additional
compression level. `-z' sets both. A value of 0 for `n' disables
compression.
`--bzip2-decompress-lowmem'
Use a different decompression method for BZIP2 compressed files.
This alternate method uses a bit more than half the memory, but
also runs at half the speed. This is useful under extreme low
memory circumstances when the file was originally compressed at a
high `--bzip2-compress-level'.
`--mangle-dos-filenames'
`--no-mangle-dos-filenames'
Older version of Windows cannot handle filenames with more than one
dot. `--mangle-dos-filenames' causes GnuPG to replace (rather than
add to) the extension of an output filename to avoid this problem.
This option is off by default and has no effect on non-Windows
platforms.
`--ask-cert-level'
`--no-ask-cert-level'
When making a key signature, prompt for a certification level. If
this option is not specified, the certification level used is set
via `--default-cert-level'. See `--default-cert-level' for
information on the specific levels and how they are used.
`--no-ask-cert-level' disables this option. This option defaults
to no.
`--default-cert-level `n''
The default to use for the check level when signing a key.
0 means you make no particular claim as to how carefully you
verified the key.
1 means you believe the key is owned by the person who claims to
own it but you could not, or did not verify the key at all. This is
useful for a "persona" verification, where you sign the key of a
pseudonymous user.
2 means you did casual verification of the key. For example, this
could mean that you verified that the key fingerprint and checked
the user ID on the key against a photo ID.
3 means you did extensive verification of the key. For example,
this could mean that you verified the key fingerprint with the
owner of the key in person, and that you checked, by means of a
hard to forge document with a photo ID (such as a passport) that
the name of the key owner matches the name in the user ID on the
key, and finally that you verified (by exchange of email) that the
email address on the key belongs to the key owner.
Note that the examples given above for levels 2 and 3 are just
that: examples. In the end, it is up to you to decide just what
"casual" and "extensive" mean to you.
This option defaults to 0 (no particular claim).
`--min-cert-level'
When building the trust database, treat any signatures with a
certification level below this as invalid. Defaults to 2, which
disregards level 1 signatures. Note that level 0 "no particular
claim" signatures are always accepted.
`--trusted-key `long key ID''
Assume that the specified key (which must be given as a full 8
byte key ID) is as trustworthy as one of your own secret keys.
This option is useful if you don't want to keep your secret keys
(or one of them) online but still want to be able to check the
validity of a given recipient's or signator's key.
`--trust-model `pgp|classic|direct|always|auto''
Set what trust model GnuPG should follow. The models are:
pgp
This is the Web of Trust combined with trust signatures as
used in PGP 5.x and later. This is the default trust model
when creating a new trust database.
classic
This is the standard Web of Trust as used in PGP 2.x and
earlier.
direct
Key validity is set directly by the user and not calculated
via the Web of Trust.
always
Skip key validation and assume that used keys are always fully
trusted. You generally won't use this unless you are using
some external validation scheme. This option also suppresses
the "[uncertain]" tag printed with signature checks when
there is no evidence that the user ID is bound to the key.
auto
Select the trust model depending on whatever the internal
trust database says. This is the default model if such a
database already exists.
`--auto-key-locate `parameters''
`--no-auto-key-locate'
GnuPG can automatically locate and retrieve keys as needed using
this option. This happens when encrypting to an email address (in
the "user@example.com" form), and there are no user@example.com
keys on the local keyring. This option takes any number of the
following arguments, in the order they are to be tried:
cert
locate a key using DNS CERT, as specified in 2538bis
(currently in draft): http://www.josefsson.org/rfc2538bis/
pka
locate a key using DNS PKA.
ldap
locate a key using the PGP Universal method of checking
"ldap://keys.(thedomain)".
keyserver
locate a key using whatever keyserver is defined using the
`--keyserver' option.
(keyserver URL)
In addition, a keyserver URL as used in the `--keyserver'
option may be used here to query that particular keyserver.
`--keyid-format `short|0xshort|long|0xlong''
Select how to display key IDs. "short" is the traditional
8-character key ID. "long" is the more accurate (but less
convenient) 16-character key ID. Add an "0x" to either to include
an "0x" at the beginning of the key ID, as in 0x99242560.
`--keyserver `name''
Use `name' as your keyserver. This is the server that
`--recv-keys', `--send-keys', and `--search-keys' will communicate
with to receive keys from, send keys to, and search for keys on.
The format of the `name' is a URI:
`scheme:[//]keyservername[:port]' The scheme is the type of
keyserver: "hkp" for the HTTP (or compatible) keyservers, "ldap"
for the LDAP keyservers, or "mailto" for the Graff email
keyserver. Note that your particular installation of GnuPG may
have other keyserver types available as well. Keyserver schemes
are case-insensitive. After the keyserver name, optional keyserver
configuration options may be provided. These are the same as the
global `--keyserver-options' from below, but apply only to this
particular keyserver.
Most keyservers synchronize with each other, so there is generally
no need to send keys to more than one server. The keyserver
`hkp://subkeys.pgp.net' uses round robin DNS to give a different
keyserver each time you use it.
`--keyserver-options `name=value1 ''
This is a space or comma delimited string that gives options for
the keyserver. Options can be prepended with a `no-' to give the
opposite meaning. Valid import-options or export-options may be
used here as well to apply to importing (`--recv-key') or exporting
(`--send-key') a key from a keyserver. While not all options are
available for all keyserver types, some common options are:
include-revoked
When searching for a key with `--search-keys', include keys
that are marked on the keyserver as revoked. Note that not
all keyservers differentiate between revoked and unrevoked
keys, and for such keyservers this option is meaningless.
Note also that most keyservers do not have cryptographic
verification of key revocations, and so turning this option
off may result in skipping keys that are incorrectly marked
as revoked.
include-disabled
When searching for a key with `--search-keys', include keys
that are marked on the keyserver as disabled. Note that this
option is not used with HKP keyservers.
auto-key-retrieve
This option enables the automatic retrieving of keys from a
keyserver when verifying signatures made by keys that are not
on the local keyring.
Note that this option makes a "web bug" like behavior
possible. Keyserver operators can see which keys you
request, so by sending you a message signed by a brand new
key (which you naturally will not have on your local
keyring), the operator can tell both your IP address and the
time when you verified the signature.
honor-keyserver-url
When using `--refresh-keys', if the key in question has a
preferred keyserver URL, then use that preferred keyserver to
refresh the key from. In addition, if auto-key-retrieve is
set, and the signature being verified has a preferred
keyserver URL, then use that preferred keyserver to fetch the
key from. Defaults to yes.
honor-pka-record
If auto-key-retrieve is set, and the signature being verified
has a PKA record, then use the PKA information to fetch the
key. Defaults to yes.
include-subkeys
When receiving a key, include subkeys as potential targets.
Note that this option is not used with HKP keyservers, as
they do not support retrieving keys by subkey id.
use-temp-files
On most Unix-like platforms, GnuPG communicates with the
keyserver helper program via pipes, which is the most
efficient method. This option forces GnuPG to use temporary
files to communicate. On some platforms (such as Win32 and
RISC OS), this option is always enabled.
keep-temp-files
If using `use-temp-files', do not delete the temp files after
using them. This option is useful to learn the keyserver
communication protocol by reading the temporary files.
verbose
Tell the keyserver helper program to be more verbose. This
option can be repeated multiple times to increase the
verbosity level.
timeout
Tell the keyserver helper program how long (in seconds) to
try and perform a keyserver action before giving up. Note
that performing multiple actions at the same time uses this
timeout value per action. For example, when retrieving
multiple keys via `--recv-keys', the timeout applies
separately to each key retrieval, and not to the
`--recv-keys' command as a whole. Defaults to 30 seconds.
http-proxy
For HTTP-like keyserver schemes that (such as HKP and HTTP
itself), try to access the keyserver over a proxy. If a
`value' is specified, use this as the HTTP proxy. If no
`value' is specified, the value of the environment variable
"http_proxy", if any, will be used.
max-cert-size
When retrieving a key via DNS CERT, only accept keys up to
this size. Defaults to 16384 bytes.
`--completes-needed `n''
Number of completely trusted users to introduce a new key signer
(defaults to 1).
`--marginals-needed `n''
Number of marginally trusted users to introduce a new key signer
(defaults to 3)
`--max-cert-depth `n''
Maximum depth of a certification chain (default is 5).
`--simple-sk-checksum'
Secret keys are integrity protected by using a SHA-1 checksum. This
method is part of the upcoming enhanced OpenPGP specification but
GnuPG already uses it as a countermeasure against certain attacks.
Old applications don't understand this new format, so this option
may be used to switch back to the old behaviour. Using this option
bears a security risk. Note that using this option only takes
effect when the secret key is encrypted - the simplest way to make
this happen is to change the passphrase on the key (even changing
it to the same value is acceptable).
`--no-sig-cache'
Do not cache the verification status of key signatures. Caching
gives a much better performance in key listings. However, if you
suspect that your public keyring is not save against write
modifications, you can use this option to disable the caching. It
probably does not make sense to disable it because all kind of
damage can be done if someone else has write access to your public
keyring.
`--no-sig-create-check'
GnuPG normally verifies each signature right after creation to
protect against bugs and hardware malfunctions which could leak
out bits from the secret key. This extra verification needs some
time (about 115% for DSA keys), and so this option can be used to
disable it. However, due to the fact that the signature creation
needs manual interaction, this performance penalty does not matter
in most settings.
`--auto-check-trustdb'
`--no-auto-check-trustdb'
If GnuPG feels that its information about the Web of Trust has to
be updated, it automatically runs the `--check-trustdb' command
internally. This may be a time consuming process.
`--no-auto-check-trustdb' disables this option.
`--use-agent'
`--no-use-agent'
Try to use the GnuPG-Agent. With this option, GnuPG first tries to
connect to the agent before it asks for a passphrase.
`--no-use-agent' disables this option.
`--gpg-agent-info'
Override the value of the environment variable `GPG_AGENT_INFO'.
This is only used when `--use-agent' has been given
`--lock-once'
Lock the databases the first time a lock is requested and do not
release the lock until the process terminates.
`--lock-multiple'
Release the locks every time a lock is no longer needed. Use this
to override a previous `--lock-once' from a config file.
`--lock-never'
Disable locking entirely. This option should be used only in very
special environments, where it can be assured that only one process
is accessing those files. A bootable floppy with a stand-alone
encryption system will probably use this. Improper usage of this
option may lead to data and key corruption.
`--exit-on-status-write-error'
This option will cause write errors on the status FD to immediately
terminate the process. That should in fact be the default but it
never worked this way and thus we need an option to enable this,
so that the change won't break applications which close their end
of a status fd connected pipe too early. Using this option along
with `--enable-progress-filter' may be used to cleanly cancel long
running gpg operations.
`--limit-card-insert-tries `n''
With `n' greater than 0 the number of prompts asking to insert a
smartcard gets limited to N-1. Thus with a value of 1 gpg won't at
all ask to insert a card if none has been inserted at startup. This
option is useful in the configuration file in case an application
does not know about the smartcard support and waits ad infinitum
for an inserted card.
`--no-random-seed-file'
GnuPG uses a file to store its internal random pool over
invocations. This makes random generation faster; however
sometimes write operations are not desired. This option can be
used to achieve that with the cost of slower random generation.
`--no-greeting'
Suppress the initial copyright message.
`--no-secmem-warning'
Suppress the warning about "using insecure memory".
`--no-permission-warning'
Suppress the warning about unsafe file and home directory
(`--homedir') permissions. Note that the permission checks that
GnuPG performs are not intended to be authoritative, but rather
they simply warn about certain common permission problems. Do not
assume that the lack of a warning means that your system is secure.
Note that the warning for unsafe `--homedir' permissions cannot be
suppressed in the gpg.conf file, as this would allow an attacker to
place an unsafe gpg.conf file in place, and use this file to
suppress warnings about itself. The `--homedir' permissions
warning may only be suppressed on the command line.
`--no-mdc-warning'
Suppress the warning about missing MDC integrity protection.
`--require-secmem'
`--no-require-secmem'
Refuse to run if GnuPG cannot get secure memory. Defaults to no
(i.e. run, but give a warning).
`--require-cross-certification'
`--no-require-cross-certification'
When verifying a signature made from a subkey, ensure that the
cross certification "back signature" on the subkey is present and
valid. This protects against a subtle attack against subkeys that
can sign. Defaults to `--require-cross-certification' for `gpg'.
`--expert'
`--no-expert'
Allow the user to do certain nonsensical or "silly" things like
signing an expired or revoked key, or certain potentially
incompatible things like generating unusual key types. This also
disables certain warning messages about potentially incompatible
actions. As the name implies, this option is for experts only. If
you don't fully understand the implications of what it allows you
to do, leave this off. `--no-expert' disables this option.
File: gnupg1.info, Node: GPG Key related Options, Next: GPG Input and Output, Prev: GPG Configuration Options, Up: GPG Options
1.2.2 Key related options
-------------------------
`--recipient NAME'
`-r'
Encrypt for user id NAME. If this option or `--hidden-recipient'
is not specified, GnuPG asks for the user-id unless
`--default-recipient' is given.
`--hidden-recipient NAME'
`-R'
Encrypt for user ID NAME, but hide the key ID of this user's key.
This option helps to hide the receiver of the message and is a
limited countermeasure against traffic analysis. If this option or
`--recipient' is not specified, GnuPG asks for the user ID unless
`--default-recipient' is given.
`--encrypt-to `name''
Same as `--recipient' but this one is intended for use in the
options file and may be used with your own user-id as an
"encrypt-to-self". These keys are only used when there are other
recipients given either by use of `--recipient' or by the asked
user id. No trust checking is performed for these user ids and
even disabled keys can be used.
`--hidden-encrypt-to `name''
Same as `--hidden-recipient' but this one is intended for use in
the options file and may be used with your own user-id as a hidden
"encrypt-to-self". These keys are only used when there are other
recipients given either by use of `--recipient' or by the asked
user id. No trust checking is performed for these user ids and
even disabled keys can be used.
`--no-encrypt-to'
Disable the use of all `--encrypt-to' and `--hidden-encrypt-to'
keys.
`--group `name=value1 ''
Sets up a named group, which is similar to aliases in email
programs. Any time the group name is a recipient (`-r' or
`--recipient'), it will be expanded to the values specified.
Multiple groups with the same name are automatically merged into a
single group.
The values are `key IDs' or fingerprints, but any key description
is accepted. Note that a value with spaces in it will be treated as
two different values. Note also there is only one level of
expansion -- you cannot make an group that points to another
group. When used from the command line, it may be necessary to
quote the argument to this option to prevent the shell from
treating it as multiple arguments.
`--ungroup `name''
Remove a given entry from the `--group' list.
`--no-groups'
Remove all entries from the `--group' list.
`--local-user NAME'
`-u'
Use NAME as the key to sign with. Note that this option overrides
`--default-key'.
`--try-all-secrets'
Don't look at the key ID as stored in the message but try all
secret keys in turn to find the right decryption key. This option
forces the behaviour as used by anonymous recipients (created by
using `--throw-keyids') and might come handy in case where an
encrypted message contains a bogus key ID.
File: gnupg1.info, Node: GPG Input and Output, Next: OpenPGP Options, Prev: GPG Key related Options, Up: GPG Options
1.2.3 Input and Output
----------------------
`--armor'
`-a'
Create ASCII armored output. The default is to create the binary
OpenPGP format.
`--no-armor'
Assume the input data is not in ASCII armored format.
`--output FILE'
`-o FILE'
Write output to FILE.
`--max-output `n''
This option sets a limit on the number of bytes that will be
generated when processing a file. Since OpenPGP supports various
levels of compression, it is possible that the plaintext of a
given message may be significantly larger than the original
OpenPGP message. While GnuPG works properly with such messages,
there is often a desire to set a maximum file size that will be
generated before processing is forced to stop by the OS limits.
Defaults to 0, which means "no limit".
`--import-options `parameters''
This is a space or comma delimited string that gives options for
importing keys. Options can be prepended with a `no-' to give the
opposite meaning. The options are:
import-local-sigs
Allow importing key signatures marked as "local". This is not
generally useful unless a shared keyring scheme is being used.
Defaults to no.
repair-pks-subkey-bug
During import, attempt to repair the damage caused by the PKS
keyserver bug (pre version 0.9.6) that mangles keys with
multiple subkeys. Note that this cannot completely repair the
damaged key as some crucial data is removed by the keyserver,
but it does at least give you back one subkey. Defaults to no
for regular `--import' and to yes for keyserver `--recv-keys'.
merge-only
During import, allow key updates to existing keys, but do not
allow any new keys to be imported. Defaults to no.
import-clean
After import, compact (remove all signatures except the
self-signature) any user IDs from the new key that are not
usable. Then, remove any signatures from the new key that
are not usable. This includes signatures that were issued by
keys that are not present on the keyring. This option is the
same as running the `--edit-key' command "clean" after
import. Defaults to no.
import-minimal
Import the smallest key possible. This removes all signatures
except the most recent self-signature on each user ID. This
option is the same as running the `--edit-key' command
"minimize" after import. Defaults to no.
`--export-options `parameters''
This is a space or comma delimited string that gives options for
exporting keys. Options can be prepended with a `no-' to give the
opposite meaning. The options are:
export-local-sigs
Allow exporting key signatures marked as "local". This is not
generally useful unless a shared keyring scheme is being used.
Defaults to no.
export-attributes
Include attribute user IDs (photo IDs) while exporting. This
is useful to export keys if they are going to be used by an
OpenPGP program that does not accept attribute user IDs.
Defaults to yes.
export-sensitive-revkeys
Include designated revoker information that was marked as
"sensitive". Defaults to no.
export-reset-subkey-passwd
When using the `--export-secret-subkeys' command, this option
resets the passphrases for all exported subkeys to empty.
This is useful when the exported subkey is to be used on an
unattended machine where a passphrase doesn't necessarily
make sense. Defaults to no.
export-clean
Compact (remove all signatures from) user IDs on the key being
exported if the user IDs are not usable. Also, do not export
any signatures that are not usable. This includes signatures
that were issued by keys that are not present on the keyring.
This option is the same as running the `--edit-key' command
"clean" before export except that the local copy of the key
is not modified. Defaults to no.
export-minimal
Export the smallest key possible. This removes all signatures
except the most recent self-signature on each user ID. This
option is the same as running the `--edit-key' command
"minimize" before export except that the local copy of the
key is not modified. Defaults to no.
`--with-colons'
Print key listings delimited by colons. Note that the output will
be encoded in UTF-8 regardless of any `--display-charset' setting.
This format is useful when GnuPG is called from scripts and other
programs as it is easily machine parsed. The details of this
format are documented in the file `doc/DETAILS', which is included
in the GnuPG source distribution.
`--fixed-list-mode'
Do not merge primary user ID and primary key in `--with-colon'
listing mode and print all timestamps as seconds since 1970-01-01.
`--with-fingerprint'
Same as the command `--fingerprint' but changes only the format of
the output and may be used together with another command.
File: gnupg1.info, Node: OpenPGP Options, Next: GPG Esoteric Options, Prev: GPG Input and Output, Up: GPG Options
1.2.4 OpenPGP protocol specific options.
----------------------------------------
`-t, --textmode'
`--no-textmode'
Treat input files as text and store them in the OpenPGP canonical
text form with standard "CRLF" line endings. This also sets the
necessary flags to inform the recipient that the encrypted or
signed data is text and may need its line endings converted back
to whatever the local system uses. This option is useful when
communicating between two platforms that have different line
ending conventions (UNIX-like to Mac, Mac to Windows, etc).
`--no-textmode' disables this option, and is the default.
If `-t' (but not `--textmode') is used together with armoring and
signing, this enables clearsigned messages. This kludge is needed
for command-line compatibility with command-line versions of PGP;
normally you would use `--sign' or `--clearsign' to select the
type of the signature.
`--force-v3-sigs'
`--no-force-v3-sigs'
OpenPGP states that an implementation should generate v4 signatures
but PGP versions 5 through 7 only recognize v4 signatures on key
material. This option forces v3 signatures for signatures on data.
Note that this option overrides `--ask-sig-expire', as v3
signatures cannot have expiration dates. `--no-force-v3-sigs'
disables this option.
`--force-v4-certs'
`--no-force-v4-certs'
Always use v4 key signatures even on v3 keys. This option also
changes the default hash algorithm for v3 RSA keys from MD5 to
SHA-1. `--no-force-v4-certs' disables this option.
`--force-mdc'
Force the use of encryption with a modification detection code.
This is always used with the newer ciphers (those with a blocksize
greater than 64 bits), or if all of the recipient keys indicate
MDC support in their feature flags.
`--disable-mdc'
Disable the use of the modification detection code. Note that by
using this option, the encrypted message becomes vulnerable to a
message modification attack.
`--personal-cipher-preferences `string''
Set the list of personal cipher preferences to `string', this list
should be a string similar to the one printed by the command
"pref" in the edit menu. This allows the user to factor in their
own preferred algorithms when algorithms are chosen via recipient
key preferences. The most highly ranked cipher in this list is
also used for the `--symmetric' encryption command.
`--personal-digest-preferences `string''
Set the list of personal digest preferences to `string', this list
should be a string similar to the one printed by the command
"pref" in the edit menu. This allows the user to factor in their
own preferred algorithms when algorithms are chosen via recipient
key preferences. The most highly ranked digest algorithm in this
list is algo used when signing without encryption (e.g.
`--clearsign' or `--sign'). The default value is SHA-1.
`--personal-compress-preferences `string''
Set the list of personal compression preferences to `string', this
list should be a string similar to the one printed by the command
"pref" in the edit menu. This allows the user to factor in their
own preferred algorithms when algorithms are chosen via recipient
key preferences. The most highly ranked algorithm in this list is
also used when there are no recipient keys to consider (e.g.
`--symmetric').
`--s2k-cipher-algo `name''
Use `name' as the cipher algorithm used to protect secret keys.
The default cipher is CAST5. This cipher is also used for
conventional encryption if `--personal-cipher-preferences' and
`--cipher-algo' is not given.
`--s2k-digest-algo `name''
Use `name' as the digest algorithm used to mangle the passphrases.
The default algorithm is SHA-1.
`--s2k-mode `n''
Selects how passphrases are mangled. If `n' is 0 a plain
passphrase (which is not recommended) will be used, a 1 adds a
salt to the passphrase and a 3 (the default) iterates the whole
process a number of times (see -s2k-count). Unless `--rfc1991' is
used, this mode is also used for conventional encryption.
`--s2k-count `n''
Specify how many times the passphrase mangling is repeated. This
value may range between 1024 and 65011712 inclusive, and the
default is 65536. Note that not all values in the 1024-65011712
range are legal and if an illegal value is selected, GnuPG will
round up to the nearest legal value. This option is only
meaningful if `--s2k-mode' is 3.
1.2.5 Compliance options
------------------------
These options control what GnuPG is compliant to. Only one of these
options may be active at a time. Note that the default setting of this
is nearly always the correct one. See the INTEROPERABILITY WITH OTHER
OPENPGP PROGRAMS section below before using one of these options.
`--gnupg'
Use standard GnuPG behavior. This is essentially OpenPGP behavior
(see `--openpgp'), but with some additional workarounds for common
compatibility problems in different versions of PGP. This is the
default option, so it is not generally needed, but it may be
useful to override a different compliance option in the gpg.conf
file.
`--openpgp'
Reset all packet, cipher and digest options to strict OpenPGP
behavior. Use this option to reset all previous options like
`--rfc1991', `--force-v3-sigs', `--s2k-*', `--cipher-algo',
`--digest-algo' and `--compress-algo' to OpenPGP compliant values.
All PGP workarounds are disabled.
`--rfc2440'
Reset all packet, cipher and digest options to strict RFC-2440
behavior. Note that this is currently the same thing as
`--openpgp'.
`--rfc1991'
Try to be more RFC-1991 (PGP 2.x) compliant.
`--pgp2'
Set up all options to be as PGP 2.x compliant as possible, and
warn if an action is taken (e.g. encrypting to a non-RSA key) that
will create a message that PGP 2.x will not be able to handle.
Note that `PGP 2.x' here means `MIT PGP 2.6.2'. There are other
versions of PGP 2.x available, but the MIT release is a good
common baseline.
This option implies `--rfc1991 --disable-mdc --no-force-v4-certs
--no-sk-comment --escape-from-lines --force-v3-sigs
--no-ask-sig-expire --no-ask-cert-expire --cipher-algo IDEA
--digest-algo MD5 --compress-algo 1'. It also disables
`--textmode' when encrypting.
`--pgp6'
Set up all options to be as PGP 6 compliant as possible. This
restricts you to the ciphers IDEA (if the IDEA plugin is
installed), 3DES, and CAST5, the hashes MD5, SHA1 and RIPEMD160,
and the compression algorithms none and ZIP. This also disables
-throw-keyids, and making signatures with signing subkeys as PGP 6
does not understand signatures made by signing subkeys.
This option implies `--disable-mdc --no-sk-comment
--escape-from-lines --force-v3-sigs --no-ask-sig-expire'.
`--pgp7'
Set up all options to be as PGP 7 compliant as possible. This is
identical to `--pgp6' except that MDCs are not disabled, and the
list of allowable ciphers is expanded to add AES128, AES192,
AES256, and TWOFISH.
`--pgp8'
Set up all options to be as PGP 8 compliant as possible. PGP 8 is
a lot closer to the OpenPGP standard than previous versions of
PGP, so all this does is disable `--throw-keyids' and set
`--escape-from-lines'. All algorithms are allowed except for the
SHA224, SHA384, and SHA512 digests.
File: gnupg1.info, Node: GPG Esoteric Options, Prev: OpenPGP Options, Up: GPG Options
1.2.6 Doing things one usually don't want to do.
------------------------------------------------
`-n'
`--dry-run'
Don't make any changes (this is not completely implemented).
`--list-only'
Changes the behaviour of some commands. This is like `--dry-run'
but different in some cases. The semantic of this command may be
extended in the future. Currently it only skips the actual
decryption pass and therefore enables a fast listing of the
encryption keys.
`-i'
`--interactive'
Prompt before overwriting any files.
`--debug FLAGS'
Set debugging flags. All flags are or-ed and FLAGS may be given in
C syntax (e.g. 0x0042).
`--debug-all'
Set all useful debugging flags.
`--debug-ccid-driver'
Enable debug output from the included CCID driver for smartcards.
Note that this option is only available on some system.
`--enable-progress-filter'
Enable certain PROGRESS status outputs. This option allows
frontends to display a progress indicator while gpg is processing
larger files. There is a slight performance overhead using it.
`--status-fd `n''
Write special status strings to the file descriptor `n'. See the
file DETAILS in the documentation for a listing of them.
`--status-file `file''
Same as `--status-fd', except the status data is written to file
`file'.
`--logger-fd `n''
Write log output to file descriptor `n' and not to stderr.
`--logger-file `file''
Same as `--logger-fd', except the logger data is written to file
`file'.
`--attribute-fd `n''
Write attribute subpackets to the file descriptor `n'. This is most
useful for use with `--status-fd', since the status messages are
needed to separate out the various subpackets from the stream
delivered to the file descriptor.
`--attribute-file `file''
Same as `--attribute-fd', except the attribute data is written to
file `file'.
`--comment `string''
`--no-comments'
Use `string' as a comment string in clear text signatures and ASCII
armored messages or keys (see `--armor'). The default behavior is
not to use a comment string. `--comment' may be repeated multiple
times to get multiple comment strings. `--no-comments' removes all
comments. It is a good idea to keep the length of a single comment
below 60 characters to avoid problems with mail programs wrapping
such lines. Note that comment lines, like all other header lines,
are not protected by the signature.
`--emit-version'
`--no-emit-version'
Force inclusion of the version string in ASCII armored output.
`--no-emit-version' disables this option.
`--sig-notation `name=value''
`--cert-notation `name=value''
`-N, --set-notation `name=value''
Put the name value pair into the signature as notation data.
`name' must consist only of printable characters or spaces, and
must contain a '@' character in the form keyname@domain.example.com
(substituting the appropriate keyname and domain name, of course).
This is to help prevent pollution of the IETF reserved notation
namespace. The `--expert' flag overrides the '@' check. `value'
may be any printable string; it will be encoded in UTF8, so you
should check that your `--display-charset' is set correctly. If
you prefix `name' with an exclamation mark (!), the notation data
will be flagged as critical (rfc2440:5.2.3.15). `--sig-notation'
sets a notation for data signatures. `--cert-notation' sets a
notation for key signatures (certifications). `--set-notation'
sets both.
There are special codes that may be used in notation names. "%k"
will be expanded into the key ID of the key being signed, "%K"
into the long key ID of the key being signed, "%f" into the
fingerprint of the key being signed, "%s" into the key ID of the
key making the signature, "%S" into the long key ID of the key
making the signature, "%g" into the fingerprint of the key making
the signature (which might be a subkey), "%p" into the fingerprint
of the primary key of the key making the signature, "%c" into the
signature count from the OpenPGP smartcard, and "%%" results in a
single "%". %k, %K, and %f are only meaningful when making a key
signature (certification), and %c is only meaningful when using
the OpenPGP smartcard.
`--sig-policy-url `string''
`--cert-policy-url `string''
`--set-policy-url `string''
Use `string' as a Policy URL for signatures (rfc2440:5.2.3.19). If
you prefix it with an exclamation mark (!), the policy URL packet
will be flagged as critical. `--sig-policy-url' sets a policy url
for data signatures. `--cert-policy-url' sets a policy url for key
signatures (certifications). `--set-policy-url' sets both.
The same %-expandos used for notation data are available here as
well.
`--sig-keyserver-url `string''
Use `string' as a preferred keyserver URL for data signatures. If
you prefix it with an exclamation mark, the keyserver URL packet
will be flagged as critical.
The same %-expandos used for notation data are available here as
well.
`--set-filename `string''
Use `string' as the filename which is stored inside messages.
This overrides the default, which is to use the actual filename of
the file being encrypted.
`--for-your-eyes-only'
`--no-for-your-eyes-only'
Set the `for your eyes only' flag in the message. This causes GnuPG
to refuse to save the file unless the `--output' option is given,
and PGP to use the "secure viewer" with a Tempest-resistant font to
display the message. This option overrides `--set-filename'.
`--no-for-your-eyes-only' disables this option.
`--use-embedded-filename'
`--no-use-embedded-filename'
Try to create a file with a name as embedded in the data. This can
be a dangerous option as it allows to overwrite files. Defaults to
no.
`--cipher-algo `name''
Use `name' as cipher algorithm. Running the program with the
command `--version' yields a list of supported algorithms. If this
is not used the cipher algorithm is selected from the preferences
stored with the key. In general, you do not want to use this
option as it allows you to violate the OpenPGP standard.
`--personal-cipher-preferences' is the safe way to accomplish the
same thing.
`--digest-algo `name''
Use `name' as the message digest algorithm. Running the program
with the command `--version' yields a list of supported
algorithms. In general, you do not want to use this option as it
allows you to violate the OpenPGP standard.
`--personal-digest-preferences' is the safe way to accomplish the
same thing.
`--compress-algo `name''
Use compression algorithm `name'. "zlib" is RFC-1950 ZLIB
compression. "zip" is RFC-1951 ZIP compression which is used by
PGP. "bzip2" is a more modern compression scheme that can
compress some things better than zip or zlib, but at the cost of
more memory used during compression and decompression.
"uncompressed" or "none" disables compression. If this option is
not used, the default behavior is to examine the recipient key
preferences to see which algorithms the recipient supports. If all
else fails, ZIP is used for maximum compatibility.
ZLIB may give better compression results than ZIP, as the
compression window size is not limited to 8k. BZIP2 may give even
better compression results than that, but will use a significantly
larger amount of memory while compressing and decompressing. This
may be significant in low memory situations. Note, however, that
PGP (all versions) only supports ZIP compression. Using any
algorithm other than ZIP or "none" will make the message
unreadable with PGP. In general, you do not want to use this
option as it allows you to violate the OpenPGP standard.
`--personal-compress-preferences' is the safe way to accomplish
the same thing.
`--cert-digest-algo `name''
Use `name' as the message digest algorithm used when signing a
key. Running the program with the command `--version' yields a
list of supported algorithms. Be aware that if you choose an
algorithm that GnuPG supports but other OpenPGP implementations do
not, then some users will not be able to use the key signatures
you make, or quite possibly your entire key.
`--disable-cipher-algo `name''
Never allow the use of `name' as cipher algorithm. The given name
will not be checked so that a later loaded algorithm will still
get disabled.
`--disable-pubkey-algo `name''
Never allow the use of `name' as public key algorithm. The given
name will not be checked so that a later loaded algorithm will
still get disabled.
`--throw-keyids'
`--no-throw-keyids'
Do not put the recipient key IDs into encrypted messages. This
helps to hide the receivers of the message and is a limited
countermeasure against traffic analysis. On the receiving side, it
may slow down the decryption process because all available secret
keys must be tried. `--no-throw-keyids' disables this option.
This option is essentially the same as using `--hidden-recipient'
for all recipients.
`--not-dash-escaped'
This option changes the behavior of cleartext signatures so that
they can be used for patch files. You should not send such an
armored file via email because all spaces and line endings are
hashed too. You can not use this option for data which has 5
dashes at the beginning of a line, patch files don't have this. A
special armor header line tells GnuPG about this cleartext
signature option.
`--escape-from-lines'
`--no-escape-from-lines'
Because some mailers change lines starting with "From " to ">From
" it is good to handle such lines in a special way when creating
cleartext signatures to prevent the mail system from breaking the
signature. Note that all other PGP versions do it this way too.
Enabled by default. `--no-escape-from-lines' disables this option.
`--passphrase-repeat `n''
Specify how many times `gpg' will request a new passphrase be
repeated. This is useful for helping memorize a passphrase.
Defaults to 1 repetition.
`--passphrase-fd `n''
Read the passphrase from file descriptor `n'. Only the first line
will be read from file descriptor `n'. If you use 0 for `n', the
passphrase will be read from stdin. This can only be used if only
one passphrase is supplied.
`--passphrase-file `file''
Read the passphrase from file `file'. Only the first line will be
read from file `file'. This can only be used if only one
passphrase is supplied. Obviously, a passphrase stored in a file is
of questionable security if other users can read this file. Don't
use this option if you can avoid it.
`--passphrase `string''
Use `string' as the passphrase. This can only be used if only one
passphrase is supplied. Obviously, this is of very questionable
security on a multi-user system. Don't use this option if you can
avoid it.
`--command-fd `n''
This is a replacement for the deprecated shared-memory IPC mode.
If this option is enabled, user input on questions is not expected
from the TTY but from the given file descriptor. It should be used
together with `--status-fd'. See the file doc/DETAILS in the source
distribution for details on how to use it.
`--command-file `file''
Same as `--command-fd', except the commands are read out of file
`file'
`--allow-non-selfsigned-uid'
`--no-allow-non-selfsigned-uid'
Allow the import and use of keys with user IDs which are not
self-signed. This is not recommended, as a non self-signed user ID
is trivial to forge. `--no-allow-non-selfsigned-uid' disables.
`--allow-freeform-uid'
Disable all checks on the form of the user ID while generating a
new one. This option should only be used in very special
environments as it does not ensure the de-facto standard format of
user IDs.
`--ignore-time-conflict'
GnuPG normally checks that the timestamps associated with keys and
signatures have plausible values. However, sometimes a signature
seems to be older than the key due to clock problems. This option
makes these checks just a warning. See also `--ignore-valid-from'
for timestamp issues on subkeys.
`--ignore-valid-from'
GnuPG normally does not select and use subkeys created in the
future. This option allows the use of such keys and thus exhibits
the pre-1.0.7 behaviour. You should not use this option unless you
there is some clock problem. See also `--ignore-time-conflict' for
timestamp issues with signatures.
`--ignore-crc-error'
The ASCII armor used by OpenPGP is protected by a CRC checksum
against transmission errors. Occasionally the CRC gets mangled
somewhere on the transmission channel but the actual content
(which is protected by the OpenPGP protocol anyway) is still okay.
This option allows GnuPG to ignore CRC errors.
`--ignore-mdc-error'
This option changes a MDC integrity protection failure into a
warning. This can be useful if a message is partially corrupt,
but it is necessary to get as much data as possible out of the
corrupt message. However, be aware that a MDC protection failure
may also mean that the message was tampered with intentionally by
an attacker.
`--no-default-keyring'
Do not add the default keyrings to the list of keyrings. Note that
GnuPG will not operate without any keyrings, so if you use this
option and do not provide alternate keyrings via `--keyring' or
`--secret-keyring', then GnuPG will still use the default public or
secret keyrings.
`--skip-verify'
Skip the signature verification step. This may be used to make the
decryption faster if the signature verification is not needed.
`--with-key-data'
Print key listings delimited by colons (like `--with-colons') and
print the public key data.
`--fast-list-mode'
Changes the output of the list commands to work faster; this is
achieved by leaving some parts empty. Some applications don't need
the user ID and the trust information given in the listings. By
using this options they can get a faster listing. The exact
behaviour of this option may change in future versions. If you
are missing some information, don't use this option.
`--no-literal'
This is not for normal use. Use the source to see for what it
might be useful.
`--set-filesize'
This is not for normal use. Use the source to see for what it
might be useful.
`--show-session-key'
Display the session key used for one message. See
`--override-session-key' for the counterpart of this option.
We think that Key Escrow is a Bad Thing; however the user should
have the freedom to decide whether to go to prison or to reveal
the content of one specific message without compromising all
messages ever encrypted for one secret key. DON'T USE IT UNLESS
YOU ARE REALLY FORCED TO DO SO.
`--override-session-key `string''
Don't use the public key but the session key `string'. The format
of this string is the same as the one printed by
`--show-session-key'. This option is normally not used but comes
handy in case someone forces you to reveal the content of an
encrypted message; using this option you can do this without
handing out the secret key.
`--ask-sig-expire'
`--no-ask-sig-expire'
When making a data signature, prompt for an expiration time. If
this option is not specified, the expiration time set via
`--default-sig-expire' is used. `--no-ask-sig-expire' disables
this option. Note that by default, `--force-v3-sigs' is set which
also disables this option. If you want signature expiration, you
must set `--no-force-v3-sigs' as well as turning
`--ask-sig-expire' on.
`--default-sig-expire'
The default expiration time to use for signature expiration. Valid
values are "0" for no expiration, a number followed by the letter d
(for days), w (for weeks), m (for months), or y (for years) (for
example "2m" for two months, or "5y" for five years), or an
absolute date in the form YYYY-MM-DD. Defaults to "0".
`--ask-cert-expire'
`--no-ask-cert-expire'
When making a key signature, prompt for an expiration time. If this
option is not specified, the expiration time set via
`--default-cert-expire' is used. `--no-ask-cert-expire' disables
this option.
`--default-cert-expire'
The default expiration time to use for key signature expiration.
Valid values are "0" for no expiration, a number followed by the
letter d (for days), w (for weeks), m (for months), or y (for
years) (for example "2m" for two months, or "5y" for five years),
or an absolute date in the form YYYY-MM-DD. Defaults to "0".
`--allow-secret-key-import'
This is an obsolete option and is not used anywhere.
`--allow-multisig-verification'
Allow verification of concatenated signed messages. This will run a
signature verification for each data+signature block. There are
some security issues with this option and thus it is off by
default. Note that versions of GPG prior to version 1.4.3
implicitly allowed this.
`--enable-special-filenames'
This options enables a mode in which filenames of the form `-&n',
where n is a non-negative decimal number, refer to the file
descriptor n and not to a file with that name.
`--no-expensive-trust-checks'
Experimental use only.
`--preserve-permissions'
Don't change the permissions of a secret keyring back to user
read/write only. Use this option only if you really know what you
are doing.
`--default-preference-list `string''
Set the list of default preferences to `string'. This preference
list is used for new keys and becomes the default for "setpref" in
the edit menu.
`--default-keyserver-url `name''
Set the default keyserver URL to `name'. This keyserver will be
used as the keyserver URL when writing a new self-signature on a
key, which includes key generation and changing preferences.
`--list-config'
Display various internal configuration parameters of GnuPG. This
option is intended for external programs that call GnuPG to
perform tasks, and is thus not generally useful. See the file
`doc/DETAILS' in the source distribution for the details of which
configuration items may be listed. `--list-config' is only usable
with `--with-colons' set.
`--gpgconf-list'
This command is simliar to `--list-config' but in general only
internally used by the `gpgconf' tool.
`--gpgconf-test'
This is more or less dummy action. However it parses the
configuration file and returns with failure if the configuraion
file would prevent `gpg' from startup. Thus it may be used to run
a syntax check on the configuration file.
1.2.7 Deprecated options
------------------------
`--load-extension `name''
Load an extension module. If `name' does not contain a slash it is
searched for in the directory configured when GnuPG was built
(generally "/usr/local/lib/gnupg"). Extensions are not generally
useful anymore, and the use of this option is deprecated.
`--show-photos'
`--no-show-photos'
Causes `--list-keys', `--list-sigs', `--list-public-keys',
`--list-secret-keys', and verifying a signature to also display
the photo ID attached to the key, if any. See also
`--photo-viewer'. These options are deprecated. Use
`--list-options [no-]show-photos' and/or `--verify-options
[no-]show-photos' instead.
`--show-keyring'
Display the keyring name at the head of key listings to show which
keyring a given key resides on. This option is deprecated: use
`--list-options [no-]show-keyring' instead.
`--ctapi-driver `file''
Use `file' to access the smartcard reader. The current default is
`libtowitoko.so'. Note that the use of this interface is
deprecated; it may be removed in future releases.
`--always-trust'
Identical to `--trust-model always'. This option is deprecated.
`--show-notation'
`--no-show-notation'
Show signature notations in the `--list-sigs' or `--check-sigs'
listings as well as when verifying a signature with a notation in
it. These options are deprecated. Use `--list-options
[no-]show-notation' and/or `--verify-options [no-]show-notation'
instead.
`--show-policy-url'
`--no-show-policy-url'
Show policy URLs in the `--list-sigs' or `--check-sigs' listings
as well as when verifying a signature with a policy URL in it.
These options are deprecated. Use `--list-options
[no-]show-policy-url' and/or `--verify-options
[no-]show-policy-url' instead.
File: gnupg1.info, Node: GPG Configuration, Next: GPG Examples, Prev: GPG Options, Up: Invoking GPG
1.3 Configuration files
=======================
There are a few configuration files to control certain aspects of
`gpg''s operation. Unless noted, they are expected in the current home
directory (*note option --homedir::).
`gpg.conf'
This is the standard configuration file read by `gpg' on startup.
It may contain any valid long option; the leading two dashes may
not be entered and the option may not be abbreviated. This default
name may be changed on the command line (*note option --options::).
Note that on larger installations, it is useful to put predefined
files into the directory `/etc/skel/.gnupg/' so that newly created users
start up with a working configuration.
For internal purposes `gpg' creates and maintaines a few other
files; They all live in in the current home directory (*note option
--homedir::). Only the `gpg' may modify these files.
`~/.gnupg/secring.gpg'
The secret keyring.
`~/.gnupg/secring.gpg.lock'
and the lock file
`~/.gnupg/pubring.gpg'
The public keyring
`~/.gnupg/pubring.gpg.lock'
and the lock file
`~/.gnupg/trustdb.gpg'
The trust database
`~/.gnupg/trustdb.gpg.lock'
and the lock file
`~/.gnupg/random_seed'
used to preserve the internal random pool
`/usr[/local]/share/gnupg/options.skel'
Skeleton options file
`/usr[/local]/lib/gnupg/'
Default location for extensions
Operation is further controlled by a few environment variables:
HOME
Used to locate the default home directory.
GNUPGHOME
If set directory used instead of "~/.gnupg".
GPG_AGENT_INFO
Used to locate the gpg-agent. This is only honored when
`--use-agent' is set. The value consists of 3 colon delimited
fields: The first is the path to the Unix Domain Socket, the
second the PID of the gpg-agent and the protocol version which
should be set to 1. When starting the gpg-agent as described in
its documentation, this variable is set to the correct value. The
option `--gpg-agent-info' can be used to override it.
COLUMNS
LINES
Used to size some displays to the full size of the screen.
File: gnupg1.info, Node: GPG Examples, Prev: GPG Configuration, Up: Invoking GPG
1.4 Examples
============
gpg -se -r `Bob' `file'
sign and encrypt for user Bob
gpg -clearsign `file'
make a clear text signature
gpg -sb `file'
make a detached signature
gpg -list-keys `user_ID'
show keys
gpg -fingerprint `user_ID'
show fingerprint
gpg -verify `pgpfile'
gpg -verify `sigfile'
Verify the signature of the file but do not output the data. The
second form is used for detached signatures, where `sigfile' is
the detached signature (either ASCII armored or binary) and are
the signed data; if this is not given, the name of the file
holding the signed data is constructed by cutting off the
extension (".asc" or ".sig") of `sigfile' or by asking the user
for the filename.
RETURN VALUE
************
The program returns 0 if everything was fine, 1 if at least a signature
was bad, and other error codes for fatal errors.
WARNINGS
********
Use a *good* password for your user account and a *good* passphrase to
protect your secret key. This passphrase is the weakest part of the
whole system. Programs to do dictionary attacks on your secret keyring
are very easy to write and so you should protect your "~/.gnupg/"
directory very well.
Keep in mind that, if this program is used over a network (telnet),
it is *very* easy to spy out your passphrase!
If you are going to verify detached signatures, make sure that the
program knows about it; either give both filenames on the command line
or use `-' to specify stdin.
INTEROPERABILITY WITH OTHER OPENPGP PROGRAMS
********************************************
GnuPG tries to be a very flexible implementation of the OpenPGP
standard. In particular, GnuPG implements many of the optional parts of
the standard, such as the SHA-512 hash, and the ZLIB and BZIP2
compression algorithms. It is important to be aware that not all
OpenPGP programs implement these optional algorithms and that by
forcing their use via the `--cipher-algo', `--digest-algo',
`--cert-digest-algo', or `--compress-algo' options in GnuPG, it is
possible to create a perfectly valid OpenPGP message, but one that
cannot be read by the intended recipient.
There are dozens of variations of OpenPGP programs available, and
each supports a slightly different subset of these optional algorithms.
For example, until recently, no (unhacked) version of PGP supported the
BLOWFISH cipher algorithm. A message using BLOWFISH simply could not be
read by a PGP user. By default, GnuPG uses the standard OpenPGP
preferences system that will always do the right thing and create
messages that are usable by all recipients, regardless of which OpenPGP
program they use. Only override this safe default if you really know
what you are doing.
If you absolutely must override the safe default, or if the
preferences on a given key are invalid for some reason, you are far
better off using the `--pgp6', `--pgp7', or `--pgp8' options. These
options are safe as they do not force any particular algorithms in
violation of OpenPGP, but rather reduce the available algorithms to a
"PGP-safe" list.
BUGS
****
On many systems this program should be installed as setuid(root). This
is necessary to lock memory pages. Locking memory pages prevents the
operating system from writing memory pages (which may contain
passphrases or other sensitive material) to disk. If you get no warning
message about insecure memory your operating system supports locking
without being root. The program drops root privileges as soon as locked
memory is allocated.
File: gnupg1.info, Node: Specify a User ID, Next: Copying, Prev: Invoking GPG, Up: Top
2 How to Specify a User Id
**************************
There are different ways to specify a user ID to GnuPG. Some of them
are only valid for `gpg' others are only good for `gpgsm'. Here is the
entire list of ways to specify a key:
* By key Id. This format is deduced from the length of the string
and its content or `0x' prefix. The key Id of an X.509 certificate
are the low 64 bits of its SHA-1 fingerprint. The use of key Ids
is just a shortcut, for all automated processing the fingerprint
should be used.
When using `gpg' an exclamation mark may be appended to force
using the specified primary or secondary key and not to try and
calculate which primary or secondary key to use.
The last four lines of the example give the key ID in their long
form as internally used by the OpenPGP protocol. You can see the
long key ID using the option `--with-colons'.
234567C4
0F34E556E
01347A56A
0xAB123456
234AABBCC34567C4
0F323456784E56EAB
01AB3FED1347A5612
0x234AABBCC34567C4
* By fingerprint. This format is deduced from the length of the
string and its content or the `0x' prefix. Note, that only the 20
byte version fingerprint is available with `gpgsm' (i.e. the SHA-1
hash of the certificate).
When using `gpg' an exclamation mark may be appended to force
using the specified primary or secondary key and not to try and
calculate which primary or secondary key to use.
The best way to specify a key Id is by using the fingerprint. This
avoids any ambiguities in case that there are duplicated key IDs.
1234343434343434C434343434343434
123434343434343C3434343434343734349A3434
0E12343434343434343434EAB3484343434343434
0xE12343434343434343434EAB3484343434343434
(`gpgsm' also accepts colons between each pair of hexadecimal
digits because this is the de-facto standard on how to present
X.509 fingerprints.)
* By exact match on OpenPGP user ID. This is denoted by a leading
equal sign. It does not make sense for X.509 certificates.
=Heinrich Heine <heinrichh@uni-duesseldorf.de>
* By exact match on an email address. This is indicated by
enclosing the email address in the usual way with left and right
angles.
<heinrichh@uni-duesseldorf.de>
* By word match. All words must match exactly (not case sensitive)
but can appear in any order in the user ID or a subjects name.
Words are any sequences of letters, digits, the underscore and all
characters with bit 7 set.
+Heinrich Heine duesseldorf
* By exact match on the subject's DN. This is indicated by a
leading slash, directly followed by the RFC-2253 encoded DN of the
subject. Note that you can't use the string printed by "gpgsm
-list-keys" because that one as been reordered and modified for
better readability; use -with-colons to print the raw (but standard
escaped) RFC-2253 string
/CN=Heinrich Heine,O=Poets,L=Paris,C=FR
* By exact match on the issuer's DN. This is indicated by a leading
hash mark, directly followed by a slash and then directly followed
by the rfc2253 encoded DN of the issuer. This should return the
Root cert of the issuer. See note above.
#/CN=Root Cert,O=Poets,L=Paris,C=FR
* By exact match on serial number and issuer's DN. This is
indicated by a hash mark, followed by the hexadecmal
representation of the serial number, the followed by a slash and
the RFC-2253 encoded DN of the issuer. See note above.
#4F03/CN=Root Cert,O=Poets,L=Paris,C=FR
* By keygrip This is indicated by an ampersand followed by the 40
hex digits of a keygrip. `gpgsm' prints the keygrip when using
the command `--dump-cert'. It does not yet work for OpenPGP keys.
&D75F22C3F86E355877348498CDC92BD21010A480
* By substring match. This is the default mode but applications may
want to explicitly indicate this by putting the asterisk in front.
Match is not case sensitive.
Heine
*Heine
Please note that we have reused the hash mark identifier which was
used in old GnuPG versions to indicate the so called local-id. It is
not anymore used and there should be no conflict when used with X.509
stuff.
Using the RFC-2253 format of DNs has the drawback that it is not
possible to map them back to the original encoding, however we don't
have to do this because our key database stores this encoding as meta
data.
File: gnupg1.info, Node: Copying, Next: Option Index, Prev: Specify a User ID, Up: Top
Appendix A GNU GENERAL PUBLIC LICENSE
*************************************
Version 2, June 1991
Copyright (C) 1989, 1991 Free Software Foundation, Inc.
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
A.0.1 Preamble
--------------
The licenses for most software are designed to take away your freedom
to share and change it. By contrast, the GNU General Public License is
intended to guarantee your freedom to share and change free
software--to make sure the software is free for all its users. This
General Public License applies to most of the Free Software
Foundation's software and to any other program whose authors commit to
using it. (Some other Free Software Foundation software is covered by
the GNU Library General Public License instead.) You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
this service if you wish), that you receive source code or can get it
if you want it, that you can change the software or use pieces of it in
new free programs; and that you know you can do these things.
To protect your rights, we need to make restrictions that forbid
anyone to deny you these rights or to ask you to surrender the rights.
These restrictions translate to certain responsibilities for you if you
distribute copies of the software, or if you modify it.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must give the recipients all the rights that
you have. You must make sure that they, too, receive or can get the
source code. And you must show them these terms so they know their
rights.
We protect your rights with two steps: (1) copyright the software,
and (2) offer you this license which gives you legal permission to copy,
distribute and/or modify the software.
Also, for each author's protection and ours, we want to make certain
that everyone understands that there is no warranty for this free
software. If the software is modified by someone else and passed on, we
want its recipients to know that what they have is not the original, so
that any problems introduced by others will not reflect on the original
authors' reputations.
Finally, any free program is threatened constantly by software
patents. We wish to avoid the danger that redistributors of a free
program will individually obtain patent licenses, in effect making the
program proprietary. To prevent this, we have made it clear that any
patent must be licensed for everyone's free use or not licensed at all.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
1. This License applies to any program or other work which contains a
notice placed by the copyright holder saying it may be distributed
under the terms of this General Public License. The "Program",
below, refers to any such program or work, and a "work based on
the Program" means either the Program or any derivative work under
copyright law: that is to say, a work containing the Program or a
portion of it, either verbatim or with modifications and/or
translated into another language. (Hereinafter, translation is
included without limitation in the term "modification".) Each
licensee is addressed as "you".
Activities other than copying, distribution and modification are
not covered by this License; they are outside its scope. The act
of running the Program is not restricted, and the output from the
Program is covered only if its contents constitute a work based on
the Program (independent of having been made by running the
Program). Whether that is true depends on what the Program does.
2. You may copy and distribute verbatim copies of the Program's
source code as you receive it, in any medium, provided that you
conspicuously and appropriately publish on each copy an appropriate
copyright notice and disclaimer of warranty; keep intact all the
notices that refer to this License and to the absence of any
warranty; and give any other recipients of the Program a copy of
this License along with the Program.
You may charge a fee for the physical act of transferring a copy,
and you may at your option offer warranty protection in exchange
for a fee.
3. You may modify your copy or copies of the Program or any portion
of it, thus forming a work based on the Program, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:
a. You must cause the modified files to carry prominent notices
stating that you changed the files and the date of any change.
b. You must cause any work that you distribute or publish, that
in whole or in part contains or is derived from the Program
or any part thereof, to be licensed as a whole at no charge
to all third parties under the terms of this License.
c. If the modified program normally reads commands interactively
when run, you must cause it, when started running for such
interactive use in the most ordinary way, to print or display
an announcement including an appropriate copyright notice and
a notice that there is no warranty (or else, saying that you
provide a warranty) and that users may redistribute the
program under these conditions, and telling the user how to
view a copy of this License. (Exception: if the Program
itself is interactive but does not normally print such an
announcement, your work based on the Program is not required
to print an announcement.)
These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the
Program, and can be reasonably considered independent and separate
works in themselves, then this License, and its terms, do not
apply to those sections when you distribute them as separate
works. But when you distribute the same sections as part of a
whole which is a work based on the Program, the distribution of
the whole must be on the terms of this License, whose permissions
for other licensees extend to the entire whole, and thus to each
and every part regardless of who wrote it.
Thus, it is not the intent of this section to claim rights or
contest your rights to work written entirely by you; rather, the
intent is to exercise the right to control the distribution of
derivative or collective works based on the Program.
In addition, mere aggregation of another work not based on the
Program with the Program (or with a work based on the Program) on
a volume of a storage or distribution medium does not bring the
other work under the scope of this License.
4. You may copy and distribute the Program (or a work based on it,
under Section 2) in object code or executable form under the terms
of Sections 1 and 2 above provided that you also do one of the
following:
a. Accompany it with the complete corresponding machine-readable
source code, which must be distributed under the terms of
Sections 1 and 2 above on a medium customarily used for
software interchange; or,
b. Accompany it with a written offer, valid for at least three
years, to give any third party, for a charge no more than your
cost of physically performing source distribution, a complete
machine-readable copy of the corresponding source code, to be
distributed under the terms of Sections 1 and 2 above on a
medium customarily used for software interchange; or,
c. Accompany it with the information you received as to the offer
to distribute corresponding source code. (This alternative is
allowed only for noncommercial distribution and only if you
received the program in object code or executable form with
such an offer, in accord with Subsection b above.)
The source code for a work means the preferred form of the work for
making modifications to it. For an executable work, complete
source code means all the source code for all modules it contains,
plus any associated interface definition files, plus the scripts
used to control compilation and installation of the executable.
However, as a special exception, the source code distributed need
not include anything that is normally distributed (in either
source or binary form) with the major components (compiler,
kernel, and so on) of the operating system on which the executable
runs, unless that component itself accompanies the executable.
If distribution of executable or object code is made by offering
access to copy from a designated place, then offering equivalent
access to copy the source code from the same place counts as
distribution of the source code, even though third parties are not
compelled to copy the source along with the object code.
5. You may not copy, modify, sublicense, or distribute the Program
except as expressly provided under this License. Any attempt
otherwise to copy, modify, sublicense or distribute the Program is
void, and will automatically terminate your rights under this
License. However, parties who have received copies, or rights,
from you under this License will not have their licenses
terminated so long as such parties remain in full compliance.
6. You are not required to accept this License, since you have not
signed it. However, nothing else grants you permission to modify
or distribute the Program or its derivative works. These actions
are prohibited by law if you do not accept this License.
Therefore, by modifying or distributing the Program (or any work
based on the Program), you indicate your acceptance of this
License to do so, and all its terms and conditions for copying,
distributing or modifying the Program or works based on it.
7. Each time you redistribute the Program (or any work based on the
Program), the recipient automatically receives a license from the
original licensor to copy, distribute or modify the Program
subject to these terms and conditions. You may not impose any
further restrictions on the recipients' exercise of the rights
granted herein. You are not responsible for enforcing compliance
by third parties to this License.
8. If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent
issues), conditions are imposed on you (whether by court order,
agreement or otherwise) that contradict the conditions of this
License, they do not excuse you from the conditions of this
License. If you cannot distribute so as to satisfy simultaneously
your obligations under this License and any other pertinent
obligations, then as a consequence you may not distribute the
Program at all. For example, if a patent license would not permit
royalty-free redistribution of the Program by all those who
receive copies directly or indirectly through you, then the only
way you could satisfy both it and this License would be to refrain
entirely from distribution of the Program.
If any portion of this section is held invalid or unenforceable
under any particular circumstance, the balance of the section is
intended to apply and the section as a whole is intended to apply
in other circumstances.
It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of
any such claims; this section has the sole purpose of protecting
the integrity of the free software distribution system, which is
implemented by public license practices. Many people have made
generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is
willing to distribute software through any other system and a
licensee cannot impose that choice.
This section is intended to make thoroughly clear what is believed
to be a consequence of the rest of this License.
9. If the distribution and/or use of the Program is restricted in
certain countries either by patents or by copyrighted interfaces,
the original copyright holder who places the Program under this
License may add an explicit geographical distribution limitation
excluding those countries, so that distribution is permitted only
in or among countries not thus excluded. In such case, this
License incorporates the limitation as if written in the body of
this License.
10. The Free Software Foundation may publish revised and/or new
versions of the General Public License from time to time. Such
new versions will be similar in spirit to the present version, but
may differ in detail to address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies a version number of this License which applies
to it and "any later version", you have the option of following
the terms and conditions either of that version or of any later
version published by the Free Software Foundation. If the Program
does not specify a version number of this License, you may choose
any version ever published by the Free Software Foundation.
11. If you wish to incorporate parts of the Program into other free
programs whose distribution conditions are different, write to the
author to ask for permission. For software which is copyrighted
by the Free Software Foundation, write to the Free Software
Foundation; we sometimes make exceptions for this. Our decision
will be guided by the two goals of preserving the free status of
all derivatives of our free software and of promoting the sharing
and reuse of software generally.
NO WARRANTY
12. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO
WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE
LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT
WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT
NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE
QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY
SERVICING, REPAIR OR CORRECTION.
13. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY
MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE
LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL,
INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR
INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU
OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY
OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN
ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
=============================================
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these
terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
convey the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
ONE LINE TO GIVE THE PROGRAM'S NAME AND AN IDEA OF WHAT IT DOES.
Copyright (C) 19YY NAME OF AUTHOR
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
Also add information on how to contact you by electronic and paper
mail.
If the program is interactive, make it output a short notice like
this when it starts in an interactive mode:
Gnomovision version 69, Copyright (C) 19YY NAME OF AUTHOR
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details
type `show w'. This is free software, and you are welcome
to redistribute it under certain conditions; type `show c'
for details.
The hypothetical commands `show w' and `show c' should show the
appropriate parts of the General Public License. Of course, the
commands you use may be called something other than `show w' and `show
c'; they could even be mouse-clicks or menu items--whatever suits your
program.
You should also get your employer (if you work as a programmer) or
your school, if any, to sign a "copyright disclaimer" for the program,
if necessary. Here is a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright
interest in the program `Gnomovision'
(which makes passes at compilers) written
by James Hacker.
SIGNATURE OF TY COON, 1 April 1989
Ty Coon, President of Vice
This General Public License does not permit incorporating your
program into proprietary programs. If your program is a subroutine
library, you may consider it more useful to permit linking proprietary
applications with the library. If this is what you want to do, use the
GNU Library General Public License instead of this License.
File: gnupg1.info, Node: Option Index, Next: Index, Prev: Copying, Up: Top
Option Index
************
|