The from argument is mandatory and must refer to an existing directory on the target system. The directory and all its contents will be downloaded to the host system.
The optional to argument can be used to override the default destination, which is the current working directory on the host system. If provided, the given directory path is taken relative to the handle's current working directory, unless the path is absolute. The destination directory on the target system must exist and allow the user to write to it, or this command will fail.
By default the command will copy soft-links "as is" and not the files that they point to, but this behavior can be altered with the -follow flag. Note that soft-links to files within the upload tree will cause the files to be duplicated when soft-links are followed. WARNING: Beware of circular soft-links when the flag is used! A circular soft-link will be traversed until the maximum target system recursion is exceeded.
Any hidden files (beginning with a dot) in the upload tree will be treated just like regular files, unless the -no-hidden flag is given, in which case they are ignored.
The -overwrite flag is required if the user wants existing target system files to be overwritten. Otherwise, without the flag, all existing target system files will remain untouched and the host files are skipped.
The -verbose flag, will cause the name of uploaded files and directories to be printed as they have been created or fully uploaded.
Note: The Simics Agent must have permissions to create and write files in the destination directory on the target system. The uploaded contents will be given ownership and the access permissions of the user who is running the Simics Agent.