1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502
|
'\" t
.ig
Copyright (C) 1989, 2000-2003, 2006, 2007, 2009-2011
Free Software Foundation, Inc.
Permission is granted to make and distribute verbatim copies of
this manual provided the copyright notice and this permission notice
are preserved on all copies.
Permission is granted to copy and distribute modified versions of this
manual under the conditions for verbatim copying, provided that the
entire resulting derived work is distributed under the terms of a
permission notice identical to this one.
Permission is granted to copy and distribute translations of this
manual into another language, under the above conditions for modified
versions, except that this permission notice may be included in
translations approved by the Free Software Foundation instead of in
the original English.
..
.
.TH GROFF_MM @MAN7EXT@ "@MDATE@" "Groff Version @VERSION@"
.
.
.SH NAME
.
groff_mm \- groff mm macros
.
.
.SH SYNOPSIS
.
.B groff
.B \-m@TMAC_M_PREFIX@m
[
.IR options .\|.\|.\&
]
[
.IR files .\|.\|.\&
]
.
.
.SH DESCRIPTION
.
The groff mm macros are intended to be compatible with the DWB mm macros
with the following limitations:
.
.TP
.B \(bu
No Bell Labs localisms are implemented.
.
.TP
.B \(bu
The macros OK and PM are not implemented.
.
.TP
.B \(bu
groff mm does not support cut marks.
.
.LP
.B m@TMAC_M_PREFIX@m
is intended to support easy localization.
Use
.B m@TMAC_M_PREFIX@mse
as an example how to adapt the output format to a national standard.
Localized strings are collected in the file
.RI `@MACRODIR@/ xx .tmac',
where
.I xx
denotes the two-letter code for the
.IR language ,
as defined in the ISO 639 standard.
For Swedish,
this is `sv.tmac' \[en]
not `se',
which is the ISO 3166 two-letter code for the
.I country
(as used for the output format localization).
.
.\"########################################################################
.LP
A file called
.B locale
or
.IB country _locale
is read after the initialization of the global variables.
It is therefore possible to localize the macros with a different company
name and so on.
.
.LP
In this manual,
square brackets are used to show optional arguments.
.
.
.SS "Number registers and strings"
.
Many macros can be controlled by number registers and strings.
A number register is assigned with the
.B nr
command:
.
.RS
.LP
.BI .nr\ "XXX \fR[\fP\fB\[+-]\fP\fR]\fPn \fR[\fPi\fR]\fP
.RE
.
.LP
.I XXX
is the name of the register,
.I n\c
\~is the value to be assigned, and
.I i\c
\~is the increment value for auto-increment.
.I n\c
\~can have a plus or minus sign as a prefix if an increment
or decrement of the current value is wanted.
(Auto-increment or auto-decrement occurs if the number register is
used with a plus or minus sign,
.BI \[rs]n+[ XXX ]
or
.BI \[rs]n-[ XXX ]\fR.)\fP
.
.LP
Strings are defined with
.BR ds .
.
.RS
.LP
\fB\&.ds\fP \fIYYY string\fP
.RE
.
.LP
The string is assigned everything to the end of the line,
even blanks.
Initial blanks in
.I string
should be prefixed with a double-quote.
(Strings are used in the text as
.BI \[rs]*[ YYY ]\fR.)\fP
.
.
.SS "Special formatting of number registers"
.
A number register is printed with normal digits if no format has been
given.
Set the format with
.BR af :
.
.RS
.LP
.BI .af\ "R c"
.RE
.
.LP
.I R\c
\~is the name of the register,
.I c\c
\~is the format.
.
.RS
.LP
.TS
tab(@);
lb lb
l l.
Form@Sequence
1@0, 1, 2, 3, .\|.\|.
001@000, 001, 002, 003, .\|.\|.
i@0, i, ii, iii, iv, .\|.\|.
I@0, I, II, III, IV, .\|.\|.
a@0, a, b, c, .\|.\|., z, aa, ab, .\|.\|.
A@0, A, B, C, .\|.\|., Z, AA, AB, .\|.\|.
.TE
.RE
.
.
.SS Fonts
.
In
.BR m@TMAC_M_PREFIX@m ,
the fonts (or rather, font styles)
.B R\c
\~(normal),
.B I\c
\~(italic), and
.B B\c
\~(bold) are hardwired to font positions
.BR 1 ,
.BR 2 ,
and\~\c
.BR 3 ,
respectively.
Internally, font positions are used for backwards compatibility.
From a practical point of view it doesn't make a big difference \[en]
a different font family can still be selected with a call to the
.B .fam
request or using
.BR groff 's
.B \-f
command line option.
On the other hand, if you want to replace just, say, font
.BR B ,
you have to replace the font at position\~2 (with a call to
`.fp\~2\~.\|.\|.').
.
.
.SS Macros
.
.TP
.BI )E\ "level text"
Add heading text
.I text
to the table of contents with
.IR level ,
which is either\~0 or in the range 1 to\~7.
See also
.BR .H .
This macro is used for customized tables of contents.
.
.TP
.BR 1C\ [ 1 ]
Begin one-column processing.
A\~\c
.B 1
as an argument disables the page break.
Use wide footnotes,
small footnotes may be overprinted.
.
.TP
.B 2C
Begin two-column processing.
Splits the page in two columns.
It is a special case of
.BR MC .
See also
.BR 1C .
.
.TP
.B AE
Abstract end,
see
.BR AS .
.
.TP
.BI AF\ \fR[\fP name-of-firm \fR]\fP
Author's firm, should be called before
.BR AU ,
see also
.BR COVER .
.
.TP
.BI AL\ \fR[\fPtype\ \fR[\fPtext-indent\ \fR[\fP1\fR]]]\fP
Start auto-increment list.
Items are numbered beginning with one.
The
.I type
argument controls the format of numbers.
.
.RS
.IP
.TS
tab(@);
lb lb
l l.
Arg@Description
1@Arabic (the default)
A@Upper-case letters (A-Z)
a@Lower-case letters (a-z)
I@Upper-case roman
i@Lower-case roman
.TE
.RE
.
.IP
.I text-indent
sets the indentation and overrides
.BR Li .
A third argument prohibits printing of a blank line before each item.
.
.TP
.BI APP\ "name text"
Begin an appendix with name
.IR name .
Automatic naming occurs if
.I name
is
.BR \[dq]\[dq] .
The appendices start with\~\c
.B A
if automatic naming is used.
A new page is ejected,
and a header is also produced if the number variable
.B Aph
is non-zero.
This is the default.
The appendix always appears in the `List of contents' with correct
page numbers.
The name `APPENDIX' can be changed by setting the string
.B App
to the desired text.
The string
.B Apptxt
contains the current appendix text.
.
.TP
.BI APPSK\ "name pages text"
Same as
.BR .APP ,
but the page number is incremented with
.IR pages .
This is used when diagrams or other non-formatted documents are
included as appendices.
.
.TP
.BI AS\ "\fR[\fParg \fR[\fPindent\fR]]\fP"
Abstract start.
Indentation is specified in `ens',
but scaling is allowed.
Argument
.I arg
controls where the abstract is printed.
.
.RS
.TS
tab(@);
lb lb
l lx.
\fBArg@Placement\fP
0@T{
Abstract is printed on page\~1 and on the cover sheet if used in the
released-paper style (\fBMT 4\fP),
otherwise it is printed on page\~1 without a cover sheet.
T}
1@Abstract is only printed on the cover sheet (\fBMT 4\fP only).
2@T{
Abstract is printed only on the cover sheet (other than \fBMT 4\fP only).
The cover sheet is printed without a need for \fBCS\fP.
T}
.TE
.RE
.
.IP
An abstract is not printed at all in external letters (\fBMT 5\fP).
The
.I indent
parameter controls the indentation of both margins,
otherwise normal text indentation is used.
.
.TP
.BI AST\ \fR[\fPtitle\fR]\fP
Abstract title.
Default is `ABSTRACT'.
Sets the text above the abstract text.
.
.TP
.BI AT\ "title1 \fR[\fPtitle2 \fR[.\|.\|.]]\fP"
Author's title.
.B AT
must appear just after each
.BR AU .
The title shows up after the name in the signature block.
.
.TP
.BI AU\ "\fR[\fPname \fR[\fPinitials \fR[\fPloc \fR[\fPdept \fR[\fPext \fR[\fProom \fR[\fParg \fR[\fParg \fR[\fParg\fR]]]]]]]]]\fP"
Author information.
Specifies the author of the memo or paper,
and is printed on the cover sheet and on other similar places.
.B AU
must not appear before
.BR TL .
The author information
can contain initials, location, department, telephone extension,
room number or name and up to three extra arguments.
.
.TP
.BI AV\ \fR[\fPname\ \fR[\fP1\fR]]\fP
Approval signature.
Generates an approval line with place for signature and date.
The string `APPROVED:' can be changed with variable
.BR Letapp ;
it is replaced with an empty lin if there is a second argument.
The string `Date' can be changed with variable
.BR Letdate .
.
.TP
.BI AVL\ \fR[\fPname\fR]\fP
Letter signature.
Generates a line with place for signature.
.
.TP
.BI B\ "\fR[\fPbold-text \fR[\fPprev-font-text \fR[\fPbold \fR[.\|.\|.]]]]\fP"
Begin boldface.
No limit on the number of arguments.
All arguments are concatenated to one word;
the first, third and so on is printed in boldface.
.
.TP
.B B1
Begin box (as the ms macro).
Draws a box around the text.
The text is indented one character,
and the right margin is one character shorter.
.
.TP
.B B2
End box.
Finishes the box started with
.BR B1 .
.
.TP
.B BE
End bottom block,
see
.BR BS .
.
.TP
.BI BI\ "\fR[\fPbold-text \fR[\fPitalic-text \fR[\fPbold-text \fR[.\|.\|.]]]]\fP"
Bold-italic.
No limit on the number of arguments,
see\~\c
.BR B .
.
.TP
.BI BL\ \fR[\fPtext-indent\ \fR[\fP1\fR]]\fP
Start bullet list.
Initializes a list with a bullet and a space in the beginning of each
list item (see
.BR LI ).
.I text-indent
overrides the default indentation of the list items set by number register
.BR Pi .
A third argument prohibits printing of a blank line before each item.
.
.TP
.BI BR\ "\fR[\fPbold-text \fR[\fProman-text \fR[\fPbold-text \fR[.\|.\|.]]]]\fP"
Bold-roman.
No limit on the number of arguments.
.
.TP
.B BS
Bottom block start.
Begins the definition of a text block which is printed at the bottom
of each page.
The block ends with
.BR BE .
.
.TP
.BI BVL\ "text-indent \fR[\fPmark-indent\ " \fR[\fP1\fR]]\fP
Start of broken variable-item list.
Broken variable-item list has no fixed mark,
it assumes that every
.B LI
has a mark instead.
The text always begins at the next line after the mark.
.I text-indent
sets the indentation to the text, and
.I mark-indent
the distance from the current indentation to the mark.
A third argument prohibits printing of a blank line before each item.
.
.TP
.BI COVER\ \fR[\fParg\fR]\fP
Begin a coversheet definition.
It is important that
.B .COVER
appears before any normal text.
This macro uses
.I arg
to build the filename
`@TMAC_MDIR@/\fIarg\fP.cov'.
Therefore it is possible to create unlimited types of cover sheets.
`ms.cov' is supposed to look like the ms cover sheet.
.B .COVER
requires a
.B .COVEND
at the end of the cover definition.
Always use this order of the cover macros:
.
.RS
.IP
.nf
\&.COVER
\&.TL
\&.AF
\&.AU
\&.AT
\&.AS
\&.AE
\&.COVEND
.fi
.RE
.
.IP
However, only
.B .TL
and
.B .AU
are required.
.
.TP
.B COVEND
Finish the cover description and print the cover page.
It is defined in the cover file.
.
.TP
.B DE
Display end.
Ends a block of text or display that begins
with
.B DS
or
.BR DF .
.
.TP
.BI DF\ "\fR[\fPformat \fR[\fPfill \fR[\fPrindent\fR]]]\fP"
Begin floating display (no nesting allowed).
A floating display is saved in a queue and is printed in the order entered.
.IR Format ,
.IR fill ,
and
.I rindent
are the same as in
.BR DS .
Floating displays are controlled by the two number registers
.B De
and
.BR Df .
.
.IP
.B De register
.
.RS
.IP
.TS
tab(@);
l lx.
0@T{
Nothing special, this is the default.
T}
1@T{
A page eject occurs after each printed display,
giving only one display per page and no text following it.
T}
.TE
.RE
.
.IP
.B Df register
.
.RS
.IP
.TS
tab(@);
l lx.
0@T{
Displays are printed at the end of each section (when section-page
numbering is active) or at the end of the document.
T}
1@T{
A new display is printed on the current page if there is enough space,
otherwise it is printed at the end of the document.
T}
2@T{
One display is printed at the top of each page or column
(in multi-column mode).
T}
3@T{
Print one display if there is enough space for it,
otherwise it is printed at the top of the next page or column.
T}
4@T{
Print as many displays as possible in a new page or column.
A page break occurs between each display if
.B De
is not zero.
T}
5@T{
Fill the current page with displays and the rest beginning at a new page
or column.
(This is the default.)
A page break occurs between each display
if \fBDe\fP is not zero.
T}
.TE
.RE
.
.TP
.BI DL\ \fR[\fPtext-indent\ "\fR[\fP\fB1\fP \fR[\fP\fB1\fP\fR]]]\fP"
Dash list start.
Begins a list where each item is printed after a dash.
.I text-indent
changes the default indentation of the list items set by
number register
.BR Pi .
A second argument prevents an empty line between each list item.
See
.BR LI .
A third argument prohibits printing of a blank line before each item.
.
.TP
.BI DS\ "\fR[\fPformat \fR[\fPfill \fR[\fPrindent\fR]]]\fP"
Static display start.
Begins collection of text until
.BR DE .
The text is printed together on the same page,
unless it is longer than the height of the page.
.B DS
can be nested arbitrarily.
.
.IP
.B format
.
.RS
.IP
.TS
tab(@);
l lx.
\[dq]\[dq]@No indentation.
none@No indentation.
L@No indentation.
I@T{
Indent text with the value of number register
.BR Si .
T}
C@Center each line.
CB@Center the whole display as a block.
R@Right-adjust the lines.
RB@Right-adjust the whole display as a block.
.TE
.RE
.
.IP
The values `L', `I', `C', and `CB' can also be specified as
`0', `1', `2', and `3', respectively,
for compatibility reasons.
.
.IP
.B fill
.
.RS
.IP
.TS
tab(@);
l l.
\[dq]\[dq]@Line-filling turned off.
none@Line-filling turned off.
N@Line-filling turned off.
F@Line-filling turned on.
.TE
.RE
.
.IP
`N' and `F' can also be specified as `0' and `1', respectively.
.
.IP
By default, an empty line is printed before and after the display.
Setting number register
.B Ds
to\~0 prevents this.
.I rindent
shortens the line length by that amount.
.
.TP
.BI EC\ "\fR[\fPtitle \fR[\fPoverride \fR[\fPflag \fR[\fPrefname\fR]]]]\fP"
Equation title.
Sets a title for an equation.
The
.I override
argument changes the numbering.
.
.IP
.B flag
.
.RS
.IP
.TS
tab(@);
l lx.
none@T{
.I override
is a prefix to the number.
T}
0@T{
.I override
is a prefix to the number.
T}
1@T{
.I override
is a suffix to the number.
T}
2@T{
.I override
replaces the number.
T}
.TE
.RE
.
.IP
.B EC
uses the number register
.B Ec
as a counter.
It is possible to use
.B .af
to change the format of the number.
If number register
.B Of
is\~1,
the format of title uses a dash instead of a dot after the number.
.
.IP
The string
.B Le
controls the title of the List of Equations;
default is `LIST OF EQUATIONS'.
The List of Equations is only printed if number register
.B Le
is\~1.
The default is\~0.
The string
.B Liec
contains the word `Equation',
which is printed before the number.
If
.I refname
is used,
then the equation number is saved with
.BR .SETR ,
and can be retrieved with `\fB.GETST\fP \fIrefname\fP'.
.
.IP
Special handling of the title occurs if
.B EC
is used inside
.BR DS / DE ;
it is not affected by the format of
.BR DS .
.
.TP
.BI EF\ \fR[\fParg\fR]\fP
Even-page footer,
printed just above the normal page footer on even pages.
See
.BR PF .
.
.IP
This macro defines string
.BR EOPef .
.
.TP
.BI EH\ \fR[\fParg\fR]\fP
Even-page header,
printed just below the normal page header on even pages.
See
.BR PH .
.
.IP
This macro defines string
.BR TPeh .
.
.TP
.B EN
Equation end, see
.BR EQ .
.
.TP
.B EOP
End-of-page user-defined macro.
This macro is called instead of the normal printing of the footer.
The macro is executed in a separate environment,
without any trap active.
See
.BR TP .
.
.IP
.B strings available to EOP
.RS
.TS
tab(@);
l l.
EOPf@argument of \fBPF\fP
EOPef@argument of \fBEF\fP
EOPof@argument of \fBOF\fP
.TE
.RE
.
.TP
.BI EPIC\ "\fR[\fP\fB\-L\fP\fR]\fP width height \fR[\fPname\fR]\fP"
Draw a box with the given
.I width
and
.IR height .
It also prints the text
.I name
or a default string if
.I name
is not specified.
This is used to include external pictures;
just give the size of the picture.
.B \-L
left-adjusts the picture;
the default is to center.
See
.BR PIC .
.
.TP
.BI EQ\ \fR[\fPlabel\fR]\fP
Equation start.
.BR EQ / EN
are the delimiters for equations written for
.BR @g@eqn (@MAN1EXT@).
.BR EQ / EN
must be inside of a
.BR DS / DE
pair,
except if
.B EQ
is used to set options for
.B @g@eqn
only.
The
.I label
argument appears at the right margin of the equation,
centered vertically within the
.BR DS / DE
block,
unless number register
.B Eq
is\~1.
Then the label appears at the left margin.
.IP
If there are multiple
.BR EQ / EN
blocks within a single
.BR DS / DE
pair,
only the last equation label (if any) is printed.
.
.TP
.BI EX\ "\fR[\fPtitle \fR[\fPoverride \fR[\fPflag \fR[\fPrefname\fR]]]]\fP"
Exhibit title.
The arguments are the same as for
.BR EC .
.B EX
uses the number register
.B Ex
as a counter.
The string
.B Lx
controls the title of the List of Exhibits;
default is `LIST OF EXHIBITS'.
The List of Exhibits is only printed if number register
.B Lx
is\~1,
which is the default.
The string
.B Liex
contains the word `Exhibit',
which is printed before the number.
If
.I refname
is used, the exhibit number is saved with
.BR .SETR ,
and can be retrieved with `\fB.GETST\fP \fIrefname\fP'.
.
.IP
Special handling of the title occurs if
.B EX
is used inside
.BR DS / DE ;
it is not affected by the format of
.BR DS .
.
.TP
.BI FC\ \fR[\fPclosing\fR]\fP
Print `Yours\~very\~truly,' as a formal closing of a letter or memorandum.
The argument replaces the default string.
The default is stored in string variable
.BR Letfc .
.
.TP
.BI FD\ \fR[\fParg\ \fR[\fP1\fR]]\fP
Footnote default format.
Controls the hyphenation (hyphen),
right margin justification (adjust),
and indentation of footnote text (indent).
It can also change the label justification (ljust).
.
.RS
.IP
.TS
tab(@);
lb lb lb lb lb
l l l l l.
arg@hyphen@adjust@indent@ljust
0@no@yes@yes@left
1@yes@yes@yes@left
2@no@no@yes@left
3@yes@no@yes@left
4@no@yes@no@left
5@yes@yes@no@left
6@no@no@no@left
7@yes@no@no@left
8@no@yes@yes@right
9@yes@yes@yes@right
10@no@no@yes@right
11@yes@no@yes@right
.TE
.RE
.
.IP
An argument greater than or equal to 11 is considered as value\~0.
Default for
.B m@TMAC_M_PREFIX@m
is 10.
.
.TP
.B FE
Footnote end.
.
.TP
.BI FG\ "\fR[\fPtitle \fR[\fPoverride \fR[\fPflag \fR[\fPrefname\fR]]]]\fP"
Figure title.
The arguments are the same as for
.BR EC .
.B FG
uses the number register
.B Fg
as a counter.
The string
.B Lf
controls the title of the List of Figures;
default is `LIST OF FIGURES'.
The List of Figures is only printed if number register
.B Lf
is\~1, which is the default.
The string
.B Lifg
contains the word `Figure',
which is printed before the number.
If
.I refname
is used, then the figure number is saved with
.BR .SETR ,
and can be retrieved with `\fB.GETST\fP \fIrefname\fP'.
.
.IP
Special handling of the title occurs if
.B FG
is used inside
.BR DS / DE ,
it is not affected by the format of
.BR DS .
.
.TP
.BI FS\ \fR[\fPlabel\fR]\fP
Footnote start.
The footnote is ended by
.BR FE .
By default, footnotes are automatically numbered;
the number is available in string\~\c
.BR F .
Just add
.B \[rs]*F
in the text.
By adding
.IR label ,
it is possible to have other number or names on the footnotes.
Footnotes in displays are now possible.
An empty line separates footnotes;
the height of the line is controlled by number register
.BR Fs ,
default value is\~1.
.
.TP
.BI GETHN\ "refname \fR[\fPvarname\fR]\fP"
Include the header number where the corresponding `\fBSETR\fP \fIrefname\fP'
was placed.
This is displayed as `X.X.X.' in pass\~1.
See
.BR INITR .
If
.I varname
is used,
.B GETHN
sets the string variable
.I varname
to the header number.
.
.TP
.BI GETPN\ "refname \fR[\fPvarname\fR]\fP"
Include the page number where the corresponding `\fBSETR\fP \fIrefname\fP'
was placed.
This is displayed as `9999' in pass\~1.
See
.BR INITR .
If
.I varname
is used,
.B GETPN
sets the stringvariable
.I varname
to the page number.
.
.TP
.BI GETR\ refname
Combine
.B GETHN
and
.B GETPN
with the text `chapter' and `,\~page'.
The string
.B Qrf
contains the text for the cross reference:
.
.RS
.IP
\&.ds Qrf See chapter \[rs]\[rs]*[Qrfh], page \[rs]\[rs]*[Qrfp].
.RE
.
.IP
.B Qrf
may be changed to support other languages.
Strings
.B Qrfh
and
.B Qrfp
are set by
.B GETR
and contain the page and header number, respectively.
.
.TP
.BI GETST\ "refname \fR[\fPvarname\fR]\fP"
Include the string saved with the second argument to
.BR .SETR .
This is a dummy string in pass\~1.
If
.I varname
is used,
.B GETST
sets it to the saved string.
See
.BR INITR .
.
.TP
.BI H\ "level \fR[\fPheading-text \fR[\fPheading-suffix\fR]]\fP"
Numbered section heading.
Section headers can have a level between 1 and 14;
level\~1 is the top level.
The text is given in
.IR heading-text ,
and must be surrounded by double quotes if it contains spaces.
.I heading-suffix
is added to the header in the text but not in the table of contents.
This is normally used for footnote marks and similar things.
Don't use
.B \[rs]*F
in
.IR heading-suffix ,
it doesn't work.
A manual label must be used, see
.BR FS .
.sp
A call to the paragraph macro\~\c
.B P
directly after\~\c
.B H
is ignored.
.B H\c
\~takes care of spacing and indentation.
.
.IP
.B Page ejection before heading
.
.RS
.IP
Number register
.B Ej
controls page ejection before the heading.
By default, a level-one heading gets two blank lines before it;
higher levels only get one.
A new page is ejected before each first-level heading if number register
.B Ej
is\~1.
All levels below or equal the value of
.B Ej
get a new page.
Default value for
.B Ej
is\~0.
.RE
.
.IP
.B Heading break level
.
.RS
.IP
A line break occurs after the heading if the heading level is less
or equal to number register
.BR Hb .
Default value is\~2.
.RE
.
.IP
.B Heading space level
.
.RS
.IP
A blank line is inserted after the heading if the heading level is less
or equal to number register
.BR Hs .
Default value is\~2.
.
.IP
Text follows the heading on the same line if the level is greater
than both
.B Hb
and
.BR Hs .
.RE
.
.IP
.B Post-heading indent
.
.RS
.IP
Indentation of the text after the heading is controlled by number
register
.BR Hi .
Default value is\~0.
.
.IP
.B Hi
.TS
tab(@);
l lx.
0@The text is left-justified.
1@T{
Indentation of the text follows the value of number
register
.B Pt ,
see
.BR P .
T}
2@T{
The text is lined up with the first word of the heading.
T}
.TE
.RE
.
.IP
.B Centered section headings
.
.RS
.IP
All headings whose level is equal or below number register
.B Hc
and also less than or equal to
.B Hb
or
.B Hs
are centered.
.RE
.
.IP
.B Font control of the heading
.
.RS
.IP
The font of each heading level is controlled by string
.BR HF .
It contains a font number or font name for each level.
Default value is
.
.RS
.IP
.B 2 2 2 2 2 2 2 2 2 2 2 2 2 2
.RE
.
.IP
(all headings in italic).
This could also be written as
.
.RS
.IP
.B I I I I I I I I I I I I I I
.RE
.
.IP
Note that some other implementations use
.B 3\~3\~2\~2\~2\~2\~2
as the default value.
All omitted values are presumed to have value\~1.
.RE
.
.IP
.B Point size control
.
.RS
.IP
String
.B HP
controls the point size of each heading,
in the same way as
.B HF
controls the font.
A value of\~0 selects the default point size.
Default value is
.
.RS
.IP
.B 0 0 0 0 0 0 0 0 0 0 0 0 0 0
.RE
.
.IP
Beware that only the point size changes, not the vertical size.
The latter can be controlled by the user-specified macros
.B HX
and/or
.BR HZ .
.RE
.
.IP
.B Heading counters
.
.RS
.IP
Fourteen number registers named
.B H1
up to
.B H14
contain the counter for each heading level.
The values are printed using Arabic numerals;
this can be changed with the macro
.B HM
(see below).
All marks are concatenated before printing.
To avoid this,
set number register
.B Ht
to\~1.
This only prints the current heading counter at each heading.
.RE
.
.IP
.B Automatic table of contents
.
.RS
.IP
All headings whose level is equal or below number register
.B Cl
are saved to be printed in the table of contents.
Default value is\~2.
.RE
.
.IP
.B Special control of the heading, user-defined macros
.
.RS
.IP
The following macros can be defined by the user to get a finer control
of vertical spacing, fonts, or other features.
Argument
.I level
is the level-argument to\~\c
.BR H ,
but\~0 for unnumbered headings (see
.BR HU ).
Argument
.I rlevel
is the real level;
it is set to number register
.B Hu
for unnumbered headings.
Argument
.I heading-text
is the text argument to
.B H
and
.BR HU .
.
.RS
.TP
.BI HX\ "level rlevel heading-text"
This macro is called just before the printing of the heading.
The following registers are available for
.BR HX .
Note that
.B HX
may alter
.BR }0 ,
.BR }2 ,
and
.BR ;3 .
.
.RS
.TP
.BR }0\ (string)
Contains the heading mark plus two spaces if
.I rlevel
is non-zero,
otherwise empty.
.
.TP
.BR ;0\ (register)
Contains the position of the text after the heading.
0\~means that the text should follow the heading on the same line,
1\~means that a line break should occur before the text,
and 2\~means that a blank line should separate the heading and the text.
.
.TP
.BR }2\ (string)
Contains two spaces if register
.B ;0
is\~0.
It is used to separate the heading from the text.
The string is empty if
.B ;0
is non-zero.
.
.TP
.BR ;3\ (register)
Contains the needed space in units after the heading.
Default is 2v.
Can be used to change things like numbering
.RB ( }0 ),
vertical spacing
.RB ( }2 ),
and the needed space after the heading.
.RE
.
.TP
.BI HY\ "dlevel rlevel heading-text"
This macro is called after size and font calculations and
might be used to change indentation.
.
.TP
.BI HZ\ "dlevel rlevel heading-text"
This macro is called after the printing of the heading,
just before
.B H
or
.B HU
exits.
Can be used to change the page header according to the section heading.
.RE
.RE
.
.TP
.BI HC\ \fR[\fPhyphenation-character\fR]\fP
Set hyphenation character.
Default value is `\[rs]%'.
Resets to the default if called without argument.
Hyphenation can be turned off by setting number
register
.B Hy
to\~0 at the beginning of the file.
.
.TP
.BI HM\ "\fR[\fParg1 \fR[\fParg2 \fR[.\|.\|.\& [\fParg14\fR]]]]\fP"
Heading mark style.
Controls the type of marking for printing of the heading counters.
Default is\~1 for all levels.
.
.IP
.B Argument
.
.TS
tab(@);
l l.
1@Arabic numerals.
0001@Arabic numerals with leading zeroes, one or more.
A@upper-case alphabetic
a@lower-case alphabetic
I@upper-case roman numerals
i@lower-case roman numerals
\[dq]\[dq]@Arabic numerals.
.TE
.
.TP
.BI HU\ heading-text
Unnumbered section header.
.B HU
behaves like
.B H
at the level in number register
.BR Hu .
See\~\c
.BR H .
.
.TP
.BI HX\ "dlevel rlevel heading-text"
User-defined heading exit.
Called just before printing the header.
See\~\c
.BR H .
.
.TP
.BI HY\ "dlevel rlevel heading-text"
User-defined heading exit.
Called just before printing the header.
See\~\c
.BR H .
.
.TP
.BI HZ\ "dlevel rlevel heading-text"
User-defined heading exit.
Called just after printing the header.
See\~\c
.BR H .
.
.TP
.BI I\ "\fR[\fPitalic-text \fR[\fPprev-font-text \fR[\fPitalic-text \fR[.\|.\|.]]]]\fP"
Italic.
Changes the font to italic if called without arguments.
With one argument it sets the word in italic.
With two arguments it concatenates them and sets the first
word in italic and the second in the previous font.
There is no limit on the number of argument;
all are concatenated.
.
.TP
.BI IA\ "\fR[\fPaddressee-name \fR[\fPtitle\fR]]\fP"
Begin specification of the addressee and addressee's address in
letter style.
Several names can be specified with empty
.BR IA / IE -pairs,
but only one address.
See
.BR LT .
.
.TP
.BI IB\ "\fR[\fPitalic-text \fR[\fPbold-text \fR[\fPitalic-text \fR[.\|.\|.]]]]\fP"
Italic-bold.
Even arguments are printed in italic, odd in boldface.
See\~\c
.BR I .
.
.TP
.B IE
End the address specification after
.BR IA .
.
.TP
.BI INITI\ "type filename \fR[\fPmacro\fR]\fP"
Initialize the new index system and set the filename to collect
index lines in with
.BR IND .
Argument
.I type
selects the type of index:
page number, header marks or both.
The default is page numbers.
.
.IP
It is also possible to create a macro that is responsible
for formatting each row;
just add the name of the macro as a third argument.
The macro is then called with the index as argument(s).
.
.IP
.B type
.
.IP
.TS
tab(@);
l lx.
N@Page numbers
H@Header marks
B@T{
Both page numbers and header marks,
separated with a tab character.
T}
.TE
.
.TP
.BI INITR\ filename
Initialize the cross reference macros.
Cross references are written to stderr and are supposed to
be redirected into file `\fIfilename\fR.qrf'.
Requires two passes with groff;
this is handled by a separate program called
.BR mmroff (@MAN1EXT@).
This program exists because
.BR groff (@MAN1EXT@)
by default deactivates the unsafe operations that are required by
.BR INITR .
The first pass looks for cross references,
and the second one includes them.
.B INITR
can be used several times,
but it is only the first occurrence of
.B INITR
that is active.
.
.IP
See also
.BR SETR ,
.BR GETPN ,
and
.BR GETHN .
.
.TP
.BI IND\ "arg1 \fR[\fParg2 \fR[.\|.\|.]]\fP"
Write a line in the index file selected by
.B INITI
with all arguments and the page number or header mark separated by tabs.
.
.RS
.IP
.B Examples
.
.IP
arg1\[rs]tpage number
.br
arg1\[rs]targ2\[rs]tpage number
.br
arg1\[rs]theader mark
.br
arg1\[rs]tpage number\[rs]theader mark
.RE
.
.TP
.B INDP
Print the index by running the command specified
by string variable
.BR Indcmd ,
which has `sort\ \-t\[rs]t' as the default value.
.B INDP
reads the output from the command to form the index,
by default in two columns (this can be changed by defining
.BR TYIND ).
The index is printed with string variable
.B Index
as header,
default is `INDEX'.
One-column processing is reactivated after the list.
.B INDP
calls the user-defined macros
.BR TXIND ,
.BR TYIND ,
and
.B TZIND
if defined.
.B TXIND
is called before printing the string `INDEX',
.B TYIND
is called instead of printing `INDEX', and
.B TZIND
is called after the printing and should take care of restoring to normal
operation again.
.
.TP
.B ISODATE \fR[\fP0\fR]\fP
Change the predefined date string in
.B DT
to ISO-format, this is, `YYYY-MM-DD'.
This can also be done by adding
.B \-rIso=1
on the command line.
Reverts to old date format if argument is\~\c
.BR 0 .
.
.TP
.BI IR\ "\fR[\fPitalic-text \fR[\fProman-text \fR[\fPitalic-text \fR[.\|.\|.]]]]\fP"
Italic-roman.
Even arguments are printed in italic, odd in roman.
See\~\c
.BR I .
.
.TP
.BI LB\ "text-indent mark-indent pad type \fR[\fPmark \fR[\fPLI-space \fR[\fPLB-space\fR]]]\fP"
List-begin macro.
This is the common macro used for all lists.
.I text-indent
is the number of spaces to indent the text from the current indentation.
.
.IP
.I pad
and
.I mark-indent
control where to put the mark.
The mark is placed within the mark area,
and
.I mark-indent
sets the number of spaces before this area.
By default it is\~0.
The mark area ends where the text begins.
The start of the text
is still controlled by
.IR text-indent .
.
.IP
The mark is left-justified within the mark area if
.I pad
is\~0.
If
.I pad
is greater than\~0,
.I mark-indent
is ignored,
and the mark is placed
.I pad
spaces before the text.
This right-justifies the mark.
.
.IP
If
.I type
is\~0 the list either has a hanging indentation or,
if argument
.I mark
is given,
the string
.I mark
as a mark.
.
.IP
If
.I type
is greater than\~0 automatic numbering occurs,
using arabic numbers if
.I mark
is empty.
.I mark
can then be any of `1', `A', `a', `I', or `i'.
.
.IP
.I type
selects one of six possible ways to display the mark.
.
.IP
.B type
.
.RS
.IP
.br
.TS
tab(@);
l l.
1@x.
2@x)
3@(x)
4@[x]
5@<x>
6@{x}
.TE
.RE
.
.IP
Every item in the list gets
.I LI-space
number of blank lines before them.
Default is\~1.
.
.IP
.B LB
itself prints
.I LB-space
blank lines.
Default is\~0.
.
.TP
.BI LC\ \fR[\fPlist-level\fR]\fP
List-status clear.
Terminates all current active lists down to
.IR list-level ,
or\~0 if no argument is given.
This is used by\~\c
.B H
to clear any active list.
.
.TP
.B LE \fR[\fP1\fR]\fP
List end.
Terminates the current list.
.B LE
outputs a blank line if an argument is given.
.
.TP
.BI LI\ \fR[\fPmark\ \fR[\fP1\fR|\fP2\fR]]\fP
List item preceding every item in a list.
Without argument,
.B LI
prints the mark determined by the current list type.
By giving
.B LI
one argument, it uses that as the mark instead.
Two arguments to
.B LI
makes
.I mark
a prefix to the current mark.
There is no separating space between the prefix
and the mark if the second argument is `2' instead of `1'.
This behaviour can also be achieved by setting number register
.B Limsp
to zero.
A zero length
.I mark
makes a hanging indentation instead.
.
.IP
A blank line is printed before the list item by default.
This behaviour can be controlled by number register
.BR Ls .
Pre-spacing occurs for each list level less than or equal to
.BR Ls .
Default value is 99.
There is no nesting limit.
.
.IP
The indentation can be changed through number register
.BR Li .
Default is\~6.
.
.IP
All lists begin with a list initialization macro,
.BR LB .
There are, however, seven predefined list types to make lists easier to use.
They all call
.B LB
with different default values.
.
.RS
.IP
.TS
tab(@);
l l.
\fBAL\fP@Automatically Incremented List
\fBML\fP@Marked List
\fBVL\fP@Variable-Item List
\fBBL\fP@Bullet List
\fBDL\fP@Dash List
\fBRL\fP@Reference List
\fBBVL\fP@Broken Variable List.
.TE
.RE
.
.IP
These lists are described at other places in this manual.
See also
.BR LB .
.
.TP
.BI LT\ \fR[\fIarg\fR]\fI
Format a letter in one of four different styles depending
on the argument.
See also section
.BR INTERNALS .
.
.RS
.IP
.TS
tab(@);
lb lb
l lx.
Arg@Style
BL@T{
Blocked.
Date line, return address, writer's address and closing
begins at the center of the line.
All other lines begin at the left margin.
T}
SB@T{
Semi-blocked.
Same as blocked,
except that the first line in every paragraph is indented five spaces.
T}
FB@T{
Full-blocked.
All lines begin at the left margin.
T}
SP@T{
Simplified.
Almost the same as the full-blocked style.
Subject and the writer's identification are printed in all-capital.
T}
.TE
.RE
.
.TP
.BI LO\ "type \fR[\fParg\fR]\fP"
Specify options in letter (see
.BR .LT ).
This is a list of the standard options:
.
.RS
.IP
.TS
tab(@);
l lx.
CN@T{
Confidential notation.
Prints `CONFIDENTIAL' on the second line below the date line.
Any argument replaces `CONFIDENTIAL'.
See also string variable
.BR LetCN .
T}
RN@T{
Reference notation.
Prints `In reference to:' and the argument two lines below the date line.
See also string variable
.BR LetRN .
T}
AT@T{
Attention.
Prints `ATTENTION:' and the argument below the inside address.
See also string variable
.BR LetAT .
T}
SA@T{
Salutation.
Prints `To Whom It May Concern:' or the argument if it was present.
The salutation is printed two lines below the inside address.
See also string variable
.BR LetSA .
T}
SJ@T{
Subject line.
Prints the argument as subject prefixed with `SUBJECT:'
two lines below the inside address,
except in letter type `SP',
where the subject is printed in all-capital without any prefix.
See also string variable
.BR LetSJ .
T}
.TE
.RE
.
.TP
.BI MC\ "column-size \fR[\fPcolumn-separation\fR]\fP"
Begin multiple columns.
Return to normal with
.BR 1C .
.B MC
creates as many columns as the current line length permits.
.I column-size
is the width of each column,
and
.I column-separation
is the space between two columns.
Default separation is
.IR column-size /15.
See also
.BR 1C .
.
.TP
.BI ML\ "mark \fR[\fPtext-indent\ " \fR[\fP1\fR]]\fP
Marked list start.
The
.I mark
argument is printed before each list item.
.I text-indent
sets the indent and overrides
.BR Li .
A third argument prohibits printing of a blank line before each item.
.
.TP
.BI MT\ "\fR[\fParg \fR[\fPaddressee\fR]]\fP"
Memorandum type.
The argument
.I arg
is part of a filename in `@TMAC_MDIR@/*.MT'.
Memorandum types 0 to\~5 are supported,
including type `string' (which gets internally mapped to type\~6).
.I addressee
just sets a variable, used in the AT&T macros.
.
.IP
.B arg
.
.RS
.IP
.TS
tab(@);
l l.
0@Normal memorandum, no type printed.
1@Memorandum with `MEMORANDUM FOR FILE' printed.
2@Memorandum with `PROGRAMMER'S NOTES' printed.
3@Memorandum with `ENGINEER'S NOTES' printed.
4@Released paper style.
5@External letter style.
.TE
.RE
.
.IP
See also
.BR COVER / COVEND ,
a more flexible type of front page.
.
.TP
.BI MOVE\ "y-pos \fR[\fPx-pos \fR[\fPline-length\fR]]\fP"
Move to a position, setting page offset to
.IR x-pos .
If
.I line-length
is not given, the difference between current and new page offset is used.
Use
.B PGFORM
without arguments to return to normal.
.
.TP
.BI MULB\ "cw1 space1 \fR[\fPcw2 space2 \fR[\fPcw3 \fR.\|.\|.]]\fP"
Begin a special multi-column mode.
All columns widths must be specified.
The space between the columns must be specified also.
The last column does not need any space definition.
.B MULB
starts a diversion,
and
.B MULE
ends the diversion and prints the columns.
The unit for the width and space arguments is `n',
but
.B MULB
accepts all normal unit specifications like `c' and `i'.
.B MULB
operates in a separate environment.
.
.TP
.B MULN
Begin the next column.
This is the only way to switch the column.
.
.TP
.B MULE
End the multi-column mode and print the columns.
.
.TP
.BI nP\ \fR[\fPtype\fR]\fP
Print numbered paragraph with header level two.
See
.BR .P .
.
.TP
.B NCOL
Force printing to the next column.
Don't use this together with the
.B MUL*
macros, see
.BR 2C .
.
.TP
.BI NS\ \fR[\fParg\ \fR[\fP1\fR]]\fP
Print different types of notations.
The argument selects between the predefined type of notations.
If the second argument is available,
then the argument becomes the entire notation.
If the argument doesn't select a predefined type,
it is printed as `Copy (\fIarg\fP) to'.
It is possible to add more standard notations,
see the string variables
.B Letns
and
.BR Letnsdef .
.
.RS
.IP
.TS
tab(@);
l l.
\fBArg@Notation\fP
\fInone\fP@Copy To
\[dq]\[dq]@Copy To
1@Copy To (with att.\&) to
2@Copy To (without att.\&) to
3@Att.
4@Atts.
5@Enc.
6@Encs.
7@Under separate cover
8@Letter to
9@Memorandum to
10@Copy (with atts.\&) to
11@Copy (without atts.\&) to
12@Abstract Only to
13@Complete Memorandum to
14@CC
.TE
.RE
.
.TP
.BI ND\ new-date
New date.
Overrides the current date.
Date is not printed if
.I new-date
is an empty string.
.
.TP
.BI OF\ \fR[\fParg\fR]\fP
Odd-page footer, a line printed just above the normal footer.
See
.B EF
and
.BR PF .
.
.IP
This macro defines string
.BR EOPof .
.
.TP
.BI OH\ \fR[\fParg\fR]\fP
Odd-page header, a line printed just below the normal header.
See
.B EH
and
.BR PH .
.
.IP
This macro defines string
.BR TPoh .
.
.TP
.B OP
Make sure that the following text is printed at the top
of an odd-numbered page.
Does not output an empty page if currently at the top of an odd page.
.
.TP
.BI P\ \fR[\fPtype\fR]\fP
Begin new paragraph.
.B P\c
\~without argument produces left-justified text,
even the first line of the paragraph.
This is the same as setting
.I type
to\~0.
If the argument is\~1,
the first line of text following\~\c
.B P
is indented by the number of spaces in number register
.BR Pi ,
by default\~5.
.
.IP
Instead of giving an argument to\~\c
.B P
it is possible to set the paragraph type in number register
.BR Pt .
Using 0 and\~1 is the same as adding that value to
.BR P .
A value of\~2 indents all paragraphs,
except after headings, lists, and displays
(this value can't be used as an argument to
.B P
itself).
.
.IP
The space between two paragraphs is controlled by number register
.BR Ps ,
and is\~1 by default (one blank line).
.
.TP
.BI PGFORM\ "\fR[\fPlinelength \fR[\fPpagelength \fR[\fPpageoffset\ " \fR[\fP1\fR]]]]\fP
Set line length, page length, and/or page offset.
This macro can be used for special formatting,
like letter heads and other.
It is normally the first command in a file,
though it is not necessary.
.B PGFORM
can be used without arguments to reset everything after a
.B MOVE
call.
A line break is done unless the fourth argument is given.
This can be used to avoid the page number on the first page
while setting new width and length.
(It seems as if this macro sometimes doesn't work too well.
Use the command line arguments to change
line length, page length, and page offset instead.)
.
.TP
.B PGNH
No header is printed on the next page.
Used to get rid of the header in letters or other special texts.
This macro must be used before any text to inhibit the page header
on the first page.
.
.TP
.BI "PIC \fR[\fP\-L\fR] [\fP\-C\fR] [\fP\-R\fR] [\fP\-I\ " "n\fR]\fP filename \fR[\fPwidth \fR[\fPheight\fR]]\fP"
Include a PostScript file in the document.
The macro depends on
.BR mmroff (@MAN1EXT@)
and
.BR INITR .
The arguments
.BR \-L ,
.BR \-C ,
.BR \-R ,
and
.BI \-I\ n
adjust the picture or indent it.
The optional
.I width
and
.I height
can also be given to resize the picture.
.
.TP
.B PE
Picture end.
Ends a picture for
.BR @g@pic (@MAN1EXT).
.
.TP
.BI PF\ \fR[\fParg\fR]\fP
Page footer.
.B PF
sets the line to be printed at the bottom of each page.
Empty by default.
See
.B PH
for the argument specification.
.
.IP
This macro defines string
.BR EOPf .
.
.TP
.BI PH\ \fR[\fParg\fR]\fP
Page header,
a line printed at the top of each page.
The argument should be specified as
.
.RS
.IP
.RI \[dq]' left-part ' center-part ' right-part '\[dq]
.RE
.
.IP
where
.IR left-part ,
.IR center-part,
and
.I right-part
are printed left-justified, centered, and right justified, respectively.
Within the argument to
.BR PH ,
the character `%' is changed to the current page number.
The default argument is
.
.RS
.IP
\[dq]''- % -''\[dq]
.RE
.
.IP
which gives the page number between two dashes.
.
.IP
This macro defines string
.BR TPh .
.
.TP
.B PS
Picture start (from pic).
Begins a picture for
.BR @g@pic (@MAN1EXT@).
.
.TP
.B PX
Page header user-defined exit.
This macro is called just after the printing of the page header in
.I no-space
mode.
.
.TP
.B R
Roman.
Return to roman font, see also\~\c
.BR I .
.
.TP
.BI RB\ "\fR[\fProman-text \fR[\fPbold-text \fR[\fProman-text \fR[.\|.\|.]]]]\fP"
Roman-bold.
Even arguments are printed in roman,
odd in boldface.
See\~\c
.BR I .
.
.TP
.BI RD\ "\fR[\fPprompt \fR[\fPdiversion \fR[\fPstring\fR]]]\fP"
Read from standard input to diversion and/or string.
The text is saved in a diversion named
.IR diversion .
Recall the text by writing the name of the diversion after a dot
on an empty line.
A string is also defined if
.I string
is given.
.I Diversion
and/or
.I prompt
can be empty (\[dq]\[dq]).
.
.TP
.B RF
Reference end.
Ends a reference definition and returns to normal processing.
See
.BR RS .
.
.TP
.BI RI\ "\fR[\fProman-text \fR[\fPitalic-text \fR[\fProman-text \fR[.\|.\|.]]]]\fP"
Print even arguments in roman, odd in italic.
See\~\c
.BR I .
.
.TP
.BI RL\ \fR[\fPtext-indent \fR[\fP1\fR]]\fP
Reference list start.
Begins a list where each item is preceded with an automatically
incremented number between square brackets.
.I text-indent
changes the default indentation.
.
.TP
.BI RP\ "\fR[\fParg1 \fR[\fParg2\fR]]\fP"
Produce reference page.
This macro can be used if a reference page is wanted somewhere in the
document.
It is not needed if
.B TC
is used to produce a table of contents.
The reference page is then printed automatically.
.
.IP
The reference counter is not reset if
.I arg1
is\~1.
.
.IP
.I arg2
tells
.B RP
whether to eject a page or not.
.
.IP
.B arg2
.
.RS
.IP
.TS
tab(@);
l lx.
0@The reference page is printed on a separate page.
1@Do not eject page after the list.
2@Do not eject page before the list.
3@Do not eject page before and after the list.
.TE
.RE
.
.IP
The reference items are separated by a blank line.
Setting number register
.B Ls
to\~0 suppresses the line.
.
.IP
The string
.B Rp
contains the reference page title and is set to `REFERENCES' by default.
The number register
.B Rpe
holds the default value for the second argument of
.BR RP ;
it is initially set to\~0.
.
.TP
.BI RS\ \fR[\fPstring-name\fR]\fP
Begin an automatically numbered reference definition.
Put the string
.B \[rs]*(Rf
where the reference mark should be and write the reference between
.BR RS / RF
at next new line after the reference mark.
The reference number is stored in number register
.BR :R .
If
.I string-name
is given,
a string with that name is defined and contains the current reference mark.
The string can be referenced as
.BI \[rs]*[ string-name ]
later in the text.
.
.TP
.BI S\ "\fR[\fPsize \fR[\fPspacing\fR]]\fP"
Set point size and vertical spacing.
If any argument is equal to `P',
the previous value is used.
A `C' means current value,
and `D' the default value.
If `+' or `\-' is used before the value,
the current value is incremented or decremented, respectively.
.
.TP
.BI SA\ \fR[\fParg\fR]\fP
Set right-margin justification.
Justification is turned on by default.
No argument or value `0' turns off justification,
and `1' turns on justification.
.
.TP
.BI SETR\ "refname \fR[\fPstring\fR]\fP"
Remember the current header and page number as
.IR refname .
Saves
.I string
if
.I string
is defined.
.I string
is retrieved with
.BR .GETST .
See
.BR INITR .
.
.TP
.BI SG\ \fR[\fParg\ \fR[\fP1\fR]]\fP
Signature line.
Prints the authors name(s) after the formal closing.
The argument is appended to the reference data,
printed at either the first or last author.
The reference data is the location,
department, and initials specified with
.BR .AU .
It is printed at the first author if the second argument is given,
otherwise at the last.
No reference data is printed if the author(s) is specified through
.BR .WA / .WE .
See section
.BR INTERNALS .
.
.TP
.BI SK\ \fR[\fPpages\fR]\fP
Skip pages.
If
.I pages
is\~0 or omitted,
a skip to the next page occurs unless it is already at the top of a page.
Otherwise it skips
.I pages
pages.
.
.TP
.BI SM\ "string1 \fR[\fPstring2 \fR[\fPstring3\fR]]\fP"
Make a string smaller.
If
.I string2
is given,
.I string1
is made smaller and
.I string2
stays at normal size,
concatenated with
.IR string1 .
With three arguments,
everything is concatenated,
but only
.I string2
is made smaller.
.
.TP
.BI SP\ \fR[\fPlines\fR]\fP
Space vertically.
.I lines
can have any scaling factor,
like `3i' or `8v'.
Several
.B SP
calls in a line only produces the maximum number of lines, not the sum.
.B SP
is ignored also until the first text line in a page.
Add
.B \[rs]&
before a call to
.B SP
to avoid this.
.
.TP
.B TAB
Reset tabs to every\ 5n.
Normally used to reset any previous tab positions.
.
.TP
.BI TB\ "\fR[\fPtitle \fR[\fPoverride \fR[\fPflag \fR[\fPrefname\fR]]]]\fP"
Table title.
The arguments are the same as for
.BR EC .
.B TB
uses the number register
.B Tb
as a counter.
The string
.B Lt
controls the title of the List of Tables;
default value is `LIST OF TABLES'.
The List of Tables is only printed if number register
.B Lt
is\~1, which is the default.
The string
.B Litb
contains the word `TABLE',
which is printed before the number.
.
.IP
Special handling of the title occurs if
.B TB
is used inside
.BR DS / DE ,
it is not affected by the format of
.BR DS .
.
.TP
.BI TC\ "\fR[\fPslevel \fR[\fPspacing \fR[\fPtlevel \fR[\fPtab \fR[\fPh1 \fR[\fPh2 \fR[\fPh3 \fR[\fPh4 \fR[\fPh5\fR]]]]]]]]]\fP"
Table of contents.
This macro is normally used as the last line of the document.
It generates a table of contents with headings up to the level
controlled by number register
.BR Cl .
Note that
.B Cl
controls the saving of headings,
it has nothing to do with
.BR TC .
Headings with a level less than or equal to
.I slevel
get
.I spacing
number of lines before them.
Headings with a level less than or equal to
.I tlevel
have their page numbers right-justified with dots or spaces separating
the text and the page number.
Spaces are used if
.I tab
is greater than zero,
dots otherwise.
Other headings have the page number directly at the end
of the heading text
.RI ( ragged-right ).
.
.IP
The rest of the arguments is printed, centered, before the
table of contents.
.
.IP
The user-defined macros
.B TX
and
.B TY
are used if
.B TC
is called with at most four arguments.
.B TX
is called before the printing of the string `CONTENTS',
and
.B TY
is called instead of printing `CONTENTS'.
.
.IP
Equivalent macros can be defined for list of figures, tables, equations
and exhibits by defining
.BI TX xx
or
.BI TY xx\fR,\fP
where
.I xx
is `Fg', `TB', `EC', or `EX', respectively.
.
.IP
String
.B Ci
can be set to control the indentations for each heading-level.
It must be scaled, like
.
.RS
.IP
\&.ds Ci .25i .5i .75i 1i 1i
.RE
.
.IP
By default,
the indentation is controlled by the maximum length of headings in each
level.
.
.IP
The string variables
.BR Lifg ,
.BR Litb ,
.BR Liex ,
.BR Liec ,
and
.B Licon
contain `Figure', `TABLE', `Exhibit', `Equation',
and `CONTENTS', respectively.
These can be redefined to other languages.
.
.TP
.B TE
Table end.
See
.BR TS .
.
.TP
.B TH \fR[\fPN\fR]\fP
Table header.
See
.BR TS .
.B TH
ends the header of the table.
This header is printed again if a page break occurs.
Argument `N' isn't implemented yet.
.
.TP
.BI TL\ "\fR[\fPcharging-case-number \fR[\fPfiling-case-number\fR]]\fP"
Begin title of memorandum.
All text up to the next
.B AU
is included in the title.
.I charging-case-number
and
.I filing-case-number
are saved for use in the front page processing.
.
.TP
.BI TM\ "\fR[\fPnum1 \fR[\fPnum2 \fR[.\|.\|.]]]\fP"
Technical memorandum numbers used in
.BR .MT .
An unlimited number of arguments may be given.
.
.TP
.B TP
Top-of-page user-defined macro.
This macro is called instead of the normal page header.
It is possible to get complete control over the header.
Note that the header and the footer are printed in a separate environment.
Line length is preserved, though.
See
.BR EOP .
.
.IP
.B strings available to TP
.RS
.TS
tab(@);
l l.
TPh@argument of \fBPH\fP
TPeh@argument of \fBEH\fP
TPoh@argument of \fBOH\fP
.TE
.RE
.
.TP
.B TS \fR[\fPH\fR]\fP
Table start.
This is the start of a table specification to
.BR @g@tbl (@MAN1EXT@).
.B TS
ends with
.BR TE .
Argument `H' tells
.B m@TMAC_M_PREFIX@m
that the table has a header.
See
.BR TH .
.
.TP
.B TX
User-defined table of contents exit.
This macro is called just before
.B TC
prints the word `CONTENTS'.
See
.BR TC .
.
.TP
.B TY
User-defined table of contents exit.
This macro is called instead of printing `CONTENTS'.
See
.BR TC .
.
.TP
.BI VERBON\ "\fR[\fPflag \fR[\fPpoint-size \fR[\fPfont\fR]]]\fP"
Begin verbatim output using Courier font.
Usually for printing programs.
All characters have equal width.
The point size can be changed with the second argument.
By specifying a third argument it is possible to use another
font instead of Courier.
.I flag
controls several special features.
Its value is the sum of all wanted features.
.
.RS
.IP
.TS
tab(@);
lb lb
l lx.
Arg@Description
1@T{
Disable the escape character (\[rs]).
This is normally turned on during verbose output.
T}
2@Add an empty line before the verbose text.
4@Add an empty line after the verbose text.
8@T{
Print the verbose text with numbered lines.
This adds four digit-sized spaces in the beginning of each line.
Finer control is available with the string variable
.BR Verbnm .
It contains all arguments to the
.BR troff (@MAN1EXT@)
command
.BR .nm ,
normally `1'.
T}
16@T{
Indent the verbose text by `5n'.
This is controlled by the number-variable
.B Verbin
(in units).
T}
.TE
.RE
.
.TP
.B VERBOFF
End verbatim output.
.
.TP
.BI VL\ "text-indent \fR[\fPmark-indent\ " \fR[\fP1\fR]]\fP
Variable-item list.
It has no fixed mark,
it assumes that every
.B LI
has a mark instead.
.I text-indent
sets the indent to the text,
and
.I mark-indent
the distance from the current indentation to the mark.
A third argument prohibits printing of a blank line before each item.
.
.TP
.BI "VM \fR[\fP\-T\fR] [\fP" "top \fR[\fPbottom\fR]]\fP"
Vertical margin.
Increase the top and bottom margin by
.I top
and
.IR bottom ,
respectively.
If option
.B \-T
is specified, set those margins to
.I top
and
.IR bottom .
If no argument is given, reset the margin to zero,
or to the default (`7v 5v') if
.B \-T
is used.
It is highly recommended that macros
.B TP
and/or
.B EOP
are defined if using
.B \-T
and setting top and/or bottom margin to less than the default.
.
.TP
.BI WA\ "\fR[\fPwriter-name \fR[\fPtitle\fR]]\fP"
Begin specification of the writer and writer's address.
Several names can be specified with empty
.BR WA / WE
pairs,
but only one address.
.
.TP
.B WE
End the address specification after
.BR .WA .
.
.TP
.BI WC\ "\fR[\fPformat1\fR] [\fPformat2\fR] [.\|.\|.]\fP"
Footnote and display width control.
.
.RS
.TS
tab(@);
l lx.
N@T{
Set default mode which is equal to using the options
.BR \-WF ,
.BR \-FF ,
.BR \-WD ,
and
.BR FB .
T}
WF@T{
Wide footnotes, wide also in two-column mode.
T}
-WF@Normal footnote width, follow column mode.
FF@T{
All footnotes gets the same width as the first footnote encountered.
T}
-FF@T{
Normal footnotes, width follows \fBWF\fP and \fB-WF\fP.
T}
WD@T{
Wide displays, wide also in two-column mode.
T}
-WD@T{
Normal display width, follow column mode.
T}
FB@T{
Floating displays generates a line break when printed on the current
page.
T}
-FB@T{
Floating displays does not generate line break.
T}
.TE
.RE
.
.
.SS "Strings used in m@TMAC_M_PREFIX@m"
.
.TP
.B App
A string containing the word `APPENDIX'.
.
.TP
.B Apptxt
The current appendix text.
.
.TP
.B EM
Em dash string
.
.TP
.B H1txt
Updated by
.B .H
and
.B .HU
to the current heading text.
Also updated in table of contents & friends.
.
.TP
.B HF
Font list for headings, `2 2 2 2 2 2 2' by default.
Non-numeric font names may also be used.
.
.TP
.B HP
Point size list for headings.
By default, this is `0 0 0 0 0 0 0' which is the same as
`10 10 10 10 10 10 10'.
.
.TP
.B Index
Contains the string `INDEX'.
.
.TP
.B Indcmd
Contains the index command.
Default value is `sort\ \-t\[rs]t'.
.
.TP
.B Lifg
String containing `Figure'.
.
.TP
.B Litb
String containing `TABLE'.
.
.TP
.B Liex
String containing `Exhibit'.
.
.TP
.B Liec
String containing `Equation'.
.
.TP
.B Licon
String containing `CONTENTS'.
.
.TP
.B Lf
Contains the string `LIST OF FIGURES'.
.
.TP
.B Lt
Contains the string `LIST OF TABLES'.
.
.TP
.B Lx
Contains the string `LIST OF EXHIBITS'.
.
.TP
.B Le
Contains the string `LIST OF EQUATIONS'.
.
.TP
.B Letfc
Contains the string `Yours very truly,',
used in
.BR .FC .
.
.TP
.B Letapp
Contains the string `APPROVED:',
used in
.BR .AV .
.
.TP
.B Letdate
Contains the string `Date',
used in
.BR .AV .
.
.TP
.B LetCN
Contains the string `CONFIDENTIAL',
used in
.BR ".LO CN" .
.
.TP
.B LetSA
Contains the string `To Whom It May Concern:',
used in
.BR ".LO SA" .
.
.TP
.B LetAT
Contains the string `ATTENTION:',
used in
.BR ".LO AT" .
.
.TP
.B LetSJ
Contains the string `SUBJECT:',
used in
.BR ".LO SJ" .
.
.TP
.B LetRN
Contains the string `In reference to:',
used in
.BR ".LO RN" .
.
.TP
.B Letns
is an array containing the different strings used in
.BR .NS .
It is really a number of string variables prefixed with
.BR Letns! .
If the argument doesn't exist,
it is included between
.B ()
with
.B Letns!copy
as a prefix and
.B Letns!to
as a suffix.
Observe the space after `Copy' and before `to'.
.
.RS
.IP
.TS
tab(@);
lb lb
l l.
Name@Value
Letns!0@Copy to
Letns!1@Copy (with att.\&) to
Letns!2@Copy (without att.\&) to
Letns!3@Att.
Letns!4@Atts.
Letns!5@Enc.
Letns!6@Encs.
Letns!7@Under separate cover
Letns!8@Letter to
Letns!9@Memorandum to
Letns!10@Copy (with atts.\&) to
Letns!11@Copy (without atts.\&) to
Letns!12@Abstract Only to
Letns!13@Complete Memorandum to
Letns!14@CC
Letns!copy@Copy \[rs]"
Letns!to@" to
.TE
.RE
.
.TP
.B Letnsdef
Define the standard notation used when no argument is given to
.BR .NS .
Default is\~0.
.
.TP
.B "MO1 - MO12"
Strings containing the month names `January' through `December'.
.
.TP
.B Qrf
String containing `See chapter \[rs]\[rs]*[Qrfh], page \[rs]\[rs]n[Qrfp].'.
.
.TP
.B Rp
Contains the string `REFERENCES'.
.
.TP
.B Tcst
Contains the current status of the table of contents and list of figures,
etc.
Empty outside of
.BR .TC .
Useful in user-defined macros like
.BR .TP .
.
.RS
.IP
.TS
tab(@);
lb lb
l l.
Value@Meaning
co@Table of contents
fg@List of figures
tb@List of tables
ec@List of equations
ex@List of exhibits
ap@Appendix
.TE
.RE
.
.TP
.B Tm
Contains the string `\[rs](tm', the trade mark symbol.
.
.TP
.B Verbnm
Argument to
.B .nm
in the
.B .VERBON
command.
Default is\~1.
.
.
.SS "Number variables used in m@TMAC_M_PREFIX@m"
.
.TP
.B Aph
Print an appendix page for every new appendix if this number variable
is non-zero.
No output occurs if
.B Aph
is zero, but there is always an appendix entry in the `List of contents'.
.
.TP
.B Cl
Contents level (in the range 0 to 14).
The contents is saved if a heading level is lower than or equal to the
value of
.BR Cl .
Default is\~2.
.
.TP
.B Cp
Eject page between list of table, list of figure, etc., if the value of
.B Cp
is zero.
Default is\~0.
.
.TP
.B D
Debug flag.
Values greater than zero produce debug information of increasing verbosity.
A value of\~1 gives information about the progress of formatting.
Default is\~0.
.
.TP
.B De
If set to\~1, eject after floating display is output.
Default is\~0.
.
.TP
.B Dsp
If defined, it controls the space output before and after static displays.
Otherwise the value of
.B Lsp
is used.
.
.TP
.B Df
Control floating keep output.
This is a number in the range 0 to 5, with a default value of\~5.
See
.BR .DF .
.
.TP
.B Ds
If set to\~1, use the amount of space stored in register
.B Lsp
before and after display.
Default is\~1.
.
.TP
.B Ej
If set to\~1, eject page before each first-level heading.
Default is\~0.
.
.TP
.B Eq
Equation labels are left-adjusted if set to\~0
and right-adjusted if set to\~1.
Default is\~0.
.
.TP
.B Fs
Footnote spacing.
Default is\~1.
.
.TP
.B "H1 - H7"
Heading counters
.
.TP
.B H1dot
Append a dot after the level-one heading number if value is greater than
zero.
Default is\~1.
.
.TP
.B H1h
A copy of number register
.BR H1 ,
but it is incremented just before the page break.
Useful in user-defined header macros.
.
.TP
.B Hb
Heading break level.
A number in the range 0 to 14,
with a default value of\~2.
See\~\c
.BR .H .
.
.TP
.B Hc
Heading centering level.
A number in the range 0 to 14,
with a default value value of\~0.
See\~\c
.BR .H .
.
.TP
.B Hi
Heading temporary indent.
A number in the range 0 to 2,
with a default value of\~1.
.
.RS
.IP
.TS
tab(@);
l lx.
0@no indentation, left margin
1@T{
indent to the right, similar to
.RB ` ".P 1" '
T}
2@T{
indent to line up with text part of preceding heading
T}
.TE
.RE
.
.TP
.B Hps
Heading pre-space level.
If the heading level is less than or equal to
.BR Hps ,
two lines precede the section heading instead of one.
Default is first level only.
The real amount of lines is controlled by the variables
.B Hps1
and
.BR Hps2 .
.
.TP
.B Hps1
Number of lines preceding
.B .H
if the heading level is greater than
.BR Hps .
Value is in units, default is 0.5.
.
.TP
.B Hps2
Number of lines preceding
.B .H
if the heading level is less than or equal to
.BR Hps .
Value is in units, default is\~1.
.
.TP
.B Hs
Heading space level.
A number in the range 0 to 14,
with a default value of\~2.
See\~\c
.BR .H .
.
.TP
.B Hss
Number of lines following
.B .H
if the heading level is less than or equal to
.BR Hs .
Value is in units, default is\~1.
.
.TP
.B Ht
Heading numbering type.
.
.RS
.IP
.TS
tab(@);
l l.
0@multiple levels (1.1.1, 1.1.2, etc.)
1@single level
.TE
.RE
.IP
Default is\~0.
.
.TP
.B Hu
Unnumbered heading level.
Default is\~2.
.
.TP
.B Hy
Hyphenation status of text body.
.
.RS
.IP
.TS
tab(@);
l l.
0@no hyphenation
1@hyphenation on, set to value\~14
.TE
.RE
.
.IP
Default is\~0.
.
.TP
.B Iso
Set this variable to\~1 on the command line to get an
ISO-formatted date string (\fB\-rIso=1\fP).
Useless inside of a document.
.
.TP
.B L
Page length, only for command line settings.
.
.TP
.B Letwam
Maximum lines in return-address, used in
.BR .WA / .WE .
Default is\~14.
.
.TP
.BR Lf ,\ Lt ,\ Lx ,\ Le
Enable (1) or disable (0) the printing of List of figures,
List of tables, List of exhibits and List of equations, respectively.
Default values are Lf=1, Lt=1, Lx=1, and Le=0.
.
.TP
.B Li
List indentation, used by
.BR .AL .
Default is\~6.
.
.TP
.B Limsp
A flag controlling the insertion of space between prefix and mark in
automatic lists
.RB ( .AL ).
.
.RS
.IP
.TS
tab(@);
l l.
0@no space
1@emit space
.TE
.RE
.
.TP
.B Ls
List space threshold.
If current list level is greater than
.B Ls
no spacing occurs around lists.
Default is\~99.
.
.TP
.B Lsp
The vertical space used by an empty line.
The default is 0.5v in troff mode and 1v in nroff mode.
.
.TP
.B N
Page numbering style.
.
.RS
.IP
.TS
tab(@);
l lx.
0@normal header for all pages.
1@T{
header replaces footer on first page, header is empty.
T}
2@page header is removed on the first page.
3@`section-page' numbering style enabled.
4@page header is removed on the first page.
5@T{
`section-page' and `section-figure' numbering style enabled.
T}
.TE
.RE
.
.IP
Default is\~0.
See also the number registers
.B Sectf
and
.BR Sectp .
.
.TP
.B Np
A flag to control whether paragraphs are numbered.
.
.RS
.IP
.TS
tab(@);
l l.
0@not numbered
1@numbered in first-level headings.
.TE
.RE
.
.IP
Default is\~0.
.
.TP
.B O
Page offset, only for command line settings.
.
.TP
.B Of
Format of figure, table, exhibit, and equation titles.
.
.RS
.IP
.TS
tab(@);
l l.
0@\[dq]. \[dq]
1@\[dq] - \[dq]
.TE
.RE
.
.IP
Default is\~0.
.
.TP
.B P
Current page-number, normally the same as `%' unless
`section-page' numbering style is enabled.
.
.TP
.B Pi
Paragraph indentation.
Default is\~5.
.
.TP
.B Pgps
A flag to control whether header and footer point size should follow
the current settings or just change when the header and footer are defined.
.
.RS
.IP
.TS
tab(@);
l lx.
0@T{
Point size only changes to the current setting when
.BR .PH ,
.BR .PF ,
.BR .OH ,
.BR .EH ,
.BR .OF ,
or
.B .OE
is executed.
T}
1@T{
Point size changes after every
.BR .S .
This is the default.
T}
.TE
.RE
.
.TP
.B Ps
Paragraph spacing.
Default is\~1.
.
.TP
.B Pt
Paragraph type.
.
.RS
.IP
.TS
tab(@);
l lx.
0@left-justified
1@indented paragraphs
2@T{
indented paragraphs except after
.BR .H ,
.BR .DE ,
or
.BR .LE .
T}
.TE
.RE
.
.IP
Default is\~0.
.
.TP
.B Rpe
Set default value for second argument of
.BR .RP .
Default is\~0.
.
.TP
.B Sectf
A flag controlling `section-figures' numbering style.
A non-zero value enables this.
See also register\~\c
.BR N .
.
.TP
.B Sectp
A flag controlling `section-page' numbering style.
A non-zero value enables this.
See also register\~\c
.BR N .
.
.TP
.B Si
Display indentation.
Default is\~5.
.
.TP
.B Verbin
Indentation for
.BR .VERBON .
Default is 5n.
.
.TP
.B W
Line length, only for command line settings.
.
.TP
.B .mgm
Always\~1.
.
.
.SH INTERNALS
.
The letter macros are using different submacros depending on
the letter type.
The name of the submacro has the letter type
as suffix.
It is therefore possible to define other letter types,
either in the national macro-file, or as local additions.
.B .LT
sets the number variables
.B Pt
and
.B Pi
to 0 and\~5, respectively.
The following strings and macros must be defined for a new letter type.
.
.TP
.BI let@init_ type
This macro is called directly by
.BR .LT .
It is supposed to initialize variables and other stuff.
.
.TP
.BI let@head_ type
This macro prints the letter head,
and is called instead of the normal page header.
It is supposed to remove the alias
.BR let@header ,
otherwise it is called for all pages.
.
.TP
.BI let@sg_ "type name title n flag \fR[\fParg1 \fR[\fParg2 \fR[.\|.\|.]]]\fP"
.B .SG
is calling this macro only for letters;
memorandums have its own processing.
.I name
and
.I title
are specified through
.BR .WA / .WB .
.I n\c
\~is the counter, 1-max,
and
.I flag
is true for the last name.
Any other argument to
.B .SG
is appended.
.
.TP
.BI let@fc_ "type closing"
This macro is called by
.BR .FC ,
and has the formal closing as the argument.
.
.LP
.B .LO
is implemented as a general option-macro.
It demands that a string named
.BI Let type
is defined, where
.I type
is the letter type.
.B .LO
then assigns the argument to the string variable
.BI let*lo- type\fR.\fP
.
.
.\".SH BUGS
.
.
.SH AUTHOR
.
Jrgen Hgg, Lund, Sweden <jh@axis.se>.
.
.
.SH FILES
.
.TP
.B @MACRODIR@/@TMAC_M_PREFIX@m.tmac
.TP
.B @TMAC_MDIR@/*.cov
.TP
.B @TMAC_MDIR@/*.MT
.TP
.B @TMAC_MDIR@/locale
.
.
.SH "SEE ALSO"
.
.BR groff (@MAN1EXT@),
.BR @g@troff (@MAN1EXT@),
.BR @g@tbl (@MAN1EXT@),
.BR @g@pic (@MAN1EXT@),
.BR @g@eqn (@MAN1EXT@)
.br
.BR groff_mmse (@MAN7EXT@)
(only in Swedish locales)
.
.\" Local Variables:
.\" mode: nroff
.\" coding: latin-1
.\" End:
|