ARCHIVE

/O

(no value)

Adds all selected files and folders to a Zip file named after the first selected item. Note that if only a single folder is selected, the items within that folder are added rather than the folder itself - this prevents you from ending up with a Zip file containing an unnecessary sub-folder.

Example: Copy ARCHIVE

The CREATEFOLDER argument can be used to change the default archive name.

Example: Copy ARCHIVE CREATEFOLDER="Backup"

<archive format>

Adds all selected files and folders to an archive of the specified format.

Example: Copy ARCHIVE=.rar

single

Each selected item will be added to its own archive, rather than all items being added to the one archive.

Example: Copy ARCHIVE=single

keepfolder

Modifies the behaviour when only a single folder is selected - instead of the items within the folder being added, the folder itself will be added to the archive.

Example: Copy ARCHIVE=keepfolder

AUTOSELECT

/K

yes

Overrides the state of the Automatically select newly copied files option on the File Operations / Copy Options Preferences page. Newly copied files will always be selected.

Example: Copy DUPLICATE AUTOSELECT=yes

no

Newly copied files will not be selected, no matter what the Automatically select newly copied files option is set to.

Example: Copy AUTOSELECT=no

BURNCD

/S

(no value)

Invokes the system CD Burning Wizard, which initiates burning of any files you have previously copied to the CD staging area.

Example: Copy BURNCD

COLLLIST

/S

(no value)

Displays a dynamically generated list of file collections - you can add selected files and folders to a file collection simply by selecting it from this list. Acts as a dynamic button. Most useful when used in a drop-down menu or on a context menu.

Example: Copy COLLLIST

COPYCREATIONTIME

/K

yes

Preserve the creation time of copied files and folders.

Overrides the no_copy_creation_time option on the Miscellaneous / Advanced Preferences page.

COPYCREATIONTIME=yes will cause file and folder creation times to be preserved even if COPYFILETIMES=no or COPYDIRTIMES=no are used.

Modified and accessed times are not affected by this argument.

Example: Copy COPYCREATIONTIME=yes

no

Do not preserve the creation time of copied files and folders. (The current time will be used instead.)

COPYCREATIONTIME=no will prevent preservation of file and folder creation times even if COPYFILETIMES=yes or COPYDIRTIMES=yes are used.

Modified and accessed times are not affected by this argument.

Example: Copy COPYCREATIONTIME=no

COPYDIRTIMES

/K

yes

Preserves the created, modified and accessed times of copied folders.

Overrides the Preserve the timestamps of copied files option on the File Operations / Copy Attributes Preferences page and the no_copy_dir_dates option on the Miscellaneous / Advanced Preferences page.

You can override the COPYDIRTIMES argument itself, for just the created timestamps, using the COPYCREATIONTIME argument.

Example: Copy COPYDIRTIMES=yes

no

Prevents preservation of the created, modified and accessed times of copied folders.

Example: Copy COPYDIRTIMES=no

COPYOWNER

/K

local

Copy file owner information when the copy takes place between local drives only (overrides the Copy owner option on the File Operations / Copy Attributes Preferences page). Note that under Vista and above, setting the file owner requires elevation and so may produce a UAC prompt.

Example: Copy COPYOWNER=local

all

Copy file owner information for all drives, not just local ones.

Example: Copy COPYOWNER=all

no

Do not copy file owner information.

Example: Copy COPYOWNER=no

COPYSECURITY

/K

yes

Copy security permissions when copying files between NTFS drives (overrides the Copy security permissions option on the File Operations / Copy Attributes Preferences page).

Example: Copy COPYSECURITY=yes

no

Do not copy security permissions. Newly copied files will inherit the default security permissions of the destination folder.

Example: Copy COPYSECURITY=no

COPYTOCOLL

/K

member

When copying (adding) folders to a file collection, add them as members of the collection (overrides the When copying folders to a Collection option on the File Operations / Copy Options Preferences page).

Example: Copy COPYTOCOLL=member

