Syntax Conventions¶
The following notation is used in VisionByte command syntax.
Notation |
Meaning |
Syntax |
Example |
|---|---|---|---|
literal |
Must appear exactly as shown. |
|
|
[OPTIONS] |
Optional flags or parameters. |
|
|
[-a|-b] |
Either option may be used; at most one is allowed, and both may be omitted. |
|
|
{-a|-b} |
Exactly one of the enclosed elements is required. Do not type the braces. |
|
|
… |
The preceding element can be repeated. |
|
|
Common Parameter Meanings¶
The following placeholders appear frequently in command syntax. Examples show typical values.
Parameter |
Meaning |
Example |
|---|---|---|
|
File name or path. |
|
|
Identifier of a check-in, such as a branch name, tag, or unique hash prefix. |
|
|
Name of an object such as a setting, user, branch, or alias. |
|
|
Repository file name or path. In the global registry context, a repository name. |
|
|
Subcommand that selects a specific action. |
|
|
Timestamp. Supported forms: “now” or “YYYY-MM-DDTHH:MM:SS.SSS”; “T” may be a space; optional timezone offset. |
|
|
Glob or LIKE pattern used for matching names. |
|
|
Symbolic tag name applied to a check-in or artifact. |
|
|
Comma-separated list of glob patterns (Comma Separated Glob). |
|
|
Comma-separated list of glob patterns. |
|
|
Hex digest of the corresponding hash algorithm; used for checksums or artifact identifiers. |
|
|
Identifier of a stash entry (see |
|
|
Configuration area name (for example: all, email, interwiki, project, shun, skin, ticket, user, alias, subscriber). |
|
|
Artifact hash identifier. |
|
|
Hash value, typically an artifact or check-in hash prefix. |
|
|
External command to execute (optionally with arguments). |
|
|
Name of a configuration setting. |
|
|
Free-form comment text (for example, a check-in or stash comment). |
|
|
Technote identifier (artifact hash). |
|