X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fpanel.3x;h=2896f01adc49bad88c818c961fc6222d398baad0;hp=cfa170ef04159027ee07e32d94e0ac275614ccbd;hb=027ae42953e3186daed8f3882da73de48291b606;hpb=3a9b6a3bf0269231bef7de74757a910dedd04e0c diff --git a/man/panel.3x b/man/panel.3x index cfa170ef..2896f01a 100644 --- a/man/panel.3x +++ b/man/panel.3x @@ -1,6 +1,35 @@ +.\"*************************************************************************** +.\" Copyright (c) 1998-2003,2006 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 * +.\" "Software"), to deal in the Software without restriction, including * +.\" without limitation the rights to use, copy, modify, merge, publish, * +.\" distribute, distribute with modifications, sublicense, and/or sell * +.\" copies of the Software, and to permit persons to whom the Software is * +.\" furnished to do so, subject to the following conditions: * +.\" * +.\" The above copyright notice and this permission notice shall be included * +.\" in all copies or substantial portions of the Software. * +.\" * +.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * +.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * +.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * +.\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * +.\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * +.\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * +.\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. * +.\" * +.\" Except as contained in this notice, the name(s) of the above copyright * +.\" holders shall not be used in advertising or otherwise to promote the * +.\" sale, use or other dealings in this Software without prior written * +.\" authorization. * +.\"*************************************************************************** +.\" +.\" $Id: panel.3x,v 1.12 2006/05/13 15:35:45 tom Exp $ .TH panel 3X "" .ds n 5 -.ds d @DATADIR@/terminfo +.ds d @TERMINFO@ .SH NAME panel - panel stack extension for curses .SH SYNOPSIS @@ -39,7 +68,7 @@ panel - panel stack extension for curses \fBint del_panel(PANEL *pan)\fR .br .SH DESCRIPTION -Panels are curses(3X) windows with the added feature of +Panels are \fBcurses\fR(3X) windows with the added feature of depth. Panel functions allow the use of stacked windows and ensure the proper portions of each window and the curses \fBstdscr\fR window are hidden or displayed when panels are added, moved, modified or removed. @@ -48,10 +77,10 @@ The set of currently visible panels is the stack of panels. The of the stack. .P A window is associated with every panel. The panel routines enable -you to create, move, hides, and show panels, as well as position a +you to create, move, hide, and show panels, as well as position a panel at any desired location in the stack. .P -Panel routines are a functional layer added to curses(3X), make only +Panel routines are a functional layer added to \fBcurses\fR(3X), make only high-level curses calls, and work anywhere terminfo curses does. .SH FUNCTIONS .TP @@ -97,7 +126,7 @@ to move a panel window. \fBreplace_panel(pan,window)\fR replaces the current window of panel with \fBwindow\fR (useful, for example if you want to resize a panel; if you're using \fBncurses\fR, -you can call \fBreplace_panel\fR on the output of \fBwresize\fR(3x)). +you can call \fBreplace_panel\fR on the output of \fBwresize\fR(3X)). It does not change the position of the panel in the stack. .TP \fBpanel_above(pan)\fR @@ -137,7 +166,7 @@ function to ensure compatibility with native panel libraries. .SH NOTE In your library list, libpanel.a should be before libncurses.a; that is, you want to say `-lpanel -lncurses', not the other way around (which would -give you a link error using GNU \fBld\fR(1) and some other linkers). +usually give a link-error). .SH FILES .P panel.h @@ -146,10 +175,11 @@ interface for the panels library libpanel.a the panels library itself .SH SEE ALSO -curses(3X) +\fBcurses\fR(3X) +.PP +This describes \fBncurses\fR +version @NCURSES_MAJOR@.@NCURSES_MINOR@ (patch @NCURSES_PATCH@). .SH AUTHOR Originally written by Warren Tucker , primarily to assist in porting u386mon to systems without a native panels library. Repackaged for ncurses by Zeyd ben-Halim. - -