1 # cat.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 cat

    14 

    15 ==short-description

    16 

    17 Concatenate the specified files and write their contents to C<stdout>.

    18 

    19 ==see-also

    20 

    21 L<match|match>, L<tail|tail>

    22 

    23 ==argument filename file_name optional multiple

    24 

    25 The names of the files to be concatenated. May contain wild characters C<*> and C<?>. If none specified, reads from C<stdin>.

    26 

    27 ==option bool f force

    28 

    29 Read the files even if they are open exclusively by another process. Runs a small risk of the data read being corrupt.

    30 

    31 ==option bool b binary

    32 

    33 Legacy option, kept for compatability. Equivalent to C<--encoding binary>.

    34 

    35 ==option enum e encoding

    36 

    37 Encoding to use. If not specified, defaults to 'auto'.

    38 

    39 ==enum-value auto

    40 

    41 Use charconv to try and figure out the encoding (slow and error-prone for anything other than UTF-16 with BOM).

    42 

    43 ==enum-value binary

    44 

    45 Read the files in binary mode and do not perform any character conversion.

    46 

    47 ==enum-value utf-8

    48 

    49 Assume the file is UTF-8 (with or without BOM).

    50 

    51 ==enum-value latin1

    52 

    53 Assume the file is encoded using ISO-8859-1.

    54 

    55 ==enum-value ltk-utf-8

    56 

    57 Assume the file is UTF-8, but use the RLtkBuf16 UTF-8 parser rather than the charconv one (useful for testing).

    58 

    59 ==option int s block-size

    60 

    61 Specify the block size to use for reading the file(s), in bytes. If not specified, defaults to 512 bytes.

    62 

    63 ==copyright

    64 

    65 Copyright (c) 2005-2010 Accenture. All rights reserved.

    66