Libraries
CLI commands Source Code
 previous   up   next 

Function Summary
void
doRemoveCmd (in array string: fileList, in boolean: recursive, in boolean: force)
Remove files and directories.
void
doCopyCmd (in var array string: fileList, in boolean: recursive, in boolean: overwriteExisting, in boolean: archive)
Copy files and directories.
void
doMoveCmd (in var array string: fileList, in boolean: overwriteExisting)
Move files and directories.
void
doMkdirCmd (in array string: fileList, in boolean: parentDirs)
Make directories.
string
getUnixCommandParameter (inout string: parameters)
Read a parameter for a Unix command from a 'string'.
string
getDosCommandParameter (inout string: parameters)
Read a parameter for a Dos command from a 'string'.
string
getDosEchoParameter (inout string: parameters)
Read a parameter for the Dos echo command from a 'string'.
void
doRm (inout string: parameters)
Remove files and directories like the Unix rm command.
void
doDel (inout string: parameters)
Remove files and directories like the DOS del command.
void
doCp (inout string: parameters)
Copy files and directories like the Unix cp command.
void
doCopy (inout string: parameters)
Copy files and directories like the DOS copy command.
void
doXCopy (inout string: parameters)
Copy files and directories like the DOS xcopy command.
void
doMv (inout string: parameters)
Move files and directories like the Unix mv command.
void
doMove (inout string: parameters)
Move files and directories like the DOS move command.
void
doMkdir (inout string: parameters)
Make directories like the Unix mkdir command.
void
doMd (inout string: parameters)
Make directories like the DOS md command.
string
doPwd (inout string: parameters)
Act like the Unix/DOS pwd (print working directory) command.
string
doEcho (inout string: parameters)
Act like the Unix/DOS echo (write text) command.
void
doCd (inout string: parameters)
Change working directory like the Unix/DOS cd command.
void
doMake (inout string: parameters)
Act like the Unix make command.

Function Detail

doRemoveCmd

const proc: doRemoveCmd (in array string: fileList, in boolean: recursive, in boolean: force)

Remove files and directories. If errors occur messages are written to STD_OUT.

Parameters:
fileList - List of files to be removed.
recursive - TRUE if subdirectories should be removed recursively, FALSE otherwise.
force - TRUE if absent files should not trigger error messages, FALSE otherwise.

doCopyCmd

const proc: doCopyCmd (in var array string: fileList, in boolean: recursive, in boolean: overwriteExisting, in boolean: archive)

Copy files and directories. The list of files must have at least two elements. If the last element of the list is a directory the other files are copied into this directory. If errors occur messages are written to STD_OUT.

Parameters:
fileList - List of files to be copied. The last element is the destination.
recursive - TRUE if subdirectories should be copied recursively, FALSE otherwise.
overwriteExisting - TRUE if existing files should be overwritten, FALSE otherwise.
archive - TRUE if file properties should be preserved, FALSE otherwise.

doMoveCmd

const proc: doMoveCmd (in var array string: fileList, in boolean: overwriteExisting)

Move files and directories. The list of files must have at least two elements. If the last element of the list is a directory the other files are moved into this directory. If errors occur messages are written to STD_OUT.

Parameters:
fileList - List of files to be moved. The last element is the destination.
overwriteExisting - TRUE if existing files should be overwritten, FALSE otherwise.

doMkdirCmd

const proc: doMkdirCmd (in array string: fileList, in boolean: parentDirs)

Make directories.

Parameters:
fileList - List of directories to be created.
parentDirs - TRUE if parent directories should be created as needed, FALSE otherwise.

getUnixCommandParameter

const func string: getUnixCommandParameter (inout string: parameters)

