1 # xmodem.cif

     2 # 

     3 # Copyright (c) 2010 Accenture. All rights reserved.

     4 # This component and the accompanying materials are made available

     5 # under the terms of the "Eclipse Public License v1.0"

     6 # which accompanies this distribution, and is available

     7 # at the URL "http://www.eclipse.org/legal/epl-v10.html".

     8 # 

     9 # Initial Contributors:

    10 # Accenture - Initial contribution

    11 #

    12 

    13 ==name xmodem

    14 

    15 ==short-description

    16 

    17 An implementation of the XMODEM file transfer protocol.

    18 

    19 ==long-description

    20 

    21 Note, where possible it is recommended that the alternative C<ymodem> command is used rather than C<xmodem>. This is because C<xmodem> has the unhelpful side effect of appending 0x1a characters to the end of the file being transferred. C<ymodem> on the other hand, knows how long the file being transferred is and so can avoid this problem. It is also able to transfer multiple files in a batch and allows the sending end to specify their names. Note also that the console implementation that ymodem is attached to must support binary mode. If it doesn't, C<KErrExtensionNotSupported> (-47) will be reported. In practice, this currently means that one of the vt100 console variants (F<vt100cons.dll>, F<vt100busdevcons.dll>, F<vt100usbcons.dll>, F<vt100btcons.dll> or F<vt100tcpcons.dll>) must be used.

    22 

    23 ==argument enum mode

    24 

    25 The required mode.

    26 

    27 ==enum-value send

    28 

    29 ==enum-value receive

    30 

    31 ==argument filename file_name optional

    32 

    33 The name of the file to be read or written. If not specified, reads will be written to STDOUT and writes will be read from STDIN.

    34 

    35 ==option bool v verbose

    36 

    37 Print progress information to STDERR. Only use this if STDERR is attached to something other than STDOUT (e.g. a file).

    38 

    39 ==option bool o overwrite

    40 

    41 Overwrite any files that already exist.

    42 

    43 ==see-also

    44 

    45 L<ymodem|ymodem>

    46 

    47 ==copyright

    48 

    49 Copyright (c) 2008-2010 Accenture. All rights reserved.

    50