diff --git a/html/license/copying.html b/html/license/copying.html index ebf91634..06c4f830 100644 --- a/html/license/copying.html +++ b/html/license/copying.html @@ -1,360 +1,361 @@ - -
-- GNU GENERAL PUBLIC LICENSE - Version 2, June 1991 - - Copyright (C) 1989, 1991 Free Software Foundation, Inc. - 675 Mass Ave, Cambridge, MA 02139, USA - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The licenses for most software are designed to take away your -freedom to share and change it. By contrast, the GNU General Public -License is intended to guarantee your freedom to share and change free -software--to make sure the software is free for all its users. This -General Public License applies to most of the Free Software -Foundation's software and to any other program whose authors commit to -using it. (Some other Free Software Foundation software is covered by -the GNU Library General Public License instead.) You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -this service if you wish), that you receive source code or can get it -if you want it, that you can change the software or use pieces of it -in new free programs; and that you know you can do these things. - - To protect your rights, we need to make restrictions that forbid -anyone to deny you these rights or to ask you to surrender the rights. -These restrictions translate to certain responsibilities for you if you -distribute copies of the software, or if you modify it. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must give the recipients all the rights that -you have. You must make sure that they, too, receive or can get the -source code. And you must show them these terms so they know their -rights. - - We protect your rights with two steps: (1) copyright the software, and -(2) offer you this license which gives you legal permission to copy, -distribute and/or modify the software. - - Also, for each author's protection and ours, we want to make certain -that everyone understands that there is no warranty for this free -software. If the software is modified by someone else and passed on, we -want its recipients to know that what they have is not the original, so -that any problems introduced by others will not reflect on the original -authors' reputations. - - Finally, any free program is threatened constantly by software -patents. We wish to avoid the danger that redistributors of a free -program will individually obtain patent licenses, in effect making the -program proprietary. To prevent this, we have made it clear that any -patent must be licensed for everyone's free use or not licensed at all. - - The precise terms and conditions for copying, distribution and -modification follow. - - GNU GENERAL PUBLIC LICENSE - TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION - - 0. This License applies to any program or other work which contains -a notice placed by the copyright holder saying it may be distributed -under the terms of this General Public License. The "Program", below, -refers to any such program or work, and a "work based on the Program" -means either the Program or any derivative work under copyright law: -that is to say, a work containing the Program or a portion of it, -either verbatim or with modifications and/or translated into another -language. (Hereinafter, translation is included without limitation in -the term "modification".) Each licensee is addressed as "you". - -Activities other than copying, distribution and modification are not -covered by this License; they are outside its scope. The act of -running the Program is not restricted, and the output from the Program -is covered only if its contents constitute a work based on the -Program (independent of having been made by running the Program). -Whether that is true depends on what the Program does. - - 1. You may copy and distribute verbatim copies of the Program's -source code as you receive it, in any medium, provided that you -conspicuously and appropriately publish on each copy an appropriate -copyright notice and disclaimer of warranty; keep intact all the -notices that refer to this License and to the absence of any warranty; -and give any other recipients of the Program a copy of this License -along with the Program. - -You may charge a fee for the physical act of transferring a copy, and -you may at your option offer warranty protection in exchange for a fee. - - 2. You may modify your copy or copies of the Program or any portion -of it, thus forming a work based on the Program, and copy and -distribute such modifications or work under the terms of Section 1 -above, provided that you also meet all of these conditions: - - a) You must cause the modified files to carry prominent notices - stating that you changed the files and the date of any change. - - b) You must cause any work that you distribute or publish, that in - whole or in part contains or is derived from the Program or any - part thereof, to be licensed as a whole at no charge to all third - parties under the terms of this License. - - c) If the modified program normally reads commands interactively - when run, you must cause it, when started running for such - interactive use in the most ordinary way, to print or display an - announcement including an appropriate copyright notice and a - notice that there is no warranty (or else, saying that you provide - a warranty) and that users may redistribute the program under - these conditions, and telling the user how to view a copy of this - License. (Exception: if the Program itself is interactive but - does not normally print such an announcement, your work based on - the Program is not required to print an announcement.) - -These requirements apply to the modified work as a whole. If -identifiable sections of that work are not derived from the Program, -and can be reasonably considered independent and separate works in -themselves, then this License, and its terms, do not apply to those -sections when you distribute them as separate works. But when you -distribute the same sections as part of a whole which is a work based -on the Program, the distribution of the whole must be on the terms of -this License, whose permissions for other licensees extend to the -entire whole, and thus to each and every part regardless of who wrote it. - -Thus, it is not the intent of this section to claim rights or contest -your rights to work written entirely by you; rather, the intent is to -exercise the right to control the distribution of derivative or -collective works based on the Program. - -In addition, mere aggregation of another work not based on the Program -with the Program (or with a work based on the Program) on a volume of -a storage or distribution medium does not bring the other work under -the scope of this License. - - 3. You may copy and distribute the Program (or a work based on it, -under Section 2) in object code or executable form under the terms of -Sections 1 and 2 above provided that you also do one of the following: - - a) Accompany it with the complete corresponding machine-readable - source code, which must be distributed under the terms of Sections - 1 and 2 above on a medium customarily used for software interchange; or, - - b) Accompany it with a written offer, valid for at least three - years, to give any third party, for a charge no more than your - cost of physically performing source distribution, a complete - machine-readable copy of the corresponding source code, to be - distributed under the terms of Sections 1 and 2 above on a medium - customarily used for software interchange; or, - - c) Accompany it with the information you received as to the offer - to distribute corresponding source code. (This alternative is - allowed only for noncommercial distribution and only if you - received the program in object code or executable form with such - an offer, in accord with Subsection b above.) - -The source code for a work means the preferred form of the work for -making modifications to it. For an executable work, complete source -code means all the source code for all modules it contains, plus any -associated interface definition files, plus the scripts used to -control compilation and installation of the executable. However, as a -special exception, the source code distributed need not include -anything that is normally distributed (in either source or binary -form) with the major components (compiler, kernel, and so on) of the -operating system on which the executable runs, unless that component -itself accompanies the executable. - -If distribution of executable or object code is made by offering -access to copy from a designated place, then offering equivalent -access to copy the source code from the same place counts as -distribution of the source code, even though third parties are not -compelled to copy the source along with the object code. - - 4. You may not copy, modify, sublicense, or distribute the Program -except as expressly provided under this License. Any attempt -otherwise to copy, modify, sublicense or distribute the Program is -void, and will automatically terminate your rights under this License. -However, parties who have received copies, or rights, from you under -this License will not have their licenses terminated so long as such -parties remain in full compliance. - - 5. You are not required to accept this License, since you have not -signed it. However, nothing else grants you permission to modify or -distribute the Program or its derivative works. These actions are -prohibited by law if you do not accept this License. Therefore, by -modifying or distributing the Program (or any work based on the -Program), you indicate your acceptance of this License to do so, and -all its terms and conditions for copying, distributing or modifying -the Program or works based on it. - - 6. Each time you redistribute the Program (or any work based on the -Program), the recipient automatically receives a license from the -original licensor to copy, distribute or modify 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 are not responsible for enforcing compliance by third parties to -this License. - - 7. If, as a consequence of a court judgment or allegation of patent -infringement or for any other reason (not limited to patent issues), -conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot -distribute so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you -may not distribute the Program at all. For example, if a patent -license would not permit royalty-free redistribution of the Program by -all those who receive copies directly or indirectly through you, then -the only way you could satisfy both it and this License would be to -refrain entirely from distribution of the Program. - -If any portion of this section is held invalid or unenforceable under -any particular circumstance, the balance of the section is intended to -apply and the section as a whole is intended to apply in other -circumstances. - -It is not the purpose of this section to induce you to infringe any -patents or other property right claims or to contest validity of any -such claims; this section has the sole purpose of protecting the -integrity of the free software distribution system, which is -implemented by public license practices. Many people have made -generous contributions to the wide range of software distributed -through that system in reliance on consistent application of that -system; it is up to the author/donor to decide if he or she is willing -to distribute software through any other system and a licensee cannot -impose that choice. - -This section is intended to make thoroughly clear what is believed to -be a consequence of the rest of this License. - - 8. If the distribution and/or use of the Program is restricted in -certain countries either by patents or by copyrighted interfaces, the -original copyright holder who places the Program under this License -may add an explicit geographical distribution limitation excluding -those countries, so that distribution is permitted only in or among -countries not thus excluded. In such case, this License incorporates -the limitation as if written in the body of this License. - - 9. The Free Software Foundation may publish revised and/or new versions -of the General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - -Each version is given a distinguishing version number. If the Program -specifies a version number of this License which applies to it and "any -later version", you have the option of following the terms and conditions -either of that version or of any later version published by the Free -Software Foundation. If the Program does not specify a version number of -this License, you may choose any version ever published by the Free Software -Foundation. - - 10. If you wish to incorporate parts of the Program into other free -programs whose distribution conditions are different, write to the author -to ask for permission. For software which is copyrighted by the Free -Software Foundation, write to the Free Software Foundation; we sometimes -make exceptions for this. Our decision will be guided by the two goals -of preserving the free status of all derivatives of our free software and -of promoting the sharing and reuse of software generally. - - NO WARRANTY - - 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY -FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN -OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES -PROVIDE THE PROGRAM "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 PROGRAM IS WITH YOU. SHOULD THE -PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, -REPAIR OR CORRECTION. - - 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR -REDISTRIBUTE THE PROGRAM 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 PROGRAM (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 PROGRAM TO OPERATE WITH ANY OTHER -PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE -POSSIBILITY OF SUCH DAMAGES. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -convey the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - -- - Go Back - - - - + + + +- Copyright (C) 19yy - - This program is free software; you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation; either version 2 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. - -Also add information on how to contact you by electronic and paper mail. - -If the program is interactive, make it output a short notice like this -when it starts in an interactive mode: - - Gnomovision version 69, Copyright (C) 19yy name of author - Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, the commands you use may -be called something other than `show w' and `show c'; they could even be -mouse-clicks or menu items--whatever suits your program. - -You should also get your employer (if you work as a programmer) or your -school, if any, to sign a "copyright disclaimer" for the program, if -necessary. Here is a sample; alter the names: - - Yoyodyne, Inc., hereby disclaims all copyright interest in the program - `Gnomovision' (which makes passes at compilers) written by James Hacker. - - , 1 April 1989 - Ty Coon, President of Vice - -This General Public License does not permit incorporating your program into -proprietary programs. If your program is a subroutine library, you may -consider it more useful to permit linking proprietary applications with the -library. If this is what you want to do, use the GNU Library General -Public License instead of this License. -
+ GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc. + 675 Mass Ave, Cambridge, MA 02139, USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Library General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify 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 are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "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 PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM 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 PROGRAM (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 PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) 19yy <name of author> + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) 19yy name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + <signature of Ty Coon>, 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Library General +Public License instead of this License. ++ +Go Back + + + + diff --git a/html/license/hydracom.html b/html/license/hydracom.html index 49a8a742..04084b66 100644 --- a/html/license/hydracom.html +++ b/html/license/hydracom.html @@ -1,120 +1,121 @@ - - -
- HydraCom Version 1.00 - - A sample implementation of the - HYDRA Bi-Directional File Transfer Protocol - - HydraCom was written by - Arjen G. Lentz, LENTZ SOFTWARE-DEVELOPMENT - COPYRIGHT (C) 1991-1993; ALL RIGHTS RESERVED - - The HYDRA protocol was designed by - Arjen G. Lentz, LENTZ SOFTWARE-DEVELOPMENT and - Joaquim H. Homrighausen - COPYRIGHT (C) 1991-1993; ALL RIGHTS RESERVED - - - DISCLAIMER - - This program is provided "as is" and comes with no warranties of any - kind, either expressed or implied. In no event shall the authors be - liable to you or anyone else for any damages, including any lost - profits, lost savings or other incidental or consequential damages - arising out of the use or inability to use this software. - - - HYDRACOM / SOURCE LICENSE - - HydraCom, its associated utilities (HydraCfg) and the HydraCom - sourcecode may be freely distributed, copied and used, no fee charged. - All files, executables and sourcecode remain the copyrighted property - of Arjen G. Lentz and LENTZ SOFTWARE-DEVELOPMENT. - The distribution archives should remain intact with no files removed - or modified. For special purposes, it is allowed to repack the - archives using a different compression system. - - HydraCom may be bundled up with for instance terminal or BBS packages, - even commercial ones, provided the buyer/user is clearly informed - about the fact that Hydra and HydraCom are free, not owned by the - distributor/retailer in question, and is not included in any possible - charge regarding the rest of the package. This documentation must also - be present so the user can inform himself about Hydra and HydraCom. - The same rules apply to inclusion in shareware and CD-ROM libraries. - In all cases, the author of HydraCom must be given credit in any - informational screens and literature that contain such information. - - The Hydra/HydraCom sourcecode may also be freely used and integrated - into other software or library, provided this is clearly stated in any - informational screens and literature pertaining to this program, and - credit is given to the original author. If the sourcecode of that - program or library is released or otherwise published, the notices - present at the top of every Hydra/HydraCom source file must be - retained in their original unmodified form. - - In addition to the above license, everyone using any part of the - sourcecode, programs or files is fully bound by the general license of - the Hydra protocol as present in the Hydra protocol description - document. For easy reference, the paragraph in question is reprinted - below. - - Any use of, or operation on (including copying/distributing) any of - the above mentioned files implies full and unconditional acceptance of - this license and disclaimer. - - - HYDRA PROTOCOL LICENSE - - You are granted a license to implement the HYDRA file transfer - protocol, HYDRA hereafter, in your own programs and/or use the sample - source code and adapt these to your particular situation and needs; - subject to the following conditions: - - - You must refer to it as the HYDRA file transfer protocol, and you - must give credit to the authors of HYDRA in any information - screens or literature pertaining to your programs that contains - other such information (credits, your own copyrights, etc.). - - - HYDRA will always remain backwards compatible with previous - revisions. HYDRA allows for expansion of its features without - interfering with previous revisions. It is, however, important - that different people do not expand the protocol in different - directions. We therefore ask you to contact us if you have any - needs/ideas regarding HYDRA, so development can be synchronized - and beneficial to all. - - - If your implementation cannot converse with past or future - revisions as supplied by us, then you must refer to it as "HYDRA - derived", or as "a variation of HYDRA", or words to that effect. - - - Hydra protocol design and HydraCom driver: Hydra protocol design: - Arjen G. Lentz Joaquim H. Homrighausen - LENTZ SOFTWARE-DEVELOPMENT 389, route d'Arlon - Langegracht 7B L-8011 Strassen - 3811 BT Amersfoort Luxembourg - The Netherlands - FidoNet 2:283/512, AINEX-BBS +31-33-633916 FidoNet 2:270/17 - arjen_lentz@f512.n283.z2.fidonet.org joho@ae.lu - - Please feel free to contact us at any time to share your comments about our - software and/or licensing policies. -- - Go Back - - - - + + + +
+ HydraCom Version 1.00 + + A sample implementation of the + HYDRA Bi-Directional File Transfer Protocol + + HydraCom was written by + Arjen G. Lentz, LENTZ SOFTWARE-DEVELOPMENT + COPYRIGHT (C) 1991-1993; ALL RIGHTS RESERVED + + The HYDRA protocol was designed by + Arjen G. Lentz, LENTZ SOFTWARE-DEVELOPMENT and + Joaquim H. Homrighausen + COPYRIGHT (C) 1991-1993; ALL RIGHTS RESERVED + + + DISCLAIMER + + This program is provided "as is" and comes with no warranties of any + kind, either expressed or implied. In no event shall the authors be + liable to you or anyone else for any damages, including any lost + profits, lost savings or other incidental or consequential damages + arising out of the use or inability to use this software. + + + HYDRACOM / SOURCE LICENSE + + HydraCom, its associated utilities (HydraCfg) and the HydraCom + sourcecode may be freely distributed, copied and used, no fee charged. + All files, executables and sourcecode remain the copyrighted property + of Arjen G. Lentz and LENTZ SOFTWARE-DEVELOPMENT. + The distribution archives should remain intact with no files removed + or modified. For special purposes, it is allowed to repack the + archives using a different compression system. + + HydraCom may be bundled up with for instance terminal or BBS packages, + even commercial ones, provided the buyer/user is clearly informed + about the fact that Hydra and HydraCom are free, not owned by the + distributor/retailer in question, and is not included in any possible + charge regarding the rest of the package. This documentation must also + be present so the user can inform himself about Hydra and HydraCom. + The same rules apply to inclusion in shareware and CD-ROM libraries. + In all cases, the author of HydraCom must be given credit in any + informational screens and literature that contain such information. + + The Hydra/HydraCom sourcecode may also be freely used and integrated + into other software or library, provided this is clearly stated in any + informational screens and literature pertaining to this program, and + credit is given to the original author. If the sourcecode of that + program or library is released or otherwise published, the notices + present at the top of every Hydra/HydraCom source file must be + retained in their original unmodified form. + + In addition to the above license, everyone using any part of the + sourcecode, programs or files is fully bound by the general license of + the Hydra protocol as present in the Hydra protocol description + document. For easy reference, the paragraph in question is reprinted + below. + + Any use of, or operation on (including copying/distributing) any of + the above mentioned files implies full and unconditional acceptance of + this license and disclaimer. + + + HYDRA PROTOCOL LICENSE + + You are granted a license to implement the HYDRA file transfer + protocol, HYDRA hereafter, in your own programs and/or use the sample + source code and adapt these to your particular situation and needs; + subject to the following conditions: + + - You must refer to it as the HYDRA file transfer protocol, and you + must give credit to the authors of HYDRA in any information + screens or literature pertaining to your programs that contains + other such information (credits, your own copyrights, etc.). + + - HYDRA will always remain backwards compatible with previous + revisions. HYDRA allows for expansion of its features without + interfering with previous revisions. It is, however, important + that different people do not expand the protocol in different + directions. We therefore ask you to contact us if you have any + needs/ideas regarding HYDRA, so development can be synchronized + and beneficial to all. + + - If your implementation cannot converse with past or future + revisions as supplied by us, then you must refer to it as "HYDRA + derived", or as "a variation of HYDRA", or words to that effect. + + + Hydra protocol design and HydraCom driver: Hydra protocol design: + Arjen G. Lentz Joaquim H. Homrighausen + LENTZ SOFTWARE-DEVELOPMENT 389, route d'Arlon + Langegracht 7B L-8011 Strassen + 3811 BT Amersfoort Luxembourg + The Netherlands + FidoNet 2:283/512, AINEX-BBS +31-33-633916 FidoNet 2:270/17 + arjen_lentz@f512.n283.z2.fidonet.org joho@ae.lu + + Please feel free to contact us at any time to share your comments about our + software and/or licensing policies. ++ +Go Back + + + + diff --git a/html/license/index.htm b/html/license/index.htm index d767ba44..184e2225 100644 --- a/html/license/index.htm +++ b/html/license/index.htm @@ -1,4 +1,5 @@ + @@ -32,7 +33,7 @@ Michiel Broek. -Back to Index +Back to Index diff --git a/html/license/jam.html b/html/license/jam.html index 80e415f9..e8c76045 100644 --- a/html/license/jam.html +++ b/html/license/jam.html @@ -1,78 +1,79 @@ - - -
- --------------------------------------------------------------------- - JAM(mbp) - The Joaquim-Andrew-Mats Message Base Proposal - --------------------------------------------------------------------- - Copyright 1993 Joaquim Homrighausen, Andrew Milner, - Mats Birch, Mats Wallin. - ALL RIGHTS RESERVED. - --------------------------------------------------------------------- - - - ===================================================================== - LEGAL NOTICE - --------------------------------------------------------------------- - - The JAM(mbp) documentation and JAM API and information attached - hereto, hereafter referred to as JAM, is protected by applicable - copyright laws and international treaty provisions. JAM is provided - "as is", without warranty of any kind or fitness for a particular - purpose, either expressed or implied, all of are hereby explicitly - disclaimed. The authors only guarantees that JAM will occupy disk - space. - - The entire risk as to the quality and performance of JAM is with you. - Should JAM prove defective or incorrect, you assume the entire cost - of all necessary servicing, repair, and/or correction. In no event - shall the authors be liable to the you or anyone else for any damages - or costs, including, but not limited to, any lost profits, lost - savings, lost income, lost information, loss of the right to use JAM, - or other incidental or consequential damages arising out of the use - or inability to use JAM. - - All information provided in JAM is subject to change without further - notice. - - JAM may be published and distributed to other people as long as no - part of it is modified by any means, this includes translation to - any other language (technical or social), and as long as no charges - are applied (including but not limited to trading). This information - may not be used to reverse engineer any application developed by the - authors. - - All applications that support JAM must include one of the following - notices in their documentation and somewhere in the product's credit - section: - - "JAM(mbp) - Copyright 1993 Joaquim Homrighausen, Andrew Milner, - Mats Birch, Mats Wallin. - ALL RIGHTS RESERVED." - - or - - "This product uses the JAM(mbp) API - - Copyright 1993 Joaquim Homrighausen, Andrew Milner, Mats Birch, - Mats Wallin. ALL RIGHTS RESERVED." - - All trademarks are trademarks or registered trademarks of their - respective holders. -- - Go Back - - - - + + + +
+ --------------------------------------------------------------------- + JAM(mbp) + The Joaquim-Andrew-Mats Message Base Proposal + --------------------------------------------------------------------- + Copyright 1993 Joaquim Homrighausen, Andrew Milner, + Mats Birch, Mats Wallin. + ALL RIGHTS RESERVED. + --------------------------------------------------------------------- + + + ===================================================================== + LEGAL NOTICE + --------------------------------------------------------------------- + + The JAM(mbp) documentation and JAM API and information attached + hereto, hereafter referred to as JAM, is protected by applicable + copyright laws and international treaty provisions. JAM is provided + "as is", without warranty of any kind or fitness for a particular + purpose, either expressed or implied, all of are hereby explicitly + disclaimed. The authors only guarantees that JAM will occupy disk + space. + + The entire risk as to the quality and performance of JAM is with you. + Should JAM prove defective or incorrect, you assume the entire cost + of all necessary servicing, repair, and/or correction. In no event + shall the authors be liable to the you or anyone else for any damages + or costs, including, but not limited to, any lost profits, lost + savings, lost income, lost information, loss of the right to use JAM, + or other incidental or consequential damages arising out of the use + or inability to use JAM. + + All information provided in JAM is subject to change without further + notice. + + JAM may be published and distributed to other people as long as no + part of it is modified by any means, this includes translation to + any other language (technical or social), and as long as no charges + are applied (including but not limited to trading). This information + may not be used to reverse engineer any application developed by the + authors. + + All applications that support JAM must include one of the following + notices in their documentation and somewhere in the product's credit + section: + + "JAM(mbp) - Copyright 1993 Joaquim Homrighausen, Andrew Milner, + Mats Birch, Mats Wallin. + ALL RIGHTS RESERVED." + + or + + "This product uses the JAM(mbp) API - + Copyright 1993 Joaquim Homrighausen, Andrew Milner, Mats Birch, + Mats Wallin. ALL RIGHTS RESERVED." + + All trademarks are trademarks or registered trademarks of their + respective holders. ++ +Go Back + + + + diff --git a/html/menus/control.html b/html/menus/control.html index b493a2c1..06f37633 100644 --- a/html/menus/control.html +++ b/html/menus/control.html @@ -1,4 +1,5 @@ + @@ -118,9 +119,9 @@ For example: ^B32000^BThis is the text^B
- Back +Back diff --git a/html/menus/menu0.html b/html/menus/menu0.html index 9716fa4a..1df6ebe8 100644 --- a/html/menus/menu0.html +++ b/html/menus/menu0.html @@ -1,4 +1,5 @@ +
@@ -172,9 +173,9 @@- Document: fsc-00xx - Version: 0.6 - Date Aug 30, 1995 - Title: Implementation and Usage of FileFind Utilities - Authors: Robert Williamson FidoNet#1:167/104.0 robert@ecs.mtlnet.org - - Intro - - A portion of the document is derived from information in - AllFix.DOC by Harald Harms @ 2:281/910 - with additional sections from - FQuery.DOC by Robert Williamson @ 1:167/104 - - The MSdos program ALLFIX by Harald Harms first introduced the idea - of searching for files via echomail. The term applied to this function - is 'FileFind'. A FileFind system allows sysops, points and BBS users - to search for files by placing a message to 'ALLFIX' in an echo - designated for the purpose of finding files. All FTN sites running a - FileFind processor which is configured to scan that echo will reply to - that user if there any files matching his query. This system provides - a method for searching many FTN sites throughout the world, with a - single message. - - FileFind programs work by either scanning through defined message - bases or scanning packets for defined AREA tagnames for messages to the - default name ALLFIX. All FileFind programs MUST respond to the name - ALLFIX, but may also respond to the name FILEFIND and the name of the - particular FileFind program in use or defined for the echo. The - FileFind program will process these messages, examining the Subject - field for search queries. If any valid query is found, the FileFind - program will search the sites files database for files matching the - users's query. - - If the FileFind program finds any matches, it will generate a reply - containing a list of the files found, and some basic information ABOUT - the system posting the reply. When the user who initially wrote the - request reads the reply, he will then be able to decide if any of the - reported files meet his needs, and from the ABOUT included in the - reply, learn where and how he may get those files. - - - FileFind Query Message Structure - - To: name_of_FileFind program - - The message must be addressed to ALLFIX so that all FileFind programs - can respond. To use features specific to a particular FileFind - program, or to limit the responses to a particular platform, the - message should be addressed to that program's name. Some FileFind - programs will respond to more than two names. - - Subject: - A space-separated list of file specifications, keywords or quoted - strings. - - keyword - single word preceeded by a '/' with no intervening spaces, - must be at least 3 characters, not including the '/'. - a keyword search is in actually a substring search of the - site's filelist. - - description - string enclosed in double-quotes, - if a single word, must be more than 3 characters. - - filespec - single word, no spaces, no double-quotes or preceding /, - must be at least 3 characters, not including any wildcard - or pattern matching charcaters, such as '*'. - Messages addressed to ALLFIX must not have any embedded - pattern matching characters. - - - The minimum number of characters for description, keyword and - filespec queries is an implementation detail of the FileFind program. - These values should be configurable, but should never be settable to - values of less than 3. - - Each implementation should allow the operator the ability to - configure a list of disallowed keywords. - - NetMail Queries - - Some FileFind programs may also have the ability to process file - search queries received as netmail and addressed to the name of the - particular FileFInd program with this capability. In this case, all - replies are via netmail also. - - NetMail Commands - FileFind Netmail commands are identifed by a leading '%'. - Implementation of netmail commands is optional. If implemented, - compliant FileFind utilities should be able to process the following - minimum NetMail command set. - - - %HELP - netmail only, returns an extended help text for the - FileFind program, the ABOUT of the the site and a list - of MAGIC freqable names. - %ABOUT - netmail only, returns the ABOUT of the site and a full - or %MAGIC list of MAGIC names. - - %NEWFILES - netmail only, returns the NEWFILES list of the site - or %NEW via netmail. - - Extended NetMail Commands: - Implementation of the following netmail commands is optional and - not required for compliance with the FileFind NetMail Command set. - - %REPORT- - Go Back - - - - + + + +- - sends a configuration report for echo - this allows an echo moderator to check if a site running - a FileFind utility is compliant with the rules of the - filefind echo. - - %REQUEST - - if found, will place requested file on hold for remote - site - - %UUREQUEST - - if found, and the filesize after uuencoding is less - than 60K, it will be sent as multiple netmail messages - - - The Site ABOUT - - Obviously, a system that neither accepts file requests nor allows - users to download on their first call should not be responding to - FileFind messages. If there are any limitations for the caller to - acquire any of the files that the site has advertised as being - available in it's FileFind response, these limitations MUST be listed - in the reply. This information should be included in the ABOUT file - that the FileFind program user creates. - - The site ABOUT should contain the following information. The - FileFind program implementor should instruct his users on these - requirements. - - - sitename - - site operator's name - - complete phonenumber - - baud rate - - hours during which filerequests are accepted, if at all - - hours during which users can download - - conditions for file requests and user downloads - NOTE: the above information should be within the first 14 lines. - optional: - - a list a MAGIC names - - an indication if magic names are also available to terminal users. - - Searching for Files and Creating Replies - - The method used by the FileFind program to search for requests is - up to the implementor. However, if searching a list, the FileFind - program should confirm the actual existance of all files that match the - query specification. - - The FileFind program should only process description strings, - filespecs or keywords that contain more than 3 valid characters and - should have configuration options to define greater minimum lengths on - a per-echo basis. - - For filespecs, the wildcard character '*' IS considered a valid - specification as well as the '?' wildcard, but only the '?' is to be - counted as a character when determining the length of query. File - extensions are not necessary and any characters AFTER a '*' are to be - ignored. The FileFind program should be configurable so as to allow - replacement all of the file extensions with '.*' or '#?' dependant on - platform. This results in queries being independant of the various - archivers in use. - - Replies - - Replies created by FileFind utilities are expected to be in - compliance with the following FTN specifications: - FTS-0001 - packed message format - FTS-0009 - MSGID/REPLY - FSC-0046 - PID and tear line - - In addition, a FileFind utility may use the FID: control line for - any information needed that cannot be put in a PID: without violating - that specification. - - ^AFID: ascii text CR - - Must be less than 80 characters including ^A and terminating CR. - - There are three ways in which the FileFind program can create replies: - - write the replies in the echo in which the query appeared. - - write the replies in an echo that has been specifically - designated for that purpose in the particular FTN or for - a gorup of echos in that FTN. - - reply via routed netmail. - - Since each FTN site connected to a particular FileFind program area - is capable of creating an information reply, there is much concern as - to the amount of traffic that can be generated, FileFind program - developers must be sensitive to these concerns by providing the means - to their users to limit the traffic on a per-echo basis. For example, - various FileFind echos have rules limiting the size or number of - replies, or the length of the system information that may be included - in a reply. - - Limiting replies - - It is strongly suggested that some default limitations be built-in. - - Limiting Site Header (ABOUT): - - If the site's ABOUT, (the text that has been configured in order to - add the system's information and Magic names list to the reply), is - greater than 14 lines, the remainder should NOT be posted. A line - should be added to the response indicated this, and the user may be - invited to either Freq or download the MAGIC name's ABOUT or MAGIC, for - a full list of magic names. The FileFind program may optionally send - the full system information and magic name list via routed netmail. - - Limiting Match List due to ambiguity of query: - - If the list of matches (note: not the size of the message itself) - is greater than 32K, the FileFind program should post a message to the - user to indicate that his query may have been too ambiguous and perhaps - invite him to freq or download the MAGIC name FILES for a full list. - - Splitting Match List into Multiple Messages: - - If the list of matches is greater than 10K, it should be split into - multiple messages of no more than 8K. Although the backbone permits - messages up to 16K in length, 8K is a more readable size. Only the - first split message may contain the ABOUT information of the site. - Each message must be given both a unique Subject field (eg: prepended - by "Part n/n") and a unique MSGID:. This because some tossers may use - either or both for dupe detection. - - Limiting Number of Split Messages: - - If the number of messages is greater than the preset limit of the - echo, and the FileFind Program does not have an option to forward the - replies via netmail, the replies should be discarded and the user - informed that his request may have been too amibiguous. - - - NetMail Reply: - - The FileFind program may have an option to forward all replies via - routed netmail, or to do so under certain conditions as outlined above. - Obviously, if the FileFind program can process netmail queries, it MUST - respond via netmail. - - User NetMail Reply Request: - - Alternativly the user can request a netmail reply for his echomail - query by preceeding the query with either "%" or "!". - eg; - Subject: % /fsc /fts - - If the FileFind program does not support this feature, it must - ignore any echomail query message that has a "%" or "!" as the first - WORD of the Subject field. - - Second Reply or Extended Response Request: - - The FileFind site indicates availablility of Second Reply by - placing the string 'program_name 4d_address' in the From: field of the - message. - eg: FROM: FQUERY 1:167/104.0 - - When a user replies to a FileFind reply, the message will be to the - FileFind program @ {network address}. When processing the FileFind - conferences, the FileFind program will treat any message to itself that - includes the site address as a Second Reply Request. - - If this feature is available, the FileFind program will include up - to a maximum of 15 files (maximum 12K match list) in it's replies. If - the user wants a more detailed listing, he simply replies to the - FileFind program's reply. Only the system that posted the original - reply will respond to that new request. This second, specific reply, - will contain up to 50 files (32K of matchlist) either including or - SKIPPING the first 15. These numbers may be replaced by byte limits in - some implementations. - - No Second Reply in Designated Reply Echo: - - The Designated Reply Echo method does not allow replies to be made, - because the FileFind program may not be permitted to scan a Designated - Reply Echo. The FileFind program should automatically report up to 50 - files for any requests. Therefore, the traffic limitaion features may - be disabled for networks that require the FileFind program to reply in - a Designated Reply Echo, and disallow Second Reply in that echo. - - Disable Local Messages: - - The FileFind program must be able to to disable the processing of - local messages. What this means is that the FileFind program will not - process any messages generated on that FTN site, including messages by - the sysop using an offline reader, or by a site's BBS or off-line - reader users. This should NOT exclude messages from a site's points. - - - Limit by Age: - - The FileFind program must be configurable so that the operator can - limit the age of an query message that is acceptable for processing. - This should be in number of days. The FileFind program may be - configured to process all the FileFind requests regardless of how old - they are. Age should never be greater than 365 days. - - LinkMGR Support: - Implmentors may choose to support the LinkMGR proposal for netmail - queries and commands. In this proposal, the queries and commands do - not appear in the subject field but rather, in the the BODY of the - message. The subject field wil contain the LinkMGR password. - Use of the LinkMGR method allows the user to send multiple commands - to the fIleFind program. -
+ Document: fsc-00xx + Version: 0.6 + Date Aug 30, 1995 + Title: Implementation and Usage of FileFind Utilities + Authors: Robert Williamson FidoNet#1:167/104.0 robert@ecs.mtlnet.org + + Intro + + A portion of the document is derived from information in + AllFix.DOC by Harald Harms @ 2:281/910 + with additional sections from + FQuery.DOC by Robert Williamson @ 1:167/104 + + The MSdos program ALLFIX by Harald Harms first introduced the idea + of searching for files via echomail. The term applied to this function + is 'FileFind'. A FileFind system allows sysops, points and BBS users + to search for files by placing a message to 'ALLFIX' in an echo + designated for the purpose of finding files. All FTN sites running a + FileFind processor which is configured to scan that echo will reply to + that user if there any files matching his query. This system provides + a method for searching many FTN sites throughout the world, with a + single message. + + FileFind programs work by either scanning through defined message + bases or scanning packets for defined AREA tagnames for messages to the + default name ALLFIX. All FileFind programs MUST respond to the name + ALLFIX, but may also respond to the name FILEFIND and the name of the + particular FileFind program in use or defined for the echo. The + FileFind program will process these messages, examining the Subject + field for search queries. If any valid query is found, the FileFind + program will search the sites files database for files matching the + users's query. + + If the FileFind program finds any matches, it will generate a reply + containing a list of the files found, and some basic information ABOUT + the system posting the reply. When the user who initially wrote the + request reads the reply, he will then be able to decide if any of the + reported files meet his needs, and from the ABOUT included in the + reply, learn where and how he may get those files. + + + FileFind Query Message Structure + + To: name_of_FileFind program + + The message must be addressed to ALLFIX so that all FileFind programs + can respond. To use features specific to a particular FileFind + program, or to limit the responses to a particular platform, the + message should be addressed to that program's name. Some FileFind + programs will respond to more than two names. + + Subject: + A space-separated list of file specifications, keywords or quoted + strings. + + keyword - single word preceeded by a '/' with no intervening spaces, + must be at least 3 characters, not including the '/'. + a keyword search is in actually a substring search of the + site's filelist. + + description - string enclosed in double-quotes, + if a single word, must be more than 3 characters. + + filespec - single word, no spaces, no double-quotes or preceding /, + must be at least 3 characters, not including any wildcard + or pattern matching charcaters, such as '*'. + Messages addressed to ALLFIX must not have any embedded + pattern matching characters. + + + The minimum number of characters for description, keyword and + filespec queries is an implementation detail of the FileFind program. + These values should be configurable, but should never be settable to + values of less than 3. + + Each implementation should allow the operator the ability to + configure a list of disallowed keywords. + + NetMail Queries + + Some FileFind programs may also have the ability to process file + search queries received as netmail and addressed to the name of the + particular FileFInd program with this capability. In this case, all + replies are via netmail also. + + NetMail Commands + FileFind Netmail commands are identifed by a leading '%'. + Implementation of netmail commands is optional. If implemented, + compliant FileFind utilities should be able to process the following + minimum NetMail command set. + + + %HELP - netmail only, returns an extended help text for the + FileFind program, the ABOUT of the the site and a list + of MAGIC freqable names. + %ABOUT - netmail only, returns the ABOUT of the site and a full + or %MAGIC list of MAGIC names. + + %NEWFILES - netmail only, returns the NEWFILES list of the site + or %NEW via netmail. + + Extended NetMail Commands: + Implementation of the following netmail commands is optional and + not required for compliance with the FileFind NetMail Command set. + + %REPORT <tagname> + - sends a configuration report for echo+ +Go Back + + + + diff --git a/html/misc/fileid.html b/html/misc/fileid.html index 2c413751..ce861971 100644 --- a/html/misc/fileid.html +++ b/html/misc/fileid.html @@ -1,386 +1,387 @@ - - -+ this allows an echo moderator to check if a site running + a FileFind utility is compliant with the rules of the + filefind echo. + + %REQUEST <filename> + - if found, will place requested file on hold for remote + site + + %UUREQUEST <filename> + - if found, and the filesize after uuencoding is less + than 60K, it will be sent as multiple netmail messages + + + The Site ABOUT + + Obviously, a system that neither accepts file requests nor allows + users to download on their first call should not be responding to + FileFind messages. If there are any limitations for the caller to + acquire any of the files that the site has advertised as being + available in it's FileFind response, these limitations MUST be listed + in the reply. This information should be included in the ABOUT file + that the FileFind program user creates. + + The site ABOUT should contain the following information. The + FileFind program implementor should instruct his users on these + requirements. + + - sitename + - site operator's name + - complete phonenumber + - baud rate + - hours during which filerequests are accepted, if at all + - hours during which users can download + - conditions for file requests and user downloads + NOTE: the above information should be within the first 14 lines. + optional: + - a list a MAGIC names + - an indication if magic names are also available to terminal users. + + Searching for Files and Creating Replies + + The method used by the FileFind program to search for requests is + up to the implementor. However, if searching a list, the FileFind + program should confirm the actual existance of all files that match the + query specification. + + The FileFind program should only process description strings, + filespecs or keywords that contain more than 3 valid characters and + should have configuration options to define greater minimum lengths on + a per-echo basis. + + For filespecs, the wildcard character '*' IS considered a valid + specification as well as the '?' wildcard, but only the '?' is to be + counted as a character when determining the length of query. File + extensions are not necessary and any characters AFTER a '*' are to be + ignored. The FileFind program should be configurable so as to allow + replacement all of the file extensions with '.*' or '#?' dependant on + platform. This results in queries being independant of the various + archivers in use. + + Replies + + Replies created by FileFind utilities are expected to be in + compliance with the following FTN specifications: + FTS-0001 - packed message format + FTS-0009 - MSGID/REPLY + FSC-0046 - PID and tear line + + In addition, a FileFind utility may use the FID: control line for + any information needed that cannot be put in a PID: without violating + that specification. + + ^AFID: ascii text CR + + Must be less than 80 characters including ^A and terminating CR. + + There are three ways in which the FileFind program can create replies: + - write the replies in the echo in which the query appeared. + - write the replies in an echo that has been specifically + designated for that purpose in the particular FTN or for + a gorup of echos in that FTN. + - reply via routed netmail. + + Since each FTN site connected to a particular FileFind program area + is capable of creating an information reply, there is much concern as + to the amount of traffic that can be generated, FileFind program + developers must be sensitive to these concerns by providing the means + to their users to limit the traffic on a per-echo basis. For example, + various FileFind echos have rules limiting the size or number of + replies, or the length of the system information that may be included + in a reply. + + Limiting replies + + It is strongly suggested that some default limitations be built-in. + + Limiting Site Header (ABOUT): + + If the site's ABOUT, (the text that has been configured in order to + add the system's information and Magic names list to the reply), is + greater than 14 lines, the remainder should NOT be posted. A line + should be added to the response indicated this, and the user may be + invited to either Freq or download the MAGIC name's ABOUT or MAGIC, for + a full list of magic names. The FileFind program may optionally send + the full system information and magic name list via routed netmail. + + Limiting Match List due to ambiguity of query: + + If the list of matches (note: not the size of the message itself) + is greater than 32K, the FileFind program should post a message to the + user to indicate that his query may have been too ambiguous and perhaps + invite him to freq or download the MAGIC name FILES for a full list. + + Splitting Match List into Multiple Messages: + + If the list of matches is greater than 10K, it should be split into + multiple messages of no more than 8K. Although the backbone permits + messages up to 16K in length, 8K is a more readable size. Only the + first split message may contain the ABOUT information of the site. + Each message must be given both a unique Subject field (eg: prepended + by "Part n/n") and a unique MSGID:. This because some tossers may use + either or both for dupe detection. + + Limiting Number of Split Messages: + + If the number of messages is greater than the preset limit of the + echo, and the FileFind Program does not have an option to forward the + replies via netmail, the replies should be discarded and the user + informed that his request may have been too amibiguous. + + + NetMail Reply: + + The FileFind program may have an option to forward all replies via + routed netmail, or to do so under certain conditions as outlined above. + Obviously, if the FileFind program can process netmail queries, it MUST + respond via netmail. + + User NetMail Reply Request: + + Alternativly the user can request a netmail reply for his echomail + query by preceeding the query with either "%" or "!". + eg; + Subject: % /fsc /fts + + If the FileFind program does not support this feature, it must + ignore any echomail query message that has a "%" or "!" as the first + WORD of the Subject field. + + Second Reply or Extended Response Request: + + The FileFind site indicates availablility of Second Reply by + placing the string 'program_name 4d_address' in the From: field of the + message. + eg: FROM: FQUERY 1:167/104.0 + + When a user replies to a FileFind reply, the message will be to the + FileFind program @ {network address}. When processing the FileFind + conferences, the FileFind program will treat any message to itself that + includes the site address as a Second Reply Request. + + If this feature is available, the FileFind program will include up + to a maximum of 15 files (maximum 12K match list) in it's replies. If + the user wants a more detailed listing, he simply replies to the + FileFind program's reply. Only the system that posted the original + reply will respond to that new request. This second, specific reply, + will contain up to 50 files (32K of matchlist) either including or + SKIPPING the first 15. These numbers may be replaced by byte limits in + some implementations. + + No Second Reply in Designated Reply Echo: + + The Designated Reply Echo method does not allow replies to be made, + because the FileFind program may not be permitted to scan a Designated + Reply Echo. The FileFind program should automatically report up to 50 + files for any requests. Therefore, the traffic limitaion features may + be disabled for networks that require the FileFind program to reply in + a Designated Reply Echo, and disallow Second Reply in that echo. + + Disable Local Messages: + + The FileFind program must be able to to disable the processing of + local messages. What this means is that the FileFind program will not + process any messages generated on that FTN site, including messages by + the sysop using an offline reader, or by a site's BBS or off-line + reader users. This should NOT exclude messages from a site's points. + + + Limit by Age: + + The FileFind program must be configurable so that the operator can + limit the age of an query message that is acceptable for processing. + This should be in number of days. The FileFind program may be + configured to process all the FileFind requests regardless of how old + they are. Age should never be greater than 365 days. + + LinkMGR Support: + Implmentors may choose to support the LinkMGR proposal for netmail + queries and commands. In this proposal, the queries and commands do + not appear in the subject field but rather, in the the BODY of the + message. The subject field wil contain the LinkMGR password. + Use of the LinkMGR method allows the user to send multiple commands + to the fIleFind program. +
-FILEID.TXT v1.8 by Richard Holler [CIS 73567,1547] -Last Revision 05/05/94 - -This text file was prepared at the request of the ASP (Association of -Shareware Professionals), but the information contained in it may be of -value to any shareware author. - - -FILE_ID.DIZ INFORMATION ------------------------ -Basically, the FILE_ID.DIZ file is a straight ASCII text file, distributed -inside your distribution archive file along with your program files, which -contains a description of your program. This file will be used by most BBS -(Bulletin Board System) softwares for the online file description of your -file. We recommend that the FILE_ID.DIZ file be used in all of your -distribution archives. - -This text file contains a description of the FILE_ID.DIZ file, as well as a -description of the recommended distribution archive format. - - -WHY SHOULD YOU USE FILE_ID.DIZ? -------------------------------- -The use of this file will insure that the online description of your -program will be in your own words (and who better to describe your program -than yourself?), and that it will remain the same no matter how many -different people upload your file to various BBS systems. - -As more and more BBS software makes use of this file, you can be assured -that your own description will replace such online descriptions as "Cool -Program" or "OK utility, but needs better ..." - -Please note that the ASP Hub Network, the Author Direct FDN (File -Distribution Network), and the majority of other electronic distribution -services *REQUIRE* that a valid FILE_ID.DIZ file be contained in your -submitted distribution archive. If your file doesn't contain a valid -FILE_ID.DIZ file, then it simply won't be distributed by these services. -Furthermore, most BBS sysops will not accept uploads of files which do not -contain a valid FILE_ID.DIZ file, so you automatically lose out on that -distribution as well. - - -DESCRIPTION: ------------- -FILE_ID.DIZ was created by Clark Development for use with their PCBDescribe -utility, as a means for BBS callers to upload a file without having to -manually type in a file description. It also ensures that the online -description is always the same regardless of the number of different BBS -systems the file is posted on. It has since been accepted by the BBS -industry more-or-less as the "standard" file description source. (The -extension of "DIZ" actually stands for "Description In Zip"). - -NOTE: The FILE_ID.DIZ file *MUST* be named exactly that, and *NOT* -something like- - Go Back - - - - + + + +.DIZ. It will *ONLY* be used if it is named -FILE_ID.DIZ! - -The FILE_ID.DIZ file is nothing more than a straight ASCII text file which -contains the full description of the archived file containing it. It is -used by most popular BBS software to describe your program, rather than -using the description supplied by the person that uploaded your file. It -should be placed *INSIDE* your distribution archive file. - -The BBS software will "look" inside the archive file. If a FILE_ID.DIZ file -is found, it will replace any existing online file description with the -text contained in FILE_ID.DIZ. It is an excellent method for making sure -that your program files are described the way that "you" want them -described. Even sysops who's software can't automatically make use of the -FILE_ID.DIZ file have found it to be an excellent source for their manually -added file descriptions. - - -STRUCTURE: ----------- -The file consists of straight ASCII text, up to 10 lines of text, each line -being no more than 45 characters long. It should *NOT* contain any blank -lines, any form of centering or formatting, or any Hi-ASCII or ANSI -characters. (i.e. it should ONLY contain alpha & numeric characters). - -We recommended that it consist of 5 basic parts: - - 1. the proper name of your program - 2. the version number - 3. the "ASP" identifier (optional, for ASP members) - 4. the description separator - 4. the description - -All of the above parts should be separated by a single "space". - -PROGRAM NAME: To set it apart from the rest, it is recommended that you use -ALL CAPS for the program name. - -VERSION NUMBER: The version number should be in the form of "v12.34". - -ASP IDENTIFIER: If you are an ASP author, we recommend that an " " -identifying mark be added after the version number, to identify your -product as an ASP-authored product. - -DESCRIPTION SEPARATOR: To separate the actual description text, insert a -simple "-" (dash/minus) character after the ASP identifier (or version -number, if not using the ASP identifier), and in front of the description -text. - -DESCRIPTION: You should attempt to FULLY describe your product, including -its most important functions and features. Be sure to include anything -which will separate your program from it's competition, and make the BBS -user want to download your file. Also try to include any hardware or -software requirements that your product may have. - -You should try to use the first 2 lines of the text to give a basic -description of your program. This is helpful for sysops who's BBS software -limits them to less than 10 lines, 45 characters. Sysops who are limited to -using shorter descriptions can simply use the 1st two lines and truncate -the rest. Thus, you can basically still supply your own description for BBS -software which does not actually utilize the FILE_ID.DIZ feature. - -The remaining lines of text can be used to elaborate on the programs -features, enhancements from the prior version, information concerning -multi-file sets. Please note that older versions of some BBS software can -only use 8 lines of text. It is advisable that you create your FILE_ID.DIZ -file so that the file can be truncated to various line lengths without -destroying it's usefulness. - - -EXAMPLE -------- -MY PROGRAM v1.23 - A program which will -do anything for anybody. Will run in only 2k -of memory. Can be run from the command line, -or installed as a TSR. Completely menu- -driven. Version 1.23 reduces the previous 4k -memory requirements, and adds an enhanced -graphical user interface. Also, MY PROGRAM -now contains Windows and DESQview support. -Coming soon - an OS/2 version. -From Do-It-All Software, Inc. $15.00 - - -MULTIPLE DISK INFO ------------------- -Please note that if your distribution archive requires multiple archive -files, you should create a separate, specific FILE_ID.DIZ file for each -archive. This can be utilized to describe the various contents of each -archive, and to identify each disk in the set. For example, the FILE_ID.DIZ -file for disk #1 could contain: - - "MY PROGRAM v1.23 Program Executable - Files - Disk 1 of 2" - [followed by detailed description text] - -while the FILE_ID.DIZ file for disk #2 could contain: - - "MY PROGRAM v1.23 Documentation Files - - Disk 2 of 2" - [followed by more detailed description text] - -Optionally, you could also create a "complete" FILE_ID.DIZ file for the -first disk, which would fully describe the program in detail, and identify -it as Disk 1 of x. Then, for each remaining file in the set, simply include -the Program Name, version number, ASP identifier, and the disk number (i.e. -"MY PROGRAM v1.23 Disk 2 of x"). - - -ADDITIONAL INFO ---------------- -Please don't be tempted to use fancy graphic or ANSI sequences in the -FILE_ID.DIZ file, as most BBS software will not allow this, and will render -your FILE_ID.DIZ file useless. Also, don't be tempted to simply copy your -program description file to FILE_ID.DIZ. Attempting to "format" your -FILE_ID.DIZ file (i.e line centering, right & left justification, etc) will -also cause unexpected results, especially for BBS software which re-formats -descriptions to other than 10line/45char. - -Fred Hill has written a freeware utility which interactively creates -a valid FILE_ID.DIZ file. The file is called DIZGEN.ZIP and can be found on -CompuServe (GO IBMBBS, Library 2) as well as on many fine BBS systems. I -highly recommend that you download a copy of this wonderful utility for -creating your FILE_ID.DIZ files. - -<*><*><*><*><*><*><*><*><*><*><*><*><*><*><*><*><*><*><*><*><*><*><*><*> - -The following is a recommendation for the structure and contents of -distribution archives prepared for use on BBS systems. - - -DISTRIBUTION DISK RECOMMENDATIONS ---------------------------------- -The following are recommendations for preparing your program files for -distribution to Bulletin Board Systems (BBSs) via the ASP's distribution -services, as well as other methods. - -Two varieties of program files are defined here: - -1) Program files which utilize an "install" utility and self-extracting -program archives (later referred to as "Author-Installed Programs"). - -2) Programs files which do not use install utilities or self-extracting -archives (later referred to as "User-Installed Programs"). - - -AUTHOR-INSTALLED PROGRAMS: --------------------------- -These programs require a bit more work from the author, but will eliminate -many user mistakes, especially in programs which require complicated -setups. - -Most "installation" utility programs will make use of program files which -have been "archived" into Self-Extracting (SFX) archives. We will attempt -to define which files should be contained in the Self-Extracting archives, -and which files should not. - -1. Files which should be contained in the self-extracting program file -archive: - - a. All program-specific executable files. - b. Any required configuration and/or data files required by the - program. - c. Program documentation files. Optionally, these may be left - outside of the self-extracting archive, in order to allow - them to be viewed/read by the various archive viewing utlities. - d. Any other program-specific files that are required for the - operation of the program. - -2. The files described above should be compiled into a self-extracting -archive file, which will then be extracted by the install utility. - -NOTE: the author is required to abide by any distribution requirements -specified by the archive utility author, and to obtain any required -distribution rights necessary. Please check to see if distribution rights -are required for your archive utility choice. - -3. Files which should NOT be contained in the self-extracting program file -archive: - - a. The install utility itself (obviously). - b. The FILE_ID.DIZ file. (described in detail in the section - preceding this one) - c. Any distribution/information files, such as VENDOR.TXT, - SYSOP.TXT, etc. - d. Any description or information file, such as DESCRIBE.TXT. - e. A user file (such as README.1ST), which should explain how - to use the install utility, what the user should expect - during the installation, and any preparation that the user - should make prior to the installation. This file might also - contain a brief description of your program, in case the user - is able to read the documentation files in the distribution - archive prior to downloading (many BBS systems offer this - ability to the user). - -4. The actual distribution archive file (described below) should then -contain the install utility, the self-extracting program archive, and the -files described in #3 above. - - -USER-INSTALLED PROGRAMS: ------------------------- -This type of distribution archive is much simpler than the Author-Installed -variety. It should simply be an archive file, containing all of the files -for the program described above. - -Since this type of program requires the user to do all of the installation -manually, it should contain very specific and detailed information -regarding the installation requirements (such as INSTALL.TXT). - - -THE DISTRIBUTION ARCHIVE FILE: ------------------------------- -The actual distribution archive file should merely be an archive file -containing the files described above. For BBS distribution, this archive -should be of the standard archive format, and -NOT- a self-extracting -archive. Many sysops will not allow self-extracting archives, and most BBS -software will not allow self-extracting archives to be uploaded. - -There are many popular archive utilities available, such as PKZIP, LHA, -LHARC, ARJ, etc. Most BBS systems are capable of handling archives in -virtually any format. However, you should be aware that most BBS systems -will convert your archive format to the format of choice by the sysop. By -following the methods described above, this conversion process should not -affect your program, or any self-extracting files which are contained -within your distribution archive file. - -You should also retain the default archive file extension defined by the -archive utility. For example, PKZIP uses a ".ZIP", LHARC uses "LZH", etc. -Changing the file extension may cause the BBS software to delete your file -because it doesn't recognize the format. - -For the actual filename for your distribution archive, it is recommended -that the program filename be limited to 6 characters to represent the -program's name (i.e. MYPROG could represent "My Program"). This should be -followed by 2 numeric digits which will represent the version number of -your release. Even if this is your initial release it should include the -version number in the filename (i.e. MYPROG10.ZIP would indicate the -program called "My Program" version 1.0). - -Please note that CompuServe limits filenames to only 6 characters. By -limiting the file "name" to 6 characters, you will easily be able to rename -the archive for CompuServe uploading by simply removing the 2-digit version -identifier, to make the file compatible with CompuServe libraries. - -By including the 2-digit version number in the archive filename, it will be -very easy for both the user and the sysop (and yourself) to identify older -versions of your program. - - -MULTIPLE DISTRIBUTION ARCHIVES ------------------------------- -At one time, it was recommended that your final distribution archive not be -larger than 350k, so that it would fit on a single 360k floppy disk and -still leave room for any distribution files necessary for Disk Vendors. -(i.e. Disk Vendors will often include their own GO.BAT file, or other -various small files to help their customers install the software). This -limitation is slowly falling by the wayside as more and more computer -systems have 3.5" floppy disk drives as standard. - -If your program is large enough to require more than one distribution -archive, it is recommended that your filename be limited to 5 characters -rather than 6 as described above. Following the 5-character name should be -the same 2-digit version number. Then, append a single "letter" to identify -the disk (i.e. MYPGM10A.ZIP, MYPGM10B.ZIP, etc.). For uploading to -CompuServe, these filenames may then be shortened to 6 characters by -removing the version identifiers (i.e. MYPGMA.ZIP, MYPGMB.ZIP). However, -for CompuServe it is recommended that you simply create a single -distibution file, and eliminate the multi-part file set. - -If your program requires multiple distribution archives, -BE SURE- to -create separate FILE_ID.DIZ files for each distribution archive. Also, each -FILE_ID.DIZ file should contain disk number information pertaining to each -individual archive (i.e. Disk 1 of 3, Disk 2 of 3, etc.). - - -THE DISTRIBUTION DISK ---------------------- -It is recommended that your distribution disk simply contain a ZIPd version -of your product. However, If you choose to supply "unarchived" files on a -distribution disk for Disk Vendor use, it is _VERY_ important that you -specify in your documentation a suggested archive filename, so that BBS -sysops can create archived files with the proper author-specified -filenames. This information should be contained in your SYSOP.TXT (or -VENDOR.TXT) file. If you don't supply a suggested archive file name, the -sysops will be forced to create the name themselves, thus you may end up -with thousands of versions of your products on BBS systems all over the -world, but all with different filenames. - -Please note that the ASP Hub Network, and nearly every other electronic -distribution service *REQUIRE* that your files be submitted as an archived -file, using the ZIP format. Also note that many BBS sysops will not go to -the trouble of ZIPing your unarchived files for you. If you don't supply -them with an archived distribution version of your product, it might not -get distributed by BBSs. - -If you supply your own disk labels, it is recommended that the ASP logo, or -at least the initials "ASP" be included on the label, so that anyone can -immediately identify your disk as an ASP member's software. - - -SUMMARY -------- -Your distribution disk should now be ready to submit to the various BBSs, -distribution services, and Disk Vendors. - -You may choose to create a separate distribution disk for use by BBSs and -Disk Vendors. However, if you follow the above steps in preparing your -distribution archive file, a separate "Disk Vendor" disk is probably not -necessary. The majority of disk vendors will be able to accept your -distribution file/disk if it is prepared in the above described format. - -
+FILEID.TXT v1.8 by Richard Holler [CIS 73567,1547] +Last Revision 05/05/94 + +This text file was prepared at the request of the ASP (Association of +Shareware Professionals), but the information contained in it may be of +value to any shareware author. + + +FILE_ID.DIZ INFORMATION +----------------------- +Basically, the FILE_ID.DIZ file is a straight ASCII text file, distributed +inside your distribution archive file along with your program files, which +contains a description of your program. This file will be used by most BBS +(Bulletin Board System) softwares for the online file description of your +file. We recommend that the FILE_ID.DIZ file be used in all of your +distribution archives. + +This text file contains a description of the FILE_ID.DIZ file, as well as a +description of the recommended distribution archive format. + + +WHY SHOULD YOU USE FILE_ID.DIZ? +------------------------------- +The use of this file will insure that the online description of your +program will be in your own words (and who better to describe your program +than yourself?), and that it will remain the same no matter how many +different people upload your file to various BBS systems. + +As more and more BBS software makes use of this file, you can be assured +that your own description will replace such online descriptions as "Cool +Program" or "OK utility, but needs better ..." + +Please note that the ASP Hub Network, the Author Direct FDN (File +Distribution Network), and the majority of other electronic distribution +services *REQUIRE* that a valid FILE_ID.DIZ file be contained in your +submitted distribution archive. If your file doesn't contain a valid +FILE_ID.DIZ file, then it simply won't be distributed by these services. +Furthermore, most BBS sysops will not accept uploads of files which do not +contain a valid FILE_ID.DIZ file, so you automatically lose out on that +distribution as well. + + +DESCRIPTION: +------------ +FILE_ID.DIZ was created by Clark Development for use with their PCBDescribe +utility, as a means for BBS callers to upload a file without having to +manually type in a file description. It also ensures that the online +description is always the same regardless of the number of different BBS +systems the file is posted on. It has since been accepted by the BBS +industry more-or-less as the "standard" file description source. (The +extension of "DIZ" actually stands for "Description In Zip"). + +NOTE: The FILE_ID.DIZ file *MUST* be named exactly that, and *NOT* +something like <filename>.DIZ. It will *ONLY* be used if it is named +FILE_ID.DIZ! + +The FILE_ID.DIZ file is nothing more than a straight ASCII text file which +contains the full description of the archived file containing it. It is +used by most popular BBS software to describe your program, rather than +using the description supplied by the person that uploaded your file. It +should be placed *INSIDE* your distribution archive file. + +The BBS software will "look" inside the archive file. If a FILE_ID.DIZ file +is found, it will replace any existing online file description with the +text contained in FILE_ID.DIZ. It is an excellent method for making sure +that your program files are described the way that "you" want them +described. Even sysops who's software can't automatically make use of the +FILE_ID.DIZ file have found it to be an excellent source for their manually +added file descriptions. + + +STRUCTURE: +---------- +The file consists of straight ASCII text, up to 10 lines of text, each line +being no more than 45 characters long. It should *NOT* contain any blank +lines, any form of centering or formatting, or any Hi-ASCII or ANSI +characters. (i.e. it should ONLY contain alpha & numeric characters). + +We recommended that it consist of 5 basic parts: + + 1. the proper name of your program + 2. the version number + 3. the "ASP" identifier (optional, for ASP members) + 4. the description separator + 4. the description + +All of the above parts should be separated by a single "space". + +PROGRAM NAME: To set it apart from the rest, it is recommended that you use +ALL CAPS for the program name. + +VERSION NUMBER: The version number should be in the form of "v12.34". + +ASP IDENTIFIER: If you are an ASP author, we recommend that an "+ +Go Back + + + + diff --git a/html/misc/ipmailer.html b/html/misc/ipmailer.html index 63ef8587..86d103e3 100644 --- a/html/misc/ipmailer.html +++ b/html/misc/ipmailer.html @@ -1,4 +1,5 @@ +" +identifying mark be added after the version number, to identify your +product as an ASP-authored product. + +DESCRIPTION SEPARATOR: To separate the actual description text, insert a +simple "-" (dash/minus) character after the ASP identifier (or version +number, if not using the ASP identifier), and in front of the description +text. + +DESCRIPTION: You should attempt to FULLY describe your product, including +its most important functions and features. Be sure to include anything +which will separate your program from it's competition, and make the BBS +user want to download your file. Also try to include any hardware or +software requirements that your product may have. + +You should try to use the first 2 lines of the text to give a basic +description of your program. This is helpful for sysops who's BBS software +limits them to less than 10 lines, 45 characters. Sysops who are limited to +using shorter descriptions can simply use the 1st two lines and truncate +the rest. Thus, you can basically still supply your own description for BBS +software which does not actually utilize the FILE_ID.DIZ feature. + +The remaining lines of text can be used to elaborate on the programs +features, enhancements from the prior version, information concerning +multi-file sets. Please note that older versions of some BBS software can +only use 8 lines of text. It is advisable that you create your FILE_ID.DIZ +file so that the file can be truncated to various line lengths without +destroying it's usefulness. + + +EXAMPLE +------- +MY PROGRAM v1.23 <ASP> - A program which will +do anything for anybody. Will run in only 2k +of memory. Can be run from the command line, +or installed as a TSR. Completely menu- +driven. Version 1.23 reduces the previous 4k +memory requirements, and adds an enhanced +graphical user interface. Also, MY PROGRAM +now contains Windows and DESQview support. +Coming soon - an OS/2 version. +From Do-It-All Software, Inc. $15.00 + + +MULTIPLE DISK INFO +------------------ +Please note that if your distribution archive requires multiple archive +files, you should create a separate, specific FILE_ID.DIZ file for each +archive. This can be utilized to describe the various contents of each +archive, and to identify each disk in the set. For example, the FILE_ID.DIZ +file for disk #1 could contain: + + "MY PROGRAM v1.23 <ASP> Program Executable + Files - Disk 1 of 2" + [followed by detailed description text] + +while the FILE_ID.DIZ file for disk #2 could contain: + + "MY PROGRAM v1.23 <ASP> Documentation Files - + Disk 2 of 2" + [followed by more detailed description text] + +Optionally, you could also create a "complete" FILE_ID.DIZ file for the +first disk, which would fully describe the program in detail, and identify +it as Disk 1 of x. Then, for each remaining file in the set, simply include +the Program Name, version number, ASP identifier, and the disk number (i.e. +"MY PROGRAM v1.23 <ASP> Disk 2 of x"). + + +ADDITIONAL INFO +--------------- +Please don't be tempted to use fancy graphic or ANSI sequences in the +FILE_ID.DIZ file, as most BBS software will not allow this, and will render +your FILE_ID.DIZ file useless. Also, don't be tempted to simply copy your +program description file to FILE_ID.DIZ. Attempting to "format" your +FILE_ID.DIZ file (i.e line centering, right & left justification, etc) will +also cause unexpected results, especially for BBS software which re-formats +descriptions to other than 10line/45char. + +Fred Hill <ASP> has written a freeware utility which interactively creates +a valid FILE_ID.DIZ file. The file is called DIZGEN.ZIP and can be found on +CompuServe (GO IBMBBS, Library 2) as well as on many fine BBS systems. I +highly recommend that you download a copy of this wonderful utility for +creating your FILE_ID.DIZ files. + +========================================================================== + +The following is a recommendation for the structure and contents of +distribution archives prepared for use on BBS systems. + + +DISTRIBUTION DISK RECOMMENDATIONS +--------------------------------- +The following are recommendations for preparing your program files for +distribution to Bulletin Board Systems (BBSs) via the ASP's distribution +services, as well as other methods. + +Two varieties of program files are defined here: + +1) Program files which utilize an "install" utility and self-extracting +program archives (later referred to as "Author-Installed Programs"). + +2) Programs files which do not use install utilities or self-extracting +archives (later referred to as "User-Installed Programs"). + + +AUTHOR-INSTALLED PROGRAMS: +-------------------------- +These programs require a bit more work from the author, but will eliminate +many user mistakes, especially in programs which require complicated +setups. + +Most "installation" utility programs will make use of program files which +have been "archived" into Self-Extracting (SFX) archives. We will attempt +to define which files should be contained in the Self-Extracting archives, +and which files should not. + +1. Files which should be contained in the self-extracting program file +archive: + + a. All program-specific executable files. + b. Any required configuration and/or data files required by the + program. + c. Program documentation files. Optionally, these may be left + outside of the self-extracting archive, in order to allow + them to be viewed/read by the various archive viewing utlities. + d. Any other program-specific files that are required for the + operation of the program. + +2. The files described above should be compiled into a self-extracting +archive file, which will then be extracted by the install utility. + +NOTE: the author is required to abide by any distribution requirements +specified by the archive utility author, and to obtain any required +distribution rights necessary. Please check to see if distribution rights +are required for your archive utility choice. + +3. Files which should NOT be contained in the self-extracting program file +archive: + + a. The install utility itself (obviously). + b. The FILE_ID.DIZ file. (described in detail in the section + preceding this one) + c. Any distribution/information files, such as VENDOR.TXT, + SYSOP.TXT, etc. + d. Any description or information file, such as DESCRIBE.TXT. + e. A user file (such as README.1ST), which should explain how + to use the install utility, what the user should expect + during the installation, and any preparation that the user + should make prior to the installation. This file might also + contain a brief description of your program, in case the user + is able to read the documentation files in the distribution + archive prior to downloading (many BBS systems offer this + ability to the user). + +4. The actual distribution archive file (described below) should then +contain the install utility, the self-extracting program archive, and the +files described in #3 above. + + +USER-INSTALLED PROGRAMS: +------------------------ +This type of distribution archive is much simpler than the Author-Installed +variety. It should simply be an archive file, containing all of the files +for the program described above. + +Since this type of program requires the user to do all of the installation +manually, it should contain very specific and detailed information +regarding the installation requirements (such as INSTALL.TXT). + + +THE DISTRIBUTION ARCHIVE FILE: +------------------------------ +The actual distribution archive file should merely be an archive file +containing the files described above. For BBS distribution, this archive +should be of the standard archive format, and -NOT- a self-extracting +archive. Many sysops will not allow self-extracting archives, and most BBS +software will not allow self-extracting archives to be uploaded. + +There are many popular archive utilities available, such as PKZIP, LHA, +LHARC, ARJ, etc. Most BBS systems are capable of handling archives in +virtually any format. However, you should be aware that most BBS systems +will convert your archive format to the format of choice by the sysop. By +following the methods described above, this conversion process should not +affect your program, or any self-extracting files which are contained +within your distribution archive file. + +You should also retain the default archive file extension defined by the +archive utility. For example, PKZIP uses a ".ZIP", LHARC uses "LZH", etc. +Changing the file extension may cause the BBS software to delete your file +because it doesn't recognize the format. + +For the actual filename for your distribution archive, it is recommended +that the program filename be limited to 6 characters to represent the +program's name (i.e. MYPROG could represent "My Program"). This should be +followed by 2 numeric digits which will represent the version number of +your release. Even if this is your initial release it should include the +version number in the filename (i.e. MYPROG10.ZIP would indicate the +program called "My Program" version 1.0). + +Please note that CompuServe limits filenames to only 6 characters. By +limiting the file "name" to 6 characters, you will easily be able to rename +the archive for CompuServe uploading by simply removing the 2-digit version +identifier, to make the file compatible with CompuServe libraries. + +By including the 2-digit version number in the archive filename, it will be +very easy for both the user and the sysop (and yourself) to identify older +versions of your program. + + +MULTIPLE DISTRIBUTION ARCHIVES +------------------------------ +At one time, it was recommended that your final distribution archive not be +larger than 350k, so that it would fit on a single 360k floppy disk and +still leave room for any distribution files necessary for Disk Vendors. +(i.e. Disk Vendors will often include their own GO.BAT file, or other +various small files to help their customers install the software). This +limitation is slowly falling by the wayside as more and more computer +systems have 3.5" floppy disk drives as standard. + +If your program is large enough to require more than one distribution +archive, it is recommended that your filename be limited to 5 characters +rather than 6 as described above. Following the 5-character name should be +the same 2-digit version number. Then, append a single "letter" to identify +the disk (i.e. MYPGM10A.ZIP, MYPGM10B.ZIP, etc.). For uploading to +CompuServe, these filenames may then be shortened to 6 characters by +removing the version identifiers (i.e. MYPGMA.ZIP, MYPGMB.ZIP). However, +for CompuServe it is recommended that you simply create a single +distibution file, and eliminate the multi-part file set. + +If your program requires multiple distribution archives, -BE SURE- to +create separate FILE_ID.DIZ files for each distribution archive. Also, each +FILE_ID.DIZ file should contain disk number information pertaining to each +individual archive (i.e. Disk 1 of 3, Disk 2 of 3, etc.). + + +THE DISTRIBUTION DISK +--------------------- +It is recommended that your distribution disk simply contain a ZIPd version +of your product. However, If you choose to supply "unarchived" files on a +distribution disk for Disk Vendor use, it is _VERY_ important that you +specify in your documentation a suggested archive filename, so that BBS +sysops can create archived files with the proper author-specified +filenames. This information should be contained in your SYSOP.TXT (or +VENDOR.TXT) file. If you don't supply a suggested archive file name, the +sysops will be forced to create the name themselves, thus you may end up +with thousands of versions of your products on BBS systems all over the +world, but all with different filenames. + +Please note that the ASP Hub Network, and nearly every other electronic +distribution service *REQUIRE* that your files be submitted as an archived +file, using the ZIP format. Also note that many BBS sysops will not go to +the trouble of ZIPing your unarchived files for you. If you don't supply +them with an archived distribution version of your product, it might not +get distributed by BBSs. + +If you supply your own disk labels, it is recommended that the ASP logo, or +at least the initials "ASP" be included on the label, so that anyone can +immediately identify your disk as an ASP member's software. + + +SUMMARY +------- +Your distribution disk should now be ready to submit to the various BBSs, +distribution services, and Disk Vendors. + +You may choose to create a separate distribution disk for use by BBSs and +Disk Vendors. However, if you follow the above steps in preparing your +distribution archive file, a separate "Disk Vendor" disk is probably not +necessary. The majority of disk vendors will be able to accept your +distribution file/disk if it is prepared in the above described format. + +
-- - - + + + + + + + + + +Last update 30-Jan-2001
-
- -
import - Import Configuration.
-- -
Synopsis.
--
import [command]
-
- -
Description.
--import can be used to import the configuration databases from -plain ascii textfiles. This program is not supported. For the format of the -input files look in the source. This program will also not function properly -after 31-Dec-1999. If someone writes real good working conversion programs -to convert BBS, Tosser, Mailer setups to MBSE BBS setup, then make them -public available. On my BBS there is a utility to export RA2.02 databases to -the format that this import program can read. -
- - Back to index - Back to Main index -
++ + + diff --git a/html/programs/mbaff.html b/html/programs/mbaff.html index b5c74263..cff3c5b9 100644 --- a/html/programs/mbaff.html +++ b/html/programs/mbaff.html @@ -1,99 +1,100 @@ - - - - - - - - -Last update 30-Jan-2001
+
+ +
import - Import Configuration.
++ +
Synopsis.
++
import [command]
+
+ +
Description.
++import can be used to import the configuration databases from +plain ascii textfiles. This program is not supported. For the format of the +input files look in the source. This program will also not function properly +after 31-Dec-1999. If someone writes real good working conversion programs +to convert BBS, Tosser, Mailer setups to MBSE BBS setup, then make them +public available. On my BBS there is a utility to export RA2.02 databases to +the format that this import program can read. +
-- - - + + + + + + + + + +Last update 30-Jan-2001
-
- -
mbaff - Announce new files and FileFind processor.
-- -
Synopsis.
-mbaff [command] <options>
-- -
Description.
--mbaff -is the new files report generator and filefind server for mbsebbs. -In order to run mbaff -you must first start mbsed, -this is the deamon which controls all bbs activities. -
-When mbaff -is run with the commandline command announce -the first thing it does is to scan all the file databases for files -from which the announced flag is not yet set, and that area has a valid -newfiles groupname. These files are uploads for example. -If such a file is found the announced flag is set and -the file is added to the -toberep.data -file. This file may already contain -new files who were received as .tic files and processed by the -mbfido program. -After this is done the toberep.data -file is compared against the newfiles -reports to see if there is anything to report. If that's the case the -creation of reports begins in the echomail areas specified. After that the -toberep.data -file is erased and the mailout semafore set.
-The files to announce are divided into groups, the names of the groups are -set in the file download areas. If you plan this well, you can make seperate -announcements for several networks, announce files bij groups of file, ie. HAM -or .jpg pictures, Linux etc. --When -mbaff -is run with the commandline command -filefind -it will search each echomail area for unreceived messages addressed to -allfix or filefind. -It will read the message header and mark the message as received. The -search options are set on the subject line. All file areas for which the -filefind flag is set to true will be searched for the requested search -patterns. If there are files found a reply will be generated for the -user who wrote the request. If the reply area is different from the scan -area, the reply is placed in the reply area. If it's not set, the reply -goes into the same area. If the netmail option is set, the reply will -be sent by netmail. To prevent echomail overflow the replies in the same -area are limited to 15 found files, replies in the other echomail area -are limited to 50 files. Netmail replies will contain up to 100 files. -
- -
Environment.
--In order to run mbaff you need to set one global environment variable -$MBSE_ROOT. -This variable must point to the root of the bbs directoy structure. The -main configuration file -config.data -must be present in the ~/etc subdirectory. -
- -
Commands.
--
mbaff announce
- Announce new files.
-mbaff filefind
- Process filefind requests. -
- -
OPTIONS
--
mbaff [command] -quiet
- Quiet mode, no screen output. -Use this switch if you run mbaff from the crontab. -- - Back to index - Back to main index -
++ + + diff --git a/html/programs/mball.html b/html/programs/mball.html index b09d21da..319378ff 100644 --- a/html/programs/mball.html +++ b/html/programs/mball.html @@ -1,4 +1,5 @@ + @@ -59,8 +60,8 @@ In mbsetup menu 1.16 you need to set the public FTP base, the days to include in newfiles listings and the maximum security level.Last update 30-Jan-2001
+
+ +
mbaff - Announce new files and FileFind processor.
++ +
Synopsis.
+mbaff [command] <options>
++ +
Description.
++mbaff +is the new files report generator and filefind server for mbsebbs. +In order to run mbaff +you must first start mbsed, +this is the deamon which controls all bbs activities. +
+When mbaff +is run with the commandline command announce +the first thing it does is to scan all the file databases for files +from which the announced flag is not yet set, and that area has a valid +newfiles groupname. These files are uploads for example. +If such a file is found the announced flag is set and +the file is added to the +toberep.data +file. This file may already contain +new files who were received as .tic files and processed by the +mbfido program. +After this is done the toberep.data +file is compared against the newfiles +reports to see if there is anything to report. If that's the case the +creation of reports begins in the echomail areas specified. After that the +toberep.data +file is erased and the mailout semafore set.
+The files to announce are divided into groups, the names of the groups are +set in the file download areas. If you plan this well, you can make seperate +announcements for several networks, announce files bij groups of file, ie. HAM +or .jpg pictures, Linux etc. ++When +mbaff +is run with the commandline command +filefind +it will search each echomail area for unreceived messages addressed to +allfix or filefind. +It will read the message header and mark the message as received. The +search options are set on the subject line. All file areas for which the +filefind flag is set to true will be searched for the requested search +patterns. If there are files found a reply will be generated for the +user who wrote the request. If the reply area is different from the scan +area, the reply is placed in the reply area. If it's not set, the reply +goes into the same area. If the netmail option is set, the reply will +be sent by netmail. To prevent echomail overflow the replies in the same +area are limited to 15 found files, replies in the other echomail area +are limited to 50 files. Netmail replies will contain up to 100 files. +
+ +
Environment.
++In order to run mbaff you need to set one global environment variable +$MBSE_ROOT. +This variable must point to the root of the bbs directoy structure. The +main configuration file +config.data +must be present in the ~/etc subdirectory. +
+ +
Commands.
++
mbaff announce
- Announce new files.
+mbaff filefind
- Process filefind requests. +
+ +
OPTIONS
++
mbaff [command] -quiet
- Quiet mode, no screen output. +Use this switch if you run mbaff from the crontab. +
- Back to index - Back to Main index +Back to index +Back to Main index diff --git a/html/programs/mbchat.html b/html/programs/mbchat.html index 87bca2da..c74e4b11 100755 --- a/html/programs/mbchat.html +++ b/html/programs/mbchat.html @@ -1,61 +1,62 @@ - -
- - - - - - --- - - + + + + + + + + + +Last update 30-Jan-2001
-
- -
mbchat - The Sysop to User chat program.
-- -
Synopsys.
--
mbchat <device>
-
- - -
Description.
--The program mbchat is used for Sysop to User chat. It -must be started by the sysop if the user has paged the sysop. The sysop -must be logged in as user mbse in order to have write -permissions to the same tty as the user has. For example, if the user is -at ttyS0 (COM1), the command to chat would be mbchat ttyS0. -
- - -
Environment.
--In order to run mbchat you must set the global variable -$MBSE_ROOT. This variable must point to the root directory -of the bbs structure. The main configuration file config.data -must be present in the ~/etc directory. -
- - -
Bugs.
--When you try to chat with a user who is up or downloading a file, the -transfer will fail or may even block. You need to check what the user is -doing before using this program. -
-This program will not be developed anymore and will be replaced by a program -that will chat via mbsed. This is safer and can be used even -from a remote site over the net. -
- - Back to index - Back to Main index -
++ + + diff --git a/html/programs/mbdiff.html b/html/programs/mbdiff.html index b83c8134..22ea2459 100644 --- a/html/programs/mbdiff.html +++ b/html/programs/mbdiff.html @@ -1,70 +1,71 @@ - - - - - - - - -Last update 30-Jan-2001
+
+ +
mbchat - The Sysop to User chat program.
++ +
Synopsys.
++
mbchat <device>
+
+ + +
Description.
++The program mbchat is used for Sysop to User chat. It +must be started by the sysop if the user has paged the sysop. The sysop +must be logged in as user mbse in order to have write +permissions to the same tty as the user has. For example, if the user is +at ttyS0 (COM1), the command to chat would be mbchat ttyS0. +
+ + +
Environment.
++In order to run mbchat you must set the global variable +$MBSE_ROOT. This variable must point to the root directory +of the bbs structure. The main configuration file config.data +must be present in the ~/etc directory. +
+ + +
Bugs.
++When you try to chat with a user who is up or downloading a file, the +transfer will fail or may even block. You need to check what the user is +doing before using this program. +
+This program will not be developed anymore and will be replaced by a program +that will chat via mbsed. This is safer and can be used even +from a remote site over the net. +
-- - - + + + + + + + + + +Last update 30-Jan-2001
-
- -
mbdiff - Nodelist difference file processor.
-- -
Synopsis.
--
mbdiff [nodelist] [nodediff] <options>
-
- -
Description.
--mbdiff applies a (compressed) nodediff file against the -nodelist of the week before to create a new nodelist. The result is a new -plain nodelist and a nodelist compressed with zip. -
- -
Environmet.
--In order to run mbdiff you must set the global variable -$MBSE_ROOT. This variable must point to the root directory -of the bbs structure. The main configuration file config.data -must be present in the ~/etc directory. -
- -
Commands.
--
mbdiff [nodelist] [nodediff]
The nodelist must be the full -path and filename without the dot and daynumber extension. The nodediff is -the full path and filename to the (compressed) nodediff file fitting on the -latest nodelist. It is adviced to make a seperate working directory where -you keep the nodelists. Don't do this in your normal nodelist directory. -When the operation is successfull, the new nodelist is in the working directory -and the old list is removed. A compressed version of the nodelist is also -placed in the working directory. From here you can hatch the new compressed -nodelist with the mbfido program. -
- -
Options.
--
-quiet
- supress screen output, this switch is needed when -mbdiff runs on the background. -
- -
Bugs.
--If you find any bugs, mispelled documentation etc, please contact the author: -Michiel Broek at 2:280/2802@Fidonet or mbroek@users.sourceforge.net -
- - Back to index - Back to Main index -
++ + + diff --git a/html/programs/mbindex.html b/html/programs/mbindex.html index 862e70cd..b7cb71e8 100644 --- a/html/programs/mbindex.html +++ b/html/programs/mbindex.html @@ -1,68 +1,69 @@ - - - - - - - - -Last update 30-Jan-2001
+
+ +
mbdiff - Nodelist difference file processor.
++ +
Synopsis.
++
mbdiff [nodelist] [nodediff] <options>
+
+ +
Description.
++mbdiff applies a (compressed) nodediff file against the +nodelist of the week before to create a new nodelist. The result is a new +plain nodelist and a nodelist compressed with zip. +
+ +
Environmet.
++In order to run mbdiff you must set the global variable +$MBSE_ROOT. This variable must point to the root directory +of the bbs structure. The main configuration file config.data +must be present in the ~/etc directory. +
+ +
Commands.
++
mbdiff [nodelist] [nodediff]
The nodelist must be the full +path and filename without the dot and daynumber extension. The nodediff is +the full path and filename to the (compressed) nodediff file fitting on the +latest nodelist. It is adviced to make a seperate working directory where +you keep the nodelists. Don't do this in your normal nodelist directory. +When the operation is successfull, the new nodelist is in the working directory +and the old list is removed. A compressed version of the nodelist is also +placed in the working directory. From here you can hatch the new compressed +nodelist with the mbfido program. +
+ +
Options.
++
-quiet
- supress screen output, this switch is needed when +mbdiff runs on the background. +
+ +
Bugs.
++If you find any bugs, mispelled documentation etc, please contact the author: +Michiel Broek at 2:280/2802@Fidonet or mbroek@users.sourceforge.net +
-- - - + + + + + + + + + +Last update 30-Jan-2001
-
- -
mbindex - Nodelist Index Compiler.
-- -
Synopsis.
--
mbindex <options>
-
- - -
Description.
--mbindex is the nodelist index compiler. It will create -an index file containing the sorted fidonet addresses as index file to the -raw nodelists in the defined nodelist directory. Several other programs -use this index file for fast retreival of data from the nodelists. Compiling -new nodelist indexes can always be done, while compiling the result -is stored in temporary index files and only after successfull compilation the -original indexes are renamed and the temporary files get the normal names. -The renamed (old) indexes stay on disk including the previous version of the -old raw nodelist. They stay there in case some program had the nodelist or -index still open. So in the nodelist directory there are current nodelists, -previous -nodelists, current indexes and previous indexes, and during compiling the -temporary indexes. There is no need to manually remove (and not wise to do so) -files from the nodelist directory. -
-The nodelists in the nodelist directory are the normal uncompressed nodelists -in MS-DOS format (with CR/LF). The filename extensions must be two or 3 digits. -So if you have a private pointlist named bestbbs.pts you -will have to rename that to bestbbs.999 to make it work. -
- -
Environment.
--In order to run mbindex you must set the global variable -$MBSE_ROOT. This variable must point to the root directory -of the bbs structure. The main configuration file config.data -must be present in the ~/etc directory. -
- -
Options.
--
mbindex -quiet
Quiet mode, no screen output. Use the switch -if you run mbindex from a shellscript or from the crontab. -
- - Back to index - Back to Main index -
++ + + diff --git a/html/programs/mblang.html b/html/programs/mblang.html index e79edd6c..7a88f4c1 100644 --- a/html/programs/mblang.html +++ b/html/programs/mblang.html @@ -1,38 +1,39 @@ - - - - - - - - -Last update 30-Jan-2001
+
+ +
mbindex - Nodelist Index Compiler.
++ +
Synopsis.
++
mbindex <options>
+
+ + +
Description.
++mbindex is the nodelist index compiler. It will create +an index file containing the sorted fidonet addresses as index file to the +raw nodelists in the defined nodelist directory. Several other programs +use this index file for fast retreival of data from the nodelists. Compiling +new nodelist indexes can always be done, while compiling the result +is stored in temporary index files and only after successfull compilation the +original indexes are renamed and the temporary files get the normal names. +The renamed (old) indexes stay on disk including the previous version of the +old raw nodelist. They stay there in case some program had the nodelist or +index still open. So in the nodelist directory there are current nodelists, +previous +nodelists, current indexes and previous indexes, and during compiling the +temporary indexes. There is no need to manually remove (and not wise to do so) +files from the nodelist directory. +
+The nodelists in the nodelist directory are the normal uncompressed nodelists +in MS-DOS format (with CR/LF). The filename extensions must be two or 3 digits. +So if you have a private pointlist named bestbbs.pts you +will have to rename that to bestbbs.999 to make it work. +
+ +
Environment.
++In order to run mbindex you must set the global variable +$MBSE_ROOT. This variable must point to the root directory +of the bbs structure. The main configuration file config.data +must be present in the ~/etc directory. +
+ +
Options.
++
mbindex -quiet
Quiet mode, no screen output. Use the switch +if you run mbindex from a shellscript or from the crontab. +
-- - - + + + + + + + + + +Last update 30-Jan-2001
-
- -
mblang - Language Data Compiler
-- -
Synopsis.
--
mblang [language data file] [language source text]
-
- -
Description.
--mblang compiles the source textfile to language datafile -which is used by the mbsebbs program. You only need to -use this program if you install a new language file. When you build the -complete mbse bbs package, this command is run automatic for you. -
- - Back to index - Back to Main index -
++ + + diff --git a/html/programs/mbmon.html b/html/programs/mbmon.html index 3c73ab64..72da8785 100644 --- a/html/programs/mbmon.html +++ b/html/programs/mbmon.html @@ -1,45 +1,46 @@ - - - - - - - - -Last update 30-Jan-2001
+
+ +
mblang - Language Data Compiler
++ +
Synopsis.
++
mblang [language data file] [language source text]
+
+ +
Description.
++mblang compiles the source textfile to language datafile +which is used by the mbsebbs program. You only need to +use this program if you install a new language file. When you build the +complete mbse bbs package, this command is run automatic for you. +
-- - - + + + + + + + + + +Last update 07-jun-2001
-
- -
mbmon - MBSE BBS Monitor
-- -
Sysnopsis.
--
mbmon
-
- -
Description.
--mbmon is the monitor program so that you can see what is -happening on your bbs. It can show all processes and actions of all programs, -show system statitistics, disk useage, and the last callers list. -mbmon must run on the same system where the bbs is. -
- -
Environment.
--In order to run mbmon you must set the global variable -$MBSE_ROOT. This variable must point to the root directory -of the bbs structure. -
- - Back to index - Back to Main index -
++ + + diff --git a/html/programs/mbmsg.html b/html/programs/mbmsg.html index 4bc50324..33cffa89 100644 --- a/html/programs/mbmsg.html +++ b/html/programs/mbmsg.html @@ -1,93 +1,94 @@ - - - - - - - - -Last update 07-jun-2001
+
+ +
mbmon - MBSE BBS Monitor
++ +
Sysnopsis.
++
mbmon
+
+ +
Description.
++mbmon is the monitor program so that you can see what is +happening on your bbs. It can show all processes and actions of all programs, +show system statitistics, disk useage, and the last callers list. +mbmon must run on the same system where the bbs is. +
+ +
Environment.
++In order to run mbmon you must set the global variable +$MBSE_ROOT. This variable must point to the root directory +of the bbs structure. +
-- - - + + + + + + + + + +Last update 30-Jan-2001
-
- -
mbmsg - Message Base Utility
-- -
Sysnopsis.
--
mbmsg [commands] <options>
-
- -
Description.
--mbmsg -is the message base utility program for mbsebbs. In order to run mbmsg you -must have started mbsed, -this is the deamon which controls all bbs activities. -
-The main purpose of mbmsg -is to link messages after tossing mail, and to maintain the size of the message -bases and the age of the messages. The best way to do the maintenance is to -run mbmsg -from the crontab. example: -
-30 05 * * * export MBSE_ROOT=/bbs; /bbs/bin/mbmsg kill pack link -quiet --Another purpose is to automatic post messages in message areas. Echomail and -netmail is possible. -
- -
Environment.
--In order to run mbmsg you must set the global variable -$MBSE_ROOT. This variable must point to the root directory -of the bbs structure. The main configuration file config.data -must be present in the ~/etc directory. -
- -
Commands.
--
mbmsg link
Link all messages by subject ignoring -Re: in the subject lines. You should run this after tossing or scanning mail. --
mbmsg kill
Kill messages in areas that have the -age set or the maximum messages set. -A setting of 0 is ignored. The messages are not removed from the message base, -they are only marked as deleted. --
mbmsg pack
This command actualy removes the -messages who have the deleted flag set. -The lastread pointers are updated and the messages renumbered. After this -command there is no way you can recover your messages, except from backups. --
mbmsg post <to> <#> <subj> <file> <flavor> -
This command posts a message in numbered area. If a field -consists of more then one word it must be surounded with quotes. -The to field can be "Michiel Broek" for a full name or -"Michiel_Broek@f16.n2801.z2.fidonet" for netmail addressing. Look out: -you need underscore between the firstname and lastname, no spaces. -Flavor can be one or more of the characters "c", "i", "h" or "p" to set the Crash, -Immediate, Hold or Private flags. -If no flavor is needed, use the - (minus sign) as a placeholder. -
- -
Options.
--
mbmsg [command] -area <#>
-Process only one area <#> number. --
mbmsg [command] -quiet
Quiet mode, -no screen output. Use this switch if you run mbmsg -from the crontab. -- - Back to index - Back to Main index -
++ + + diff --git a/html/programs/mbout.html b/html/programs/mbout.html index ec860b00..6fc4e03b 100644 --- a/html/programs/mbout.html +++ b/html/programs/mbout.html @@ -1,105 +1,106 @@ - - - - - - - - -Last update 30-Jan-2001
+
+ +
mbmsg - Message Base Utility
++ +
Sysnopsis.
++
mbmsg [commands] <options>
+
+ +
Description.
++mbmsg +is the message base utility program for mbsebbs. In order to run mbmsg you +must have started mbsed, +this is the deamon which controls all bbs activities. +
+The main purpose of mbmsg +is to link messages after tossing mail, and to maintain the size of the message +bases and the age of the messages. The best way to do the maintenance is to +run mbmsg +from the crontab. example: +
+30 05 * * * export MBSE_ROOT=/bbs; /bbs/bin/mbmsg kill pack link -quiet ++Another purpose is to automatic post messages in message areas. Echomail and +netmail is possible. +
+ +
Environment.
++In order to run mbmsg you must set the global variable +$MBSE_ROOT. This variable must point to the root directory +of the bbs structure. The main configuration file config.data +must be present in the ~/etc directory. +
+ +
Commands.
++
mbmsg link
Link all messages by subject ignoring +Re: in the subject lines. You should run this after tossing or scanning mail. ++
mbmsg kill
Kill messages in areas that have the +age set or the maximum messages set. +A setting of 0 is ignored. The messages are not removed from the message base, +they are only marked as deleted. ++
mbmsg pack
This command actualy removes the +messages who have the deleted flag set. +The lastread pointers are updated and the messages renumbered. After this +command there is no way you can recover your messages, except from backups. ++
mbmsg post <to> <#> <subj> <file> <flavor> +
This command posts a message in numbered area. If a field +consists of more then one word it must be surounded with quotes. +The to field can be "Michiel Broek" for a full name or +"Michiel_Broek@f16.n2801.z2.fidonet" for netmail addressing. Look out: +you need underscore between the firstname and lastname, no spaces. +Flavor can be one or more of the characters "c", "i", "h" or "p" to set the Crash, +Immediate, Hold or Private flags. +If no flavor is needed, use the - (minus sign) as a placeholder. +
+ +
Options.
++
mbmsg [command] -area <#>
+Process only one area <#> number. ++
mbmsg [command] -quiet
Quiet mode, +no screen output. Use this switch if you run mbmsg +from the crontab. +
-- - - + + + + + + + + + +Last update 31-Jan-2001
-
- -
mbout - The Outbound Manager
-- -
Synopsis.
--
mbout [command] <params> <options> -
- -
Description.
--mbout is the outbound manager for MBSE BBS. It can ask -information from the nodelists, create and remove polls, request and send files and -display the outbound status. Most of the tasks such as create and remove -polls should be done from the crontab. -
- -
Environment.
--In order to run mbout you must set the global variable -$MBSE_ROOT. This variable must point to the root directory -of the bbs structure. The main configuration file config.data -must be present in the ~/etc directory. -
- -
Commands.
--
mbout att <node> <flavor> <file>
will attach -the specified file to the specified node. The node should be in the format -f2802.n280.z2, flavor should be crash, immediate, normal or hold. Only the first -letter of the flavor parameter is needed. -If the node is not in the nodelist, the status is Down or Hold, then this command fails. -To non-CM nodes you mus use the Immediate flavor if you want to send the file direct. -The flavors Hold and Normal are still allowed. The file must be in the directory range -from where file attaches are allowed. --
mbout poll [node..node]
creates poll requests in the outbound -for one or more nodes. The node should be in the format f2802.n280.z2. The semafore -scanout is created so that the mailer will start calling. -The mailer will handle the poll request as if it should deliver immediate mail, -so the node will be called as long as the poll request exists, even to nodes which are not CM. -The error counter for the node to poll will be reset to zero, so a node that was -previous marked undialable will be called again. -If a call to a node is successfull, the poll file will be removed by mbcico. -If a node is not in the nodelist or has the status Down or Hold, no poll will be created for that node. --
mbout stop [node..node]
removes poll requests that are -leftover when polling nodes didn't succeed. There is no check if the node is -in the nodelist or has the status Down or Hold, the poll is always removed. --
mbout req <node> <file> [file..file]
creates -filerequests to a node. One or more filenames may be given including wildcards. -It is not possible to do update or password protected uploads yet. If there -is already a requestlist for that node, the new requests will be added. This -command does not call a node, you need to create a poll request to make the -actual call. This is also practical if you want some files from your uplink, -just make the requests and the actual request is send when your normal -scheduled poll to your uplink is processed. --
mbout stat
shows the status of the mailer outbound. -This status is also written to the logfile. --
mbout node <node>
will show the nodelist information for -a certain node. -
- -
Options.
--
mbout [commands] -quiet
will suppress screen output. This is -usefull if you run mbout from the crontab or from background -scripts. -
- -
Examples.
--This is an example of crontab entries that writes the outbound status to the -logfile and creates and stops polling of 2 nodes.
--00 00 * * * export MBSE_ROOT=/opt/mbse; $MBSE_ROOT/bin/mbout stat -quiet -00 01 * * * export MBSE_ROOT=/opt/mbse; $MBSE_ROOT/bin/mbout poll f98.n100.z92 f0.n100.z92 -quiet -00 02 * * * export MBSE_ROOT=/opt/mbse; $MBSE_ROOT/bin/mbout stop f98.n100.z92 f0.n100.z92 -quiet --- - Back to index - Back to Main index -
++ + + diff --git a/html/programs/mbseq.html b/html/programs/mbseq.html index 1ab89e47..e74632b7 100644 --- a/html/programs/mbseq.html +++ b/html/programs/mbseq.html @@ -1,49 +1,50 @@ - - - - - - - - -Last update 31-Jan-2001
+
+ +
mbout - The Outbound Manager
++ +
Synopsis.
++
mbout [command] <params> <options> +
+ +
Description.
++mbout is the outbound manager for MBSE BBS. It can ask +information from the nodelists, create and remove polls, request and send files and +display the outbound status. Most of the tasks such as create and remove +polls should be done from the crontab. +
+ +
Environment.
++In order to run mbout you must set the global variable +$MBSE_ROOT. This variable must point to the root directory +of the bbs structure. The main configuration file config.data +must be present in the ~/etc directory. +
+ +
Commands.
++
mbout att <node> <flavor> <file>
will attach +the specified file to the specified node. The node should be in the format +f2802.n280.z2, flavor should be crash, immediate, normal or hold. Only the first +letter of the flavor parameter is needed. +If the node is not in the nodelist, the status is Down or Hold, then this command fails. +To non-CM nodes you mus use the Immediate flavor if you want to send the file direct. +The flavors Hold and Normal are still allowed. The file must be in the directory range +from where file attaches are allowed. ++
mbout poll [node..node]
creates poll requests in the outbound +for one or more nodes. The node should be in the format f2802.n280.z2. The semafore +scanout is created so that the mailer will start calling. +The mailer will handle the poll request as if it should deliver immediate mail, +so the node will be called as long as the poll request exists, even to nodes which are not CM. +The error counter for the node to poll will be reset to zero, so a node that was +previous marked undialable will be called again. +If a call to a node is successfull, the poll file will be removed by mbcico. +If a node is not in the nodelist or has the status Down or Hold, no poll will be created for that node. ++
mbout stop [node..node]
removes poll requests that are +leftover when polling nodes didn't succeed. There is no check if the node is +in the nodelist or has the status Down or Hold, the poll is always removed. ++
mbout req <node> <file> [file..file]
creates +filerequests to a node. One or more filenames may be given including wildcards. +It is not possible to do update or password protected uploads yet. If there +is already a requestlist for that node, the new requests will be added. This +command does not call a node, you need to create a poll request to make the +actual call. This is also practical if you want some files from your uplink, +just make the requests and the actual request is send when your normal +scheduled poll to your uplink is processed. ++
mbout stat
shows the status of the mailer outbound. +This status is also written to the logfile. ++
mbout node <node>
will show the nodelist information for +a certain node. +
+ +
Options.
++
mbout [commands] -quiet
will suppress screen output. This is +usefull if you run mbout from the crontab or from background +scripts. +
+ +
Examples.
++This is an example of crontab entries that writes the outbound status to the +logfile and creates and stops polling of 2 nodes.
++00 00 * * * export MBSE_ROOT=/opt/mbse; $MBSE_ROOT/bin/mbout stat -quiet +00 01 * * * export MBSE_ROOT=/opt/mbse; $MBSE_ROOT/bin/mbout poll f98.n100.z92 f0.n100.z92 -quiet +00 02 * * * export MBSE_ROOT=/opt/mbse; $MBSE_ROOT/bin/mbout stop f98.n100.z92 f0.n100.z92 -quiet ++
-- - - + + + + + + + + + +Last update 31-Jan-2001
-
- -
mbseq - Sequence number creator
-- -
Synopsis.
--
mbseq
- 
- -
Description.
--mbseq writes a eight character hexadecimal unique sequence -number to the stdout. This number is received from mbsed -which keeps track of the generated sequence numbers. This written number can -be used in shell scripts to create unique filenames for Fidonet .pkt files, -for example: -
-
-cp temp.pkt `mbseq`.pkt -
-
- -
Bugs.
--Nah, it's only 50 lines code, what could go wrong? -
- - - Back to index - Back to Main index -
++ + + diff --git a/html/programs/mbsetup.html b/html/programs/mbsetup.html index 73c27cd4..b665cee2 100644 --- a/html/programs/mbsetup.html +++ b/html/programs/mbsetup.html @@ -1,4 +1,5 @@ + diff --git a/html/programs/mbstat.html b/html/programs/mbstat.html index f589c93e..8c2af763 100644 --- a/html/programs/mbstat.html +++ b/html/programs/mbstat.html @@ -1,79 +1,80 @@ - - - - - - - - -Last update 31-Jan-2001
+
+ +
mbseq - Sequence number creator
++ +
Synopsis.
++
mbseq
+ 
+ +
Description.
++mbseq writes a eight character hexadecimal unique sequence +number to the stdout. This number is received from mbsed +which keeps track of the generated sequence numbers. This written number can +be used in shell scripts to create unique filenames for Fidonet .pkt files, +for example: +
+
+cp temp.pkt `mbseq`.pkt +
+
+ +
Bugs.
++Nah, it's only 50 lines code, what could go wrong? +
+ + +Back to index +Back to Main index +
-- - - + + + + + + + + + +Last update 07-Jul-2001
-
- -
mbstat - MBSE BBS Status Changer
-- -
Synopsis.
--
mbstat [commands] <options>
-
- -
Description.
--mbstat changes the bbs status between open and close, can wait -for all users to logoff and wait for critical utilities to stop their actions. -
- -
Environment.
--In order to run mbstat you must set the global variable -$MBSE_ROOT. This variable must point to the root directory -of the bbs structure. The main configuration file config.data -must be present in the ~/etc directory. -
- -
Commands.
--
mbstat semafore scanout
will set the internal -semafore scanout in the mbtask daemon. The following semafore's -are valid: scanout, mailout, mailin, mbindex, reqindex, msglink. --
mbstat close
will close the bbs for users. -Users that are just logging in to the bbs will be thrown out after a short message. -Users already logged in will be thrown out when they pass by a menu prompt. -So users who are doing file transfers can finish their transfers before being disconnected. --
mbstat open
opens the bbs for users. -This should be run from one of the system startup scripts right after you started -mbsed. If you installed everything as it should this -command is already executed at system startup. --
mbstat wait
will -wait for the bbs to become free. This includes a check for utilities that -do critical actions so they can finish their job without corrupting the bbs -databases. The default is to wait 60 minutes. If the semafore -upsdown exists it will wait only 30 seconds. --You should run mbstat close wait in your system shutdown script so -that the system shutdown will wait for a clean shutdown of the bbs before -the rest of your system goes down. If you installed everything as it should -be then these commands are already installed in your system shutdown scripts. -
- -
Options.
--
mbstat [command] -quiet
will supress screen output. -This is good for using mbstat in scripts. -- - - Back to index - Back to Main index -
++ + + diff --git a/html/programs/mbtoberep.html b/html/programs/mbtoberep.html index 86413043..24d5fef7 100644 --- a/html/programs/mbtoberep.html +++ b/html/programs/mbtoberep.html @@ -1,47 +1,48 @@ - - - - - - - - -Last update 07-Jul-2001
+
+ +
mbstat - MBSE BBS Status Changer
++ +
Synopsis.
++
mbstat [commands] <options>
+
+ +
Description.
++mbstat changes the bbs status between open and close, can wait +for all users to logoff and wait for critical utilities to stop their actions. +
+ +
Environment.
++In order to run mbstat you must set the global variable +$MBSE_ROOT. This variable must point to the root directory +of the bbs structure. The main configuration file config.data +must be present in the ~/etc directory. +
+ +
Commands.
++
mbstat semafore scanout
will set the internal +semafore scanout in the mbtask daemon. The following semafore's +are valid: scanout, mailout, mailin, mbindex, reqindex, msglink. ++
mbstat close
will close the bbs for users. +Users that are just logging in to the bbs will be thrown out after a short message. +Users already logged in will be thrown out when they pass by a menu prompt. +So users who are doing file transfers can finish their transfers before being disconnected. ++
mbstat open
opens the bbs for users. +This should be run from one of the system startup scripts right after you started +mbsed. If you installed everything as it should this +command is already executed at system startup. ++
mbstat wait
will +wait for the bbs to become free. This includes a check for utilities that +do critical actions so they can finish their job without corrupting the bbs +databases. The default is to wait 60 minutes. If the semafore +upsdown exists it will wait only 30 seconds. ++You should run mbstat close wait in your system shutdown script so +that the system shutdown will wait for a clean shutdown of the bbs before +the rest of your system goes down. If you installed everything as it should +be then these commands are already installed in your system shutdown scripts. +
+ +
Options.
++
mbstat [command] -quiet
will supress screen output. +This is good for using mbstat in scripts. ++ + +Back to index +Back to Main index +
-- - - + + + + + + + + + +Last update 31-Jan-2001
-
- -
mbtoberep - List newfiles to report
-- -
Synopsis.
--
mbtoberep
-
- -
Description.
--mbtoberep is a small utility to list the file -~/etc/toberep.data which contains the newfiles found on your system before -mbaff announce is run. This program is intended for system -development but I decided to leave it in the distribution for now. If you -pipe the output thru more or less you are able to inspect the records. -
- -
Environment.
--In order to run mbtoberep you must set the global variable -$MBSE_ROOT. This variable must point to the root directory -of the bbs structure. The main configuration file config.data -must be present in the ~/etc directory. -
- - Back to index - Back to Main index -
++ + + diff --git a/html/programs/mbuser.html b/html/programs/mbuser.html index b09b1665..9cddbdaa 100644 --- a/html/programs/mbuser.html +++ b/html/programs/mbuser.html @@ -1,71 +1,72 @@ - - - - - - - - -Last update 31-Jan-2001
+
+ +
mbtoberep - List newfiles to report
++ +
Synopsis.
++
mbtoberep
+
+ +
Description.
++mbtoberep is a small utility to list the file +~/etc/toberep.data which contains the newfiles found on your system before +mbaff announce is run. This program is intended for system +development but I decided to leave it in the distribution for now. If you +pipe the output thru more or less you are able to inspect the records. +
+ +
Environment.
++In order to run mbtoberep you must set the global variable +$MBSE_ROOT. This variable must point to the root directory +of the bbs structure. The main configuration file config.data +must be present in the ~/etc directory. +
-- - - + + + + + + + + + +Last update 02-Feb-2001
-
- -
mbuser - User Database Maintenance
-- -
Sysnopsis.
--
mbuser [commands] <options>
-
- -
Description.
--mbuser is the user database maintenance program. It can delete -users upto a certain level who have not called for a number of days. It can -also pack the user database. This is not really a pack of the database, the -deleted records are zeroed but the database is never shrinked. Every user -once in this database will keep his record forever. This is to be sure that -all LastRead Pointers will be correct. Records that are zeroed can be -reused for new users. mbuser must run setuid root and -setgid root because it executes /usr/sbin/userdel to delete the Unix account -of the user that is removed from the bbs. -
- -
Environment.
--In order to run mbuser you must set the global variable -$MBSE_ROOT. This variable must point to the root directory -of the bbs structure. The main configuration file config.data -must be present in the ~/etc directory. mbuser must be -installed setuid root and setgid root, ls -la looks like this:
---rws--s--x 1 root root 23560 Jun 19 19:50 /opt/mbse/bin/mbuser* --
- -
Commands.
--
mbuser kill [n] [l]
will mark users to delete who have not -called in n days upto and including level l. --
mbuser pack
will delete (zero) the users marked for deletion. -You should also run this command if you marked users to delete with -mbsetup. -
- -
Options.
--
mbuser [command] -quiet
will suppress screen output, this is -for running mbuser in the background or from the crontab. -- - Back to index - Back to Main index -
++ + + diff --git a/html/programs/mbuseradd.html b/html/programs/mbuseradd.html index 92950b61..e3d5247d 100644 --- a/html/programs/mbuseradd.html +++ b/html/programs/mbuseradd.html @@ -1,72 +1,73 @@ - - - - - - - - -Last update 02-Feb-2001
+
+ +
mbuser - User Database Maintenance
++ +
Sysnopsis.
++
mbuser [commands] <options>
+
+ +
Description.
++mbuser is the user database maintenance program. It can delete +users upto a certain level who have not called for a number of days. It can +also pack the user database. This is not really a pack of the database, the +deleted records are zeroed but the database is never shrinked. Every user +once in this database will keep his record forever. This is to be sure that +all LastRead Pointers will be correct. Records that are zeroed can be +reused for new users. mbuser must run setuid root and +setgid root because it executes /usr/sbin/userdel to delete the Unix account +of the user that is removed from the bbs. +
+ +
Environment.
++In order to run mbuser you must set the global variable +$MBSE_ROOT. This variable must point to the root directory +of the bbs structure. The main configuration file config.data +must be present in the ~/etc directory. mbuser must be +installed setuid root and setgid root, ls -la looks like this:
++-rws--s--x 1 root root 23560 Jun 19 19:50 /opt/mbse/bin/mbuser* ++
+ +
Commands.
++
mbuser kill [n] [l]
will mark users to delete who have not +called in n days upto and including level l. ++
mbuser pack
will delete (zero) the users marked for deletion. +You should also run this command if you marked users to delete with +mbsetup. +
+ +
Options.
++
mbuser [command] -quiet
will suppress screen output, this is +for running mbuser in the background or from the crontab. +
-- - - + + + + + + + + + +Last update 02-Feb-2001
-
- -
mbuseradd - The useradd wrapper.
-- -
Sysnopsis.
--
mbuseradd [gid] [username] [comment] [userdir]
-
- -
Description.
--mbuseradd is the wrapper for the useradd -program that should be present on most Linux systems. useradd -may only be executed by root and there are some other minor -things that need to be done as root to create a new Unix -account that can be used with MBSE BBS. The solution for these problems is -mbuseradd, this little program runs setuid root and setgid -root. If it fails to do that it aborts. mbuseradd is called -by mbsebbs from the newuser function. You never need to -run mbuseradd by hand. If it is successfull the user will -have an entry in /etc/passwd, the comment is his Fidonet name, and his shell -is $MBSE_ROOT/bin/mbsebbs. -
-If all this is successfull until now, the homedirectory for this user is -created and the right ownership and permissions are set. In his homedirectory -the empty file .hushlogin is placed to prevent check for -new mail when he logs into your system. This is the Unix mailcheck that is -skipped and has nothing todo with the check for new mail in the bbs. All -other directories that are needed for the bbs are created by mbsebbs. -
- -
Environment.
--In order to run mbuseradd you must set the global variable -$MBSE_ROOT. This variable must point to the root directory -of the bbs structure. The main configuration file config.data -must be present in the ~/etc directory. mbuseradd must be -installed setuid root and setgid root, ls -la looks like this:
---rws--s--x 1 root root 6644 Jun 26 21:23 /opt/mbse/bin/mbuseradd* --
- -
Commands.
--
mbuseradd [gid] [name] [comment] [usersdir]
for example:
--mbuseradd bbs mbroek "Michiel Broek" /opt/mbse/home --- - Back to index - Back to Main index -
++ + + diff --git a/html/setup/archiver.html b/html/setup/archiver.html index 9a93ac25..02a074ff 100644 --- a/html/setup/archiver.html +++ b/html/setup/archiver.html @@ -1,44 +1,45 @@ - - - - - - - - -Last update 02-Feb-2001
+
+ +
mbuseradd - The useradd wrapper.
++ +
Sysnopsis.
++
mbuseradd [gid] [username] [comment] [userdir]
+
+ +
Description.
++mbuseradd is the wrapper for the useradd +program that should be present on most Linux systems. useradd +may only be executed by root and there are some other minor +things that need to be done as root to create a new Unix +account that can be used with MBSE BBS. The solution for these problems is +mbuseradd, this little program runs setuid root and setgid +root. If it fails to do that it aborts. mbuseradd is called +by mbsebbs from the newuser function. You never need to +run mbuseradd by hand. If it is successfull the user will +have an entry in /etc/passwd, the comment is his Fidonet name, and his shell +is $MBSE_ROOT/bin/mbsebbs. +
+If all this is successfull until now, the homedirectory for this user is +created and the right ownership and permissions are set. In his homedirectory +the empty file .hushlogin is placed to prevent check for +new mail when he logs into your system. This is the Unix mailcheck that is +skipped and has nothing todo with the check for new mail in the bbs. All +other directories that are needed for the bbs are created by mbsebbs. +
+ +
Environment.
++In order to run mbuseradd you must set the global variable +$MBSE_ROOT. This variable must point to the root directory +of the bbs structure. The main configuration file config.data +must be present in the ~/etc directory. mbuseradd must be +installed setuid root and setgid root, ls -la looks like this:
++-rws--s--x 1 root root 6644 Jun 26 21:23 /opt/mbse/bin/mbuseradd* ++
+ +
Commands.
++
mbuseradd [gid] [name] [comment] [usersdir]
for example:
++mbuseradd bbs mbroek "Michiel Broek" /opt/mbse/home ++
-- - - + + + + + + + + + +Last update 29-Jan-2001
-
- -
MBSE BBS Setup - archiver programs
--To process mail, files and test new uploads you need archivers to process those -files. For each (un)archiver you must setup the full path and filename and -commandline switches. Archivers and unarchivers may be different programs such -as zip and unzip.
-There is a little -difference in processing mail and files, mail will always work on the same -directory, while for ticfile processing the archives can contain subdirectories. -So it is obvious that for rearchiving a file you need the recursive -switches to keep the directory structure within an archive as it was.
-There is also a special command to replace a banner in an archive. This is when -you receive files with the banner of your uplink in it and you want to replace -it with the add of your own bbs and you don't want to mess with the files in -the archive.
-The last option is to extract the file FILE_ID.DIZ from the -archive, this can be used for file description when the file is imported in -your bbs. To make life a little more easy, during the first bbs setup the most -common archivers already configured. You only need to make sure that they are -really present on your system. -
- - Back to index - Back to main index -
++ + + diff --git a/html/setup/bbs.html b/html/setup/bbs.html index cc6d8c76..a338e977 100644 --- a/html/setup/bbs.html +++ b/html/setup/bbs.html @@ -1,42 +1,43 @@ - - - - - - - - -Last update 29-Jan-2001
+
+ +
MBSE BBS Setup - archiver programs
++To process mail, files and test new uploads you need archivers to process those +files. For each (un)archiver you must setup the full path and filename and +commandline switches. Archivers and unarchivers may be different programs such +as zip and unzip.
+There is a little +difference in processing mail and files, mail will always work on the same +directory, while for ticfile processing the archives can contain subdirectories. +So it is obvious that for rearchiving a file you need the recursive +switches to keep the directory structure within an archive as it was.
+There is also a special command to replace a banner in an archive. This is when +you receive files with the banner of your uplink in it and you want to replace +it with the add of your own bbs and you don't want to mess with the files in +the archive.
+The last option is to extract the file FILE_ID.DIZ from the +archive, this can be used for file description when the file is imported in +your bbs. To make life a little more easy, during the first bbs setup the most +common archivers already configured. You only need to make sure that they are +really present on your system. +
-- - - + + + + + + + + + +Last update 29-Jan-2001
-
- -
MBSE BBS Setup - Edit BBS Setup.
-- -
Edit BBS Setup.
--The BBS setup is split in the following sections: -
- -
- - Back to index - Back to main index -
++ + + diff --git a/html/setup/bbslist.html b/html/setup/bbslist.html index 36478cc7..6a85f17d 100644 --- a/html/setup/bbslist.html +++ b/html/setup/bbslist.html @@ -1,28 +1,29 @@ - - - - - - - - -Last update 29-Jan-2001
+
+ +
MBSE BBS Setup - Edit BBS Setup.
++ +
Edit BBS Setup.
++The BBS setup is split in the following sections: +
+ +
+ +Back to index +Back to main index +
-- - - + + + + + + + + + +Last update 29-Jan-2001
-
- -
MBSE BBS Setup - BBS Setup - BBS List Data.
--This is not available yet. -
- - Back to BBS index - Back to index - Back to main index -
++ + + diff --git a/html/setup/domains.html b/html/setup/domains.html index adc761f2..647daec5 100644 --- a/html/setup/domains.html +++ b/html/setup/domains.html @@ -1,4 +1,5 @@ + diff --git a/html/setup/fegroup.html b/html/setup/fegroup.html index 3800b70d..ae0c8526 100644 --- a/html/setup/fegroup.html +++ b/html/setup/fegroup.html @@ -1,64 +1,65 @@ - - - - - - - - -Last update 29-Jan-2001
+
+ +
MBSE BBS Setup - BBS Setup - BBS List Data.
++This is not available yet. +
-- - - + + + + + + + + + +Last update 30-Jan-2001
-
- -
MBSE BBS Setup - File Echo's Setup - File Groups.
-- -
Introduction.
--File echo groups are to logically divide your file echo's for different -file distribution networks. It makes sense to select the groups by uplink and -area file that is available for that file distribution network. By doing that -downlinks can connect areas that are not yet connected at your bbs but are -available from your uplink. NOTE: uplink requests is not yet implemented. -
- -
Cost Sharing.
--With the setup of groups you can also specify the Cost Sharing for the -files distribution. The unit cost is the cost for each transmitted file -if the unit size field is zero, or the unit price per transmitted unit size. -The final cost is multiplied with the "Add Prom." factor to add taxes or so. -Also if your uplink sends advanced .tic files, the cost found in that .tic -file will be added to the cost as well. Further you can set the final price -to divide between your downlinks or let them all pay the full price. - -
File Group Setup.
--
-Name File Echo Group name. -Comment The description of that group. -Active If this group is active. -Use Aka The Fidonet aka to use for this group -Uplink The Fidonet aka of the uplink. -Areas The name of the areas file (in ~/etc). -Unit Cost The cost per unit. -Unit Size The size in Kbytes per unit. -Add Prom. The prommilage to add to the cost. -Divide Divide cost over downlinks. -Deleted If this group must be deleted. --- -
- - Back to File Echo's Setup - Back to index - Back to main index -
++ + + diff --git a/html/setup/fidonet.html b/html/setup/fidonet.html index 8de0cd55..46f8fe0e 100644 --- a/html/setup/fidonet.html +++ b/html/setup/fidonet.html @@ -1,42 +1,42 @@ - - - - - - - - -Last update 30-Jan-2001
+
+ +
MBSE BBS Setup - File Echo's Setup - File Groups.
++ +
Introduction.
++File echo groups are to logically divide your file echo's for different +file distribution networks. It makes sense to select the groups by uplink and +area file that is available for that file distribution network. By doing that +downlinks can connect areas that are not yet connected at your bbs but are +available from your uplink. NOTE: uplink requests is not yet implemented. +
+ +
Cost Sharing.
++With the setup of groups you can also specify the Cost Sharing for the +files distribution. The unit cost is the cost for each transmitted file +if the unit size field is zero, or the unit price per transmitted unit size. +The final cost is multiplied with the "Add Prom." factor to add taxes or so. +Also if your uplink sends advanced .tic files, the cost found in that .tic +file will be added to the cost as well. Further you can set the final price +to divide between your downlinks or let them all pay the full price. + +
File Group Setup.
++
+Name File Echo Group name. +Comment The description of that group. +Active If this group is active. +Use Aka The Fidonet aka to use for this group +Uplink The Fidonet aka of the uplink. +Areas The name of the areas file (in ~/etc). +Unit Cost The cost per unit. +Unit Size The size in Kbytes per unit. +Add Prom. The prommilage to add to the cost. +Divide Divide cost over downlinks. +Deleted If this group must be deleted. +++ +
+ +Back to File Echo's Setup +Back to index +Back to main index +
-- - - + + + + + + + + + +Last update 29-Jan-2001
-
- -
MBSE BBS Setup - fidonet Networks
--Each fidonet network can have maximum 6 zones. The main zone (where you are) -must be the first zone, the others will follow. You can add 6 additional -nodelists to merge with the main nodelist. These additional nodelists are -normally more recent that the main nodelist, so entries in the additional -nodelists will replace entries from the main nodelist when you compile the -nodelists. In the shown example you can see that I have a regional nodelist -and a pointlist added for my region. For each additional list you must -specify the RC address because that information is normally present in these -nodelists. Watch out! Nodelist names are case sensitive. If you receive a -nodelist and automatic put them in place with the mbfido -program, and the resulting file is uppercase, you must use uppercase names -here also. You don't need to give the extension of the nodelist name, the -mbindex will figure that out. -
- - -
- Back to index -
- Back to main index -
++ + + diff --git a/html/setup/fileecho.html b/html/setup/fileecho.html index d74a678e..357e1c90 100644 --- a/html/setup/fileecho.html +++ b/html/setup/fileecho.html @@ -1,94 +1,95 @@ - - - - - - - - -Last update 29-Jan-2001
+
+ +
MBSE BBS Setup - fidonet Networks
++Each fidonet network can have maximum 6 zones. The main zone (where you are) +must be the first zone, the others will follow. You can add 6 additional +nodelists to merge with the main nodelist. These additional nodelists are +normally more recent that the main nodelist, so entries in the additional +nodelists will replace entries from the main nodelist when you compile the +nodelists. In the shown example you can see that I have a regional nodelist +and a pointlist added for my region. For each additional list you must +specify the RC address because that information is normally present in these +nodelists. Watch out! Nodelist names are case sensitive. If you receive a +nodelist and automatic put them in place with the mbfido +program, and the resulting file is uppercase, you must use uppercase names +here also. You don't need to give the extension of the nodelist name, the +mbindex will figure that out. +
+ + +
+Back to index +Back to main index +
-- - - + + + + + + + + + +Last update 08-Jun-2001
-
- -
MBSE BBS Setup - File Echo's Setup - TIC Areas.
-- -
Introduction.
--In this setup you can define the File Echo's or TIC areas. Files received or -send from this areas are bound together with a *.tic file with information -about the file and where to store that file. Each file echo must belong to a -group, in this grouprecord is the information about costsharing and some -other details. When a file is received at your system you can do several -things with that file before it is stored in your download areas such as; -scanning the file for virusses, extracting the FILE_ID.DIZ file to use as -description, allow update of magic alias, convert to another compression -format, replace the file archive comment with an add of your own bbs and limit -the number of files (nodelists). -
- -
TIC Area Setup.
--
-Comment A description for this area. -Area tag The tag for this area. -BBS area The BBS download area number, 0 means passthru. -Message Not in use yet. -Group The group where this area belongs to. -Keep # The number of files to keep, the name must match. -Fido aka The Fidonet aka to use for this area. -Convert The archiver to convert to, leave blank for none. -Banner The bannerfile (in ~/etc) to replace in the archive. -Replace Honor the "Replace" command in the .tic file. -Dupecheck Check for duplicates in this area. -Secure Check if the sending system is connected. -No touch Don't touch the filedate, keep it original. -Virus sc. Try to scan for virusses. -Announce Files may be announced in this area. -Upd magic Allow update magic request name. -File_id Try to use the FILE_ID.DIZ file for description. -Conv.all Convert archive even if it is already right. -Send org. Send original received file instead of the file from the BBS. -Mandatory Downlinks can't disconnect from this area. -Notified Not in use yet. -Upl discon Not in use yet. -Deleted If this area must be deleted. -Active If this area is active. -Systems To the screen with connected systems. --- -
- - -
Global Commands.
--From menu 10.2 you can enter the global commands menu. In this menu you can: -
-
-After you have selected the action you want and added the items to do, you will see -a screen were you can select TIC file area groups. You can then tag one or more -groups and press enter when you are done. Then you have one chance to perform the -actions or to bail out. All areas matching in that group are affected by your -changes. If you are not happy with the result, don't save the database and no -harm is done. The file mbsetup.log shows all affected areas. -- Delete connection -
- Add new connection -
- Replace connection -
- Change connection status -
- Change aka to use -
- Delete TIC area -
- - - Back to File Echo's Setup - Back to index - Back to main index -
++ + + diff --git a/html/setup/filefind.html b/html/setup/filefind.html index fc67e2a6..92a268c6 100644 --- a/html/setup/filefind.html +++ b/html/setup/filefind.html @@ -1,58 +1,59 @@ - - - - - - - - -Last update 08-Jun-2001
+
+ +
MBSE BBS Setup - File Echo's Setup - TIC Areas.
++ +
Introduction.
++In this setup you can define the File Echo's or TIC areas. Files received or +send from this areas are bound together with a *.tic file with information +about the file and where to store that file. Each file echo must belong to a +group, in this grouprecord is the information about costsharing and some +other details. When a file is received at your system you can do several +things with that file before it is stored in your download areas such as; +scanning the file for virusses, extracting the FILE_ID.DIZ file to use as +description, allow update of magic alias, convert to another compression +format, replace the file archive comment with an add of your own bbs and limit +the number of files (nodelists). +
+ +
TIC Area Setup.
++
+Comment A description for this area. +Area tag The tag for this area. +BBS area The BBS download area number, 0 means passthru. +Message Not in use yet. +Group The group where this area belongs to. +Keep # The number of files to keep, the name must match. +Fido aka The Fidonet aka to use for this area. +Convert The archiver to convert to, leave blank for none. +Banner The bannerfile (in ~/etc) to replace in the archive. +Replace Honor the "Replace" command in the .tic file. +Dupecheck Check for duplicates in this area. +Secure Check if the sending system is connected. +No touch Don't touch the filedate, keep it original. +Virus sc. Try to scan for virusses. +Announce Files may be announced in this area. +Upd magic Allow update magic request name. +File_id Try to use the FILE_ID.DIZ file for description. +Conv.all Convert archive even if it is already right. +Send org. Send original received file instead of the file from the BBS. +Mandatory Downlinks can't disconnect from this area. +Notified Not in use yet. +Upl discon Not in use yet. +Deleted If this area must be deleted. +Active If this area is active. +Systems To the screen with connected systems. +++ +
+ + +
Global Commands.
++From menu 10.2 you can enter the global commands menu. In this menu you can: +
+
+After you have selected the action you want and added the items to do, you will see +a screen were you can select TIC file area groups. You can then tag one or more +groups and press enter when you are done. Then you have one chance to perform the +actions or to bail out. All areas matching in that group are affected by your +changes. If you are not happy with the result, don't save the database and no +harm is done. The file mbsetup.log shows all affected areas. +- Delete connection +
- Add new connection +
- Replace connection +
- Change connection status +
- Change aka to use +
- Delete TIC area +
+ + +Back to File Echo's Setup +Back to index +Back to main index +
-- - - + + + + + + + + + +Last update 30-Jan-2001
-
- -
MBSE BBS Setup - Filefind Areas.
-- -
Introduction.
--The filefind idea on Fidonet came from the program Allfix written by Harald -Harms. The idea is -that a user writes a mail in a filefind area addressed to "Allfix" with in the -subject line the items to search for. On all BBS'es with a filefind utility -those programs try to find the requested files and then produce a reply of -which files they have found. That reply can be in the same area, in a special -reply echo or can be sent by netmail. Usually the user gets a lot of replies -from which he can see if someone has the file(s) available he was searching -for. -
- -
Filefind Setup.
--
-Comment The comment for this area. -Origin The origin line to use for the reply. -Aka to use The Fidonet aka to use in this area. -Scan area The JAM area in which to scan for requests. -Reply area The JAM area to put the replies in, leave blank if in the same area. -Language Not in use yet, but DO select one! -Template Not in use yet. -Active If this area is active. -Deleted If this area must be deleted. -Net. reply If the reply will be sent by netmail. -Hi ACSII If high ASCII is allowed in the replies. --- - -
- - Back to index - Back to main index -
++ + + diff --git a/html/setup/files.html b/html/setup/files.html index a0a6fa9f..d471d6fc 100644 --- a/html/setup/files.html +++ b/html/setup/files.html @@ -1,4 +1,5 @@ + diff --git a/html/setup/index.htm b/html/setup/index.htm index 0ae82b24..69fc9c6b 100644 --- a/html/setup/index.htm +++ b/html/setup/index.htm @@ -1,80 +1,81 @@ - - - - - - - - -Last update 30-Jan-2001
+
+ +
MBSE BBS Setup - Filefind Areas.
++ +
Introduction.
++The filefind idea on Fidonet came from the program Allfix written by Harald +Harms. The idea is +that a user writes a mail in a filefind area addressed to "Allfix" with in the +subject line the items to search for. On all BBS'es with a filefind utility +those programs try to find the requested files and then produce a reply of +which files they have found. That reply can be in the same area, in a special +reply echo or can be sent by netmail. Usually the user gets a lot of replies +from which he can see if someone has the file(s) available he was searching +for. +
+ +
Filefind Setup.
++
+Comment The comment for this area. +Origin The origin line to use for the reply. +Aka to use The Fidonet aka to use in this area. +Scan area The JAM area in which to scan for requests. +Reply area The JAM area to put the replies in, leave blank if in the same area. +Language Not in use yet, but DO select one! +Template Not in use yet. +Active If this area is active. +Deleted If this area must be deleted. +Net. reply If the reply will be sent by netmail. +Hi ACSII If high ASCII is allowed in the replies. +++ + +
-- - - + + + + + + + + + +Last update 27-May-2001
-
- -
MBSE BBS Setup Guide
-- -
Invoking mbsetup
--As user mbse type mbsetup to start the setup -program. This version is not yet finished. There are a few items you can't -setup yet. -When you start mbsetup you will see the following screen: -
- -
- -
mbsetup main options
--
-
- -Back to index -- Edit Global configuration -
- Edit Fido networks -
- Edit Archiver programs -
- Edit Virus scanners -
- Edit Modem types -
- Edit TTY lines info -
- Edit Fidonet nodes -
- Edit BBS setup - -
- Edit Mail setup - -
- Edit File echo's setup - -
- Edit Newfiles groups -
- Edit Newfiles reports -
- Edit Filefind setup -
- Edit Files database -
- Edit BBS users -
- Edit Services -
- Edit Domains -
- Edit Task Manager -
- Show software information -
- Create site documents -
++ + + diff --git a/html/setup/language.html b/html/setup/language.html index e2e62b50..ee20445d 100644 --- a/html/setup/language.html +++ b/html/setup/language.html @@ -1,4 +1,5 @@ + diff --git a/html/setup/magic.html b/html/setup/magic.html index f9987581..1151fcc1 100644 --- a/html/setup/magic.html +++ b/html/setup/magic.html @@ -1,74 +1,75 @@ - - - - - - - - -Last update 27-May-2001
+
+ +
MBSE BBS Setup Guide
++ +
Invoking mbsetup
++As user mbse type mbsetup to start the setup +program. This version is not yet finished. There are a few items you can't +setup yet. +When you start mbsetup you will see the following screen: +
+ +
+ +
mbsetup main options
++
+
+ +Back to index +- Edit Global configuration +
- Edit Fido networks +
- Edit Archiver programs +
- Edit Virus scanners +
- Edit Modem types +
- Edit TTY lines info +
- Edit Fidonet nodes +
- Edit BBS setup + +
- Edit Mail setup + +
- Edit File echo's setup + +
- Edit Newfiles groups +
- Edit Newfiles reports +
- Edit Filefind setup +
- Edit Files database +
- Edit BBS users +
- Edit Services +
- Edit Domains +
- Edit Task Manager +
- Show software information +
- Create site documents +
-- - - + + + + + + + + + +Last update 30-Jan-2001
-
- -
MBSE BBS Setup - File Echo's Setup - Magics Files Setup.
-- -
Introduction.
--Magics are special actions that you can perform if files received in a .tic -area. The actions are: copy file to a directory, unpack file in a directory, -set number of files to keep, move file to another .tic area, update magic -request alias, adopt file into another area, store in another path, -delete file (don't process it further) and execute a command. The edit screen -is different for all kinds of actions you select. More than one magic record -may exist for each area. With all these actions you can for example can setup -processing of nodediff's and unpacking nodelists in the nodelist directory. -
- -
Magics Setup.
--
-Magic The action to perform, select with the spacebar. -Filemask The filemask to scan for. "?" Matches all characters, - "#" matches any digit and "@" any alpha character. -Active If this magic is active. -Deleted If this magic must be deleted. -Area The area in which this magic is found. -To path The destination path. (Copy, Other path and Unpack). -To area The destination area. (Adopt and Move). -Command The command to execute. (Execute). -Keep # The number of files to keep. (Keep). -Compile Trigger "compile nodelists". (Copy, Unpack and Execute). --
- -
Macro's
--In the commandline for the magic execute command you may use macro's to replace -parts of the commandline. The following macro's are defined: -
-%F Replaced by the full path and filename of the file. -%P Replaced by the full path to the file. -%N Replaced by the filename without dot and extension. -%E Replaced by the extension of the filename. -%L The last 2 characters of the filename extension. -%D The day number of the year, 3 digits. -%C The last 2 digits of the day number of the year. -%A The .tic area name. -- -- -
- - Back to File Echo's Setup - Back to index - Back to main index -
++ + + diff --git a/html/setup/mail.html b/html/setup/mail.html index f7f9048a..4f2a8aec 100644 --- a/html/setup/mail.html +++ b/html/setup/mail.html @@ -1,35 +1,36 @@ - - - - - - - - -Last update 30-Jan-2001
+
+ +
MBSE BBS Setup - File Echo's Setup - Magics Files Setup.
++ +
Introduction.
++Magics are special actions that you can perform if files received in a .tic +area. The actions are: copy file to a directory, unpack file in a directory, +set number of files to keep, move file to another .tic area, update magic +request alias, adopt file into another area, store in another path, +delete file (don't process it further) and execute a command. The edit screen +is different for all kinds of actions you select. More than one magic record +may exist for each area. With all these actions you can for example can setup +processing of nodediff's and unpacking nodelists in the nodelist directory. +
+ +
Magics Setup.
++
+Magic The action to perform, select with the spacebar. +Filemask The filemask to scan for. "?" Matches all characters, + "#" matches any digit and "@" any alpha character. +Active If this magic is active. +Deleted If this magic must be deleted. +Area The area in which this magic is found. +To path The destination path. (Copy, Other path and Unpack). +To area The destination area. (Adopt and Move). +Command The command to execute. (Execute). +Keep # The number of files to keep. (Keep). +Compile Trigger "compile nodelists". (Copy, Unpack and Execute). ++
+ +
Macro's
++In the commandline for the magic execute command you may use macro's to replace +parts of the commandline. The following macro's are defined: +
+%F Replaced by the full path and filename of the file. +%P Replaced by the full path to the file. +%N Replaced by the filename without dot and extension. +%E Replaced by the extension of the filename. +%L The last 2 characters of the filename extension. +%D The day number of the year, 3 digits. +%C The last 2 digits of the day number of the year. +%A The .tic area name. ++ ++ +
+ +Back to File Echo's Setup +Back to index +Back to main index +
-- - - + + + + + + + + + +Last update 29-Jan-2001
-
- -
MBSE BBS Setup - Mail Setup.
-- -
Edit Mail Setup.
--The Mail Setup is split in the following sections: -
- -
- - Back to index - Back to main index -
++ + + diff --git a/html/setup/modems.html b/html/setup/modems.html index 5d5e9081..ae252dd7 100644 --- a/html/setup/modems.html +++ b/html/setup/modems.html @@ -1,88 +1,89 @@ - - - - - - - - -Last update 29-Jan-2001
+
+ +
MBSE BBS Setup - Mail Setup.
++ +
Edit Mail Setup.
++The Mail Setup is split in the following sections: +
+ +
+ +Back to index +Back to main index +
-- - - + + + + + + + + + +Last update 29-Jan-2001
-
- -
MBSE BBS Setup - Modem types
--In the setup screen you can define all kinds of modems you use. This includes -ISDN modems. -This is not the setup of individual lines, that is in the next section, so -if you own a bbs with 5 analogue lines with only two brands and types of -modems connected, you need only to define those two types of modems here. Some -defaults are installed during initial bbs setup. -
- -
Setup a modem.
--
-Type The description of this modem. -Init 1 The first modem init string. -Init 2 The second init string (if needed). -Init 3 The third init string (if needed). -Reset Not in use -Hangup Only needed if drop DTR doesn't work. -Dial The dial command. -Info Command to get caller-id (not tested). -Ok The modem "OK" response. -Offset The answer/connect time offset. -Speed The maximum modem linespeed, ie 28800. -Available If this modem is available. -Deleted If this modem must be deleted. -Stripdash Strip dashes from the dial command. -Connect strings Here you can define 20 connect strings. -Error strings Here you can define 10 non-connect strings. --
- -
Special characters
--
-\\ Send one backslash. -\r Send the CR character. -\n Send the LF character. -\t Send the TAB character. -\b Send the BS character. -\s Send a space character. -\d Wait one second. -\p Wait 0,25 second. -\D Send untranslated phone number. -\T Send translated phone number. --
- -
The Hangup field
--This is only needed if your modem doesn't hangup by dropping the DTR line for -one second. Most modems do that if &D2 or &D3 is in the init string. -
- -
The Offset field.
--The Offset field is to calculate the cost for outgoing calls. -Analogue modems need time to establish the connection, 6 seconds is quite -common. So when you see the CONNECT BLABLA message, the phone connection -is there already 6 seconds and you are already paying for 6 seconds. This -offset is thus added to the total calculated connect time for cost -calculations. For ISDN modems this can be 1 or 0. -
- -
- - Back to index - Back to main index -
++ + + diff --git a/html/setup/newfiles.html b/html/setup/newfiles.html index 6823b5d6..5007feb8 100644 --- a/html/setup/newfiles.html +++ b/html/setup/newfiles.html @@ -1,54 +1,55 @@ - - - - - - - - -Last update 29-Jan-2001
+
+ +
MBSE BBS Setup - Modem types
++In the setup screen you can define all kinds of modems you use. This includes +ISDN modems. +This is not the setup of individual lines, that is in the next section, so +if you own a bbs with 5 analogue lines with only two brands and types of +modems connected, you need only to define those two types of modems here. Some +defaults are installed during initial bbs setup. +
+ +
Setup a modem.
++
+Type The description of this modem. +Init 1 The first modem init string. +Init 2 The second init string (if needed). +Init 3 The third init string (if needed). +Reset Not in use +Hangup Only needed if drop DTR doesn't work. +Dial The dial command. +Info Command to get caller-id (not tested). +Ok The modem "OK" response. +Offset The answer/connect time offset. +Speed The maximum modem linespeed, ie 28800. +Available If this modem is available. +Deleted If this modem must be deleted. +Stripdash Strip dashes from the dial command. +Connect strings Here you can define 20 connect strings. +Error strings Here you can define 10 non-connect strings. ++
+ +
Special characters
++
+\\ Send one backslash. +\r Send the CR character. +\n Send the LF character. +\t Send the TAB character. +\b Send the BS character. +\s Send a space character. +\d Wait one second. +\p Wait 0,25 second. +\D Send untranslated phone number. +\T Send translated phone number. ++
+ +
The Hangup field
++This is only needed if your modem doesn't hangup by dropping the DTR line for +one second. Most modems do that if &D2 or &D3 is in the init string. +
+ +
The Offset field.
++The Offset field is to calculate the cost for outgoing calls. +Analogue modems need time to establish the connection, 6 seconds is quite +common. So when you see the CONNECT BLABLA message, the phone connection +is there already 6 seconds and you are already paying for 6 seconds. This +offset is thus added to the total calculated connect time for cost +calculations. For ISDN modems this can be 1 or 0. +
+ +
-- - - + + + + + + + + + +Last update 30-Jan-2001
-
- -
MBSE BBS Setup - Newfiles Reports.
-- -
Introduction.
--For each network you can define one or more newfiles reports to announce the -newfiles that arrived on your BBS. The files to include in the reports are -specified by the newfiles groups you can include or exclude for announcement. -
- -
Reports Setup.
--
-Comment The comment for this report. -Msg area The JAM message base to write the report in. -Origin line The origin line to use. -From name The name to use in the "From:" field. -To name The name to use in the "To :" field. -Subject The text to use in the "Subj:" field. -Language Not in use yet, but DO select! -Template Not in use yet. -Aka to use The Fidonet aka to use in this area. -Active If this report is active. -Deleted If this report must be deleted. -High ASCII Allow high ASCII in this area. -New groups The screen to define the groups to include. --- - -
- - Back to index - Back to main index -
++ + + diff --git a/html/setup/newgroups.html b/html/setup/newgroups.html index 894dd9a0..15df32cc 100644 --- a/html/setup/newgroups.html +++ b/html/setup/newgroups.html @@ -1,49 +1,50 @@ - - - - - - - - -Last update 30-Jan-2001
+
+ +
MBSE BBS Setup - Newfiles Reports.
++ +
Introduction.
++For each network you can define one or more newfiles reports to announce the +newfiles that arrived on your BBS. The files to include in the reports are +specified by the newfiles groups you can include or exclude for announcement. +
+ +
Reports Setup.
++
+Comment The comment for this report. +Msg area The JAM message base to write the report in. +Origin line The origin line to use. +From name The name to use in the "From:" field. +To name The name to use in the "To :" field. +Subject The text to use in the "Subj:" field. +Language Not in use yet, but DO select! +Template Not in use yet. +Aka to use The Fidonet aka to use in this area. +Active If this report is active. +Deleted If this report must be deleted. +High ASCII Allow high ASCII in this area. +New groups The screen to define the groups to include. +++ + +
-- - - + + + + + + + + + +Last update 30-Jan-2001
-
- -
MBSE BBS Setup - Newfiles Groups.
-- -
Introduction
--The newfiles group are there to create separate newfiles announcements for -several networks and areas. Even if you don't want to make different -announcements you still need to define at least 2 groups. One is a group -where you don't announce files in and one where you do. These groups are -linked to the BBS file areas and must be defined before you define the BBS -file areas. As you can see in the example picture I seperated the groups -in subjects. -
- -
Newfiles Groups Setup.
--
-Name The tag name of the group. -Comment The comment for this group. -Active If this group is active. -Deleted If this group must be deleted. --- - -
- - Back to index - Back to main index -
++ + + diff --git a/html/setup/oneliner.html b/html/setup/oneliner.html index 3973e6ef..e63cf31b 100644 --- a/html/setup/oneliner.html +++ b/html/setup/oneliner.html @@ -1,37 +1,38 @@ - - - - - - - - -Last update 30-Jan-2001
+
+ +
MBSE BBS Setup - Newfiles Groups.
++ +
Introduction
++The newfiles group are there to create separate newfiles announcements for +several networks and areas. Even if you don't want to make different +announcements you still need to define at least 2 groups. One is a group +where you don't announce files in and one where you do. These groups are +linked to the BBS file areas and must be defined before you define the BBS +file areas. As you can see in the example picture I seperated the groups +in subjects. +
+ +
Newfiles Groups Setup.
++
+Name The tag name of the group. +Comment The comment for this group. +Active If this group is active. +Deleted If this group must be deleted. +++ + +
-- - - + + + + + + + + + +Last update 29-Jan-2001
-
- -
MBSE BBS Setup - BBS Setup - Oneliners.
-- -
Oneliners.
--Oneliners are small quotes that can be random selected and displayed to -your users. From the same database oneliners can be selected and inserted -at the bottom of messages. With the oneliners setup you can edit, add, -delete and import oneliners. Import is done from plain ASCII textfiles, -one quote on each line. The lines should be maximum 70 characters long. -
- -
- - Back to BBS index - Back to index - Back to main index -
++ + + diff --git a/html/setup/protocol.html b/html/setup/protocol.html index 1ffb48e8..e085ca3f 100644 --- a/html/setup/protocol.html +++ b/html/setup/protocol.html @@ -1,55 +1,56 @@ - - - - - - - - -Last update 29-Jan-2001
+
+ +
MBSE BBS Setup - BBS Setup - Oneliners.
++ +
Oneliners.
++Oneliners are small quotes that can be random selected and displayed to +your users. From the same database oneliners can be selected and inserted +at the bottom of messages. With the oneliners setup you can edit, add, +delete and import oneliners. Import is done from plain ASCII textfiles, +one quote on each line. The lines should be maximum 70 characters long. +
+ +
-- - - + + + + + + + + + +Last update 29-Jan-2001
-
- -
MBSE BBS Setup - BBS Setup - Transfer Protocols.
-- -
Introduction.
--It might look strange that you have to define transfer protocols for the bbs -while for the mailer you don't need to do that. This is historic, ifcico -already had internal protocols and the precessor of the bbs package had external -protocols. Because my priority was make the bbs working it still is that way. -When time comes I will build some of the protocols internal, adding external -protocols will allways be possible. -
- -
Transfer Protocols Setup.
--
-Select Key The key the user has to press to select this protocol. -Name The name of this protocol. -Upload The full path and filename and parameters to upload files. -Download The full path and filename and parameters to download files. -Available If this protocol is available. -Batching If this is a batching protocol. -Bi direct If this is a bi-directional protocol (Not supported yet). -Advice A small advice to the user shown before the transfer starts. -Efficiency The efficiency in percent. Has no real meaning. -Deleted If this protocol must be deleted. -Sec. level The security level a user must have to select this protocol. --- -
- - Back to BBS index - Back to index - Back to main index -
++ + + diff --git a/html/setup/safe.html b/html/setup/safe.html index 95096a82..66656ef3 100755 --- a/html/setup/safe.html +++ b/html/setup/safe.html @@ -1,29 +1,30 @@ - - - - - - - - -Last update 29-Jan-2001
+
+ +
MBSE BBS Setup - BBS Setup - Transfer Protocols.
++ +
Introduction.
++It might look strange that you have to define transfer protocols for the bbs +while for the mailer you don't need to do that. This is historic, ifcico +already had internal protocols and the precessor of the bbs package had external +protocols. Because my priority was make the bbs working it still is that way. +When time comes I will build some of the protocols internal, adding external +protocols will allways be possible. +
+ +
Transfer Protocols Setup.
++
+Select Key The key the user has to press to select this protocol. +Name The name of this protocol. +Upload The full path and filename and parameters to upload files. +Download The full path and filename and parameters to download files. +Available If this protocol is available. +Batching If this is a batching protocol. +Bi direct If this is a bi-directional protocol (Not supported yet). +Advice A small advice to the user shown before the transfer starts. +Efficiency The efficiency in percent. Has no real meaning. +Deleted If this protocol must be deleted. +Sec. level The security level a user must have to select this protocol. +++ +
-- - - + + + + + + + + + +Last update 29-Jan-2001
-
- -
MBSE BBS Setup - BBS Setup - Safe Cracker Data
--This is meant to edit users personal safe cracker records and to reset -the winner. This is not available yet. -
- - Back to BBS index - Back to index - Back to main index -
++ + + diff --git a/html/setup/services.html b/html/setup/services.html index 91e8ccdf..2f59b190 100644 --- a/html/setup/services.html +++ b/html/setup/services.html @@ -1,4 +1,5 @@ + diff --git a/html/setup/sitedoc.html b/html/setup/sitedoc.html index 95435f3f..aff19909 100644 --- a/html/setup/sitedoc.html +++ b/html/setup/sitedoc.html @@ -1,37 +1,38 @@ - - - - - - - - -Last update 29-Jan-2001
+
+ +
MBSE BBS Setup - BBS Setup - Safe Cracker Data
++This is meant to edit users personal safe cracker records and to reset +the winner. This is not available yet. +
-- - - + + + + + + + + + +Last update 30-Jan-2001
-
- -
MBSE BBS Setup - Create Sitedocs.
-- -
Create Sitedocs
--This option creates 3 documents in the doc directory under the home directory -of MBSE BBS, site.doc, xref.doc and stat.doc. Only the file site.doc is more -or less complete, the other 2 are heavily under construction. These three -files are a complete reference of your BBS setup. Especially the site.doc is -a large document, think at least four times before you send it to a printer. -The document xref.doc will contain lists with data from your setup that -depends on eachother. The file stat.doc will be a listing of all statistic -counters that are present in several data files. -
- - Back to index - Back to main index -
++ + + diff --git a/html/setup/softinfo.html b/html/setup/softinfo.html index 933e4137..b9b0d479 100644 --- a/html/setup/softinfo.html +++ b/html/setup/softinfo.html @@ -1,31 +1,32 @@ - - - - - - - - -Last update 30-Jan-2001
+
+ +
MBSE BBS Setup - Create Sitedocs.
++ +
Create Sitedocs
++This option creates 3 documents in the doc directory under the home directory +of MBSE BBS, site.doc, xref.doc and stat.doc. Only the file site.doc is more +or less complete, the other 2 are heavily under construction. These three +files are a complete reference of your BBS setup. Especially the site.doc is +a large document, think at least four times before you send it to a printer. +The document xref.doc will contain lists with data from your setup that +depends on eachother. The file stat.doc will be a listing of all statistic +counters that are present in several data files. +
-- - - + + + + + + + + + +Last update 30-Jan-2001
-
- -
MBSE BBS Setup - Show Software Information.
-- -
Introduction
--This screen shows the information about the MBSE BBS software, copyright and -release policy. -
- - Back to index - Back to main index -
++ + + diff --git a/html/setup/taskmgr.html b/html/setup/taskmgr.html index 7f85852d..de7e04a2 100644 --- a/html/setup/taskmgr.html +++ b/html/setup/taskmgr.html @@ -1,4 +1,5 @@ + diff --git a/html/setup/tic.html b/html/setup/tic.html index d23d0bb7..9ee68cdb 100644 --- a/html/setup/tic.html +++ b/html/setup/tic.html @@ -1,37 +1,38 @@ - - - - - - - - -Last update 30-Jan-2001
+
+ +
MBSE BBS Setup - Show Software Information.
++ +
Introduction
++This screen shows the information about the MBSE BBS software, copyright and +release policy. +
-- - - + + + + + + + + + +Last update 29-Jan-2001
-
- -
MBSE BBS Setup - File Echo's Setup.
-- -
File Echo's Setup.
--The File Echo's Setup is split in the following sections: -
- -
- - Back to index - Back to main index -
++ + + diff --git a/html/setup/timebank.html b/html/setup/timebank.html index 1e29c545..00f8bf79 100755 --- a/html/setup/timebank.html +++ b/html/setup/timebank.html @@ -1,29 +1,30 @@ - - - - - - - - -Last update 29-Jan-2001
+
+ +
MBSE BBS Setup - File Echo's Setup.
++ +
File Echo's Setup.
++The File Echo's Setup is split in the following sections: +
+ +
+ +Back to index +Back to main index +
-- - - + + + + + + + + + +Last update 29-Jan-2001
-
- -
MBSE BBS Setup - BBS Setup - TimeBank.
--This is meant to edit the users personal timebank records. This is not -available yet. -
- - Back to BBS index - Back to index - Back to main index -
++ + + diff --git a/html/setup/ttyinfo.html b/html/setup/ttyinfo.html index fd84d178..d7b01bdf 100644 --- a/html/setup/ttyinfo.html +++ b/html/setup/ttyinfo.html @@ -1,4 +1,5 @@ + diff --git a/html/setup/users.html b/html/setup/users.html index bd510a5b..dc14e639 100644 --- a/html/setup/users.html +++ b/html/setup/users.html @@ -1,4 +1,5 @@ + diff --git a/html/setup/virscan.html b/html/setup/virscan.html index 6eb4b3af..c66c726d 100644 --- a/html/setup/virscan.html +++ b/html/setup/virscan.html @@ -1,4 +1,5 @@ +Last update 29-Jan-2001
+
+ +
MBSE BBS Setup - BBS Setup - TimeBank.
++This is meant to edit the users personal timebank records. This is not +available yet. +