@database EasyFR.guide @master Work:progs/EasyFR/Docs/English/EasyFR.guide @$VER: 2.0 @author "Francesco Dipietromaria" @(c) "1995" @remark Created with Heddley v1.1 (c) Edd Dumbill 1994 @node "Main" "EasyFR.guide" @next "Legal issues" @{b}EasyFR v2.0@{ub} EasyFR, an utility to handle FidoNet File-Request. Copyright (C) 1994 Angelo Vizzarro Copyright (C) 1995 Francesco Dipietromaria GUI has been created with MUI (C) 1993 Stefan Stuntz. This guide describes how to install and use `EasyFR'. @{" Legal issues " link "Legal issues" 0} @{" About EasyFR " link "About EasyFR" 0} @{" How to install " link "How to install" 0} @{" Let's go! " link "Let's go!" 0} @{" How to register " link "How to register" 0} @{" Author addresses " link "Author address" 0} @{" Acknowledgements " link "Acknowledgements" 0} @endnode @node "Legal issues" "EasyFR.guide/Legal issues" @next "License" @prev "Main" @{b} Legal issues@{ub} @{" License " link "License" 0} @{" No warranty " link "No Warranty" 0} @{" Disclaimer " link "Disclaimer" 0} @endnode @node "License" "EasyFR.guide/License" @next "No Warranty" @prev "Main" @{b} License@{ub} This license applies to the product called "EasyFR", a program for the Amiga computer, published by Francesco Dipietromaria under the concepts of ShareWare, and the accompanying documentation, example files and anything else that comes with the original distribution. The terms "Program" and "EasyFR" below, refer to this product. The licensee is addressed as `you'. * You may copy and distribute verbatim copies of the program's executable code and documentation as you receive it, in any medium, provided that you conspicuously and appropriately publish only the original, unmodified program, with all copyright notices and disclaimers of warranty intact and including all the accompanying documentation, example files and anything else that came with the original. * You may not copy and/or distribute this program without the accompanying documentation and other additional files that came with the original. You may not copy and/or distribute modified versions of this program. * You may not copy, modify, sublicense, distribute or transfer the program except as expressly provided under this license. Any attempt otherwise to copy, modify, sublicense, distribute or transfer the program is void, and will automatically terminate your rights to use the program under this license. However, parties who have received copies, or rights to use copies, from you under this license will not have their licenses terminated so long as such parties remain in full compliance. * By copying, distributing and/or using the program you indicate your acceptance of this license to do so, and all its terms and conditions. * Each time you redistribute the program, the recipient automatically receives a license from the original licensor to copy, distribute and/or use the program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. * You may not disassemble, decompile, re-source or otherwise reverse engineer the program. * You may use the programs for a period of up to 3 weeks for evaluation. After that, you have to @{"register" link "How to register" 0} or quit using the program. * If you wish to incorporate parts of the programs into other programs, write to the author to ask for permission. * You agree to cease distributing the program and data involved if requested to do so by the author. * You may charge a fee to recover distribution costs. The fee for diskette distribution may not be more than the cost to obtain a public domain diskette from Fred Fish. @endnode @node "No Warranty" "EasyFR.guide/NO Warranty" @next "About EasyFR" @prev "Copyright" @{b} No warranty@{ub} THERE IS NO WARRANTY FOR THE PROGRAMS, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAMS "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAMS IS WITH YOU. SHOULD THE PROGRAMS PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY REDISTRIBUTE THE PROGRAMS AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAMS (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAMS TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. @endnode @node "Disclaimer" "EasyFR.guide/Disclaimer" @next "Copyright" @prev "No Warranty" @{b} Disclaimer@{ub} No warranty, either express or implied, is made with respect to the fitness or merchantability of `EasyFR'. Francesco Dipietromaria (referred to as `the author'), reserves the right to not develop any future versions of `EasyFR'. The author will try to make a good faith attempt at correcting any problems if any are discovered, but is in no way required, nor bound to correct them. The author neither assumes nor accepts any responsibility for the use or misuse of these programs. He will also not be held liable for damages or any compensation beyond the original registration fee due to loss of profit or any other damages arising out of the use, or inability to use this program. The author will not be liable for any damage arising from the failure of this program to perform as described, or any destruction of other programs or data residing on a system attempting to run the programs. The user of this program uses it at his or her own risk. @endnode @node "Copyright" "EasyFR.guide/Copyright" @next "About EasyFR" @prev "Disclaimer" @{b} Copyright@{ub} `EasyFR' is become @{i}shareware@{ui} from version 2.0. Unregistered users will found the old annoying requester at startup and will use a slowed and memory hunger function to read XPK packed filelists. Please, support shareware concept. If you like this program and you use it, consider registering. If you need more info, please refer to secion @{"How to register" link "How to register" 0}. @endnode @node "About EasyFR" "EasyFR.guide/About EasyFR" @next "How to install" @prev "Copyright" @{b} About EasyFR@{ub} `EasyFR' projcet is born from my friend Angelo Vizzarro, who made the first version of this software: "The idea of EasyFR comes in my mind one day when my friend Gino Casavecchia shows me some utility to handle File-Requests: I did like none of them. So, considering I was looking for a project to try using MUI, i started programming, and this is the result!" Unfortunatly Angelo Vizzarro stopped the project, due to lack of time. I asked him souce codes, say I would be very happy to keep on developping this software. In this way we get to `EasyFR 2.0'. `EasyFR' is an utility to help and handle File-Requests in an easyer way. Considering this, you will need to have: - an Amiga :-) - a modem - a Point - a mailer If you do not have these, probably you are not interested in EasyFR. EasyFR 2.0 needs: - Kickstart 2.0 (you will need at least 2.1 to run localization); - MUI 2.2 (or updated version) installed; - xpkmaster.library 2.4; - traplist.library 5.2 (better 5.4); These are some of the feature: - You can create and handel .REQ files to be send to the BBS (with a mailer) that should reply your request; - You can read and select directly from a fidonet box (a Filelist) files you want to request; selected entries will be copied in the .REQ file; - You can handle fidonet box (Filelist) packed with any XPK library; - Find Next & Find Previous functions in fidonet boxes; - You can display info about nodes in nodelist (using traplist.library); - You can edit a QuickList with most frequently used nodes; - Mailer can be runned directly from EasyFR pressing one button; - Simple menagement of InBound: directory; - You can list and extract lha archive; - EasyFR can join a Filelist to a specific node (via traplist.library): changing node will change filelist too; - GUI is personalizable by the user, this thanx Stefan Stunz and his `@{"Magic User Interface" link "Magic User Interface" 0}'; - Localization: by now only english and italian are distributed; - On-line help: oressing the HELP key, the AmigaGuide® help will be shown. Help is context-sensitive; As you can read, there is nothing really particular, but there seems that other program miss something. Some can run TrapDoor, do not handle fido boxes (Filelists), other do not support traplist.library, and I haven't seen any supporting XPK libraries. `EasyFR' try to handle File Requests in a complete and easy way. @endnode @node "Magic User Interface" "EasyFR.guide/Magic User Interface" `EasyFR' has been developed using `MUI' v2.0 ((C) Stefan Stunz). This mean: 1) You MUST have `MUI' installed in order to run this program; 2) You MUST have at least AmigaOS 2.04 (v37.175) in order to install `MUI' If you do not know `MUI', probably you won't be happy to loose some space of your HD installing this package. I think you will change your opinion! `MUI' offers many feature to both the user and the programmer. Some examples: - A GUI following the Comodore's User Interface Style Guide; - Every `MUI' application can be iconified; - You can use the keyboard, instead of the 'usual' mouse; - Almost all elements will automatically fit to the window size (if resiable) and to the selected font (witch may change); - Many GUI parameters (font, color, pattern, background images, screen, etc.) can be changed directly from the user, using the @{"MUI-Prefs" link "MUI-Prefs" 0} program supplied with the distribution; I could go on, but i prefer to stop here (please, download `MUI' from your local BBS and read the documentation); I only add that not having `MUI' installed means not to use all those programs that require it (and they are more and more), not only `EasyFR'! @endnode @node "How to install" "EasyFR.guide/How to install" @next "Let's go!" @prev "About EasyFR" @{b} How to install@{ub} 1) Install @{"MUI" link "Magic User Interface" 0} in your sistem. `EasyFR' does not work without `MUI' 2) Choose a dir and copy these files: - EasyFR (executable) - EasyFR.info (executable icon) - EasyFR.sleep.info (AppIcon for EasyFR) - EasyFR.guide (on-line help) 3) Create a dir named "C" and copy in it the file C/mouse2 provided with the distribution. 4) EasyFR need his directory to be assigned as EasyFR:. Please do this and add it to the file s:user-startup. 5) Copy the catalog file of your language (if provided) in the dir Locale:Catalogs/Italiano. Please note that locale support comes from Workbench 2.1 and later. If you are using WB 2.0, EasyFR will speak in English. For a full working it is raccomanded to install TrapDoor package (or another mailer), and/or at least the traplist.library: `EasyFR' uses this library to handle node informations. Now installation is done. By the way you can install EasyFR using the installer script provided with the distribution... :-) EasyFR can be run either from a shell with the command "EasyFR" or "run EasyFR >NIL: 50%. Speed slow down stricly depend on the compression method you are using. Using a really fast unpacking packer can be faster than usgin plain filelist. EasyFR offer to the feature of "linking" a filelist to a node: in this way, every time you select the node, the linked filelist will be automatically loaded. This information is saved in the extra database handled by the traplist.library. BTW, you can also turn this feature off from the configuration panel. The name (and the path) of the filelist can be inserted direcly in the string gadget or selected via the popup, that will activate an ASL file-requester. You will also find an easy to use string search funtion. @endnode @node "Nodelist Page" "EasyFR.guide/Nodelist Page" @next "Global Nodelist" @prev "FileLists" @{b}Nodelist Page@{ub} In this page you will find: - @{"Information on nodes" link "Global Nodelist" 0}; - @{"The Quicklist" link "QuickList" 0}. @endnode @node "Global Nodelist" "EasyFR.guide/Global Nodelist" @next "QuickList" @prev "Nodelist Page" @{b}Global Nodelist@{ub} From version 2.0, EasyFR uses traplist.library written by Maximilian Hantsch and Martin Laubach. In this way there is no more need to use a self made handling of the nodelist (as in the èpreviuos release). This make EasyFR more standard... Every information about nodes are completely handled by this library. You have not to load big nodelist and to process them: traplist.library uses an index to speed up searching trough the nodelist itself. In the bottom you'll find a string gadged labeled `Node address': here you shall write the fidonet node number you want to look at. If this address exist, EasyFR will show every information available for this node. Displayed nodes can be added to the @{"Quicklist" link "QuickList" 0} for a faster use. @endnode @node "QuickList" "EasyFR.guide/QuickList" @next "InBoud Page" @prev "Global Nodelist" @{b} The QuickList@{ub} This is where you should add the most used systems. This list will be shown every time you will activate the pop-up near the node address un the main page, where, double-clicking on a node, will select it. Please, have a look to @{"Node to poll" link "Node to poll" 0}. The buttons `Add' and `Remove' are used to add or remove the node that is currently displayed to the QuickList. Double-clicking an entry from this list will let EasyFR display informa- tions about it. @endnode @node "InBoud Page" "EasyFR.guide/InBound Page" @next "InBound list" @prev "QuickList" @{b}InBound Page@{ub} From this page you can perform some easy function of the InBound directory before and after the request. You can: - have a look to the @{"InBound List" link "InBound list" 0}, - perform some @{"commands on files" link "InBound commands" 0}. @endnode @node "InBound list" "EasyFR.guide/InBound Directory list" @next "InBound commands" @prev "InBoud Page" @{b} InBound directory List.@{ub} This page can be usefull before and after the download to verify witch files are present and witch are just arrived. Name, lenght, date and comment are displayed. Have a look to @{"InBound commands" link "InBound commands" 0} @endnode @node "InBound commands" "EasyFR.guide/InBound Commands" @next "Config Page" @prev "InBound list" @{b}InBound commands@{ub} @{u}Rescan InBound@{uu} Force EasyFR to read InBound directory again, usable after a download. @{u}Set Comment@{uu} This button let you edit the filenote of a file; this can be handy after a download when filenotes do not describe the contents of the file. @{u}Lha List@{uu} Open a console window and displays the contents of the selected file if it is an lh file (from lha0 to lh5 method are recognised). This feature runs the command you have inseted in the appropriate string gadget in the config page. @{u}Lha Extract@{uu} Extract the selected file using the command in the appropriate string gadget in the config page. @{u}Sort by ...@{uu} From here you can select the sort method of the directory list, either by Name or by Size. @endnode @node "Config Page" "EasyFR.guide/Config Page" @next "Download command" @prev "InBound commands" @{b}Config Page@{ub} This page contains all information required from the program to work properly. Following entries are requested: - @{"Download command" link "Download command" 0}; - @{"LhA list command" link "LhA list command" 0}; - @{"LhA extract command" link "LhA extract command" 0}; - @{"InBound path" link "InBound Path" 0}; - @{"OutBound path" link "OutBound Path" 0}; - @{"Nodelist path" link "Nodelist Path" 0}; - @{"Work path" link "Work Path" 0}; Then you can choice to either to use the traplist.library or not to @{"link a" link "Node-Filelist" 0} @{" Filelist" link "Node-Filelist" 0} to a specific node address. On the right some information abount the registration status and the @{"XPK libraries" link "XPK libraries" 0} status are displaied. @endnode @node "Download command" "EasyFR.guide/Download Command" @next "LhA list command" @prev "Config Page" @{b} Download command@{ub} `EasyFR' allow you to directly do a download without having to run manually a mailer and make it do the call. Anyway it cannot handle directly the modem. `EasyFR' will run the command you will enter in this string gadged every time you will push the call button in the main page. If you are using Trapdoor as mailer, you will have to insert something somilar to the following line (let's suppose Trapdoor is in the directory Mail:bin/): Mail:bin/Trapdoor CALL %a The tocken %a will be sobstituted with the current address. You are supposed to use a mailer that support traplist.library too, because no telephone number is inserted (future release may support this, too). For further information about Trapdoor or other mailer, please refer to theri documentation. @endnode @node "LhA list command" "EasyFR.guide/LhA List Command" @next "LhA extract command" @prev "Download command" @{b} LhA list command@{ub} Here you must insert the command that will be executed on the selected file in the InBound listview when you press the `Lha List' button. The command should look like: C:Lha l -Qa %f where %f is the filename of the selected entry. There is non need the specify the redirection on a console: a window will be opened automatically. @endnode @node "LhA extract command" "EasyFR.guide/LhA Extract Command" @next "InBound Path" @prev "LhA list command" @{b} LhA extract command@{ub} Here you must insert the command that will be executed on the selected file in the InBound listview when you press the `Lha Extract' button. The command should look like: C:Lha x -Qa %f RAM: where %f is the filename of the selected entry. There is non need the specify the redirection on a console: a window will be opened automatically. @endnode @node "InBound Path" "EasyFR.guide/InBound Path" @next "OutBound Path" @prev "LhA extract command" @{b} InBoud path@{ub} Insert here the full path of the directory where your mailer puts downloaded files. This path shall be the same as in the mailer configuration file. Examples: Mail:InBound/ InBound: @endnode @node "OutBound Path" "EasyFR.guide/OutBound Path" @next "Nodelist Path" @prev "InBound Path" @{b} OutBoud path@{ub} Insert here the full path of the directory where you want .REQ file saved. This one should be the same directory where mail packet are saved from the tosser. This path shall be the same as in the mailer configuration file. Examples: Mail:OutBound/ OutBound: @endnode @node "Nodelist Path" "EasyFR.guide/Nodelist Path" @next "Work Path" @prev "OutBound Path" @{b} Nodelist path@{ub} Insert here the full path of the nodelist directory. This path shall be the same as in the Traplist configuration file. Examples: Mail:Nodelist/ Nodelist: @endnode @node "Work Path" "EasyFR.guide/Work path" @next "Node-Filelist" @prev "Nodelist Path" @{b} Work path@{ub} `EasyFR' needs a work directory where to write some temp files. Insert here the full path of this directory. Usually it is better to select a path in the Ram Disk, but you can select a path on you hard drive too. Examples: T: Ram:T/ @endnode @node "Node-Filelist" "EasyFR.guide/Associazione Nodo-FileList" @next "XPK libraries" @prev "Work Path" @{b} Filelist link@{ub} If this flag is active, the program remember the last Filelist used for a specific node, and load it when that node is selected. Filelist path and name is recorded in the extra database handled by the traplist.library. This function is available only if this library is installed. @endnode @node "XPK libraries" "EasyFR.guide/XPK Libraries" @next "ARexx" @prev "Node-Filelist" @{b} XPK Libraries@{ub} XPK is an interface standard between programs and packer libraries. Every XPK application can handle datas packed with every XPK packer library: you only need that specific packer library and also `EasyFR 2.0' will be able to read packed Filelist. XPK libraries are distributed in two archives `xpkXXusr.lha' and `xpkXXdev.lha', where XX is the version number. Currently distributed version is 2.5. You can find them from your local BBS or on an Aminet mirror. Thanx goes to: Urban Dominik Mueller umueller@amiga.physik.unizh.ch Bryan Ford bryanf@hpmcaa.mcm.hp.com Peter Struijk ddws0168@dutiws.tudelft.nl Christian von Roques roques@karlsruhe.gmd.de Andre Beck beck@freia.inf.tu-dresden.de Marc Zimmermann zimmerma@ibr.cs.tu-bs.de Kristian Nielsen bombadil@diku.dk Torsten Juergeleit bj030@aix370.rrz.uni-koeln.de Matthias Scheler tron@uni-paderborn.de Uwe Roehm roehm@kirk.fmi.uni-passau.de Martin A. Blatter blatter@amiga.physik.unizh.ch ...and may others. EasyFR 2.0 support XPK libraries. You only need to install the xpk25usr.lha package (where 25 is the version number) to make `EasyFR 2.0' to read XPK packed filelist. There are many other packer libraries not dostributed with the original archive. You can find the on may BBSes or on internet. Filelist are text files and can be packed with a ratio up to 60-70%. I suggest you to try to pack filelist with the NUKE method (the xpknuke.library can be found in the original XPK archive): using this one you will gain more than 60% on text file keeping hi-speed decompression. @{b}WARNING@{ub}: registered users will make use of an optimized (either in time or in space) finction for reading packed filelist. @{i}Unregistered users@{ui} will note a slow down and will need more memory for read them. I suggest you not to read big packed filelist, or you will have to wait long time. On my A2000/030 (25 Mhz), `EasyFR 2.0', 020+ registered version, took about 14 seconds to read a packed Aminet INDEX filelist (Uncompressed length 1119741 bytes, Compressed length 443256 bytes) loading it from HD. @endnode @node "ARexx" "EasyFR.guide/ARexx" @next "How to register" @prev "XPK libraries" @{b} ARexx Interface@{ub} EasyFR 2.0 have the standard ARexx interface provided by MUI (quit, hide, deactivate, show, activate, info, help): please refer to the MUI documentation for further information about these commands. Other commands will be implemented in next releases, to make it possible to program `EasyFR' with an ARexx script. @endnode @node "How to register" "EasyFR.guide/Come registrarsi" @next "Author address" @prev "XPK libraries" @{b} How to register@{ub} From release 2.0, EasyFR is become shareware. You can use EasyFR for an evaluation period of 3 weeks. After this period, if you like it, if you think it is useful and it is a well done program, you have to register. The registration fee can be payed in italian lire (10.000 lire) or in american dollars (8 US $). To register fill in the @{"Registration form" alink "Registration.form/main" 0} and send it to the @{"author" link "Author address" 0} via snail mail or via e-mail. Remember that future developing of this software depend on your support. @endnode @node "Author address" "EasyFR.guide/Come contattare l'autore" @next "History" @prev "How to register" @{b} How to contact the author@{ub} For any information, for registering, bug report, suggestions or other, you can reach the author to the following address: Francesco Dipietromaria v. Genovesi, 15 10128 Torino Italia ...or via E-mail to the following addresses: Fido: 2:334/503.15 Amy: 39:101/402.5 Uucp: dpm@pmn.it I will not reply to snail mail because of postal expenses. It's better to use e-mail. @endnode @node "History" "EasyFR.guide/Storia" @next "Future" @prev "Author address" @{b} History@{ub} EasyFR 1.0: - First pubblic release (not distributed on internet beause english documantation were missing). EasyFR 2.0: - The project comes in my hands (thanx to Angelo Vizzarro that give it to me); - Added traplist.library support; - Removed personal nodelist handling; - Added @{"XPK libraries" link "XPK libraries" 0} support for reading packed filelist; Future developing of this software depend on your support. @endnode @node "Future" "EasyFR.guide/Futuro" @next "Acknowledgements" @prev "History" @{b}Future...@{ub} Future releases are planned to have some more feature: - A complete ARexx interface, able to pilot the program completely; - Make it possible to handle not in nodelist addresses using the QuickList (handling at least the phone number for the mailer); - Time cost calculation for the download of the selected files; Suggestions are welcome. @endnode @node "Acknowledgements" "EasyFR.guide/Ringraziamenti" @prev "Future" @{b} Acknowledgements@{ub} The following names are either trademarks or the efforts of the person and/or company listed: * Amiga and AmigaDOS are trademarks of Commodore-Amiga, Inc. * ARexx by William S. Hawes, Wishful Thinking Development Corp. * Fido and FidoNet are trademarks of Tom Jennings, Fido Software. * TrapDoor is a registered trademark of Maximilian Hantsch and Martin Laubach. * TrapList and traplist.library by Maximilian Hantsch and Martin Laubach. * XPK e xpkmaster.library © Urban Dominik Mueller and many others. I wish to thanx Angelo Vizzarro for giving me the source code of his first release of EasyFR with the documentation needed for continuing the development of this soft (some authors prefer to trash their source code instead of giving them to someone else). A special thank you to the following people (in alphabetical order): - Gino Casavecchia fot his support; - Alex Garoli for his suggestion and his help in solving probs; - Marco Losurdo for the Icons and the Logo; and to my other beta testers (in alphabetical order): Danilo Aghemo, Fabrizio David, Andrea Vallinotto, Angelo Verdone e Amiga & Technology BBS for their support and bug reports needed to keep developing EasyFR 2.0. License agreement and legal mumbo jumbo largely stolen from TrapDoor manual. Many thanx to all of you. EasyFR 2.0 has been programmed on Amiga2000/A2630, Kickstart 3.1 (version 40.63), Workbench 3.1 (version 40.42) using SAS/C Develpment System 6.55. A special thanx goes to SAS Institute for developing this great compiler and to the SAS Institute GmbH (European Headquarter) for their reliability and the speed with witch they send me the package. The documentationa and the source code have been prepared using GoldED2.2.0 ©1993-1994 Dietmar Eilert. My thanx goes to him too for his wonderful editor. @endnode