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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
|
Autoconf Macro Archive
======================
:Homepage: http://autoconf-archive.cryp.to/
:Latest Release: autoconf-archive-2006-03-12.tar.bz2_
:Browse Archive: `Index of available Macros <macros-by-category.html>`_
Synopsis
--------
The Autoconf Macro Archive aims to provide a collection of
reusable Autoconf_ macros as free software. The archive
currently features more than 300 macros which perform
portability tests ranging from compiler support for weird
language extensions to automatic generation of
sophisticated Automake_ rules. However, all these macros
have been contributed by friendly supporters of the cause
from all over the Internet; the archive really just
collects and distributes them.
How To Contribute
-----------------
You have written a macro and would like to share it? Great!
Just write up a brief explanation how it can be used, send
it off to <simons@cryp.to>, and wait for me to get back to
you with either an report of success or lots of questions.
If you feel like being particularly helpful, you can do me
the favor and format the macro in the archive's internal
markup before submitting it::
dnl @synopsis AX_MY_MACRO(param1 [, param1])
dnl
dnl Describe what test the macro performs,
dnl what the parameters do, and how the result
dnl is used after that.
dnl
dnl Paragraphs are separated by an "dnl" line.
dnl
dnl An indented line is a block quote.
dnl That's often nice for giving examples.
dnl
dnl @author Joe Doe <joe@example.org>
dnl @version 2006-03-12
dnl @license AllPermissive
AC_DEFUN([AX_MY_MACRO],[
...
])
Please submit *one file per macro*. If you have a family of
macros that depend on each other, denote that by calling
``AC_REQUIRE``; then ``aclocal(1)`` will collect all of
them automatically no matter over how many files they are
spread.
The comprehensive list of all keywords understood by the
formatting engine is:
``@category keyword``
The keyword may be any of ``Automake``, ``C``,
``CrossCompilation``, ``Cxx``, ``Fortran``,
``InstalledPackages``, ``Java``, ``LaTeX``, or
``Misc``. You can assign a macro into more than one
category by specifying multiple ``@category`` lines::
@category C
@category Cxx
``@synopsis a line of free text``
The synopsis line should provide the usual
specification of the macro's arguments. If you think
it's useful, you can provide more than one
``@synopsis``.
``@summary a line of free text``
Give a one-sentence explanation of what the macro
does. This short summary will be displayed on the
generated index pages.
``@version yyyy-mm-dd``
Every macro in the archive is versioned with the date
of the its last modification. For most macros, that is
the day of submission.
``@author My Name <my.address@example.net>``
This tag accepts free text, actually, so you can write
whatever you want, but it's good practice to use the
common format shown above. Multiple ``@author`` lines
are permitted.
``@license keyword``
The keyword may be any of ``AllPermissive``, ``GPL2``,
``GPLWithACException``, or ``BSD``. The Free Software
Foundation recommends_ the all-permissive license for
Autoconf macros.
Copyleft
--------
Compilation Copyright (c) 2005 by Peter Simons
<simons@cryp.to>. The Autoconf Macro Archive is
licensed according to the terms of the `GNU General Public
License <http://www.gnu.org/licenses/gpl.html>`_.
All macros are copyrighted by their respective authors.
Please refer to the individual files for details.
.. References used in the text above
.. .................................
.. _Autoconf: http://www.gnu.org/software/autoconf/
.. _Automake: http://sources.redhat.com/automake/
.. _autoconf-archive-2006-03-12.tar.bz2: http://autoconf-archive.cryp.to/autoconf-archive-2006-03-12.tar.bz2
.. _recommends: http://www.gnu.org/prep/maintain/html_node/License-Notices.html
|
