core/builtins/start.cif
changeset 0 7f656887cf89
equal deleted inserted replaced
-1:000000000000 0:7f656887cf89
       
     1 # start.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 start
       
    14 
       
    15 ==short-description
       
    16 
       
    17 Starts the specified process and then completely disowns it.
       
    18 
       
    19 ==long-description
       
    20 
       
    21 This is useful in the situation where you want the process to have a longer lifetime than the L<fshell|fshell> instance that created it. Note the child process does not inherit fshell's I/O handles or environment variables.
       
    22 
       
    23 ==see-also
       
    24 
       
    25 L<disown|disown>, L<time|time>
       
    26 
       
    27 ==argument string exe-name
       
    28 
       
    29 The executable to start.
       
    30 
       
    31 ==argument string arguments optional last
       
    32 
       
    33 The arguments to pass to the exe.
       
    34 
       
    35 ==option bool r rendezvous
       
    36 
       
    37 Wait for the child process to call C<RProcess::Rendezvous> before exiting. Can not be used with C<--wait>.
       
    38 
       
    39 ==option bool w wait
       
    40 
       
    41 Wait for the child process to exit before exiting. May not be used with C<--rendezvous>.
       
    42 
       
    43 ==option int t timeout
       
    44 
       
    45 Only relevant with either C<--rendezvous> or C<--wait>. Causes the command to abort after the specified number of seconds if the child process hasn't called C<RProcess::Rendezvous> or exited (as appropriate) in that time. If the timeout is zero or not specified, the command will wait indefinitely.
       
    46 
       
    47 ==option bool m measure
       
    48 
       
    49 If specified, measure the time taken for the child process to rendezvous (if C<--rendezvous> is specified) or exit (if C<--wait> is specified). This can be more accurate than using the fshell L<time|time> command if C<exe-name> is not an fshell command, because start doesn't attempt to parse its arguments as an fshell command line (adding the overhead of variable expansion, pipeline establishment etc) or to set up iosrv connections for the child process.
       
    50 
       
    51 ==copyright
       
    52 
       
    53 Copyright (c) 2006-2010 Accenture. All rights reserved.
       
    54