Command Line Commands and Parameters
The following is a list and general description of all the command-line commands.
|
Command |
Description |
| About | Displays the version information. |
| AddFile | Adds one or multiple files to a project. The path of the file on the local
machine is specified by the -workdir parameter. Required Params: -server, -port, -username, -pwd, -alias, -prj, -file,-workdir Optional Params: -tempdir, -comment, -auto or -text or -bin,-zoneoff, -notreadonly, -ptype, -pserver, -pport, -puser, -ppwd, -nozip, -nodelta, -windows, -unix, -mac |
| AddFolder | Adds an entire local folder to the database. The path of the
local folder on the local machine is specified by the -workdir parameter.
Use -r to add the folder recursively. Required Params: -server, -port, -username, -pwd, -alias, -prj, -workdir Optional Params: -nozip, -nodelta, -tempdir, -comment, -r, -auto or -text or -bin,-zoneoff, -notreadonly, -ptype, -pserver, -pport, -puser, -ppwd, -windows, -unix, -mac |
| AddLabel | Adds a label to a project or a file. Required Params: -server, -port, -username, -pwd, -alias, -prj, -label Optional Params: -comment, -file, -ptype, -pserver, -pport, -puser, -ppwd |
| BranchFile | Breaks the share link and the changes made
to that file will no longer be reflected in other projects. Required Params: -server, -port, -username, -pwd, -alias, -prj, -file Optional Params: -comment, -ptype, -pserver, -pport, -puser, -ppwd |
| CreateProject | Creates an empty project in the VSS database whose full name
is specified by the -prj parameter. Required Params: -server, -port, -username, -pwd, -alias, -prj Optional Params: -comment, -ptype, -pserver, -pport, -puser, -ppwd |
| CheckInFile | Checks in one or multiple files. Required Params: -server, -port, -username, -pwd, -alias, -prj, -file Optional Params: -workdir, -tempdir, -comment,-keep,-windows or -unix or -mac,- checkin or -ask or -undo, -del, -zoneoff, -notreadonly, -ptype, -pserver, -pport, -puser, -ppwd, -nozip, -nodelta |
| CheckInProject | Checks in an entire project. Use -r to check in the project
recursively. Required Params: -server, -port, -username, -pwd, -alias, -prj Optional Params: -workdir, -tempdir, -r, -comment,-del, -windows or -unix or -mac, -keep, -checkin or -ask or -undo, -zoneoff, -notreadonly, -ptype, -pserver, -pport, -puser, -ppwd, -nozip, -nodelta |
| CheckOutFile | Checks out one or multiple files. This command also makes the
local files writable. Required Params: -server, -port, -username, -pwd, -alias, -prj, -file Optional Params: -workdir, -tempdir, -ask or -skip or -replace,-windows or -unix or -mac,-time, -zoneoff, -ptype, -pserver, -pport, -puser, -ppwd, -nozip, -nodelta, -comment |
| CheckOutProject | Checks out an entire project. This command also makes the
local files in the project writable. Use -r to checkout a project
recursively. Required Params: -server, -port, -username, -pwd, -alias, -prj Optional Params: -workdir, -tempdir, -r ,-ask or -skip or -replace,-windows or -unix or -mac,-time,-zoneoff, -ptype, -pserver, -pport, -puser, -ppwd, -nozip, -nodelta, -comment |
| Delete | Deletes a file or project. If the -permanent flag is set, it
will delete the file or project permanently from the database so it cannot
be recovered. Required Params: -server, -port, -username, -pwd, -alias, -prj Optional Params: -file, -permanent, -ptype, -pserver, -pport, -puser, -ppwd |
| Dir | Displays all projects and files under a project. Use -r to
see about a project recursively. Required Params: -prj Optinal Params: -r, -zoneoff |
| GetDatabases | Lists all databases accessible by the input server. Required Params: -server, -port Optional Params: -ptype, -pserver, -pport, -puser, -ppwd |
| GetFile | Gets one or multiple files from the SourceSafe database. It
will get the latest version of files unless the -rev or -label parameter is used
to specify a certain file. Required Params: -server, -port, -username, -pwd, -alias, -prj, -file Optional Params: -workdir, -tempdir, -rev, -label,-writable, -ask or -skip or -replace,-time,-windows or -unix or -mac, -zoneoff, -ptype, -pserver, -pport, -puser, -ppwd, -nozip, -nodelta |
| GetFileHistory | Gets the revision history of the file. Required Params: -server, -port, -username, -pwd, -alias, -prj, -file Optional Params: -user, -datetime, -zoneoff, -ptype, -pserver, -pport, -puser, -ppwd |
| GetFileInfo | Gets current information about a file.
Required Params: -server, -port, -username, -pwd, -alias, -prj, -file Optional Params : -zoneoff, -ptype, -pserver, -pport, -puser, -ppwd |
| GetFileList | Gets a list of all files in the input project. This command
outputs the name, version and date of each file. Required Params: -server, -port, -username, -pwd, -alias, -prj Optional Params: -zoneoff, -ptype, -pserver, -pport, -puser, -ppwd |
| GetProject | Gets all of the files in a project. It will get the latest
version of the files in a project unless the -label or -datetime parameter
is used to specify a previous version of a project. Use -r to get the
project recursively.
Required Params: -server, -port, -username, -pwd, -alias, -prj |
| GetProjectHistory | Displays project history in Command Line Client. Required params: -prj Optional params: -r,-user, -datatime, -zoneoff, -includefilehistory |
| GetProjectTree | This command returns
the structure of the project in the VSS database. Please note that this
command does not retrieve the files in the project.
Required Params: -server, -port, -username, -pwd, -alias, -prj |
| Interactive | Puts the Client in an interactive shell, where you can enter
commands one after the other, without having to re-run the Command Line
Client each time. Type 'quit' when you want to quit interactive shell. Required Params: -server, -port, -username, -pwd, -alias Optional Params : -tempdir, -ptype, -pserver, -pport, -puser, -ppwd |
| Rename | Renames a file or project in the VSS database. Required Params: -server, -port, -username, -pwd, -alias, -prj, -newname Optional Params: -file, -ptype, -pserver, -pport, -puser, -ppwd |
| ShareFile | Shares the current version of one or multiple files to
another project. Updates to a shared file will be reflected in all the
projects to which the file is shared. Required Params: -server, -port, -username, -pwd, -alias, -prj, -file, -shareto Optional Params: -branch, -ptype, -pserver, -pport, -puser, -ppwd |
| ShareProject | Shares the current version of a project to another project.
Updates to files in a shared project will be reflected in all the projects
to which the project is shared. Required Params: -server, -port, -username, -pwd, -alias, -prj, -shareto Optional Params: -branch, -r, -comment, -ptype, -pserver, -pport, -puser, -ppwd |
| UndoCheckOutProject | Cancels the checkout of a project and revert to the state
before the Check Out operation was performed. Use -r to undo checkout of the
project recursively. Required Params: -server, -port, -username, -pwd, -alias, -prj Optional Params: -workdir, -tempdir, -r,-windows or -unix or -mac,-time, -leave or -replace or -del,-zoneoff, -notreadonly, -ptype, -pserver, -pport, -puser, -ppwd, -nozip, -nodelta |
| UndoCheckOutFile | Cancels the checkout of one or multiple files and revert to
the state before the Check Out operation was performed. Required Params: -server, -port, -username, -pwd, -alias, -prj, -file Optional Params: -workdir, -tempdir, -windows or -unix or -mac, -time, -leave or -replace or -del, -zoneoff, -notreadonly, -ptype, -pserver, -pport, -puser, -ppwd, -nozip, -nodelta |
The following is a list and description of parameters accepted by Dynamsoft SAW for VSS Command Line. It is necessary to enter full parameter names. If you want to cancel current operation, type 'c' (for Java Command Line, you need to press Enter after 'c').
Note: Please put a space between a parameter and the value it acts on.
|
Parameter |
Description |
| -alias | The alias that Dynamsoft SAW for VSS Server has defined to point to a SourceSafe database. This name is specified under the Databases section of the Dynamsoft SAW for VSS Server Manager. |
| -ask | Used with GetFile, GetProject, CheckOutFile, CheckOutProject, CheckInFile and CheckInProject. If present, will ask whether to perform skip or replace or cancel operation. |
| -auto | Auto detect file type. |
| -bin | Binary file type. |
| -branch | Used with the ShareFile and ShareProject commands. If present, will perform a branch operation immediately after the share. |
| -checkin | Check in the file. |
| -comment | Text used for comments. |
| -datetime | Used with the GetFileHistory or
GetProject command. When used with GetFileHistory: A list of valid date, only required two value, the formats is "datefrom|dateto", the first is date from, the second is date to. If -datetime is not present, query the data from current time to one year ago. When used with
GetProject: only required one value. "Jun/16/2005", "Jun/16/2005 6:10:00", "6/16/2005", "6/16/2005 6:10:00". (for Java Command Line) |
| -del | Deletes local copy. |
| -file | A "/" separated list of valid Dynamsoft SAW for VSS files in the project specified by the -prj parameter. |
| -h /-? | Help. |
| -includefilehistory | Used with ShowingProjectHistory. If present, will show file history together with project history. |
| -keep | Used with CheckInFile and CheckInProject. If present, will keep checkout status after the checkin. |
| -label | A label that can be associated with a particular project version or a file version. |
| -leave | Leaves local copy. |
| -mac | Mac EOL. |
| -newname | Used with the Rename command. The new name of a project or file that is being renamed. |
| -nodelta | Turns off delta transfer. By default, the Command Line Client will use delta transfer for all data transfers. |
| -notreadonly | Used with CheckInProject, CheckInFile, UndoCheckOutProject, UndoCheckOutFile, AddFile and AddFolder. If present, will not change the file attribute. If not present ,will make file read-only. |
| -nozip | Turns off compression. By default, the Command Line Client will use compression for all data transfers. |
| -permanent | Used with the Delete command. Permanently deletes a file or project from the database. |
| -port | The port of a running Dynamsoft SAW for VSS server. |
| -pport | The port of the proxy server. |
| -ppwd | The password corresponding to the user name specified by the -puser parameter. See also -puser. |
| -prj | A valid Dynamsoft SAW for VSS project in the database. |
| -pserver | The domain name or IP address of the proxy server. If ptype = "None", this parameter is invalid and not required. |
| -ptype | The proxy type. Valid ptype parameters are "None", "Http", "Socks4" and "Socks5", the default value is "None". |
| -puser | The user name used for connecting the proxy Server. If ptype = "None" or "Socks4", the parameter is invalid and not required. |
| -pwd | The password corresponding to the user name specified by the -username parameter. |
| -r | If present, the project level command will be performed recursively. |
| -replace | Replace local copy or replace writable file. |
| -rev | A version number of the file specified. |
| -skip | Skip the local copy. |
| -server | The domain name or IP address of a running Dynamsoft SAW for VSS server. |
| -shareto | Used with the ShareFile and ShareProject commands. The project into which a file or project will be shared. |
| -tempdir | Set the local temporary directory. The default temporary directory is the Dynamsoft SAW for VSS temporary directory specified in the ServerInfo->General Settings section of the Dynamsoft SAW for VSS Server Manager (for Java Command Line, the default temporary directory is the system temporary directory). |
| -text | Text file type. |
| -time | Valid time parameters are "modi", "checkin"
and "current". If -time is not present, the current time is used. modi - Specifies that the file's last modified date/time stamp will be the file's modification time as set in the SourceSafe database. current - Specifies that the current time will be used. checkin- Specifies that the checked in time will be used. Examples: -time modi or -time current or -time checkin. |
| -undo | Undo checking out. |
| -unix | Unix EOL. |
| -user | Used with GetFileHistory. If not specified, the history of all uses is returned. |
| -username | The user name used for logging into the Dynamsoft SAW for VSS Server. |
| -verb | If present, outputs verbose status messages, such as connections, server responses, etc. |
| -windows | Windows EOL. |
| -writable | Used with GetFile and GetProject. If present, will make the files writable. |
| -workdir | The working directory where the Command Line Client places a Dynamsoft SAW for VSS file or project. The default working directory is the Dynamsoft SAW for VSS Command Line directory. This parameter is also used to specify where on the local machine the Command Line Client looks for a file or project to add or check in to the database. The local working directory should be an absolute path. |
| -zoneoff | Set the offset of server time zone to local time zone, the default is zero. The value is between -24 and +24. |