sub

Copy folders to collections as sub-collections (the contents of the folder will be added as member items to the newly created sub-collection).

Example: Copy COPYTOCOLL=sub

ask

Ask how to copy folders to collections.

Example: Copy COPYTOCOLL=ask

DUPLICATE

/S

(no value)

Create duplicates of the selected items in the same folder. You will be prompted to enter new names (or a wildcard pattern) for the duplicated files.

Example: Copy DUPLICATE

FILE

/M

<filename> ...

Specifies the name of the file or files to copy. If you don't provide this argument the command operates on all selected items in the source Lister. This is the default argument for the Copy command - you don't need to specify the FILE keyword.

If you only specify the filename instead of the full path of the file or files, Opus will look in the current source folder. You can also specify a wildcard pattern. Remember that if the filename contains spaces you need to enclose it in quotes.

Example: Copy "C:\Data Directory\*.xls" TO /desktop

FLATVIEWCOPY

/K

single

When copying items in different directories from a flat view file display, the files will all be copied to the same target directory. This overrides the When copying in Flat View mode option on the File Operations / Copy Options Preferences page.

Example: Copy FLATVIEWCOPY=single

recreate

Recreates the source folder structure when copying items in different directories out of a flat view file display.

Example: Copy FLATVIEWCOPY=recreate

ask

Opus will ask you what to do when copying items out of a flat view file display.

Example: Copy FLATVIEWCOPY=ask

HERE

/S

(no value)

Use the source folder as the destination folder (for example, archives can be extracted to the same folder instead of the destination).

Example: Copy EXTRACT HERE

Important: The HERE argument can complicate buttons which run more than one command, as it can affect the destination folder used by subsequent commands in the same button. It is recommended to use TO={sourcepath$} instead if the button runs multiple commands.

Scripting: The HERE argument does not work when running commands via the scripting Command object. Instead, use cmd.SetDestTab(cmd.sourcetab) on the Command object, or use an explicit TO argument in the command string.

INCLUDEINLIBRARY

/O

(no value)

Displays a dynamically generated list of libraries - you can include a selected folder in a library simply by selecting it from this list. Acts as a dynamic button. Most useful when used in a drop-down menu or on a context menu.

Opus will automatically navigate to show the contents of the library with the newly included folder.

Example: Copy INCLUDEINLIBRARY

noread

Prevents Opus from automatically navigating to the library when you include a folder in it via the generated list.

Example: Copy INCLUDEINLIBRARY noread

$new

Include selected folders in a new library. The new library will be given the name of the first selected folder. Opus will automatically navigate to the new library unless you include the noread: prefix.

Example: Copy INCLUDEINLIBRARY noread:$new

<library name>

Include selected folders in the named library. Opus will automatically navigate to the new library unless you include the noread: prefix.

Example: Copy INCLUDEINLIBRARY "noread:Movie Files"

MAKELINK

/O

(no value)

Creates shortcuts to all selected files and folders. Shortcuts do not require NTFS. Shortcuts may point to things on different drives to themselves.

Example: Copy MAKELINK TO /desktop

junction

Creates junctions to all selected folders. Junctions are only supported on NTFS drives. Junctions only work with folders (not with files). Junctions may point to folders on different drives to themselves.

Example: Copy MAKELINK=junction

hardlink

Creates hardlinks to all selected files. Hardlinks are only supported on NTFS drives. Hardlinks only work with files (not folders). Hardlinks cannot point to files on different drives to themselves.

Example: Copy MAKELINK=hardlink

softlink

Creates softlinks to all selected files or folders, using absolute paths. Softlinks require Windows Vista or above and are only supported on NTFS drives. Softlinks work with both files and folders. Softlinks may point to things on different drives to themselves. Creating softlinks requires administrator access and will trigger a UAC prompt if necessary.

Example: Copy MAKELINK=softlink

relsoftlink

