added help writeup for logging to file

git-svn-id: http://svn.klever.net/kin/pumpkin/trunk@145 fe716a7a-6dde-0310-88d9-d003556173a8

2 files changed, 11 insertions, 3 deletions

diff --git a/help/pumpkin.rtf b/help/pumpkin.rtf
index 9c02ca9..abdca4f 100644
--- a/help/pumpkin.rtf
+++ b/help/pumpkin.rtf
@@ -7,77 +7,79 @@ DO NOT MODIFY THIS FILE DIRECTLY. EDIT XML DOCUMENT INSTEAD
    \red0\green0\blue0;\red0\green0\blue255;\red0\green255\blue255;\red0\green255\blue0;

    \red255\green0\blue255;\red255\green0\blue0;\red255\green255\blue0;\red255\green255\blue255;

    \red0\green0\blue128;\red0\green128\blue128;\red0\green128\blue0;\red128\green0\blue128;

    \red128\green0\blue0;\red128\green128\blue0;\red128\green128\blue128;\red192\green192\blue192;}

   

 \pard\plain\keepn

 #{\footnote About}

 ${\footnote About PumpKIN}

 K{\footnote about}

 { \f1\fs18\b\sb120 About {\b PumpKIN}}

 \par\sa120\sb120\qj\pard \f1\fs18\sb120 {\b PumpKIN} is a program designed to send and receive files over the net while having {\uldb {\b T42}}{\v %!ExecFile("http://kin.klever.net/T42/")} or {\b\cf6 Wintalk} session running using {\i TFTP} ({\uldb {\b RFC1350}}{\v %!ExecFile("http://www.rfc-editor.org/rfc/rfc1350.txt")}) protocol. It includes full-functional {\i TFTP} server/client so it may be useful for maintaining {\uldb CISCO}{\v %!ExecFile("http://www.cisco.com/")} routers and other network equipment.

 \par\sa120\sb120\qj\pard \f1\fs18\sb120 

 \par\sa120\sb120\qj\pard \f1\fs18\sb120 {\b {\i Enjoy!}}

 {

 \par\pard\plain\sb360\sa120 \f1\fs16 Copyright (c) 1997-2006 {\uldb\cf0 Klever Group (http://www.klever.net/)}{\v %!ExecFile("http://www.klever.net/")}

 \par\qj\sb120\sa120Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

 \par The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

 \par \sa360 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

 }

 \page

 

 \pard\plain

 #{\footnote News}

 ${\footnote What's New}

-\par\pard\plain\f1\fs24\qc\cf2\b 2.7 - February 1st, 2006

+\par\pard\plain\f1\fs24\qc\cf2\b 2.7 - 

 \par\pard\plain\fi0\li0\f1\fs18 \bullet  Added acess lists based on request IP address and TFTP opcode for automating access policy

 \par\pard\plain\fi0\li0\f1\fs18 \bullet  Added possibility to start/stop TFTP server, while keeping client functionality intact

+\par\pard\plain\fi0\li0\f1\fs18 \bullet  Logging to file

 \par\pard\plain\f1\fs24\qc\cf2\b 2.6 - August 6th, 2005

 \par\pard\plain\fi0\li0\f1\fs18 \bullet  more robust solution to the backslash/slash dilemma

 \par\pard\plain\fi0\li0\f1\fs18 \bullet  A bit more elaborate error reporting

 \par\pard\plain\fi0\li0\f1\fs18 \bullet  Fixed uninstall procedure so that it works on XP

 \par\pard\plain\f1\fs24\qc\cf2\b 2.5 - July 11th, 2004

 \par\pard\plain\fi0\li0\f1\fs18 \bullet  Change of {\uldb license}{\v About} and opening the source.

 \par\pard\plain\fi0\li0\f1\fs18 \bullet  Minor cosmetic changes

 \par\pard\plain\f1\fs24\qc\cf2\b 2.0 - June 13th, 1998

 \par\pard\plain\fi0\li0\f1\fs18 \bullet  Sounds customization. Now you can customize {\b PumpKIN} bells and whistles or turn them off completely.

 \par\pard\plain\fi0\li0\f1\fs18 \bullet  Previous version of {\b PumpKIN} had a bug causing it to misbehave when you're requesting file from remote {\i tftp} server using {\b IP Address} (as opposed to {\b hostname}).

 \par\pard\plain\fi0\li0\f1\fs18 \bullet  Typo causing {\b PumpKIN} to log outgoing request in reverse (i.e. {\i Requesting 'hostname' from 'filename'}) fixed.

 \par\pard\plain\fi0\li0\f1\fs18 \bullet  Something else that you may not notice and I can not remember.

 \par\pard\plain\f1\fs24\qc\cf2\b 1.5 - February 12th, 1998

 \par\pard\plain\fi0\li0\f1\fs18 \bullet  Transfer resumes. No checking on file contents is done, so it's up to you to decide whether you want to start transmission from the beginning or resume unfinished transfer.

 \par\pard\plain\fi0\li0\f1\fs18 \bullet  Support for {\b block size}, {\b trasnfer size} and {\b transfer timeout} options as described in {\uldb {\b RFC1782}}{\v %!ExecFile("http://www.rfc-editor.org/rfc/rfc1782.txt")}, {\uldb {\b RFC1783}}{\v %!ExecFile("http://www.rfc-editor.org/rfc/rfc1783.txt")} and {\uldb {\b RFC1784}}{\v %!ExecFile("http://www.rfc-editor.org/rfc/rfc1784.txt")}. I'm not sure if there are any other {\i TFTP} implementations supporting this, but at least it makes sense if you use {\b PumpKIN} on both ends.

 \par\pard\plain\fi0\li0\f1\fs18 \bullet  New Install program

 \page

 

 \pard\plain\keepn

 #{\footnote Using}

 ${\footnote Using PumpKIN}

 { \f1\fs18\b\sb120 Using {\b PumpKIN}}

 \par\sa120\sb120\qj\pard \f1\fs18\sb120 This is a simple program for file exchange between two parties. It allows you to send files over the network to your party while having a {\uldb {\b T42}}{\v %!ExecFile("http://kin.klever.net/T42/")} or {\b\cf6 Wintalk} conversation. It uses open sessions to determine IP address of your party. Also you may use it as a {\i TFTP} client/server by itself. To get/put files from/to {\i TFTP} server you need to enter host name/IP address manually in the {\uldb Request Dialog}{\v Request}.

 \par\sa120\sb120\qj\pard \f1\fs18\sb120 To Abort transfer(s) currently in progress - select transfer(s) you want to terminate in the list and click {\b Abort xfer} button.

 \par\sa120\sb120\qj\pard \f1\fs18\sb120 You may want to hide {\b PumpKIN} window and leave it as a tray icon only. Just click the \{bmct pumpkin.bmp\} icon in the tray or simply close the window.

 \par\sa120\sb120\qj\pard \f1\fs18\sb120 Use {\uldb Options}{\v Options} button to set {\b PumpKIN} options.

+\par\sa120\sb120\qj\pard \f1\fs18\sb120 You can start and stop {\b PumpKIN}'s {\i TFTP} server by checking and unchecking the {\b Server is running} checkbox in the lower right corner of main {\b PumpKIN} window.

 \page

 

 \pard\plain\keepn

 #{\footnote ConfirmRRQ}

 ${\footnote Confirm Read Request Dialog}

 { \f1\fs18\b\sb120 Confirm Read Request Dialog}

 \par\sa120\sb120\qj\pard \f1\fs18\sb120 When the file is requested from your {\i TFTP} server you may choose to {\b Grant Access} to this file or to {\b Deny Access}. If you hesitate to answer for {\uldb {\b Confirmation timeout}}{\v ConfirmationTimeout} ({\i default - 30 seconds}) {\b PumpKIN} defaults to denial of all requests.

 \page

 

 \pard\plain\keepn

 #{\footnote ConfirmWRQ}

 ${\footnote Confirm Write Request Dialog}

 { \f1\fs18\b\sb120 Confirm Write Request Dialog}

 \par\sa120\sb120\qj\pard \f1\fs18\sb120 Whenever your party sends you a file you have always a choice to accept it or not. You can also save the file under a different name by choosing the {\b Rename} option. If you already have file with such name you may chose to {\b resume} transfer. No checking on file contents is done. This option may or may not work depending on remote implementation of protocol. It does work if you use {\b PumpKIN} on both ends. If you are still unsure for {\uldb {\b Confirmation timeout}}{\v ConfirmationTimeOut} ({\i default - 30 seconds}) {\b PumpKIN} will make safe decision for you (deny).

 \page

 

 \pard\plain\keepn

 #{\footnote Request}

 ${\footnote Request Dialog}

 { \f1\fs18\b\sb120 Request Dialog}

 \par\sa120\sb120\qj\pard \f1\fs18\sb120 Request dialog is aimed to let you form read or write request. You may set the following options:\pard

 \par \fi0\li0 \bullet   {\b Local File} - You can change the name of the file you're sending (or destination in case you're receiving) right here. You may also use {\b Browse} button to select the file.

 \par \fi0\li0 \bullet   {\b Remote File} Specifies the name of file on the remote host you're requesting (in case of read request) or the name of file you want your file to appear as (in case of write request).

 \par \fi0\li0 \bullet   {\b Remote Host} is your party's host or {\i TFTP} server you're requesting file from/sending file to. To refresh the list of your talk windows use {\b REFRESH} button.

@@ -90,43 +92,47 @@ ${\footnote Request Dialog}
 ${\footnote Options}

 { \f1\fs18\b\sb120 Options}

 \par\sa120\sb120\qj\pard \f1\fs18\sb120 {\b PumpKIN} options property sheet consists of two tabs. For more information see {\uldb {\b Network}}{\v NetworkOptions} and {\b Server} options.

 \page

 

 \pard\plain\keepn

 #{\footnote NetworkOptions}

 ${\footnote Network Options}

 { \f1\fs18\b\sb120 Network Options}\pard

 \par \fi0\li0 \bullet   {\b UDP Ports}\pard

 \par \fi0\li0 \bullet   {\b Listen for incoming connections on port} - specifies the port we're listening to. The default as defined in {\uldb {\b RFC1350}}{\v %!ExecFile("http://www.rfc-editor.org/rfc/rfc1350.txt")} is 69.

 \par \fi0\li0 \bullet   {\b Send outgoing requests to port} - specifies the port we're going to send all requests to.\pard

 \par \fi0\li0 \bullet   {\b Default Connection timeout} - if there's no activity for specified time, transfer is considered to be dead and terminated. {\b PumpKIN} tries to propagate this value to remote as described in {\uldb {\b RFC1782}}{\v %!ExecFile("http://www.rfc-editor.org/rfc/rfc1782.txt")} and {\uldb {\b RFC1784}}{\v %!ExecFile("http://www.rfc-editor.org/rfc/rfc1784.txt")} if possible.

 \par \fi0\li0 \bullet   {\b Default Block Size} - {\b PumpKIN} tries to negotiate block size with remote using this value unless specified explicitly in request. If remote doesn't support {\uldb {\b RFC1782}}{\v %!ExecFile("http://www.rfc-editor.org/rfc/rfc1782.txt")} and {\uldb {\b RFC1783}}{\v %!ExecFile("http://www.rfc-editor.org/rfc/rfc1783.txt")}{\b PumpKIN} falls back to 512 bytes per block.\pard

 \page

 

 \pard\plain\keepn

 #{\footnote ServerOptions}

 ${\footnote Server Options}

 { \f1\fs18\b\sb120 Server Options}\pard

 \par \fi0\li0 \bullet   {\b TFTP Filesystem root} - Specifies the location of files you're transmitting or where to start looking for them from. Defaults to the directory you start {\b PumpKIN} for the first time from.

 \par \fi0\li0 \bullet   {\b Allow access to subdirectories} - specifies whether you want allow access to the whole subtree of {\b TFTP Root} or only to the directory itself.

 \par \fi0\li0 \bullet   {\b Read Request Behavior} - You may choose to automatically agree to give all files requested, to be prompted to confirm these operations, or to deny all requests as if you're not even here.

 \par \fi0\li0 \bullet   {\b Write Request Behavior} - You may chose to {\b take all files} ({\i not recommended}), to {\b prompt only if file exists already}, {\b Always prompt} or {\b Deny all requests}.

-\par \fi0\li0 \bullet   {#{\footnote ConfirmationTimeOut}}{\b Confirmation timeout} - this is the time {\b PumpKIN} will wait for you to accept or deny request before it will give up and take default action which is always deny.\pard

+\par \fi0\li0 \bullet   {#{\footnote ConfirmationTimeOut}}{\b Confirmation timeout} - this is the time {\b PumpKIN} will wait for you to accept or deny request before it will give up and take default action which is always deny.

+\par \fi0\li0 \bullet   {\b Log file} - If you want to enable logging to file, set the destination file here.\pard

 \page

 

 \pard\plain\keepn

 #{\footnote SoundsOptions}

 ${\footnote Sounds Options}

 { \f1\fs18\b\sb120 Sounds}

 \par\sa120\sb120\qj\pard \f1\fs18\sb120 You can customize {\b PumpKIN} sounds notifications here. There are three customizable sounds defined - {\b Incoming request}, which notifies you about incoming request prompt if you're set to be prompted whenever incoming request occurs. {\b xfer Aborted} - which happens to sound every time transfer is interrupted for whatever reason - time out, explicit kill, denied access, etc. {\b xfer Finished} means that your file was successfully transmitted.

 \par\sa120\sb120\qj\pard \f1\fs18\sb120 You can select any {\b .wav} file or one of the predefined sounds from the dropdown list.

 \page

 

 \pard\plain\keepn

 #{\footnote ACL}

 ${\footnote Access Lists}

 { \f1\fs18\b\sb120 Access Lists}

 \par\sa120\sb120\qj\pard \f1\fs18\sb120 You can slightly automate your access policies by setting up read/write request behavior for different incoming requests.

-\par\sa120\sb120\qj\pard \f1\fs18\sb120 The rule consists of {\b request type}, source networke ({\b ip} and {\b netmask}) and {\b action} to take (see also {\uldb Server Options}{\v ServerOptions}).

+\par\sa120\sb120\qj\pard \f1\fs18\sb120 The rule consists of {\b request type}, source network ({\b ip} and {\b netmask}) and {\b action} to take (see also {\uldb Server Options}{\v ServerOptions}).

+\par\sa120\sb120\qj\pard \f1\fs18\sb120 When {\b PumpKIN} receives request it goes through the list of rules and bases its decision on the first matching rule. To rearrange order of rules, select the rule you wish to move and use up and down arrows buttons on the right. To remove rule, use the cross button.

+\par\sa120\sb120\qj\pard \f1\fs18\sb120 To add a new rule fill in the information about {\b request type}, source {\b address} and {\b netmask} and desired action. Then click on the 'Add new rule' button.

+\par\sa120\sb120\qj\pard \f1\fs18\sb120 If you wish to amend the rule, select it in the rules list, change parameters below and click the 'Replace rule' button.

 \page

 }
\ No newline at end of file
diff --git a/help/pumpkin.xml b/help/pumpkin.xml
index 944bb54..46e3bbc 100644
--- a/help/pumpkin.xml
+++ b/help/pumpkin.xml
@@ -1,38 +1,39 @@
 <?xml version="1.0"?>

 <winhelp>

  <topic id="About" title="About PumpKIN" keywords="about">

   <heading scroll="no">About <kin>PumpKIN</kin></heading>

   <p><kin>PumpKIN</kin> is a program designed to send and receive files over the net while having <kin href="http://kin.klever.net/T42/">T42</kin> or <product>Wintalk</product> session running using <term>TFTP</term> (<rfc num="1350"/>) protocol. It includes full-functional <term>TFTP</term> server/client so it may be useful for maintaining <a href="http://www.cisco.com/">CISCO</a> routers and other network equipment.</p>

   <p/>

   <p><b><i>Enjoy!</i></b></p>

   <license years="1997-2006"/>

   <credist/>

  </topic>

  <topic id="News" title="What's New">

   <newsfor version="2.7" date="">

    <ni>Added acess lists based on request IP address and TFTP opcode for automating access policy</ni>

    <ni>Added possibility to start/stop TFTP server, while keeping client functionality intact</ni>

+   <ni>Logging to file</ni>

   </newsfor>

   <newsfor version="2.6" date="August 6th, 2005">

    <ni>more robust solution to the backslash/slash dilemma</ni>

    <ni>A bit more elaborate error reporting</ni>

    <ni>Fixed uninstall procedure so that it works on XP</ni>

   </newsfor>

   <newsfor version="2.5" date="July 11th, 2004">

    <ni>Change of <a href="#About">license</a> and opening the source.</ni>

    <ni>Minor cosmetic changes</ni>

   </newsfor>

   <newsfor version="2.0" date="June 13th, 1998">

    <ni>Sounds customization. Now you can customize <kin>PumpKIN</kin> bells and whistles or turn them off completely.</ni>

    <ni>Previous version of <kin>PumpKIN</kin> had a bug causing it to misbehave when you're requesting file from remote <term>tftp</term> server using <b>IP Address</b> (as opposed to <b>hostname</b>).</ni>

    <ni>Typo causing <kin>PumpKIN</kin> to log outgoing request in reverse (i.e. <i>Requesting 'hostname' from 'filename'</i>) fixed.</ni>

    <ni>Something else that you may not notice and I can not remember.</ni>

   </newsfor>

   <newsfor version="1.5" date="February 12th, 1998">

    <ni>Transfer resumes. No checking on file contents is done, so it's up to you to decide whether you want to start transmission from the beginning or resume unfinished transfer.</ni>

    <ni>Support for <b>block size</b>, <b>trasnfer size</b> and <b>transfer timeout</b> options as described in <rfc num="1782"/>, <rfc num="1783"/> and <rfc num="1784"/>. I'm not sure if there are any other <term>TFTP</term> implementations supporting this, but at least it makes sense if you use <kin>PumpKIN</kin> on both ends.</ni>

    <ni>New Install program</ni>

   </newsfor>

  </topic>

  <topic id="Using" title="Using PumpKIN">

   <heading scroll="no">Using <kin>PumpKIN</kin></heading>

@@ -65,40 +66,41 @@
   <heading scroll="no">Options</heading>

   <p><kin>PumpKIN</kin> options property sheet consists of two tabs. For more information see <a href="#NetworkOptions"><b>Network</b></a> and <a herf="#ServerOptions"><b>Server</b></a> options.</p>

  </topic>

  <topic id="NetworkOptions" title="Network Options">

   <heading scroll="no">Network Options</heading>

   <ul>

    <li><b>UDP Ports</b>

     <ul>

      <li><b>Listen for incoming connections on port</b> - specifies the port we're listening to. The default as defined in <rfc num="1350"/> is 69.</li>

      <li><b>Send outgoing requests to port</b> - specifies the port we're going to send all requests to.</li>

     </ul>

    </li>

    <li><b>Default Connection timeout</b> - if there's no activity for specified time, transfer is considered to be dead and terminated. <kin>PumpKIN</kin> tries to propagate this value to remote as described in <rfc num="1782"/> and <rfc num="1784"/> if possible.</li>

    <li><b>Default Block Size</b> - <kin>PumpKIN</kin> tries to negotiate block size with remote using this value unless specified explicitly in request. If remote doesn't support <rfc num="1782"/> and <rfc num="1783"/> <kin>PumpKIN</kin> falls back to 512 bytes per block.</li>

   </ul>

  </topic>

  <topic id="ServerOptions" title="Server Options">

   <heading scroll="no">Server Options</heading>

   <ul>

    <li><b>TFTP Filesystem root</b> - Specifies the location of files you're transmitting or where to start looking for them from. Defaults to the directory you start <kin>PumpKIN</kin> for the first time from.</li>

    <li><b>Allow access to subdirectories</b> - specifies whether you want allow access to the whole subtree of <b>TFTP Root</b> or only to the directory itself.</li>

    <li><b>Read Request Behavior</b> - You may choose to automatically agree to give all files requested, to be prompted to confirm these operations, or to deny all requests as if you're not even here.</li>

    <li><b>Write Request Behavior</b> - You may chose to <b>take all files</b> (<i>not recommended</i>), to <b>prompt only if file exists already</b>, <b>Always prompt</b> or <b>Deny all requests</b>.</li>

    <li><a name="ConfirmationTimeOut"/><b>Confirmation timeout</b> - this is the time <kin>PumpKIN</kin> will wait for you to accept or deny request before it will give up and take default action which is always deny.</li>

+   <li><b>Log file</b> - If you want to enable logging to file, set the destination file here.</li>

   </ul>

  </topic>

  <topic id="SoundsOptions" title="Sounds Options">

   <heading scroll="no">Sounds</heading>

   <p>You can customize <kin>PumpKIN</kin> sounds notifications here. There are three customizable sounds defined - <b>Incoming request</b>, which notifies you about incoming request prompt if you're set to be prompted whenever incoming request occurs. <b>xfer Aborted</b> - which happens to sound every time transfer is interrupted for whatever reason - time out, explicit kill, denied access, etc. <b>xfer Finished</b> means that your file was successfully transmitted.</p>

   <p>You can select any <b>.wav</b> file or one of the predefined sounds from the dropdown list.</p>

  </topic>

  <topic id="ACL" title="Access Lists">

   <heading scroll="no">Access Lists</heading>

   <p>You can slightly automate your access policies by setting up read/write request behavior for different incoming requests.</p>

   <p>The rule consists of <b>request type</b>, source network (<b>ip</b> and <b>netmask</b>) and <b>action</b> to take (see also <a href="#ServerOptions">Server Options</a>).</p>

   <p>When <kin>PumpKIN</kin> receives request it goes through the list of rules and bases its decision on the first matching rule. To rearrange order of rules, select the rule you wish to move and use up and down arrows buttons on the right. To remove rule, use the cross button.</p>

   <p>To add a new rule fill in the information about <b>request type</b>, source <b>address</b> and <b>netmask</b> and desired action. Then click on the 'Add new rule' button.</p>

   <p>If you wish to amend the rule, select it in the rules list, change parameters below and click the 'Replace rule' button.</p>

  </topic>

 </winhelp>