core/builtins/cp.cif
changeset 0 7f656887cf89
equal deleted inserted replaced
-1:000000000000 0:7f656887cf89
       
     1 # cp.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 cp
       
    14 
       
    15 ==short-description
       
    16 
       
    17 Copy one or more files or folders.
       
    18 
       
    19 ==long-description
       
    20 
       
    21 If source is a directory and --recurse is used, destination is assumed to be a directory. If C<destination> exists, C<source> is copied into it, giving the directory structure C<destinationdir\sourcename\...>. This is in line with how posix cp behaves, but it is different to the default Symbian CFileMan behaviour, which would put the files in sourcedir directly into destinationdir without creating a directory called sourcename. In posix cp terms, CFileMan usually performs C<cp -r source\* destination\> instead of C<cp -r source destination>. If C<destination> does not exist, it is created, and posix cp and CFileMan behave the same in this case. It is considered preferable for fshell cp to behave the same as posix cp, rather than following CFileMan's behaviour.
       
    22 
       
    23 Because of the above behavioural ambiguity (and other strangenesses in CFileMan) it is not recommended to copy a directory without specifying the --recurse option.
       
    24 
       
    25 Note, also aliased to C<copy>.
       
    26 
       
    27 ==argument filename source
       
    28 
       
    29 The name of the source file (may contain wild characters) or directory.
       
    30 
       
    31 ==argument filename destination
       
    32 
       
    33 The name of the destination file or directory.
       
    34 
       
    35 ==option bool r recurse
       
    36 
       
    37 Copy matching files in sub-directories. Creates any missing directories in the destination path.
       
    38 
       
    39 ==option bool o overwrite
       
    40 
       
    41 Overwrite file at destination, if it exists.
       
    42 
       
    43 ==option bool f force
       
    44 
       
    45 Forcibly copy, even if the file is in use. Note, this option can't be used with --recurse.
       
    46 
       
    47 ==copyright
       
    48 
       
    49 Copyright (c) 2006-2010 Accenture. All rights reserved.
       
    50