Creates softlinks to any selected files or folders, using relative paths where possible. A regular absolute link will be created if the target can not be expressed relative to the link. (See softlink for more information on softlinks.)

Example: Copy MAKELINK=relsoftlink

auto

Automatically determines the most suitable type of link to create. On Vista and above, it will usually create softlinks (for both files and folders). On Windows XP, it will usually create junctions (for folders) and hardlinks (for files). Shortcuts will be created instead in cases where the desired link type is not applicable. For example, a shortcut will be created if the drives are not NTFS or if a hardlink is desired but the source and destination are on different drives.

Example: Copy MAKELINK=auto

autonosoft

Does the same as auto except that it will not try to create softlinks. It will usually create junctions (for folders) and hardlinks (for files). Shortcuts will be created instead in cases where the desired link type is not applicable. For example, a shortcut will be created if the drives are not NTFS or for files where the source and destination are on different drives.

Example: Copy MAKELINK=autonosoft

MARKDESTARCHIVE

/K

yes

Clears the A ("ready for archiving") attribute on newly copied files. You can use this if your backup solution uses the A attribute to indicate a file has changes which need backing up, and you don't want the new copy to be backed up (until something modifies it and sets its A attribute again).

Overrides the Mark copied files as archived (clear the A flag) option on the File Operations / Copy Attributes Preferences page.

This does nothing if not preserving file attributes on copied files.

Example: Copy MARKDESTARCHIVE=yes

no

Do not clear the A attribute on newly copied files.

Example: Copy MARKDESTARCHIVE=no

MOVE

/S

(no value)

Move selected files and folders to the destination (a.k.a. cut-and-paste). If the destination folder is on the same drive as the source then generally items can be moved through a simple rename operation, which is very quick. When moving files between devices Opus first copies them to the destination, and then deletes them from the source.

Example: Copy MOVE

MOVEWITHSHIFT

/S

(no value)

Selected items will be moved if the Shift key is held down when the command is executed, otherwise they will be copied.

Example: Copy MOVEWITHSHIFT

NOQUEUEWHENSAME

/S

(no value)

Disables the use of the copy queue when the source and destination paths are on the same drive partition. You would normally only use this argument when moving files, because moves on the same drive can be done without actually copying any data.

Example: Copy MOVE NOQUEUEWHENSAME

QUEUE

/O

(no value)

Enables automatic copy queuing. File copies will be queued automatically if required (based on the source and destination drives). This can override the Automatically manage file copy queues option on the File Operations / Copy Options Preferences page.

Example: Copy QUEUE

<queue name>

When you specify a queue name as the value for this argument, it enables manual copy queuing when copying files. That is, with a name specified, file copies will always be queued to the specified queue - if no name is specified for the argument, copies will only be queued if needed. The specified name will be shown in the progress dialog's title bar.

Example: Copy QUEUE=MyQueue

none

Used to disable copy queuing - whether enabled in Preferences, or otherwise enabled by the shift keyword.

Example: Copy QUEUE=none

shift

Lets you specify two alternate parameters for the QUEUE argument. The value specified before the shift keyword is used if the Shift key is not held down - the value after it is used if it is. For example, you could configure a copy button to queue files to a specific queue if the Shift key were held down, and to disable queuing otherwise.

Example: Copy QUEUE=none,shift,MyQueue TO \\NAS1\Storage

quiet

Specify the quiet keyword to suppress the prompt that normally indicates a copy operation has been queued.

Example: Copy QUEUE=MyQueue,quiet

SENDMAIL

/O

(no value)

Send selected files as email attachments. Email settings must be configured on the Internet / Email Preferences page.

Example: Copy SENDMAIL

<email address>

Send selected files to the specified email recipient. This only works if email sending is set to use the MAPI client on the Internet / Email Preferences page.

Example: Copy SENDMAIL=f.bloggs@company.com

TO

/K

<target path>

