commands/backup/backup.cif
changeset 0 7f656887cf89
equal deleted inserted replaced
-1:000000000000 0:7f656887cf89
       
     1 # backup.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 backup
       
    14 
       
    15 ==short-description
       
    16 
       
    17 Put the handset into backup mode.
       
    18 
       
    19 ==long-description
       
    20 
       
    21 A means of requesting backup aware modules to close their file handles. Note, this command does not actually B<perform> a backup, it merely prepares the system for one. It can be useful if you want to copy a file that is normally held open by a running process. Another strategy if this doesn't work (note, not everything is backup aware) is to do something like:
       
    22 
       
    23   kill -m some-process && cp some-file .
       
    24 
       
    25 ==see-also
       
    26 
       
    27 L<restore|restore>
       
    28 
       
    29 ==argument enum operation
       
    30 
       
    31 The required operation to perform.
       
    32 
       
    33 ==enum-value start
       
    34 
       
    35 Request that all backup aware modules release their file handles and prepare for a backup.
       
    36 
       
    37 ==enum-value stop
       
    38 
       
    39 Request that all backup aware modules reclaim their file handles.
       
    40 
       
    41 ==copyright
       
    42 
       
    43 Copyright (c) 2008-2010 Accenture. All rights reserved.
       
    44