releasing/cbrtools/perl/CleanEnv.pod
changeset 607 378360dbbdba
parent 602 3145852acc89
equal deleted inserted replaced
591:22486c9c7b15 607:378360dbbdba
       
     1 # Copyright (c) 2000-2009 Nokia Corporation and/or its subsidiary(-ies).
       
     2 # All rights reserved.
       
     3 # This component and the accompanying materials are made available
       
     4 # under the terms of the License "Eclipse Public License v1.0"
       
     5 # which accompanies this distribution, and is available
       
     6 # at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     7 # 
       
     8 # Initial Contributors:
       
     9 # Nokia Corporation - initial contribution.
       
    10 # 
       
    11 # Contributors:
       
    12 # 
       
    13 # Description:
       
    14 # 
       
    15 
       
    16 
       
    17 =head1 NAME
       
    18 
       
    19 CleanEnv - Restores an environment to a clean state.
       
    20 
       
    21 =head1 SYNOPSIS
       
    22 
       
    23   cleanenv [options]
       
    24 
       
    25 options:
       
    26 
       
    27   -h  help
       
    28   -r  really clean
       
    29   -f  force (don't prompt)
       
    30   -v  verbose output (-vv very verbose)
       
    31 
       
    32 =head1 DESCRIPTION
       
    33 
       
    34 Provides the user with the option of:
       
    35 
       
    36 =over 4
       
    37 
       
    38 =item *
       
    39 
       
    40 Re-installing dirty components.
       
    41 
       
    42 =item *
       
    43 
       
    44 Removing files of unknown origin.
       
    45 
       
    46 =back
       
    47 
       
    48 Normally when scanning an environment certain directories and files are ignored from the point of view of C<unknown origin> status (see the document I<Installation Guide> for more details), for example intermediate build files. The C<-r> switch causes C<CleanEnv> to not ignore any files when performing it's scan, and hence do a more comprehensive clean.
       
    49 
       
    50 Normally it will ask you if you want to delete files, and/or reinstall components. The -f flag supresses these questions, and should be used with care.
       
    51 
       
    52 =head1 KNOWN BUGS
       
    53 
       
    54 None.
       
    55 
       
    56 =head1 COPYRIGHT
       
    57 
       
    58  Copyright (c) 2000-2009 Nokia Corporation and/or its subsidiary(-ies).
       
    59  All rights reserved.
       
    60  This component and the accompanying materials are made available
       
    61  under the terms of the License "Eclipse Public License v1.0"
       
    62  which accompanies this distribution, and is available
       
    63  at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
    64  
       
    65  Initial Contributors:
       
    66  Nokia Corporation - initial contribution.
       
    67  
       
    68  Contributors:
       
    69  
       
    70  Description:
       
    71  
       
    72 
       
    73 =cut