Release 1.0.0

[gob-dx.git] / doc / gob.1.in

diff --git a/doc/gob.1.in b/doc/gob.1.in
index 34ad853aff95c1a080d3bc73961bf9cc2beffa2b..aa9b45de618de30806d56a30813987d063aec455 100644 (file)
--- a/doc/gob.1.in
+++ b/doc/gob.1.in
@@ -900,6 +900,43 @@ Another way to get out of this problem is if you can use those types only
 in the private members, in which case they won't be in the generated public
 header.
 
+.SH BUILDING WITH MAKE
+.PP
+If you are using normal makefiles, what you need to do is to add a generic
+rule for .gob files.  So you would include the following in the Makefile
+and then just use the .c and .h files as usual (make sure the space
+before the 'gob' is a tab, not spaces):
+.nf
+
+  %.c %.h %-private.h: %.gob
+          gob $<
+
+.fi
+
+.SH BUILDING WITH AUTOCONF and AUTOMAKE
+.PP
+This is a little bit more involved.  Basically the first thing to do is to
+check for GOB in your configure.in file.  You can use the supplied m4 macro
+which will also check the version of gob.  Basically you include this:
+.nf
+
+  GOB_CHECK(0.93.4)
+
+.fi
+This will replace @GOB@ in your makefiles with the full path of gob.  Thus
+when adding the generic rule to your Makefile.am file, it should look like:
+.nf
+
+  %.c %.h %-private.h: %.gob
+          @GOB@ $<
+
+.fi
+.PP
+For Makefile.am you have to set up a couple more things.  First you have to
+include the generated .c and .h files into BUILT_SOURCES variable.  You
+have to include both the .gob and the .c and .h files in the SOURCES for your
+program.
+
 .SH BUGS
 .PP
 Also the lexer does not actually parse the C code, so I'm sure that some corner