ncurses 6.4 - patch 20240420

[ncurses.git] / man / MKada_config.in

diff --git a/man/MKada_config.in b/man/MKada_config.in
index 487a9a82393e1f467625dc6c36e9ac843fcec169..a017d09f8ae8dac5aede9b982654cd3b8edeb6d9 100644 (file)
--- a/man/MKada_config.in
+++ b/man/MKada_config.in
@@ -1,5 +1,6 @@
 .\"***************************************************************************
-.\" Copyright (c) 2010 Free Software Foundation, Inc.                        *
+.\" Copyright 2019-2021,2023 Thomas E. Dickey                                *
+.\" Copyright 2010-2014,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,31 +27,123 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: MKada_config.in,v 1.3 2010/03/06 22:29:06 tom Exp $
-.TH ADACURSES "1" "" "" "User Commands"
+.\" $Id: MKada_config.in,v 1.34 2024/04/20 21:13:27 tom Exp $
+.TH adacurses@USE_CFG_SUFFIX@\-config 1 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "User commands"
+.ds C adacurses@USE_CFG_SUFFIX@\-config
+.ie \n(.g \{\
+.ds `` \(lq
+.ds '' \(rq
+.ds '  \(aq
+.\}
+.el \{\
+.ie t .ds `` ``
+.el   .ds `` ""
+.ie t .ds '' ''
+.el   .ds '' ""
+.ie t .ds '  \(aq
+.el   .ds '  '
+.\}
+.
+.\" Fix broken EX/EE macros on DWB troff.
+.\" Detect it: only DWB sets up a `)Y` register.
+.if !\n(.g .if \n()Y \{\
+.\" Revert the undesired changes to indentation.
+.am EX
+.in -5n
+..
+.am EE
+.in +5n
+..
+.\}
+.
 .SH NAME
-adacurses-config \- helper script for AdaCurses libraries
+\fB\%adacurses@USE_CFG_SUFFIX@\-config\fP \-
+configuration helper for \fI@ADA_LIBNAME@\fP libraries
 .SH SYNOPSIS
-.B adacurses-config
-[\fIoptions\fR]
+.B \*C
+.RB [ \-\-cflags ]
+.RB [ \-\-libs ]
+.PP
+.B \*C \-\-version
+.PP
+.B \*C \-\-help
 .SH DESCRIPTION
-This is a shell script which simplifies configuring an application to use
-the AdaCurses library binding to ncurses.
+This program development aid simplifies the process of configuring
+applications to use the \fI@ADA_LIBNAME@\fP library binding to
+\fI\%ncurses\fP.
 .SH OPTIONS
+.TP 11 \" "--version" + 2n
+\fB\-\-cflags\fP
+reports the GNAT (Ada compiler) flags needed to compile with
+\fI@ADA_LIBNAME@\fP.
 .TP
-\fB\-\-cflags\fR
-echos the gnat (Ada compiler) flags needed to compile with adacurses
+\fB\-\-libs\fP
+reports the GNAT libraries needed to link with \fI@ADA_LIBNAME@\fP.
 .TP
-\fB\-\-libs\fR
-echos the gnat libraries needed to link with adacurses
+\fB\-\-version\fP
+reports the release and patch date information of the \fI\%ncurses\fP
+libraries used to configure and build \fI@ADA_LIBNAME@\fP and exits
+successfully.
 .TP
-\fB\-\-version\fR
-echos the release+patchdate version of adacurses
-.TP
-\fB\-\-help\fR
-prints this message
-.SH "SEE ALSO"
-\fBcurses\fR(3X)
+\fB\-\-help\fP
+issues a usage message and exits successfully.
 .PP
-This describes \fBncurses\fR
-version @NCURSES_MAJOR@.@NCURSES_MINOR@ (patch @NCURSES_PATCH@).
+Omitting options implies \*(``\fB\-\-cflags \-\-libs\fP\*(''.
+.SH EXAMPLES
+Consider a program using \fI@ADA_LIBNAME@\fP to write the message
+\*(``Hello, world!\*('' in the center of the screen and wait for the
+user to press the \*(``q\*('' key before exiting.
+Populate a file \fIhello.adb\fP with the following.
+.PP
+.if \n(LL>67n .RS 4
+.EX
+with Terminal_Interface.Curses; use Terminal_Interface.Curses;
+
+procedure Hello is
+   Visibility : Cursor_Visibility := Invisible;
+   Message : constant String := "Hello, World!";
+   done : Boolean := False;
+   c : Key_Code;
+begin
+   Init_Screen;
+   Set_Echo_Mode (False);
+   Set_Cursor_Visibility (Visibility);
+   Set_Timeout_Mode (Standard_Window, Non_Blocking, 0);
+
+   Move_Cursor (Line => Lines / 2,
+                Column => (Columns \- Message\*'Length) / 2);
+   Add (Str => Message);
+
+   while not done loop
+      c := Get_Keystroke (Standard_Window);
+
+      case c is
+          when Character\*'Pos (\*'q\*') => done := True;
+          when others => null;
+      end case;
+
+      Nap_Milli_Seconds (50);
+   end loop;
+
+   End_Windows;
+end Hello;
+.EE
+.if \n(LL>67n .RE
+.ne 2
+.PP
+Then, using
+.RS 4
+.EX
+gnatmake \(gaadacurses@USE_CFG_SUFFIX@\-config \-\-cflags\(ga hello \e
+    \-largs \(gaadacurses@USE_CFG_SUFFIX@\-config \-\-libs\(ga
+.EE
+.RE
+or, more simply,
+.RS 4
+.EX
+gnatmake hello \(gaadacurses@USE_CFG_SUFFIX@\-config\(ga
+.EE
+.RE
+you can compile and link the program.
+.SH "SEE ALSO"
+\fB\%curses\fP(3X)