Module Name: src Committed By: apb Date: Fri Aug 8 21:38:45 UTC 2014
Added Files: src/external/bsd/ekermit/bin/ekermit: ekermit.1 Log Message: Add a simple man page for ekermit(1). This is derived from the help output and the web page http://www.kermitproject.org/ek.html To generate a diff of this commit: cvs rdiff -u -r0 -r1.1 src/external/bsd/ekermit/bin/ekermit/ekermit.1 Please note that diffs are not public domain; they are subject to the copyright notices on the relevant files.
Added files: Index: src/external/bsd/ekermit/bin/ekermit/ekermit.1 diff -u /dev/null src/external/bsd/ekermit/bin/ekermit/ekermit.1:1.1 --- /dev/null Fri Aug 8 21:38:45 2014 +++ src/external/bsd/ekermit/bin/ekermit/ekermit.1 Fri Aug 8 21:38:45 2014 @@ -0,0 +1,125 @@ +.\" $NetBSD: ekermit.1,v 1.1 2014/08/08 21:38:45 apb Exp $ +.Dd August 8, 2014 +.Os +.Dt MAKE 1 +.\" .Os [OPERATING_SYSTEM] [version/release] +.Sh NAME +.Nm ekermit +.Nd Send or receive files using Kermit file transfer protocol +.Sh SYNOPSIS +.Nm +.Op options +.Sh DESCRIPTION +.Nm +is a simple command line interface to +EK (Embedded Kermit, E-Kermit), +which is an implementation of the Kermit file +transfer protocol written in ANSI C and designed for embedding in devices or +firmware, use in realtime applications, or for construction of DLLs and +libraries. +.Pp +.\" "What E-Kermit Does" +EK performs just two functions: sending files and receiving files. +.\" "What E-Kermit Does NOT Do" +EK does not include client/server functions; a command or script +programming language; character-set conversion; transport encryption; +or any form of communications or file input/output. +It does not dial modems, it does not make connections, +it does not have a built-in TCP/IP stack or interface to an external one. +If you need these features, then you should use a full Kermit program, +such as C-Kermit or Kermit 95. +.Pp +The followiong options are available: +.Bl -tag -width "XsXfileX..." +.It Fl r +Receive files. +.It Fl s Ar file ... +Send files. +.It Fl p Ar neoms +Parity: none, even, odd, mark, space. +.It Fl b Ar 1235 +Block check type: 1, 2, 3, or 5 +.It Fl k +Keep incompletely received files. +.It Fl B +Force binary mode. +.It Fl T +Force text mode. +.It Fl R +Remote mode (vs local). +.It Fl L +Local mode (vs remote). +.It Fl E Ar number +Simulated error rate (0-100). +.It Fl d +Create +.Pa debug.log . +.It Fl h +Display a help message. +.El +. +.Sh IMPLEMENTATION NOTES +EK includes the following Kermit Protocol features: +.Bl -bullet -offset indent -compact +.It +Long packets. +.It +Sliding windows with Go-Back-to-N error recovery. +.It +Repeat-count compression. +.It +Control-character prefixing and unprefixing. +.It +8th-bit prefixing (for transferring 8-bit data on 7-bit links) (= parity). +.It +Attribute packets (type, size, and date). +.It +Sending and receiving single or multiple files. +.It +Automatic per-file text/binary mode switching. +.It +All three block check types (6- and 12-bit checksum, 16-bit CRC). +.It +Status reports (protocol state, file name, size, timestamp, bytes so far). +.It +Transfer cancellation by either party. +.El +.Pp +The following Kermit Protocol features are not implemented: +.Bl -bullet -offset indent -compact +.It +Sliding windows with selective retransmission. +.It +Character sets. +.It +Locking shifts. +.It +Client/server. +.El +.Pp +Because EK is designed primarily for embedding, it does not use +streaming or (except in EKSW) true sliding windows (although much of the +sliding windows code is there). +.Pp +The lack of true sliding windows in EK is compensated by having EK +pretend to support them without really doing so. +This allows its sending partner to "stream" packets rather than waiting +for ACKs after each one, as long as there isn't an error. +If there is an error, the recovery strategy is "go back to n" (or +perhaps in some cases "error out") rather than "selective repeat". +EKSW, a separate program that has not been integrated with EK (but +should be), supports true sliding windows with selective repeat; that +is, only those packets are retransmitted that actually need to be. +.Pp +In any event, since EK is intended primarily for embedding, it is +anticipated that round-trip delays won't be a big factor; connections +will generally be local, short, relatively fast, and if the connection +is effectively flow controlled, error-free. +When effective flow control is lacking, the speed and/or packet length +and/or window size can be set to a combination of values that maximizes +throughput and minimizes data loss. +.Sh SEE ALSO +.Lk http://www.kermitproject.org/ek.html +.Sh HISTORY +Version 1.1 of EK was released in 2002. +A BSD-licenced version 1.6 was released in 2011.