From d48e4086d58daaa96328e17a362a9c6d07b73753 Mon Sep 17 00:00:00 2001 From: Martin Baulig Date: Tue, 11 Aug 1998 08:37:01 +0000 Subject: Some work on the documentation. --- doc/Makefile | 2 +- doc/autoconf.sgml | 253 +++++++++++++++++++++++++++++++++++ doc/gnome-hackers.sgml | 349 +++---------------------------------------------- doc/libgtopConf.sh | 35 +++++ 4 files changed, 307 insertions(+), 332 deletions(-) create mode 100644 doc/autoconf.sgml create mode 100644 doc/libgtopConf.sh (limited to 'doc') diff --git a/doc/Makefile b/doc/Makefile index ec8f2cc3..8d406a01 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -12,7 +12,7 @@ clean: -V %no-make-index% libgtop.sgml > /dev/null && \ touch .timestamp -.timestamp2: gnome-hackers.sgml +.timestamp2: gnome-hackers.sgml autoconf.sgml -rm -rf gnome-hackers mkdir gnome-hackers -rm -f .timestamp2 diff --git a/doc/autoconf.sgml b/doc/autoconf.sgml new file mode 100644 index 00000000..16bf1603 --- /dev/null +++ b/doc/autoconf.sgml @@ -0,0 +1,253 @@ + + Autoconf macros + + + All you need to check for &libgtop; is in &gnome-libgtop-check.m4;, + just use GNOME_INIT_LIBGTOP with an optional + fail argument in the same way like + GNOME_INIT: + + + Warn if &libgtop; cannot be found + + GNOME_INIT_LIBGTOP + + + + Abort if &libgtop; cannot be found + + GNOME_INIT_LIBGTOP(fail) + + + + This will define a HAVE_LIBGTOP automake + conditional and everything from the configuration script of + &libgtop;. + + + The configuration script of &libgtop; (&libgtopConf.sh;) + + + After a successful build of &libgtop;, a &libgtopConf.sh; script + containing useful configuration variables is created. + + + It defines the following variables which you can use in your + Makefile.am: + + + + LIBGTOP_LIBDIR + + + + The directory where the library files of &libgtop; are installed. + + + LIBGTOP_INCLUDEDIR + + + + The directory where the header files of &libgtop; are installed. + + + LIBGTOP_LIBS + + + + Use this to link your program with &libgtop;. + + + LIBGTOP_INCS + + + + Use this to get the header files for &libgtop;. + + + LIBGTOP_NAMES_LIBS + + + + Use this to link your program with &libgtop; and its + names interface. + + + LIBGTOP_NAMES_INCS + + + + Use this to get the header files for &libgtop; and the + required -DGLIBTOP_NAMES to get its + names interface. + + + LIBGTOP_GUILE_LIBS + + + + Use this to link your program with &libgtop; and its + guile interface. This will also include all the required + guile libraries. + + + LIBGTOP_GUILE_INCS + + + + Use this to get the header files for &libgtop; and guile + and the required -DGLIBTOP_GUILE to get + the guile interface of &libgtop;. + + + LIBGTOP_GUILE_NAMES_LIBS + + + + Use this to link your program with &libgtop; and both its + names and its guile interface. This will also include all the + required guile libraries. + + + LIBGTOP_GUILE_NAMES_INCS + + + + Use this to get the header files for &libgtop;, its guile + and its names interface, the guile header files and the + required -DGLIBTOP_GUILE and + -DGLIBTOP_NAMES. + + + LIBGTOP_BINDIR + + + + The directory where the binaries of &libgtop; are installed. + + + LIBGTOP_SERVER + + + + Full pathname of the &libgtop; server. + + + LIBGTOP_MAJOR_VERSION + + + + Major version of &libgtop;. + + + LIBGTOP_MINOR_VERSION + + + + Minor version of &libgtop;. + + + LIBGTOP_VERSION + + + + Full version of &libgtop;. + + + LIBGTOP_SERVER_VERSION + + + + Version of the &libgtop; server. This is incremented each + time the client/server protocol changes. + + + libgtop_sysdeps_dir + + + + The sysdeps directory that is used on your system. + + + libgtop_need_server + + + + Either yes or no. + + + libgtop_use_machine_h + + + + Either yes or no. + Intended for internal use only + and may be removed in future versions. + + + Note for &libgtop; hackers + + + This variable gets set in + macros/gnome-libgtop-sysdeps.m4. + + + If this is enabled, you need to put a + glibtop_machine.h header file in the + sysdeps directory which needs to define a structure of + type glibtop_machine. + + + This structure represents the + machine field of + glibtop defined in + glibtop.h + and can be used to store some + machine dependent data. + + + + libgtop_guile_found + + + + Either yes or no. + + + libgtop_want_examples + + + + Considered obsolete. + + + + + All this variables are taken from the + &libgtopConf.sh; script which is created during + the installation of &libgtop;. + + + + Sample &libgtopConf.sh; (gnome and guile are installed in + <filename>/home/baulig/INSTALL</filename> and &libgtop; in + <filename>/home/norwegen/TEST</filename>) + + + &example-libgtopConf-sh; + + + + + diff --git a/doc/gnome-hackers.sgml b/doc/gnome-hackers.sgml index 71fbfaff..3132b708 100644 --- a/doc/gnome-hackers.sgml +++ b/doc/gnome-hackers.sgml @@ -1,12 +1,16 @@ + + +macros/gnome-libgtop-check.m4"> +libgtopConf.sh"> +libgtop"> ]> - Using LibGTop in the Gnome Project + Using Libgtop in the Gnome Project Martin @@ -22,7 +26,7 @@ 1998 Martin Baulig - + @@ -47,13 +51,15 @@ For more details see the file COPYING in the source - distribution of LibGTop. + distribution of &libgtop;. - $Id$ + + $Id$ + This is a short introduction in how to use @@ -62,11 +68,6 @@ takes and the information stored in the automatically generated libgtopConf.sh configuration script. - - - This document is currently out of date. - - Documentation about the new table () @@ -86,329 +87,10 @@ - - Autoconf macros - - - <filename>macros/gnome-libgtop-check.m4</filename> - - - Contains all that you need to include libgtop in any Gnome application. It defines - GNOME_INIT_LIBGTOP which you can use in the same way like - GNOME_INIT to check whether libgtop is installed and to read - its libgtopConf.sh script. It automatically invokes - GNOME_LIBGTOP_SYSDEPS. - - - When libgtop can be found, it defines HAVE_LIBGTOP. There's - also an automake conditional HAVE_LIBGTOP which you can use. - - - <filename>macros/gnome-libgtop-sysdeps.m4</filename> - - - This file defines GNOME_LIBGTOP_SYSDEPS which you can - use to check which sysdeps directory libgtop should - use and whether the gtop_server is needed. - - - It defines the following variables: - - - - - libgtop_sysdeps_dir - - - - The sysdeps dir libgtop uses. - - - libgtop_use_machine_h - - - - Some of the system dependent parts of libgtop - provide a structure _glibtop_machine defined in - a header file glibtop_machine.h they provide. This - structure gets inserted into the machine member - of _glibtop when config.h - defines HAVE_GLIBTOP_MACHINE_H. - - - This variable is either yes or no and - tells you whether this is the case. If it is true, this macro wil automatically - define HAVE_GLIBTOP_MACHINE_H. - - - libgtop_need_server - - - - Is either yes or no and tells you - whether the server is needed. If it is needed, it will automatically - define NEED_LIBGTOP. - - - This macro also provides a conditional NEED_LIBGTOP - which you can use in you Makefile.am. - - - - - - + Configuration - - The configure script of libgtop - takes some non-standard options to let you decide which parts of the library - should be build. - - - - - - Normally, configure decides whether or not using the - server is required. Depending upon this decision, it adds either - -lgtop (when it's needed) or - -lgtop_systems (when it's not needed) to - LIBGTOP_LIBS and LIBGTOP_GUILE_LIBS. - - - You can change this behaviour with the following options: - - - - - --enable-libgtop-server - - - - Use the server regardless whether or not it is required. - - - --disable-libgtop-server - - - - Do not use the server regardless wheter or not it is required. - - - - - - - Normally, the guile interface of libgtop is build - when guile can be found on the system. - - - - - --disable-libgtop-guile - - - - Disables building the guile interface even if you have - guile installed. - - - --enable-libgtop-guile - - - - Has no effect at all since you cannot build the guile interface without - having guile installed on your system. - - - - - - - If you do not need the names subdirs, you can disable - their building with the following option: - - - - - --disable-libgtop-names - - - - Disables building of the names subdirs. - - - --enable-libgtop-names - - - - Is the default. - - - - - If it is enables, GLIBTOP_NAMES will be defined. - - - - - To disable building of the examples, you can say: - - - - - --without-examples - - - - Disables building of the examples. - - - - - - - The <filename>libgtopConf.sh</filename> script - - - After a successful build of libgtop, a - libgtopConf.sh script is generated which will later - be used to decide how to link a program with libgtop. - - - It defines the following variables: - - - - - LIBGTOP_LIBDIR - - - - Defaults to $(prefix)/lib. It is the directory - where the libgtop libraries get installed. - - - LIBGTOP_INCLUDEDIR - - - - Defaults to $(prefix)/include. It is the directory - where the libgtop header files get installed. - - - LIBGTOP_LIBS - - - - Contains everything that you need to add to the _LDADD - variable of automake to link a program with - libgtop. - - - LIBGTOP_INCS - - - - Contains everything that you need to add to the _INCLUDES - variable of automake to compile a program that uses - libgtop. - - - LIBGTOP_GUILE_INCS - - - - Contains everything that you need to add to the _INCLUDES - variable of automake to compile a program that uses both - libgtop and its guile interface. - - - LIBGTOP_BINDIR - - - - Defaults to $(bindir). It is the directory where the - libgtop binaries get installed. - - - LIBGTOP_SERVER - - - - Defaults to $(bindir)/gtop_server. It is the full pathname - where the server gets installed. - - - libgtop_sysdeps_dir - - - - The sysdeps directory that is used on your system. - - - libgtop_need_server - - - - Is either yes or no and tells you - whether using the server is needed or not. - - - libgtop_use_machine_h - - - - Is either yes or no and tells you - whether glibtop_machine_h should be included in - glibtop.h. - - The system dependent part of the library may provide an additional header - file, glibtop_machine_h. In this case, they define - a structure _glibtop_machine in this header file. - This structure represents the machine member of - _glibtop. - - - libgtop_guile_found - - - - Is either yes or no and tells you - whether guile has been found on your system - (or if building the guile interface was disabled). - - - libgtop_want_names - - - - Is either yes or no and tells you - whether the sysdeps/names subdirectory was build. - - - libgtop_want_guile_names - - - - Is either yes or no and tells you - whether the sysdeps/guile/names subdirectory was build. - - - libgtop_want_examples - - - - Is either yes or no and tells you - whether the examples were build. - - - - - Sample <filename>libgtopConf.sh</filename> - - &libgtopConf.sh; - + &autoconf.sgml; @@ -416,6 +98,11 @@ diff --git a/doc/libgtopConf.sh b/doc/libgtopConf.sh new file mode 100644 index 00000000..0fc78273 --- /dev/null +++ b/doc/libgtopConf.sh @@ -0,0 +1,35 @@ +# +# Configuration of the libgtop package +# + +LIBGTOP_LIBDIR="/home/baulig/TEST/lib" +LIBGTOP_INCLUDEDIR="/home/baulig/TEST/include" + +LIBGTOP_LIBS="-L/home/baulig/TEST/lib -lgtop -lgtop_common -lgtop_sysdeps -L/usr/X11R6/lib -lXau" +LIBGTOP_INCS="-I/home/baulig/TEST/include" + +LIBGTOP_NAMES_LIBS="-L/home/baulig/TEST/lib -lgtop -lgtop_common -lgtop_sysdeps -lgtop_names -L/usr/X11R6/lib -lXau" +LIBGTOP_NAMES_INCS="-I/home/baulig/TEST/include -DGLIBTOP_NAMES" + +LIBGTOP_GUILE_LIBS="-L/home/baulig/TEST/lib -lgtop -lgtop_guile -lgtop_common -lgtop_sysdeps -L/usr/X11R6/lib -lXau -L/home/baulig/INSTALL/lib -lguile -ldl -lreadline -ltermcap -lm" +LIBGTOP_GUILE_INCS="-I/home/baulig/TEST/include -I/home/baulig/INSTALL/include -DGLIBTOP_GUILE" + +LIBGTOP_GUILE_NAMES_LIBS="-L/home/baulig/TEST/lib -lgtop -lgtop_guile -lgtop_common -lgtop_sysdeps -lgtop_names -L/usr/X11R6/lib -lXau" +LIBGTOP_GUILE_NAMES_INCS="-I/home/baulig/TEST/include -I/home/baulig/INSTALL/include -DGLIBTOP_GUILE -DGLIBTOP_NAMES" + +LIBGTOP_BINDIR="/home/baulig/TEST/bin" +LIBGTOP_SERVER="/home/baulig/TEST/bin/libgtop_server" + +LIBGTOP_MAJOR_VERSION="0" +LIBGTOP_MINOR_VERSION="2a" +LIBGTOP_VERSION="0.2a" + +LIBGTOP_SERVER_VERSION="1" + +libgtop_sysdeps_dir="linux" +libgtop_need_server="no" +libgtop_use_machine_h="no" + +libgtop_guile_found="yes" + +libgtop_want_examples="" -- cgit v1.2.1