Read a parameter for a Unix command from a 'string'. Unix parameters consist of unquoted and quoted parts. Quoted parts can be quoted with single quotes (') or with double quotes ("). A single quoted part ends with the next single quote. A double quoted part ends with unescaped double quotes. In a double quoted part the sequences \" and \\ do not terminate the quoted part and describe a double quote (") respectively a backslash (\). In an unquoted part a backslash (\) can used to escape characters that would otherwise have a special meaning. The backslash is ignored and the character after it is added to the word. To represent a backslash it must be doubled. When the function is called it is assumed that parameters[1] contains the first character of the parameter. When the function is left parameters is empty or parameters[1] contains the character after the parameter.

Returns:
the next parameter for a Unix command.

getDosCommandParameter

const func string: getDosCommandParameter (inout string: parameters)

Read a parameter for a Dos command from a 'string'. Dos parameters consist of unquoted and quoted parts. Quoted parts start with a double quote (") and end with the next double quote. In an unquoted part a caret (^) can used to escape characters that would otherwise have a special meaning. The caret is ignored and the character after it is added to the word. To represent a caret it must be doubled. When the function is called it is assumed that parameters[1] contains the first character of the parameter. When the function is left 'parameters' is empty or parameters[1] contains the character after the parameter.

Returns:
the next parameter for a Dos command.

getDosEchoParameter

const func string: getDosEchoParameter (inout string: parameters)

Read a parameter for the Dos echo command from a 'string'. Dos parameters consist of unquoted and quoted parts. Quoted parts start with a double quote (") and end with the next double quote. The starting and ending double quotes are part of the result. In an unquoted part a caret (^) can used to escape characters that would otherwise have a special meaning. The caret is ignored and the character after it is added to the word. To represent a caret it must be doubled. When the function is called it is assumed that parameters[1] contains the first character of the parameter. When the function is left 'parameters' is empty or parameters[1] contains the character after the parameter.

Returns:
the next parameter for the Dos echo command.

doRm

const proc: doRm (inout string: parameters)

Remove files and directories like the Unix rm command. The command accepts the options -r, -R and -f.

Parameters:
parameters - Parameters (file names and options) of the command. The function removes the used parameters.

doDel

const proc: doDel (inout string: parameters)

Remove files and directories like the DOS del command. The command accepts the option /S.

Parameters:
parameters - Parameters (file names and options) of the command. The function removes the used parameters.

doCp

const proc: doCp (inout string: parameters)

Copy files and directories like the Unix cp command. The command accepts the options -r, -R, -n, -a and -p.

Parameters:
parameters - Parameters (file names and options) of the command. The function removes the used parameters.

doCopy

const proc: doCopy (inout string: parameters)

Copy files and directories like the DOS copy command. The command accepts the option /Y.

Parameters:
parameters - Parameters (file names and options) of the command. The function removes the used parameters.

doXCopy

const proc: doXCopy (inout string: parameters)

Copy files and directories like the DOS xcopy command. The command accepts the options /E, /O and /Y.

Parameters:
parameters - Parameters (file names and options) of the command. The function removes the used parameters.

doMv

const proc: doMv (inout string: parameters)

Move files and directories like the Unix mv command. The command accepts the option -n.

Parameters:
parameters - Parameters (file names and options) of the command. The function removes the used parameters.

doMove

const proc: doMove (inout string: parameters)

Move files and directories like the DOS move command. The command accepts the option /Y.

Parameters:
parameters - Parameters (file names and options) of the command. The function removes the used parameters.

doMkdir

const proc: doMkdir (inout string: parameters)

Make directories like the Unix mkdir command. The command accepts the option -p.

Parameters:
parameters - Parameters (file names and options) of the command. The function removes the used parameters.

doMd

const proc: doMd (inout string: parameters)

Make directories like the DOS md command.

Parameters:
parameters - Parameters (file names and options) of the command. The function removes the used parameters.

doPwd

const func string: doPwd (inout string: parameters)

Act like the Unix/DOS pwd (print working directory) command.

Parameters:
parameters - Parameters (file names and options) of the command. The function removes the used parameters.
Returns:
the current working directory.

doEcho

const func string: doEcho (inout string: parameters)

Act like the Unix/DOS echo (write text) command.

Parameters:
parameters - Parameters (file names and options) of the command. The function removes the used parameters.
Returns:
the string that should be written.

doCd

const proc: doCd (inout string: parameters)

Change working directory like the Unix/DOS cd command.

Parameters:
parameters - Parameters (file names and options) of the command. The function removes the used parameters.

doMake

const proc: doMake (inout string: parameters)

Act like the Unix make command. This library just contains a forward definition. The actual definition of this function must be done outside of this library.

Parameters:
parameters - Parameters (file names and options) of the command. The function removes the used parameters.


 previous   up   next