ncurses 6.0 - patch 20161105
[ncurses.git] / man / MKada_config.in
index 487a9a82393e1f467625dc6c36e9ac843fcec169..8108fc478e0948ebfec7112e131f37264f1a6cb5 100644 (file)
@@ -1,5 +1,5 @@
 .\"***************************************************************************
-.\" Copyright (c) 2010 Free Software Foundation, Inc.                        *
+.\" Copyright (c) 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            *
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: MKada_config.in,v 1.3 2010/03/06 22:29:06 tom Exp $
+.\" $Id: MKada_config.in,v 1.10 2016/11/05 21:08:21 tom Exp $
+.ds C adacurses@USE_CFG_SUFFIX@\-config
 .TH ADACURSES "1" "" "" "User Commands"
 .SH NAME
-adacurses-config \- helper script for AdaCurses libraries
+adacurses@USE_CFG_SUFFIX@\-config \- helper script for AdaCurses libraries
 .SH SYNOPSIS
-.B adacurses-config
+.B \*C
 [\fIoptions\fR]
 .SH DESCRIPTION
 This is a shell script which simplifies configuring an application to use
@@ -39,16 +40,82 @@ the AdaCurses library binding to ncurses.
 .SH OPTIONS
 .TP
 \fB\-\-cflags\fR
-echos the gnat (Ada compiler) flags needed to compile with adacurses
+echos the gnat (Ada compiler) flags needed to compile with AdaCurses.
 .TP
 \fB\-\-libs\fR
-echos the gnat libraries needed to link with adacurses
+echos the gnat libraries needed to link with AdaCurses.
 .TP
 \fB\-\-version\fR
-echos the release+patchdate version of adacurses
+echos the release+patchdate version of the ncurses libraries used
+to configure and build AdaCurses.
 .TP
 \fB\-\-help\fR
-prints this message
+prints a list of the \fB\*C\fP script's options.
+.PP
+If no options are given, \fB\*C\fP prints the combination
+of 
+\fB\-\-cflags\fR and
+\fB\-\-libs\fR
+that \fBgnatmake\fP expects (see example).
+.SH EXAMPLE
+.PP
+For example, supposing that you want to compile the "Hello World!"
+program for AdaCurses.
+Make a file named "hello.adb":
+.RS
+.nf
+.ft CW
+with Terminal_Interface.Curses; use Terminal_Interface.Curses;
+
+procedure Hello is
+
+   Visibility : Cursor_Visibility := Invisible;
+   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 - 12) / 2);
+   Add (Str => "Hello World!");
+
+   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;
+.fi
+.RE
+.PP
+Then, using
+.RS
+.ft CW
+gnatmake `adacurses-config --cflags` hello -largs `adacurses-config --libs`
+.ft
+.RE
+.PP
+or (simpler):
+.RS
+.ft CW
+gnatmake hello `adacurses-config`
+.ft
+.RE
+.PP
+you will compile and link the program.
 .SH "SEE ALSO"
 \fBcurses\fR(3X)
 .PP