[src/trunk]: src/lib/libpanel Skeleton manual pages for libpanel functions. ...

[uwe <uwe%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/f235aee267dc
branches:  trunk
changeset: 341252:f235aee267dc
user:      uwe <uwe%NetBSD.org@localhost>
date:      Tue Oct 27 23:42:55 2015 +0000

description:
Skeleton manual pages for libpanel functions.  No content yet.

diffstat:

 lib/libpanel/move_panel.3    |  43 ++++++++++++++++++++++++++++++++++
 lib/libpanel/new_panel.3     |  55 ++++++++++++++++++++++++++++++++++++++++++++
 lib/libpanel/panel_above.3   |  55 ++++++++++++++++++++++++++++++++++++++++++++
 lib/libpanel/panel_hidden.3  |  51 ++++++++++++++++++++++++++++++++++++++++
 lib/libpanel/panel_userptr.3 |  47 +++++++++++++++++++++++++++++++++++++
 lib/libpanel/update_panels.3 |  43 ++++++++++++++++++++++++++++++++++
 6 files changed, 294 insertions(+), 0 deletions(-)

diffs (truncated from 318 to 300 lines):

diff -r 5821913ee238 -r f235aee267dc lib/libpanel/move_panel.3
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/lib/libpanel/move_panel.3 Tue Oct 27 23:42:55 2015 +0000
@@ -0,0 +1,43 @@
+.\"    $NetBSD: move_panel.3,v 1.1 2015/10/27 23:42:55 uwe Exp $
+.\"
+.\" Copyright (c) 2015 Valery Ushakov
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
+.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
+.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+.\"
+.Dd October 28, 2015
+.Dt MOVE_PANEL 3
+.Os
+.Sh NAME
+.Nm move_panel
+.Nd change panel position
+.Sh LIBRARY
+.Lb libpanel
+.Sh SYNOPSIS
+.In panel.h
+.\"
+.Ft int
+.Fn move_panel "PANEL *p" "int y" "int x"
+.\"
+.Sh DESCRIPTION
+Change panel position on screen...
+.Sh SEE ALSO
+.Xr panel 3
diff -r 5821913ee238 -r f235aee267dc lib/libpanel/new_panel.3
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/lib/libpanel/new_panel.3  Tue Oct 27 23:42:55 2015 +0000
@@ -0,0 +1,55 @@
+.\"    $NetBSD: new_panel.3,v 1.1 2015/10/27 23:42:55 uwe Exp $
+.\"
+.\" Copyright (c) 2015 Valery Ushakov
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
+.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
+.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+.\"
+.Dd October 28, 2015
+.Dt NEW_PANEL 3
+.Os
+.Sh NAME
+.Nm new_panel ,
+.Nm panel_window ,
+.Nm replace_panel ,
+.Nm del_panel
+.Nd panel routines
+.Sh LIBRARY
+.Lb libpanel
+.Sh SYNOPSIS
+.In panel.h
+.\"
+.Ft PANEL *
+.Fn new_panel "WINDOW *win"
+.\"
+.Ft WINDOW *
+.Fn panel_window "PANEL *p"
+.\"
+.Ft int
+.Fn replace_panel "PANEL *p" "WINDOW *win"
+.\"
+.Ft int
+.Fn del_panel "PANEL *p"
+.\"
+.Sh DESCRIPTION
+Routines to manage panels and associated curses windows...
+.Sh SEE ALSO
+.Xr panel 3
diff -r 5821913ee238 -r f235aee267dc lib/libpanel/panel_above.3
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/lib/libpanel/panel_above.3        Tue Oct 27 23:42:55 2015 +0000
@@ -0,0 +1,55 @@
+.\"    $NetBSD: panel_above.3,v 1.1 2015/10/27 23:42:55 uwe Exp $
+.\"
+.\" Copyright (c) 2015 Valery Ushakov
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
+.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
+.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+.\"
+.Dd October 28, 2015
+.Dt PANEL_ABOVE 3
+.Os
+.Sh NAME
+.Nm top_panel ,
+.Nm bottom_panel ,
+.Nm panel_above ,
+.Nm panel_below
+.Nd z-order of panels
+.Sh LIBRARY
+.Lb libpanel
+.Sh SYNOPSIS
+.In panel.h
+.\"
+.Ft int
+.Fn top_panel "PANEL *p"
+.\"
+.Ft int
+.Fn bottom_panel "PANEL *p"
+.\"
+.Ft PANEL *
+.Fn panel_above "PANEL *p"
+.\"
+.Ft PANEL *
+.Fn panel_below "PANEL *p"
+.\"
+.Sh DESCRIPTION
+Routines to manage z-order of panels...
+.Sh SEE ALSO
+.Xr panel 3
diff -r 5821913ee238 -r f235aee267dc lib/libpanel/panel_hidden.3
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/lib/libpanel/panel_hidden.3       Tue Oct 27 23:42:55 2015 +0000
@@ -0,0 +1,51 @@
+.\"    $NetBSD: panel_hidden.3,v 1.1 2015/10/27 23:42:55 uwe Exp $
+.\"
+.\" Copyright (c) 2015 Valery Ushakov
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
+.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
+.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+.\"
+.Dd October 28, 2015
+.Dt PANEL_HIDDEN 3
+.Os
+.Sh NAME
+.Nm hide_panel ,
+.Nm show_panel ,
+.Nm panel_hidden
+.Nd visibility of panels
+.Sh LIBRARY
+.Lb libpanel
+.Sh SYNOPSIS
+.In panel.h
+.\"
+.Ft int
+.Fn hide_panel "PANEL *p"
+.\"
+.Ft int
+.Fn show_panel "PANEL *p"
+.\"
+.Ft int
+.Fn panel_hidden "PANEL *p"
+.\"
+.Sh DESCRIPTION
+Routines to manage visibility of panels...
+.Sh SEE ALSO
+.Xr panel 3
diff -r 5821913ee238 -r f235aee267dc lib/libpanel/panel_userptr.3
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/lib/libpanel/panel_userptr.3      Tue Oct 27 23:42:55 2015 +0000
@@ -0,0 +1,47 @@
+.\"    $NetBSD: panel_userptr.3,v 1.1 2015/10/27 23:42:55 uwe Exp $
+.\"
+.\" Copyright (c) 2015 Valery Ushakov
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
+.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
+.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+.\"
+.Dd October 28, 2015
+.Dt PANEL_USERPTR 3
+.Os
+.Sh NAME
+.Nm set_panel_userptr ,
+.Nm panel_userptr
+.Nd user data associated with panels
+.Sh LIBRARY
+.Lb libpanel
+.Sh SYNOPSIS
+.In panel.h
+.\"
+.Ft int
+.Fn set_panel_userptr "PANEL *p" "char *data"
+.\"
+.Ft char *
+.Fn panel_userptr "PANEL *p"
+.\"
+.Sh DESCRIPTION
+Routines to manage user data associated with panels...
+.Sh SEE ALSO
+.Xr panel 3
diff -r 5821913ee238 -r f235aee267dc lib/libpanel/update_panels.3
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/lib/libpanel/update_panels.3      Tue Oct 27 23:42:55 2015 +0000
@@ -0,0 +1,43 @@
+.\"    $NetBSD: update_panels.3,v 1.1 2015/10/27 23:42:55 uwe Exp $
+.\"
+.\" Copyright (c) 2015 Valery Ushakov
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
+.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
+.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+.\"