summaryrefslogtreecommitdiff
path: root/mkc_check_decl.1
blob: 6c87e3ff3c2c678771118572a0e8835b873bf7a8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
.\"	$NetBSD$
.\"
.\" Copyright (c) 2009-2010 by Aleksey Cheusov (vle@gmx.net)
.\" Absolutely no warranty.
.\"
.\" ------------------------------------------------------------------
.de VS \" Verbatim Start
.ft CW
.nf
.ne \\$1
..
.de VE \" Verbatim End
.ft R
.fi
..
.\" ------------------------------------------------------------------
.TH MKC_CHECK_DECL 1 "Mar 15, 2009" "" ""
.SH NAME
mkc_check_decl \- checks for define, function, variable or type.
.SH SYNOPSIS
.BI mkc_check_decl " <check_type> <what> [includes...]"
.br
.BI mkc_check_decl " -h|--help"
.SH DESCRIPTION
.I check_type
is either
.IR " define" , " variable" , " func[0-9]" , " type " or " member" .
Depending on its value
.B mkc_check_decl
checks for define, variable, function with specified number
of arguments, type or a member of structure 
in a specified header files
.I includes
by compiling a test program.
As a result it prints either 1 (success) or 0 (failure) to stdout.
.SH OPTIONS
.TP
.B "-h|--help"
display help message
.SH ENVIRONMENT
.TP
.B CC
Compiler. By default
.I cc
is used.
.TP
.B CPPFLAGS, CFLAGS
Options passed to the compiler, for example -I for additional directories
that contain header files.
.TP
.B MKC_VERBOSE
If set to 1, verbose messages are output to stderr.
.TP
.B MKC_SHOW_CACHED
If set to 1 and MKC_VERBOSE is set to 1, cached results
are output to stderr.
.TP
.B MKC_COMMON_HEADERS
List of header files to add to .c test program.
.TP
.B MKC_CACHEDIR
Directory where temporary and cache files are created.
If unset they are created in a current directory.
.TP
.B MKC_NOCACHE
All results are cached unless MKC_NOCACHE variable is set
to 1.
.TP
.B MKC_DELETE_TMPFILES
If set to 1, temporary files are removed.
.SH EXAMPLES
.VS
   mkc_check_decl define __GNUC__
   mkc_check_decl define RTLD_LAZY dlfcn.h
   mkc_check_decl variable sys_errlist errno.h
   mkc_check_decl variable __malloc_hook malloc.h
   mkc_check_decl func3 poll poll.h
   mkc_check_decl func2 fgetln stdio.h
   mkc_check_decl type mbstate_t wchar.h
   mkc_check_decl type long-long
   mkc_check_decl member tm.tm_isdst time.h
   mkc_check_decl member ifreq.ifr_addr.sa_len net/if.h
.VE
.SH AUTHOR
Aleksey Cheusov <vle@gmx.net>