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
|
\chapter{Appendix}
\markboth{}{}
The following sections comprise the \dgb{appendix}. Each section will cover
one particular topic in some detail, or introduce subjects that are not
explicitly covered in the body of this book.
\dgb{Appendix 1} - Gives details on various useful UNIX commands.\\
\dgb{Appendix 2} - Provides a short introduction to several useful editors.\\
\dgb{Appendix 3} - Explains the various uses of the \dgb{loop} device.\\
\dgb{Appendix 4} - A simple solution to some multiple OS installs.\\
\dgb{Appendix 5} - Shows you to build a \dgb{Packages} file.\\
\dgb{Appendix 6} - Some hints on how to use Linux as a server on the LAN.\\
\dgb{Appendix 7} - Lists the options that can be passed to the Linux Kernel.\\
\dgb{Appendix 8} - Contains the body of the Debian Social Contract/DFSG.\\
\dgb{Appendix 9} - Presents the full text of the GNU Free Documentation License.
\newpage
\section{Appendix 1: Common UNIX Commands}
\thispagestyle{plain}
\subsection{Introduction}
This section covers most of the useful commands available on any UNIX
operating system. None of the commands are covered in great detail, but
enough information is given to be a useful introduction for those not
familiar with the various UNIX commands. For more details on these and other
commands, there are two standard commands for getting documentation on
programs installed on the system: the
\index{man}%
\dgb{man} command and the
\index{info}%
\dgb{info}
command. If information is desired for command \dgb{foo}, either
\dgi{man foo} or \dgi{info foo} will provide the available documentation.
Not all packages provide \dgb{info} pages, while many GNU packages don't
provide \dgb{man} pages. Depending on the program involved one or the other
of these will be available. When the command is unknown but some idea of
functionality is known, a key word search can be made of the \dgb{man} pages
using the \dgi{apropos} command or \dgi{man -k}.
\dgnote{The term \dgb{program} and \dgb{command} have been used
interchangeably in the previous discussion. This is because in UNIX, all
executable commands are, in fact, programs that execute to perform their
various tasks. Every program, and thus, every command, is documented in some
fashion or another within the system. In a Debian system each package places
its copyright, changelogs, and any additional examples or documents into the
directory \dgi{/usr/share/doc/$<$package name$>$} and is a good place to start
after you have exhausted the \dgb{man} and \dgb{info} pages.}
\newpage
\subsection{chgrp}
\index{chgrp command}%
This command is used to change the group ownership of a file or files. The
form of the command is: \dgi{chgrp $<$options$>$ $<$group$>$ $<$files$>$.}
The \dgi{$<$group$>$} will be assigned to the \dgi{$<$files$>$} that are
specified. As usual wild cards are permitted, allowing multiple files to be
specified. Several useful options are:
\begin{hanging}
\hitem{-c} describe only the files who's ownerships have actually changed.
\hitem{-f} don't print error messages on unchanged files.
\hitem{-R} recursively traverse the sub-directories changing group permission
on the appropriate files.
\end{hanging}
Example:
\dgscreen{chgrp -R dwarf /home/dwarf}
Will change all of the files in all of the directories below \dgi{/home/dwarf}
to belong to the group \dgb{dwarf}.
See also: \dgb{chmod}, \dgb{chown}
\newpage
\subsection{chmod}
\index{chmod command}%
When it is necessary to modify the permissions on a particular file or group
of files this command is the one to use. It takes the form:
\dgscreen{chmod $<$options$>$ $<$mode$>$ $<$files$>$}
\dgb{$<$mode$>$} has the form: [ugoa...][[+-=][rwxXstugo...]...][,...]
\begin{hanging}
\hitem{u} the user who owns the file
\hitem{g} users in the files group
\hitem{o} other users not in the group
\hitem{a} all users
\hitem{+} causes permissions to be added to those already present for the file.
\hitem{-} remove the specified permissions from the file
\hitem{=} make those permissions specified as the only permissions defined for the file.
\hitem{r} read permission
\hitem{w} write permission
\hitem{x} executed permission
\hitem{X} execute only if the file is a directory or already has permission for some user.
\hitem{s} set user or group id on execution.
\hitem{t} save program text on swap device
\hitem{u} set the permission to those of the user who owns the file.
\hitem{g} set the permissions to those of the group.
\hitem{o} set the permissions to those other than the group.
\end{hanging}
\dgb{$<$options$>$}
\begin{hanging}
\hitem{-c} give a verbose reporting of only the files changed.
\hitem{-r} recursively change permissions of directories and their contents.
\hitem{-f} do not print errors about files that were not changed.
\end{hanging}
Example:
\dgscreen{chmod g-w $./$*}
Will remove the group write permissions from all the files in the current
directory.
See also: \dgb{chown}, \dgb{chgrp}
\newpage
\subsection{chown}
\index{chown command}%
To change the ownership of a file or group of files the \dgi{chown} command
is used. This command has the form:
\dgscreen{chown $<$options$>$ [user][:.][group] $<$files$>$}
If only \dgb{user} is supplied, then the ownership of the file is changed to
that user. If a \dgb{:} or \dgb{.} is followed by a user name, then the
ownership of the file is changed to the specified user and the group is
changed to the login group for that user. If \dgb{user:group} or
\dgb{user.group} is provided, not only the ownership of the file is changed
to user, but also the group assigned to the file is changed to \dgb{group}.
Files can be designated with wild cards so that a set of files can be changed
at the same time.
Several useful options are detailed below. See the \dgb{man} page for complete
details:
\begin{hanging}
\hitem{-c} describe only those files that have been changed.
\hitem{-f} don't print error messages when files can't be changed.
\hitem{-R} recursively change files in sub-directories.
\end{hanging}
Example:
\dgscreen{chown fred $./$document.1}
will change the ownership of \dgb{document.1} to user \dgb{fred}.
See also: \dgb{chmod}, \dgb{chgrp}
\newpage
\subsection{cp}
\index{cp command}%
This command is used to copy files from one location in the file system to
another. The form of the command is:
\dgscreen{cp $<$options$>$ $<$from files$>$ $<$to location$>$}
Wild cards are permitted in the \dgb{$<$from files$>$} parameter. If this
parameter refers to more than one file, the \dgb{$<$to location$>$} must be
a directory. There are a wide range of options for this command. Several are
listed here.
\begin{hanging}
\hitem{-a} This option is the same as the \dgb{-dpR} and attempts to retain the
permissions and ownerships of the files being copied. This option is the best
way to ``replicate'' a file system on another partition, or to move a sub-tree
from one place to another without changing its permission structures.
\hitem{-d} Copy symlinks as symlinks rather than the file pointed to and
preserve hard link relationships between files in the copies.
\hitem{-p} Preserve the owner, group, permissions, and time-stamp found on the
original when making the copies.
\hitem{-R} Recursively copy all sub-directories and their file contents. This
will allow a complete limb of a file system to be replicated somewhere else in
the file system.
\end{hanging}
Example:
\dgscreen{cp -a /home /mnt}
will copy all of the files and directories in \dgi{/home} into the directory
\dgb{/mnt} and will maintain the permissions and ownerships of the files
during the copy.
\newpage
\subsection{df}
\index{df command}%
This command displays file system information for each device mounted on the
system. The information displayed includes the size of the partition, the
amount used, and the amount available. The device name and mount point are
also provided in this display.
Example:
\dgscreen{df}
{\footnotesize{\tt{
\begin{tabular}{llllll}
\multicolumn{1}{l}{Filesystem} &
\multicolumn{1}{c}{1024-blocks} &
\multicolumn{1}{c}{Used} &
\multicolumn{1}{c}{Available} &
\multicolumn{1}{c}{Capacity} &
\multicolumn{1}{c}{Mounted on} \\
/dev/hdb3 & 649339 & 396690 & 219108 & 64\% & / \\
/dev/hda1 & 1054176 & 784352 & 269824 & 74\% & /mnt/DOS \\
/dev/hdb1 & 649307 & 542629 & 73139 & 88\% & /mnt/image/1 \\
/dev/hdb7 & 331767 & 180711 & 133922 & 57\% & /mnt/image/2 \\
/dev/hdb5 & 347375 & 258195 & 71240 & 78\% & /Debian \\
/dev/hdb6 & 347375 & 303564 & 25871 & 92\% & /home \\
/mnt/a/deb.iso & 617388 & 617388 & 0 & 100\% & /mnt/loop1 \\
/mnt/image/1/1.3.iso & 540506 & 540506 & 0 & 100\% & /mnt/loop2 \\
\end{tabular}
}}}
The order in which the file systems are listed, is the order that they were
mounted. Except for the last two entries, the above were all mounted by
\dgi{fstab} at boot time. The last two are \dgb{loop} mounted image files.
\newpage
\subsection{du}
\index{du command}%
The \dgi{du} command reports the disk usage for the specified directory.
The value reported for each sub-directory and the total are given in
1024 byte blocks.
Example:
\dgscreen{du /lib\\
\begin{tabular}{ll}
1 & /lib/modules/2.1/fs \\
1 & /lib/modules/2.1/net \\
1 & /lib/modules/2.1/scsi \\
1 & /lib/modules/2.1/block \\
1 & /lib/modules/2.1/cdrom \\
1 & /lib/modules/2.1/ipv4 \\
1 & /lib/modules/2.1/misc \\
8 & /lib/modules/2.1 \\
77 & /lib/modules/2.0.22/block \\
55 & /lib/modules/2.0.22/net \\
133 & /lib/modules/2.0.22/scsi \\
321 & /lib/modules/2.0.22/fs \\
45 & /lib/modules/2.0.22/misc \\
635 & /lib/modules/2.0.22 \\
80 & /lib/modules/2.1.5/block \\
58 & /lib/modules/2.1.5/net \\
139 & /lib/modules/2.1.5/scsi \\
335 & /lib/modules/2.1.5/fs \\
48 & /lib/modules/2.1.5/misc \\
664 & /lib/modules/2.1.5 \\
477 & /lib/modules/2.0.30/net \\
974 & /lib/modules/2.0.30/scsi \\
265 & /lib/modules/2.0.30/fs \\
245 & /lib/modules/2.0.30/cdrom \\
228 & /lib/modules/2.0.30/misc \\
2195 & /lib/modules/2.0.30 \\
3503 & /lib/modules \\
5730 & /lib \\
\end{tabular}}
\enlargethispage{100pt}
This declares \dgi{/lib} to contain 5730, 1k (1024 byte) blocks.
\newpage
\subsection{ls}
\index{ls command}%
This command provides information about the contents and permissions of
files within the file system. The bare command \dgi{ls} will list the files
in the current directory. In addition to the many options that can be used
with this command, the last element on the command line can be a file or
directory specification. Wild cards are appropriate here, so \dgi{ls m*}
will list all files in the current directory that begin with \dgb{m}.
There are many options that can be used with the \dgi{ls} command. A few
of the more useful are:
\begin{hanging}
\hitem{-l} display listing in the ``long'' format, giving file type,
permissions, the number of hard links, owner and group name, byte size,
and the time stamp, by default the modification time.
\hitem{-a} display all files, including those that start with the `.' character.
\hitem{-R} give a recursive listing of the contents of all sub-directories.
\hitem{-\/-} color-code files according to file type.
\hitem{-S} sort by file size.
\hitem{-r} reverse the order of whatever sort has been chosen.
\end{hanging}
Example:
\dgscreen{ls -l /dev/l$*$ \\
brw-rw---- 1 root cdrom 24, 0 Jan 17 09:45 /dev/lmscd \\
srw-rw-rw- 1 root root , 0 Jun 8 23:49 /dev/log \\
brw-rw---- 1 root disk 7, 0 Sep 23 1996 /dev/loop0 \\
brw-rw---- 1 root disk 7, 1 Sep 23 1996 /dev/loop1 \\
brw-rw---- 1 root disk 7, 2 Sep 23 1996 /dev/loop2 \\
brw-rw---- 1 root disk 7, 3 Sep 23 1996 /dev/loop3 \\
brw-rw---- 1 root disk 7, 4 Sep 23 1996 /dev/loop4 \\
brw-rw---- 1 root disk 7, 5 Sep 23 1996 /dev/loop5 \\
brw-rw---- 1 root disk 7, 6 Sep 23 1996 /dev/loop6 \\
brw-rw---- 1 root disk 7, 7 Sep 23 1996 /dev/loop7 \\
crw-rw---- 1 root lp 6, 0 Jan 17 09:45 /dev/lp0 \\
crw-rw---- 1 root lp 6, 1 Jan 17 09:45 /dev/lp1}
lists all the files in \dgi{/dev} that begin with \dgb{l} and lists them in
the long format.
\newpage
\subsection{mkdir}
\index{mkdir command}%
This command is used to create sub-directories within the file system. The
command expects at least a directory specification and has several options.
The most useful of which is:
\begin{hanging}
\hitem{-m mode} This option allows the specification of permissions on the
directory being created
\end{hanging}
Example:
\dgscreen{mkdir /mnt/DOS}
will add the subdirectory \dgb{DOS} to the \dgi{/mnt} directory.
See also: \dgb{rmdir}
\newpage
\subsection{mv}
\index{mv command}%
The move command \dgi{mv}, like copy, is of the form:
\dgscreen{mv $<$options$>$ $<$source$>$ $<$dest$>$.}
The \dgb{$<$source$>$} parameter can contain wild cards, and when referring
to more than one file the \dgb{$<$dest$>$} must be a directory. Several
options include:
\begin{hanging}
\hitem{-b} make backups of the files to be removed.
\hitem{-i} prompt before removing files.
\hitem{-v} print the name of the files being moved.
\end{hanging}
Example:
\dgscreen{mv myfile myfile.old}
will move the file \dgb{myfile} to the new file named\dgb{myfile.old}.
\newpage
\subsection{rm}
\index{rm command}%
The remove command \dgi{rm} is used to delete files from the file system.
After options this command expects a file name. Wild cards are permitted
here, so the command can remove more than one file at a time. Several
options for this command are:
\begin{hanging}
\hitem{-r} recursively remove files from sub-directories.
\hitem{-f} never prompt for files to remove and ignore nonexistent files.
\hitem{-i} prompt for each file before removing it.
\end{hanging}
Example:
\dgscreen{rm -r /home/fred/$*$}
will remove all the files in all the directories of \dgi{/home/fred}.
\newpage
\subsection{rmdir}
\index{rmdir command}%
This command is the reverse of the \dgb{mkdir} command. It causes the
directory specified to be removed. There is only one option for this
command:
\begin{hanging}
\hitem{-p} removes any parent directories that become empty by removing the
specified directory.
\end{hanging}
Example:
\dgscreen{rmdir /mnt/DOS}
will remove the sub-directory \dgb{DOS} from the path \dgi{/mnt}.
See also: \dgb{mkdir}
\newpage
\section{Appendix 2: Text Editors}
\thispagestyle{plain}
\subsection{Introduction}
Linux systems provide many different kinds of editors. Debian is no different.
From the tiny \dgb{ae} used in the base system, to the gigantic and powerful
\dgb{emacs}, there are all the editors you might expect to find in any UNIX,
and then some. The following section will give a brief description of four
editors found in Debian. Each description section will tell how to start the
editor, how to save a file, and how to exit the editor. Some of the primary
edit features will also be discussed.
For more detailed information see the \dgb{man} pages and other documentation
provided with each of the editors.
\newpage
\subsection{ae}
\index{Anthony'w Editor}%
Anthony's Editor
\index{ae}%
\dgb{ae} is an exceptionally small program (23.9K) that
provides basic edit capability for the rescue disk and the base system.
The default condition for the editor is with the help screen visible. This
is one of the features that makes this editor so easy to use.
The current release of Debian uses \dgb{slang1} instead of \dgb{ncurses},
because the library is much smaller, allowing other things to go on the boot
file system. To accommodate the new library constraints, and to give \dgb{ae}
functionality on many terminal types, the key-bindings have been changed to be
more like \dgb{emacs}. Most keys are control keys, with some use of the escape
key. For those terminals without an escape key, \dgb{$<$ctrl-[$>$} will act as
an escape.
All of the possible commands available in the editor are displayed on the
screen. \dgb{$<$ctrl-X$><$ctrl-H$>$} will toggle the help screen off and on
to provide more screen area for editing. The standard commands are:
\begin{hanging}
\hitem{\^{ }X I} Read a file into the editor.
\hitem{\^{ }X\^{ }S} Write the contents of the editor to a file.
\hitem{\^{ }@} Block select to cursor movement.
\hitem{\^{ }W} Cut selected block.
\hitem{\^{ }Y} Paste a cut block.
\hitem{\^{ }X\^{ }C} Exit the editor only if file has been saved. Prompts to save file.
\hitem{\^{ }Q} Exit the editor without saving the file first. Discards changes
\end{hanging}
\enlargethispage{100pt}
\dgb{ae} is the only editor available in the base system, so until the system
is upgraded to ``standard'' there may not be an editor available that is
completely familiar. \dgb{ae} is the compromise between size and familiarity.
\newpage
\subsection{joe}
Joe's Own Editor
\index{joe}%
\dgb{joe} is a \dgb{WordStar} clone with all the features
found in that ancient piece of CP/M code. The \dgb{control K} sequences are
the same as in the original, so anyone familiar with \dgb{WordStar} can just
use \dgb{joe} without thinking about learning new commands. For those not
familiar with this word processor the following will be a good start:
\begin{hanging}
\hitem{\^{ }K H} Toggle the help screen on and off.
\hitem{\^{ }K D} Save the current edit session.
\hitem{\^{ }K X} Save the current edit session and exit.
\hitem{\^{ }K Z} Suspend the editor for the shell.
\hitem{\^{ }C} Abort the current edit session. (don't save the file)
\end{hanging}
With the help screen you can find out how to select a block of text, move or
copy the block. Word search and replace are also available along with a spell
checker.
When a file is saved with \dgb{joe} it automatically moves the original file
to original-file-name~. The \dgb{~} makes it easy to identify the backup edit
session, but it only reflects the last edit session, so older contents will be
lost.
\newpage
\subsection{vi}
\index{vi}%
One of the standard editors found on any UNIX system, \dgb{vi}, is a modal
editor that provides many useful features. This section is not spacious enough
to do justice to \dgb{vi}'s many features, so only the basic commands needed
to do simple editing will be covered here. A few of the more useful commands
include:
\begin{hanging}
\hitem{:viusage$<$CR$>$} Show a list of vi commands.
\hitem{:exusage$<$CR$>$} Show the list of ex commands.
\hitem{:q!} Unconditional exit back to the shell.
\hitem{:wq} Write the file and quit.
\hitem{i} Enter insert mode (characters can only be entered when in input mode).
\hitem{$<$esc$>$} Return to command mode.
\end{hanging}
Modal refers to the way that \dgb{vi} operates in different modes. When first
invoked, \dgb{vi} is in command input mode. The cursor can be moved around the
screen, but any other keys typed are expected to be commands. Some of those
commands, like the \dgb{i} command, switch the editor into text input mode.
For the insert command, the characters typed are inserted to the left of the
cursor.
The escape key will return to command mode, either from text input mode or
to abort a command in the middle. If you type several characters that do not
create a command, no other command can be entered until these characters are
cleared. The escape key returns to command input mode and clears the partial
command.
\newpage
\subsection{emacs}
\index{emacs}%
\dgb{emacs} is another, larger editor that comes with most standard systems.
It has many features not found in other editors, not to mention a built-in
LISP interpreter. Because of its many features, many of the \dgb{emacs}
commands are multiple control or escape sequences. Some of the more common
are listed below:
\begin{hanging}
\hitem{\^{ }X\^{ }C} Exit emacs
\hitem{\^{ }H\^{ }T} Presents a Tutorial on emacs
\hitem{\^{ }H\^{ }I} Displays the GNU Info pages on emacs
\hitem{\^{ }X\^{ }S} Save the current buffer to a file
\end{hanging}
\dgb{emacs} can be used to edit several buffers at one time, and provides
many different ``source'' environments helpful to creation of source code.
These areas are far too broad to be covered in these few paragraphs. The
\dgb{Tutorial} is highly recommended as a good way to get to know the
features of \dgb{emacs}. The \dgb{info} pages will give other, useful
information not found in the tutorials. Both of these should be enough to
give you a good feel for how this editor works, and what it can provide.
\newpage
\section{Appendix 3: The Loop Device}
\thispagestyle{plain}
The
\index{loop device|(}%
\dgb{loop device} is a device driver that allows an \dgb{image file} to be
mounted as though it were a normal block device. The question that immediately
jumps to mind is, ``So, how do I use this beast''. As an example, let's look at
mounting, and examining the contents of, the rescue floppy image file.
First the CD-ROM, or other device containing this
\index{image files}%
\dgb{image file} needs to
be mounted like:
\dgscreen{mount -r -t iso9660 /dev/scd0 /cdrom}
\dgnote{The \dgb{-r} option declares the device to be read only.
Also \dgi{/dev/scd0} assumes the drive is the first SCSI device. If the
machine uses a SoundBlaster Pro/Creative Labs combo for the cdrom this
device would be \dgi{/dev/sbpcd0} instead. The other possibilities depend on
the particular interface being used.}
If this is an ``Official CD'' that was mounted, the file of interest is
found as:
\dgscreen{/cdrom/debian/hamm/main/disks-i386/current/resc1440.bin}
So the mount command using the \dgb{loop device} will look like:
\dgscreen{mount -t msdos -o loop /../../resc1440.bin /mnt}
After this an \dgi{ls} of \dgi{/mnt} will show all the files that will
appear on the floppy disk when this image file is transferred to it. This
is a ``live'' file system. That is, it can be modified just like any other
read/write file system mounted as a block device. The changes made to the
file system while mounted become part of the image file and will be reflected
on the floppy constructed from that image. Of course, in our example the
\dgb{file image} resides on a read-only medium so changes aren't possible,
but when the image file resides on a writable medium, like the hard disk,
then those kinds of changes become possible.
OK. We can mount such file systems, but how are they constructed in the
first place? This, of course requires a *nix environment. The tools are
\dgb{dd} and
\index{losetup}%
\dgb{losetup}, and the process goes something like this:
First it is necessary to create an empty file of the desired size. This is
done with
\index{dd command}%
\dgb{dd} and the \dgb{zero device} in a command like:
\dgscreen{dd if=/dev/zero of=/../image.file bs=1k count=100000}
This will create a file with 100~MB of space. Note that the file size is
equivalent to the partition size when creating partitions on a block device
like the hard disk. This file will thus hold a file system that can reach
100~MB in size before ``device full'' errors occur.
Before a file system can be created on this
\index{image files}%
\dgb{image file} and mounted, it
needs to be made to look like a block device. This is done with the
\dgb{losetup} program in the following fashion:
\dgscreen{losetup /dev/loop0 /../image.file}
There are 8 loop devices to choose from, so you may need to check to see if
a particular device is already in use. \dgi{losetup /dev/loopN}, where
\dgb{N} ranges between 0 and 7, will return the status of the Nth
\dgb{loop device} if it is mounted and will return an error message if it
is not.
Now that \dgi{/dev/loop0} is a legitimate block device,
\dgb{mke2fs} (or any of the other file system creation utilities) can be
used to create a file system on the looped
\index{image files}%
\dgb{image file} with a command
like:
\dgscreen{mke2fs -c /dev/loop() 100000}
The \dgb{-c} option checks the device for bad blocks and the value on the
end specifies how many blocks are on the file system. These two options can
be left off the command line and results will be seen faster, but there is
no guarantee that the resultant file system will be useful. Take the time to
check for bad blocks. It is time you will not spend looking for the cause of
problems later. Once the file system has been created, and a \dgb{loop device}
associated with file, it can be mounted using the following command line:
\dgscreen{mount -t ext2 /dev/loop0 /mnt}
When this is later unmounted make sure to release the device with the
command \dgi{losetup -d /dev/loop1}. Another alternative is to release
the \dgb{loop device} as soon as the file system creation is complete, and
mount the file as in the previous example with a command like:
\dgscreen{mount -t ext2 -o loop=/../image.file /mnt}
In either case this produces a ``file system'' mounted on \dgi{/mnt} that has
100~MB of storage space. Whatever this file system is intended to contain
can now be copied, or untarred, or otherwise created on the new file system.
It should be evident that \dgb{loop devices} are very useful critters.
\index{loop device|)}%
The installation software makes use of one to perform several sets in the
installation by mounting image files from the CD, instead of requiring a
floppy disk to mount. This is not only faster, but physically easier than
the floppy installation method.
\newpage
\section{Appendix 4: Multiple OS Installation}
\thispagestyle{plain}
There are different ways that more than one Operating System can reside on
the same machine. DOS and Windows can easily reside on the same machine with
Linux, and each can be booted at the choice of the operator. Windows~95/98 is
a little bit trickier since it demands its own boot manager. Installing
Windows~95/98 after installing Linux will result in LILO getting ``bumped off''
the system. Installing Linux AFTER Windows~95/98 will work. You will need to
configure your Linux system to be able to boot Windows~95/98 with LILO however.
\index{LILO}%
LILO can be used as long as there is a Linux partition on the first physical
drive. With a modified boot record and LILO, the system can be made to boot
either Linux or DOS/Windows~95/98. There are other boot loaders available
for Intel machines. Most of these can be used to boot a variety of operating
systems.
The more versatile method of installation uses the DOS program
\index{loadlin}%
\dgb{loadlin.exe}.
This software can boot a kernel image from a DOS partition and mount any
partition on the system as the root partition for that kernel. For automatic
operation, the best method is to use the config.sys menu system in DOS to
offer the choices of the different OS available on the machine. Then
\index{autoexec.bat}%
\dgb{autoexec.bat} can determine whether to go ahead and boot DOS or run
\index{loadlin}%
\dgb{loadlin} and boot Linux. The following example should clarify this
process:
\dgscreen{config.sys: \\
{[Menu]} \\
menuitem=NewLinux, Linux 2.0.30 \\
menuitem=OldLinux, Linux 2.0.27 \\
menuitem=DOS \\
{[DOS]} \\
DEVICE=C:$\backslash$DOS$\backslash$SETVER.EXE \\
DEVICE=C:$\backslash$DOS$\backslash$HIMEM.SYS \\
DOS=HIGH \\
FILES=30 \\
STACKS=9,256 \\
{[NewLinux]} \\
{[OldLinux]} \\
autoexec.bat: \\
cd $\backslash$boot$\backslash$linux \\
goto \%config\% \\
:DOS \\
cd $\backslash$ \\
C:$\backslash$DOS$\backslash$SMARTDRV.EXE \\
@ECHO OFF \\
PROMPT \$p\$g \\
PATH C:$\backslash$WINDOWS;C:$\backslash$DOS \\
SET TEMP=C:$\backslash$DOS \\
goto End \\
:NewLinux \\
loadlinx vmlinuz2 root=/dev/hdb3 \\
goto End \\
:OldLinux \\
loadlinx vmlinuz root=/dev/hdb3 \\
goto End \\
:End }
\dgnote{This system allows the root file system to reside on
another area besides the first device on the machine.}
This process will work for Windows 95/98 as well as DOS/Windows and OS/2.
\newpage
\section{Appendix 5: Building Packages Files}
\thispagestyle{plain}
Files with the extension \dgb{.deb} contain the packages managed by \dgb{dpkg}.
For information on how these packages are built, the \dgi{programmer.html/} and
\dgi{policy.html/} directories will provide much useful information. These
files are found on a Debian system in the \dgi{/usr/doc/dpkg}.
What you need to build a Packages file:
\begin{enumerate}
\item Debian GNU/Linux system with dpkg-dev installed.
\item A collection of .deb package files.
\item The override file for the distribution involved.
\end{enumerate}
The Debian package \dgb{dpkg-dev} provides the script
\index{dpkg-scanpackages}%
\dgb{dpkg-scanpackages}
which is used to produce
\index{Packages files}%
\dgb{Packages} files. With this tool an arbitrary
collection of Debian binary packages can be converted into a ``distribution''.
Normally the Debian distribution resides in the sub-directories of the
directory
\index{binary-i386}%
\dgi{binary-i386}. Many times however, even with a ``standard''
archives of this distribution, the \dgb{Packages} file is not in sync with
the archive, and a new \dgb{Packages} file will be required. The proper
operation of
\index{dselect}%
\dgb{dselect} depends on an accurate and up-to-date \dgb{Packages}
file.
Another reason for building a
\index{Packages files}%
\dgb{Packages} file relates to the construction
of a ``custom'' installation. Collecting a specific subset of the Debian
distribution for installation using \dgb{dselect} will require a \dgb{Packages}
file for this subset. Once these packages are collected into a sub-tree, a
\dgb{Packages} file can be created.
\dgb{dpkg-scanpackages} has two required parameters, and sends its output to
\dgb{stdout}. The first parameter is the path to the archives while the second
points to the
\index{override file}%
\dgb{override file} for the release being used. The 1.3 release
is code named \dgb{bo}, while the previous release was \dgb{rex} and the next
one was \dgb{hamm} (all characters from the movie dgb{Toy Story}). These
\dgb{override} files are found in the
\index{indices/}%
\dgi{indices/} directory of any Debian
mirror with the name \dgb{override.bo} or \dgb{override.rex} or
\dgb{override.hamm} depending on which distribution the packages came from.
The command line would look something like:
\dgscreen{dpkg-scanpackage $./$bo/binary-i386 $./$indices/override.bo $>$Packages}
and will run for quite some time. Upon completion the script will print
information about any differences found between packages and information
found in the \dgb{override} file. This is typically caused by the fact that
the maintainer changed and the \dgb{override} file does not reflect the new
maintainer. These errors are never a problem to the correct operation of the
\dgb{Packages} file, but are informative only. The final information provided
by the script gives the total number of packages added to the \dgb{Packages}
file. A copy of this file along with a gzipped copy should be placed in the
outer directory of the distribution tree. For the standard distribution the
\dgb{Packages} file goes into \dgi{../binary-i386}. When a group of packages
are collected into one directory that is the directory where the \dgb{Packages}
and \dgb{Packages.gz} files should be placed as well. Once this has been
accomplished the distribution is ready to be installed using \dgb{dselect}.
\newpage
\section{Appendix 6: Linux as a Server}
\thispagestyle{plain}
One of the many versatile features of Linux is its ability to act as a server
in various network environments. Linux, and therefore Debian, provides
features that allow it to act as a server for Windows and Windows~95/98
machines. It can also act as a server for an AppleTalk network, or even a
Novell network.
\index{samba}%
\dgb{SAMBA} is the name of the software that provides the tools for serving
Windows machines. A very comprehensive discussion of this tool can be found
at:
\dgscreen{http://lake.canberra.edu.au/pub/samba}
There is also a \dgb{HOWTO} that can be found at:
\dgscreen{http://www.interweft.com.au/other/samba/smb\_se.html}
as well as a \dgb{FAQ} that can be found at:
\dgscreen{http://sunse.jinr.dubna.su/local/samba/samba.faq.html}
AppleTalk, the Macintosh network protocol, can be supported by the kernel if
the proper
\index{appletalk}%
\dgb{appletalk.o} module is provided, or compiled into the kernel.
This network is also called
\index{netatalk}%
\dgb{netatalk} and a \dgb{HOWTO} can be found at:
\dgscreen{http://www.anders.com/projects/netatalk/}
Linux can also be run directly on a Mac with the product called
\index{MKLinux}%
\dgb{MKLinux}.
Information on how to set up \dgb{netatalk} on \dgb{MKLinux} can be found at:
\dgscreen{http://www.primate.wisc.edu/people/dubois/mklinux/netatalk-setup.html}
\newpage
Linux can even act as a server on a
\index{NetWare}%
\dgb{Novell} network. The kernel needs to
have \dgb{IPX} support compiled in, or as a module. For more information see:
\dgscreen{http://electron.phys.dal.ealmini/HTTP+Netware}
or
\dgscreen{http://www.inet.co.th/cyberclub/karnedp/http-4.html}
The \dgb{IPX} module is also discussed in the \dgb{Modules HOWTO} which can
be found at:
\dgscreen{http://linuxwww.db.erau.edu/ldp/HOWTO/Module-HOWTO-s.html}
or at most mirrors of the \dgb{Linux Documentation Project}.
All of the above sites were found using one of the many
\index{search engines}%
search engines that
the Internet provides. If you point your browser at:
\dgscreen{http://altavista.digital.com/cgi-bin/query?pg=aq}
the first blank line on the screen that comes up is for a list of keywords
with logical operators that define the way they are selected. The real power
of this page is the second field for \dgb{Result Ranking Criterion}. Key
words in this list are used to bring more likely hits to the top of the list.
This is very useful when your keywords return 2,000 hits.
There are many other search engines available on the net. Using the above site
and the keyword
\index{search engines}%
``search engine'' produces 500,000 hits, so choices for
\dgb{Result Ranking Criterion} can be very useful.
\newpage
\section{Appendix 7: Arguments}
\thispagestyle{plain}
\index{kernel arguments|(}
The kernel accepts arguments of the following form:
\begin{hanging}
\hitem{no387=} This argument tells the kernel not to use the math
co-processor, even when present. The kernel must, of course, be compiled
with math emulation support for this to work.
\hitem{root=} Tells the kernel which partition to use as the root device.
This value can be entered as a text string, like \dgi{/dev/hda4}, or as the
\dgb{major/minor} number for the device, which for \dgb{hda4} is ``0x304''
for major 3 and minor 4, \dgb{fsck} has been run. This argument can be set
with \dgb{rdev}.
\hitem{debug=} Under normal circumstances the kernel logs only those
messages of debug level 7 or below to the console. Using this argument
will send all debug messages to the console. \dgb{klogd} also has options
that it will accept to modify what debug level will get logged. See the
\dgb{man} page for details.
\hitem{reserve=} Protects various i/o ports from being probed. It
takes the form: \dgi{reserve=iobase,extent[,iobase,extent]...} and will keep
one device driver from probing sensitive ports on another card. Since that
card will eventually need to be initialized by its own driver, this command
is usually used in conjunction with another. If the device \dgb{foo} is caused
to lock up by a probe from another device, the argument list would look like:
\dgscreen{reserve= 0x300,32 foo=0x300}
This will keep all other device
drivers from probing 0x300 while allowing the drive that uses that port to
be properly initialized.
\hitem{ramdisk=} This argument tells the kernel how big a ramdisk to
create. To put a file system from a \dgb{floppy} into a \dgb{ramdisk} would
require an argument like: \dgi{ramdisk=1440}. Note that the units of size for
this argument is kilobytes. This is one of the few parameters that can be set
in the kernel using \dgb{rdev}.
\hitem{mem=} Since the BIOS of most PCs can only report 64~MB there are
times when the kernel needs to be told that there is more memory than this.
This argument should be used with great care, since, if you lie to the kernel
and tell it that it has more address space than it actually has, the system
will crash miserably at some time in the near future. Also make sure that your
system does not use the highest memory for caching the BIOS code, as use of
this memory by the kernel will ultimately crash the system as well. The value
given after the equal sign should be the highest ram address available to the
kernel, so a 96~MB system would get an argument like `mem=0x6000000'.
\end{hanging}
\newpage
\subsection{SCSI device arguments}
\index{SCSI device arguments|(}
\dgb{General Notation}
\begin{hanging}
\hitem{iobase} The first I/O port that the SCSI device occupies, normally
between the values: 0x200 and 0x3ff
\hitem{irq} The hardware interrupt that the SCSI card is configured to use.
\hitem{scsi-id} The host adapter's ID on the SCSI bus. Some adapters allow
this value to be changed but most don't. Many adapters use ID of seven,
however, the \dgb{Seagate} and dgb{Future Domain TMC-950} cards used ID of six.
\hitem{parity} Specifying a 1 tells the card to expect the SCSI devices to
report parity. Setting this to 0 has the opposite effect. As with the scsi-id
not all adapters accept this argument.
\end{hanging}
\newpage
\subsection{SCSI argument list}
\begin{hanging}
\hitem{max\_scsi\_luns} Some SCSI devices are poorly designed and will lock
up when probed for LUNs (Logical Unit Numbers) other than zero. As the kernels
now default to only probe LUN~0, this argument allows for the probing of other
LUNs as well.
\hitem{st=} This is used to configure SCSI tape devices and has the form:
\dgi{st=buf\_size[,write\_threshold[,max\_bufs]]}.
\hitem{buf\_size:} The value is given in units of kilobytes with the
default value of 32 and a max value of 16384.
\hitem{write\_threshold:} Is the size of the buffer that will commit a
write to tape and defaults to 30 kilobytes.
\hitem{max\_bufs:} Normally defaults to 2 but the proper number depends
on how many devices are present.
\hitem{aha152x=iobase[,irq[,scsi-id[,reconnect[,parity]]]]} These values
are as described earlier and are order dependent, so to specify parity, the
rest of the parameters must appear on the line. If the reconnect value is
non-zero the device will be allowed to disconnect/reconnect.
\newpage
\hitem{aha1542=iobase[,buson,busof[,dmaspeed]]} The iobase for this
card is usually, 0x130, 0x134, 0x230, 0x234, 0x330, and 0x334. Some clone
cards provide other addresses as well. \dgb{buson} and \dgb{busof} specify
the time the card spends on and off the buss. Default values are 11$\mu$s
on and 4$\mu$s off so that other cards get a chance at the ISA buss.
\dgb{dmaspeed}
refers to the rate at which the DMA transfers proceed. The default value is
5~MB/s, although some cards allow setting up to 10~MB/s, but care should be
taken to make sure that the machine is up to the task.
\hitem{aic7xxx=extended,no\_reset} A nonzero value for extended enables
extended translation for large disks. A nonzero value for no\_reset tells the
card not to reset the card at boot up.
\hitem{buslogic=} The only parameter that this argument accepts is the
\dgb{iobase}. The expected values are: 0x130, 0x134, 0x230, 0x234, 0x330, and
0x334.
\hitem{tmc8xx=mem\_base,irq} The probe code for these \dgb{Future Domain}
cards looks for a BIOS on the card. If one is not found, or the signature is
not recognized, this card will go unrecognized. Specifying the \dgb{mem\_base}
address and the \dgb{irq} in this argument will force recognition of the card.
The \dgb{mem\_base} address specifies the memory mapped I/O region of the card
and expects values: 0xc8000, 0xcc000, 0xce000, 0xdc000, 0xde000.
\hitem{pas16=iobase,irq} This card uses the \dgb{NC5380} SCSI chip and
usually expects the \dgb{iobase} to be 0x388. If the \dgb{irq} value is given
as 255, then the card will operate without interrupts, at a reduced capability.
\hitem{st0x=mem\_base,irq} This probe code also expects to find a bios
and will not find the card if there is no BIOS. This argument will force
detection of the card. \dgb{mem\_base} is the memory mapped I/O region of the
card and uses values: 0xc8000, 0xca000, 0xcc000, 0xce000, 0xdc000, 0xde000.
\hitem{t128=mem\_base,irq} These cards also use the \dgb{NC5380} SCSI
chip and expects the following values for \dgb{mem\_base}: 0xc8000, 0xcc000,
0xd8000, 0xdc000.
\end{hanging}
The following cards do not accept arguments:
\begin{tabular}{lll}
Always IN2000 & Adaptec aha1740 & EATA-DMA \\
EATA-PIO & Future Domain 16xx & NCR5380 (generic) \\
NCR53c7xx to & NCR53c8xx & Qlogic \\
Ultrastor & Western Digital wd7000 & \\
\end{tabular}
\index{SCSI device arguments|)}%
\newpage
\subsection{Hard Disk Arguments}
\index{hard disk arguments|(}%
The hard disk arguments are used to do special setup on IDE devices. This
includes a number of CD-ROM devices as well as the normal hard drives.
Drive-specific options have the form:
\dgscreen{hda=, hdb=, hdc=, hdd=.}
Non drive-specific options have the form: \dgb{hd=}. This option can be used
to specify the next drive in the \dgb{a}, \dgb{b}, \dgb{c}, \dgb{d} order.
Drive specific options can be used in place of non-specific ones with the
expected result. In the following discussion the \dgb{hd=} will be used
exclusively and can be replaced by any drive specific option that applies.
\begin{hanging}
\hitem{hd=cyls,heads,sects[,wpcom[,irq]]} This option is used to
specify the physical geometry of the disk. Only the first three parameters
are required. The \dgb{wpcom} (write pre-compensation) parameter is ignored
by IDE devices. The \dgb{irq} value is the \dgb{irq} of the controller of
the device and as such is not strictly a drive parameter.
\hitem{hd=serialize} Many of the older kernels had a broken CMD-640 chip
driver design which resulted in corrupted data when the second controller
was operated at the same time as the first. This option forces the driver
to do sequential accesses rather than simultaneous activity. You will only
need to use this option if you have a drive installed on the second IDE
controller.
\newpage
\hitem{hd=dtc2278} If you have a \dgb{DTC2278D} IDE interface this
option causes the driver to attempt to enable the second controller as
well as faster transfer options.
\hitem{hd=noprobe} If the machine has an old IDE drive that suffers
from being probed this option will keep that disaster from happening.
For example, if the drive is \dgb{hdb} then the following will allow the
drive to not be probed but also provide the drive information for proper
identification of the drive: \dgi{hdb=noprobe hdb=1166,7,17} will do the
trick.
\hitem{hd=nowerr} As some drives appear to have the \dgb{WRERR\_STAT}
bit permanently stuck, this option allows the drive to work anyway.
\hitem{hd=cdrom} If there is an ATAPI compatible CD-ROM installed on
one of the IDE controllers and it is not recognized by the kernel, this
option will allow the kernel to recognize the drive.
\enlargethispage{100pt}
\hitem{xd=type,irq,iobase,dma\_chan} If the system has an old 8 bit xt
card, the driver probes the card for a BIOS. If none is found, or the
signature is not recognized, then the drive will not be recognized. This
option will allow the recognition to occur. \dgb{type} specifies the card
manufacturer and has the values: 0=generic; 1=DTC; 2,3,4=Western Digital;
5,6,7=Seagate; 8=OMTI. \dgb{irq}, \dgb{iobase} and \dgb{dma\_chan} are all
required parameters, so don't leave any of them unspecified.
\end{hanging}
\index{hard disk arguments|)}%
\newpage
\subsection{Other CD-ROMS}
This section contains options for CD-ROM devices that are neither SCSI or
IDE/ATAPI devices.
\index{CD-ROM arguments|(}%
\begin{hanging}
\hitem{aztcd=iobase[,magic\_number]} The \dgb{Aztech} interface uses
these options. If the magic number is set to 0x79 the driver will continue
to try to function even when the firmware version is unknown. Any other magic
number will be ignored by the driver.
\hitem{cdu31a=iobase[,irq[,is\_pas\_card]]} This argument is used to
configure the \dgb{Pro Audio Spectrum} cards as well as some \dgb{Sony}
supplied interface cards. Passing an \dgb{irq} value of 0 tells the driver
that the card does not support interrupts. If the card does support them you
are encouraged to use the interrupt, as it will ease the CPU load. If the card
is a \dgb{Pro Audio Spectrum} then the \dgb{is\_pas\_card} parameter should be
\dgb{PAS}.
\enlargethispage{100pt}
\hitem{sonycd535=iobase[,irq]} Used by the \dgb{Sony CDU-535} interface card,
the \dgb{iobase} passed as 0 to act as a placeholder when an \dgb{irq} needs
to be specified.
\hitem{gscd=iobase} Used by the \dgb{GoldStar} interface.
\hitem{mcd=iobase[,irq[,wait\_value]]} Used by \dgb{Mitsumi Standard}
interface cards, the \dgb{wait\_value} is for devices that are having trouble
with time-outs, but should be used with care as some implementations of the
driver don't support this option. Whether or not it is implemented depends
on a compile time DEFINE.
\hitem{mcdx=} For the \dgb{Mitsumi XA/Multisession} interface experimental.
\hitem{optcd=iobase} The \dgb{Optics Storage} interface uses this argument.
\hitem{cm206=[iobase][,irq]} Used by the \dgb{Philips CM206} interface,
this driver expects \dgb{irq} values between 3 and 11 and \dgb{iobase} values
between 0x300 and 0x370, so these can be supplied in any order, with either
value missing. There is also the \dgb{cm206=auto} which tells the driver to
auto probe for the information.
\hitem{sjcd=iobase[,irq[,dma\_channel]]} This argument is used by the
\dgb{Sanyo} interface card.
\hitem{sbpcd=iobase,type} Used by the \dgb{Soundblaster Pro} interface
card, the value of \dgb{type} can be: 0 for \dgb{LaserMate}, 1 for
\dgb{SoundBlaster}, 2 for \dgb{SoundScape}, and 3 for \dgb{Teac16bit}. The
\dgb{iobase} is the base for the CD interface and not the sound card.
\end{hanging}
\index{CD-ROM arguments|)}%
\newpage
\subsection{Floppy Drive Arguments}
\index{floppy drive arguments|(}%
All of the information in this section can be found in \dgb{README.fd} in
\dgi{linux/drivers/block}. The following information is taken directly from
this file.
Several points of interest include:
\begin{itemize}
\item Using \dgb{floppy=} arguments on the command line as well as in the LILO
config file will result in the two arguments being concatenated.
\item The \dgb{floppy=} argument can be used with \dgb{insmod}, however the
syntax is slightly different.
\item For \dgb{insmod} the \dgb{floppy=} is only entered once with the
parameters following it in quotes as, \dgi{floppy``daring two\_fdc''}.
\item \dgb{floppy=mask,allowed\_drive\_mask} and \dgb{floppy=all\_drives} are
obsolete and should be replaced by: \dgi{floppy=$<$drive$>$,$<$type$>$,cmos}
\end{itemize}
Specifying a drive is mandatory when using more than 2 floppy drives, and sets
the CMOS type for \dgb{$<$drive$>$} to \dgb{$<$type$>$}, where the CMOS types
are:
\dgscreen{0 - Use the value found in the physical CMOS \\
1 - 5 1/4 DD \\
2 - 5 1/4 HD \\
3 - 3 1/2 DD \\
4 - 3 1/2 HD \\
5 - 3 1/2 ED \\
6 - 3 1/2 ED \\
16 - unknown or not installed}
\dgnote{Type 5 is for use with \dgb{AMI} floppy drives. Under
other circumstances this type was intended for use by floppy ``tapes''.}
\begin{hanging}
\hitem{floppy=asus\_pci} Sets the bitmask to allow only devices 0 and 1. This
is the default.
\hitem{floppy=daring} Indicates a ``well-behaved'' floppy controller, which
allows the driver to provide more efficient and smoother operation and will
speed up certain operations. However this may cause failures on some
controllers.
\hitem{floppy=one\_fdc} Tells the driver that you have only one controller.
This is the default.
\hitem{floppy=[address,]two\_fdc} Indicates to the driver that there
are two floppy disk controllers and that the second controller resides at
\dgb{address}. If \dgb{address} is not entered then 0x370 is assumed.
\hitem{floppy=thinkpad} Informs the driver that this is a \dgb{Thinkpad} and
will deal with the inverted disk change line used by these machines.
\hitem{floppy=0,thinkpad} Tells the driver that this is not a
\dgb{Thinkpad}.
\newpage
\hitem{floppy=omnibook and floppy=nodma} As the \dgb{HP Omnibook} has
no workable DMA channel and other hardware deliver ``Unable to allocate DMA
memory'' error, this argument tells the driver not to use DMA transfers with
the drive. The machine must be at least a 486 to use \dgb{nodma}, and the
FIFO threshold should be set to 10 or lower to limit the number of data
transfer interrupts.
\hitem{floppy=dma} Allows the driver to use DMA and is the default.
\hitem{floppy=nofifo} Used to disable the FIFO entirely. If the Ethernet
card or other device declares ``Bus master arbitration error'' while using the
floppy, you will need to use this argument to disable the FIFO.
\hitem{floppy=fifo} Enables the FIFO and is the default.
\hitem{floppy=threshold,fifo\_depth} This argument is relevant in DMA mode
and sets the FIFO threshold. A higher value allows the floppy driver to
tolerate more interrupt latency, while generating more interrupts. A lower
value should lower the interrupt latency and produces fewer interrupts.
This threshold can be tuned using the \dgi{floppy control -\/-messages} and
then later looking for \dgi{Over/underrun - retrying} messages when accessing
the floppy drive. If there are a huge amount of these messages then the
threshold is set too low. Set the threshold value higher until you only see
an occasional error message. Building the kernel with the floppy driver as a
module will allow you to remove the driver and reinstall it with a different
threshold value without the need to reboot the machine. Remember to reissue
the \dgi{floppycontrol -\/-messages} command after each reload of the driver.
Usually this ``tuning'' will not be necessary, as the default value of 0xa is
a reasonable value in most cases.
\hitem{floppy=unexpected\_interrupts} This argument causes a warning
message to be printed whenever an unexpected interrupt is received from
the floppy. This is the default behavior.
\hitem{floppy=no\_unexpected\_interrupts and floppy=L40SX} These
arguments causes no message to be printed when an unexpected interrupt
in received. The \dgb{IBM L40SX} laptops have an interaction between
certain video modes and the floppy controller that result in unexpected
interrupts. These interrupts only effect performance and can be safely
ignored.
\end{hanging}
\dgi{fdutils} and \dgi{mtools} provide additional run-time configuration
capabilities for the floppy drive, including reading high capacity disks.
\index{floppy drive arguments|)}%
\newpage
\subsection{Other Device Drivers}
Any drivers not falling into the above categories will be found here.
\index{other arguments|(}%
\begin{hanging}
\hitem{ether=irq,iobase[,param1[,param2....[,param8]]],name} For
configuring Ethernet cards. The various cards have differing parameters,
but they all require an \dgb{irq} and \dgb{iobase} address. The first
non-numeric value is taken to be the name of the device. This argument
is typically used to force the detection of a second Ethernet card, and,
for that purpose, would look like: \dgi{ether=0,0,eth1}. Note that 0 is
again used as a place holder for this argument.
\hitem{sound=device1[,device2.....[,device11]]} Provide a means to override
the compiled in values. This is somewhat complex and should be avoided if
possible. The \dgb{deviceN} parameters are of the form 0xTaaaId where the
bytes are used as follows:
\begin{hanging}
\hitem{T} device type: 1=FM, 2=SB, 3=PAS, 4=GUS, 5=MPU401, 6=SB16,
7=SB16-MPU401
\hitem{aaa} I/O address in hex
\hitem{I} Interrupt in hex
\hitem{d} DMA channel
\end{hanging}
Using a `sound=0' disables the sound card all together.
\hitem{busmouse=irq} Used by the busmouse driver.
\end{hanging}
\index{other arguments|)}%
\index{kernel arguments|)}%
\newpage
\section{Appendix 8: What is Free Software}
\thispagestyle{plain}
The following definition of
\index{Free Software}%
Free Software is copyright \copyright\ 1997
``Software in the Public Interest'' and is printed here with the author's
permission. The project participants overwhelmingly voted to adopt this
declaration on the 4th of July, 1997. What follows is the entire document.
\index{Debian's Social Contract}%
DEBIAN'S ``SOCIAL CONTRACT'' WITH THE FREE SOFTWARE COMMUNITY
We are \dgb{Software In The Public Interest}, producers of the
\dgb{Debian GNU/Linux} system. This is the
\dgb{social contract} we offer to the free software community.
1. Debian Will Remain 100\% Free Software
We promise to keep the \dgb{Debian GNU/Linux} distribution entirely free
software. As there are many definitions of free software, we include the
guidelines we use to determine if software is ``free'' below. We will support
our users who develop and run non-free software on Debian, but we will never
make the system depend on an item of non-free software.
2. We Will Give Back to the Free Software Community
When we write new components of the Debian system, we will license them as
free software. We will make the best system we can, so that free software
will be widely distributed and used. We will feed back bug-fixes,
improvements, user requests, etc.\ to the ``upstream'' authors of software
included in our system.
3. We Won't Hide Problems
We will keep our entire bug-report database open for public view at all
times. Reports that users file on-line will immediately become visible to
others.
\newpage
4. Our Priorities are Our Users and Free Software
We will be guided by the needs of our users and the free-software community.
We will place their interests first in our priorities. We will support the
needs of our users for operation in many different kinds of computing
environment. We won't object to commercial software that is intended to run
on Debian systems, and we'll allow others to create value-added distributions
containing both Debian and commercial software, without any fee from us. To
support these goals, we will provide an integrated system of high-quality, 100% free software, with no legal restrictions that would prevent these kinds of use.
5. Programs That Don't Meet Our Free-Software Standards
We acknowledge that some of our users require the use of programs that don't
conform to the Debian Free Software Guidelines. We have created ``contrib'' and
``non-free'' areas in our FTP archive for this software. The software in these
directories is not part of the Debian system, although it has been configured
for use with Debian. We encourage CD manufacturers to read the licenses of
software packages in these directories and determine if they can distribute
that software on their CDs. Thus, although non-free software isn't a part of
Debian, we support its use, and we provide infrastructure (such as our
bug-tracking system and mailing lists) for non-free software packages.
\dgb{THE DEBIAN FREE SOFTWARE GUIDELINES}
1. Free Redistribution
The license of a Debian component may not restrict any party from selling or
giving away the software as a component of an aggregate software distribution
containing programs from several different sources. The license may not
require a royalty or other fee for such sale.
2. Source Code
The program must include source code, and must allow distribution in source
code as well as compiled form.
3. Derived Works
The license must allow modifications and derived works, and must allow them
to be distributed under the same terms as the license of the original software.
4. Integrity of The Author's Source Code
The license may restrict source-code from being distributed in modified
form \_only\_ if the license allows the distribution of ``patch files'' with the
source code for the purpose of modifying the program at build time. The
license must explicitly permit distribution of software built from modified
source code. The license may require derived works to carry a different name
or version number from the original software. (This is a compromise. The
Debian group encourages all authors to not restrict any files, source or
binary, from being modified.)
5. No Discrimination Against Persons or Groups
The license must not discriminate against any person or group of persons.
6. No Discrimination Against Fields of Endeavor
The license must not restrict anyone from making use of the program in a
specific field of endeavor. For example, it may not restrict the program
from being used in a business, or from being used for genetic research.
7. Distribution of License
The rights attached to the program must apply to all to whom the program is
redistributed without the need for execution of an additional license by
those parties.
8. License Must Not Be Specific to Debian
The rights attached to the program must not depend on the program's being
part of a Debian system. If the program is extracted from Debian and used
or distributed without Debian but otherwise within the terms of the
program's license, all parties to whom the program is redistributed should
have the same rights as those that are granted in conjunction with the
Debian system.
9. License Must Not Contaminate Other Software
The license must not place restrictions on other software that is distributed
along with the licensed software. For example, the license must not insist
that all other programs distributed on the same medium must be free software.
10. Example Licenses
The ``GPL'', ``BSD'', and ``Artistic'' licenses are examples of licenses that
we consider ``free''.
The concept of a Linux distribution stating its ``social contract with the
free software community'' was suggested to me by Ean Schussler. I composed
a draft, and then it was refined by the Debian developers in e-mail
conference during most of June. They then voted to approve it as our
publicly stated policy. We hope that other software projects, including
other Linux distributions, will use this document as a model. We will gladly
grant permission for any such use.
Respectfully Submitted
Bruce Perens \\
Debian Project Leader
\newpage
\section{Appendix 9: GNU Free Documentation License}
\thispagestyle{plain}
\label{gfdl}
What follows is the verbatim text of the
\index{GNU Free Documentation License}%
\dgb{GNU Free Documentation License}.
This is the license under which this book has been released.
\subsection{GNU Free Documentation License}
Version 1.1, March 2000\\
\index{Free Software Foundation}%
Copyright \copyright\ 2000 Free Software Foundation, Inc.\\
59 Temple Place, Suite 330, Boston, MA 02111-1307 USA\\
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
\subsubsection*{Preamble}
The purpose of this License is to make a manual, textbook, or other
written document ``free'' in the sense of freedom: to assure everyone
the effective freedom to copy and redistribute it, with or without
modifying it, either commercially or noncommercially. Secondarily,
this License preserves for the author and publisher a way to get
credit for their work, while not being considered responsible for
modifications made by others.
This License is a kind of ``copyleft'', which means that derivative
works of the document must themselves be free in the same sense. It
complements the GNU General Public License, which is a copyleft
license designed for free software.
We have designed this License in order to use it for manuals for free
software, because free software needs free documentation: a free
program should come with manuals providing the same freedoms that the
software does. But this License is not limited to software manuals;
it can be used for any textual work, regardless of subject matter or
whether it is published as a printed book. We recommend this License
principally for works whose purpose is instruction or reference.
\subsubsection{Applicability and Definitions}
This License applies to any manual or other work that contains a
notice placed by the copyright holder saying it can be distributed
under the terms of this License. The ``Document'', below, refers to any
such manual or work. Any member of the public is a licensee, and is
addressed as ``you''.
A ``Modified Version'' of the Document means any work containing the
Document or a portion of it, either copied verbatim, or with
modifications and/or translated into another language.
A ``Secondary Section'' is a named appendix or a front-matter section of
the Document that deals exclusively with the relationship of the
publishers or authors of the Document to the Document's overall subject
(or to related matters) and contains nothing that could fall directly
within that overall subject. (For example, if the Document is in part a
textbook of mathematics, a Secondary Section may not explain any
mathematics.) The relationship could be a matter of historical
connection with the subject or with related matters, or of legal,
commercial, philosophical, ethical or political position regarding
them.
The ``Invariant Sections'' are certain Secondary Sections whose titles
are designated, as being those of Invariant Sections, in the notice
that says that the Document is released under this License.
The ``Cover Texts'' are certain short passages of text that are listed,
as Front-Cover Texts or Back-Cover Texts, in the notice that says that
the Document is released under this License.
A ``Transparent'' copy of the Document means a machine-readable copy,
represented in a format whose specification is available to the
general public, whose contents can be viewed and edited directly and
straightforwardly with generic text editors or (for images composed of
pixels) generic paint programs or (for drawings) some widely available
drawing editor, and that is suitable for input to text formatters or
for automatic translation to a variety of formats suitable for input
to text formatters. A copy made in an otherwise Transparent file
format whose markup has been designed to thwart or discourage
subsequent modification by readers is not Transparent. A copy that is
not ``Transparent'' is called ``Opaque''.
Examples of suitable formats for Transparent copies include plain
ASCII without markup, Texinfo input format, \LaTeX~input format, SGML
or XML using a publicly available DTD, and standard-conforming simple
HTML designed for human modification. Opaque formats include
PostScript, PDF, proprietary formats that can be read and edited only
by proprietary word processors, SGML or XML for which the DTD and/or
processing tools are not generally available, and the
machine-generated HTML produced by some word processors for output
purposes only.
The ``Title Page'' means, for a printed book, the title page itself,
plus such following pages as are needed to hold, legibly, the material
this License requires to appear in the title page. For works in
formats which do not have any title page as such, ``Title Page'' means
the text near the most prominent appearance of the work's title,
preceding the beginning of the body of the text.
\subsubsection{Verbatim Copying}
You may copy and distribute the Document in any medium, either
commercially or noncommercially, provided that this License, the
copyright notices, and the license notice saying this License applies
to the Document are reproduced in all copies, and that you add no other
conditions whatsoever to those of this License. You may not use
technical measures to obstruct or control the reading or further
copying of the copies you make or distribute. However, you may accept
compensation in exchange for copies. If you distribute a large enough
number of copies you must also follow the conditions in section 3.
You may also lend copies, under the same conditions stated above, and
you may publicly display copies.
\subsubsection{Copying in Quantity}
If you publish printed copies of the Document numbering more than 100,
and the Document's license notice requires Cover Texts, you must enclose
the copies in covers that carry, clearly and legibly, all these Cover
Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
the back cover. Both covers must also clearly and legibly identify
you as the publisher of these copies. The front cover must present
the full title with all words of the title equally prominent and
visible. You may add other material on the covers in addition.
Copying with changes limited to the covers, as long as they preserve
the title of the Document and satisfy these conditions, can be treated
as verbatim copying in other respects.
If the required texts for either cover are too voluminous to fit
legibly, you should put the first ones listed (as many as fit
reasonably) on the actual cover, and continue the rest onto adjacent
pages.
If you publish or distribute Opaque copies of the Document numbering
more than 100, you must either include a machine-readable Transparent
copy along with each Opaque copy, or state in or with each Opaque copy
a publicly-accessible computer-network location containing a complete
Transparent copy of the Document, free of added material, which the
general network-using public has access to download anonymously at no
charge using public-standard network protocols. If you use the latter
option, you must take reasonably prudent steps, when you begin
distribution of Opaque copies in quantity, to ensure that this
Transparent copy will remain thus accessible at the stated location
until at least one year after the last time you distribute an Opaque
copy (directly or through your agents or retailers) of that edition to
the public.
It is requested, but not required, that you contact the authors of the
Document well before redistributing any large number of copies, to give
them a chance to provide you with an updated version of the Document.
\subsubsection{Modifications}
You may copy and distribute a Modified Version of the Document under
the conditions of sections 2 and 3 above, provided that you release
the Modified Version under precisely this License, with the Modified
Version filling the role of the Document, thus licensing distribution
and modification of the Modified Version to whoever possesses a copy
of it. In addition, you must do these things in the Modified Version:
\begin{itemize}
\item Use in the Title Page (and on the covers, if any) a title distinct
from that of the Document, and from those of previous versions
(which should, if there were any, be listed in the History section
of the Document). You may use the same title as a previous version
if the original publisher of that version gives permission.
\item List on the Title Page, as authors, one or more persons or entities
responsible for authorship of the modifications in the Modified
Version, together with at least five of the principal authors of the
Document (all of its principal authors, if it has less than five).
\item State on the Title page the name of the publisher of the
Modified Version, as the publisher.
\item Preserve all the copyright notices of the Document.
\item Add an appropriate copyright notice for your modifications
adjacent to the other copyright notices.
\item Include, immediately after the copyright notices, a license notice
giving the public permission to use the Modified Version under the
terms of this License, in the form shown in the Addendum below.
\item Preserve in that license notice the full lists of Invariant Sections
and required Cover Texts given in the Document's license notice.
\item Include an unaltered copy of this License.
\item Preserve the section entitled ``History'', and its title, and add to
it an item stating at least the title, year, new authors, and
publisher of the Modified Version as given on the Title Page. If
there is no section entitled ``History'' in the Document, create one
stating the title, year, authors, and publisher of the Document as
given on its Title Page, then add an item describing the Modified
Version as stated in the previous sentence.
\item Preserve the network location, if any, given in the Document for
public access to a Transparent copy of the Document, and likewise
the network locations given in the Document for previous versions
it was based on. These may be placed in the ``History'' section.
You may omit a network location for a work that was published at
least four years before the Document itself, or if the original
publisher of the version it refers to gives permission.
\item In any section entitled ``Acknowledgements'' or ``Dedications'',
preserve the section's title, and preserve in the section all the
substance and tone of each of the contributor acknowledgements
and/or dedications given therein.
\item Preserve all the Invariant Sections of the Document,
unaltered in their text and in their titles. Section numbers
or the equivalent are not considered part of the section titles.
\item Delete any section entitled ``Endorsements''. Such a section
may not be included in the Modified Version.
\item Do not retitle any existing section as ``Endorsements''
or to conflict in title with any Invariant Section.
\end{itemize}
If the Modified Version includes new front-matter sections or
appendices that qualify as Secondary Sections and contain no material
copied from the Document, you may at your option designate some or all
of these sections as invariant. To do this, add their titles to the
list of Invariant Sections in the Modified Version's license notice.
These titles must be distinct from any other section titles.
You may add a section entitled ``Endorsements'', provided it contains
nothing but endorsements of your Modified Version by various
parties --- for example, statements of peer review or that the text has
been approved by an organization as the authoritative definition of a
standard.
You may add a passage of up to five words as a Front-Cover Text, and a
passage of up to 25 words as a Back-Cover Text, to the end of the list
of Cover Texts in the Modified Version. Only one passage of
Front-Cover Text and one of Back-Cover Text may be added by (or
through arrangements made by) any one entity. If the Document already
includes a cover text for the same cover, previously added by you or
by arrangement made by the same entity you are acting on behalf of,
you may not add another; but you may replace the old one, on explicit
permission from the previous publisher that added the old one.
The author(s) and publisher(s) of the Document do not by this License
give permission to use their names for publicity for or to assert or
imply endorsement of any Modified Version.
\subsubsection{Combining Documents}
You may combine the Document with other documents released under this
License, under the terms defined in section 4 above for modified
versions, provided that you include in the combination all of the
Invariant Sections of all of the original documents, unmodified, and
list them all as Invariant Sections of your combined work in its
license notice.
The combined work need only contain one copy of this License, and
multiple identical Invariant Sections may be replaced with a single
copy. If there are multiple Invariant Sections with the same name but
different contents, make the title of each such section unique by
adding at the end of it, in parentheses, the name of the original
author or publisher of that section if known, or else a unique number.
Make the same adjustment to the section titles in the list of
Invariant Sections in the license notice of the combined work.
In the combination, you must combine any sections entitled ``History''
in the various original documents, forming one section entitled
``History''; likewise combine any sections entitled ``Acknowledgements'',
and any sections entitled ``Dedications''. You must delete all sections
entitled ``Endorsements''.
\subsubsection{Collections of Documents}
You may make a collection consisting of the Document and other documents
released under this License, and replace the individual copies of this
License in the various documents with a single copy that is included in
the collection, provided that you follow the rules of this License for
verbatim copying of each of the documents in all other respects.
\enlargethispage{100pt}
You may extract a single document from such a collection, and distribute
it individually under this License, provided you insert a copy of this
License into the extracted document, and follow this License in all
other respects regarding verbatim copying of that document.
\newpage
\subsubsection{Aggregation With Independent Works}
A compilation of the Document or its derivatives with other separate
and independent documents or works, in or on a volume of a storage or
distribution medium, does not as a whole count as a Modified Version
of the Document, provided no compilation copyright is claimed for the
compilation. Such a compilation is called an ``aggregate'', and this
License does not apply to the other self-contained works thus compiled
with the Document, on account of their being thus compiled, if they
are not themselves derivative works of the Document.
If the Cover Text requirement of section 3 is applicable to these
copies of the Document, then if the Document is less than one quarter
of the entire aggregate, the Document's Cover Texts may be placed on
covers that surround only the Document within the aggregate.
Otherwise they must appear on covers around the whole aggregate.
\subsubsection{Translation}
Translation is considered a kind of modification, so you may
distribute translations of the Document under the terms of section 4.
Replacing Invariant Sections with translations requires special
permission from their copyright holders, but you may include
translations of some or all Invariant Sections in addition to the
original versions of these Invariant Sections. You may include a
translation of this License provided that you also include the
original English version of this License. In case of a disagreement
between the translation and the original English version of this
License, the original English version will prevail.
\subsubsection{Termination}
You may not copy, modify, sublicense, or distribute the Document except
as expressly provided for under this License. Any other attempt to
copy, modify, sublicense or distribute the Document is void, and will
automatically terminate your rights under this License. However,
parties who have received copies, or rights, from you under this
License will not have their licenses terminated so long as such
parties remain in full compliance.
\subsubsection{Future Revisions of This License}
The Free Software Foundation may publish new, revised versions
of the GNU Free Documentation License from time to time. Such new
versions will be similar in spirit to the present version, but may
differ in detail to address new problems or concerns. See
http://www.gnu.org/copyleft/.
Each version of the License is given a distinguishing version number.
If the Document specifies that a particular numbered version of this
License ``or any later version'' applies to it, you have the option of
following the terms and conditions either of that specified version or
of any later version that has been published (not as a draft) by the
Free Software Foundation. If the Document does not specify a version
number of this License, you may choose any version ever published (not
as a draft) by the Free Software Foundation.
\newpage
\subsubsection*{ADDENDUM: How to use this License for your documents}
To use this License in a document you have written, include a copy of
the License in the document and put the following copyright and
license notices just after the title page:
\begin{quote}
Copyright \copyright\ YEAR YOUR NAME.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.1
or any later version published by the Free Software Foundation;
with the Invariant Sections being LIST THEIR TITLES, with the
Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.
A copy of the license is included in the section entitled ``GNU
Free Documentation License''.
\end{quote}
If you have no Invariant Sections, write ``with no Invariant Sections''
instead of saying which ones are invariant. If you have no
Front-Cover Texts, write ``no Front-Cover Texts'' instead of
``Front-Cover Texts being LIST''; likewise for Back-Cover Texts.
If your document contains nontrivial examples of program code, we
recommend releasing these examples in parallel under your choice of
free software license, such as the GNU General Public License,
to permit their use in free software.
|