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
|
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<refentry>
<refentryinfo>
<date>2008-Dec-13</date>
<author>
<firstname>Steve</firstname>
<surname>McInerney</surname>
<email>steve@stedee.id.au</email>
</author>
<author>
<firstname>Bradford</firstname>
<surname>L. Barrett</surname>
<email>brad@mrunix.net</email>
</author>
</refentryinfo>
<refmeta>
<refentrytitle>awffull.conf</refentrytitle>
<manvolnum>5</manvolnum>
</refmeta>
<refnamediv>
<refname>AWFFull</refname>
<refpurpose>A Webalizer Fork, Full o' features</refpurpose>
</refnamediv>
<refsect1 id="description">
<title>Description</title>
<para>awffull.conf is the configuration file for
<productname>awffull</productname>(1). awffull.conf is a standard
<productname>ASCII</productname>(7) text files that may be created or
edited using any standard editor.</para>
<para>Blank lines and lines that begin with a pound sign ('#') are
ignored.</para>
<para>Any other lines are considered to be configuration lines, and have
the form <quote>Keyword Value</quote>, where the <quote>Keyword</quote> is
one of the currently available configuration keywords, and
<quote>Value</quote> is the value to assign to that particular
option.</para>
<para>Any text found after the keyword up to the end of the line is
considered the keyword's value, so you should not include anything after
the actual value on the line that is not actually part of the value being
assigned. The file
<filename><application>sample.conf</application></filename> provided with
the distribution contains lots of useful documentation and examples as
well.</para>
<para>Some <quote>Keywords</quote> will accept a
2<superscript>nd</superscript> value. In those situations, the first value
may be enclosed in double quotes (") to allow for whitespace.</para>
<para>Keywords are Case Insensitive. Values are Case Sensitive, with some
gotchas: See Ignore* for details.</para>
</refsect1>
<refsect1 id="wildcards">
<title>Wildcards</title>
<para>Wildcards within <productname>AWFFull</productname> are a little non
standard and may cause some confusion.</para>
<para>Wildcards are only valid within the Value of certain keywords</para>
<para>A Value can have either a leading or trailing '*' to signify a
wildcard character. If no wildcard is found, a match can occur anywhere in
the string. Given a string <quote>www.yourmama.com</quote>, the values
<quote>your</quote>, <quote>*mama.com</quote> and <quote>www.your*</quote>
will all match.</para>
<para>Thus the use of the wildcard signifies that the other end of the
Value is anchored at the Beginning or End of a field to be searched
against.</para>
<para>eg. A Value of <quote>Bot*</quote> implies that the field (probably
UserAgent in this case) MUST start with the letters Bot. Or in the case of
a Hostname <quote>*.gov.au</quote> implies a match ONLY against Australian
Government hostnames.</para>
</refsect1>
<refsect1 id="run_options">
<title>Run Options</title>
<para>The Run Options are the generic ones that tell AWFFull where stuff
is and how to generally operate. Some of these can modify the results that
AWFFull will produce.</para>
<variablelist>
<varlistentry>
<term>OutputDir</term>
<listitem>
<para><property>OutputDir</property> is where you want to put the
output files. This should should be a full path name, however
relative ones might work as well. If no output directory is
specified, the current directory will be used.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>LogFile</term>
<listitem>
<para><property>LogFile</property> defines the web server log file
to use. If not specified here or on on the command line, input will
default to STDIN. If the log filename ends in '.gz' (ie: a
<application>gzip</application> compressed file), it will be
decompressed on the fly as it is being read.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>LogType</term>
<listitem>
<para><property>LogType</property> defines the log type being
processed. Normally, <productname>AWFFull</productname> expects a
CLF or Combined web server log as input. Using this option, you can
process ftp logs as well (<filename>xferlog</filename> as produced
by <productname>wu-ftpd</productname> and others), or
<productname>Squid</productname> native logs. Values can be 'auto'
'clf', 'combined', 'ftp', 'domino' or 'squid', with 'auto' the
default. The 'auto' value means that
<productname>AWFFull</productname> will try and work out what log
format you are sending to it. If no joy,
<productname>AWFFull</productname> will immediately exit.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>GeoIP</term>
<listitem>
<para><property>GeoIP</property> enables or disables the use of the
<productname>GeoIP</productname> capability for more accurate
detection of countries. Default is <quote>no</quote>. NOTE! Do not
enable GeoIP if you analyse files that have had the IP Address
translated to a Fully Qualified Host Name. Use either raw IP
Addresses and GeoIP, or Names and disable GeoIP. ie. Don't use GeoIP
AND DNShistory.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>GeoIPDatabase</term>
<listitem>
<para><property>GeoIPDatabase</property> is the location of the
<productname>GeoIP</productname> database file. Default is
<filename>/usr/local/share/GeoIP/GeoIP.dat</filename>, which is
where a default <productname>GeoIP</productname> install will put
it. Note that the database is updated monthly. For the details see:
<ulink
url="http://www.maxmind.com/app/geoip_country">http://www.maxmind.com/app/geoip_country</ulink></para>
</listitem>
</varlistentry>
<varlistentry>
<term>Incremental</term>
<listitem>
<para><property>Incremental</property> processing allows multiple
partial log files to be used instead of one huge one. Useful for
large sites that have to rotate their log files more than once a
month. <productname>AWFFull</productname> will save its internal
state before exiting, and restore it the next time run, in order to
continue processing where it left off. This mode also causes
<productname>AWFFull</productname> to scan for and ignore duplicate
records (records already processed by a previous run). See the
<filename>README</filename> file for additional information. The
value may be 'yes' or 'no', with a default of 'no'. The file
<filename>awffull.current</filename> is used to store the current
state data, and is located in the output directory of the program
(unless changed with the <property>IncrementalName</property> option
below). Please read at least the section on Incremental processing
in the <filename>README</filename> file before you enable this
option.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>TimeMe</term>
<listitem>
<para><property>TimeMe</property> allows you to force the display of
timing information at the end of processing. A value of 'yes' will
force the timing information to be displayed. A value of 'no' has no
effect.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>IgnoreHist</term>
<listitem>
<para><property>IgnoreHist</property> should not be used in a
standard configuration, but it is here because it is useful in
certain analysis situations. If the history file is ignored, the
main <quote><filename>index.html</filename></quote> file will only
report on the current log files contents. Incremental data (if
present) is still processed. Useful when you want to reproduce the
reports from scratch, for example. USE WITH CAUTION! Valid values
are <quote>yes</quote> or <quote>no</quote>. Default is
<quote>no</quote>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>IncrementalName</term>
<listitem>
<para><property>IncrementalName</property> allows you to specify the
filename for saving the incremental data in. It is similar to the
HistoryName option where the name is relative to the specified
output directory, unless an absolute filename is specified. The
default is a file named
<quote><filename>awffull.current</filename></quote> kept in the
normal output directory. If you don't specify
<property>Incremental</property> as 'yes' then this option has no
meaning.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>HistoryName</term>
<listitem>
<para><property>HistoryName</property> allows you to specify the
name of the history file produced by
<productname>AWFFull</productname>. The history file keeps the data
for up to 12 months worth of logs, used for generating the main HTML
page (<filename>index.html</filename>). The default is a file named
<filename>awffull.hist</filename>, stored in the specified output
directory. If you specify just the filename (without a path), it
will be kept in the specified output directory. Otherwise, the path
is relative to the output directory, unless absolute (leading
/).</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="analysis_options">
<title>Analysis Options</title>
<para>These are the basic analysis options that one can and should modify
to start fine tuning <productname>AWFFull</productname> against a given
website.</para>
<variablelist>
<varlistentry>
<term>PageType</term>
<listitem>
<para>PageType lets you tell AWFFull what types of URL's you
consider a 'page'. Most people consider html and cgi documents as
pages, while not images and audio files. If no types are specified,
defaults will be used ('htm', 'html', 'cgi' and HTMLExtension if
different for web logs, 'txt' for ftp logs). Putting the more likely
page types first in the list should increase the speed of a
run.</para>
<para>Do Not Use Wildcards Here. It will not work.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>NotPageType</term>
<listitem>
<para>NotPageType is the direct and incompatible opposite of
PageType. You can use one set or the other, but not both. PageType
specifies what *is* a Page, NotPageType specifies what *isn't*, and
hence by implication, everything else is a page. Neither method is
more or lessor correct than the other. It's more what is more
accurate for *your* site. Do not add the "." or use any wildcards.
As a general rule. There are some assumed internal optimisations
that may otherwise break. Those who understand pcre's would do well
to examine the source of parser.c if they wish to extract greater
flexibility from the below.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>FoldSeqErr</term>
<listitem>
<para>FoldSeqErr forces <productname>AWFFull</productname> to ignore
sequence errors. This is useful for Netscape and other web servers
that cache the writing of log records and do not guarantee that they
will be in chronological order. The use of the FoldSeqErr option
will cause out of sequence log records to be treated as if they had
the same time stamp as the last valid record. The default action is
to ignore out of sequence log records.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>SearchEngine</term>
<listitem>
<para>The SearchEngine keywords allow specification of search
engines and their query strings on the URL. These are used to locate
and report what search strings are used to find your site. The first
word is a substring to match in the referrer field that identifies
the search engine, and the second is the URL variable used by that
search engine to define it's search terms.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>VisitTimeout</term>
<listitem>
<para>VisitTimeout allows you to set the default timeout for a visit
(sometimes called a 'session'). The default is 30 minutes, which
should be fine for most sites. Visits are determined by looking at
the time of the current request, and the time of the last request
from the site. If the time difference is greater than the
VisitTimeout value, it is considered a new visit, and visit totals
are incremented. Value is the number of seconds to timeout
(default=1800=30min)</para>
</listitem>
</varlistentry>
<varlistentry>
<term>TrackPartialRequests</term>
<listitem>
<para>TrackPartialRequests is used to track 206 codes. This gives
two additional columns in the Top URLs tables. The first to "Hits"
counts the number of partial requests The second to "Volume" counts
the volume in partial requests This option is more of use to those
with lots of PDF's.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>MangleAgents</term>
<listitem>
<para>The MangleAgents allows you to specify how much, if any,
AWFFull should mangle user agent names. This allows several levels
of detail to be produced when reporting user agent statistics. There
are six levels that can be specified, which define different levels
of detail suppression. Level 5 shows only the browser name (MSIE or
Mozilla) and the major version number. Level 4 adds the minor
version number (single decimal place). Level 3 displays the minor
version to two decimal places. Level 2 will add any sub-level
designation (such as Mozilla/3.01Gold or MSIE 3.0b). Level 1 will
attempt to also add the system type if it is specified. The default
Level 0 displays the full user agent field without modification and
produces the greatest amount of detail. User agent names that can't
be mangled will be left unmodified.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>AssignToCountry</term>
<listitem>
<para>AssignToCountry allows a form of override to force given
domains to a specified country. Use the standard 2 letter country
codes. Can also use org, com, net and so on, if more appropriate.
With judicious use of AllSites, GroupSite and 'whois', this can
cover the majority of your users without too much effort.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>IndexAlias</term>
<listitem>
<para>AWFFull normally strips the string 'index.' off the end of
URL's in order to consolidate URL totals. For example, the URL
/somedir/index.html is turned into /somedir/ which is really the
same URL. This option allows you to specify additional strings to
treat in the same way. You don't need to specify 'index.' as it is
always scanned for by AWFFull, this option is just to specify
_additional_ strings if needed. If you don't need any, don't specify
any as each string will be scanned for in EVERY log record... A
bunch of them will degrade performance. Also, the string is scanned
for anywhere in the URL, so a string of 'home' would turn the URL
/somedir/homepages/brad/home.html into just /somedir/ which is
probably not what was intended.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>IgnoreIndexAlias</term>
<listitem>
<para>The opposite (in a way) of IndexAlias is IgnoreIndexAlias.
This will STOP any URL variable stripping, as well as ignoring the
default "index." setting, or any that you set above.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="ignore_options">
<title>Ignore* Options</title>
<para>The Ignore* keywords allow you to completely ignore, or filter away,
log records based on hostname, URL, user agent, referrer or user name. Use
the same syntax as the Hide* keywords, where the value can have a leading
or trailing wildcard '*'.</para>
<variablelist>
<varlistentry>
<term>IgnoreURL</term>
<listitem>
<para>Filters out traffic accessing certain URLs. eg You may wish to
avoid seeing traffic that accesses administration functions, thus
"IgnoreURL /admin*". URLs are case sensitive.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>IgnoreSite</term>
<listitem>
<para>Ignore sites that visit this website. Ignore by what is
presented to awffull - name or IP Address. Sites are lowercased
prior to filtering, so if Ignore'ing by name, do use a lowercased
Value.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>IgnoreReferrer</term>
<listitem>
<para>Ignore specified referrers. Very useful for filtering away
SPAM Referrers. Referrers are partially case sensitive. \o/ The host
portion is lowercased; the URI is case sensitive.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>IgnoreUser</term>
<listitem>
<para>Ignore specified users. User names are lowercased prior to
filtering.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>IgnoreAgent</term>
<listitem>
<para>Agents are case sensitive.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="include_options">
<title>Include* Options</title>
<para>The Include* keywords allow you to force the inclusion of log
records based on hostname, URL, user agent, referrer or user name. The
Include* keywords take precedence over the Ignore* keywords.</para>
<para>Note: Using Ignore/Include combinations to selectively process parts
of a web site is _extremely inefficient_!!! Avoid doing so if possible ie:
grep or gawk the records to a separate file if you really want that kind
of report.</para>
<variablelist>
<varlistentry>
<term>IncludeURL</term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry>
<term>IncludeSite</term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry>
<term>IncludeReferrer</term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry>
<term>IncludeUser</term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry>
<term>IncludeAgent</term>
<listitem>
<para></para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="segmenting_options">
<title>Segmenting Options</title>
<para>Segmenting is a bit like the Ignore* and Include* keywords. Where it
differs is in "remembering". Such that, as a <quote>session</quote> (or
<quote>visit</quote>) moves away from the original entry condition, that
session is still tracked. So if you segment on a referal from Google, only
sessions that were refered to the analysed website, from Google, will be
tracked. Even as that same session accesses other pages within the
website.</para>
<para>eg. Google -> Site Page 1 -> Site Page 2 -> Site Page
3</para>
<para>Whereas Ignore/Include would only filter the first interaction. eg.
Google -> Site Page 1</para>
<para>By "session" (or <quote>visit</quote>) it is meant that the time
limitation of a session (typically 30 minutes timeout) will impact. So in
the above example from Google, if the last step (from Page 2 to Page 3)
occured 31+ minutes after the Page 1 to Page 2 transition, then this final
step would NOT be included. The trail would be:</para>
<para>Google -> Site Page 1 -> Site Page 2</para>
<para>Please do be aware that currently <productname>AWFFull</productname>
uses IP Addresses to determine the continuation of a given session. This
will be most flawed if you have a user population that sits behind
corporate firewalls, or ISP Proxies. To mention two major problem
areas.</para>
<bridgehead>Why do Segmenting?</bridgehead>
<para><ulink
url="http://judah.webanalyticsdemystified.com/2007/11/a-few-tips-on-web-analytics-segmentation.html">http://judah.webanalyticsdemystified.com/2007/11/a-few-tips-on-web-analytics-segmentation.html</ulink></para>
<para><quote>Segment analysis will tell you different things about your
audience than you will realize from studying overall population
metrics.</quote></para>
<para><quote>The goal of segmentation is to maximize future value of that
segment by optimizing your marketing mix.</quote></para>
<para>With apologies to Judah for mixing his phrase order around.
:-)</para>
<variablelist>
<varlistentry>
<term>SegCountry</term>
<listitem>
<para>Segment by Country: Only track sessions that come from the
following countries. This will be determined by:</para>
<orderedlist>
<listitem>
<para>Use of AssignToCountry overrides</para>
</listitem>
<listitem>
<para>GeoIP lookups if so configured and enabled</para>
</listitem>
<listitem>
<para>Hostname TLD. eg .au</para>
</listitem>
</orderedlist>
<para>The third option is generally going to be the worst for
accuracy. eg. We have plenty of Australian IP addresses that
otherwise resolve to .com or .net etc.</para>
<para>It is strongly advised to enable GeoIP if you wish to use this
option.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>SegReferer</term>
<listitem>
<para>Segment by Referer: Only track sessions that originated from
the following referers. NOTE!!!! SegReferer only works against the
HOST name. Not the full URL.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="display_options">
<title>Display Options</title>
<para>The Display Options modify the resulting output that
<productname>AWFFull</productname> produces. Things like HTML Headers and
Footers to add on every page. These options don't change the numbers that
AWFFull will calculate, but may change which ones appear, giving the
illusion of a numerical change.</para>
<variablelist>
<varlistentry>
<term>ReportTitle</term>
<listitem>
<para>ReportTitle is the text to display as the title. The hostname
(unless blank) is appended to the end of this string (separated with
a space) to generate the final full title string. Default is (for
English) <quote>Usage Statistics for</quote>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>HostName</term>
<listitem>
<para>HostName defines the hostname for the report. This is used in
the title, and is prepended to the URL table items. This allows
clicking on URL's in the report to go to the proper location in the
event you are running the report on a 'virtual' web server, or for a
server different than the one the report resides on. If not
specified here, or on the command line,
<productname>AWFFull</productname> will try to get the hostname via
a uname system call. If that fails, it will default to
<quote>localhost</quote>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>IndexMonths</term>
<listitem>
<para>This option controls how many years worth of data to display
on the front summary page. In months. eg: Display the last 5 years:
5 x 12 = 60</para>
</listitem>
</varlistentry>
<varlistentry>
<term>DailyStats</term>
<listitem>
<para>DailyStats allows the daily statistics table to be disabled -
not displayed. Values may be <quote>yes</quote> or
<quote>no</quote>. Default is <quote>yes</quote> - do display the
Daily Statistics table.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>HourlyStats</term>
<listitem>
<para>HourlyGraph and HourlyStats allows the hourly statistics graph
and statistics table to be disabled (not displayed). Values may be
"yes" or "no". Default is "yes".</para>
</listitem>
</varlistentry>
<varlistentry>
<term>CSSFilename</term>
<listitem>
<para>CSSFilename is used to set the name of the CSS file to use in
conjunction with the generated html. An existing file is not
overwritten, so feel free to make you own changes to the default
file. The default is <filename>awffull.css</filename>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>FlagsLocation</term>
<listitem>
<para>FlagsLocation will enable the display of country flag pictures
in the country table. The path is that for a webserver, not file
system. Can be relative or complete. The trailing slash is not
necessary. The default location is not set and hence will not be
used.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>YearlySubtotals</term>
<listitem>
<para>YearlySubtotals will display the subtotal for a given year in
the main page. This is in addition to the Grand Total of all
years.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>GroupShading</term>
<listitem>
<para>The GroupShading allows grouped rows to be shaded in the
report. Useful if you have lots of groups and individual records
that intermingle in the report, and you want to differentiate the
group records a little more. Value can be <quote>yes</quote> or
<quote>no</quote>, with <quote>yes</quote> being the default.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>GroupHighlight</term>
<listitem>
<para>GroupHighlight allows the group record to be displayed in
BOLD. Can be either <quote>yes</quote> or <quote>no</quote> with the
default being <quote>yes</quote>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>HTMLExtension</term>
<listitem>
<para>HTMLExtension allows you to specify the filename extension to
use for generated HTML pages. Normally, this defaults to "html", but
can be changed for sites who need it (like for PHP embedded
pages).</para>
</listitem>
</varlistentry>
<varlistentry>
<term>UseHTTPS</term>
<listitem>
<para>UseHTTPS should be used if the analysis is being run on a
secure server, and links to urls should use <quote>https://</quote>
instead of the default <quote>http://</quote>. If you need this, set
it to <quote>yes</quote>. Default is <quote>no</quote>. This only
changes the behaviour of the <quote>Top URLs</quote> table.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Top*</term>
<listitem>
<para>The various <quote>Top</quote> options below define the number
of entries for each table. Tables may be disabled by using zero (0)
for the value.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>TopURLs</term>
<listitem>
<para>The most accessed URLs or Resources by number of requests
(hits). Includes both Pages and Images, for example. Defaults to 30
URLs.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>TopKURLs</term>
<listitem>
<para>The greatest volume generating URLs. Defaults to 10
URL's.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>TopEntry</term>
<listitem>
<para>The most accessed initial URLs within a complete Visit. Will
also display Single Access counts, Stickiness ration and Popularity
ratio. Defaults to 10 URLs.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>TopExit</term>
<listitem>
<para>The most accessed last URLs within a complete Visit. ie: The
last page recorded of a Visit. Also displays the Popularity ratio.
Defaults to 10 URLs.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Top404Errors</term>
<listitem>
<para>The most seen error requests and a corresponding referring
URL. Defaults to 0, ie not shown.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>TopSites</term>
<listitem>
<para>Those Sites that have accessed the most Pages. Default is 30
Sites.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>TopKSites</term>
<listitem>
<para>Those Sites that have downloaded the greatest Volume. Default
is 10 Sites.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>TopReferrers</term>
<listitem>
<para>Those local and remote URLs that refer the most requests.
Default is 30 Referrers.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>TopSearch</term>
<listitem>
<para>Those words and phrases used at remote Search Engines to
direct traffic here. Default is 20 Phrases.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>TopUsers</term>
<listitem>
<para>Those logged in users who most use the site. Default is 20
Users.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>TopAgents</term>
<listitem>
<para>The Browser Agents that are busiest against this site. Default
is 15 Agents.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>TopCountries</term>
<listitem>
<para>A view of all traffic against this site via country.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>All*</term>
<listitem>
<para>The All* keywords allow the display of all the below measures.
If enabled, a separate HTML page will be created, and a link will be
added to the bottom of the appropriate "Top" table. There are a
couple of conditions for this to occur. First, there must be more
items than will fit in the "Top" table (otherwise it would just be
duplicating what is already displayed). Second, the listing will
only show those items that are normally visible, which means it will
not show any hidden items. Grouped entries will be listed first,
followed by individual items. The value for these keywords can be
either 'yes' or 'no', with the default being 'no'. Please be aware
that these pages can be quite large in size, particularly the sites
page, and separate pages are generated for each month, which can
consume quite a lot of disk space depending on the traffic to your
site.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>AllURLs</term>
<listitem>
<para>All accessed URLs</para>
</listitem>
</varlistentry>
<varlistentry>
<term>AllEntryPages</term>
<listitem>
<para>All Pages that initialised a Visit</para>
</listitem>
</varlistentry>
<varlistentry>
<term>AllExitPages</term>
<listitem>
<para>All the last or exit pages in all Visits.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>All404Errors</term>
<listitem>
<para>All ErrorRequests and the corresponding referral URLs.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>AllSites</term>
<listitem>
<para>All remote sites that accessed this website.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>AllReferrers</term>
<listitem>
<para>All local and remote referring URLs</para>
</listitem>
</varlistentry>
<varlistentry>
<term>AllSearchStr</term>
<listitem>
<para>All Remote Search Engine words and Phrases used to refer
traffic here.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>AllUsers</term>
<listitem>
<para>All users who logged into this website.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>AllAgents</term>
<listitem>
<para>All Browser Agents used to access this site. Useful for
identifying robots.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>GMTTime</term>
<listitem>
<para>GMTTime allows reports to show GMT (UTC) time instead of local
time. Default is to display the time the report was generated in the
timezone of the local machine, such as EDT or PST. This keyword
allows you to have times displayed in UTC instead. Use only if you
really have a good reason, since it will probably screw up the
reporting periods by however many hours your local time zone is off
of GMT.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>HTMLPre</term>
<listitem>
<para>HTMLPre defines HTML code to insert at the very beginning of
the file. Default is the DOCTYPE line shown below. Max line length
is 80 characters, so use multiple HTMLPre lines if you need
more.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>HTMLHead</term>
<listitem>
<para>HTMLHead defines HTML code to insert within the
<code><HEAD></HEAD></code> block, immediately after the
<code><TITLE></code> line. Maximum line length is 80
characters, so use multiple lines if needed.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>HTMLBody</term>
<listitem>
<para>HTMLBody defined the HTML code to be inserted, starting with
the <BODY> tag. If not specified, the default is shown below.
If used, you MUST include your own <BODY> tag as the first
line. Maximum line length is 80 char, use multiple lines if
needed.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>HTMLPost</term>
<listitem>
<para>HTMLPost defines the HTML code to insert immediately before
the first <HR> on the document, which is just after the title
and "summary period"-"Generated on:" lines. If anything, this should
be used to clean up in case an image was inserted with HTMLBody. As
with HTMLHead, you can define as many of these as you want and they
will be inserted in the output stream in order of appearance. Max
string size is 80 characters. Use multiple lines if you need
to.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>HTMLTail</term>
<listitem>
<para>HTMLTail defines the HTML code to insert at the bottom of each
HTML document, usually to include a link back to your home page or
insert a small graphic. It is inserted as a table data element (ie:
<TD> your code here </TD>) and is right aligned with the
page. The maximum string size is 80 characters.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>HTMLEnd</term>
<listitem>
<para>HTMLEnd defines the HTML code to add at the very end of the
generated files. It defaults to what is shown below. If used, you
MUST specify the </BODY> and </HTML> closing tags as the
last lines. The maximum string length is 80 characters.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="graphing_options">
<title>Graphing Options</title>
<para>As distinct from the general Display Options, the Graphing Options
focus on manipulating the various graphs produced.</para>
<variablelist>
<varlistentry>
<term>CountryGraph</term>
<listitem>
<para>CountryGraph allows the usage by country graph to be disabled.
Values can be 'yes' or 'no', default is 'yes'.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>DailyGraph</term>
<listitem>
<para>DailyGraph determines if the daily statistics graph will be
displayed or not. Values may be "yes" or "no". Default is "yes" - do
display the daily graph.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>HourlyGraph</term>
<listitem>
<para>HourlyGraph determines if the daily statistics graph will be
displayed or not. Values may be "yes" or "no". Default is "yes" - do
display the hourly graph.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>TopURLsbyHitsGraph</term>
<listitem>
<para>Display a pie chart of the top URLs by HITS</para>
</listitem>
</varlistentry>
<varlistentry>
<term>TopURLsbyVolGraph</term>
<listitem>
<para>Display a pie chart of the top URLs by HITS</para>
</listitem>
</varlistentry>
<varlistentry>
<term>TopExitPagesGraph</term>
<listitem>
<para>Display Top Exit Pages Pie Chart. Values may be
<quote>hits</quote> or <quote>visits</quote> or "no". Default is
"no"</para>
<para><quote>hits</quote> means order the graph by hits</para>
<para><quote>visits</quote> means order the graph by visits</para>
</listitem>
</varlistentry>
<varlistentry>
<term>TopEntryPagesGraph</term>
<listitem>
<para>Display Top Entry Pages Pie Chart. Values may be
<quote>hits</quote> or <quote>visits</quote> or "no". Default is
"no"</para>
<para><quote>hits</quote> means order the graph by hits</para>
<para><quote>visits</quote> means order the graph by visits</para>
</listitem>
</varlistentry>
<varlistentry>
<term>TopSitesbyPagesGraph</term>
<listitem>
<para>Display a pie chart of the Top Sites by Page
Impressions</para>
</listitem>
</varlistentry>
<varlistentry>
<term>TopSitesbyVolGraph</term>
<listitem>
<para>Display a pie chart of the Top Sites by Page
Impressions</para>
</listitem>
</varlistentry>
<varlistentry>
<term>TopAgentsGraph</term>
<listitem>
<para>Display a pie chart of the Top User Agents (by pages)</para>
</listitem>
</varlistentry>
<varlistentry>
<term>GraphLegend</term>
<listitem>
<para>GraphLegend allows the color coded legends to be turned on or
off in the graphs. The default is for them to be displayed. This
only toggles the color coded legends, the other legends are not
changed. If you think they are hideous and ugly, say 'no' here
:)</para>
</listitem>
</varlistentry>
<varlistentry>
<term>GraphLines</term>
<listitem>
<para>GraphLines allows you to have index lines drawn behind the
graphs. Anything other than "no" will enable the lines.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Graph*X and Graph*Y</term>
<listitem>
<para>The following Graph*X and Graph*Y options are used to modify
the sizes of the created charts. The default settings are shown. The
defaults are also the minimum settings. #define GRAPH_INDEX_X 512 /*
px. Default X size (512) */ #define GRAPH_INDEX_Y 256 /* px. Default
Y size (256) */ #define GRAPH_DAILY_X 512 /* px. Daily X size (512)
*/ #define GRAPH_DAILY_Y 400 /* px. Daily Y size (400) */ #define
GRAPH_HOURLY_X 512 /* px. Daily X size (512) */ #define
GRAPH_HOURLY_Y 400 /* px. Daily Y size (400) */ #define GRAPH_PIE_X
512 /* px. Pie X size (512) */ #define GRAPH_PIE_Y 300 /* px. Pie Y
size (300) */</para>
</listitem>
</varlistentry>
<varlistentry>
<term>GraphIndexX</term>
<listitem>
<para>The main chart on the front page. Summary of all Months.
Default is 512 pixels.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>GraphIndexY</term>
<listitem>
<para>Default is 256 pixels.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>GraphDailyX</term>
<listitem>
<para>The Day by Day Summary graph at the start of each Months
Summary. Default is 512 pixels.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>GraphDailyY</term>
<listitem>
<para>Default is 400 pixels.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>GraphHourlyX</term>
<listitem>
<para>The Hourly Average graph within each Months Summary. Default
is 512 pixels.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>GraphHourlyY</term>
<listitem>
<para>Default is 400 pixels.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>GraphPieX</term>
<listitem>
<para>All pie charts are the same size. Default is 512
pixels.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>GraphPieY</term>
<listitem>
<para>Default is 300 pixels.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Graph and Table Colours</term>
<listitem>
<para>The custom bar graph and pie Colours can be overridden with
these options. Declare them in the standard hexadecimal way - as per
HTML but without the '#'. If none are given, you will get the
default <productname>AWFFull</productname> colors.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ColorHit</term>
<listitem>
<para>Default value is <quote>00805C</quote> (dark green)</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ColorFile</term>
<listitem>
<para>Default value is <quote>0000FF</quote> (blue)</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ColorSite</term>
<listitem>
<para>Default value is <quote>FF8000</quote> (orange)</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ColorKbyte</term>
<listitem>
<para>Default value is <quote>FF0000</quote> (red)</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ColorPage</term>
<listitem>
<para>Default value is <quote>00E0FF</quote> (cyan)</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ColorVisit</term>
<listitem>
<para>Default value is <quote>FFFF00</quote> (yellow)</para>
</listitem>
</varlistentry>
<varlistentry>
<term>PieColor1</term>
<listitem>
<para>Default value is <quote>00805C</quote> (dark green)</para>
</listitem>
</varlistentry>
<varlistentry>
<term>PieColor2</term>
<listitem>
<para>Default value is <quote>0000FF</quote> (blue)</para>
</listitem>
</varlistentry>
<varlistentry>
<term>PieColor3</term>
<listitem>
<para>Default value is <quote>FF8000</quote> (orange)</para>
</listitem>
</varlistentry>
<varlistentry>
<term>PieColor4</term>
<listitem>
<para>Default value is <quote>FF0000</quote> (red)</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="group_options">
<title>Group* Options</title>
<para>The Group* keywords permit the grouping of similar objects as if
they were one. Grouped records are displayed in the <quote>Top</quote>
tables and can optionally be displayed in bold and/or shaded. Groups
cannot be hidden, and are not counted in the main totals. The Group*
options do not hide the individual items that are members of the Group. If
you wish to hide the records that match - so just the grouping record is
displayed - follow with an identical Hide* keyword with the same value. Or
use the single GroupAndHide* keyword that matches, instead of the Group*
and Hide* combination.</para>
<para>Group* keywords may have an optional label which will be displayed
instead of the keywords value. The label should be separated from the
value by at least one white-space character, such as a space or
tab.</para>
<para>The Hide*, Group* and Ignore* and Include* keywords allow you to
change the way Sites, URL's, Referrers, User Agents and User names are
manipulated. The Ignore* keywords will cause AWFFull to completely ignore
records as if they didn't exist (and thus not counted in the main site
totals). The Hide* keywords will prevent things from being displayed in
the 'Top' tables, but will still be counted in the main totals. The Group*
keywords allow grouping similar objects as if they were one. Grouped
records are displayed in the 'Top' tables and can optionally be displayed
in BOLD and/or shaded. Groups cannot be hidden, and are not counted in the
main totals. The Group* options do not, by default, hide all the items
that it matches. If you want to hide the records that match (so just the
grouping record is displayed), follow with an identical Hide* keyword with
the same value. (see example below) In addition, Group* keywords may have
an optional label which will be displayed instead of the keywords value.
The label should be separated from the value by at least one 'white-space'
character, such as a space or tab.</para>
<para>The value can have either a leading or trailing '*' wildcard
character. If no wildcard is found, a match can occur anywhere in the
string. Given a string <quote>www.yourmama.com</quote>, the values
<quote>your</quote>, <quote>*mama.com</quote> and <quote>www.your*</quote>
will all match.</para>
<variablelist>
<varlistentry>
<term>GroupURL</term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry>
<term>GroupSite</term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry>
<term>GroupReferrer</term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry>
<term>GroupUser</term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry>
<term>GroupAgent</term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry>
<term>GroupDomains</term>
<listitem>
<para>The GroupDomains keyword allows you to group individual host
names into their respective domains. The value specifies the level
of grouping to perform, and can be thought of as 'the number of
dots' that will be displayed. For example, if a visiting host is
named cust1.tnt.mia.uu.net, a domain grouping of 1 will result in
just "uu.net" being displayed, while a 2 will result in
"mia.uu.net". The default value of zero disable this feature.
Domains will only be grouped if they do not match any existing
"GroupSite" records, which allows overriding this feature with your
own if desired.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="hide_options">
<title>Hide* Options</title>
<para>The Hide* keywords will prevent things from being displayed in the
'Top' tables. The hidden items will still be counted in the main
totals.</para>
<variablelist>
<varlistentry>
<term>HideURL</term>
<listitem>
<para>Hide URL matching <application>name</application>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>HideSite</term>
<listitem>
<para>Hide site matching <application>name</application>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>HideReferrer</term>
<listitem>
<para>Hide referrer matching <application>name</application>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>HideUser</term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry>
<term>HideAgent</term>
<listitem>
<para>Hide user agents matching
<application>name</application>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>HideAllSites</term>
<listitem>
<para>HideAllSites allows forcing individual sites to be hidden in
the report. This is particularly useful when used in conjunction
with the "GroupDomain" feature, but could be useful in other
situations as well, such as when you only want to display grouped
sites (with the GroupSite keywords...). The value for this keyword
can be either 'yes' or 'no', with 'no' the default, allowing
individual sites to be displayed.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="groupandhide_options">
<title>GroupAndHide* Options</title>
<para>All the Hide and Group "name" options can be combined in a single
config line. eg GroupAndHideURL. If you start using the Group* options you
will find that you tend to match every Group* option with a corresponding
Hide* option. The GroupAndHide* options simply short circuit this
unnecessary duplication.</para>
<variablelist>
<varlistentry>
<term>GroupAndHideURL</term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry>
<term>GroupAndHideSite</term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry>
<term>GroupAndHideReferrer</term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry>
<term>GroupAndHideUser</term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry>
<term>GroupAndHideAgent</term>
<listitem>
<para></para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="data_dump_options">
<title>Data Dump Options</title>
<para>The Dump* keywords allow the dumping of Sites, URL's, Referrers User
Agents, User names and Search strings to separate tab delimited text
files, suitable for import into most database or spreadsheet
programs.</para>
<variablelist>
<varlistentry>
<term>DumpPath</term>
<listitem>
<para>DumpPath specifies the path to dump the files. If not
specified, it will default to the current output directory. Do not
use a trailing slash ('/').</para>
</listitem>
</varlistentry>
<varlistentry>
<term>DumpHeader</term>
<listitem>
<para>The DumpHeader keyword specifies if a header record should be
written to the file. A header record is the first record of the
file, and contains the labels for each field written. Normally,
files that are intended to be imported into a database system will
not need a header record, while spreadsheets usually do. Value can
be either 'yes' or 'no', with 'no' being the default.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>DumpExtension</term>
<listitem>
<para>DumpExtension allow you to specify the dump filename extension
to use. The default is "tab", but some programs are picky about the
filenames they use, so you may change it here (for example, some
people may prefer to use "csv").</para>
</listitem>
</varlistentry>
<varlistentry>
<term>DumpURLs</term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry>
<term>DumpEntryPages</term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry>
<term>DumpExitPages</term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry>
<term>DumpSites</term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry>
<term>DumpReferrers</term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry>
<term>DumpSearchStr</term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry>
<term>DumpUsers</term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry>
<term>DumpAgents</term>
<listitem>
<para></para>
</listitem>
</varlistentry>
<varlistentry>
<term>DumpCountries</term>
<listitem>
<para></para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id="examples">
<title>Examples</title>
<bridgehead>Sample Extract of a configuration file:</bridgehead>
<para><programlisting># The 'auto' value means that AWFFull will try and work out what log format
# you are sending to it. If no joy, AWFFull will immediately exit.
LogType auto
# OutputDir is where you want to put the output files. This should
# should be a full path name, however relative ones might work as well.
# If no output directory is specified, the current directory will be used.
OutputDir .</programlisting></para>
<bridgehead>Minimal configuration file:</bridgehead>
<programlisting># Sample *MINIMAL* AWFFull configuration file
#
# The below settings are the only ones you *really* need to worry about
# when configuring AWFFull. See the sample.conf file for all options if
# the below only serves to whet your appetite.
#
# See awfful(1) or sample.conf for full explanations.
# We can do a little bit each day, or hour...
Incremental yes
# Your server name to display
HostName www.my_example.site
##---------------------------
# Use PageType OR NotPageType
# I personally prefer NotPageType - YMMV!
PageType htm
PageType html
PageType php
#PageType pl
#PageType cfm
#PageType pdf
#PageType txt
#PageType cgi
### OR! ---------------------
#NotPageType gif
#NotPageType css
#NotPageType js
#NotPageType jpg
#NotPageType ico
#NotPageType png
##---------------------------
# Should always fold in Sequence Errors. Logs can be messy...
FoldSeqErr yes
# If you want to see the country flags, uncomment the following.
# This is the, possibly relative, URL where the flag flies are located.
#FlagsLocation flags
</programlisting>
</refsect1>
<refsect1 id="see_also">
<title>See Also</title>
<para><productname>awffull</productname>(1)</para>
</refsect1>
<refsect1 id="bugs">
<title>Bugs</title>
<para>None currently known. YMMV....</para>
<para>Report bugs to <ulink
url="https://bugs.launchpad.net/awffull">https://bugs.launchpad.net/awffull</ulink>,
or use the email discussion list:
<email>awffull@stedee.id.au</email></para>
</refsect1>
<refsect1 id="notes">
<title>Notes</title>
<para>In case it is not obvious: AWFFull is a play/pun on the word
<quote>awful</quote>, and is pronounced the same way. Yes it was
deliberate.</para>
</refsect1>
<refsect1 id="references">
<title>References</title>
<para>[1] Web Site Measurement Hacks. Eric T. Peterson (and others).
O'Reilly. ISBN 0-596-00988-7.</para>
</refsect1>
</refentry>
|