home *** CD-ROM | disk | FTP | other *** search
/ Meeting Pearls 3 / Meeting_Pearls_III.iso / Pearls / comm / Fido / TrapDoor / docs / ExtraUtils.Man < prev    next >
Text File  |  1994-06-23  |  14KB  |  560 lines
  1.  
  2.  
  3.      Page 1             TrapDoor's Extra Utilities              Page 1
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.                               Extra Utilities
  22.                             Copyright (c) 1994
  23.                    Maximilian Hantsch and Martin Laubach
  24.                             All rights reserved
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.                        Extra Utilities Documentation
  32.                          Friday 27-May-94 12:41:17
  33.                             Copyright (c) 1994
  34.                             Maximilian Hantsch
  35.                             All rights reserved
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.                  This manual describes the extra utilities
  46.                          which come with TrapDoor.
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.      Page 2             TrapDoor's Extra Utilities              Page 2
  66.  
  67.  
  68.   1. Introduction     
  69.  
  70.        This manual is a description of the extra utilities that come
  71.      with TrapDoor, quickly summarizing the usage of each of these
  72.      little goodies.  Please  also  consult  the manuals for TrapDoor
  73.      and TrapList for additional information  on  the nodelist, the
  74.      extra database, and other topics you find missing in here.  
  75.  
  76.        If you are new to Fidonet, we recommend to read TrapDoor's
  77.      Fidonet Manual (FidoNet.Man) first.  
  78.  
  79.  
  80.  
  81.  
  82.  
  83.  
  84.  
  85.   2. The Programs     
  86.  
  87.        The "Extra Utilities" comprise the following utility programs: 
  88.  
  89.         clearacct    enumnet      enumnodes    getnode
  90.         listacct     listconfig   listnodes    listpasswd
  91.         setconfig    setpasswd    shownl
  92.  
  93.        All of these programs are little tools that use functions in
  94.      traplist.library to access the Fidonet nodelist and the
  95.      so-called extra database. Using these utilities you can retrieve
  96.      information from the nodelist and extra database, and also
  97.      change some of the information in the extra database.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.      The Programs
  125.  
  126.  
  127.      Page 3             TrapDoor's Extra Utilities              Page 3
  128.  
  129.  
  130.   2.1. clearacct     
  131.  
  132.      Usage: clearacct <nodenumber>
  133.             clearacct ALL
  134.  
  135.        Clears the TrapDoor accounting information for a single node
  136.      or all systems.  
  137.  
  138.      Examples: clearacct 2:310/6 
  139.                clearacct all 
  140.  
  141.   2.2. enumnet     
  142.  
  143.      Usage: enumnet <nodenumber>
  144.  
  145.        Shows all nodes and points in the network in which the given
  146.      node resides.  
  147.  
  148.      Example: enumnet 2:310/3 
  149.  
  150.   2.3. enumnodes     
  151.  
  152.      Usage: enumnodes
  153.  
  154.        Enumerates through all the nodes in the nodelist, printing out
  155.      all zone entries.  
  156.  
  157.      Example: enumnodes 
  158.  
  159.   2.4. getnode     
  160.  
  161.      Usage: getnode <nodenumber>
  162.  
  163.        Retrieves and displays nodelist information about a single
  164.      node. The output will be something like: 
  165.  
  166.           Node 2:310/6.0, "The Mad House" is in Vienna Austria
  167.           Operated by Rene Hexel
  168.           Region 31, Hub 0
  169.           Baud 9600
  170.           Phone 603-8532, Cost 0.67
  171.           Flags CM,XW,V32,V42,V42B
  172.           Password secret
  173.  
  174.      Example: getnode 2:310/6 
  175.  
  176.   2.5. listacct     
  177.  
  178.      Usage: listacct
  179.  
  180.        Displays all accounting information that is stored in the
  181.      extra database. For each node that has accounting information,
  182.      it displays the node number, the total cost of calls since the
  183.      last "clearacct", the number of outgoing calls, the number of
  184.  
  185.  
  186.      The Programs                                         listacct
  187.  
  188.  
  189.      Page 4             TrapDoor's Extra Utilities              Page 4
  190.  
  191.  
  192.      incoming calls, the number of good sessions, the number of
  193.      failed sessions, the number of BUSY, NO CARRIER/NO DIALTONE, and
  194.      the number of VOICE connects.  
  195.  
  196.        Finally, if the information is available, it will display the
  197.      TrxID of the last session that you had with the remote system.  
  198.  
  199.      Example: listacct 
  200.  
  201.        yields: 
  202.  
  203.         Node         |    Cost   CO  CI   S+  S-    B   N   V
  204.      ----------------+-----------------------------------------
  205.        2:310/6.0     |    0.57    3   0    2   0    1   0   0
  206.                      |       Last session: 2B944A8E/2B944B60
  207.        2:310/90.0    |    2.00    4   0    2   0    2   0   0
  208.                      |       Last session: 2B9449C2/2B944A98
  209.  
  210.   2.6. listconfig     
  211.  
  212.      Usage: listconfig
  213.  
  214.        Shows all the custom configuration entries in the extra
  215.      database. The output will be something like: 
  216.  
  217.            Node         : Config
  218.           ------------------------
  219.           1:134/2003.0  : Call 001-403-347-3269 ModemDialPre ATS7=90X7DT
  220.           2:205/428.0   : minbaud 2400 noemsi
  221.  
  222.      Example: listconfig 
  223.  
  224.   2.7. listnodes     
  225.  
  226.      Usage: listnodes
  227.  
  228.        Lists all nodes in the nodelist. The output will be HUGE! 
  229.  
  230.      Example: listnodes 
  231.  
  232.   2.8. listpasswd     
  233.  
  234.      Usage: listpasswd
  235.  
  236.        Shows all the password entries in the extra database. The
  237.      output will be something like: 
  238.  
  239.            Node         : Password
  240.           ------------------------
  241.           2:2/5.0       : dont
  242.           2:2/6.0       : even
  243.           2:310/6.0     : think
  244.           2:310/6.1     : about
  245.           2:310/30.0    : it42
  246.  
  247.  
  248.      The Programs                                       listpasswd
  249.  
  250.  
  251.      Page 5             TrapDoor's Extra Utilities              Page 5
  252.  
  253.  
  254.      Example: listpasswd 
  255.  
  256.   2.9. setconfig     
  257.  
  258.      Usage: setconfig <nodenumber> "<special config>"
  259.             setconfig <nodenumber> ""
  260.             setconfig <nodenumber>
  261.  
  262.        Modify and examine individual custom config entries. The first
  263.      form sets a special configuration entry, the second removes it,
  264.      and the third invocation style displays the current setting.  
  265.  
  266.      Examples: setconfig 2:310/6 "NOEMSI NOWAZOO" 
  267.                setconfig 2:310/6 "" 
  268.                setconfig 2:310/6 
  269.  
  270.   2.10. setpasswd     
  271.  
  272.      Usage: setpasswd <nodenumber> "<password>"
  273.             setpasswd <nodenumber> ""
  274.             setpasswd <nodenumber>
  275.  
  276.        Modify and examine individual session password entries. The
  277.      first form sets a password entry, the second removes it, and the
  278.      third invocation style displays the current password with that
  279.      node.  
  280.  
  281.      Examples: setpasswd 2:310/6 "magic1" 
  282.                setpasswd 2:310/6 "" 
  283.                setpasswd 2:310/6 
  284.  
  285.   2.11. shownl     
  286.  
  287.      Usage: shownl
  288.  
  289.        Displays the names of all the nodelists that were used to
  290.      compile the current nodelist index file (fidonet.index).  
  291.  
  292.      Example: shownl 
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.      The Programs                                           shownl
  311.  
  312.  
  313.      Page 6             TrapDoor's Extra Utilities              Page 6
  314.  
  315.  
  316.   3. Politics     
  317.  
  318.        This chapter describes the software Licence for the extra
  319.      utilities, how they may be distributed, and where you can find
  320.      Support for the programs. Plus, some legalese.  
  321.  
  322.   3.1. Distribution & Licence     
  323.  
  324.        These extra utilities are part of TrapDoor®. Being part of the
  325.      TrapDoor® package, the same software Licence as for TrapDoor®
  326.      applies to these extra utilities. They may be distributed freely
  327.      as part of the TrapDoor® package: 
  328.  
  329.        The distributor may only charge a fee up to the costs of
  330.      obtaining a public domain diskette from Fred Fish. The
  331.      distributor agrees to cease distributing the programs and data
  332.      involved if requested to do so by the authors. The distributor
  333.      may only distribute an unmodified copy of the original program,
  334.      with all the supplied documentation and copyright notices
  335.      intact.  
  336.  
  337.   3.2. Support     
  338.  
  339.        The latest version of TrapDoor (with all its associated tools)
  340.      is always available for filerequest from FidoNet node 2:310/6,
  341.      "The Mad House" under the magic filename "TRAPDOOR".  
  342.  
  343.        If you have any suggestions, bug reports etc., feel free to
  344.      contact the authors of TrapDoor at the address given in the
  345.      chapter "Registration" of the TrapDoor manual, or at one of
  346.      these addresses: 
  347.  
  348.           Maximilian Hantsch      Martin Laubach
  349.           Fido: 2:310/6           Fido: 2:310/3.14
  350.           Uucp: max@madvie.co.at  Uucp: mjl@alison.co.at
  351.  
  352.        Also, there is a FidoNet Echomail conference called TRAPDOOR,
  353.      which should be available at major backbones. This conference is
  354.      in English and intended for the users of TrapDoor and the extra
  355.      utilities. There, you can freely exchange your experience with
  356.      the software, discuss future enhancements you would like to see
  357.      etc. The authors will participate in the conference and try to
  358.      assist you. The availability of new versions of TrapDoor will be
  359.      announced there, too.  
  360.  
  361.  
  362.  
  363.  
  364.  
  365.  
  366.  
  367.  
  368.  
  369.  
  370.  
  371.  
  372.      Politics                                              Support
  373.  
  374.  
  375.      Page 7             TrapDoor's Extra Utilities              Page 7
  376.  
  377.  
  378.   3.3. No Warranty    
  379.  
  380.        THERE IS NO WARRANTY FOR THE PROGRAMS, TO THE EXTENT PERMITTED
  381.      BY APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE
  382.      COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAMS "AS
  383.      IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED,
  384.      INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  385.      MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE
  386.      ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAMS IS
  387.      WITH YOU.  SHOULD THE PROGRAMS PROVE DEFECTIVE, YOU ASSUME THE
  388.      COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.  
  389.  
  390.        IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
  391.      WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY
  392.      REDISTRIBUTE THE PROGRAMS AS PERMITTED ABOVE, BE LIABLE TO YOU
  393.      FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
  394.      CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
  395.      THE PROGRAMS (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA
  396.      BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
  397.      PARTIES OR A FAILURE OF THE PROGRAMS TO OPERATE WITH ANY OTHER
  398.      PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED
  399.      OF THE POSSIBILITY OF SUCH DAMAGES.  
  400.  
  401.  
  402.  
  403.  
  404.   3.4. Disclaimer     
  405.  
  406.        No warranty, either express or implied, is made with respect
  407.      to the fitness or merchantability of the extra utilities
  408.      described herein.  
  409.  
  410.        Maximilian Hantsch and Martin Laubach (referred to as "the
  411.      authors"), reserve the right to not develop any future versions
  412.      of these programs.  
  413.  
  414.        The authors will try to make a good faith attempt at
  415.      correcting any problems if any are discovered, but are in no way
  416.      required, nor bound to correct them.  
  417.  
  418.        The authors neither assume nor accept any responsibility for
  419.      the use or misuse of these programs. They also will not be held
  420.      liable for damages or any compensation beyond the original
  421.      registration fee due to loss of profit or any other damages
  422.      arising out of the use, or inability to use these programs.  
  423.  
  424.        Neither Maximilian Hantsch nor Martin Laubach will be liable
  425.      for any damage arising from the failure of these programs to
  426.      perform as described, or any destruction of other programs or
  427.      data residing on a system attempting to run the programs.  While
  428.      we know of no damaging errors, the user of these programs uses
  429.      it at his or her own risk.  
  430.  
  431.  
  432.  
  433.  
  434.      Politics                                           Disclaimer
  435.  
  436.  
  437.      Page 8             TrapDoor's Extra Utilities              Page 8
  438.  
  439.  
  440.   4. Acknowledgements     
  441.  
  442.        The following names are either trademarks or the efforts of
  443.      the person and/or company listed: 
  444.  
  445.        Amiga and AmigaDOS are trademarks of Commodore-Amiga, Inc.
  446.        ARexx by William S. Hawes, Wishful Thinking Development Corp.
  447.        Fido and FidoNet are trademarks of Tom Jennings, Fido Software.
  448.        Many Thanks to all our beta testers.
  449.        Special Proofreading: Arnout Grootveld.
  450.        Special Thanks to all our Registered Users.
  451.        TrapDoor is a registered trademark of Maximilian Hantsch
  452.                                          and Martin Laubach.
  453.        TrapList, TrapPoll, TrapTell and traplist.library
  454.                       by Maximilian Hantsch and Martin Laubach.
  455.        TrapToss by René Hexel.
  456.  
  457.  
  458.  
  459.  
  460.  
  461.  
  462.  
  463.  
  464.  
  465.  
  466.  
  467.  
  468.  
  469.  
  470.  
  471.  
  472.  
  473.  
  474.  
  475.  
  476.  
  477.  
  478.  
  479.  
  480.  
  481.  
  482.  
  483.  
  484.  
  485.  
  486.  
  487.  
  488.  
  489.  
  490.  
  491.  
  492.  
  493.  
  494.  
  495.  
  496.      Acknowledgements
  497.  
  498.  
  499.      Road Map           TrapDoor's Extra Utilities            paM daoR
  500.  
  501.  
  502.   Road Map
  503.  
  504.  
  505.         1. Introduction    .....................................    2
  506.         2. The Programs    .....................................    2
  507.            2.1. clearacct    ...................................    3
  508.            2.2. enumnet    .....................................    3
  509.            2.3. enumnodes    ...................................    3
  510.            2.4. getnode    .....................................    3
  511.            2.5. listacct    ....................................    3
  512.            2.6. listconfig    ..................................    4
  513.            2.7. listnodes    ...................................    4
  514.            2.8. listpasswd    ..................................    4
  515.            2.9. setconfig    ...................................    5
  516.            2.10. setpasswd    ..................................    5
  517.            2.11. shownl    .....................................    5
  518.         3. Politics    .........................................    6
  519.            3.1. Distribution & Licence    ......................    6
  520.            3.2. Support    .....................................    6
  521.            3.3. No Warranty   ..................................    7
  522.            3.4. Disclaimer    ..................................    7
  523.         4. Acknowledgements    .................................    8
  524.  
  525.  
  526.  
  527.  
  528.  
  529.  
  530.  
  531.  
  532.  
  533.  
  534.  
  535.  
  536.  
  537.  
  538.  
  539.  
  540.  
  541.  
  542.               "I think my life needs a rewind/erase button."
  543.               -- "... and a volume control." [Calvin/Hobbes]
  544.  
  545.  
  546.  
  547.  
  548.  
  549.  
  550.  
  551.  
  552.  
  553.  
  554.  
  555.  
  556.  
  557.  
  558.      Road Map
  559.  
  560.