core/builtins/foreach.cif
changeset 0 7f656887cf89
equal deleted inserted replaced
-1:000000000000 0:7f656887cf89
       
     1 # foreach.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 ==argument filename directory_name
       
    14 
       
    15 The name of the directory to iterate through.
       
    16 
       
    17 ==include source.cif
       
    18 
       
    19 ==name foreach
       
    20 
       
    21 ==short-description
       
    22 
       
    23 Execute a script for each file in a specified directory.
       
    24 
       
    25 ==long-description
       
    26 
       
    27 This command is similar to L<source|source>, but executes the specified script once for every entry (file or directory) that is found in the specified directory. The first argument passed to the script is the full path name of the entry. If any C<script_args> were specified, these are passed to the script as the second and third arguments, etc.
       
    28 
       
    29 Note, as with L<source|source>, this command executes in the context of the L<fshell|fshell> instance that executed it. Any changes to environment variables will be written to the L<fshell|fshell> environment when it completes.
       
    30 
       
    31 ==see-also
       
    32 
       
    33 L<source|source>
       
    34 
       
    35 ==copyright
       
    36 
       
    37 Copyright (c) 2006-2010 Accenture. All rights reserved.
       
    38