Inherits from NSObject
Declared in ExMap.h

Overview

A definition of an ex command.

Tasks

  •   name

    The primary name of this command.

    property
  •   names

    All names and aliases of this command.

    property
  •   syntax

    Syntax string describing the format and arguments of the command.

    property

Properties

name

The primary name of this command.

@property (nonatomic, readonly) NSString *name

Declared In

ExMap.h

names

All names and aliases of this command.

@property (nonatomic, readonly) NSArray *names

Declared In

ExMap.h

syntax

Syntax string describing the format and arguments of the command.

@property (nonatomic, readonly) NSString *syntax

Discussion

The syntax string consists of the following characters:

  • ! — allow ! directly after command name
  • r — allow range
  • % — default to whole file if no range
  • + — allow “+command” argument
  • c — allow count > 0
  • e — allow extra argument(s)
  • E — require extra argument(s)
  • 1 — only one extra argument allowed
  • x — expand wildcards and filename meta chars (‘%’ and ‘#’) in extra arguments
  • R — allow register
  • l — allow an optional line argument
  • L — require a line argument
  • ~ — allow /regexp/replace/flags argument
  • / — allow /regexp/flags argument
  • | (bar) — do NOT end command with a trailing bar
  • m — command modifies document

Declared In

ExMap.h