ENOVIA Synchronicity DesignSync Advanced Quick Reference

backup - Backs up a SyncServer [-[no]recursive] [-[no]force]

backup [-from <date>] [ [-lock [[-keys <mode>] | [-from {local | vault}]]

cachescrubber - Cleans the cache of outdated or unused files [-merge] [-reference]] |

ENOVIA SYNCHRONICITY [-get [[-keys <mode>] | [-from {local | vault}]]

cachescrubber <cache directory> [<age in days>] [-noref]

[-merge] [-overlay <selector>[,<selector>...]]] |

DESIGNSYNC DATAMANAGER ADVANCED [-preds32] [-dryrun] [-report <mode>]

-share | -mirror | -reference]

COMMAND QUICK REFERENCE [-usage] [-help] [-[no]unifystate] [-[no]retain] [-savelocal <value>]

cachetouchlinks - Determines which files to be cleaned by the [-trigarg <arg>] [--] [<argument> [<argument...]]
cachescrubber command
add - Adds new objects to a module compare - Compares workspaces and module versions
cachetouchlinks [-path <path-to-workspace-dir> |

add [-[no]recursive [-[no]emptydirs]]] [-filter <string>] compare [-[no]same] [-[no]history] [-format list|text]

-file <path-to-workspace-list-file>]

[-no[selected]] [-report brief|normal|verbose|error] [-output <file> | -stream <stream>]

[-norecursive] [-ignoreerrs] [-report <mode>]

[--] <workspace module>[<argument>...] [-recursive | -norecursive]

addbackref - Adds whereused support to targets of hierarchical [-dryrun] [-checkerrors]
references.
cancel - Cancels a previous checkout operation [-report silent|brief|normal|verbose] [-[no]path]

addbackref [-[no]recursive] <argument> cancel [-[no]recursive] [-filter <string>] [-hreffilter [-exclude <string>] [-filter <string>] [-hreffilter
<string>] <string>]
addcdslib - Specifies a cds.lib file
[-exclude <object>[,<object>...]] [-selector <selector> [-hrefmode dynamic|static|normal]

addcdslib <path> [-keep | -share | -mirror | -reference] [-selector2 <selector2> [-hrefmode2
dynamic|static|normal]]]

