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
|
<HTML>
<HEAD>
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1">
<META NAME="GENERATOR" CONTENT="Mozilla/4.03 [en] (X11; I; Linux 2.0.32 i686) [Netscape]">
<META NAME="Author" CONTENT="Lee McLoughlin and Zoe Leech">
<TITLE>Mirror 2.9 Reference Manual</TITLE>
<!--
Copyright (C) 1990 - 1997 Lee McLoughlin
Permission to use, copy, and distribute this software and its
documentation for any purpose with or without fee is hereby granted,
provided that the above copyright notice appear in all copies and
that both that copyright notice and this permission notice appear
in supporting documentation.
Permission to modify the software is granted, but not the right to
distribute the modified code. Modifications are to be distributed
as patches to released version.
This software is provided "as is" without express or implied warranty.
$Id: mirror.html,v 2.9 1998/05/29 19:03:01 lmjm Exp lmjm $
$Log: mirror.html,v $
Revision 2.9 1998/05/29 19:03:01 lmjm
*** empty log message ***
-->
</HEAD>
<BODY TEXT="#000000" BGCOLOR="#FFFFFF" LINK="#0000EF" VLINK="#51188E" ALINK="#FF0000">
<CENTER>
<H1>
Mirror 2.9 Reference Manual</H1></CENTER>
<CENTER>
<H1>
<I>Lee McLoughlin</I></H1></CENTER>
<CENTER><I><FONT SIZE=+0>and</FONT></I></CENTER>
<CENTER>
<H1>
<I><FONT SIZE=+3>Zoë Leech</FONT></I></H1></CENTER>
<CENTER>1 June 1998</CENTER>
<CENTER><TT><A HREF="mailto:lmjm@icparc.ic.ac.uk">lmjm@icparc.ic.ac.uk</A></TT></CENTER>
<CENTER><TT><A HREF="zl@icparc.ic.ac.uk">zl@icparc.ic.ac.uk</A></TT></CENTER>
<UL>
<LI>
<A HREF="#Introduction">Introduction</A></LI>
<LI>
<A HREF="#Description">Description</A></LI>
<LI>
<A HREF="#Flags">Flags</A></LI>
<LI>
<A HREF="#Package Files">Package Files</A></LI>
<UL>
<LI>
<A HREF="#Keywords">Keywords</A></LI>
</UL>
<LI>
<A HREF="#Filestores">Filestores</A></LI>
<LI>
<A HREF="#Examples">Examples</A></LI>
<LI>
<A HREF="#Temporary Filenames">Temporary Filenames</A></LI>
<LI>
<A HREF="#Regular Expressions">Regular Expressions</A></LI>
<LI>
<A HREF="#Hints">Hints</A></LI>
<LI>
<A HREF="#Netiquette">Netiquette</A></LI>
<LI>
<A HREF="#Bugs">Bugs</A></LI>
<LI>
<A HREF="#Remember!">Remember!</A></LI>
<LI>
<A HREF="#Author">Author</A></LI>
</UL>
<H2>
<A NAME="Introduction"></A>Introduction</H2>
<B>Mirror</B> is a package written in <B><A HREF="http://www.perl.com/">Perl</A></B>
that uses the FTP<A HREF="http://sunsite.org.uk/rfc/rfc959.txt"> protocol
</A>to duplicate a directory hierarchy between the machine it is run on
and a remote host. It avoids copying files unnecessarily by comparing the
file time-stamps and file sizes before transferring. Amongst other things,
it can optionally rename, compress, gzip, and split files.
<P><B>Mirror</B> was written by <A HREF="http://sunsite.org.uk/~lmjm/">Lee
McLoughlin</A> <<A HREF="mailto:lmjm@icparc.ic.ac.uk">lmjm@icparc.ic.ac.uk</A>>
for use by archive maintainers but can be used by anyone wanting to transfer
a lot of files via FTP. Although originally only available on Un*x
with version 2.9 <B>mirror</B> will also run on Wind*ws 95 and Wind*ws
NT.
<BR>
<P>The latest version of <B>mirror</B> can always be found at either:
<UL><TT><FONT SIZE=+1><A HREF="ftp://sunsite.org.uk/packages/mirror/mirror.tar.gz">ftp://sunsite.org.uk/packages/mirror/mirror.tar.gz</A></FONT></TT>
<BR><TT><FONT SIZE=+1><A HREF="ftp://sunsite.org.uk/packages/mirror/mirror.zip">ftp://sunsite.org.uk/packages/mirror/mirror.zip</A></FONT></TT></UL>
The latest version of this guide can always be found at:
<UL><TT><FONT SIZE=+1><A HREF="http://sunsite.org.uk/packages/mirror/mirror-guide.html">http://sunsite.org.uk/packages/mirror/</A></FONT></TT></UL>
<H2>
<A NAME="Description"></A>Description</H2>
<B>Mirror</B> is called in one of two ways (see also mirror master):
<UL>
<PRE><TT><FONT SIZE=+1>mirror [flags] <A HREF="#-g">-g</A>site:pathname</FONT></TT></PRE>
<PRE><TT><FONT SIZE=+1>mirror [flags] [<A HREF="#Package Files">package-files</A>]</FONT></TT></PRE>
</UL>
The first method is used to retrieve a remote file or directory into the
current directory. If you are mirroring a directory it is best to end the
pathname in a slash ('/') as this makes the remote recursive listing smaller
or use the <B><A HREF="#-r">-r</A></B> flag to suppress recursion (see
<B><A HREF="#-g">-g</A></B> below). The <B><A HREF="#Setting Defaults">mirror.defaults</A></B>
file is not used.
<P>In the second method given above, a minimal number of arguments are
required and <B>mirror</B> is controlled by <B><I><A HREF="#Keywords">keyword=value</A></I></B>
lines read from the package files. <A NAME="Finding Defaults"></A>If
a file named <B><A HREF="#Setting Defaults">mirror.defaults</A></B> is
found in either the directory containing the <B>mirror</B> executable or
in the <B>PERLLIB</B> path, then it is loaded before any of the <TT><FONT SIZE=+1>package-files</FONT></TT>.
<B><A HREF="#Setting Defaults">mirror.defaults</A></B> normally just contains
the package of keyword settings called <B><I><A HREF="#Setting Defaults">defaults</A></I></B>
that is used to provide common defaults for all <TT><FONT SIZE=+1>package-files</FONT></TT>.
If no <B><A HREF="#Setting Defaults">mirror.defaults</A></B> file is found
the <A HREF="#Keywords">default settings</A> built into <B>mirror </B>
are used.
<P>Each <TT><FONT SIZE=+1><A HREF="#Package Files">package-files</A></FONT></TT>
is read in turn, looking for named <A HREF="#Package Files">packages</A>.
If the package is not named <B><I><A HREF="#Setting Defaults">defaults</A></I>,</B>
then <B>mirror</B> will perform the following steps.
<P>If <B>mirror</B> is already connected to a site, other than the target
site, it will disconnect from the site. It then changes to the given
local directory, creating it if necessary, and scans it to get the details
of the local files that are already there. <B>Mirror</B> then attempts
to connect to the remote site's FTP daemon. It will then login using the
given <B><I><A HREF="#remote_user">remote_user</A></I></B> and <B><I><A HREF="#remote_password">remote_password</A></I></B>.
The remote directory is then scanned. <B>Mirror</B> does this by changing
to the remote directory (<B><I><A HREF="#remote_dir">remote_dir</A></I></B>)
and running the FTP LIST command, passing the <B><I><A HREF="#flags_recursive">flags_recursive</A></I></B>
or <B><I><A HREF="#flags_nonrecursive">flags_nonrecursive</A></I></B> options
depending on the value of <B><I><A HREF="#recursive">recursive</A></I></B>.
Alternatively a file containing the directory listing may be retrieved
(see <B><I><A HREF="#ls_lR_file">ls_lR_file</A></I></B> and <B><I><A HREF="#local_ls_lR_file">local_ls_lR_file</A></I></B>)
. Each remote pathname will have any required mappings performed on it
to create a local pathname. Then any checks specified by the <I><B><A HREF="#exclude_patt">exclude_patt</A></B>,</I>
<B><I><A HREF="#max_days">max_days</A></I></B>, <B><I><A HREF="#get_newer">get_newer</A></I></B>
and <B><I><A HREF="#get_size_change">get_size_change</A> </I></B>keywords
are applied to names of files or symlinks. <B><I><A HREF="#max_days">max_days</A></I></B>,
<B><I><A HREF="#get_newer">get_newer</A></I></B> and <B><I><A HREF="#get_size_change">get_size_change</A>
</I></B>are not applied to directories. This creates a list of all
required remote files and the local pathnames to store them in.
<P>Local versions of all required directories are then created. Then
all required files are fetched from the remote site into their local pathnames.
This is done by retrieving the file into a <A HREF="#Temporary Filenames">temporary
file</A> in the target directory. The transfer is normally done in binary
mode (see <B><I><A HREF="#vms_xfer_text">vms_xfer_text</A></I></B>).
If required the temporary file may be <A HREF="#File Compression">compressed,
gzip'ed</A> or <A HREF="#File Splitting">split</A>. The file's time-stamps
are reset to match those of the remote file. Finally the temporary
file is renamed to have the correct name.
<P>Once all files have been transferred any required symbolic links are
created (where support by your Operating System) and any unnecessary pathnames
in the mirror are <A HREF="#File Deletion">deleted</A>.
<P>Unless an internal failure is detected, any error will cause the current
package to be skipped and the next one tried.
<P><B>Mirror</B> can handle symbolic links but not hard links. It does
not duplicate owner or group information as usually this is meaningless
over a network (but see <B><I><A HREF="#user">user</A></I></B> and <B><I><A HREF="#group">group</A></I></B>).
If you require any of these options and you are on Un*x use <B>rdist(1)</B>
instead.
<P><B>Mirror</B> was written to mirror remote Un*x archives, but has grown
(like topsy).
<H2>
<A NAME="Flags"></A>Flags</H2>
Although <B>mirror</B> has a large number of command line flags most should
only really be used when doing a very simple mirror as a one-time event.
If you intend to maintain a mirror area it is much better to put all the
details into a <B>mirror</B> <A HREF="#Package Files">package</A> file
and then run <B>mirror</B> on that file.
<P>The only flags you should use often are <B><A HREF="#-n">-n</A></B>
and, if you like to see what mirror is up to,<B><A HREF="#-d">-d</A></B>.
<BR>
<TABLE>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><A NAME="-d"></A><B>-d </B></TD>
<TD ALIGN=LEFT VALIGN=TOP>Enable debugging. If this argument is given more
than once (e.g. -d -d) the debugging level will increase. Currently the
maximum useful level is four.</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><A NAME="-n"></A><B>-n</B> </TD>
<TD ALIGN=LEFT VALIGN=TOP>Do nothing except compare local and remote directories,
no file transfers are done. Sets debug level to two, so that you are shown
a trace of what would be done.</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><A NAME="-g"></A><B>-g site:path</B> </TD>
<TD ALIGN=LEFT VALIGN=TOP>Get all files matching path, which is a
<A HREF="#Regular Expressions">regexp</A>, on the given site. If path matches
.*/.+ (e.g. /fred or /fred/bloggs) then it is the name of the directory
and everything after the last / is the pattern of filenames to get. If
path ends with / then it is the name of a directory and all its contents
are retrieved. One note of caution. If you use host:/fred, a full
directory listing of / on the remote host will be done. If all you wanted
was the contents of the directory /fred then specify host:/fred/</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><A NAME="-p"></A><B>-p package</B> </TD>
<TD ALIGN=LEFT VALIGN=TOP>When using multiple <A HREF="#Package Files">package
files </A>only mirror the given package. This option may be given multiple
times in which case all the given packages will be mirrored. Without this
option, all packages will be mirrored. Package is a <A HREF="#Regular Expressions">regexp</A>
matched against the package name following the -p.</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><B>-R package</B> </TD>
<TD ALIGN=LEFT VALIGN=TOP>Similar to <B><A HREF="#-p">-p</A></B> but skips
all packages until it reaches the given package. Useful for restarting
failed <B>mirror</B> runs from where they left off.</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><B>-F</B> </TD>
<TD ALIGN=LEFT VALIGN=TOP>Use temporary <B>dbm</B> files for the information
about files. This is useful if you mirror a very large directory.
See the variable <B><I><A HREF="#use_files">use_files</A>.</I></B></TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><A NAME="-r"></A><B>-r</B> </TD>
<TD ALIGN=LEFT VALIGN=TOP>Equivalent to <B>-k <I><A HREF="#recursive">recursive</A></I>=false</B></TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><B>-v</B> </TD>
<TD ALIGN=LEFT VALIGN=TOP>Print the version details of <B>mirror</B> and
exit.<A NAME="-T"></A></TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><B>-T</B> </TD>
<TD ALIGN=LEFT VALIGN=TOP>Do not do any file transfers just force the time-stamps
of any local files to be reset to be the same as the remote files. Normally
only used when initialising a mirror that already contains files retrieved
another way (e.g. from CDROM).</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><B>-Ufilename</B> </TD>
<TD ALIGN=LEFT VALIGN=TOP>Record all files transfered by mirror into the
given filename. Remember that <B>mirror</B> changes into <I><A HREF="#local_dir">local_dir</A></I>
to do its work, so it should be a full pathname. If no filename is given,
it defaults to <TT><FONT SIZE=+1>upload_log.day.month.year</FONT></TT>.</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><A NAME="-k"></A><B>-k <I>key</I>=value</B> </TD>
<TD ALIGN=LEFT VALIGN=TOP>Override any default key/value. See below</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><B>-m</B> </TD>
<TD ALIGN=LEFT VALIGN=TOP>Equivalent to <B><A HREF="#-k">-k</A> <I><A HREF="#mode_copy">mode_copy</A></I>=true</B> </TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><B>-t</B> </TD>
<TD ALIGN=LEFT VALIGN=TOP>Equivalent to <B><A HREF="#-k">-k</A> <I><A HREF="#text_mode">text_mode</A></I>=true</B></TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><B>-f</B> </TD>
<TD ALIGN=LEFT VALIGN=TOP>Equivalent to <B><A HREF="#-k">-k</A> <I><A HREF="#force">force</A></I>=true</B></TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><B>-s site</B> </TD>
<TD ALIGN=LEFT VALIGN=TOP>Equivalent to <B><A HREF="#-k">-k</A> <I><A HREF="#site">site</A></I>=site</B></TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><B>-u user</B> </TD>
<TD ALIGN=LEFT VALIGN=TOP>Equivalent to <B><A HREF="#-k">-k</A> <I><A HREF="#remote_user">remote_user</A></I>=user</B>
You are then prompted for a password, with echo turned off. The password
is used as the <B><I><A HREF="#remote_password">remote_password</A></I></B>.</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><B>-L</B></TD>
<TD ALIGN=LEFT VALIGN=TOP>Just generate a pretty printed version of the
input and exit.</TD>
</TR>
</TABLE>
<H2>
<A NAME="Package Files"></A>Package Files</H2>
Each group of keywords defines how to mirror a particular package and should
begin with a unique <B><I><A HREF="#package">package</A></I></B> line.
The package name is used in report generation and by the <B><A HREF="#-p">-p</A></B>
argument, so pick something mnemonic. The minimum needed for each package
is <B><I><A HREF="#package">package</A></I></B>, <B><I><A HREF="#site">site</A></I></B>,
<B><I><A HREF="#remote_dir">remote_dir</A></I></B> and <B><I><A HREF="#local_dir">local_dir</A></I></B>
. On finding a <B><I><A HREF="#package">package</A></I></B> line, all the
default values are reset to either the values from the <B><I><A HREF="#Setting Defaults">defaults</A></I></B>
package (or built-in values if defaults has not been set). A package
ends at either the next <B><I><A HREF="#package">package</A></I></B> statement
or at the end of file.
<P>Package files are parsed as a series of statements. Blank lines and
lines beginning with a hash are ignored. Each statement is of the form
<UL><B><I>keyword</I>=value</B></UL>
or
<UL><B><I>keyword</I>+value</B></UL>
You can add whitespace before the keyword and the equals/plus. Everything
immediately following the equals/plus is the value, including any leading
or trailing whitespace. The equals version sets the keyword to this value,
while the plus version concatenates the value onto the end of the existing
value (normally set in <B><I><A HREF="#Setting Defaults">defaults</A></I></B>
package).
<P>A statement can be continued over multiple lines by ending all lines
except the last, with the character ampersand ('&'). The line following
the ampersand, is appended to the current line with all leading whitespace
removed.
<P>Although there are a lot of keywords that can be set, the built-in defaults
will handle most cases. Normally only <B><I><A HREF="#package">package</A></I></B>,
<B><I><A HREF="#site">site</A></I></B>, <B><I><A HREF="#remote_dir">remote_dir</A></I></B>
and <B><I><A HREF="#local_dir">local_dir</A></I></B> need to be set.
<H3>
<A NAME="Setting Defaults"></A>Setting Defaults</H3>
If the package name is <B>defaults</B>, then no site is contacted, but
the default values given for any keywords are changed. Normally all the
defaults are in the file <B>mirror.defaults</B> which will be automatically
loaded before any <A HREF="#Package Files">package files</A> (see <A HREF="#Finding Defaults">Description</A>).
<PRE><TT># Sample mirror.defaults
package=defaults
# The LOCAL hostname - if not the same as `hostname` returns
# (I advertise the name sunsite.org.uk but the machine is
# really swallow.doc.ic.ac.uk.)
hostname=sunsite.org.uk
# Keep all local_dirs relative to here
local_dir=/public/
remote_password=wizards@sunsite.org.uk</TT></PRE>
<H3>
<A NAME="Keywords"></A>Keywords</H3>
The following is a list of all the available keywords and the default values
built into <B>mirror</B>. To change these defaults it is usually
best to change your <B><A HREF="#Setting Defaults">mirror.defaults </A></B>file.
<BR>
<BR>The keywords are grouped into the following sections:
<UL>
<LI>
<A HREF="#Required Keywords">Required Keywords</A></LI>
<LI>
<A HREF="#FTP Related">FTP Related</A></LI>
<LI>
<A HREF="#File Copying">File Copying</A></LI>
<LI>
<A HREF="#Local File Attributes">Local File Attributes</A></LI>
<LI>
<A HREF="#File Deletion">File Deletion</A></LI>
<LI>
<A HREF="#File Compression">File Compression</A></LI>
<LI>
<A HREF="#File Splitting">File Splitting</A></LI>
<LI>
<A HREF="#Directory Listings">Directory Listings</A></LI>
<LI>
<A HREF="#Logging">Logging</A></LI>
<LI>
<A HREF="#Special">Special</A></LI>
</UL>
<TABLE NOSAVE >
<TR VALIGN=TOP>
<TD COLSPAN="3"><A NAME="Required Keywords"></A><B><U><FONT SIZE=+1>Required
Keywords </FONT></U></B></TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><B><I><U>keyword</U></I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I><U>default</U></I></TD>
<TD ALIGN=LEFT VALIGN=TOP><U>Description</U></TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><A NAME="package"></A><B><I>package</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>none</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>A name for the package to be mirrored.
Should be different from all other package names you use.</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><A NAME="site"></A><B><I>site</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>none</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>Hostname or IP address of the remote site to
mirror from.</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><A NAME="remote_dir"></A><B><I>remote_dir</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>none</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>Remote directory to mirror. See also <B><I><A HREF="#recurse_hard">recurse_hard</A></I></B>.</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><A NAME="local_dir"></A><B><I>local_dir</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>none</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>Local directory.</TD>
</TR>
<TR>
<TD> </TD>
</TR>
<TR VALIGN=TOP>
<TD COLSPAN="3"><A NAME="FTP Related"></A><B><U><FONT SIZE=+1>FTP Related </FONT></U></B></TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><B><I><U>keyword</U></I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I><U>default</U></I></TD>
<TD ALIGN=LEFT VALIGN=TOP><U>Description</U></TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><A NAME="remote_user"></A><B><I>remote_user</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>anonymous</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>Username to use at remote site.</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><A NAME="remote_password"></A><B><I>remote_password</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>localuser@localhostname</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>Password to use at remote site. Note: <I>localuser</I>
is will be your name and <I>localhostname</I> will be the name of the local
machine (if it can be found, see <B><I><A HREF="#hostname">hostname</A></I></B>)</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><A NAME="remote_account"></A><B><I>remote_account</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>none</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>Account name/password to use at remote site,
after logging in anonymously (for systems that require it).</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><A NAME="remote_group"></A><B><I>remote_group</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>none</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>If present set the remote 'site group'. </TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><A NAME="remote_gpass"></A><B><I>remote_gpass</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>none</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>If present set the remote 'site gpass'. </TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><A NAME="timeout"></A><B><I>timeout</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>40</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>Timeout FTP requests after this many seconds. </TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><A NAME="failed_gets_excl"></A><B><I>failed_gets_excl</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>none</I></TD>
<TD ALIGN=LEFT VALIGN=TOP><A HREF="#Regular Expressions">Regexp</A> of
error messages to skip reporting, when the FTP GET command fails.
(E.g. permission denied.)</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><A NAME="ftp_port"></A><B><I>ftp_port</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>21</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>Port number of remote FTP daemon. </TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><A NAME="proxy"></A><B><I>proxy</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>false</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>Set to true to use proxy FTP service. </TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><A NAME="proxy_ftp_port"></A><B><I>proxy_ftp_port</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>4514</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>Port number of proxy-service FTP daemon. This
value should be changed depending on which proxy library you are using. </TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><A NAME="proxy_gateway"></A><B><I>proxy_gateway</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>internet-gateway</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>Name of proxy-service, may also be supplied by
the environment variable <B>INTERNET_HOST</B>. </TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><A NAME="using_socks"></A><B><I>using_socks</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>false</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>Set to true if you are using a SOCKS version
of <B>Perl</B>. </TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><A NAME="passive_ftp"></A><B><I>passive_ftp</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>false</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>Set to true if you want to use the PASV extension
of the FTP protocol. Especially useful with firewalls, other proxy FTP
servers, and the variable <B><I><A HREF="#using_socks">using_socks</A></I></B>. </TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><B><I>retry_call</I></B></TD>
<TD ALIGN=LEFT VALIGN=BASELINE><I>true</I></TD>
<TD ALIGN=LEFT VALIGN=BASELINE>If initial connect fails, retry ONCE after
ONE minute. This is to handle sites which reverse lookup the incoming host
but sometimes timeout on the first attempt. </TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><B><I>disconnect</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>false</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>Disconnect from remote site at end of package.
Normally only disconnects if the next <B><I><A HREF="#package">package</A></I></B>
specifies a different site. (Some sites will not let you change to
certain directories except when first connecting in.)</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><B><I>remote_idle</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>none</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>If set try and set the remote idle timer to this.</TD>
</TR>
<TR>
<TD> </TD>
</TR>
<TR VALIGN=TOP>
<TD COLSPAN="3"><A NAME="File Copying"></A><B><U><FONT SIZE=+1>File Copying </FONT></U></B></TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><B><I><U>keyword</U></I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I><U>default</U></I></TD>
<TD ALIGN=LEFT VALIGN=TOP><U>Description</U></TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><A NAME="get_patt"></A><B><I>get_patt</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>.</I></TD>
<TD ALIGN=LEFT VALIGN=TOP><A HREF="#Regular Expressions">Regexp</A> of
remote pathnames to retrieve.</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><A NAME="exclude_patt"></A><B><I>exclude_patt</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>none</I></TD>
<TD ALIGN=LEFT VALIGN=TOP><A HREF="#Regular Expressions">Regexp</A> of
remote pathnames to ignore.</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><B><I>local_ignore</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>none</I></TD>
<TD ALIGN=LEFT VALIGN=TOP><A HREF="#Regular Expressions">Regexp</A> of
local pathnames to ignore. Useful to skip restricted local directories.</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><A NAME="get_newer"></A><B><I>get_newer</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>true</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>Get the remote file if it is more recent that
the local file.</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><A NAME="get_size_change"></A><B><I>get_size_change</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>true</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>Get the file if the size is different from local.
If the file is to be <A HREF="#File Compression">compressed</A> after being
fetched <B><I>get_size_change</I></B> is automatically set to false.</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><A NAME="make_bad_symlinks"></A><B><I>make_bad_symlinks</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>false</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>If true, symlinks will be made to invalid (non-existent)
pathnames. (In older versions of <B>mirror</B> this defaulted to true.)</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><B><I>follow_local_symlinks</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>none</I></TD>
<TD ALIGN=LEFT VALIGN=TOP><A HREF="#Regular Expressions">Regexp</A> of
pathnames of local symbolic links. Rather than treating them as symlinks
the target files or directories they reference are used instead. This makes
local symlinks invisible to <B>mirror</B>.</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><B><I>get_missing</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>true</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>Really get files. When set to false, only deletions
and symlinking will be done. Used to delete expired files older than <B><I><A HREF="#max_days">max_days</A></I></B>
without retrieving older files.</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><B><I>get_file</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>true</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>Get files. If set to false <B>mirror</B>
will try to put files.</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><A NAME="text_mode"></A><B><I>text_mode</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>false</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>If true, all files are transferred in TEXT mode.
Un*x prefers binary so that is the default.</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><B><I>strip_cr</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>false</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>Strip carriage returns from any file as it is
retrieved.</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><A NAME="vms_keep_versions"></A><B><I>vms_keep_versions</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>true</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>When mirroring VMS files, keep the version numbers.
If false, the versions are stripped off and the only the base filenames
are kept.</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><A NAME="vms_xfer_text"></A><B><I>vms_xfer_text</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP>(readme|info|listing|\.c)$</TD>
<TD ALIGN=LEFT VALIGN=TOP>Pattern of VMS files to transfer in TEXT mode
(case insensitive).</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><A NAME="name_mappings"></A><B><I>name_mappings</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>none</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>Remote to local pathname mappings (a <B>Perl</B>
substitute command, e.g. s:old:new:).</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><B><I>external_mapping</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>none</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>Specifies a file that should contain a Perl module
called <TT><FONT SIZE=+1>extmap</FONT></TT> containing at least a function
called <TT><FONT SIZE=+1>map</FONT></TT>. This function is used as
the <B><I><A HREF="#name_mappings">name_mappings</A></I></B> function.</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><B><I>update_local</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>false</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>Set <B><I><A HREF="#get_patt">get_patt</A></I></B>
to be all the files and directories already present in <B><I><A HREF="#local_dir">local_dir</A></I></B>.</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><A NAME="max_days"></A><B><I>max_days</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>0</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>If >0, ignore files older than this many days.
Any ignored files will not be transferred or deleted.</TD>
</TR>
<TR VALIGN=TOP>
<TD><B><I>max_size</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>0</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>If >0, do not transfer any files any larger than
this many bytes.</TD>
</TR>
<TR VALIGN=TOP NOSAVE>
<TD ALIGN=LEFT VALIGN=TOP NOSAVE><B><I>chmod</I></B></TD>
<TD>true</TD>
<TD>By default try and set the file attributes (e.g. time-stamps) of the
copied file. If false do not set attributes. </TD>
</TR>
<TR>
<TD> </TD>
</TR>
<TR VALIGN=TOP>
<TD COLSPAN="3"><A NAME="Local File Attributes"></A><B><U><FONT SIZE=+1>Local
File Attributes </FONT></U></B></TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><B><I><U>keyword</U></I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I><U>default</U></I></TD>
<TD ALIGN=LEFT VALIGN=TOP><U>Description</U></TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><A NAME="user"></A><B><I>user</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>none</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>User name or uid to give to local pathnames.</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><A NAME="group"></A><B><I>group</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>none</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>Group name or gid to give to local pathnames.</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><A NAME="mode_copy"></A><B><I>mode_copy</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>false</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>Flag indicating if we need to copy the file/dir
modes. If this is false then <B><I><A HREF="#file_mode">file_mode</A></I></B>
and <B><I><A HREF="#dir_mode">dir_mode</A></I></B> will be used instead.</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><A NAME="file_mode"></A><B><I>file_mode</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>0444</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>Mode to give files created locally if <B><I><A HREF="#mode_copy">mode_copy</A></I></B>
is false.</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><A NAME="dir_mode"></A><B><I>dir_mode</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>0755</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>Mode to give directories created locally if <B><I><A HREF="#mode_copy">mode_copy</A></I></B>
is false.</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><A NAME="force"></A><B><I>force</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>false</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>If true, all files will be transferred regardless
of the results from size or time-stamp comparisons.</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><B><I>umask</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>07000</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>Do not create setuid files by default (see the
<B>chmod(1)</B> on Un*x).</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><B><I>use_timelocal</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>true</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>Time-stamp files to local time zone. If false,
the time zone is set to GMT (older versions of <B>mirror</B> had a bug
setting all files to GMT).</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><B><I>force_times</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>yes</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>Force local times to match remote times.</TD>
</TR>
<TR>
<TD> </TD>
</TR>
<TR VALIGN=TOP>
<TD COLSPAN="3"><A NAME="File Deletion"></A><B><U><FONT SIZE=+1>File Deletion </FONT></U></B></TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><B><I><U>keyword</U></I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I><U>default</U></I></TD>
<TD ALIGN=LEFT VALIGN=TOP><U>Description</U></TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><B><I>do_deletes</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>false</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>Delete destination files if not in source tree.</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><A NAME="delete_patt"></A><B><I>delete_patt</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>.</I></TD>
<TD ALIGN=LEFT VALIGN=TOP><A HREF="#Regular Expressions">Regexp</A> of
local pathnames to check for deletions. Names that are not matched are
not checked. The match by <B><I><A HREF="#delete_excl">delete_excl</A>
</I></B>is done to all files selected by this pattern.</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><B><I>delete_get_patt</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>false</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>Set <A HREF="#delete_patt"><B><I>delete_patt</I></B>
</A>to be <B><I><A HREF="#get_patt">get_patt</A></I></B>.</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><A NAME="delete_excl"></A><B><I>delete_excl</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>none</I></TD>
<TD ALIGN=LEFT VALIGN=TOP><A HREF="#Regular Expressions">Regexp</A> of
local pathnames that <B>mirror</B> will not delete.</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><A NAME="max_delete_files"></A><B><I>max_delete_files</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>10%</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>If this is set to just a number and there are
more than this many files to delete, do not delete just warn. If this is
set to <I>number%</I> and the percentage of files that would be deleted
is greater than the number, do not delete just warn.</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><A NAME="max_delete_dirs"></A><B><I>max_delete_dirs</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>10%</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>As <B><I><A HREF="#max_delete_files">max_delete_files</A></I></B>
except applies to directories.</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><A NAME="save_deletes"></A><B><I>save_deletes</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>false</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>Instead of deleting local files move them into
<B><I><A HREF="#save_dir">save_dir</A></I></B> . </TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><A NAME="save_dir"></A><B><I>save_dir</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>Old</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>Where local files no longer on remote site are
moved to. Either begins with / or is relative to <B><I>local_dir</I></B>.
Only used when <B><I><A HREF="#save_deletes">save_deletes</A></I></B> is
true.</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><B><I>store_remote_listing</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>none</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>Local pathname where remote listings are kept.
Useful if you have a slow network or want to perform several operations
on the same package without retrieving the index every time.</TD>
</TR>
<TR>
<TD> </TD>
</TR>
<TR VALIGN=TOP>
<TD COLSPAN="3"><A NAME="File Compression"></A><B><U><FONT SIZE=+1>File
Compression </FONT></U></B></TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><B><I><U>keyword</U></I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I><U>default</U></I></TD>
<TD ALIGN=LEFT VALIGN=TOP><U>Description</U></TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><A NAME="compress_patt"></A><B><I>compress_patt</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>none</I></TD>
<TD ALIGN=LEFT VALIGN=TOP><A HREF="#Regular Expressions">Regexp</A> of
files to compress before storing locally. See <B><I><A HREF="#get_size_change">get_size_change</A></I></B>.</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><B><I>compress_excl</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>\.(z|gz)$</I></TD>
<TD ALIGN=LEFT VALIGN=TOP><A HREF="#Regular Expressions">Regexp</A> of
files not to compress (case insensitive).</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><A NAME="compress_prog"></A><B><I>compress_prog</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>compress</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>Program to compress files. If set to the word
<B>compress</B> or <B>gzip</B>, the full pathname for the program and correct
<B><I>compress_suffix</I></B> will automatically be set. When using <B>gzip</B>,
level -9 is used. Note that <B><I><A HREF="#compress_suffix">compress_suffix</A>
</I></B>can be reset to a non-standard value by setting it after <B><I>compress_prog</I></B>.</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><A NAME="compress_suffix"></A><B><I>compress_suffix</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>none</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>Character(s) the compress program appends to
files. If <B><I><A HREF="#compress_prog">compress_prog</A></I></B> is <B>compress</B>,
this defaults to .Z. If <B><I><A HREF="#compress_prog">compress_prog</A></I></B>
is <B>gzip</B>, this defaults to .gz.</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><B><I>compress_conv_patt</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>(\.Z|\.taz)$</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>If <B><I><A HREF="#compress_prog">compress_prog
</A></I></B>is gzip, files matching this pattern are uncompressed and gzip'ed
before storing locally. Compression conversion is only meant to do compress
to gzip conversion.</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><B><I>compress_conv_expr</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>s/\.Z$/\.gz/;</I>
<BR><I>s/\.taz$/\.tgz/</I></TD>
<TD ALIGN=LEFT VALIGN=TOP><B>Perl</B> expression to convert suffix from
compress to gzip style. Change .Z to .gz and .taz to .tgz.</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><B><I>compress_size_floor</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>0</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>Do not compress files smaller than this size,
in bytes.</TD>
</TR>
<TR>
<TD> </TD>
</TR>
<TR VALIGN=TOP>
<TD COLSPAN="3"><A NAME="File Splitting"></A><B><U><FONT SIZE=+1>File Splitting </FONT></U></B></TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><B><I><U>keyword</U></I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I><U>default</U></I></TD>
<TD ALIGN=LEFT VALIGN=TOP><U>Description</U></TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><B><I>split_max</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>0</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>If >0 and the size of the file is greater than
this many bytes, the file is split up to be stored locally (filename must
also match <B><I>split_patt</I></B>). The name of the file being
split up is used as the directory name and each part is stored in a file
called part1, part2... in that directory.</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><B><I>split_patt</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>none</I></TD>
<TD ALIGN=LEFT VALIGN=TOP><A HREF="#Regular Expressions">Regexp</A> of
remote pathnames to split up before storing locally.</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><B><I>split_chunk</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>102400</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>Size, in bytes, of chunks to split files into.</TD>
</TR>
<TR>
<TD> </TD>
</TR>
<TR VALIGN=TOP>
<TD COLSPAN="3"><A NAME="Directory Listings"></A><B><U><FONT SIZE=+1>Directory
Listings</FONT></U></B> </TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><B><I><U>keyword</U></I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I><U>default</U></I></TD>
<TD ALIGN=LEFT VALIGN=TOP><U>Description</U></TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><A NAME="remote_fs"></A><B><I>remote_fs</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>unix</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>File store type. Currently can be one of <B><A HREF="#remote_fs=unix">unix</A></B>,
<B><A HREF="#remote_fs=dls">dls</A></B>, <B><A HREF="#remote_fs=netware">netware</A></B>,
<B><A HREF="#remote_fs=vms">vms</A></B>, <B><A HREF="#remote_fs=dosftp">dosftp</A></B>,
<B><A HREF="#remote_fs=macos">macos</A></B>, <B><A HREF="#remote_fs=lsparse">lsparse</A></B>
and <B><A HREF="#remote_fs=infomac">infomac</A></B>. See the <A HREF="#Filestores">Filestores</A>
section for more details.</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><A NAME="ls_lR_file"></A><B><I>ls_lR_file</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>none</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>Remote file containing ls-lR (result of running
ls -lR on that machine), otherwise run remote <B>ls</B> command.</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><A NAME="local_ls_lR_file"></A><B><I>local_ls_lR_file</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>none</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>Local file containing ls-lR, otherwise use remote
<I><A HREF="#ls_lR_file">ls_lR_file</A></I>. This is useful when first
mirroring a large package.</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><A NAME="recursive"></A><B><I>recursive</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>true</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>Mirror both the contents of <B><I><A HREF="#local_dir">local_dir</A></I></B>
and sub directories of <B><I><A HREF="#local_dir">local_dir</A></I></B>.</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><A NAME="recurse_hard"></A><B><I>recurse_hard</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>false</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>Generate remote ls by doing CWD and ls for each
sub directory. In this case <B><I><A HREF="#remote_dir">remote_dir </A></I></B>must
be absolute (begin with a /) not relative. Use the CWD command in FTP to
find the path for the start of the remote archive area. (Not available
if <B><I><A HREF="#remote_fs">remote_fs</A></I></B> is VMS.)</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><A NAME="flags_recursive"></A><B><I>flags_recursive</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>-lRat</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>Flags to send to remote ls to do a recursive
listing.</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><A NAME="flags_nonrecursive"></A><B><I>flags_nonrecursive</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>-lat</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>Flags to send to remote ls to do a non-recursive
listing.</TD>
</TR>
<TR>
<TD><B><I>ls_fix_mappings</I></B></TD>
<TD><I>none</I></TD>
<TD>Edit pathnames in remote directory listings (a <B>Perl</B> substitute
command, e.g. s:/usr/spool/pub:/:).</TD>
</TR>
<TR>
<TD> </TD>
</TR>
<TR VALIGN=TOP>
<TD COLSPAN="3"><A NAME="Logging"></A><B><U><FONT SIZE=+1>Logging </FONT></U></B></TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><B><I><U>keyword</U></I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I><U>default</U></I></TD>
<TD ALIGN=LEFT VALIGN=TOP><U>Description</U></TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><B><I>update_log</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>none</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>Filename, relative to <B><I><A HREF="#remote_dir">local_dir</A></I></B>,
where <B>mirror</B> will write a report of all it does to maintain a package.</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><A NAME="mail_to"></A><B><I>mail_to</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>none</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>Mail a log of the work done to this comma separated
list of addresses (currently only supported on Un*x).</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><A NAME="mail_prog"></A><B><I>mail_prog</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>none</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>Program called to send to the <B><I><A HREF="#mail_to">mail_to</A>
</I></B>list. May be passed the argument <B><I><A HREF="#mail_subject">mail_subject</A></I></B>.
Defaults to <B>mailx</B>, <B>Mail</B>, or <B>mail</B>. (Not supported under
Wind*ws)</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><A NAME="mail_subject"></A><B><I>mail_subject</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>-s "mirror update"</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>This can contain <B><I>$keyword</I></B>.
These will be replaced by the current value for that keyword (e.g.: -s
"mirror update: $package")</TD>
</TR>
<TR>
<TD> </TD>
</TR>
<TR VALIGN=TOP>
<TD COLSPAN="3"><A NAME="Special"></A><B><U><FONT SIZE=+1>Special</FONT></U></B> </TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><B><I><U>keyword</U></I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I><U>default</U></I></TD>
<TD ALIGN=LEFT VALIGN=TOP><U>Description</U></TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><A NAME="hostname"></A><B><I>hostname</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>none</I></TD>
<TD ALIGN=LEFT VALIGN=TOP><B>Mirror</B> automatically skips packages whose
<B><I><A HREF="#site">site</A></I></B> variable matches this host. Defaults
to the local hostname. This is normally only ever set in the <B><I><A HREF="#Setting Defaults">defaults</A></I></B>
package. Useful if you are sharing <B>mirror</B> <A HREF="#Package Files">package
files</A> with others.</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><B><I>comment</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>none</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>Used in reports.</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><B><I>use_files</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>false</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>Put the associative arrays that <B>mirror</B>
uses into temporary files (currently only support on Un*x). The files
are created in /var/tmp with names: local_map and remote_map. The
suffixes will depend on which DBM library was set as default when <B>Perl</B>
was installed on your machine.</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><B><I>interactive</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>false</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>A non-batch transfer. Implied by <B><A HREF="#-g">-g</A></B>
flag.</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><B><I>skip</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>none</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>If set causes this package to be skipped.
The value is reported as the reason for skipping.</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><B><I>verbose</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>false</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>Verbose messages.</TD>
</TR>
<TR VALIGN=TOP>
<TD ALIGN=LEFT VALIGN=TOP><A NAME="algorithm"></A><B><I>algorithm</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP><I>0</I></TD>
<TD ALIGN=LEFT VALIGN=TOP>Sets the basic algorithm that <B>mirror</B> uses.
<P><B><I>Algorithm=0</I></B> mirrors an entire site at a time. This
is very friendly on the remote site as it uses few of its resources.
However it can chew up a lot of memory on the local machine.
<P><B><I>Algorithm=1</I></B> mirrors a site directory-by-directory.
Should <B>ONLY</B> be used for true mirrors (i.e.: no differences between
the this mirror copy and the original). This uses up a lot less local resources.
However it is very unfriendly to the remote site as it requires remote
site to run an <B>ls</B> command for each directory mirrored.
<B>Mirror</B> will only "see" the one directory it is mirroring so it will
not know that files outside this directory exists so symlinks outside this
directory are considered bad, see <A HREF="#make_bad_symlinks"><B><I>make_bad_symlinks</I></B>.</A>
Deletions are done on a directory by directory basis so be extra careful
about the settings of <A HREF="#max_delete_files">max_delete_files</A>
and <A HREF="#max_delete_dirs">max_delete_dirs</A>. <B><I><A HREF="#get_patt">get_patt</A></I></B>
is applied to just the filename in this directory not the full path, as
are other name checks. You will almost certainly need to set <B><I><A HREF="#remote_dir">remote_dir</A></I></B>
to be an absolute pathname (beginning with /). </TD>
</TR>
<TR VALIGN=TOP NOSAVE>
<TD ALIGN=LEFT VALIGN=TOP NOSAVE><B><I>local_dir_check</I></B></TD>
<TD ALIGN=LEFT VALIGN=TOP NOSAVE><I>false</I></TD>
<TD ALIGN=LEFT VALIGN=TOP NOSAVE>If true and the <B><I><A HREF="#local_dir">local_dir
</A></I></B>does not exit skip this package. By default the <B><I><A HREF="#local_dir">local_dir</A></I></B>
will be created if it does not already exist.</TD>
</TR>
<TR>
<TD></TD>
<TD></TD>
<TD></TD>
</TR>
</TABLE>
<H2>
<A NAME="Filestores"></A>Filestores</H2>
<B>Mirror</B> uses the remote directory listing to work out what files
are available. <B>Mirror</B> was originally targeted connect to Un*x FTP
daemons using a standard <B>ls</B> command. To use a Un*x host with a non-standard
<B>ls</B> or a non Un*x host it is necessary to set the <B><I><A HREF="#remote_fs">remote_fs</A></I></B>
variable to match the kind of directory listing that will be returned.
There is some interaction between <B><I>remote_fs</I></B> and other variables
in particular <B><I><A HREF="#flags_nonrecursive">flags_nonrecursive</A></I></B>,
<B><I><A HREF="#recurse_hard">recurse_hard</A></I></B> and <B><I><A HREF="#get_size_change">get_size_change</A>.</I></B>
The following sections show examples of the results of running the FTP
DIR command on the various kinds of archive and recommendations for related
variables. With some unusual set-ups archive you may have to vary from
the recommended variable set-ups.
<H3>
<A NAME="remote_fs=unix"></A>remote_fs=unix</H3>
<PRE>total 65
-rw-r--r-- 1 nobody nobody 2245 Jan 28 20:06 README
-rw-r--r-- 1 nobody nobody 45881 Jan 29 19:13 mirror.html</PRE>
This is the default and you should not normally have to reset any other
related variables.
<H3>
<A NAME="remote_fs=dls"></A>remote_fs=dls</H3>
<PRE>00index.txt 189916
0readme 5793
1_x/ = OS/2 1.x-specific files</PRE>
This is an <B>ls</B> variant used on some Un*x archives. It provides descriptions
of known items in the listing. Set <B><I><A HREF="#flags_recursive">flags_recursive</A></I></B>
to -dtR.
<H3>
<A NAME="remote_fs=netware"></A>remote_fs=netware</H3>
<PRE>- [R----F--] jrd 1646 May 07 21:43 index
d [R----F--] jrd 512 Sep 09 10:52 netwire
d [R----F--] jrd 512 Sep 02 01:31 pktdrvr
d [RWCE-F--] jrd 512 Sep 04 10:55 incoming</PRE>
or
<PRE>-[R----F--] 1 jrd 1646 May 07 21:43 index
d[R----F--] 1 jrd 512 Sep 09 10:52 netwire
d[R----F--] 1 jrd 512 Sep 02 01:31 pktdrvr</PRE>
This is used by Novell archives. Set <B><I><A HREF="#recurse_hard">recurse_hard</A></I></B>
to true and set <B><I><A HREF="#flags_nonrecursive">flags_nonrecursive</A></I></B>
to be nothing. See also <B><I><A HREF="#remote_dir">remote_dir</A></I></B>.
<H3>
<A NAME="remote_fs=dosftp"></A>remote_fs=dosftp</H3>
<PRE>00-index.txt 6,471 13:54 7/20/93 alabama.txt 1,246 23:29 5/08/97
alaska.txt 873 23:29 5/08/92 alberta.txt 2,162 23:29 5/08/97</PRE>
dosftp is for an FTP daemon on D*S boxes. Set <B><I><A HREF="#recurse_hard">recurse_hard</A></I></B>
to true and set <B><I><A HREF="#flags_nonrecursive">flags_nonrecursive</A></I></B>
to nothing. See also <B><I><A HREF="#remote_dir">remote_dir</A></I></B>.
<H3>
<A NAME="remote_fs=macos"></A>remote_fs=macos</H3>
<PRE>-------r-- 0 127 127 Aug 27 13:53 !Gopher Links
drwxrwxr-x folder 32 Sep 9 16:30 FAQ
drwxrwx-wx folder 0 Sep 9 09:59 incoming</PRE>
macos is for one of Macintosh FTP daemon variants. Although the output
is similar to Un*x the Un*x <B><I>remote_fs</I></B> type cannot cope
with it because there are three file sizes for each file. Set <B><I><A HREF="#recurse_hard">recurse_hard</A></I></B>
to true, <B><I><A HREF="#flags_nonrecursive">flags_nonrecursive</A></I></B>
to nothing, <B><I><A HREF="#get_size_change">get_size_change</A></I></B>
to false and <B><I><A HREF="#compress_patt">compress_patt</A></I></B> to
nothing (this last setting is due to the unusual file names upsetting the
shell used to run compress). See also <B><I><A HREF="#remote_dir">remote_dir</A></I></B>.
<H3>
<A NAME="remote_fs=vms"></A>remote_fs=vms</H3>
<PRE>USERS:[ANONYMOUS.PUBLIC]
1-README.FIRST;13 9 14-JUN-1993 13:09 [ANONYMOUS] (RWE,RWE,RE,RE)
PALTER.DIR;1 1 18-JAN-1993 11:56 [ANONYMOUS] (RWE,RWE,RE,RE)
PRESS-RELEASES.DIR;1
1 11-AUG-1992 20:05 [ANONYMOUS] (RWE,RWE,,)</PRE>
alternatively:
<PRE>[VMSSERV.FILES]ALARM.DIR;1 1/3 5-MAR-1993 18:09
[VMSSERV.FILES]ALARM.TXT;1 1/3 4-FEB-1993 12:20</PRE>
Set <B><I><A HREF="#flags_recursive">flags_recursive</A></I></B> to '[...]'
and <B><I><A HREF="#get_size_change">get_size_change</A></I></B> to false.
<B><I><A HREF="#recurse_hard">recurse_hard</A></I></B> is <B>not</B> available
with VMS. See also the <B><I><A HREF="#vms_keep_versions">vms_keep_versions</A></I></B>
and <B><I><A HREF="#vms_xfer_text">vms_xfer_text</A></I></B> variables.
<BR>
<H3>
<A NAME="remote_fs=infomac"></A>remote_fs=infomac</H3>
<PRE>-r 1974 Jul 21 00:06 00readme.txt
lr 3 Sep 8 08:34 AntiVirus -> vir</PRE>
This is a special case just meant to handle the sumex-aim.stanford.edu
info-mac directory listing stored on that archive in help/all-files. <B><I><A HREF="#recurse_hard">recurse_hard</A></I></B>
should be set to true.
<H3>
<A NAME="remote_fs=dosish"></A>remote_fs=dosish</H3>
This is for a D*S/Wind*ws FTP server with a faintly DOS like output
<PRE>03-04-94 08:45PM <DIR> .
03-04-94 08:45PM <DIR> ..
03-04-94 09:58AM 9718 Conduit
03-04-94 09:59AM 8745 Eve</PRE>
<B><I><A HREF="#recurse_hard">recurse_hard</A></I></B> should be set to
true and <B><I><A HREF="#flags_nonrecursive">flags_nonrecursive</A></I></B>
to nothing.
<H3>
<A NAME="remote_fs=lsparse"></A>remote_fs=lsparse</H3>
Allow reparsing of the listing generated by <B>mirror</B> with debugging
turned to a high level. Meant only for <A HREF="mailto:lmjm@icparc.ic.ac.uk?SUBJECT=You Are A Wizard"><B>mirror</B>
wizards</A>.
<H2>
<A NAME="Examples"></A>Examples</H2>
Here is the <A HREF="#Setting Defaults">mirror.defaults</A> file from the
archive on sunsite.org.uk:
<PRE># This is the default mirror settings used by my site:
# sunsite.org.uk (193.63.255.4)
package=defaults
# The LOCAL hostname - if not the same as `hostname`
# (I advertise the name sunsite.org.uk but the machine is
# really swallow.sunsite.org.uk)
hostname=sunsite.org.uk
# Keep all local_dirs relative to here
local_dir=/public/Mirrors
remote_password=wizards@sunsite.org.uk
mail_to=
# Don't mirror file modes. Set all dirs/files to these
dir_mode=0755
file_mode=0444
# By default, files are owned by root.zero
user=0
group=0
# # Keep a log file in each updated directory
# update_log=.mirror
update_log=
# Don't overwrite my mirror log with the remote one.
# Don't retrieve any of their mirror temporary files.
# Don't touch anything whose name begins with a space!
# nor any FSP or gopher files...
exclude_patt=(^|/)(\.mirror$|\.in\..*\.$|MIRROR.LOG|#.*#|\.FSP|\.cache|\.zipped|lost+found/|)
# Try to compress everything
compress_patt=.
compress_prog=compress
# Don't compress information files, files that don't benefit from
# being compressed, files that tell ftpd, gopher, wais... to do things,
# the sources for compression programs...
# (Note this is the only regexp that is case insensitive.)
compress_excl+|^\.notar$|-z|\.gz$|\.taz$|\.tar.Z|\.arc$|\.zip$|\.lzh$|\.zoo$|\.exe$|\.lha$|\.zom$|\.gif$|\.jpeg$|\.jpg$|\.mpeg$|\.au$|read.*me|index|\.message|info|faq|gzip|compress
# Don't delete own mirror log or any .notar files (incl in subdirs)
delete_excl=(^|/)\.(mirror|notar)$
# Ignore any local readme files
local_ignore=README.doc.ic
# Automatically delete local copies of files that the
# remote site has zapped
do_deletes=true</PRE>
Here are some sample package descriptions:
<PRE>package=gnu
comment=Powerful and free Un*x utilities
site=prep.ai.mit.edu
remote_dir=/pub/gnu
# Local_dir+ causes gnu to be appended to the default local_dir
# so making /public/gnu
local_dir+gnu
exclude_patt+|^ListArchives/|^lost+found/|^scheme-7.0/|^\.history
# I tend to only keep the latest couple of versions of things
# this stops mirror from retrieving the older versions I've removed
max_days=30
do_deletes=false
package=X11R6
comment=X Windows (windowing graphics system for Un*x)
site=ftp.x.org
remote_dir=/pub/R6
local_dir+ftp.x.org/pub/R6
# This is a local symlink to the free-for-all contrib area
# and is mirrored elsewhere
local_ignore=^contrib$
# Don't compress a thing. It is already compressed
# but doesn't look it.
compress_patt=
# THIS IS JUST A TEST
package=test vms site
site=vmsbox.somewhere.ac.uk
local_dir=/tmp/copy4
remote_dir=vmsserv/files
remote_fs=vms
# Must do these settings for VMS
flags_recursive=[...]
get_size_change=false
# and on, and on ...</PRE>
<H2>
<A NAME="Temporary Filenames"></A>Temporary Filenames</H2>
By default when mirror creates a temporary filename it takes the real filename
and puts <B><TT><FONT SIZE=+1>.in.</FONT></TT></B> at the start.
<BR>If your system limits the length of a filename a lot (some older Un*xes
were limited to 14 characters) then look for:
<PRE> <TT>LIMITED NAMELEN</TT></PRE>
which is about 75% of the way through mirror.pl, for a note on how to reduce
temporary filename length. I only know of one site using this.
<H2>
<A NAME="Regular Expressions"></A>Regular Expressions</H2>
This is a short explanation of regular expressions. For a more comprehensive
guide see the <B>Perl</B> manual pages or the O'Reilly book "Mastering
Regular Expressions".
<P>A regular expression, or regexp, is a way of using matching patterns
in text strings. For example the regexp:
<UL>
<PRE> ^s</PRE>
</UL>
would match any string that begins with an <B><TT><FONT SIZE=+1>s</FONT></TT></B>.
The <B><TT><FONT SIZE=+1>^</FONT></TT></B> is a special character that
means <I>beginning of string</I>. There are a number of specials
possible in a regexp, everything that is not special is taken as a literal
character, such as the <B><TT><FONT SIZE=+1>s</FONT></TT></B> in the example
above. To turn off a special character put a backslash, <B><TT><FONT SIZE=+1>\</FONT></TT></B>,
in front of it. This only effects the special character immediately
following it.
<P>A word of warning: although very similar to Un*x shell (and D*S COMMAND)
wildcards there are differences. For example any Un*x and D*S would
treat *.ZIP as any filename ending in .ZIP, *.ZIP as a regular expression
is an error! The * is special that must follow something (see below).
<H3>
Regexp Specials</H3>
<TABLE>
<TR>
<TD>^</TD>
<TD>beginning of string</TD>
</TR>
<TR>
<TD>$</TD>
<TD>end of string</TD>
</TR>
<TR>
<TD>.</TD>
<TD>any character</TD>
</TR>
<TR>
<TD>[r]</TD>
<TD>a range or characters either as a list <I>abcef</I> or a hyphen separated
range <I>a-f</I></TD>
</TR>
<TR>
<TD>[^r]</TD>
<TD>anything not in the given list or range</TD>
</TR>
<TR>
<TD>(p1|p2|p3...)</TD>
<TD>patterns p1 or p2 or p3 ... (the patterns may be specials)</TD>
</TR>
<TR>
<TD>*</TD>
<TD>zero or more of the preceding item (which may be a special)</TD>
</TR>
<TR>
<TD>+</TD>
<TD>one or more of the preceding item (which may be a special)</TD>
</TR>
<TR>
<TD>\d</TD>
<TD>any digit (same as [0-9])</TD>
</TR>
<TR>
<TD>\D</TD>
<TD>any non-digit (same as [^0-9])</TD>
</TR>
<TR>
<TD>\s</TD>
<TD>any whitespace character</TD>
</TR>
<TR>
<TD>\S</TD>
<TD>any whitespace character</TD>
</TR>
</TABLE>
<H3>
Regexp Examples</H3>
<TABLE>
<TR>
<TD>abc</TD>
<TD>matches <I>abc</I>, also <I>xxxabcyyy</I> but not <I>xabbcy</I> </TD>
</TR>
<TR>
<TD>^abc$</TD>
<TD>matches only <I>abc</I></TD>
</TR>
<TR>
<TD>a.*z</TD>
<TD>matches <I>a</I> <I>any string z</I>. e.g. <I>asdkjfhaksdjfhz</I></TD>
</TR>
<TR>
<TD>index.html</TD>
<TD>matches <I>index.html </I>AND <I>indexXhtml index/html</I> (. matches
any character)</TD>
</TR>
<TR>
<TD>index\.html</TD>
<TD>matches <I>index.html </I>(the backslash stops . matching any character)</TD>
</TR>
<TR>
<TD>[rR][eE][aA][dD][mM][eE]</TD>
<TD>matches <I>readme</I>, <I>Readme</I>, <I>README</I> ...</TD>
</TR>
<TR>
<TD>\.(gz|Z)$</TD>
<TD>matches strings ending in <I>.gz </I>or <I>.Z</I></TD>
</TR>
</TABLE>
<H2>
<A NAME="Hints"></A>Hints</H2>
When adding a new package, first test it by running <B>mirror</B> with
the <B><A HREF="#-n">-n</A></B> option.
<P>If you are adding to an existing archive that was not created by <B>mirror</B>
(perhaps you copied the files from a CDROM) then it is usually best to
force the time-stamps of the existing local files so time comparisons with
the remote files show the files as identical (see <B><A HREF="#-T">-T</A></B>).
<P>Try and keep all packages that are being retrieved from the same site
together in the same <A HREF="#Package Files">package file</A>. That way
<B>mirror</B> will only have to login once.
<P>Remember that all regexp's are <B>Perl</B> regular expressions.
<P>If the remote site contains symlinks that you want to "flatten out"
into the corresponding files, then do this by changing the flags passed
to the remote <B>ls</B> which will be either <B><I><A HREF="#flags_recursive">flags_recursive</A></I></B>
or <B><I><A HREF="#flags_nonrecursive">flags_nonrecursive</A></I></B> to
include <B><I>L</I></B> First test this by trying a <B>ls -lRatL</B>
on the remote site under the FTP command to check whether the remote filestore
has any symlink loops. These cause ls to go into an infinite
loop - if this happens you will have to talk to the manager of the remote
area about removing them.
<P>If you are mirroring a very large site that changes infrequently, add
<B><I><A HREF="#max_days">max_days</A>=7</I></B> to the settings <B>after</B>
it is initially mirrored. That way <B>mirror</B> will only have to consider
recent files when updating. Then once a week, or whenever necessary, call
<B>mirror</B> with <B><A HREF="#-k">-k </A><I><A HREF="#max_days">max_days</A>=0
</I></B>to force a full update.
<P>If you don't want to compress anything from the remote site the easiest
way to do this is to set the <B><I><A HREF="#compress_patt">compress_patt</A></I></B>
to nothing.
<P>If you want to run a command at the end of mirroring a package a useful
trick is to reset the <B><I><A HREF="#mail_prog">mail_prog</A></I></B>
variable to be the program name and <B><I><A HREF="#mail_to">mail_to</A></I></B>
to be the arguments.
<P>For netware, dosftp, macos and VMS you should normally set <B><I><A HREF="#remote_dir">remote_dir</A></I></B>
to be the home directory of the remote FTP daemon. Connect in manually
and before changing directory use the pwd command to find where home is.
If you are only mirroring part of the tree then give the full pathname
including this home directory at the start.
<P>macos names can sometimes contain characters that make it hard to pass
them through Un*x shells. Since compressing files is done via a shell it
would be best to turn off compression with <B><I><A HREF="#compress_patt">compress_patt</A>=</I></B>
<P>macos files seem to always change size when transfered, in either binary
or text mode. So it would be best to set get_size_change=false
<H2>
<A NAME="Netiquette"></A>Netiquette</H2>
If you are going to mirror a remote site, please obey any restrictions
that the site administrators place on access. You can generally find the
restrictions on connecting to the archive using the standard FTP command.
Any restrictions are normally given as a login banner or in a (hopefully)
obvious file.
<P>Here are, what I hope are, some good general rules:
<P>You should probably get permission from the remote site <B>before</B>
setting up a mirror of it. Some sites require detailed logs.
Unauthorised mirrors would take traffic from the site generating the logs
and so ruin their statistics. There may also be <B>SERIOUS LEGAL
REASONS</B> why mirrors are unwanted.
<P>Only mirror a site well outside the working hours of both the local
and remote sites.
<P>It is probably unfriendly to try to mirror a remote site more than once
a day.
<P>Before trying to mirror a remote site, try and find the packages you
want from local archives, as no one will be pleased if you soak up a lot
of network bandwidth needlessly.
<P>If you have a local archive, then tell people about it so they don't
have to waste bandwidth and CPU at the remote site.
<P>Do remember to check your package-files from time to time in case the
remote archive has changed their access restrictions.
<BR>
<H2>
<A NAME="Bugs"></A>Bugs</H2>
Some of the netiquette guidelines should be enforced.
<P>Should be able to cope with links as well as symlinks.
<P>Suffers from creeping featurism. (Actually more like galloping featurism!.)
<P>If you are using Perl 4 (Perl 5 users skip this):
<UL>If h2ph has been run for your system then you should probably remove
the socket.ph shipped with mirror and use the one <I>meant</I> for your
machine. If h2ph has not been run then you should persuade your systems
administrators to do so. The contents of socket.ph are operating
system specific and it is possible that what works for me will not work
for you.
<P>A special note for Solaris 2.x users. The socket.ph created by
h2ph doesn't work. Install the socket.ph-solaris from this distribution
instead.</UL>
<P>There seems to be a problem with older versions of Perl that causes
mirror to fail with the message 'fstype unix unknown'. If you experience
<BR>this then please upgrade your Perl to 5.004 or better.
<BR>
<H2>
<A NAME="Remember!"></A>Remember!</H2>
Objects in a mirror are closer than you think!
<H2>
<A NAME="Author"></A>Author</H2>
Mirror was writen by <A HREF="http://sunsite.org.uk/~lmjm/">Lee McLoughlin</A>
<<A HREF="mailto:lmjm@icparc.ic.ac.uk">lmjm@icparc.ic.ac.uk</A>>. It
uses a heavily rewritten and extended version of the ftp.pl package originally
by: Alan R. Martello <al@ee.pitt.edu> which uses lchat.pl which is based
on the chat2.pl package by: Randal L. Schwartz <merlyn@ora.com>
<P>Special thanks to the following people for patches, comments and other
suggestions that have helped to improve <B>mirror</B>. If I have omitted
anyone, please contact me.
<P>Zoë Leech <zl@icparc.ic.ac.uk>
<BR>James Revell <revell@uunet.uu.net>
<BR>Chris Myers <chris@wugate.wustl.edu>
<BR>Amos Shapira <amoss@cs.huji.ac.il>
<BR>Paul A Vixie <vixie@pa.dec.com>
<BR>Jonathan Kamens <jik@pit-manager.mit.edu>
<BR>Christian Andretzky <casys@otto.mb3.tu-chemnitz.de>
<BR>Kean Stump <kean@ucs.orst.edu>
<BR>Anita Eijs <anita@hermes.bouw.tno.nl>
<BR>Simon E Sperro <S.E.Sperro@gdr.bath.ac.uk>
<BR>Aaron Wohl <aw0g+@andrew.cmu.edu>
<BR>Michael Meissner <meissner@osf.org>
<BR>Michael Graff <explorer@iastate.edu>
<BR>Bradley Rhoades <us267388@mail.mmmg.com>
<BR>Edwards Reed <eer@cinops.xerox.com>
<BR>Joachim Schrod <schrod@iti.informatik.th-darmstadt.de>
<BR>David Woodgate <David.Woodgate@mel.dit.csiro.au>
<BR>Pieter Immelman <pi@itu1.sun.ac.za>
<BR>Jost Krieger <x920031@bus072.rz.ruhr-uni-bochum.de>
<BR>Erez Zadok <ezk@cs.columbia.edu>
<BR>
<H2>
Copyright</H2>
Mirror, both the software and all the accompanying documentation including
this document, is under the following copyright.
<P><FONT SIZE=-1>Copyright © 1990 - 1998 Lee McLoughlin</FONT>
<P><FONT SIZE=-1>Permission to use, copy, and distribute this software
and its documentation for any purpose with or without fee is hereby granted,
provided that the above copyright notice appear in all copies and that
both that copyright notice and this permission notice appear in supporting
documentation.</FONT>
<P><FONT SIZE=-1>Permission to modify the software is granted, but not
the right to distribute the modified code. Modifications are to be distributed
as patches to released version.</FONT>
<P><FONT SIZE=-1>This software is provided "as is" without express or implied
warranty.</FONT>
</BODY>
</HTML>
|