commands/shutapp/shutapp.cif
changeset 0 7f656887cf89
equal deleted inserted replaced
-1:000000000000 0:7f656887cf89
       
     1 # shutapp.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 shutapp
       
    14 
       
    15 ==short-description
       
    16 
       
    17 Requests the shutdown of one or more applications.
       
    18 
       
    19 ==see-also
       
    20 
       
    21 L<listapps|listapps>, L<focus|focus>
       
    22 
       
    23 ==option uint i id multiple
       
    24 
       
    25 Send the shut down message to just the application with the specified window group identifier.
       
    26 
       
    27 ==option string m match multiple
       
    28 
       
    29 Send the shut down message to just the applications that match the specified window group name. Wild characters C<*> and C<?> are supported.
       
    30 
       
    31 ==option int t timeout
       
    32 
       
    33 The time (in seconds) after which to abort waiting for each application's thread to exit. Defaults to 5 seconds.
       
    34 
       
    35 ==option bool v verbose
       
    36 
       
    37 Print verbose output.
       
    38 
       
    39 ==option bool a all
       
    40 
       
    41 Shut all currently running applications down.
       
    42 
       
    43 ==option bool f force
       
    44 
       
    45 Send the more forceful C<EApaSystemEventSecureShutdown> as opposed to C<EApaSystemEventShutdown>. This should allow system apps to be shut.
       
    46 
       
    47 ==copyright
       
    48 
       
    49 Copyright (c) 2007-2010 Accenture. All rights reserved.
       
    50