X-Git-Url: http://erislabs.net/gitweb/?a=blobdiff_plain;f=doc%2Fgnulib.texi;h=22b4cf7e228b6b7ca3f2a1d99f85776ffab9f8e5;hb=d7b344a2c6c70623de8fcdac7d129a4a2bad53e2;hp=23638c774699b376b33638c71d73b5c7d5337426;hpb=4b91fb1bb6aa7be4352e8a39e6453a4e90726d92;p=gnulib.git diff --git a/doc/gnulib.texi b/doc/gnulib.texi index 23638c774..22b4cf7e2 100644 --- a/doc/gnulib.texi +++ b/doc/gnulib.texi @@ -1,5 +1,5 @@ \input texinfo @c -*-texinfo-*- -@comment $Id: gnulib.texi,v 1.26 2006-07-19 21:48:14 dprice Exp $ +@comment $Id: gnulib.texi,v 1.31 2007-01-03 18:51:20 karl Exp $ @comment %**start of header @setfilename gnulib.info @settitle GNU Gnulib @@ -7,28 +7,21 @@ @syncodeindex pg cp @comment %**end of header -@set UPDATED $Date: 2006-07-19 21:48:14 $ +@set UPDATED $Date: 2007-01-03 18:51:20 $ @copying This manual is for GNU Gnulib (updated @value{UPDATED}), which is a library of common routines intended to be shared at the source level. -Copyright @copyright{} 2004, 2005, 2006 Free Software Foundation, Inc. +Copyright @copyright{} 2004, 2005, 2006, 2007 Free Software Foundation, Inc. -@quotation Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation; with no -Invariant Sections, with the Front-Cover Texts being ``A GNU Manual,'' -and with the Back-Cover Texts as in (a) below. A copy of the -license is included in the section entitled ``GNU Free Documentation -License.'' - -(a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify -this GNU Manual, like GNU software. Copies published by the Free -Software Foundation raise funds for GNU development.'' -@end quotation +Invariant Sections, with no Front-Cover Texts, and with no Back-Cover +Texts. A copy of the license is included in the section entitled +``GNU Free Documentation License.'' @end copying @dircategory Software development @@ -55,21 +48,22 @@ Software Foundation raise funds for GNU development.'' @end ifnottex @menu -* Gnulib:: +* Introduction:: * Invoking gnulib-tool:: +* Miscellaneous Notes:: +* Particular Modules:: Documentation of Individual Modules * Copying This Manual:: * Index:: @end menu +@node Introduction +@chapter Introduction -@node Gnulib -@chapter Gnulib +Gnulib is a source code library. It provides basic functionalities to +programs and libraries. Currently (as of October 2006) more than 30 +packages make use of Gnulib. -This manual contains some bare-bones documentation, but not much more. -It's mostly been a place to store notes until someone (you?)@ gets -around to writing a coherent manual. - -Getting started: +Resources: @itemize @item Gnulib is hosted at Savannah: @@ -80,17 +74,33 @@ Getting started: @end itemize @menu +* Library vs. Reusable Code:: +* Portability and Application Code:: +* Modules:: +* Various Kinds of Modules:: +* Collaborative Development:: +* Copyright:: +* Steady Development:: +* Openness:: +@end menu + +@include gnulib-intro.texi + + +@include gnulib-tool.texi + + +@node Miscellaneous Notes +@chapter Miscellaneous Notes + +@menu * Comments:: * Header files:: -* Quoting:: -* ctime:: -* inet_ntoa:: -* gcd:: * Out of memory handling:: * Library version handling:: -* Regular expressions:: * Windows sockets:: * Libtool and Windows:: +* License Texinfo sources:: @end menu @@ -180,15 +190,6 @@ arbitrary order. @end itemize -@include quote.texi - -@include ctime.texi - -@include gcd.texi - -@include inet_ntoa.texi - - @node Out of memory handling @section Out of memory handling @@ -285,17 +286,6 @@ Typical uses look like: @end example -@node Regular expressions -@section Regular expressions - -Gnulib supports many different types of regular expressions; although -the underlying features are the same or identical, the syntax used -varies. The descriptions given here for the different types are -generated automatically. - -@include regexprops-generic.texi - - @node Windows sockets @section Windows sockets @@ -328,6 +318,7 @@ Todo: Make getaddrinfo.c open the WS2_32.DLL and check for the getaddrinfo symbol and use it if present, otherwise fall back to our own implementation. + @node Libtool and Windows @section Libtool and Windows @@ -349,7 +340,48 @@ library. From a @file{Makefile.am}: libgsasl_la_LDFLAGS += -no-undefined @end example -@include gnulib-tool.texi + +@node License Texinfo sources +@section License Texinfo sources + +Gnulib provides copies of the GNU GPL, GNU LGPL, and GNU FDL licenses +in Texinfo form. (The master location is +@url{http://www.gnu.org/licenses/}). These Texinfo documents have +various node names and structures built into them; for your manual, +you might like to change these. It's ok to do this, and a convenient +way to do so is to use a context diff and the @option{--local-dir} +option to @command{gnulib-tool}. + +Of course the license texts themselves should not be changed at all. + + +@node Particular Modules +@chapter Particular Modules + +@menu +* Quoting:: +* ctime:: +* error and progname:: +* gcd:: +* inet_ntoa:: +* Regular expressions:: +@end menu + +@include quote.texi +@include error.texi +@include ctime.texi +@include gcd.texi +@include inet_ntoa.texi + +@node Regular expressions +@section Regular expressions + +Gnulib supports many different types of regular expressions; although +the underlying features are the same or identical, the syntax used +varies. The descriptions given here for the different types are +generated automatically. + +@include regexprops-generic.texi @node Copying This Manual