lib/libcurses/curses_default_colors.3

   1 .\"     $NetBSD: curses_default_colors.3,v 1.6 2008/04/30 13:10:51 martin Exp $
   2 .\" Copyright (c) 2002 The NetBSD Foundation, Inc.
   3 .\" All rights reserved.
   4 .\"
   5 .\" This code is derived from software contributed to The NetBSD Foundation
   6 .\" by Julian Coleman.
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer in the
  15 .\"    documentation and/or other materials provided with the distribution.
  16 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  17 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  18 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  19 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  20 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  21 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  22 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  23 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  24 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  25 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  26 .\" POSSIBILITY OF SUCH DAMAGE.
  27 .\"
  28 .Dd October 13, 2002
  29 .Dt CURSES_DEFAULT_COLORS 3
  30 .Os
  31 .Sh NAME
  32 .Nm curses_default_colors ,
  33 .Nm assume_default_colors ,
  34 .Nm use_default_colors
  35 .Nd curses default colors setting routines
  36 .Sh LIBRARY
  37 .Lb libcurses
  38 .Sh SYNOPSIS
  39 .In curses.h
  40 .Ft int
  41 .Fn assume_default_colors "short fore" "short back"
  42 .Ft int
  43 .Fn use_default_colors ""
  44 .Sh DESCRIPTION
  45 These functions tell the curses library to set the default colors or to use
  46 the terminal's default colors instead of using the default colors for curses
  47 applications (which are white foreground on black background).
  48 .Pp
  49 The function
  50 .Fn assume_default_colors fore back
  51 sets the default colors to foreground color
  52 .Fa fore
  53 and background color
  54 .Fa back .
  55 If a value of \-1 is used for a color, then the terminal default color is used
  56 for that color.
  57 .Pp
  58 The function
  59 .Fn use_default_colors
  60 sets both the foreground and background colors to the terminal default colors.
  61 This is equivalent to
  62 .Fn assume_default_colors \-1 \-1 .
  63 .Sh RETURN VALUES
  64 These functions return OK on success and ERR on failure.
  65 .Sh SEE ALSO
  66 .Xr curses_color 3
  67 .Sh STANDARDS
  68 These functions are based on
  69 .Em ncurses
  70 extensions to the curses standards.
  71 .Sh HISTORY
  72 These functions first appeared in
  73 .Nx 2.0 .