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

    14 

    15 ==short-description

    16 

    17 Print a text string to C<stdout>. If no text is specified as an argument, reads from C<stdin> and writes the result to C<stdout>.

    18 

    19 ==long-description

    20 

    21 Note, this command used to interpret escape sequences such as C<^r> and C<^t> itself. This functionality has now been moved into C<CCommandBase> so all fshell commands can benefit from it. A consequence of this change is that it is no longer necessary to double escape such sequences.

    22 

    23 ==argument string string optional last

    24 

    25 The text to be printed.

    26 

    27 ==option bool e stderr

    28 

    29 Print to C<stderr> rather than C<stdout>.

    30 

    31 ==option bool w wrap

    32 

    33 Wraps the text to the screen width, ensuring that words do not get split across lines.

    34 

    35 ==option uint i indent

    36 

    37 The number of characters to indent the text by. Only has an effect when used with C<--wrap>.

    38 

    39 ==option enum a attributes multiple

    40 

    41 The attributes to assign to the text written to the console.

    42 

    43 ==enum-value bold

    44 

    45 ==enum-value underscore

    46 

    47 ==enum-value blink

    48 

    49 ==enum-value inverse

    50 

    51 ==enum-value conceal

    52 

    53 ==option enum f foreground-color

    54 

    55 The color the font glyphs are to be drawn in.

    56 

    57 ==enum-value black

    58 

    59 ==enum-value red

    60 

    61 ==enum-value green

    62 

    63 ==enum-value yellow

    64 

    65 ==enum-value blue

    66 

    67 ==enum-value magenta

    68 

    69 ==enum-value cyan

    70 

    71 ==enum-value white

    72 

    73 ==option enum b background-color

    74 

    75 The color the rectangle behind the font glyphs is to be drawn in.

    76 

    77 ==enum-value black

    78 

    79 ==enum-value red

    80 

    81 ==enum-value green

    82 

    83 ==enum-value yellow

    84 

    85 ==enum-value blue

    86 

    87 ==enum-value magenta

    88 

    89 ==enum-value cyan

    90 

    91 ==enum-value white

    92 

    93 ==option bool B binary

    94 

    95 Write to the console in I<binary mode>. Note, not all consoles support the notion of I<binary mode>. If not, KErrNotSupported (-5) will be returned. In practice, currently only the VT100 console variants support this.

    96 

    97 ==option bool n no-newline

    98 

    99 By default echo will append a new line (C<CRLF>) on to the end of the C<string> argument, if it doesn't already have one. Use C<--no-newline> to prevent this.

   100 

   101 ==copyright

   102 

   103 Copyright (c) 2006-2010 Accenture. All rights reserved.

   104