commands/restore/restore.cif
author Joe Branton <joe.branton@accenture.com>
Thu, 29 Jul 2010 12:58:05 +1000
changeset 17 949c6f5096e4
parent 0 7f656887cf89
permissions -rw-r--r--
More build fixes. Changed the documentation builder to automatically prepend %EPOCROOT% (converted to a path relative form) to pre-processor include path options that start with 'epoc32'. Prevously $(EPOCROOT) was prepended in the makefile, which broke the documentation build because the pre-processor will only accecpt relative path include options.

# restore.cif
# 
# Copyright (c) 2010 Accenture. All rights reserved.
# This component and the accompanying materials are made available
# under the terms of the "Eclipse Public License v1.0"
# which accompanies this distribution, and is available
# at the URL "http://www.eclipse.org/legal/epl-v10.html".
# 
# Initial Contributors:
# Accenture - Initial contribution
#

==name restore

==short-description

Put the handset into restore mode.

==long-description

A means of requesting backup aware modules to close their file handles. Note, this command does not actually B<perform> a restore, it merely prepares the system for one.

==see-also

L<backup|backup>

==argument enum operation

The required operation.

==enum-value start

Request that all backup aware modules release their file handles and prepare for a restore.

==enum-value stop

Request that all backup aware modules reclaim their files.

==copyright

Copyright (c) 2008-2010 Accenture. All rights reserved.