5.7 Suffix Slots

Here we document most of the slots that are only available for suffix objects. Some slots are shared by suffix and group objects, they are documented in Predicate Slots.

Also see Suffix Classes.

5.7.1 Slots of transient-suffix

• key The key, a key vector or a key description string.
• command The command, a symbol.
• transient Whether to stay transient. See Transient State.
• format The format used to display the suffix in the popup buffer. It must contain the following %-placeholders:
  • %k For the key.
  • %d For the description.
  • %v For the infix value. Non-infix suffixes don’t have a value.
• description The description, either a string or a function that is called with no argument and returns a string.

5.7.2 Slots of transient-infix

Some of these slots are only meaningful for some of the subclasses. They are defined here anyway to allow sharing certain methods.

• argument The long argument, e.g. --verbose.
• shortarg The short argument, e.g. -v.
• value The value. Should not be accessed directly.
• init-value Function that is responsable for setting the object’s value. If bound, then this is called with the object as the only argument. Usually this is not bound, in which case the object’s primary transient-init-value method is called instead.
• unsavable Whether the value of the suffix is not saved as part of the prefixes.
• multi-value For options, whether the option can have multiple values. If non-nil, then default to use completing-read-multiple.
• always-read For options, whether to read a value on every invocation. If this is nil, then options that have a value are simply unset and have to be invoked a second time to set a new value.
• allow-empty For options, whether the empty string is a valid value.
• history-key The key used to store the history. This defaults to the command name. This is useful when multiple infixes should share the same history because their values are of the same kind.
• reader The function used to read the value of an infix. Not used for switches. The function takes three arguments, PROMPT, INITIAL-INPUT and HISTORY, and must return a string.
• prompt The prompt used when reading the value, either a string or a function that takes the object as the only argument and which returns a prompt string.
• choices A list of valid values. How exactly that is used depends on the class of the object.

5.7.3 Slots of transient-variable

• variable The variable.

5.7.4 Slots of transient-switches

• argument-format The display format. Must contain %s, one of the choices is substituted for that. E.g. --%s-order.
• argument-regexp The regexp used to match any one of the switches. E.g. \\(--\\(topo\\|author-date\\|date\\)-order\\).