Documention for: xcopy.r
Created by: reboltof
 on: 11-Apr-2006
Format: text/editable
Downloaded on: 30-Apr-2025

xcopy.r

=== Introduction

This script implements the function 'xcopy.

=== History

\table

<b>Version</b>

<b>Date</b>

<b>Comment</b>

<b>Author</b>

=row

1.0

11-apr-06

Initial doc

reboltof

/table

=== Description

'xcopy allows to execute selectives copies from/to different media.

=== Usage

--- Copy a file to a file

    xcopy %origin-file-path.r %target-file-path.r

The origin file, which access path is <b>%origin-file.r</b> will be copy to the destination path <b>%origin-file.r</b>.

--- Copy a file to a directory

    xcopy %origin-file.r %target-dir/

The origin file, which access path is <b>%origin-file.r</b> will be copy to the destination directory <b>%target-dir/</b>, using the same name as the original file.

--- Copy a directory to a directory

    xcopy %origin-dir/ %target-dir/

All files and subdirectories of the origin directory <b>%origin-dir/</b> will be copied under the destination directory <b>%target-dir/</b>.

The destination directory will be created if it does not exists. The structure of the subdirectories will be preserved.

=== Refinement

You can use following refinements for a more precise usage

--- verbose

    xcopy/verbose %origin-dir/ %target-dir/

All actions will be feedbacked to the user, using the console.

--- no-warn

    xcopy/no-warn %origin-dir/ %target-dir/

By default, 'xcopy asks the user's confirmation before overwritting an existing file. Using the refinement /no-warn allows the overwritting in all cases, without confirmation.

--- filter

    xcopy/filter %origin-dir/ %target-dir/ [%.r %.bmp]

You can use this refinement to limit the copy to the files having the specified extension(s). The extension desired are always put into a block, also if there is only one:

    xcopy/filter %origin-dir/ %target-dir/ [%.r]