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

    14 

    15 ==short-description

    16 

    17 Provides information on IO objects within the IO server.

    18 

    19 ==argument enum object_type

    20 

    21 The type of IO object to display information about. The following values are supported:

    22 

    23 ==enum-value read-write

    24 

    25 Both read and write objects.

    26 

    27 ==enum-value read

    28 

    29 Just read objects.

    30 

    31 ==enum-value write

    32 

    33 Just write objects.

    34 

    35 ==enum-value end-point

    36 

    37 All end-points. Note, the remaining values are specific kinds of end-point.

    38 

    39 ==enum-value console

    40 

    41 Just console end-points.

    42 

    43 ==enum-value file

    44 

    45 Just file end-points. Note, file end-points are used by L<fshell|fshell> when it redirects the input or output of a command from or to a file in response to <, > or >>.

    46 

    47 ==enum-value null

    48 

    49 Just null end-points. Note, null end-points are used by L<fshell|fshell> when the input or output of a command is redirected from or to F</dev/nul> or C<NUL>.

    50 

    51 ==enum-value pipe

    52 

    53 Just pipe end-points. Note, pipe end-points are used by L<fshell|fshell> when a command-line contains the pipe (C<|>) operator.

    54 

    55 ==enum-value persistent-console

    56 

    57 Just persistent console end-points. See L<pcons|pcons> and the F<Persistent Consoles> section of the tool-kit's documentation for more details.

    58 

    59 ==option string m match

    60 

    61 Match string to filter object names. Defaults to C<*>.

    62 

    63 ==copyright

    64 

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

    66