Specify the target path for the command. By default Copy functions that require a destination folder will use the current destination file display or Lister - this argument allows you to override that. Also see the HERE argument for a way to override the destination path. You can use folder aliases and @ftp shortcuts, URL-style paths for virtual filesystems (collections, libraries, etc.) as well as standard file system paths. Remember that if the specified path contains a space you must enclose the whole path in quotes. This only sets the destination folder; if you want to change the names of the copied files as well, use the AS argument.

Example: Copy TO "lib://Backups/Daily Backup Folder"

ask

Normally if no destination path is specified, and there is no current destination file display or Lister, Opus will prompt for a destination path via a popup dialog. You can use the ask value to force Opus to always prompt for a destination path, even if there already is one.

You can also specify a default destination path, by appending a colon and the path. Remember to use quotes if the path contains spaces.

Example: Copy TO=ask
Example: Copy TO="ask:c:\My Documents"

ask$

Force Opus to ask for a destination path. If you have a function that combines multiple Copy commands, you can use ask$ to make Opus only prompt for a destination path once for the whole function, rather than prompting separately for each Copy command.

You can also specify a default destination path, by appending a colon and the path.

Example: Copy TO=ask$
Example: Copy TO=ask$:D:\

UPDATEALL

/S

(no value)

Update files in the destination folder (a simple form of one-way synchronization). Only files that either do not exist in the destination, or do exist but are different from the source files, will be copied - other files will be skipped. A file is defined as different if either its timestamp is newer or its size has changed - the contents of the file are not compared.

Example: Copy UPDATEALL FORCE

UPDATESECURITY

/K

yes

Update security permissions and encryption settings for moved files, to match the destination folder (overrides the Update permissions/encryption to match the destination when moving files option on the File Operations / Copy Attributes Preferences page). For example, if a folder has the E attribute set, files moved into that folder will be automatically encrypted.

This only applies if a file can be moved via a rename operation - for files that are moved to different devices, via a copy and delete operation, the newly copied files will inherit the permissions of the destination folder (this behaviour is controlled by the COPYSECURITY argument).

Example: Copy UPDATESECURITY=yes

no

Do not update security permissions or encryption settings for moved files (when files are moved via a rename, their existing permissions will remain).

Example: Copy UPDATESECURITY=no

WHENEXISTS

/K

ask

If a file that is being copied already exists in the destination, ask what to do. This overrides the option Ask for confirmation before overwriting existing files on the File Operations / Copy Options page in Preferences.

Example: Copy WHENEXISTS=ask

skip

If a file that is being copied already exists in the destination, skip over it (leaving existing file intact).

Example: Copy WHENEXISTS=skip

recycle

When replacing a file, delete the original to the recycle bin if possible. You can combine this flag with the other options.
 

Note that Undo can not be used to restore these files automatically, however you will be able to retrieve them from the recycle bin manually.
 

Example: Copy WHENEXISTS=replace,recycle

replace

Replace any existing files without prompting.

Example: Copy WHENEXISTS=replace

rename

If a file with the same name already exists in the destination, the newly copied file will be renamed automatically to avoid a clash.

Example: Copy WHENEXISTS=rename

renameold

The old file (the one that already exists in the destination directory) will be renamed before the new file is copied.

Example: Copy WHENEXISTS=renameold

resume

When copying to FTP sites, a previous incomplete file transfer will be automatically resumed (only applies if the server supports FTP, and the existing file is smaller than the one being copied).

Example: Copy WHENEXISTS=resume

merge

Automatically merge the contents of an existing folder with that of the folder being copied. This overrides the Ask for confirmation before merging existing folders option on the File Operations / Copy Options page in Preferences. You can use this value in addition to another value to specify the 'when exists' behaviour for files as well as folders.

Example: Copy WHENEXISTS=replace,merge

keepnewer

Replace any existing files if the files being copied are newer. If the timestamps are the same or older, the already-existing files will be skipped.

Example: Copy WHENEXISTS=keepnewer

(This was called replacenewer in the past. It has been renamed for clarity. The old name still works to maintain compatibility.)