TaskMaster / TMLite Quick Reference
Extended Console Commands
(As of: v4.20 / Updated: 07 Nov 2008)
Executable via TMConsole (Shell) prompt or within a Batch / Task script
Syntax :   { } required     [ ] optional     | 'or'                 Options :   Must be separated by space
Column > :   Output redirection supported (i.e., for logging - must be last item on command line)
(overwrite:   >vol:path\name.ext     append:   >>vol:path\name.ext)
Local Server Commands
(Supported by TaskMaster & TMLite unless noted otherwise.)
Command Syntax Options > Comments
ABORT {cmd | task} /# # (numeric) instance
/A All matching instances
Cancel the specified {cmd} or {task}. The /# and /A options apply when aborting specific instances of multiple active SYNC commands or tasks.
APPEND [[d:|vol:]path\]{src} [[d:|vol:]path\]{dest}   X Append {src} file specification to {dest} file specification.
CD [[vol:]path]
CHDIR [[vol:]path] 		    Change Current Working Directory (CWD) to path.
Note: If no specification provided, show CWD.
CHMOD [[vol:]path\]{spec} [[+|-]attr] (Refer to FLAG) X (Refer to FLAG)
CHOWN [[vol:]path\]{spec} [user] /DO Dirs only
/FO Files only
/H Hidden/System
/S Subdir recursion 		X List/Set owner for dirs & files matching {spec}.
Notes: List mode if no [user] specified. {spec} must be a valid file specification or search pattern.
CLEAR CONNS {#} [# # # ...]   X Clear (kill) specified connections.
CLEAR USERS {user} [user user user ...]   X Clear (kill) connections with logged in Object names matching {user}.
Note: Supports wild cards.
COPY [[d:|vol:]path\]{src} [[d:|vol:]path\]{dest} /D Decompress dest (NW Co)
/I Ignore errors
/O Owner set (def) | /-O not
/T Trustee set (def) | /-T not 		X Basic local Server file copy (NSS / TFS Volumes & DOS partition).
Notes: Attributes, date/time stamps, IRM, owner, and trustee rights are set to match the source, by default. Supports wild cards.
DEL [[d:|vol:]path\]{spec}
DELETE [[d:|vol:]path\]{spec} 		/Y Confirm delete all   Delete any file(s) which match {spec}.
Note: Supports wild cards.
DELTREE [[vol:]path\]{spec} /# Repeat process up to /# times
/I Ignore non-critical errors
/K Keep dirs (files only)
/P Purge deleted dirs/files
/V Verbose listing
/Y Confirm delete all 		  Recursive deletion of dirs & files which match {spec}.
Note: Supports wild cards.
DIR [[d:|vol:]path\][spec] /A Attr info | /A=search
/B Bare list
/D Dir list | /-D no dirs
/F File list | /-F no files
/H Hidden/System
/L= Len (size) search
/N NS info | /N=search
/O Owner info | /O=search | /-O Bad
/Q Quiet mode (summary list only)
/R Rights info | /R=search | /-R Bad
/S Subdir recursion
/T Time info | /T=search
/W Wide list
/X DOS list (no NS info) 		X List dirs & files matching [spec] and optional search criteria.
Notes: Lists all, if no [spec]. Supports wild cards.
DUMP [[d:|vol:]path\]{file}     Hexadecimal list of {file} contents.
ERASE [[d:|vol:]path\]{spec}     (Refer to DEL or DELETE)
FILE CLOSE [[vol:]path\]{spec} /S Subdir recursion X Close file(s) matching {spec} without clearing (killing) the associated connection(s).
Notes: File(s) are internally flushed prior to close. Supports wild cards.
FILE UNLOCK [[vol:]path\]{spec} /S Subdir recursion X Unlock file(s) matching {spec} without clearing (killing) the associated connection(s).
Notes: Only Server-based locks. Supports wild cards.
FIND "string" [[vol:]path\]{spec} /C Count lines
/I Case insensitive
/L List files only
/N Line Numbers
/S Subdir recursion
/X DOS name 		X List file(s) matching {spec} which contain "string".
Notes: /C overrides /L and /N. Supports wild cards.
FLAG [[vol:]path\]{spec} [[+|-]attr] /DO Dirs only
/FO Files only
/H Hidden/System
/S Subdir recursion 		X Set attributes for dirs &/or files matching {spec}.
Note: Lists current attributes if no [attr] specified.
FLAGDIR [vol:]{spec} [[+|-]attr] /H Hidden/System
/S Subdir recursion 		X Set attributes for dirs matching {spec}.
Note: Lists current attributes if no [attr] specified.
GRANT {rights} [[vol:]path\]{spec} {user | group}   X Set specified {rights} to {user} or {group} for Dir(s)/File(s) matching {spec}.
Note: Supports wild cards.
LIST CONNS {#} [# # # ...] /A Address
/O Object type 		X List info about the specified connection(s).
LIST MODULES [nlm] /I Info (resources) X List info on any modules matching [nlm].
Notes: Lists all loaded modules if no [nlm]. Supports wild cards.
LIST SCREENS   X List NLM screens & which NLM created each.
LIST SESSIONS /I Info (resources) X List any active TMRemote sessions.
Note: * Not supported by TMLite. *
LIST USERS [user] /A Address
/O Object type 		X List any connections with logged in Object names matching [user].
Notes: Lists all logged in conns if no [user]. Supports wild cards.
LIST VOLUMES [vol]   X List info on any mounted volume matching [vol].
Note: List all volumes if no [vol].
MD [[d:|vol:]path\]{dir}
MKDIR [[d:|vol:]path\]{dir} 		/D Create as DOS Name Space
/L Create as Long Name Space
/M Create as Mac Name Space
/N Create as NFS Name Space 		  Create {dir}.
Note: Supports DOS partition.
PURGE [[vol:]path\]{spec} /# deleted age (min)
/A All (subdirs)
/D Dirs processed
/Q Query (list only)
/Z Zero length files 		X Purge deleted files matching {spec} in [[vol:]path\].
Note: Purge all files in CWD if no {spec}.
RD [[d:|vol:]path\]{dir}
RMDIR [[d:|vol:]path\]{dir} 		    Remove {dir}.
Note: Supports DOS partition.
REN [[d:|vol:]path\]{spec} [path\]{spec}
RENAME [[d:|vol:]path\]{spec} [path\]{spec} 		/C Change owning Name Space
/D DOS Name Space
/L Long Name Space
/M Mac Name Space
/N NFS Name Space 		  Rename files.
Notes: Same drive / volume only. Supports wild cards. Supports DOS partition. The /C option requires a Name Space option and changes the owning Name Space. If a Name Space is specified without the /C option, only the specified Name Space name is modified.
RENDIR [[d:|vol:]path\]{spec} [path\]{spec} /C Change owning Name Space
/D DOS Name Space
/L Long Name Space
/M Mac Name Space
/N NFS Name Space 		  Rename directory.
Notes: Same drive / volume only. The /C option requires a Name Space option and changes the owning Name Space. If a Name Space is specified without the /C option, only the specified Name Space name is modified.
REVOKE {rights} [[vol:]path\]{spec} {user | group}   X Revoke {rights} from {user} or {group} for dirs & files matching {spec}.
Note: Supports wild cards.
SORT [[vol:]path\]{src} [[vol:]path\]{dest} {keys} /D Descending sort
/I Insensitive case
/N Null records excl.
/P Pack data for keys 		X Sort {src} into {dest} using {keys}.
SC [cmdline]
SYSTEM CONSOLE [cmdline] 		    Change the active screen on the Server Console to the System Console screen.
Note: Optional [cmdline] can be passed to System Console prompt.
TASKLIST   X List active tasks.
TMCMD {cmd} [...]     Launches {cmd} (Local Console Command) as a single command task (.i.e, batch processed).
TMCONFIG ADD OPERATOR {obj_name[.cx]}
TMCONFIG DEL OPERATOR {obj_name[.cx]}
TMCONFIG LIST OPERATOR [spec]
TMCONFIG ADD USER {obj_name[.cx]}
TMCONFIG DEL USER {obj_name[.cx]}
TMCONFIG LIST USER [spec]
TMCONFIG LOG CLEAR
TMCONFIG LOG SAVE [[vol:]path\]filename.ext
TMCONFIG TMREMOTE {user_class} {rights}
TMCONFIG TMREMOTE LIST
TMCONFIG TMREMOTE PASSWORD 		    Manage the TaskMaster configuration, including:
Add/Del/List TM Operator(s);
Add/Del/List TM Users(s);
Clear/Save Master log file;
Define/List TM Remote Console Users/Rights/Password.
Note: * Only the LOG options are supported by TMLite. *
TMHELP [cmd]     On-line help for [cmd].
Note: General help if no [cmd] specified.
TMINFO   X Registration information.
TMRELOAD     Reload Server module (NLM).
TMRESET     Causes the NLM to re-read the configuration & schedule files.
TMRUN [[vol:]path\]{task} ["arg"] ["arg" "arg" ...]     Launch processing of {task}.
TMSCHEDULE [task]
TMSCHEDULE ADD {task} {date} {time}
TMSCHEDULE DEL {task} [/# | /A]

/# matching task number #
/A all matching tasks 		X Add/Del/List task schedule.
ADD: {date} = date (mm/dd), every month (dd) or weekday (Y|N for SMTWTFS).
ADD: {time} = time (hh:mm), every hour (:mm) or interval (mm).
Notes: Use DOS 8.3 name only for task, no path or Long name. Wild cards supported for [task], except for ADD/DEL.
TMSERVER CX   - list DS context
DS   - list full DS Server name
TREE   - list DS tree
UPTIME   - list Server up-time 		X List Server information.
TMSMTP {svc.domain.sub} [[vol:]path\]{filename.ext}
TMSMTP {###.###.###.###} [[vol:]path\]{filename.ext} 		    Connection to the specified SMTP Server (first specification, named or dot notated) then send the specified file (second specification) as a self contained E-Mail message (i.e., TO: / FROM: contained therein).
Note: * Not supported by TMLite. *
TMUNLOAD     Unloads the NLM.
TREE [[vol:]path] /A ASCII indent character
/B Bare list
/D Delimited data
/F Fixed length fields
/I Dir/File info
/S Size not formatted
/X DOS name only 		X List directory tree for [path].
Note: List Current Working Directory (CWD) tree, if no [path] specified.
TYPE [[d:|vol:]path\]{file}     List the contents of the specified {file}. (ASCII dump.)
USERLIST [user] (Refer to LIST USERS) X (Refer to LIST USERS)
VOLINFO [vol]   X (Refer to LIST VOLUMES)
WHEREIS {spec} /D incl Dirs (def) | /-D excl
/F incl Files (def) | /-F excl
/I Info 		X List dirs / files matching {spec} on Current Working Volume (CWV).
WHOHAS {spec} /S Subdir recursion X List connection(s) / module(s) with any file open matching {spec}.
XCOPY [[d:|vol:]path\]{src} [[d:|vol:]path\]{dest} /A Archive copy
/D Decompress dest (NW Co)
/E Empty Dir copy
/G Gridlock (error if dest open)
/H Hidden/System
/I Ignore errors
/M (/A & reset attr)
/N Nice (shared RO) | /-N Excl mode
/O Owner set (def) | /-O not
/R overwrite RO
/S Subdir recursion
/T Trustee set (def) | /-T not 		X Enhanced local Server copy (NSS / TFS Volumes & DOS partition).
Notes: Attributes, date/time stamps, IRM, owner, and trustee rights are set to match the source, by default. Supports wild cards. Supports DOS partition.
Remote Server Commands
(Supported by TaskMaster, not supported by TMLite.)
Command Syntax Options > Comments
SCOPY [[vol:]path\]{lsrc} rserver/vol:path\[rdest]
SCOPY rserver/vol:path\{rsrc} [[vol:]path\][ldest] 		/B Block update (def) | /-B full copy
/C Compress xfer | /-C Raw
/D Decompress dest (NW Co)
/I Ignore errors
/O Owner set (def) | /-O not
/T Trustee set (def) | /-T not
/+IP[=?] if IP avail, use ? pkt size
/+NCP[=?] use NCP & ? pkt size
/# Summary processing statistics 		X Basic file copy between Servers.
Block Update: If /-B is not specified, Block (Delta Change) Update logic is used to minimize the amount of data transferred for file updates.
Compression: If neither /C nor /-C specified (default), intelligent compression used (compression only attempted on uncompressed file types).
Gridlock: If destination file is Open (InUse), it is closed (default) unless /G option is specified which causes an InUse error.
IP Support: If both Servers are NetWare v5+ with IP and a stable comm link can be established, data transfer will utilize IP (UDP) by default. While the default maximum calculated packet size cannot be increased, it can be decreased via /+IP=x option (x = desired packet size - range: 1024 - 32768). Using /+NCP or /+NCP=x option (x = desired packet size - range: 1024 - 32768) disables IP (UDP) support and forces use of NCP Extensions.
Notes: Attributes, date/time stamps, IRM, owner, and trustee rights are set to match the source, by default. Wild cards are supported for Local-to-Remote operations only.
STASKLIST {rserver}   X List active tasks on {rserver}.
STMINFO {rserver}   X Registration info for {rserver}.
SXCOPY [[vol:]path\]{lsrc} rserver/vol:path\[ldest]
SXCOPY rserver/vol:path\{rsrc} [[vol:]path\][rdest] 		/A Archive copy
/B Block update (def) | /-B full copy
/C Compress xfer | /-C Raw
/D Decompress dest (NW Co)
/E Empty Dir copy
/G Gridlock (error if dest open)
/H Hidden/System
/I Ignore errors
/J Jumble (encrypt) data
/M (/A & reset attr)
/N Nice (shared RO) | /-N Excl mode
/O Owner set (def) | /-O not
/R overwrite RO
/S Subdir recursion
/T Trustee set (def) | /-T not
/X eXclude non-DOS criteria
/+IP[=?] if IP avail, use ? pkt size
/+NCP[=?] use NCP & ? pkt size
/# Summary processing statistics 		X Enhanced file copy between Servers.
Block Update: If /-B is not specified, Block (Delta Change) Update logic is used to minimize the amount of data transferred for file updates.
Compression: If neither /C nor /-C specified (default), intelligent compression used (compression only attempted on uncompressed file types).
Gridlock: If destination file is Open (InUse), it is closed (default) unless /G option is specified which causes an InUse error.
IP Support: If both Servers are NetWare v5+ with IP and a stable comm link can be established, data transfer will utilize IP (UDP) by default. While the default maximum calculated packet size cannot be increased, it can be decreased via /+IP=x option (x = desired packet size - range: 1024 - 32768). Using /+NCP or /+NCP=x option (x = desired packet size - range: 1024 - 32768) disables IP (UDP) support and forces use of NCP Extensions.
Notes: Attributes, date/time stamps, IRM, owner, and trustee rights are set to match the source, by default. Wild cards and the options /A /E /M /S are supported for Local-to-Remote operations only.
TMSCMD {rserver} {cmd}     Submit {cmd} to {rserver}.
TMUPDATE [rserver] [rserver rserver ...] /U Update / Upgrade only X Distributes/reloads TaskMaster NLMs to specified [rserver] Remote Servers.
Notes: Updates known Servers running TaskMaster NLM if no [rserver] specified. Wild cards supported.
SYNC: Replicate Files / Synchronize Data
(Supported by TaskMaster, not supported by TMLite.)
Command Syntax Options > Comments
SYNC [[vol:]path\]{src} vol:path [<excl.lst]
SYNC [[vol:]path\]{src} remote/vol:path [<excl.lst]
SYNC LIST 		/A Add (if not on dst)
/B Block update (def) | /-B full copy
/C Compress xfer | /-C Raw
/D Del (if not of src)
/E Excl src access | /-E Shared R/O
/F File info compare
/G Gridlock (error if dest open)
/H Hidden/System
/I Ignore errors
/J Jumble (encrypt) data
/K Keep dirs (with /D)
/L Log command line
/M Mod (src newer dest)
/O Owner set (def) | /-O not
/Q Query mode
/R Replace (copy all)
/S Subdir recursion
/T Trustee set (def) | /-T not
/U Upd (dst newer src)
/V Ver (src/dst mismatch)
/W Warnings/Errors only
/X eXclude non-DOS processing
/+ENT=# max entries per directory
/+EXC=# max entries for exclusion
/+IP[=?] if IP avail, use ? pkt size
/+MIG=[Y|N] process migrated files
/+NCP[=?] use NCP & ? pkt size
LIST List active SYNC processing 		X Replicate files &/or synchronize data between Local directories and directories on Local or Remote Servers based upon the options specified.
Block Update: If /-B is not specified, Block (Delta Change) Update logic is used to minimize the amount of data transferred for file updates.
Compression: If neither /C nor /-C specified (default), intelligent compression used (compression only attempted on uncompressed file types).
Gridlock: If destination file is Open (InUse), it is closed (default) unless /G option is specified which causes an InUse error.
IP Support: If both Servers are NetWare v5+ with IP and a stable comm link can be established, data transfer will utilize IP (UDP) by default. While the default maximum calculated packet size cannot be increased, it can be decreased via /+IP=x option (x = desired packet size - range: 1024 - 32768). Using /+NCP or /+NCP=x option (x = desired packet size - range: 1024 - 32768) disables IP (UDP) support and forces use of NCP Extensions.
For more detailed information, refer to the: SYNC FAQ
Notes: Attributes, date/time stamps, IRM, owner, and trustee rights are set to match the source, by default. Specific source dirs, files & file patterns can be excluded using a redirection list ([<excl.lst]).