group

group — groups a number of logs or groups together.

Syntax

(group newlabel [existing ...])
    

Arguments

newlabel

A label for the new group.

existing

One or more log command labels for existing logs, or one or more group command labels for existing groups.

Returns

On success, t, otherwise one of the following error messages:

(error "textlog: Group newlabel already exists")
(error "textlog: Group or log existing does not exist")
(error "textlog: Too few arguments to group: # < #")
(error "textlog: Invalid command: group")

or, if none of the above errors apply, nil.

Description

The group command lets you group any number of logs or groups. This allows you to give commands that refer to several logs at the same time, because a command specifying the label of a group will be applied to all the logs in that group or its sub-groups.

Groups can be made recursively (ie. groups of groups). Each group must contain either groups or logs, but not both; you are not permitted to have a group consisting of groups and single logs.

This command corresponds to the Cogent C API function LG_Group.

See Also

log

Example

(group vat20 temp20 press20)
(group vat21 temp21 press21)
(group limits max_ht min_ht)
(group all vat20 vat21 limits)