format(1)

NAME
Format a region (paragraph or C comment block)

DESCRIPTION
This macro is used to reformat a hilighted region in the current buffer. The effect of the reformat is dependent on the file extension. There are two types of formats supported: C style comments. This macro knows how to format comments which are used at the head of a function and also how to format comments which are a part of the code. Normal text paragraphs.

Formatting a C style comment involves first removing any comment box around the existing comments, reformatting the text of the comment as if it were pure text, and then placing a box around the comments. Comments which start at the beginning of a line are formatted to fill a line. Comments which start indented are formatted with 40 columns of text per line.

Normal text is formatted in a similar way to a word processor. The user can set up whether paragraphs are to be left justified or have ragged margins.

This macro can be used to reformat multiple paragraphs. A paragraph boundary is taken as a blank line.

MENU/KEYS
This feature is available via the <Ctrl-F> key.

SEE ALSO
Document options, autowrap, margin

BUGS
Reformatting a comment which has an indented list removes the indenting.