format.h

Low-level text formatting and output.

This header file provides low-level access to the formatter engine. You really shouldn't use anything in here, unless you know what you're doing. It's far better to use the higher-level functions provided elsewhere and to leave the low level formatting chores to the library.

This part of the documentation also includes an explanation of the various ad hoc escape sequences used for formatting purposes.

Original banner, legalese and change history follow.

 ***************************************************************************** 
 **                                                                         **
 **  FILE:     format.h                                                     **
 **  AUTHORS:  Alexios                                                      **
 **  REVISION: A, July 94                                                   **
 **  PURPOSE:  Low level text formatting and output routines                **
 **  NOTES:    Interface to format.c                                        **
 **  LEGALESE:                                                              **
 **                                                                         **
 **  This program is free software; you  can redistribute it and/or modify  **
 **  it under the terms of the GNU  General Public License as published by  **
 **  the Free Software Foundation; either version 2 of the License, or (at  **
 **  your option) any later version.                                        **
 **                                                                         **
 **  This program is distributed  in the hope  that it will be useful, but  **
 **  WITHOUT    ANY WARRANTY;   without  even  the    implied warranty  of  **
 **  MERCHANTABILITY or  FITNESS FOR  A PARTICULAR  PURPOSE.   See the GNU  **
 **  General Public License for more details.                               **
 **                                                                         **
 **  You  should have received a copy   of the GNU  General Public License  **
 **  along with    this program;  if   not, write  to  the   Free Software  **
 **  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.              **
 **                                                                         **
 *****************************************************************************


 *
 * $Id: format.h,v 1.3 2001/04/22 14:49:04 alexios Exp $
 *
 * $Log: format.h,v $
 * Revision 1.3  2001/04/22 14:49:04  alexios
 * Merged in leftover 0.99.2 changes and additional bug fixes.
 *
 * Revision 0.2  1997/11/06 20:03:39  alexios
 * Added GPL legalese to the top of this file.
 *
 * Revision 0.1  1997/08/26 15:48:53  alexios
 * First registered revision. Adequate.
 *
 *
 *

Paging result codes

Results codes from the last paging pause.

fmt_lastresult

The last paging result.

fmt_screenheight

The current screen height in rows.

fmt_setpausetext

Change the pager prompt.

fmt_output

Low level output function.

fmt_setlinelen

Set the length of a line.

fmt_setformatting

Enable or disable formatting.

fmt_setverticalformat

Set paging mode.

fmt_setscreenheight

Set screen height.

fmt_screenpause

Invokes the screen pager.

fmt_forcedpause

Forces a screen pause.

fmt_resetvpos

Sets the perceived vertical position.

Formatting directives.

Ad hoc escape sequences used for formatting purposes.

Author:

Alexios

Alphabetic index