usr/src/man/man3xcurses/nl.3xcurses

   1 '\" te
   2 .\"  Copyright (c) 1990, 1995 by Mortice Kern Systems Inc.  All Rights Reserved  Portions Copyright (c) 1996, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH NL 3XCURSES "Jun 5, 2002"
   7 .SH NAME
   8 nl, nonl \- enable/disable newline control
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e
  13 \fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ]
  14
  15 \fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ]
  16
  17 #include <curses.h>
  18
  19 \fBint\fR \fBnl\fR(\fBvoid\fR);
  20 .fi
  21
  22 .LP
  23 .nf
  24 \fBint\fR \fBnonl\fR(\fBvoid\fR);
  25 .fi
  26
  27 .SH DESCRIPTION
  28 .sp
  29 .LP
  30 The \fBnl()\fR function enables the handling of newlines.  The \fBnl()\fR
  31 function converts newline into carriage return and line feed  on output and
  32 converts carriage return into newline on input.  \fBnonl()\fR disables the
  33 handling of newlines.
  34 .sp
  35 .LP
  36 The handling of newlines is initially enabled.  Disabling the handling of
  37 newlines results in faster cursor motion since  X/Open Curses can use the
  38 line-feed capability more efficiently.
  39 .SH RETURN VALUES
  40 .sp
  41 .LP
  42 On success, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR.
  43 .SH ERRORS
  44 .sp
  45 .LP
  46 None.
  47 .SH ATTRIBUTES
  48 .sp
  49 .LP
  50 See \fBattributes\fR(5) for descriptions of the following attributes:
  51 .sp
  52
  53 .sp
  54 .TS
  55 box;
  56 c | c
  57 l | l .
  58 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  59 _
  60 Interface Stability     Standard
  61 _
  62 MT-Level        Unsafe
  63 .TE
  64
  65 .SH SEE ALSO
  66 .sp
  67 .LP
  68 \fBlibcurses\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5)