"\n", " NAME\n", " xarchie - X11 browser interface to\n", " archie, version 2.0.9\n", "\n", " SYNOPSIS\n", " xarchie [X Toolkit options]\n", " [-host host]\n", " [-search type|-e|-c|-s|-r|-ec|-es|-er]\n", " [-sort type|-t|-w]\n", " [-maxhits num] [-offset num]\n", " [-nice lev|-N lev] [-noscroll]\n", " [-mono|-gray|-color]\n", " [-debug num|-D num] [-help|-?]\n", "\n", " DESCRIPTION\n", "\n", " Xarchie is an X11 browser interface to\n", " the Archie Internet information system\n", " using the Prospero virtual filesystem\n", " protocol. Archie provides information\n", " about files available for ftp anywhere\n", " on the Internet; Xarchie displays this\n", " information using an easy-to-use,\n", " point-and-click interface. Xarchie\n", " allows you to further explore ftp\n", " sites by examining directories\n", " returned as query matches, and allows\n", " you to retrieve files located this\n", " way. Xarchie is designed (like most X\n", " applications) to be highly customiz-\n", " able, allowing you to tailor the\n", " look-and-feel of the tool to your own\n", " preferences.\n", "\n", " This document is broken into two\n", " parts. First, the USER'S GUIDE\n", " describes Archie and Xarchie, and cov-\n", " ers both Basic and Advanced Xarchie\n", " usage. Second, the REFERENCE MANUAL\n", " provides all the information needed to\n", " customize Xarchie. You can also browse\n", " this document using the Xarchie Help\n", " facility.\n", "\n", " To report problems or bugs, please see\n", " the section \"Reporting Bugs\" in the\n", " REFERENCE MANUAL section.\n", "\n", " USER'S GUIDE\n", "\n", " The User's Guide section of this\n", " manual describes the Archie service,\n", " the Xarchie client, and how to use\n", " Xarchie to access resources available\n", " for FTP on the Internet.\n", "\n", " What is Archie?\n", "\n", " The Archie information system is a\n", " network-based information tool offer-\n", " ing proactive data retrieval and\n", " indexing for widely distributed\n", " collections of data.\n", "\n", " Perhaps the best known application of\n", " the Archie system is to maintain the\n", " Internet Archives database. This data-\n", " base, already available from a number\n", " of service providers across the Inter-\n", " net, currently contains the names of\n", " over 2,100,000 files at over 1,000\n", " anonymous FTP archive sites. Using\n", " this database, users can rapidly\n", " locate needed files without the need\n", " to log onto dozens or even hundreds of\n", " machines. Archie servers offering this\n", " database currently receive over 50,000\n", " queries per day. It is this database\n", " that the Xarchie client accesses, as\n", " described in the next section, using\n", " one of the many independently owned\n", " and operated Archie servers around the\n", " world.\n", "\n", " The Archie system is much more than\n", " the Internet Archives database. For\n", " more information contact Bunyip Infor-\n", " mation Systems at (514) 398-3709 or\n", " (514) 398-811 or email\n", " \"info@bunyip.com\".\n", "\n", " What is Xarchie?\n", "\n", " Xarchie is an X11 browser interface to\n", " the Archie Internet Archives database\n", " using the Prospero virtual filesystem\n", " protocol. Archie provides information\n", " about files available for ftp anywhere\n", " on the Internet; Xarchie displays this\n", " information using an easy-to-use,\n", " point-and-click interface. Xarchie\n", " allows you to further explore ftp\n", " sites by examining directories\n", " returned as query matches, and allows\n", " you to retrieve files located this\n", " way.\n", "\n", " Xarchie is designed (like most X\n", " applications) to be highly customiz-\n", " able, allowing you to tailor the\n", " look-and-feel of the tool to your own\n", " preferences. See the REFERENCE MANUAL\n", " for details.\n", "\n", " Users should be aware that the Xarchie\n", " client accesses a server that is\n", " shared with users on other hosts. As\n", " such, submitting long or large numbers\n", " of queries during peak periods not\n", " only increases the time that you have\n", " to wait for a response, but it\n", " increases the time that others have to\n", " wait too. Please read about the -nice\n", " option, the niceLevel resource, and\n", " the \"Nice Level\" setting before making\n", " large queries. Also, you should use\n", " the closest possible host to save\n", " long-distance network traffic. Abusers\n", " of the service may find their access\n", " revoked without notice.\n", "\n", " The Xarchie Display\n", "\n", " Xarchie uses several conventions\n", " regarding menus and button names:\n", "\n", " - Clicking on a button whose name\n", " ends with a \">\" will pop up a\n", " menu from which you should select\n", " the desired action.\n", "\n", " - Clicking on or selecting an item\n", " whose name ends in \"...\" will pop\n", " up a panel that will let you per-\n", " form the desired operation.\n", "\n", " A label with neither of these suffixes\n", " indicates that the action will be\n", " taken without subsequent interaction.\n", "\n", " Xarchie's display is divided into\n", " three horizontal areas. The top pane\n", " is a control panel providing the fol-\n", " lowing buttons:\n", "\n", " File:\n", " Clicking on this button presents\n", " the File Menu, from which you can\n", " select a variety of file-related\n", " operations to be described later.\n", " The File Menu operations can also\n", " be invoked by holding down the\n", " Meta key and typing the first\n", " letter of the operation's name\n", " (e.g., Meta-Q to quit).\n", "\n", " Settings:\n", " Clicking on this button presents\n", " the Settings Menu, whose opera-\n", " tions will be described in the\n", " \"Advanced Usage\" section.\n", "\n", " Query:\n", " This button presents the Query\n", " Menu, used to send queries to\n", " Archie. Its operation will be\n", " described shortly.\n", "\n", " Abort:\n", " When active during a query or\n", " retrieval, this button allows you\n", " to abort the operation.\n", "\n", " Help:\n", " Clicking on this button pops up\n", " the Help Panel, which allows you\n", " to browse this document on-line.\n", "\n", " Finally, the area labelled \"Status\" is\n", " used to provide information about the\n", " progress of a query or other informa-\n", " tive messages.\n", "\n", " The middle pane of the Xarchie display\n", " functions as a host-location-file\n", " browser. That is, the leftmost pane\n", " displays hostnames, the middle pane\n", " locations (directories), and the\n", " rightmost pane files or directories\n", " returned by a query. The browser's use\n", " is described in the section \"Brows-\n", " ing\", below. You can adjust the rela-\n", " tive size of the browser panes using\n", " the Grips on their borders.\n", "\n", " Finally, the bottom pane of the Xar-\n", " chie display provides a set of Text\n", " items where you can enter information\n", " and where information is displayed as\n", " query results are browsed. Not all\n", " Text items can be typed in; some are\n", " used for display only. These text\n", " items provide Emacs-like editing con-\n", " trols (see xedit(1) for a complete\n", " description). Typing Return in some\n", " Text items invokes an action as a\n", " shortcut for selecting it from a menu\n", " or button.\n", "\n", " Basic Xarchie Usage\n", "\n", " This section provides information on\n", " basic querying, browsing, and file\n", " operations. The \"Advanced Xarchie\n", " Usage\" section describes how to use\n", " the Settings Panel and how to perform\n", " other, more complicated, queries.\n", "\n", " Querying\n", "\n", " The primary function provided by Xar-\n", " chie is that of querying the Archie\n", " server for a \"search term\" (the string\n", " or expression for which you want to\n", " search). By default, your query uses\n", " exact search mode. That is, the search\n", " term must literally match an entry in\n", " the database for the entry to be\n", " returned. Other search modes are\n", " available, and are described in the\n", " \"Advanced Usage\" section.\n", "\n", " You enter your search term in the\n", " appropriately labelled Text item in\n", " the bottom pane of the Xarchie\n", " display. Hitting Return in the text\n", " item or selecting \"Query Item\" from\n", " the Query Menu will send your request\n", " to Archie.\n", "\n", " The Status area will be updated as the\n", " query progresses. First the Archie\n", " server's Internet address is looked\n", " up, then the server is contacted, the\n", " search term is sent over, and, after\n", " reaching the front of the server's\n", " request queue, matches are returned to\n", " Xarchie. The matches, if any, are\n", " displayed in the browser and the\n", " Status area indicates how many matches\n", " were returned.\n", "\n", " If your window manager and version of\n", " X support it, you can iconify the Xar-\n", " chie application and the icon will\n", " change to reflect the progress of your\n", " query. That is, it will change when a\n", " query is in progress and when it fin-\n", " ishes.\n", "\n", " Aborting\n", "\n", " If you find that your query is taking\n", " too long, you can abort it by clicking\n", " on the \"Abort\" button when it is\n", " active. Your query will be aborted as\n", " soon as possible. You should note that\n", " while aborting a query will allow you\n", " to enter a new query, it does not\n", " remove the query from the server's\n", " queue (this may be changed in the\n", " future). Thus aborting queries does\n", " not reduce the load on the server --\n", " just the opposite probably. Use it\n", " with discretion, like the rest of the\n", " service.\n", "\n", " Browsing\n", "\n", " As described in the section \"The Xar-\n", " chie Display\", the middle pane of the\n", " Xarchie display functions as a host-\n", " location-file browser. The leftmost\n", " pane of the browser contains the names\n", " of hosts that have a file matching\n", " your search term. Clicking the Left\n", " mouse button on a hostname will\n", " highlight it and cause the middle\n", " browser pane to be filled with a list\n", " of locations on that host where files\n", " matching your search term can be\n", " found. The selected hostname will also\n", " be displayed in the Text item labelled\n", " \"Host\" in the bottom pane of the Xar-\n", " chie display.\n", "\n", " Similarly, selecting a location from\n", " the middle browser pane will cause the\n", " right browser pane to be filled with a\n", " list of the files available from the\n", " selected host in the selected loca-\n", " tion, and the location will be\n", " displayed in the bottom pane item\n", " labelled \"Location\".\n", "\n", " Finally, selecting a file from the\n", " right browser pane causes its name,\n", " size, permission modes and last-\n", " modification date to be displayed in\n", " the correspondingly-labelled bottom\n", " pane items.\n", "\n", " Note that if a browser pane has only\n", " one item, then that item will be\n", " automatically selected and its\n", " \"lesser\" panes and information items\n", " filled in. This saves time and effort\n", " in the common case where there is only\n", " one host, location, or file that\n", " matches your query. Also, note that,\n", " by default, Xarchie scrolls the\n", " browser pane when you select an item.\n", " This makes it easy to click through a\n", " long list of matches, but can be\n", " annoying. If you don't like it, it can\n", " be changed on the Settings Panel\n", " (described below), and see the\n", " description of the -noscroll command-\n", " line option in the REFERENCE MANUAL.\n", "\n", " The browser allows you to select mul-\n", " tiple items simultaneously, although\n", " of course only the last-selected item\n", " will have it's information displayed\n", " in the bottom pane. You add to a\n", " selection by clicking the Left button\n", " with Shift depressed. If the clicked-\n", " on item is already selected, it will\n", " be unselected. Currently, only the\n", " bottom level of the browser can have\n", " multiple selections, since a selection\n", " at a higher level clears the selec-\n", " tions for all lower levels (this may\n", " be changed in the future). Thus you\n", " can select multiple files from a sin-\n", " gle host, but not multiple files from\n", " separate hosts.\n", "\n", " Expanding the Browser\n", "\n", " The browser can be expanded, allowing\n", " you to investigate, say, a directory\n", " that matched your query. To select and\n", " expand an directory, double-click on\n", " it (double-click with Shift to avoid\n", " unselecting any other items). You can\n", " also select \"Open\" from the File Menu\n", " to expand directories (although this\n", " will also open selected files, as\n", " described later). All selected direc-\n", " tories will be expanded by querying an\n", " appropriate Archie server, and the\n", " Status area will keep you informed.\n", " Expansion requests can be aborted just\n", " like queries using the \"Abort\" button.\n", "\n", " If only a single item was expanded,\n", " and if the expansion was successful,\n", " then the browser will scroll to\n", " display the results. The arrow buttons\n", " across the top of the browser can be\n", " used to scroll the browser left or\n", " right when they are active. The Middle\n", " and Right mouse buttons or the Left\n", " and Right arrow keys will do the same\n", " thing, when the pointer is in the\n", " browser panes.\n", "\n", " Viewing Files\n", "\n", " You can view a file that is selected\n", " in the browser by selecting \"Open\"\n", " from the File Menu (or by typing\n", " Meta-O). Xarchie retrieves all\n", " selected files in ASCII mode into a\n", " temporary directory. The Status area,\n", " like usual, will keep you posted on\n", " the progress of the operation and,\n", " once the FTP connection is esta-\n", " blished, the Abort button can be used\n", " to abort the Open operation. If you\n", " abort and there are files remaining to\n", " retrieve, you will be prompted as to\n", " whether to continue with the next\n", " file. Note that partially-retrieved\n", " files are not removed. There is\n", " currently no way to abort the transfer\n", " until the connection is established.\n", " The connection will eventually timeout\n", " and control will return to Xarchie if\n", " connection is impossible.\n", "\n", " Each file is displayed in a popup Text\n", " window after being retrieved. Use the\n", " \"Down\" and \"Up\" buttons or the\n", " scrollbars to view the text. Click on\n", " the \"Dismiss\" button to destroy the\n", " window and delete the file. To save\n", " the file before dismissing, use the\n", " \"Save\" button. This pops up a panel\n", " with which you can choose the name of\n", " the file to which to save.\n", "\n", " Note that because the Archie database\n", " is only updated periodically, some\n", " files returned by Archie may not exist\n", " when you attempt to retrieve them.\n", " This and any other FTP errors are sig-\n", " nalled with alert boxes.\n", "\n", " Retrieving Files\n", "\n", " The \"Open\" action should be used to\n", " view short files, such as \"README\"\n", " files, that you don't need to save.\n", " For more permanent files, and for\n", " non-ASCII files like tar or compressed\n", " files, Xarchie allows you to retrieve\n", " the selected browser items using the\n", " \"Get\" item of the File Menu (or typing\n", " Meta-G). The selected files are\n", " retrieved via FTP and stored in the\n", " current directory (see the section\n", " \"FTP Parameters\" in the \"Advanced\n", " Usage\" section for how to change\n", " this). The \"Status\" area is updated\n", " to reflect the progress of the\n", " transfer. As for \"Open\", you can abort\n", " the retrieval using the \"Abort\" button\n", " once the FTP connection is esta-\n", " blished.\n", "\n", " It is currently not possible to\n", " retrieve a directory, although of\n", " course the directory can be opened and\n", " the entire contents selected for\n", " transfer.\n", "\n", " Note that because the Archie database\n", " is only updated periodically, some\n", " files returned by Archie may not exist\n", " when you attempt to retrieve them.\n", " This and any other FTP errors are sig-\n", " nalled with alert boxes.\n", "\n", " As with querying, if your window\n", " manager and version of X support it,\n", " Xarchie's icon will be changed to\n", " reflect the progress of a transfer.\n", "\n", " Saving, Loading, and Writing\n", "\n", " Xarchie allows you to save and reload\n", " the contents of the browser, or write\n", " it in human-readable format using the\n", " items on the File menu. Selecting\n", " either of \"Save\", \"Load\", or \"Write\"\n", " (or typing Meta-S, Meta-L, or Meta-W,\n", " respectively) will pop up the File\n", " Panel with which you can specify the\n", " appropriate filename. Clicking on the\n", " \"Ok\" button will invoke the appropri-\n", " ate action; clicking \"Cancel\" will\n", " abort the operation and pop down the\n", " panel.\n", "\n", " Saving the database creates a file\n", " containing sufficient information for\n", " the browser to be reloaded using\n", " \"Load\". The output is not intended for\n", " human consumption. The current Set-\n", " tings are also written to the file by\n", " \"Save\" and are restored by \"Load\".\n", "\n", " Users should note that a reloaded\n", " database will be \"flattened\", that is,\n", " directories will be added to the mid-\n", " dle pane as needed to fit everything\n", " in three browser panes. (This may be\n", " changed in the future to preserve the\n", " original hierarchy.)\n", "\n", " Writing the database is intended to\n", " create files that are more or less\n", " human-readable (compared to \"Save\",\n", " anyway). There are two possible for-\n", " mats, selectable from the \"Write For-\n", " mat\" menu on the panel. If \"One entry\n", " per line\" is selected, then the output\n", " will have one line per entry, in the\n", " format\n", "\n", " mode size date host:location/file\n", "\n", " If \"Pretty-printed\" is selected, then\n", " the file format has hostnames starting\n", " at the beginning of the line, location\n", " names indented one tab, and file\n", " entries indented two tabs, all on\n", " separate lines. Hostnames and\n", " locations are only printed once, as\n", " in:\n", "\n", " host\n", " location\n", " mode size date file\n", "\n", " The latter is more readable, the\n", " former may be more useful if the out-\n", " put is to be used by a program.\n", "\n", " Quitting Xarchie\n", "\n", " You can exit Xarchie by selecting\n", " \"Quit\" from the File Menu (or typing\n", " Meta-Q).\n", "\n", " Advanced Xarchie Usage\n", "\n", " This section describes how various\n", " aspects of Xarchie's functionality can\n", " be modified to perform different\n", " queries and other operations. Further\n", " customization information is found in\n", " the REFERENCE MANUAL section.\n", "\n", " The Settings Panel\n", "\n", " The panel popped up by selecting\n", " \"Other\" on the Settings Menu in the\n", " top Xarchie pane allows you to change\n", " the parameters of your queries Archie.\n", " Each of the parameters is described in\n", " the following sections.\n", "\n", " After you're done with the Settings\n", " Panel, clicking on the \"Apply\" button\n", " will make Xarchie use the settings as\n", " set on the panel. Clicking on\n", " \"Default\" will reset the settings to\n", " the values they had when Xarchie\n", " started (but note that you will still\n", " have to apply them to have them take\n", " effect). Clicking on \"Done\" closes the\n", " Settings panel. A popup confirmer will\n", " appear if you did not apply your\n", " changes, allowing you to discard the\n", " changes or go back and apply them.\n", " Note that the \"Apply\" button is inac-\n", " tive until a change is made.\n", "\n", " The menus available from the\n", " \"Search Type\", \"Sort Type\", \"Nice\n", " Level\" and \"Archie Host\" submenus of\n", " the Settings Menu on the Xarchie top\n", " pane have effects corresponding to\n", " those of the buttons on the Settings\n", " Panel. However, they do not require\n", " that the \"Apply\" button be clicked on\n", " to take effect, and do not affect the\n", " behaviour of the \"Done\" button con-\n", " firmer.\n", "\n", " Archie host\n", "\n", " The item labelled \"Host\" provides a\n", " menu of known Archie hosts. You should\n", " choose one appropriate to your site\n", " (i.e., one that minimizes long-\n", " distance transmission). In addition\n", " however, you can enter an arbitrary\n", " hostname in the Text item next to the\n", " \"Host\" button. Note that the Archie\n", " host is only used for queries; expan-\n", " sion requests use information stored\n", " with the items to determine which host\n", " to contact. That is, changing the\n", " Archie host does not \"take effect\"\n", " until the next query is issued.\n", "\n", " If you have the ping(1) program, you\n", " can try to use it with the its \"-s\"\n", " option to locate a \"nearby\" host.\n", "\n", " You can specify hostnames using either\n", " the symbolic name or by giving its\n", " numeric IP address (four octets\n", " separated by periods). In either case,\n", " you can specify the port at which the\n", " Prospero server should be contacted by\n", " giving it in parentheses immediately\n", " following the hostname (no spaces).\n", "\n", " Search mode\n", "\n", " The \"Search Mode\" item allow you to\n", " change how Archie interprets your\n", " search term. Holding a mouse button\n", " down while the mouse cursor is on the\n", " button displays a menu from which you\n", " can choose the desired search type.\n", " The label to the right of the item is\n", " updated to reflect the choice.\n", "\n", " The exact mode is fastest and returns\n", " files exactly matching your search\n", " term. The substr and subcase modes\n", " return substring and case-sensitive\n", " substring matches respectively (i.e.,\n", " substr means case-insensitive). The\n", " regexp mode allows you to specify a\n", " regular expression to select files\n", " (see ed(1) for a description of regu-\n", " lar expression syntax). The exact*\n", " forms of these last three try an exact\n", " match first and then fall back on the\n", " more costly search type if the exact\n", " match fails.\n", "\n", " Sort mode\n", "\n", " The \"Sort Mode\" item allows you to\n", " specify how Xarchie displays the\n", " results from Archie. Holding a mouse\n", " button down while the mouse cursor is\n", " in this item displays a menu from\n", " which you can choose the desired sort\n", " type. The label to the right of the\n", " item is updated to reflect the choice.\n", " Applying the settings (see above) will\n", " cause the data to be resorted accord-\n", " ing to the new sort mode.\n", "\n", " The type can be one of name, date, or\n", " weight. Sorting by name is simple\n", " lexicographic ordering.\n", "\n", " If sorting by date is selected, then\n", " hosts are ordered according to the\n", " most recent file among those returned\n", " for them, and similarly for locations.\n", " Files themselves are ordered by last-\n", " modification date, naturally.\n", "\n", " If sorting by weight is selected, then\n", " hosts are ordered by a user-definable\n", " set of \"weights\". In this way, hosts\n", " that are \"close\" (in some sense) are\n", " displayed first. The weights can be\n", " set using the Text item that appears\n", " on the Settings Panel when this sort\n", " mode is selected.\n", "\n", " Hopefully, an appropriate weight list\n", " for the geographic location of your\n", " site will have been installed as the\n", " default. In any case, the the weight\n", " list is a set of lines, where each\n", " line specifies a weight and the set of\n", " domains for that weight. A host's\n", " weight is determined by finding the\n", " first line for which the end of the\n", " host's name matches one of the suf-\n", " fixes. A host that belongs in none of\n", " the classes is assigned the weight 99.\n", " For example, the default for the USA\n", " is:\n", "\n", " 1 edu com net gov mil us\n\\n", " 2 ca\n\\n", " 3 uk de nl fi fr eu.net\n\\n", " 100 au nz jp\n", "\n", " This means that all the US domains are\n", " ordered first, then Canada, then\n", " several European countries. Hosts in\n", " Australia, New Zealand, and Japan are\n", " ordered after any unknown (i.e. non-\n", " matching) hosts.\n", "\n", " For more details, see the description\n", " of the hostWeights non-widget resource\n", " in the REFERENCE MANUAL section.\n", "\n", " Nice level\n", "\n", " The \"Nice Level\" item deserves special\n", " mention. As mentioned in the \"About\n", " Archie\" section, Archie servers run on\n", " machines that must be shared between\n", " other Archie users and even other\n", " \"real\" users. This item allows you to\n", " voluntarily lower the priority of your\n", " request, just like the nice(1) command\n", " does for Unix. The menu provides some\n", " recommended values and you can enter\n", " arbitrary values in the text item. If\n", " you are searching with a large number\n", " of matches requested, please increase\n", " your nice level.\n", "\n", " Note that, like nice(1), nicing a job\n", " does not mean your job won't affect\n", " others. In particular, once your job\n", " begins it is not pre-empted, thus you\n", " should still avoid long jobs during\n", " peak periods. You should especially\n", " avoid queries for items of only per-\n", " sonal interest (you know what we mean)\n", " during these periods. As stated above,\n", " abusers of the service may find their\n", " access revoked without notice.\n", "\n", " Other Query Settings\n", "\n", " The following items set parameters of\n", " your query to the Archie server.\n", "\n", " Max Hits:\n", " the limit on the number of suc-\n", " cessful matches that will be\n", " returned.\n", "\n", " Initial Timeout:\n", " the length of the first timeout\n", " interval in seconds.\n", "\n", " Retries:\n", " the number of times to retry a\n", " query if it times out, doubling\n", " the timeout each retry.\n", "\n", " These items are Text items that allow\n", " you to edit their values.\n", "\n", " The item labelled \"Auto-Scroll\n", " Browser\" controls whether the browser\n", " scrolls after an item is selected.\n", " Setting this to \"yes\" is useful when\n", " browsing a long list of matches. It\n", " can be annoying if you're doing more\n", " selective browsing, so set it to \"no\"\n", " in those cases.\n", "\n", " FTP settings\n", "\n", " The following items allow you to set\n", " parameters of file retrieval. You\n", " should be sure they are appropriately\n", " set before retrieving files using\n", " either \"Open\" or \"Get\".\n", "\n", " FTP Email Address:\n", " Specifies the password used for\n", " anonymous FTP login. By\n", " convention, users logging in as\n", " \"anonymous\" send their email\n", " address as the password. Some\n", " servers enforce this by checking\n", " the address. The default may not\n", " be appropriate depending on what\n", " information Xarchie could glean\n", " from your system about its\n", " address. You can set the environ-\n", " ment variables USER and HOSTNAME\n", " to override the system's informa-\n", " tion, or see the description of\n", " the ftpMailAddress non-widget\n", " resource in the REFERENCE MANUAL.\n", "\n", " FTP Local Directory:\n", " Specifies the directory into\n", " which files will be retrieved\n", " using \"Get\".\n", "\n", " FTP Transfer Type:\n", " Provides a menu from which you\n", " can select \"ascii\" or \"binary\"\n", " mode transfer for files retrieved\n", " with \"Get\". Files retrieved with\n", " \"Open\" are always retrieved in\n", " ascii mode.\n", "\n", " FTP Prompt:\n", " Provides a menu allowing you to\n", " enable or disable prompting dur-\n", " ing multi-file transfers.\n", "\n", " Trace FTP Transfers:\n", " Since FTP transfers are suscepti-\n", " ble to timeouts and other confu-\n", " sions, this item allows you to\n", " monitor any FTP interactions. If\n", " tracing is enabled, then invoking\n", " \"Open\" or \"Get\" on a file will\n", " popup a trace window that\n", " displays a running log of the FTP\n", " session as it happens. Using\n", " this successfully requires that\n", " you understand something about\n", " how FTP works, which is beyond\n", " the scope of this document.\n", "\n", " Strip CR\n", " If this option is enabled, then\n", " carriage returns are removed from\n", " ASCII-mode files. This is usually\n", " desirable when transferring to a\n", " Unix machine.\n", "\n", " Querying Hosts and Locations\n", "\n", " The Query Menu provides two other\n", " types of queries besides the \"Query\n", " Item\" described in the \"Basic Usage\"\n", " section for querying the Archie data-\n", " base.\n", "\n", " Selecting \"Query Host\" will use the\n", " hostname in the \"Host\" Text item on\n", " the bottom pane and will fill the\n", " browser with the contents of the root\n", " of its FTP directory. From then on,\n", " interaction is as previously\n", " described. The host to query can be in\n", " the \"Host\" item as a result of select-\n", " ing a host in the browser, or you can\n", " type directly into the item the name\n", " of the host that you wish to open.\n", " Typing Return in the \"Host\" item is\n", " equivalent to selecting \"Query Host\"\n", " from the Query Menu.\n", "\n", " Querying locations by selecting \"Query\n", " Location\" is similar: the Archie\n", " server is queried for the contents of\n", " the directory given by the \"Location\"\n", " item on the host given by the \"Host\"\n", " item. The browser is filled in with\n", " the results of the query (i.e., the\n", " contents of the directory). As before,\n", " you can type the name of the location\n", " into the \"Location\" item if you wish,\n", " and typing Return there is the same as\n", " invoking \"Query Location\".\n", "\n", " Note that because the Archie database\n", " is only updated periodically, some\n", " files returned by Archie may not exist\n", " when you attempt to retrieve them.\n", " Similarly, recently added files may\n", " exist on the host but not in the\n", " Archie database.\n", "\n", " REFERENCE MANUAL\n", "\n", " This section provides all the informa-\n", " tion you should need to customize Xar-\n", " chie. Command-line options, non-widget\n", " resources, widget hierarchies, trans-\n", " lations actions, and other information\n", " are all provided. It is assumed that\n", " you understand enough about X applica-\n", " tions to understand this.\n", "\n", " Command-line Options\n", "\n", " The following non-widget resources can\n", " be set from the command-line or in a\n", " resource file. As usual, when given on\n", " the command line they can be abbrevi-\n", " ated to their shortest unique prefix,\n", " often the first letter. Furthermore\n", " Xarchie accepts all the standard X\n", " Toolkit options (see X(1)).\n", "\n", " -host host\n", " Sets the host to which Archie\n", " queries will be sent. Please be\n", " careful to use the nearest possi-\n", " ble host. You can specify host-\n", " names using either the symbolic\n", " name or by giving its numeric IP\n", " address (four octets separated by\n", " periods). In either case, you can\n", " specify the port at which the\n", " Prospero server should be\n", " contacted by giving it in\n", " parentheses immediately following\n", " the hostname (no spaces).\n", "\n", " The default is\n", " \"archie.sura.net(1526)\". This\n", " option corresponds to the\n", " archieHost resource.\n", "\n", " -search type\n", " Sets the search mode for Archie\n", " queries. The type can be one of\n", " exact, substr, subcase, regexp,\n", " exactSubstr, exactSubcase, or\n", " exactRegexp. See the section\n", " describing the Settings Panel in\n", " the USER'S GUIDE for a descrip-\n", " tion of the various search types.\n", " The default search mode is exact.\n", " This option corresponds to the\n", " searchType resource.\n", "\n", " -e Equivalent to \"-search exact\".\n", "\n", " -s Equivalent to \"-search substr\".\n", "\n", " -c Equivalent to \"-search subcase\".\n", "\n", " -r Equivalent to \"-search regexp\".\n", "\n", " -es Equivalent to \"-\n", " search exactSubstr\".\n", "\n", " -ec Equivalent to \"-\n", " search exactSsubcase\".\n", "\n", " -er Equivalent to \"-\n", " search exactRegexp\".\n", "\n", " -sort type\n", " Sets the sort mode for displaying\n", " Archie responses. The type can be\n", " one of name, date, or weight.\n", " See the section describing the\n", " Settings Panel in the USER'S\n", " GUIDE for a description of the\n", " various sort types. This option\n", " corresponds to the sortType\n", " resource.\n", "\n", " -t Equivalent to \"-sort date\".\n", "\n", " -w Equivalent to \"-sort weight\".\n", "\n", " -maxHits num\n", " Sets the maximum number of\n", " matches allowed per query. This\n", " option corresponds to the maxHits\n", " resource.\n", "\n", " -offset num\n", " Sets the offset of the Prospero\n", " query. This option corresponds to\n", " the offset resource.\n", "\n", " -nice level or -N level\n", " Sets the query niceness level.\n", " Higher numbers are nicer, up to a\n", " maximum niceness of 32765. The\n", " default niceness is 0. This\n", " option corresponds to the\n", " niceLevel resource.\n", " -noscroll\n", " By default, Xarchie scrolls the\n", " browser lists automatically when\n", " you select items. This usually\n", " makes it easier to scan through\n", " the results of queries but can be\n", " annoying. This option turns off\n", " the automatic scrolling. It\n", " corresponds to the autoScroll\n", " resource.\n", "\n", " -mono or -gray or -color\n", " By default, Xarchie will deter-\n", " mine the visual type of your\n", " display and use the proper color\n", " resources. If it gets it wrong,\n", " you can override the default by\n", " specifying one of these options.\n", " They correspond to the visualType\n", " resource.\n", "\n", " -debug level or -D level\n", " Sets the Prospero debugging\n", " level. Higher numbers mean more\n", " verbose messages. This option\n", " corresponds to the debugLevel\n", " resource. Xarchie must be spe-\n", " cially compiled for this option\n", " to have any effect (see the\n", " Imakefile or your local\n", " installer).\n", "\n", " -help or -?\n", " Prints the usage message summar-\n", " izing Xarchie options.\n", "\n", " Non-widget Resources\n", "\n", " Xarchie has a default set of resources\n", " built in. If you wish to customize the\n", " tool, take a copy of the default\n", " application defaults file (see the\n", " section \"Files\", below) and modify it.\n", " Then, before invoking Xarchie, set the\n", " environment variable XAPPLRESDIR to\n", " the directory containing your private\n", " copy. Alternatively, you can place\n", " entries in your .Xdefaults file or\n", " provide them with the -xrm toolkit\n", " option (see X(1)). Most of the fol-\n", " lowing resources can also be set using\n", " the command-line options described in\n", " the previous section.\n", "\n", " Query Resources\n", "\n", " archieHost\n", " Sets the host to which Archie\n", " queries will be sent. Please be\n", " careful to use the nearest\n", " possible host. The default is\n", " \"archie.sura.net\". This resource\n", " can be set with the -host option\n", " or on the Settings Panel.\n", "\n", " You can specify hostnames using\n", " either the symbolic name or by\n", " giving its numeric IP address\n", " (four octets separated by\n", " periods). In either case, you can\n", " specify the port at which the\n", " Prospero server should be con-\n", " tacted by giving it in\n", " parentheses immediately following\n", " the hostname (no spaces).\n", "\n", " searchType\n", " Sets the search mode for Archie\n", " queries. This can be one of\n", " exact, substr, subcase, regexp,\n", " exactSubstr, exactSubcase, or\n", " exactRegexp. See the section\n", " describing the Settings Panel in\n", " the USER'S GUIDE for a descrip-\n", " tion of the various search types.\n", " The default search mode is exact.\n", " This resource can be set with the\n", " -search option, or its abbrevia-\n", " tions -e, -s, -c, -r, -es, -ec,\n", " or -er, or on the Settings Panel.\n", "\n", " sortType\n", " Sets the sort mode for displaying\n", " Archie responses. This can be one\n", " of name, date, or weight. See\n", " the section of the Settings\n", " Panel, above, for a description\n", " of the various search types.\n", " This resource can be set with the\n", " -sort option, or its abbrevia-\n", " tions -t or -w, or on the Set-\n", " tings Panel.\n", "\n", " hostWeights\n", " Specifies the weights used to\n", " order hosts when sorting by\n", " weight is selected. The format of\n", " this resource is a series of\n", " entries of the form:\n", "\n", " weight host [hosts...] {,|\n}\n", "\n", " where parts of an entry are\n", " separated by spaces or tabs and\n", " entries are separated by a comma\n", " or newline. Each entry specifies\n", " a weight and a series of possible\n", " suffixes (one or more trailing\n", " components). A host's weight is\n", " determined by finding the first\n", " class for which the end of the\n", " host's name matches one of the\n", " suffixes. A host that belongs in\n", " none of the classes is assigned\n", " the weight 99. For example, the\n", " default for the USA is:\n", " 1 edu com net gov mil us\n\\n", " 2 ca\n\\n", " 3 uk de nl fi fr eu.net\n\\n", " 100 au nz jp\n", "\n", " This means that all the US\n", " domains are ordered first, then\n", " Canada, then several European\n", " countries. Hosts in Australia,\n", " New Zealand, and Japan are\n", " ordered after any unknown (i.e.\n", " non-matching) hosts. This\n", " resource can be set on the Set-\n", " tings Panel.\n", "\n", " If this resource is not defined,\n", " Xarchie will attempt to make an\n", " intelligent choice by comparing\n", " the system's idea of its hostname\n", " with a set of pre-compiled\n", " defaults. This may not work, but\n", " is usually better than nothing,\n", " and it can always be edited on\n", " the Settings Panel anyway.\n", "\n", " niceLevel\n", " Sets the query niceness level.\n", " Higher numbers are nicer, up to a\n", " maximum niceness of 32765. The\n", " default is 0. This resource can\n", " be set with the -nice option or\n", " on the Settings Panel.\n", "\n", " maxHits\n", " Sets the maximum number of\n", " matches allowed per query. The\n", " default is 99. This resource can\n", " be set with the -maxHits option\n", " or on the Settings Panel.\n", "\n", " offset\n", " Sets the Prospero offset. The\n", " default is 0. This resource can\n", " be set with the -offset option or\n", " on the Settings Panel.\n", "\n", " timeout\n", " Sets the initial timeout value,\n", " in seconds. The default is 4.\n", " This resource can be set on the\n", " Settings Panel.\n", "\n", " retries\n", " Sets the number of retries, where\n", " the timeout doubles every retry.\n", " This resource can be set on the\n", " Settings Panel.\n", "\n", " debugLevel\n", " Sets the Prospero debugging\n", " level. Higher numbers mean more\n", " verbose messages. Xarchie must\n", " have been compiled specially for\n", " this option to have any effect\n", " (see the Imakefile or your local\n", " installer). This resource can be\n", " set with the -debug or -D\n", " options.\n", "\n", " Browser Resources\n", "\n", " autoScroll\n", " By default, Xarchie scrolls the\n", " browser lists automatically when\n", " you select items. This usually\n", " makes it easier to scan through\n", " the results of queries but can be\n", " annoying. This resource enables\n", " or disables automatic scrolling.\n", " The default is True. It can be\n", " set to False with the -noscroll\n", " option and can be changed on the\n", " Settings Panel.\n", "\n", " pasteBuffer\n", " If this resource is True (the\n", " default), browser selections are\n", " stored in the CUT_BUFFER_0 pro-\n", " perty of the root window of the\n", " Xarchie display in the format:\n", "\n", " host:location/file\n", "\n", " This allows them to be used by\n", " other applications using\n", " XFetchBytes(3X). The Xarchie\n", " distribution includes a sample\n", " program (xcutbuf.c) that\n", " retrieves the contents of a cut-\n", " buffer property.\n", "\n", " FTP Resources\n", "\n", " ftpMailAddress\n", " By convention, FTP users are\n", " expected to send their email\n", " address as the password during\n", " anonymous login. The string\n", " specified by this resource is\n", " passed to sprintf(3) along with\n", " two parameters: the username and\n", " the hostname (as indicated by the\n", " system or by the USER and HOST-\n", " NAME environment variables), and\n", " the result is used as the pass-\n", " word for anonymous FTP logins.\n", " The default is \"%s@%s\". You\n", " should change this resource if\n", " your system returns strange or\n", " incorrect values for either\n", " parameter. The password (after\n", " sprintf) can be edited on the\n", " Settings Panel.\n", "\n", " ftpLocalDir\n", " Sets the local destination direc-\n", " tory for ftp transfers. This will\n", " be used as the initial value of\n", " the \"FTP Local Dir\" item on the\n", " Settings Panel.\n", "\n", " ftpType\n", " Sets the transfer type for ftp\n", " transfers. This will be used as\n", " the initial value of the \"Ftp\n", " transfer type\" item on the Set-\n", " tings Panel. It should be one of\n", " \"ascii\" or \"binary\".\n", "\n", " ftpPrompt\n", " Specifies whether to prompt for\n", " verification during transfers\n", " involving multiple files. This\n", " will be used as the initial value\n", " of the \"Prompt during transfers\"\n", " item on the Settings Panel.\n", "\n", " ftpTrace\n", " Specifies whether to pop up a\n", " window in which FTP transactions\n", " are monitored. This will be used\n", " as the initial value of the\n", " \"Trace FTP transfers\" item on the\n", " Settings Panel.\n", "\n", " ftpStrip\n", " Specifies whether to strip car-\n", " riage returns from files\n", " transferred in ASCII mode. This\n", " will be used as the initial value\n", " of the \"Strip CR\" item on the\n", " Settings Panel.\n", "\n", " Database Writing Resources\n", "\n", " fileWriteOnePerLine\n", " Specifies the format of files\n", " written by \"Write\". This will be\n", " used as the initial value of the\n", " \"Write format\" item on the File\n", " Panel. The meaning of this set-\n", " ting is described in the USER'S\n", " GUIDE section on \"Saving, Load-\n", " ing, and Writing\".\n", "\n", " Special Font Resources\n", " Xarchie uses two fonts by default: one\n", " \"normal\" and one \"bold\". However,\n", " because of widget naming and resource\n", " lookup conventions, these fonts must\n", " be specified in many places in the\n", " resource file. To make it easier to\n", " find and change these fonts, the fol-\n", " lowing two resources are defined:\n", "\n", " xarchieFont\n", " The name of the default font used\n", " by Xarchie widgets. If any widget\n", " specifies a font resource as\n", " \"xarchieFont\", this font will be\n", " used.\n", "\n", " xarchieBoldFont\n", " Like the above, but specifies the\n", " font used by any widget that\n", " specifies a font resource of\n", " \"xarchieBoldFont\".\n", "\n", " The resource converter that looks up\n", " fontnames is modified so that the the\n", " two special strings \"xarchieFont\" and\n", " \"xarchieBoldFont\" result in the\n", " corresponding font being returned;\n", " other strings are looked up as normal\n", " fontnames.\n", "\n", " Other Resources\n", "\n", " visualType\n", " This resource allows you to over-\n", " ride Xarchie's builtin determina-\n", " tion of the type of display,\n", " which it uses to specify\n", " appropriate color resources. You\n", " can specify \"mon\", \"gray\", or\n", " \"color\" as the value of this\n", " resource. It can also be set with\n", " the corresponding command-line\n", " options.\n", "\n", " defaultIcon\n", " If given, this resource specifies\n", " the name of an X bitmap file that\n", " will be used as Xarchie's icon\n", " when not querying (assuming you\n", " are using a window manager that\n", " supports icon pixmaps). The X\n", " resource conversion routines will\n", " look for the file in a variety of\n", " places, including directories\n", " given by the global resource bit-\n", " mapFilePath.\n", "\n", " busyIcon\n", " If given, this resource specifies\n", " the name of an X bitmap file that\n", " will be used as Xarchie's icon\n", " when querying (see the descrip-\n", " tion of the defaultIcon resource,\n", " above). The icon is changed back\n", " to the default when the query\n", " completes, so you can watch for a\n", " change while Xarchie is iconi-\n", " fied.\n", "\n", " Widget Hierarchies\n", "\n", " Xarchie uses primarily Athena widgets,\n", " with some extra sub-classes as\n", " described below.\n", "\n", " Main Xarchie Widgets\n", " The widget hierarchy for the main Xar-\n", " chie display is as follows:\n", "\n", " Xarchie xarchie\n", " [Form color|gray] <-- Color or gray-scale displays only\n", " Paned outerPaned\n", " Form buttonForm\n", " MenuButton fileButton\n", " MenuButton settingsButton\n", " MenuButton queryButton\n", " Command abortButton\n", " Command helpButton\n", " Label,Text status{Label,Text}\n", " Form browserForm\n", " Command browserUpButton\n", " Command browserDownButton\n", " Paned browserPaned\n", " Viewport browserViewport0\n", " XfwfMultiList browserList0\n", " Viewport browserViewport1\n", " XfwfMultiList browserList1\n", " Viewport browserViewport2\n", " XfwfMultiList browserList2\n", " Form stringForm\n", " Label,Text search{Label,Text}\n", " Label,Text host{Label,Text}\n", " Label,Text location{Label,Text}\n", " Label,Text file{Label,Text}\n", " Label,Text size{Label,Text}\n", " Label,Text modes{Label,Text}\n", " Label,Text date{Label,Text}\n", "\n", " On color displays, there is an extra\n", " Form widget named \"color\" created as\n", " the only child of the toplevel shell,\n", " and all other widgets are children of\n", " it. This allows resources that are\n", " only applicable for color displays to\n", " use the prefix \"Xarchie.color\" while\n", " generally applicable resources should\n", " use the \"Xarchie*\" prefix. On gray-\n", " scale displays, the extra widget is\n", " named \"gray\". On monochrome displays,\n", " no extra widget is created.\n", "\n", " The XfwfMultiList widget is a modifi-\n", " cation of the standard Athena List\n", " widget that allows multiple items to\n", " be selected. It was written by Brian\n", " Totty (totty@flute.cs.uiuc.edu) and is\n", " distributed by the Free Widget Founda-\n", " tion (contact free-widgets-\n", " request@kazoo.cs.uiuc.edu). Xarchie\n", " can be compiled to use standard Athena\n", " List widgets instead. See the\n", " Imakefile or your local installer.\n", "\n", " To describe this widget hierarchy\n", " briefly, outerPaned controls the rela-\n", " tive sizes of the three horizontal\n", " display areas while browserPaned\n", " allows the browser panels to be\n", " resized independently. Each browser\n", " panel consists of a Viewport to allow\n", " it to scroll and an XfwfMultiList (or\n", " List) to display the entries.\n", "\n", " The command buttons and status widgets\n", " are pretty straightforward. The\n", " fileButton pops up the fileMenu, whose\n", " items invoke the obvious actions (see\n", " below) when selected. The settingsBut-\n", " ton pops up the settingsMenu, which\n", " uses some special translations and the\n", " settings-submenu() action to permit\n", " the use of pullright submenus. The\n", " queryButton pops up the queryMenu, the\n", " abortButton (when active) invokes the\n", " abort() action, and the helpButton\n", " invokes the help() action to pop up\n", " the Help panel.\n", " In the bottom pane, the searchText\n", " widget is used to enter the search\n", " term, and by default it binds Return\n", " to the query() action (see below) to\n", " send the query to Archie. The host-\n", " Text binds Return to query-host() and\n", " the locationText binds Return to\n", " query-location(). All the other Text\n", " items in the stringForm cannot be\n", " edited and are used to display infor-\n", " mation about the current browser\n", " selection.\n", "\n", " Settings Panel Widgets\n", "\n", " The \"Panel\" item on the Settings menu\n", " pops up the Settings Panel, which has\n", " the following widget hierarchy:\n", "\n", " TopLevelShell settingsShell\n", " Form settingsForm\n", " Command setDoneButton\n", " Command setApplyButton\n", " Command setDefaultButton\n", " MenuButton,AsciiText setHost{Button,Text}\n", " MenuButton,Label setSearch{Button,Label}\n", " MenuButton,Label setSort{Button,Label}\n", " Label,AsciiText setHostWeights{Label,Text}\n", " MenuButton,AsciiText setNice{Button,Text}\n", " Label,AsciiText setMaxHits{Label,Text}\n", " Label,AsciiText setTimeout{Label,Text}\n", " Label,AsciiText setRetries{Label,Text}\n", " Label,AsciiText setAutoScroll{Button,Label}\n", " Label,AsciiText ftpMailAddress{Label,Text}\n", " Label,AsciiText ftpLocalDir{Label,Text}\n", " MenuButton,Label ftpType{Button,Label}\n", " MenuButton,Label ftpPrompt{Button,Label}\n", " MenuButton,Label ftpTrace{Button,Label}\n", " MenuButton,Label ftpStrip{Button,Label}\n", "\n", " The setDoneButton invokes the\n", " settings-done() action, the setAp-\n", " plyButton invokes settings-apply(),\n", " and the setDefaultButton invokes\n", " settings-default(). The actions are\n", " described below. The MenuButton widg-\n", " ets pop up menus described below under\n", " \"Menus\". The AsciiText widgets are\n", " used to display and edit the\n", " corresponding parameters.\n", "\n", " File Panel Widgets\n", "\n", " The \"Save\", \"Load\", and \"Write\" items\n", " on the File menu pop up the File\n", " panel, which has the following widget\n", " hierarchy:\n", "\n", " TopLevelShell fileShell\n", " Form fileForm\n", " Label fileLabel\n", " XfwfFileChooser fileChooser\n", " Label,AsciiText filename{Label,Text}\n", " MenuButton,Label fileWriteMode{Button,Label}\n", " Command fileOkButton, fileCancelButton\n", "\n", " The XfwfFileChooser widget provides a\n", " browser for selecting files. Xarchie\n", " can be compiled without the\n", " FileChooser, if necessary. See the\n", " Imakefile or your local installer.\n", "\n", " In any event, the fileLabel indicates\n", " what operation is being performed, the\n", " fileChooser, fileText, and buttons are\n", " used to select a file, and the\n", " fileWriteModeButton pops up the\n", " fileWriteModeMenu (only enabled for\n", " Write). Typing Return in the\n", " filenameText is the same as clicking\n", " the fileOkButton, and sending the\n", " WM_DELETE_WINDOW message (typically\n", " from the window manager) is the same\n", " as clicking on the fileCancelButton.\n", "\n", " View Window Widgets\n", " Whenever a file is retrieved by\n", " \"Open\", it is displayed in a window\n", " with the following widget hierarchy:\n", "\n", " TopLevelShell viewShell\n", " Form viewForm\n", " Command viewDoneButton\n", " Command viewDownButton\n", " Command viewUpButton\n", " Command viewSaveButton\n", " Text viewText\n", "\n", " The title of the TopLevel shell is set\n", " to the basename of the file being\n", " viewed in the viewText. The operation\n", " of the buttons is all hard-coded.\n", " Clicking on the viewSaveButton results\n", " in the following panel being displayed\n", " to select the file to save to:\n", "\n", " TopLevelShell viewSaveShell\n", " Form viewSaveForm\n", " Label viewSaveLabel\n", " AsciiText viewSaveLabelText\n", " XfwfFileChooser fileChooser\n", " Label viewSaveTextLabel\n", " AsciiText viewSaveText\n", " Command viewSaveOkButton, viewSaveCancelButton\n", "\n", " The viewSaveLabelText indicates the\n", " name of the temporary file from which\n", " the save should be made and connot be\n", " changed. The fileChooser and fileText\n", " allow you to select the file to save\n", " to.\n", "\n", " Help Panel Widgets\n", " The \"Help\" button in Xarchie's top\n", " pane pops up the Help panel, which has\n", " the following widget hierarchy:\n", "\n", " TopLevelShell helpShell\n", " Form helpForm\n", " Label helpLabel\n", " Viewport helpViewport\n", " List helpList\n", " Text helpText\n", " Command helpDoneButton\n", " Command helpPrevButton\n", " Command helpNextButton\n", " Command helpDownButton\n", " Command helpUpButton\n", "\n", " The helpLabel identifies the version\n", " of Xarchie. The helpList displays the\n", " help topics, and the corresponding\n", " text is displayed in the helpText.\n", " The helpDoneButton invokes the\n", " help-done() action, the helpPrevButton\n", " invokes the help-prev() action, and\n", " the helpNextButton invokes the\n", " help-next() action. The helpDownButton\n", " and helpUpButton invoke the\n", " help-down() and help-up() actions\n", " respectively.\n", "\n", " About Panel Widgets\n", "\n", " Selecting the \"About\" item on the File\n", " menu pops up the About panel, which\n", " has the following widget hierarchy:\n", "\n", " TopLevelShell aboutShell\n", " Form aboutForm\n", " Label aboutLabel{0,1,2,3,4,5}\n", " Command aboutDoneButton\n", "\n", " The labels are set to display the ver-\n", " sion of Xarchie and other contact\n", " information. There is little you can\n", " or should do with these widgets.\n", "\n", " Popup Widgets\n", "\n", " Finally, two types of popup windows\n", " can appear. An Alert box signals an\n", " error and blocks until clicked in; a\n", " Confirm box allows the user to make a\n", " Yes/No decision. These have the fol-\n", " lowing widget hierarchies:\n", "\n", " TransientShell alertShell\n", " Dialog alertDialog\n", " Command okButton\n", "\n", " TransientShell confirmShell\n", " Dialog confirmDialog\n", " Command yesButton,noButton\n", "\n", " respectively. Several actions are\n", " defined (see below) for use in these\n", " popups.\n", "\n", " Menus\n", " The MenuButton widgets on both the\n", " main Xarchie display and on the vari-\n", " ous panels use standard Athena Sim-\n", " pleMenu widgets. The following naming\n", " conventions are used to allow\n", " resources to be specified: if the\n", " parent SimpleMenu widget is named\n", " \"fooMenu\", then the SmeBSBObjects mak-\n", " ing up the entries are named\n", " \"fooMenuItemn\", where n starts at 0\n", " for the first item in the menu. The\n", " menus are all children of the main\n", " Xarchie shell, toplevel. For example,\n", " the File menu has widget hierarchy\n", "\n", " SimpleMenu fileMenu\n", " SmeBSB menuLabel\n", " SmeBSB fileMenuItem{0,1,2,3,4,5,6}\n", "\n", " There are three things worth mention-\n", " ing. First, as noted above, the set-\n", " tingsMenu uses special translations\n", " and the settings-submenu() action to\n", " allow pullright submenus. Secondly,\n", " the submenus available from the Set-\n", " tings menu (searchMenu, sortMenu,\n", " niceMenu, and hostMenu) and those\n", " available on the Settings Panel (set-\n", " SearchMenu, setSortMenu, setNiceMenu,\n", " and setHostMenu) have the same labels\n", " but are different widgets with dif-\n", " ferent effects. The Settings Panel\n", " menus (the second group) only update\n", " the Settings panel, requiring the Done\n", " button to be clicked to take effect.\n", " The Settings menu submenus (the first\n", " group) take effect immediately, and\n", " also indicate the current item in the\n", " left margin of the menu.\n", "\n", " Finally, the number, order, and effect\n", " of all menus are hardcoded, although\n", " the labels can, of course, be changed\n", " in the resource file. However, chang-\n", " ing the labels will NOT change the\n", " effect of selecting the item, with the\n", " exception of the hostMenu and setHost-\n", " Menu. These menus use the numHosts\n", " non-widget resource to indicate how\n", " many items are on the menu. Thus you\n", " can add hosts to the menu by adding\n", " label resources for the new\n", " hostMenuItem's and increasing the\n", " value of Xarchie.numHosts. Xarchie\n", " parses the labels to determine the\n", " hostname: anything up to whitespace\n", " constitutes the hostname (and optional\n", " port number), anything after is simply\n", " commentary.\n", "\n", " Translation Actions\n", "\n", " The following action procedures are\n", " registered for Xarchie and can be\n", " bound to widget events using the\n", " translations resource (see the Xt\n", " manual, Appendix C). The actions of\n", " the browser widgets are hard-coded\n", " since they are so essential to correct\n", " behaviour. They can however be bound\n", " to different events using the notify()\n", " action (that is, you could notify on\n", " some other event than mouse clicks, if\n", " you know what you're doing).\n", "\n", " Main panel actions\n", "\n", " quit()\n", " Exit Xarchie. By default this is\n", " invoked by selecting \"Quit\" from\n", " the File menu or by typing\n", " \"Meta-Q\" in any non-Text widget.\n", "\n", " query()\n", " Send the current contents of the\n", " \"Search Term\" text widget (sear-\n", " chText) to Archie. By default\n", " this is performed by hitting\n", " Return in searchText or by\n", " selecting \"Query Item\" from the\n", " Query menu.\n", "\n", " query-host()\n", " Fills the browser with the con-\n", " tents of the root directory of\n", " the host given by the contents of\n", " the \"Host\" text widget (host-\n", " Text). By default this is per-\n", " formed by hitting Return in host-\n", " Text or by by selecting \"Query\n", " Host\" from the Query menu.\n", "\n", " query-location()\n", " Fills the browser with the con-\n", " tents of the directory given by\n", " the \"Location\" text widget (loca-\n", " tionText) and the host given by\n", " the contents of the \"Host\" text\n", " widget (hostText). By default\n", " this is performed by hitting\n", " Return in locationText or by\n", " selecting \"Query Location\" from\n", " the Query menu.\n", "\n", " abort()\n", " Aborts the current query at the\n", " soonest possible time. Has no\n", " effect is a query is not\n", " currently being processed. By\n", " default, this invoked by clicking\n", " on the Abort button when it is\n", " active.\n", "\n", " query-or-abort()\n", " Invokes either query() or\n", " abort(), depending on whether a\n", " query is in progress.\n", "\n", " about()\n", " Pops up the About panel.\n", "\n", " ftp-get()\n", " Begin retrieval of the\n", " currently-selected files. By\n", " default this is invoked by\n", " selecting \"Get\" from the \"File\"\n", " menu, or by typing \"Meta-G\" in\n", " any non-Text widget.\n", "\n", " Browser actions\n", "\n", " Items are selected in the browser\n", " using the Left mouse button, as usual.\n", " Clicking with Shift does not clear\n", " other selections, allowing multiple\n", " selections. This is implemented using\n", " the XfwfMultiList translation actions\n", " Notify(), Set(), Toggle(), and Open-\n", " Many(), unless your version of Xarchie\n", " was compiled to not use the XfwfMul-\n", " tiList widget (see the Imakefile or\n", " your local installer). Modify at your\n", " own risk!\n", "\n", " The following actions are used for\n", " other browser operations.\n", "\n", " browser-up()\n", " Shifts the browser left (i.e., up\n", " the file hierarchy) if possible.\n", " By default this is invoked by\n", " clicking on the \"<<<\" button\n", " (browserUpButton), or by clicking\n", " the Middle mouse button in the\n", " browser, or by hitting the \"Left\"\n", " key (often the left arrow on the\n", " cursor keypad).\n", "\n", " browser-down()\n", " Shifts the browser right (ie.,\n", " down the file hierarchy) if pos-\n", " sible. By default this is\n", " invoked by clicking on the \">>>\"\n", " button (browserDownButton), or by\n", " clicking the Right mouse button\n", " in the browser, or by hitting the\n", " \"Right\" key (often the right\n", " arrow on the cursor keypad).\n", "\n", " browser-top()\n", " Shifts the browser to its left-\n", " most position (i.e., the top of\n", " the file hierarchy). By default\n", " this is invoked by clicking with\n", " Shift on the \"<<<\" button\n", " (browserUpButton) or by hitting\n", " the \"Home\" key.\n", "\n", " browser-open-directories()\n", " Expands selected directories. If\n", " the browser was expanded uniquely\n", " and successfully, it will be\n", " shifted right to display the new\n", " information. By default, this is\n", " invoked by double-clicking in the\n", " browser.\n", "\n", " browser-open-files()\n", " Retrieves selected files by FTP\n", " into a temporary file and\n", " displays them using View windows.\n", "\n", " browser-open-all()\n", " Opens the selected items by\n", " expanding selected directories\n", " and retrieving selected files for\n", " viewing. By default, this is\n", " invoked by selecting \"Open\" from\n", " the File menu, or by typing\n", " \"Meta-O\" in any non-text widget.\n", "\n", " Settings actions\n", " The following actions control the Set-\n", " tings Panel and can be used to change\n", " some settings without using the panel.\n", "\n", " popup-settings()\n", " Pops up the Settings Panel, and\n", " resets its values to those\n", " currently in effect. Raises the\n", " Settings Panel if it is already\n", " popped up. By default this is\n", " performed by selecting \"Other\" on\n", " the Settings menu.\n", "\n", " settings-apply()\n", " Sets the current settings from\n", " the values on the Settings Panel.\n", " By default this is performed by\n", " clicking the \"Apply\" button on\n", " the Settings Panel.\n", "\n", " settings-default()\n", " Resets the values on the Settings\n", " Panel to the default settings,\n", " but does not affect the current\n", " settings until the\n", " settings-apply() action is\n", " invoked. By default, this is\n", " invoked by clicking on the\n", " \"Default\" button on the Settings\n", " Panel.\n", "\n", " settings-done()\n", " Pops down the Settings Panel. If\n", " there are changes that have not\n", " be applied, then a popup confirm\n", " box allows the user to discard\n", " the settings or go back and apply\n", " them. By default, this is\n", " invoked by clicking on the \"Done\"\n", " button on the Settings Panel.\n", "\n", " set-host(hostname)\n", " This action sets the Archie host\n", " as indicated on the Settings\n", " Panel, but does not affect the\n", " current settings until the\n", " settings-apply() action is\n", " invoked.\n", "\n", " set-host-now(hostname)\n", " Sets the Archie host immediately\n", " without waiting for\n", " settings-apply().\n", "\n", " set-search-type(type)\n", " This action sets the searchType\n", " as indicated on the Settings\n", " Panel, but does not affect the\n", " current settings until the\n", " settings-apply() action is\n", " invoked.\n", "\n", " set-search-type-now(type)\n", " Sets the searchType immediately\n", " without waiting for\n", " settings-apply().\n", "\n", " set-sort-type(type)\n", " This action sets the sortType as\n", " indicated on the Settings Panel,\n", " but does not affect the current\n", " settings until the\n", " settings-apply() action is\n", " invoked.\n", "\n", " set-sort-type-now(type)\n", " Sets the sortType immediately\n", " without waiting for\n", " settings-apply().\n", "\n", " set-nice-level(level)\n", " This action sets the niceLevel as\n", " indicated on the Settings Panel,\n", " but does not affect the current\n", " settings until the\n", " settings-apply() action is\n", " invoked.\n", "\n", " set-nice-level-now(level)\n", " Sets the niceLevel immediately\n", " without waiting for\n", " settings-apply().\n", "\n", " settings-submenu()\n", " This action procedure is docu-\n", " mented here only for complete-\n", " ness. It should only be used for\n", " BtnMotion events in the set-\n", " tingsMenu widget. It invokes the\n", " appropriate pullright menu for\n", " the Settings menu. Believe me,\n", " you don't want to deal with this.\n", "\n", " File actions\n", " The operation of the File panel is\n", " hard-coded. The following actions are\n", " used to pop it up however:\n", "\n", " file-save()\n", " Pops up the File panel, and\n", " resets its values in preparation\n", " for saving the database. By\n", " default this is invoked by\n", " selecting \"Save\" from the \"File\"\n", " menu or by typing \"Meta-S\" in any\n", " non-Text widget.\n", "\n", " file-load()\n", " Pops up the File panel, and\n", " resets its values in preparation\n", " for reloading the database. By\n", " default this is invoked by\n", " selecting \"Load\" from the \"File\"\n", " menu or by typing \"Meta-L\" in any\n", " non-Text widget.\n", "\n", " file-write()\n", " Pops up the File panel, and\n", " resets its values in preparation\n", " for writing the database in a\n", " human-readable form. By default\n", " this is invoked by selecting\n", " \"Write\" from the \"File\" menu or\n", " by typing \"Meta-W\" in any non-\n", " Text widget.\n", "\n", " Help actions\n", "\n", " help()\n", " Pops up the Help panel.\n", "\n", " help-done()\n", " Dismisses the Help panel.\n", "\n", " help-prev()\n", " help-next()\n", " Selects the previous or next help\n", " topic, respectively.\n", "\n", " help-up()\n", " help-down()\n", " Scrolls the text of the current\n", " help topic up or down one page,\n", " respectively. This is an alter-\n", " native to using the Text widget's\n", " scrollbar.\n", "\n", " Miscellaneous actions\n", "\n", " ftp-trace-done()\n", " Dismisses the FTP Trace window.\n", " By default, this is invoked by\n", " clicking on the \"Dismiss\" button\n", " in the FTP Trace window.\n", "\n", " Environment Variables\n", "\n", " The following environment variables\n", " are used by Xarchie if they are\n", " defined:\n", "\n", " TMPDIR - Directory for \"Open\"-ed\n", " files\n", " XAPPLRESDIR - Directory containing\n", " Xarchie resource file\n", " USER - Username for FTP mail\n", " address\n", " HOSTNAME - Hostname for FTP mail\n", " address\n", "\n", " Files\n", "\n", " Xarchie - default Xarchie resource\n", " file\n", "\n", " Diagnostics\n", "\n", " Xarchie indicates X errors using the\n", " ever-popular default X error handler\n", " that prints a message and dies, possi-\n", " bly leaving a large core dump some-\n", " where.\n", "\n", " Errors due to incorrect resource\n", " specifications cause an error message\n", " on stderr, but do not kill Xarchie\n", " (usually).\n", "\n", " Errors due to incorrect user commands\n", " or problems with the connection to\n", " Archie result in a popup alert box\n", " being displayed. Clicking on the indi-\n", " cated button in the alert box will\n", " make it go away and allow you to con-\n", " tinue.\n", "\n", " An incorrect value for the FTP mail\n", " address (as determined from the system\n", " information or from the USER and HOST-\n", " NAME variables) can result in access\n", " being denied by some anonymous FTP\n", " servers. See the description of the\n", " ftpMailAddress non-widget resource if\n", " your system has problems with this.\n", "\n", " If you continually get \"Can't resolve\n", " hostname\" errors when you try to\n", " query, then Xarchie was not built\n", " properly. Contact your local main-\n", " tainer and suggest that they read the\n", " PROBLEMS file concerning the \"resolv\"\n", " library.\n", "\n", " If your queries always time out, then\n", " there are two possibilities. First,\n", " and by far the most likely, is that\n", " the server is simply busy. Try again\n", " later. The other possibility is that\n", " UDP traffic is disabled on your sys-\n", " tem. You should contact your local\n", " maintainer and ask them to read the\n", " PROBLEMS files concerning UDP traffic.\n", "\n", " Known Bugs\n", "\n", " Crashes have been observed when the\n", " Help text is scrolled. There is no\n", " fix, but see the PROBLEMS file for\n", " some discussion.\n", "\n", " The list of files in the FileChooser\n", " widgets don't seem to get displayed\n", " properly all the time. That is, some-\n", " times items seem to be drawn on top of\n", " each other. Refreshing the window\n", " (eg., iconify/deiconify or scrolling\n", " up/down) clears it up. This seems like\n", " an Xaw bug, but is difficult to repeat\n", " in isolation.\n", "\n", " Your mileage may vary regarding the\n", " Xarchie icon changing to reflect\n", " search and transfer status. Your win-\n", " dow manager may not support\n", " application-specified icons, or may\n", " not support them changing dynamically.\n", " See the PROBLEMS file for some discus-\n", " sion.\n", "\n", " It is not currently possible to abort\n", " during nameserver lookup. Perhaps\n", " some day I'll get motivated to add\n", " asynchronous DNS code.\n", "\n", " The browser has a hard-coded maximum\n", " depth, beyond which you cannot expand\n", " directories. I don't think it will be\n", " a major problem however.\n", "\n", " Reporting Bugs\n", "\n", " If you have problems with or questions\n", " about an individual Archie server\n", " site, contact archie-admin at that\n", " site. If you have any questions about\n", " Archie itself, write to\n", " info@bunyip.com. If you have questions\n", " about Prospero, write to info-\n", " prospero@isi.edu. The USENET newsgroup\n", " comp.archives.admin may also be help-\n", " ful.\n", "\n", " If you have a problem, please read the\n", " \"Known Bugs\" section first, then con-\n", " tact your local maintainer and/or\n", " refer to the PROBLEMS and INSTALL\n", " files in the Xarchie distribution.\n", "\n", " When reporting bugs, problems, sugges-\n", " tions or contributions, please be sure\n", " to send them to the right place.\n", " Issues dealing with the X interface\n", " should be sent to George Ferguson\n", " (ferguson@cs.rochester.edu). Please be\n", " sure to include sufficient details,\n", " including hardware, OS, compiler, ver-\n", " sion of X, and the like. No amount of\n", " detail is too much.\n", "\n", " Brendan Kehoe (brendan@cygnus.com) is\n", " in charge of the archie clients and\n", " most of the network stuff underlying\n", " Xarchie, Cliff Neuman (bcn@isi.edu) is\n", " in charge of Prospero, and Alan Emtage\n", " and Peter Deutsch\n", " ({bajan,peterd}@bunyip.com) are in\n", " charge of the Archie project itself.\n", " Individual archie servers, however,\n", " are maintained locally at each server\n", " site (archie-admin@).\n", "\n", " AUTHOR\n", "\n", " George Ferguson, University of Roches-\n", " ter,\n", " (ferguson@cs.rochester.edu)\n", " Original standalone archie program by\n", " Brendan Kehoe,\n", " (brendan@cs.widener.edu).\n", "\n", " Original Prospero archie program by\n", " Clifford Neuman,\n", " (bcn@isi.edu).\n", "\n", " The archie service was conceived of\n", " and implemented by Alan Emtage\n", " (bajan@bunyip.com), Peter Deutsch\n", " (peterd@bunyip.com) and Bill Heelan\n", " (wheelan@bunyip.com).\n", "\n",