io7m | single-page | multi-page | epub | Cardant User Manual 1.0.0-beta0001
7.2.50. syntax-list
Previous
7.2. Shell Command Reference
Up
7.2.52. type-package-get-text
Next

# 7.2.51. syntax-show

- 7.2.51.1. Name
- 7.2.51.2. Description
- 7.2.51.3. Examples
- 7.2.51.4. Parameters

## 7.2.51.1. Name

1
syntax-show - Show the given syntax definition.

## 7.2.51.2. Description

1
The syntax-show command displays definitions and/or examples for the given syntax rule.

## 7.2.51.3. Examples

### 7.2.51.3.1. Example

    [cardant]$ syntax-show --rule metadata-type-match
    metadata-type-match :=
      metadata-type-any
      | metadata-type-equal-to
      | metadata-type-not-equal-to
    metadata-type-any :=
      with-any-type
    metadata-type-equal-to :=
      (with-type-equal-to <type>)
    metadata-type-not-equal-to :=
      (with-type-not-equal-to <type>)

    [cardant]$ syntax-show --rule metadata-type-match --example true
    [with-type-equal-to "com.io7m:t"]

    [with-type-not-equal-to "com.io7m:t"]

## 7.2.51.4. Parameters

### 7.2.51.4.1. --example

Attribute | Value
--- | ---
Name | --example
Type | java.lang.Boolean
Default Value | false
Cardinality | [1, 1]
Description | Show a syntax example.

### 7.2.51.4.2. --rule

Attribute | Value
--- | ---
Name | --rule
Type | java.lang.String
Default Value |
Cardinality | [1, 1]
Description | The syntax rule name.

7.2.50. syntax-list
Previous
7.2. Shell Command Reference
Up
7.2.52. type-package-get-text
Next
io7m | single-page | multi-page | epub | Cardant User Manual 1.0.0-beta0001