addhref - Creates a hierarchical reference between modules [-[no]selected] [-[no]force] [-[no]retain] [-trigarg <arg>] [ -[modulecontext <context>]

addhref <fromargument> <toargument> [-relpath <rel_path>] [-modulecontext <context>] [--] [<argument> [--] [argument [argument]]
[-name <name>] [-rootpath <path>] [<argument>...]]
compare-foreach - Function to process the results of a
cd - Changes your current directory compare command.

addhref <fromargument> [-rootpath <path>] [-relpath See a Tcl language reference manual. compare-foreach var1 var2 result_list tcl_script [-
<rel_path>] nofolder] [-path]
ci - Checks in the specified objects
[-file <filename> |-tcllist contents - Lists the contents of a configuration or a module.
<toargument_specification_list>] ci [-branch <branch> | -branch auto(<branch>)]
contents [-selector <selector>] [-filter <string>]
alias - Creates, shows, or removes a command alias [-modulecontext <context>] [-filter <string>] [-hreffilter <string>] [-exclude <object> [,<object>...]]
[-format <text| list>] [-[no]recursive] [-[no]versions]
alias [-temporary] [-args <#>] [--] [-exclude <object>[,<object>...]] [-hrefmode <dynamic|static|normal>]
[-modulecontext <context>]
{-list | -delete <alias_name> | <alias_name> {<cmd> [&& [-hreffilter <string>] [-[no]hrefversions] [-report silent|normal|verbose]
<cmd> ...]}} [-output <file>] [stream <stream>]
[-[no]new] [-[no]comment "<text>"]
annotate - Shows last modification information per line
[-[no]selected] [-[no]recursive]
annotate [-version <selector>] [-back <number> | -from
<selector>] [-[no]dryrun] [-[no]force]

[-[no]skip] [-[no]retain]

[-[no]white] [-output <filename> ] [--] <argument> [-datatype ascii | binary] [-tag <tagname>] [-[no]path] [-fullpath] <argument>

auto_mkindex - Indexes stcl procedures [-keep [-keys <mode>] | -lock [-keys <mode>] | contents-foreach - Function to process the results of a
contents command.
auto_mkindex <directory_name> [<file>...] -share | -mirror | -reference]
contents-foreach var result_list tcl_script [-nofolder] [-
Note: This command is supported only in stcl mode. [-report brief|normal|verbose|error] -[no]iflock path]

auto_reset - Resets the Tcl autoload index [-[no]resume]] [-trigarg <arg>] [--] datasheet - Displays an object's data sheet

auto_reset [<argument> [<argument>...]] datasheet <object>

Note: This command is supported only in stcl mode. co - Checks out the specified objects DesSync - Invokes the DesignSync graphical interface

co [-version <selector>[,<selector>...]] DesSync [-nosplash] [path]

[-exclude <object>[,<object>...]]

[-[no]selected] [-[no]comment "text"]

diff - Compares files and versions of files [-writableunlocked] [-filter <string>] [-exclude <string>] notetype - Server-side commands to manipulate note types

diff [-standard | -unified | -syncdiff | -annotate | -gui] [-hreffilter <string>] [--] [<argument> [<argument>...]] notetype <notetype_command> [<notetype_command_options>]

[-version <id>] [-output <resultFile>] ls-foreach - Function to process the results of an ls command.

[-binary] [-ancestor <commonAncestorFile>] ls-foreach var result_list tcl_script [-nofolder] [-path] Usage: notetype

[-embed] [-white] [-case] [-kk] [-modulecontext <context>] migratetag - Migrates old DesignSync tags to modules. [create|delete|enumerate|getdescription|rename|
schema]
[-[no]usemoduleversions] [--]
migratetag [-branchname <branchtag>] [-list] <argument> password - Stores a user's name and password.
{[-file1] <fileA>} [[-file2] <fileB>] [<selector>[,<selector>...]]

dss - Invokes the DesignSync shell (dss) mirrorsetdefaultuser - Sets the default user and password using password -save <ServerURL> specified objects
a UNIX shell script
dss [<command>] populate - Fetches or updates

dssc - Invokes the concurrent version of dss mirrorsetdefaultuser <serverURL> <defaultUser> populate [-dir <path>] [-version
<selector>[,<selector>...]]
dssc [<command>] mkbranch - Creates a new branch
[-incremental | -full] [-[no]new]]
exit - Ends a DesignSync session, or an stcl script
mkbranch [-[no]selected] [-exclude <string>,[<string>...]] [-[no]recursive] [-modulecontext <context>]
exit [-daemon [-force]] [<status>]
[-[no]recursive] [-[no]comment <text>] [-filter <string>] [-exclude
gets - Reads a string from a file <object>[,<object>...]]
[-version <selector>] [--]
See a Tcl language reference manual. [-hreffilter <string>]
<branchname> [<argument> [<argument> ...]]
help - Provides help on the Synchronicity command set [-hrefmode {static | dynamic | normal}]
mkedge - Creates merge edges between specified versions.
help [-summary] [-brief] [-all] [-output <file>] [<topic> [-report brief|normal|verbose|error] [-[no]force]
[...]] mkedge [-modulecontext <module>] -- <argument>
[[-lock [-keys <mode> | -from {local | vault}]] |
import - Fetches an object, leaving it unmanaged mkfolder - Creates a folder (directory)
[-get [-keys <mode> | -from {local | vault}]]
import [-version <selector>] [-force] [--]
mkfolder [--] <foldername> [<foldername>...] [-share] | [-mirror] | [-reference] [-lock -reference] ]
<argument> <object> [<object>...] [-[no]merge] [-overlay <selector>[,<selector>...]]|
mkmod - Creates a module on a server
locate - Finds a specified object on the search paths
mkmod [-[no]comment "<text>"] [-path <workspace_path>] [-[no]retain] [-reference]
locate [-first | -all] [-env | -path | -url] [-reverse] <argument>
[-[no]unifystate] [-trigarg <arg>]
[-nothrow] [--] <ObjectName> module - Commands to manipulate module data
[-[no]emptydirs] [-log <filename>]
lock - Creates a server-side lock on a module branch. <module_command> [<module_command_options>]
[-target <module_configuration_url>]
lock [-[no]comment [<string>] [--] argument
[-mcachemode <mcache_mode>] [-mcachepaths <path_list>]
log - Logs DesignSync commands and results to a file
Usage: [-savelocal <value>] [-[no]replace] [-xtras <list>]
log [-on | -off] [-output | -nooutput] [-state] [--] [add|addbackref|addhref|addlogin|get|lock|migratetag|
[<argument> [<argument>...]]
[-defaultdir <dir> | <logFileName>] mkedge|mkmod|mvmember|remove|rollback|rmedge|rmhref|
prompt - Sets the dss/dssc command-line prompt
ls - Lists information about the specified objects rmlogin|rmmod|showconfs|showhrefs|showlogins|showmcache|
prompt [-default | -url]
ls [-[no]recursive] [-merged added|rename|remove|all|""] showmods|showstatus|whereused|unremove|upgrade|version]
purge - Purges specified branches or versions of objects from
[-[no]selected] [-[no]addselect] [-[no]path | -fullpath] more - Controls the paging of command output the vault.

[-report <mode>[+<mode>][-<mode>]] [-format list | text] more [-lines <n>] [--] <command> purge [-branch <branchname>]

[-output <file> | -stream <stream>] mvfile - Moves the specified object [-exclude <object>[,<object>...]]

[-[no]header] [-[un]locked [-workspace <path> | -vault mvfile [-allconfigs] <object> <destination> [-keepversions <n>]
<path>]]
mvfolder - Moves the specified folder [-keepsince <date>]
[-[un]managed] [-[un]changed] [-[un]modified]
mvfolder [--] <folder> <destination> [-[no]recursive]
[-[no]needsmerge [-branch <branch>]] [-modulecontext
<context>] mvmember - Changes the natural path of a module member. [-report <mode>]

mvmember [-modulecontext <context>] [-[no]selected] [-[no]dryrun]

[-[no]immediate] [--] [<fromargument>...] <toargument> [-[no]force]

[--] rmvault - Deletes the specified vault showhrefs - Displays the hierarchy of a module.

<argument> [<argument>...] rmvault [-[no]force] [-[no]keepvid] [-trigarg <arg>] [--] showhrefs [-format text|list] [-report {normal | verbose |
brief}]
quit - No longer valid; use 'exit' <vault> [<vault> [...]]
record - Captures command output [-hrefmode {dynamic | static | normal}] [-[no]recursive]
rmversion - Deletes versions from the vault
record <command> <variable> <argument>
rmversion [-[no]force] [-trigarg <arg>] [-report <mode>] [-
refreshcache - Refreshes a workspace, re-establishing cache -] <version> showlocks - Shows all locked items in the vault.
links to point to either a new cache location or to new cache
names. [<version> [...]] showlocks [-format text|list] [-modulecontext <context>]

refreshcache [-workspace <path-to-workspace-dir>| -file rollback - Reverts a module back to a previous version, rolling [-[no]recursive] <argument>
back any structural changes.
<path-to-workspace-list-file>] showmcache - Lists the modules in one or more module
rollback [-[no]comment ["text"]] [-version <selector>] caches.

[-preds32] [-dryrun] [-norecursive] [-continue_on_error] [--] <argument> showmcache [-mcachepaths <path_list>] [-format (text |
[-verbose] [-usage] [-help] list)]
rstcl - Runs server-side stcl scripts
showmods - Displays the modules available on a server or
remove - Removes a module member from a module. rstcl -server <serverURL> -script <script> workspace.

remove [-[no]recursive] [-filter <string>] [-[no]keep] [- [-urlparams <name>=<value>[&<name>=value[...]]] showmods [-report {normal | brief | verbose}]
[no]force] [-output <file>]
[-format [{text | list}] [-filter <string>] [<argument>]
[-[no]immediate] [-modulecontext <context>] [--] <argument> run - Executes a DesignSync command file or stcl script
restoreserver - Restores the data from a backed-up server showstatus - Displays the status of a module in your
run [-verbose] [-dryrun] [-ignoreerrs] [--] workspace.

restoreserver {-defaultdir <dir> | <filename>} showstatus [-[no]recursive] [-releases] [-[no]objects]

restorevault - Restores specified server vault or directory data scd - Changes your current location [-report {normal | brief | summary | verbose}]

restorevault [-overwrite] -from <backup_area> [--] <path> scd [--] [<path> | <URL>] [-format <type>] [-[no]hrefs] <argument>

retire - Marks a branch as obsolete select - Identifies specific objects to be processed spwd - Displays the URL of the current location

retire [-[un]retire] [-[no]keep] [-[no]selected] [- select [--] {-show | <argument> [<argument>...]} spwd
[no]recursive]
setfilter - Sets the persistent filter or hreffilter list stcl - Invokes the Synchronicity Tcl interface
[-[no]force | [-branch <branch> | -branch auto(<branch>)]]

[-trigarg <arg>] [--] [<argument> [<argument>...]] setfilter [-filter | -hreffilter] [--] stcl [--] [-exp '<command>' | <scriptname>]

rmedge - Removes previously set merge edges <workspace module> <filter>|<hreffilter> stclc - Invokes the concurrent version of stcl

rmedge -modulecontext <moduleURL> -- <argument> setmirror - Maps a mirror directory to a working directory stclc [--] [-exp '<command>' | <scriptname>]

rmfile - Deletes the specified object setmirror [--] [<mirrorDirectory> <localWorkingDirectory>] switchlocker - Changes the current owner of a lock

rmfile [-trigarg <arg>] [--] <object> [<object> [...]] setowner - Sets the owner on the object specified switchlocker [-modulecontext <context>] [--] <locker>
<argument>
rmfolder - Deletes the specified folder setowner [--] <argument> <owner>

rmfolder [-[no]recursive] [-trigarg <arg>] [-[no]keepvid] setroot - Sets the module root in a workspace
<folder>
setroot -[[un]set] [--] <workspace folder> SyncAdmin - Synchronicity Administrator tool
[<folder> [...]]
setselector - Sets the persistent selector list SyncAdmin [-site | -project | -user | -file <filename>]
rmhref - Removes a hierarchical reference between modules
setselector [-selected] [-recursive] [--] sync_workspace_upgrade - Updating workspace metadata
rmhref <fromargument> <toargument> [<toargument>..] from 3.X to 5.X.
<selector>[,<selector>...] <argument> [argument>...]
rmmod - Removes a module from a server sync_workspace_upgrade [-help] [-usage] [-force]
setvault - Associates a vault with a work area [-report normal|verbose|brief]
hcm rmmod [-[no]vaultdata] [-[no]notes] [-[no]force] [- <workspace-directory-1> [<workspace-directory-2>...]
[no]keep] setvault [-recursive] [--]
<vaultURL>[@<selector>[,<selector>...]]
<argument>
<localFolder>

syncdadmin - Manages syncd processes [-maxtags <n>] [-exclude <string>] access global - Defines global variables and procs for access
filters
syncdadmin [start | begin | stop [-force] | close [-force] [-modulecontext <context>]
| access global <script>
[-output <filename> | -stream <port>]

lock | unlock | status [-verbose]] [--] <argument> [<argument>...] access init - Defines variables and procs

syncinfo - Returns Synchronicity environment information vhistory-foreach - Function to process the results of a vhistory access init [<actionList>] <script>
command.
syncinfo [<arg> [<arg>...]] access list - Returns a list of defined access controls
vhistory-foreach obj result_list <tcl_script>
tag - Assigns a tag to a version or a branch access list -actions
vhistory-foreach-obj- Function to process the results of a
tag [ -[no]replace | [-[no]delete | vhistory command. access reset - Updates a SyncServer's access controls

[-version <selector> | vhistory-foreach-obj vb obj <tcl_script> access reset

[-branch <branch> | -branch auto(<branch>)]]]] whereused - Traces the use of hierarchical references access verify - Determines whether a user is allowed to perform
an action
[-[no]recursive] [-[no]modified] whereused [-[no]recursive] [-format list|text] [-report
<mode>] access verify <action> <user> [<arg> [...]] [-why <var>]
[-[im]mutable] [-[no]comment <text>]
[-showtags all|none|immutable|version] access verify <note_action> <note_system> <note_type> *
[-[no]selected] [-exclude <object>[,<object>,...]]
[-versions <selector>,...] <argument> ctp list - Lists installed Custom Type Packages
[-report <mode>] [-warn <mode>] -modulecontext
<context> interrupt - How to interrupt commands

[-trigarg <arg>] [--] <tagname>

[<argument> [<argument> ...]] Control-c (Delete key on HP platforms) ctp list

unlock - Releases the lock from a server branch access allow - Allows access to the specified actions ctp verify - Validates installed Custom Type Package files

unlock [-[no]recursive] [-[no]selected] [-trigarg <arg>] access {allow | deny} <actionList> {everyone | [only] users ctp verify [<path>]
<userList>}
[-exclude <object>[,<object>...]] [-filter <string>] defaults commands - Lists the commands that support the
[when <parm> <globExpr> [when ...]] [-because defaults system
[-branch <branch> | -branch auto(<branch>)] "<message_string>"]

[-modulecontext <context>] [--] [<argument> [<argument> access db_filter - Specify criteria for allowing or denying access defaults commands
...]] for ViewNote or EditNote defaults off - Disables the command defaults system

unremove - Restores removed files to a module

unremove [-version <selector>] -modulecontext <context> access db_filter <actionList> [when <parm> <globExpr> [when defaults off [<expr>]

<member-path>[;<member-version>] ...]] <script> defaults on - Enables the command defaults system

unselect - Removes files from the 'selected' list access decline - Causes additional access rules to be invoked defaults on

unselect [-quiet] [--] [-all | <argument> [<argument>...]] access decline <actionList> {everyone | users <userList>} defaults refresh - Refreshes the command defaults system
[when <parm> <globExpr> [when ...]]
unsetvault - Disassociates a vault from a work area
access define - Define additional actions to be access defaults refresh
unsetvault [-[no]recursive] <argument> [..] controlled
defaults set - Defines the default values for a command

upgrade - Upgrades a DesignSync vault folder or a legacy access define <action> [<parameterList>] defaults set [-temporary | -nooverrule] -- <command>
module to the current module structure <option>
access deny - Denies access to the specified actions
upgrade [-[no]maphrefs] [-[no]maperror] [-name [<option> ...]
<modulename>]
access {allow | deny} <actionList> {everyone | [only] users defaults show - Shows the current default values for a
[-category <path>] [-report brief|normal|verbose ] <userList>} command
<argument>
[when <parm> <globExpr> [when ...]] [-because defaults show [-source] [<command>]
vhistory - Displays an object's version history "<message_string>"]

vhistory [-branch <branchname> -descendants <n> | access filter - Specify criteria for allowing or denying access defaults state - Returns the state of the command defaults
system
-lastversions <n> -lastbranches <n> | -all] access filter <actionList> [when <parm> <globExpr> [when
...]] <script> defaults state

[-[no]selected] [-[no]recursive]

[-report <mode>] [-format list | text]

hcm Example - How to use the legacy commands (legacy) hcm rmconf - Removes a legacy configuration from a server [-report {normal | brief | summary | script}]
hcm add - Another name for the add command. (legacy)
hcm upgrade - Upgrades a DesignSync vault to a legacy
hcm addbackref - Another name for the addbackref command. hcm rmconf -target <configuration_url> module (legacy)
[-notes]
hcm upgrade -target <DesignSyncVault_url>
hcm lock - Another name for the lock command. hcm rmhref - Removes a hierarchical reference between
hcm version - Displays the DesignSync installation version
hcm lock - Another name for the lock command. modules (legacy)
hcm version
hcm migratetag - Another name for the migratetag command. hcm rmhref [-fromtarget <uppermod_url>]
localversion delete - Deletes a saved version of the given
hcm mkedge - Another name for the mkedge command. [-totarget <submod_url>] collection
hcm mvmember - Another name for the mvmember
command. [-relpath <relative_path>] localversion delete <sync collection>|<sgc collection>
<locint>
hcm rmlogin - Removes a login stored on a server
localversion list - Lists saved versions of collection objects
hcm remove - Another name for the remove command. hcm rmlogin -fromtarget <origin_server_url>
localversion list <sync collection>|<sgc
hcm rmedge - Another name for the rmedge command. -fromuser <origin_server_username> | -fromallusers collection>|<directory>
-totarget <referenced_server_url> | -toalltargets
localversion restore- Restores a saved version of the given
hcm rollback - Another name for the rollback command. hcm rmmod - Removes a legacy module and its configurations collection

hcm whereused - Another name for the whereused command. from a server (legacy) localversion restore <sync collection>|<sgc collection>
<locint>
hcm addhref - Creates a hierarchical reference between legacy hcm rmmod -target <module_url> [-vaultdata] [-notes]
module configurations (legacy) hcm showconfs - Displays module configurations (legacy) localversion save - Saves local version of the given collection

hcm addhref -fromtarget <uppermod_url> hcm showconfs [-target <module_url> | -path <path>] localversion save <sync collection>|<sgc collection>
-totarget <submod_url>
[-relpath <relative_path>] [-directoryrecursive] [-report {normal | script}] mirror create - Creates a mirror

hcm addlogin - Stores a server login to enable hierarchical hcm showhrefs - Displays the hierarchy of a module mirror create [-selector <selector_list>] [-category
queries (legacy) configuration (legacy) <category>]

hcm addlogin -fromtarget <origin_server_url> hcm showhrefs [-target <configuration_url> | -path <path>] [-hrefmode<static|dynamic|normal>]
-fromuser <origin_server_username> | -fromallusers
-totarget <referenced_server_url> | -toalltargets [-report {normal | script | brief | command}] [-notify<email_list>] [-[no]recursive]
-touser <referenced_server_username>
[-recursive] [-type normal|primary|secondary] [-RSuser <user>]
hcm doc - Displays HCM Help in a web browser
hcm showlogins - Displays the logins stored on a server [-MASuser <user>] [-PMASuser <user>]
hcm doc
[-primaryserver <serverURL>] [-description <description>]
hcm get - Fetches a legacy module configuration into your
work area (legacy) hcm showlogins -fromtarget <origin_server_url>

hcm get [-recursive] [-target <configuration_url>] [-[no]enable] [-parentname <parent_mirror>]
[-path <path>] [-incremental | full]
[-replace | -noreplace | -force] [ -fromuser <origin_server_username> | -fromallusers ]
[-[no]retain] [-merge | edit] [-keys <key_mode>]
[-mcachemode <mcache_mode>] [-mcachepaths <path_list>] <serverURL> -name <name> <-mirrordir <mirrorDir>>

hcm mkmod - Creates an HCM module on a server (legacy) [ -report {normal | script | command} ]

hcm mkmod -target <module_url> -vaultURL <vaultURL>
[-description <description>]
hcm showmcache - Lists the releases in module caches (legacy) mirror delete - Deletes a mirror
hcm showmcache [-mcachepaths <path_list>]

mirror delete <serverURL> -name <name> [-force]

[-report {normal | script}] mirror disable - Disables a mirror

hcm showmods - Displays the modules available on a server mirror disable <serverURL> -name <name> | -all

hcm showmods -target <server_url> [-report {normal | mirror edit - Modifies mirror parameters
script}]

hcm showstatus - Displays the status of a configuration in your mirror edit [-mirrordir <mirrorDir>] [-vaultURL <vaultURL>]
work area
[-selector <selector_list>] [-category <category>]

hcm showstatus [-files] [-notify <email_list>] [-[no]recursive]

[-path <path>] [-type normal|primary|secondary] [-RSuser <user>]

[-recursive] [-MASuser <user>] [-PMASuser <user>]

[-releases]

[-primaryserver <serverURL>] [-description <description>] [-status good|warning|failure|unknown|none|any] note counts - Computes statistics about notes and the
[-format text|list] frequency of values
[-hrefmode <static|dynamic|normal>] <serverURL> -name
<name> mw dependency - Specifies or displays Milkyway view note counts <NotetypeName>
dependencies [-countlinks]
mirror enable - Enables a specified mirror [ [-dbquery <dbase_expr>] |
mw dependency <viewname> [-dependson <viewnames>] [-sqlquery <sql_expr>] ]
mirror enable <serverURL> -name name | -disabled | -all [-dateresolution <Resolution>]
mw doc - Displays the DS MW Help in a web browser [<OutVarName> [Dimension0 [Dimension1
mirror get - Returns all parameters for specified mirror [Dimension2]]]]
mw doc
mirror get <serverURL> -name <name> [-format text|list] note create - Creates a new note
mw export - Export data from a Milkyway library
mirror getoptions - Gets mirror options on a server note create -type <type_name> [-id <id>] [-date <date>]
mw export [-comment "<text>"] [{<name> <value>} [...]]
mirror getoptions <serverURL> [-format text|list] [-refs -other -techfile [-tfname <file>] | -all]
[-modulecontext <context>] <library path> note delete - Deletes a note and associated notelinks
mirror isenabled - Tests whether a mirror is enabled
Where:
mirror isenabled <serverURL> -name <name>

mirror ismirror - Tests whether a name is valid for a defined
mirror

mirror ismirror <serverURL> -name <name> <library path> is the path to your library. note delete <NoteURL>

mirror list - Returns a list of all mirrors from a server mw import - Import data into a Milkyway library note detach - Deletes the link between a note and an object

mirror list <serverURL> [-enabled|disabled|all] mw import [-refs -other -techfile | -all] [-vault] note detach <NoteURL> <ObjURL>

[-category <category_pattern>] [-format text|list] [-modulecontext <context>] <library path> note getprop - Retrieves a property of a note

[-name <name_pattern>] Where: note getprop <NoteURL> <PropertyName>

mirror rename - Changes the mirror name <library path> is the path to your library. note links - Returns the set of links for a note

mirror rename <serverURL> -name <name> -newname <newname> mw rebuildlib - Rebuilds a Milkyway library note links [-object <objURL> | -note <noteURL>] [-pairs] [-
norec]
mirror reset - Populates the mirror's directory, leaving it in the mw rebuildlib <library_path>
same state as if the mirror had been removed and then note query - Queries the note system and returns note URLs
repopulated and values

mirror reset <serverURL> -name <name> Where: note query [-type <notetype>] [-filter ViewNote | EditNote]
<library path> is the path to your library. [[-attached <ObjUrl> [-norec]]
mirror setoptions - Sets general mirror options

mirror setoptions <serverURL> [-defaultuser <user>] mw setuplib - Initialize a Milkyway library for data management [[-dbquery <dbase_expr>] | [-sqlquery <sql_expr>]]

[-commonnotifylist<email_list>] [-noenforceSUID] mw setuplib [-vault <vaultURL> | -modulecontext <context>] [-select <PropertyList>] [--]
[-[no]enforcedefaultuser] [-disableRS | -enableRS] [-tfname <file>] [-norefs] [-notech] [-noother]
[-disableMAS | -enableMAS] [-name <name>] [-comment "<text>"] note relink - Moves note attachments from one object to
another

[-warnifstale <time>] <library path> note relink <FromObjURL> <ToObjURL> [-norec]

mirror status - Returns the status for the mirror Where: note schema - Extracts information about a note type's
<library path> is the path to your library, which must structure
mirror status <serverURL> [-format text|list] [-servertype note setprops - Sets property values on a note
RS|MAS]

[-name <name>] already exist in note setprops [--] <note_url> <propname> <propvalue>

mirror wheremirrored- Shows where vault data is mirrored. your workspace, but may be an empty folder. [<propname> <propvalue>]...

mirror wheremirrored <vaultURL> [-selector <selector_list>] mw version - Displays the DesignSync and the DS MW version note setprops [--] <note_url> <proplist>

[-category <category>] mw version note systems - Gets a list of note systems
[-type normal|primary|secondary|all]
note attach - Creates a link between a note and an object note systems

[-name <name>] note attach <noteURL> <objURL>

note types - Gets a list of defined note types for all note <branchname> [<argument> ...] sregistry keys - Displays sub-keys in registry value
systems
parray auto_index - Lists the autoloaded stcl procedures sitr mkmod - Creates and releases the initial version of the Client-side invocation:
module sregistry keys [-currentuser | -localmachine | -synch ]
parray auto_index [-user | -project | -site | -file <filename>]
sitr mkmod -top [-format text | list] <KeyPath>

sitr mkmod -name [category/]<name> | -vaultpath <url> Server-side invocation:
sregistry keys [-currentuser | -localmachine | -synch ]
Note: This command is supported only in stcl mode. [-description "<text>"] [-nomcache]] [-port | -site | -file <filename>]
[-format text | list] <KeyPath>
ptype choices - Returns the set of legal values for an sitr populate - Updates the workspace with the specified
enumerated type module version sregistry reset - Forces a refresh of all registry files
sregistry scope - Temporarily changes which registry files are
ptype choices <ptype_name> sitr populate [-config <tagname>] [-force] [-noprompt] active

ptype class - Returns the class of a property type sitr release - Creates a new module release and updates the sregistry scope [-project | -site]
baseline alias {defaults set -- <command> <option> [<option> ...]}
ptype class <ptype_name>
sitr release [-release <sitr_branch><NUM.NUM>] [- sregistry set - Sets a registry value
ptype enumerate - Returns a list of all property types description "<text>"]
sregistry set [-currentuser | -localmachine | -synch ]
ptype enumerate [-noupdate] [-noprompt] [-user | -project | -site | -file <filename>]
[-port | -site | -file <filename>]
ptype is - Tests whether a property type is of a certain class sitr select - Identifies module configurations to process. <keyPath> [-type number|string]
<value> [--] Data
ptype is <[-boolean] | [-choice] | [-date] sitr select [-clear] [-delete] [-relpath <relpath>]
| [-machine] | [-number] | [-string] [-name <href name>] [-report {normal | table | verbose}] sregistry source - Displays the source of a registry value

| [-time] | [-timestamp] [-userlist]> [<argument>...] sregistry source [-currentuser | -localmachine | -synch]
[-user | -project | -site | -file <filename>]
<PropertyTypeName> sitr status - Compares the local workspace to the specified [-port | -site | -file <filename>]
<keyPath> <value>
ptype strwidth - Returns the maximum width for strings of this configuration.
type sregistry values - Displays the available registry values
sitr status -versus <tagname>
sregistry values [-currentuser | -localmachine | -synch ]
ptype strwidth <ptype_name> sitr submit - Submits a module version for integration [-user | -project | -site | -file <filename>]
[-port | -site | -file <filename>]
ptype transitions - For the value of a state machine, returns the sitr submit [-release [<branch_>]v<NUM>[.<NUM>]] [-force] [-format text | list] <keyPath>
set of values that are legal for that value to change to
[-nointegrate] [-noprompt] [-description <description>] subscription add - Subscribes for email related to specified
objects
ptype transitions <PropertyTypeName> <-from [<argument> [...]]
<PropertyValue>> subscription add [-user user] [-noteType noteType] [-filter
sitr update - Updates a submodule workspace with the Expr]
sitr env - Displays SITaR environment variables specified module version. [-server serverURL] [-ci] [-conolock] [-colock]
[-unlock] [-tag] [-tagname TagName] object...
sitr env sitr update [-config <tag>] [-force] [-nooverwrite]

sitr integrate - Integrates selected changes into the project [-noprompt] [<argument>[ ...]]
integration workspace
sregistry delete - Delete registry key or value
sitr integrate [-force] [-nopopulate] [-report {normal |
verbose}] sregistry delete [-currentuser | -localmachine | -synch ]

[-noprompt] [-user | -project | -site | -file <filename>]
[-port | -site | -file <filename>]
sitr lookup - Displays a list of modules matching the specified <keyPath> <value>
criteria
sregistry get - Get a registry value
sitr lookup [-since <timestamp> | <release configuration>]
sregistry get [-currentuser | -localmachine | -synch]
[-report {normal | verbose | script}] [-allconfigs] [-port | -site | -file <filename>]
[-user | -project | -site | -file <filename>]
[<argument> ...]

sitr mkbranch - Creates a module branch of a SITaR module.

sitr mkbranch [-[no]populate] [-[no]integrate] [-format text | list] [-base dec | hex]

[-description <description>] <keyPath> <value> [-default <dataPath>]

subscription delete - Deletes email subscriptions for specified trigger list - Gets a list of triggers url members - Returns the members of the specified collection
objects
url members [--] <collection> [<varname> <code>]
trigger list [-enabled|disabled|all]
url mirror - Returns the URL of a local directory's mirror
subscription delete [-user user] [-noteType noteType] [- [name_expr ...]
server serverURL] url mirror [--] <directory>

subscription edit - Edits email subscriptions [-event event] url modified - Checks if an object has been modified

subscription edit [-user user] [-server serverURL] trigger status - Shows the status of triggers url modified [--] <argument>

subscription get - Gets subscription information as a Tcl list trigger status [<name_expr> ...] url naturalpath - Returns the natural path for a module
member
subscription get [-user user] [-noteType noteType] [-server trigger unblock - Depreciated command
url naturalpath [--] <argument>
serverURL] trigger unblock
url notes - Returns the notes attached to the specified object
subscription list - Lists email subscriptions url branchid - Returns the branch number of the specified
object, module or module member url notes [--] [-type <type> [-dbquery <query>]]
subscription list [-user user] [-noteType noteType] [-
server serverURL] url branchid [--] <argument> <argument>

synctrace set - Turns on software tracing url configs - Returns the configurations of a ProjectSync url owner - Returns the owner of an object
project
synctrace set [-server <serverURL>] 0 url owner [--] <argument>

synctrace unset - Turns off software tracing url configs [--] <argument> url path - Extracts the path section of a URL

synctrace unset [-server <serverURL>] 0 url container - Returns the object containing a specified object url path [--] <object>

trigger block - Prevents recursive trigger script activation url container [--] <object> url projects - Returns a SyncServer's ProjectSync projects

trigger block url contents - Returns the objects in a container object url projects <object>

trigger create - Creates or replaces a trigger url contents [-ifpopulated [-incremental] | -all] [- url properties - Returns properties for the specified object
prefetch]
trigger create <name> url properties [--] <argument> <array_name>
[-replace] [-version <selector>[,<selector>...]] [--] <argument>
[-require|exclude <name> <valueExprList> ...] url registered - Checks whether an object is under revision
[-exec <command_and_arguments> | url exists - Reports whether an object exists control
-tcl_script <script_filename> |
url exists [--] <argument> url registered [--] <argument>

url fetchedstate - Returns the fetched state of an object url relations - Determine collection object dependencies

-tcl_file <file_name> | url fetchedstate [--] <argument> url relations [--] <collection> <relation_name> [<varname>
<code>]
-tcl_store <file_name>] url fetchtime - Returns the time when an object was fetched
url resolveancestor - Returns the closest common ancestor of
trigger delete - Deletes an existing trigger url fetchtime [--] <argument> two versions

trigger delete <name> url filter - Returns the persistent filter for a workspace module

trigger disable - Prevents a trigger from firing url filter [-help | -usage | -?] [-hreffilter | -filter]

trigger disable <name> [--] <argument> url resolveancestor [-noedges] -version
<selector>[,<selector>...]
trigger enable - Makes a disabled trigger active again url getprop - Retrieves a property of an object
[--] <argument>
trigger enable <name> url getprop [--] <argument> <propertyName>
url resolvetag - Returns the version number associated with a
trigger isEnabled - Determines whether or not a trigger is url inconflict - Checks if a file merge had conflicts selector
enabled
url inconflict [--] <argument> url resolvetag [-version <selector>[,<selector>...]] [--]
trigger isEnabled <name>
url leaf - Returns the leaf of the URL <argument>
trigger fire - Executes a trigger
url leaf [--] <argument> url retired - Returns whether a branch is retired
trigger fire <name> <event>
url locktime - Returns when a branch was locked url retired [--] <argument>
trigger get - Gets information about a trigger
url locktime [--] <argument>

trigger get <name>

url rmprop - Removes specified properties for a module object user create - Creates a new user id with the specified profile
from the local metadata.

user create <userid> <{Name Value Name Value...}>

url rmprop <argument> <property> user delete - Deletes the specified user ID and corresponding
profile
url root - Returns the workspace root for a given path

url root [--] <path> user delete <username>

url selector - Returns an object's persistent selector list V6R2011. Copyright 1997-2010 Dasault Systemes. All rights
reserved.
url selector [--] <argument>

url servers - Returns server-list definitions

url servers [-urls* | -enterprise | -site | -user | -all]

url setprop - Sets a property on an object

url setprop [--] <Object_url> <prop_name> <prop_value>

url syslock - Sets a system lock on a lock name or file path

url syslock -acquire <name_or_path> [-canonize] [-
shared]

[-timeout secs]

url syslock -yield <name_or_path> [-canonize] [-
shared]

[-timeout secs] [-all]

url syslock -release <name_or_path> [-canonize]

url syslock -realmount <name_or_path>

url syslock -realpath <name_or_path>

url syslock -showlocks

Note: The <name_or_path> argument must follow the

-acquire/-yield/-release/-realmount/-realpath option.

url tags - Returns the version tags associated with a specified
object

url tags [-version <selector>] [--] <argument>

url users - Returns all users defined for an object's server

url users <object>

url vault - Returns the URL of an object's vault

url vault [-modulecontext <context>] <argument>

url versionid - Returns the version number of the specified
object

url versionid [--] <argument>

url versions - Returns the URLs of an object's versions

url versions <argument>

user counts - Counts the number of user records

user counts