X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=man%2Fcurs_extend.3x;h=05ed5dfb569d586d7396a8564b75453419c63e3b;hb=5fa28d9ac15ff11842cdd1375df3bf3ce1112cb7;hp=8e992e749d89964347f9464fec4e80e6e9be55dc;hpb=a8987e73ec254703634802b4f7ee30d3a485524d;p=ncurses.git diff --git a/man/curs_extend.3x b/man/curs_extend.3x index 8e992e74..05ed5dfb 100644 --- a/man/curs_extend.3x +++ b/man/curs_extend.3x @@ -1,5 +1,6 @@ .\"*************************************************************************** -.\" Copyright (c) 1999-2002,2003 Free Software Foundation, Inc. * +.\" Copyright 2018-2022,2023 Thomas E. Dickey * +.\" Copyright 1999-2010,2016 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,59 +27,82 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" Author: Thomas E. Dickey 1999 +.\" Author: Thomas E. Dickey 1999-on .\" -.\" $Id: curs_extend.3x,v 1.12 2003/10/25 20:33:16 tom Exp $ -.TH curs_extend 3X "" +.\" $Id: curs_extend.3x,v 1.44 2023/12/23 16:36:18 tom Exp $ +.TH curs_extend 3X 2023-12-23 "ncurses 6.4" "Library calls" +.ie \n(.g \{\ +.ds `` \(lq +.ds '' \(rq +.\} +.el \{\ +.ie t .ds `` `` +.el .ds `` "" +.ie t .ds '' '' +.el .ds '' "" +.\} .SH NAME -\fBcurses_version\fP, -\fBuse_extended_names\fP \- miscellaneous curses extensions - +\fB\%curses_version\fP, +\fB\%use_extended_names\fP \- +miscellaneous \fIcurses\fR extensions .SH SYNOPSIS -\fB#include \fP - -\fBconst char * curses_version(void);\fP -.br -\fBint use_extended_names(bool enable);\fP +.nf +\fB#include +.PP +\fBconst char * curses_version(void); +\fBint use_extended_names(bool \fIenable\fP); +.fi .SH DESCRIPTION These functions are extensions to the curses library which do not fit easily into other categories. -.PP -Use -.I curses_version() -to get the version number, including patch level of the library, e.g., -.B 5.0.19991023 -.PP -The -.I use_extended_names() +.SS curses_version +Use \fBcurses_version\fP +to get the version number, including patch level of the library, +prefixed by \*(``ncurses\*('', e.g., +.RS +.sp +.B ncurses 5.0.19991023 +.RE +.SS use_extended_names +The \fBuse_extended_names\fP function controls whether the calling application is able to use user-defined or nonstandard names which may be compiled into the terminfo description, i.e., via the terminfo or termcap interfaces. Normally these names are available for use, since the essential decision -is made by using the \fB\-x\fP option of \fItic\fP to compile +is made by using the \fB\-x\fP option of \fB@TIC@\fP to compile extended terminal definitions. However you can disable this feature to ensure compatibility with other implementations of curses. +.SH RETURN VALUE +\fBcurses_version\fP returns a pointer to static memory; you should not free +this in your application. +.PP +\fBuse_extended_names\fP returns the previous state, allowing you to +save this and restore it. +.SH EXTENSIONS +These functions are \fB\%ncurses\fP(3X) extensions, +and are not found in SVr4 +.IR curses , +4.4BSD +.IR curses , +or any other previous curses implementation. .SH PORTABILITY -These routines are specific to ncurses. They were not supported on -Version 7, BSD or System V implementations. It is recommended that -any code depending on them be conditioned using NCURSES_VERSION. -.SH SEE ALSO -\fBcurs_getch\fR(3X), -\fBcurs_mouse\fR(3X), -\fBcurs_print\fR(3X), -\fBdefault_colors\fR(3X), -\fBdefine_key\fR(3X), -\fBkeybound\fR(3X), -\fBkeyok\fR(3X), -\fBresizeterm\fR(3X), -\fBwresize\fR(3X). -.SH AUTHOR +Applications employing +.I \%ncurses +extensions should condition their use on the visibility of the +.B \%NCURSES_VERSION +preprocessor macro. +.SH AUTHORS Thomas Dickey. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: +.SH SEE ALSO +\fB\%curs_getch\fP(3X), +\fB\%curs_mouse\fP(3X), +\fB\%curs_print\fP(3X), +\fB\%curs_util\fP(3X), +\fB\%default_colors\fP(3X), +\fB\%define_key\fP(3X), +\fB\%keybound\fP(3X), +\fB\%keyok\fP(3X), +\fB\%resizeterm\fP(3X), +\fB\%wresize\fP(3X)