lsfolder

Lists information about folders

Applicability

Product

Command type

VersionVault

cleartool subcommand

Platform

UNIX

Linux

Windows

Synopsis

lsfolder [ –s/hort | –l/ong | –fmt format-string
| –tre/e [ –fmt format-string ] [ –dep/th depth ]

| –anc/estor [ –fmt format-string ] [ –dep/th depth ] ] [ –obs/olete ]

[ –inv/ob vob-selector | –in folder-selector [ –r/ecurse ] | –vie/w view-tag | –cvi/ew

| folder-selector ...]

Description

The lsfolder command displays information that describes one or more folders.

Restrictions

None.

Options and arguments

Choosing a display format

Default
A one-line summary.
–s/hort
Displays only the the name of each folder.
–l/ong
Displays a detailed listing for a folder.
–fmt format-string
Displays information in the specified format. For more information, see the fmt_ccase reference page.
–tre/e [ –fmt format-string ] [ –dep/th depth ]
Displays information about a folder and its contents. Default output format is similar to that of the lsvtree command.

The –fmt option displays information in the format specified by the format-string argument. For more information, see the fmt_ccase reference page.

The –depth option lists the hierarchy of objects to the level specified by the depth argument. The depth argument must be a positive integer.

–anc/estor [ –fmt format-string ] [ –dep/th depth ]
Displays information about a folder and any parent folders.

The –fmt option formats information using the specified format-string. For more information, see the fmt_ccase reference page.

The –depth option specifies how many levels to display. The depth argument must be a positive integer: a value of zero lists the entire hierarchy.

Specifying a folder

Default
All folders in the project VOB of the current directory.
–inv/ob vob-selector
Displays a list of folders in the specified project VOB.
–in folder-selector ... [ –r/ecurse ]
Displays a list of subfolders of the specified folder or folders. With –r/ecurse, lists the contents of all subfolders.
–vie/w view-tag
Displays information about the parent folder of the stream attached to the specified view.
–cvi/ew
Displays information about the parent folder of the stream attached to the current view.
folder-selector ...
Specifies one or more folders to list.

Listing obsolete folders

Default
Lists only nonobsolete folders.
–obs/olete
Includes obsolete folders in the listing. Obsolete folders are those that have been processed with lock –obsolete

Examples

The UNIX system and Linux examples in this section are written for use in csh. If you use another shell, you might need to use different quoting and escaping conventions.

The Windows examples that include wildcards or quoting are written for use in cleartool interactive mode. If you use cleartool single-command mode, you might need to change the wildcards and quoting to make your command interpreter process the command appropriately.

In cleartool single-command mode, cmd-context represents the UNIX system and Linux shells or Windows command interpreter prompt, followed by the cleartool command. In cleartool interactive mode, cmd-context represents the interactive cleartool prompt.

  • Display a one-line summary of the specified folder.

    cmd-context lsfolder Core_Parsers@/vobs_core_projects
    2007-09-17T11:21:36  Core_Parsers  bill   "Core_Parsers"

  • Display a long listing for the specified folder.

    cmd-context  lsfolder -long RootFolder@/vobs_core_projects
    folder "RootFolder"
    2007-09-17T10:52:34 by Bill Marrs (bill.user@propane)
      "Predefined Root folder."
      owner: bill
      group: user
      title: Root folder
      contains folders:
        Parsers
        Core_Parsers
      contains projects:
        Java_Parser