# encase(3)

[Home] [Commands] [Variables] [Macro-Dev] [Glossary]

## NAME

encase - Encase a text region with start/end string

## SYNOPSIS

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 pattern. 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).

## NOTES

encase is a macro defined in `misc.emf`.

## SEE ALSO

global-bind-key(2).

(c) Copyright JASSPA 2009
Last Modified: 2009/09/03
Generated On: 2009/10/12

</HMTL>