Show TOC

WORKSPACESLocate this document in the navigation structure

Use

Lists all available workspaces or workspaces on the server. When the -F option is specified, the workspace folders are listed. Without the -F option, the workspaces are listed.

Syntax

Syntax

WORKSPACES [-f] [-F] [[-s] [-d]] [-uf]

Arguments

[-F]

Specifies that workspace folders have to be listed.

[-f]

Using this option you can specify the properties of the workspace (folder) that have to be displayed.

The fields that can be specified are:

  • DisplayName (DN)

    Gives the display name of the workspace.

  • LocalPath (LP)

    Absolute local path of the workspace.

  • RemotePath (RP)

    Absolute remote path of the workspace.

  • BrowsePath (BP)

    Browse path of the workspace.

  • Description (Des)

    Description associated with the workspace.

  • All

    Prints all the above fields.

[-s]

Using this option you can specify the field on whose basis the output is sorted. The fields that can be specified are the ones listed above. Sorting is in ascending order by default.

[-d]

Sorts the output in descending order.

[-uf]

If this is specified, then the field values will not be truncated to fit into a given space. However, this may lead to output that is not easy to read. It is recommended that this is used only for scripting.

Description

Lists the available workspaces (workspace folders).
Example

Listing All Workspaces

To list all workspaces available on the server, execute:

workspaces

Listing All Workspace Folders

To list all workspace folders available on the server, execute:

workspaces -F