encase(3)

NAME

encase - Encase a region with start/end string

SYNOPSIS

n encase "start-string" "end-string"

DESCRIPTION

encase provides a short cut to encapsulate a selected region of text with a start-string and end-string. The command is modal and operates in two different operating modes as follows.

First run encase without a current region section (i.e. no selected highlighted text) and the user is prompted for the start-string and end-string. The user is also prompted if the command has not been run before and the start-string and end-string are undefined.

With the strings defined then select a region with the mouse or keyboard (esc space and move or S-move) to define the start and end point of the region. With a selected region then execute the encase command using esc x encase. This is most effective when bound to a simple key, see global-bind-key(2).

The numeric argument n is used to modify the default behavior of the command, where the bits are defined as follows:

0x01


When set the start and end location is determined by the position in the buffer, the start being first in the buffer. When this bit is clear the start position in always the start of the region regardless of where it is in the buffer. When defining the start and end strings, i.e. no region is defined or bit 4 is set, the value of this bit is used as a default for subsequent calls when no argument is given.

0x02


When set the current mark and cursor positions are used as the start and end position rather than the current region, this removes the need for a current region.

0x04


The start and end strings are always prompted for when this bit is set.

NOTES

encase is a macro defined in misc.emf.

SEE ALSO

global-bind-key(2).

(c) Copyright JASSPA 2025
Last Modified: 2025/08/31
Generated On: 2025/09/29