summaryrefslogtreecommitdiffabout
path: root/help/pumpkin.xml
Side-by-side diff
Diffstat (limited to 'help/pumpkin.xml') (more/less context) (show whitespace changes)
-rw-r--r--help/pumpkin.xml1
1 files changed, 1 insertions, 0 deletions
diff --git a/help/pumpkin.xml b/help/pumpkin.xml
index 2e53edd..153219a 100644
--- a/help/pumpkin.xml
+++ b/help/pumpkin.xml
@@ -52,64 +52,65 @@
<p>Use <a href="#Options">Options</a> button to set <kin>PumpKIN</kin> options.</p>
<p>You can start and stop <kin>PumpKIN</kin>'s <term>TFTP</term> server by checking and unchecking the <b>Server is running</b> checkbox in the lower right corner of main <kin>PumpKIN</kin> window.</p>
</topic>
<topic id="ConfirmRRQ" title="Confirm Read Request Dialog">
<heading scroll="no">Confirm Read Request Dialog</heading>
<p>When the file is requested from your <term>TFTP</term> server you may choose to <b>Grant Access</b> to this file or to <b>Deny Access</b>. If you hesitate to answer for <a href="#ConfirmationTimeout"><b>Confirmation timeout</b></a> (<i>default - 30 seconds</i>) <kin>PumpKIN</kin> defaults to denial of all requests.</p>
</topic>
<topic id="ConfirmWRQ" title="Confirm Write Request Dialog">
<heading scroll="no">Confirm Write Request Dialog</heading>
<p>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</b> option. If you already have file with such name you may chose to <b>resume</b> 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 <kin>PumpKIN</kin> on both ends. If you are still unsure for <a href="#ConfirmationTimeOut"><b>Confirmation timeout</b></a> (<i>default - 30 seconds</i>) <kin>PumpKIN</kin> will make safe decision for you (deny).</p>
</topic>
<topic id="Request" title="Request Dialog">
<heading scroll="no">Request Dialog</heading>
<p>Request dialog is aimed to let you form read or write request. You may set the following options:</p>
<ul>
<li><b>Local File</b> - 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</b> button to select the file.</li>
<li><b>Remote File</b> 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).</li>
<li><b>Remote Host</b> is your party's host or <term>TFTP</term> server you're requesting file from/sending file to. To refresh the list of your talk windows use <b>REFRESH</b> button.</li>
<li><b>Type</b> is the type of transfer as defined in <rfc num="1350"/>. Doesn't mean much, really. Defined types are '<i>octet</i>' or '<i>netascii</i>'. Default is '<i>octet</i>'.</li>
<li><b>Block Size</b> - Use this block size if remote is <rfc num="1783"/>-compliant. If remote doesn't support this option <kin>PumpKIN</kin> will fallback to 512 bytes per block.</li>
</ul>
</topic>
<topic id="Options" title="Options">
<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>ip address</b> - ip address to listen to.</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>