Fix.
[autobuild.git] / doc / autobuild.texi
1 \input texinfo   @c -*-texinfo-*-
2 @comment $Id: autobuild.texi,v 1.2 2004-07-08 14:02:44 jas Exp $
3 @comment %**start of header
4 @setfilename autobuild.info
5 @include version.texi
6 @settitle Autobuild @value{VERSION}
7 @syncodeindex pg cp
8 @comment %**end of header
9 @copying
10 This manual is last updated @value{UPDATED} for version
11 @value{VERSION} of GNU Libidn.
12
13 Copyright @copyright{} 2004 Simon Josefsson.
14
15 @quotation
16 Permission is granted to copy, distribute and/or modify this document
17 under the terms of the GNU Free Documentation License, Version 1.1 or
18 any later version published by the Free Software Foundation; with no
19 Invariant Sections, with the Front-Cover Texts being ``A GNU Manual,''
20 and with the Back-Cover Texts as in (a) below.  A copy of the
21 license is included in the section entitled ``GNU Free Documentation
22 License.''
23
24 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
25 this GNU Manual, like GNU software.  Copies published by the Free
26 Software Foundation raise funds for GNU development.''
27 @end quotation
28 @end copying
29
30 @dircategory Development
31 @direntry
32 * autobuild: (autobuild).       Generate HTML information from software builds.
33 @end direntry
34
35 @dircategory GNU utilities
36 @direntry
37 * autobuild: (autobuild)Invoking autobuild.     Process build logs.
38 * abindex: (autobuild)Invoking abindex.         Create indexes for build logs.
39 @end direntry
40
41 @titlepage
42 @title Autobuild
43 @subtitle for version @value{VERSION}, @value{UPDATED}
44 @author Simon Josefsson (@email{bug-autobuild@@josefsson.org})
45 @page
46 @vskip 0pt plus 1filll
47 @insertcopying
48 @end titlepage
49
50 @contents
51
52 @ifnottex
53 @node Top
54 @top Autobuild
55
56 @insertcopying
57 @end ifnottex
58
59 @menu
60 * Introduction::
61 * Integrating autobuild.m4 in your project::
62 * Invoking autobuild::
63 * Invoking abindex::
64 * Copying This Manual::
65 * Index::
66 @end menu
67
68 @node Introduction
69 @chapter Introduction
70
71 Autobuild is a package that process output from building software,
72 primarily focused on packages using Autoconf and Automake, and then
73 generate a HTML summary file, containing links to each build log.  The
74 output include project name, version, build host types (cross compile
75 aware), compiler host name, date of build, and indication of success
76 or failure.  The output is indexed in many ways to simplify browsing.
77
78 The quickest way to get an understanding of what Autobuild can do for
79 you, is to look at some example output.  For now, we recommend looking
80 at how Autobuild is used in the GNU Libidn project, see
81 @url{http://josefsson.org/autobuild-logs/libidn.html}.
82
83 @node Integrating autobuild.m4 in your project
84 @chapter Integrating autobuild.m4 in your project
85
86
87 @node Invoking autobuild
88 @chapter Invoking autobuild
89
90 @pindex autobuild
91 @cindex invoking @command{autobuild}
92
93 This is a autobuild manual.  There is no autobuild program to
94 invoke, but if there was, you could see its basic usage
95 and command line options here.
96
97 @node Invoking abindex
98 @chapter Invoking abindex
99
100 @pindex abindex
101 @cindex invoking @command{abindex}
102
103 This is a autobuild manual.  There is no autobuild program to invoke,
104 but if there was, you could see its basic usage and command line
105 options here.
106
107
108 @node Copying This Manual
109 @appendix Copying This Manual
110
111 @menu
112 * GNU Free Documentation License::  License for copying this manual.
113 @end menu
114
115 @include fdl.texi
116
117
118 @node Index
119 @unnumbered Index
120
121 @printindex cp
122
123 @bye