man/MKada_config.in

   1 .\"***************************************************************************
   2 .\" Copyright 2019-2021,2023 Thomas E. Dickey                                *
   3 .\" Copyright 2010-2014,2016 Free Software Foundation, Inc.                  *
   4 .\"                                                                          *
   5 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
   6 .\" copy of this software and associated documentation files (the            *
   7 .\" "Software"), to deal in the Software without restriction, including      *
   8 .\" without limitation the rights to use, copy, modify, merge, publish,      *
   9 .\" distribute, distribute with modifications, sublicense, and/or sell       *
  10 .\" copies of the Software, and to permit persons to whom the Software is    *
  11 .\" furnished to do so, subject to the following conditions:                 *
  12 .\"                                                                          *
  13 .\" The above copyright notice and this permission notice shall be included  *
  14 .\" in all copies or substantial portions of the Software.                   *
  15 .\"                                                                          *
  16 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  17 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  18 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  19 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  20 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  21 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  22 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  23 .\"                                                                          *
  24 .\" Except as contained in this notice, the name(s) of the above copyright   *
  25 .\" holders shall not be used in advertising or otherwise to promote the     *
  26 .\" sale, use or other dealings in this Software without prior written       *
  27 .\" authorization.                                                           *
  28 .\"***************************************************************************
  29 .\"
  30 .\" $Id: MKada_config.in,v 1.34 2024/04/20 21:13:27 tom Exp $
  31 .TH adacurses@USE_CFG_SUFFIX@\-config 1 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "User commands"
  32 .ds C adacurses@USE_CFG_SUFFIX@\-config
  33 .ie \n(.g \{\
  34 .ds `` \(lq
  35 .ds '' \(rq
  36 .ds '  \(aq
  37 .\}
  38 .el \{\
  39 .ie t .ds `` ``
  40 .el   .ds `` ""
  41 .ie t .ds '' ''
  42 .el   .ds '' ""
  43 .ie t .ds '  \(aq
  44 .el   .ds '  '
  45 .\}
  46 .
  47 .\" Fix broken EX/EE macros on DWB troff.
  48 .\" Detect it: only DWB sets up a `)Y` register.
  49 .if !\n(.g .if \n()Y \{\
  50 .\" Revert the undesired changes to indentation.
  51 .am EX
  52 .in -5n
  53 ..
  54 .am EE
  55 .in +5n
  56 ..
  57 .\}
  58 .
  59 .SH NAME
  60 \fB\%adacurses@USE_CFG_SUFFIX@\-config\fP \-
  61 configuration helper for \fI@ADA_LIBNAME@\fP libraries
  62 .SH SYNOPSIS
  63 .B \*C
  64 .RB [ \-\-cflags ]
  65 .RB [ \-\-libs ]
  66 .PP
  67 .B \*C \-\-version
  68 .PP
  69 .B \*C \-\-help
  70 .SH DESCRIPTION
  71 This program development aid simplifies the process of configuring
  72 applications to use the \fI@ADA_LIBNAME@\fP library binding to
  73 \fI\%ncurses\fP.
  74 .SH OPTIONS
  75 .TP 11 \" "--version" + 2n
  76 \fB\-\-cflags\fP
  77 reports the GNAT (Ada compiler) flags needed to compile with
  78 \fI@ADA_LIBNAME@\fP.
  79 .TP
  80 \fB\-\-libs\fP
  81 reports the GNAT libraries needed to link with \fI@ADA_LIBNAME@\fP.
  82 .TP
  83 \fB\-\-version\fP
  84 reports the release and patch date information of the \fI\%ncurses\fP
  85 libraries used to configure and build \fI@ADA_LIBNAME@\fP and exits
  86 successfully.
  87 .TP
  88 \fB\-\-help\fP
  89 issues a usage message and exits successfully.
  90 .PP
  91 Omitting options implies \*(``\fB\-\-cflags \-\-libs\fP\*(''.
  92 .SH EXAMPLES
  93 Consider a program using \fI@ADA_LIBNAME@\fP to write the message
  94 \*(``Hello, world!\*('' in the center of the screen and wait for the
  95 user to press the \*(``q\*('' key before exiting.
  96 Populate a file \fIhello.adb\fP with the following.
  97 .PP
  98 .if \n(LL>67n .RS 4
  99 .EX
 100 with Terminal_Interface.Curses; use Terminal_Interface.Curses;
 101
 102 procedure Hello is
 103    Visibility : Cursor_Visibility := Invisible;
 104    Message : constant String := "Hello, World!";
 105    done : Boolean := False;
 106    c : Key_Code;
 107 begin
 108    Init_Screen;
 109    Set_Echo_Mode (False);
 110    Set_Cursor_Visibility (Visibility);
 111    Set_Timeout_Mode (Standard_Window, Non_Blocking, 0);
 112
 113    Move_Cursor (Line => Lines / 2,
 114                 Column => (Columns \- Message\*'Length) / 2);
 115    Add (Str => Message);
 116
 117    while not done loop
 118       c := Get_Keystroke (Standard_Window);
 119
 120       case c is
 121           when Character\*'Pos (\*'q\*') => done := True;
 122           when others => null;
 123       end case;
 124
 125       Nap_Milli_Seconds (50);
 126    end loop;
 127
 128    End_Windows;
 129 end Hello;
 130 .EE
 131 .if \n(LL>67n .RE
 132 .ne 2
 133 .PP
 134 Then, using
 135 .RS 4
 136 .EX
 137 gnatmake \(gaadacurses@USE_CFG_SUFFIX@\-config \-\-cflags\(ga hello \e
 138     \-largs \(gaadacurses@USE_CFG_SUFFIX@\-config \-\-libs\(ga
 139 .EE
 140 .RE
 141 or, more simply,
 142 .RS 4
 143 .EX
 144 gnatmake hello \(gaadacurses@USE_CFG_SUFFIX@\-config\(ga
 145 .EE
 146 .RE
 147 you can compile and link the program.
 148 .SH "SEE ALSO"
 149 \fB\%curses\fP(3X)