X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_termattrs.3x;h=4e482f14aefc86a96102fd10759242bfb240f14b;hp=1e07307d19c0e2a7043d978b202225ccfc2df77a;hb=74433bcf4f6fe40862a28f3c00edaedcd5054b01;hpb=3853a8e97d7efa8cb6a3c93c696d2c52895d6a70 diff --git a/man/curs_termattrs.3x b/man/curs_termattrs.3x index 1e07307d..4e482f14 100644 --- a/man/curs_termattrs.3x +++ b/man/curs_termattrs.3x @@ -1,5 +1,6 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2003,2007 Free Software Foundation, Inc. * +.\" Copyright 2018-2020,2021 Thomas E. Dickey * +.\" Copyright 1998-2010,2015 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * .\" copy of this software and associated documentation files (the * @@ -26,109 +27,115 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_termattrs.3x,v 1.10 2007/06/02 20:40:07 tom Exp $ +.\" $Id: curs_termattrs.3x,v 1.18 2021/12/25 21:41:58 tom Exp $ .TH curs_termattrs 3X "" .SH NAME -\fBbaudrate\fR, -\fBerasechar\fR, -\fBerasewchar\fR, -\fBhas_ic\fR, -\fBhas_il\fR, -\fBkillchar\fR, -\fBkillwchar\fR, -\fBlongname\fR, -\fBterm_attrs\fR, -\fBtermattrs\fR, -\fBtermname\fR - \fBcurses\fR environment query routines +\fBbaudrate\fP, +\fBerasechar\fP, +\fBerasewchar\fP, +\fBhas_ic\fP, +\fBhas_il\fP, +\fBkillchar\fP, +\fBkillwchar\fP, +\fBlongname\fP, +\fBterm_attrs\fP, +\fBtermattrs\fP, +\fBtermname\fP \- \fBcurses\fP environment query routines .SH SYNOPSIS -\fB#include \fR +\fB#include \fP .PP -\fBint baudrate(void);\fR +\fBint baudrate(void);\fP .br -\fBchar erasechar(void);\fR +\fBchar erasechar(void);\fP .br -\fBint erasewchar(wchar_t *\fR\fIch\fR\fB);\fR +\fBint erasewchar(wchar_t *\fP\fIch\fP\fB);\fP .br -\fBbool has_ic(void);\fR +\fBbool has_ic(void);\fP .br -\fBbool has_il(void);\fR +\fBbool has_il(void);\fP .br -\fBchar killchar(void);\fR +\fBchar killchar(void);\fP .br -\fBint killwchar(wchar_t *\fR\fIch\fR\fB);\fR +\fBint killwchar(wchar_t *\fP\fIch\fP\fB);\fP .br -\fBchar *longname(void);\fR +\fBchar *longname(void);\fP .br -\fBattr_t term_attrs(void);\fR +\fBattr_t term_attrs(void);\fP .br -\fBchtype termattrs(void);\fR +\fBchtype termattrs(void);\fP .br -\fBchar *termname(void);\fR +\fBchar *termname(void);\fP .br .SH DESCRIPTION -The \fBbaudrate\fR routine returns the output speed of the terminal. The -number returned is in bits per second, for example \fB9600\fR, and is an +.SS baudrate +The \fBbaudrate\fP routine returns the output speed of the terminal. +The +number returned is in bits per second, for example \fB9600\fP, and is an integer. +.SS erasechar, erasewchar .PP -The \fBerasechar\fR routine returns the user's current erase character. +The \fBerasechar\fP routine returns the user's current erase character. .PP -The \fBerasewchar\fR routine stores the current erase character -in the location referenced by \fIch\fR. +The \fBerasewchar\fP routine stores the current erase character +in the location referenced by \fIch\fP. If no erase character has been defined, the routine fails -and the location referenced by \fIch\fR is not changed. +and the location referenced by \fIch\fP is not changed. +.SS has_is, has_il .PP -The \fBhas_ic\fR routine is true if the terminal has insert- and delete- +The \fBhas_ic\fP routine is true if the terminal has insert- and delete- character capabilities. .PP -The \fBhas_il\fR routine is true if the terminal has insert- and delete-line -capabilities, or can simulate them using scrolling regions. This might +The \fBhas_il\fP routine is true if the terminal has insert- and delete-line +capabilities, or can simulate them using scrolling regions. +This might be used to determine if it would be appropriate to turn on physical -scrolling using \fBscrollok\fR. +scrolling using \fBscrollok\fP. +.SS killchar, killwchar .PP -The \fBkillchar\fR routine returns the user's current line kill character. +The \fBkillchar\fP routine returns the user's current line kill character. .PP -The \fBkillwchar\fR routine stores the current line-kill character -in the location referenced by \fIch\fR. +The \fBkillwchar\fP routine stores the current line-kill character +in the location referenced by \fIch\fP. If no line-kill character has been defined, -the routine fails and the location referenced by \fIch\fR is not changed. +the routine fails and the location referenced by \fIch\fP is not changed. +.SS longname .PP -The \fBlongname\fR routine returns a pointer to a static area -containing a verbose description of the current terminal. The maximum -length of a verbose description is 128 characters. It is defined only -after the call to \fBinitscr\fR or \fBnewterm\fR. The area is -overwritten by each call to \fBnewterm\fR and is not restored by -\fBset_term\fR, so the value should be saved between calls to -\fBnewterm\fR if \fBlongname\fR is going to be used with multiple +The \fBlongname\fP routine returns a pointer to a static area +containing a verbose description of the current terminal. +The maximum +length of a verbose description is 128 characters. +It is defined only +after the call to \fBinitscr\fP or \fBnewterm\fP. The area is +overwritten by each call to \fBnewterm\fP and is not restored by +\fBset_term\fP, so the value should be saved between calls to +\fBnewterm\fP if \fBlongname\fP is going to be used with multiple terminals. +.SS termattrs, term_attrs .PP If a given terminal does not support a video attribute that an -application program is trying to use, \fBcurses\fR may substitute a +application program is trying to use, \fBcurses\fP may substitute a different video attribute for it. -The \fBtermattrs\fR and \fBterm_attrs\fR functions -return a logical \fBOR\fR of all video attributes supported by the -terminal using \fIA_\fR and \fIWA_\fR constants respectively. -This information is useful when a \fBcurses\fR program +The \fBtermattrs\fP and \fBterm_attrs\fP functions +return a logical \fBOR\fP of all video attributes supported by the +terminal using \fBA_\fP and \fBWA_\fP constants respectively. +This information is useful when a \fBcurses\fP program needs complete control over the appearance of the screen. +.SS termname .PP -The \fBtermname\fR routine returns the terminal name used by \fBsetupterm\fR. +The \fBtermname\fP routine returns the terminal name used by \fBsetupterm\fP. .SH RETURN VALUE -\fBlongname\fR and \fBtermname\fR return \fBNULL\fR on error. +\fBlongname\fP and \fBtermname\fP return \fBNULL\fP on error. .PP -Routines that return an integer return \fBERR\fR upon failure and \fBOK\fR -(SVr4 only specifies "an integer value other than \fBERR\fR") upon successful +Routines that return an integer return \fBERR\fP upon failure and \fBOK\fP +(SVr4 only specifies "an integer value other than \fBERR\fP") upon successful completion. .SH NOTES -Note that \fBtermattrs\fR may be a macro. +Note that \fBtermattrs\fP may be a macro. .SH PORTABILITY -The XSI Curses standard, Issue 4 describes these functions. It changes the -return type of \fBtermattrs\fR to the new type \fBattr_t\fR. -Most versions of curses truncate the result returned by \fBtermname\fR to +The XSI Curses standard, Issue 4 describes these functions. +It changes the +return type of \fBtermattrs\fP to the new type \fBattr_t\fP. +Most versions of curses truncate the result returned by \fBtermname\fP to 14 characters. .SH SEE ALSO -\fBcurses\fR(3X), \fBcurs_initscr\fR(3X), \fBcurs_outopts\fR(3X) -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: +\fBcurses\fP(3X), \fBcurs_initscr\fP(3X), \fBcurs_outopts\fP(3X)