diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/info/appx/fdl.texinfo (renamed from doc/info/fdl.texinfo) | 0 | ||||
| -rw-r--r-- | doc/info/appx/gpl.texinfo (renamed from doc/info/gpl.texinfo) | 0 | ||||
| -rw-r--r-- | doc/info/content.texinfo | 101 | ||||
| -rw-r--r-- | doc/info/hardcopy-copying.texinfo | 35 | ||||
| -rw-r--r-- | doc/info/macros.texinfo | 31 | ||||
| -rw-r--r-- | doc/info/reusable/macros.texinfo | 48 | ||||
| -rw-r--r-- | doc/info/reusable/paper.texinfo | 109 | ||||
| -rw-r--r-- | doc/info/reusable/titlepage.texinfo | 79 | ||||
| -rw-r--r-- | doc/info/slibc.texinfo | 280 | ||||
| -rw-r--r-- | doc/info/titlepage-data.texinfo | 24 |
10 files changed, 419 insertions, 288 deletions
diff --git a/doc/info/fdl.texinfo b/doc/info/appx/fdl.texinfo index 9c3bbe5..9c3bbe5 100644 --- a/doc/info/fdl.texinfo +++ b/doc/info/appx/fdl.texinfo diff --git a/doc/info/gpl.texinfo b/doc/info/appx/gpl.texinfo index c773b1d..c773b1d 100644 --- a/doc/info/gpl.texinfo +++ b/doc/info/appx/gpl.texinfo diff --git a/doc/info/content.texinfo b/doc/info/content.texinfo new file mode 100644 index 0000000..db098c9 --- /dev/null +++ b/doc/info/content.texinfo @@ -0,0 +1,101 @@ +@c This file includes everything after the titlepage. + + +@defcodeindex op +@defcodeindex hf +@defcodeindex lv + + + +@ifnothtml +@shortcontents +@contents +@end ifnothtml + + +@menu +* Introduction:: Introduction to @command{slibc} and this manual. +* Language facilities:: C language facilities provided by the library. +* Error reporting:: Detecting, reporting, and printing errors. +* Integer types:: Portable and descriptive integer types. +* Memory allocation:: How to give your process or memory. + +* Free Software Needs Free Documentation:: Why free documentation is important. +* GNU General Public License:: Copying and sharing @command{slibc}. +* GNU Free Documentation License:: Copying and sharing this manual. + +* Concept index:: Index of concepts. +* Option index:: Index of command line options. +* Program index:: Index of utilities. +* Variable index:: Index of environment variables. +* Header file index:: Index of header files. +* Data type index:: Index of data types. +* LValue index:: Index of all types of lvalues. +* Function index:: Index of functions and callable macros. +@end menu +@c In GNU Emacs a @detailmenu can be created with `C-c C-u m`. +@c TODO @detailmenu + + + +@include chap/introduction.texinfo +@include chap/language-facilities.texinfo +@include chap/error-reporting.texinfo +@include chap/integer-types.texinfo +@include chap/memory-allocation.texinfo + + + +@include appx/free-software-needs-free-documentation.texinfo + +@node GNU General Public License +@appendix GNU General Public License +@include appx/gpl.texinfo + +@node GNU Free Documentation License +@appendix GNU Free Documentation License +@include appx/fdl.texinfo + + + +@node Concept index +@unnumbered Concept index +Index of concepts. +@printindex cp + +@node Option index +@unnumbered Option index +Index of command line options. +@printindex op + +@node Program index +@unnumbered Program index +Index of utilities. +@printindex pg + +@node Variable index +@unnumbered Variable index +Index of environment variables. +@printindex vr + +@node Header file index +@unnumbered Header file index +Index of header files. +@printindex hf + +@node Data type index +@unnumbered Data type index +Index of type definitions, structures, unions, enumerations, +and built in data types. +@printindex tp + +@node LValue index +@unnumbered LValue index +Index of variables, constant preprocessor values, and lvalue macros. +@printindex lv + +@node Function index +@unnumbered Function index +Index of functions and callable macros. +@printindex fn + diff --git a/doc/info/hardcopy-copying.texinfo b/doc/info/hardcopy-copying.texinfo index ada83ef..b56c2fb 100644 --- a/doc/info/hardcopy-copying.texinfo +++ b/doc/info/hardcopy-copying.texinfo @@ -1,18 +1,27 @@ @c --- This is a template for the hardcopy-copying.texinfo file. --- +@c Uncomment this when dead tree editions can be ordered. +@c @set HARDCOPY_AVAILABLE + + +@set PRINTINGNUMBER First +@set PRINTINGDATE Januari 0000 +@set ISBNNUMBER 0000000000 + +@ifset HARDCOPY @copying @ifset VERSION -This manual documents the Stockholm C Standard Library version @value{VERSION}@. +This manual documents @value{programnamewiththe} version @value{VERSION}@. @end ifset @ifclear VERSION -This manual documents the Stockholm C Standard Library. +This manual documents @value{programnamewiththe}. @end ifclear @* @ifset EDITION -@sc{ISBN} 0000000000, @value{EDITION} Edition, First Printing, Januari 0000. +@sc{ISBN} @value{ISBNNUMBER}, @value{EDITION} Edition, @value{PRINTINGNUMBER} Printing, @value{PRINTINGDATE}. @end ifset @ifclear EDITION -@sc{ISBN} 0000000000, First Printing, Januari 0000. +@sc{ISBN} @value{ISBNNUMBER}, @value{PRINTINGNUMBER} Printing, @value{PRINTINGDATE}. @end ifclear @* @@ -25,6 +34,8 @@ X Copyright @copyright{} 2015 Mattias Andrée @e{maandree@@member.fsf.org} @* +@c The copyright information from the main file, add any required +@c Invariant Sections being used on the dead tree edition. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version@tie{}1.3 or any later version published by the Free Software Foundation; @@ -36,8 +47,24 @@ 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''. +@c THIS WAS LAST UPPDATE 2015-DECEMBER-08 UTC +@c AUTHORITATIVE COPYRIGHT INFORMATION IS AVAILABLE +@c IN scrotty.texinfo. THIS FILL MUST BE UPDATED +@c BEFORE PRINTING. @* Cover art by XY Z. Cover design by XY Z. Printed in XYZ. @end copying +@end ifset + + + +@ifclear HARDCOPY +@ifset HARDCOPY_AVAILABLE +@macro orderhardcopy{} +If you prefer a dead tree edition, you can order one from +... +@endif +@end ifset +@end ifclear diff --git a/doc/info/macros.texinfo b/doc/info/macros.texinfo deleted file mode 100644 index 1798d76..0000000 --- a/doc/info/macros.texinfo +++ /dev/null @@ -1,31 +0,0 @@ -@iftex -@macro e{a} -(@email{\a\}) -@end macro -@end iftex -@ifnottex -@macro e{a} -@email{\a\} -@end macro -@end ifnottex - -@iftex -@macro xrm{} -@rm{} -@end macro -@end iftex -@ifnottex -@macro xrm{} -@end macro -@end ifnottex - -@iftex -@macro xtt{} -@tt{} -@end macro -@end iftex -@ifnottex -@macro xtt{} -@end macro -@end ifnottex - diff --git a/doc/info/reusable/macros.texinfo b/doc/info/reusable/macros.texinfo new file mode 100644 index 0000000..8d95983 --- /dev/null +++ b/doc/info/reusable/macros.texinfo @@ -0,0 +1,48 @@ +@c GENERAL ADVICE. +@c Because of an previous regression bug in Texinfo +@c it is a good idea to use @w around lines using +@c macros. + + +@c Use this comment to get a good looking e-mail +@c address in both the info output and the TeX +@c processed output. +@iftex +@macro e{a} +(@email{\a\}) +@end macro +@end iftex +@ifnottex +@macro e{a} +@email{\a\} +@end macro +@end ifnottex + +@c This is intented do be used inside @example. +@c At the beginning of non-code text in a source +@c code comment, use this macro to make it look +@c good in TeX processed output. End with @xtt. +@iftex +@macro xrm{} +@rm{} +@end macro +@end iftex +@ifnottex +@macro xrm{} +@end macro +@end ifnottex + +@c This is intented do be used inside @example. +@c At the end of non-code text in a source code +@c comment, use this macro to make it look +@c good in TeX processed output. +@iftex +@macro xtt{} +@tt{} +@end macro +@end iftex +@ifnottex +@macro xtt{} +@end macro +@end ifnottex + diff --git a/doc/info/reusable/paper.texinfo b/doc/info/reusable/paper.texinfo new file mode 100644 index 0000000..5a6aca8 --- /dev/null +++ b/doc/info/reusable/paper.texinfo @@ -0,0 +1,109 @@ +@c This file is used, by inclusion, to allow the +@c builder to specify how output shall be formatted. + +@c On dead tree editions we defailt to smallbook format. +@ifset HARDCOPY +@ifclear USLETTER +@ifclear AFOURPAPER +@ifclear AFIVEPAPER +@ifclear SMALLBOOK +@set SMALLBOOK +@end ifclear +@end ifclear +@end ifclear +@end ifclear +@end ifset + +@c On dead tree editions the heading on the left page +@c is different from the heading on the right page. +@c On online editions the heading is identical on the +@c left pages and on the right pages. +@ifclear SINGLE_HEADINGS +@ifclear DOUBLE_HEADINGS +@ifclear HARDCOPY +@set SINGLE_HEADINGS +@end ifclear +@ifset HARDCOPY +@set DOUBLE_HEADINGS +@end ifset +@end ifclear +@end ifclear + +@c Apply paper format. Default to A4. (Remember +@c dead tree editions defaulted to smallbook.) +@ifset AFIVEPAPER +@afivepaper +@end ifset +@ifset SMALLBOOK +@smallbook +@end ifset +@ifclear AFIVEPAPER +@ifclear SMALLBOOK +@ifclear USLETTER +@afourpaper +@set AFOURPAPER +@end ifclear +@end ifclear +@end ifclear +@c (Texinfo defaults to US letter, thus nothing is +@c done for USLETTER.) + +@c Only on dead tree editions: optionally add +@c cropmarks, and by default, chapters begin +@c on odd page numbers (the right side.) +@ifset HARDCOPY +@ifset CROPMARKS +@cropmarks +@end ifset +@ifclear SKIPCHAPTERNEWPAGE +@setchapternewpage odd +@end ifclear +@end ifset + +@c Apply font size. On smallbook and A5 default to +@c 10 points, on A4 and US letter we default to +@c 11 points. +@ifclear SKIPFONTTEXTSIZE +@ifset SMALLBOOK +@set SMALLFONT +@end ifset +@ifset AFIVEPAPER +@set SMALLFONT +@end ifset +@end ifclear +@ifset SMALLFONT +@fonttextsize 10 +@end ifset +@ifclear SMALLFONT +@iftex @c Because of bug in Texinfo<=4.13 +@fonttextsize 11 +@end iftex +@end ifclear + +@c In America it is customary to have two spaces after +@c a period. It is not elsewhere. (@frenchspacing is a +@c misnomer) +@ifclear AMERICANSPACING +@frenchspacing on +@end ifclear + +@c This should only be used when writting the document. +@c It is used to locate overflows. It should be be used +@c in a printed version. It can be used in an online come +@c use users can easier detect overflows and report them. +@ifclear NOFINALOUT +@finalout +@end ifclear + + +@c Call this macro after the title page, but before the +@c table of content, or the short table of content. +@macro setheadings{} +@ifset DOUBLEHEADINGS +@headings double +@end ifset +@ifset SINGLEHEADINGS +@headings single +@end ifset +@end macro + diff --git a/doc/info/reusable/titlepage.texinfo b/doc/info/reusable/titlepage.texinfo new file mode 100644 index 0000000..55981f7 --- /dev/null +++ b/doc/info/reusable/titlepage.texinfo @@ -0,0 +1,79 @@ +@c This file @top or @titlepage. + +@ifnottex +@node Top +@top @value{title} -- @value{subtitle} +@insertcopying +@end ifnottex + +@titlepage +@title @value{title} +@subtitle @value{subtitle} + +@c Date, edition, and version of the program. +@c Should be set on dead tree editions. Not too +@c important on online editions. +@ifset DATE +@ifset VERSION +@ifset EDITION +@subtitle @value{DATE}, @value{programname} version@tie{}@value{VERSION}, @value{EDITION} edition +@end ifset +@ifclear EDITION +@subtitle @value{DATE}, @value{programname} version@tie{}@value{VERSION} +@end ifclear +@end ifset +@ifclear VERSION +@ifset EDITION +@subtitle @value{DATE}, @value{EDITION} edition +@end ifset +@ifclear EDITION +@subtitle @value{DATE} +@end ifclear +@end ifclear +@end ifset +@ifclear DATE +@ifset VERSION +@ifset EDITION +@subtitle @value{programname} version@tie{}@value{VERSION}, @value{EDITION} edition +@end ifset +@ifclear EDITION +@subtitle @value{programname} version@tie{}@value{VERSION} +@end ifclear +@end ifset +@ifclear VERSION +@ifset EDITION +@subtitle @value{EDITION} edition +@end ifset +@end ifclear +@end ifclear + +@ifset LOGO +@vskip 0pt plus 1filll +@c This way, it is centered exactly in pdf and approximently +@c in dvi and ps. @center does not work for @image in dvi and ps. +@multitable @columnfractions 0.15 0.7 +@item @tab @center @image{../logo,250px} +@end multitable +@vskip 0pt plus 2filll +@end ifset +@authors{} + +@page +@ifset HARDCOPY +@vskip 0pt plus 1filll +@insertcopying +@page +@end ifset +@ifset HAVE_DEDICATION +@dedication{} +@end ifset +@ifclear HARDCOPY +@vskip 0pt plus 1filll +@ifset HARDCOPY_AVAILABLE +@orderhardcopy{} +@* +@end ifset +@insertcopying +@end ifclear +@end titlepage + diff --git a/doc/info/slibc.texinfo b/doc/info/slibc.texinfo index 9af14fe..9a45ce1 100644 --- a/doc/info/slibc.texinfo +++ b/doc/info/slibc.texinfo @@ -1,7 +1,7 @@ \input texinfo @c -*-texinfo-*- @c %**start of header @documentencoding UTF-8 -@include macros.texinfo +@include reusable/macros.texinfo @copying @c -------------------------------------------------------------------------------- Copyright @copyright{} 2015 @w{Mattias Andrée @e{maandree@@member.fsf.org}} @@ -16,6 +16,7 @@ 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 quotation @c THIS WAS LAST CHANGED 2015-OCTOBER-12 +@c When updated, please remember to update hardcopy-copying.texinfo too. @c -------------------------------------------------------------------------------- @end copying @@ -23,7 +24,25 @@ license is included in the section entitled ``GNU Free Documentation License''. @setfilename slibc.info @settitle slibc -- Stockholm C Standard Library @documentlanguage en_GB -@finalout +@include titlepage-data.texinfo + +@c You can change the title of the document in dir by compiling with +@c INFO_FLAGS='-c CATEGORY=your_new_category' +@ifclear CATEGORY +@set CATEGORY Multimedia +@end ifclear + +@dircategory @value{CATEGORY} +@direntry +* slibc: (slibc). @value{subtitle} +@end direntry + +@documentdescription +Developer and maintainer manual for the +Stockholm C Standard Library. +@end documentdescription +@c %**end of header + @iftex @c @set USLETTER @@ -40,6 +59,7 @@ license is included in the section entitled ``GNU Free Documentation License''. @c @set DOUBLE_HEADINGS @c @set SINGLE_HEADINGS @c @set AMERICANSPACING +@c @set FINALOUT @ignore @@ -65,87 +85,13 @@ license is included in the section entitled ``GNU Free Documentation License''. @end ignore -@ifset HARDCOPY -@ifclear USLETTER -@ifclear AFOURPAPER -@ifclear AFIVEPAPER -@ifclear SMALLBOOK -@set SMALLBOOK -@end ifclear -@end ifclear -@end ifclear -@end ifclear -@end ifset - -@ifclear SINGLE_HEADINGS -@ifclear DOUBLE_HEADINGS -@ifclear HARDCOPY -@set SINGLE_HEADINGS -@end ifclear -@ifset HARDCOPY -@set DOUBLE_HEADINGS -@end ifset -@end ifclear -@end ifclear - -@ifset AFIVEPAPER -@afivepaper -@end ifset -@ifset SMALLBOOK -@smallbook -@end ifset -@ifclear AFIVEPAPER -@ifclear SMALLBOOK -@ifclear USLETTER -@afourpaper -@set AFOURPAPER -@end ifclear -@end ifclear -@end ifclear - -@ifset HARDCOPY -@ifset CROPMARKS -@cropmarks -@end ifset -@ifclear SKIPCHAPTERNEWPAGE -@setchapternewpage odd -@end ifclear -@end ifset - -@ifclear SKIPFONTTEXTSIZE -@ifset SMALLBOOK -@set SMALLFONT -@end ifset -@ifset AFIVEPAPER -@set SMALLFONT -@end ifset -@end ifclear -@ifset SMALLFONT -@fonttextsize 10 -@end ifset -@ifclear SMALLFONT -@fonttextsize 11 -@end ifclear - -@ifclear AMERICANSPACING -@frenchspacing on -@end ifclear - +@comment You can see these too with TEXINFO_FLAGS. @c @paragraphindent asis @c @firstparagraphindent none @c @exampleindent asis @c @kbdinputstyle distinct -@dircategory Library -@direntry -* slibc: (slibc). Stockholm C Standard Library. -@end direntry - -@documentdescription -Developer and maintainer manual for the -Stockholm C Standard Library. -@end documentdescription -@c %**end of header +@include reusable/paper.texinfo @@ -195,183 +141,11 @@ Stockholm C Standard Library. -@defcodeindex op -@defcodeindex hf -@defcodeindex lv - - - -@ifset HARDCOPY @include hardcopy-copying.texinfo -@end ifset - -@ifnottex -@node Top -@top slibc -- Stockholm C Standard Library -@insertcopying -@end ifnottex - -@titlepage -@title Stockholm C Standard Library -@subtitle The @command{slibc} reference manual - -@ifset DATE -@ifset VERSION -@ifset EDITION -@subtitle @value{DATE}, Stockholm C Standard Library version@tie{}@value{VERSION}, @value{EDITION} edition -@end ifset -@ifclear EDITION -@subtitle @value{DATE}, Stockholm C Standard Library version@tie{}@value{VERSION} -@end ifclear -@end ifset -@ifclear VERSION -@ifset EDITION -@subtitle @value{DATE}, @value{EDITION} edition -@end ifset -@ifclear EDITION -@subtitle @value{DATE} -@end ifclear -@end ifclear -@end ifset -@ifclear DATE -@ifset VERSION -@ifset EDITION -@subtitle Stockholm C Standard Library version@tie{}@value{VERSION}, @value{EDITION} edition -@end ifset -@ifclear EDITION -@subtitle Stockholm C Standard Library version@tie{}@value{VERSION} -@end ifclear -@end ifset -@ifclear VERSION -@ifset EDITION -@subtitle @value{EDITION} edition -@end ifset -@end ifclear -@end ifclear - -@ifset LOGO -@vskip 0pt plus 1filll -@comment this way, it is centered exactly in pdf and approximently in dvi and ps -@comment @center does not work for @image in dvi and ps -@multitable @columnfractions 0.15 0.7 -@item @tab @center @image{../logo,250px} -@end multitable -@vskip 0pt plus 2filll -@end ifset -@author by Mattias Andrée (maandree) - -@page -@ifset HARDCOPY -@vskip 0pt plus 1filll -@insertcopying -@page -@end ifset -@c TODO I do not have a quote for this manual yet. -@c @center `' -@ifclear HARDCOPY -@vskip 0pt plus 1filll -@c If you prefer a dead tree edition, you can order one from -@c ... -@c @* -@insertcopying -@end ifclear -@end titlepage - -@ifset DOUBLE_HEADINGS -@headings double -@end ifset -@ifset SINGLE_HEADINGS -@headings single -@end ifset - -@shortcontents -@contents - - - -@menu -* Introduction:: Introduction to @command{slibc} and this manual. -* Language facilities:: C language facilities provided by the library. -* Error reporting:: Detecting, reporting, and printing errors. -* Integer types:: Portable and descriptive integer types. -* Memory allocation:: How to give your process or memory. - -* Free Software Needs Free Documentation:: Why free documentation is important. -* GNU General Public License:: Copying and sharing @command{slibc}. -* GNU Free Documentation License:: Copying and sharing this manual. - -* Concept index:: Index of concepts. -* Option index:: Index of command line options. -* Program index:: Index of utilities. -* Variable index:: Index of environment variables. -* Header file index:: Index of header files. -* Data type index:: Index of data types. -* LValue index:: Index of all types of lvalues. -* Function index:: Index of functions and callable macros. -@end menu -@c TODO @detailmenu (`C-c C-u m`) - - - -@include chap/introduction.texinfo -@include chap/language-facilities.texinfo -@include chap/error-reporting.texinfo -@include chap/integer-types.texinfo -@include chap/memory-allocation.texinfo - - - -@include appx/free-software-needs-free-documentation.texinfo - -@node GNU General Public License -@appendix GNU General Public License -@include gpl.texinfo - -@node GNU Free Documentation License -@appendix GNU Free Documentation License -@include fdl.texinfo - - -@node Concept index -@unnumbered Concept index -Index of concepts. -@printindex cp - -@node Option index -@unnumbered Option index -Index of command line options. -@printindex op - -@node Program index -@unnumbered Program index -Index of utilities. -@printindex pg - -@node Variable index -@unnumbered Variable index -Index of environment variables. -@printindex vr - -@node Header file index -@unnumbered Header file index -Index of header files. -@printindex hf - -@node Data type index -@unnumbered Data type index -Index of type definitions, structures, unions, enumerations, -and built in data types. -@printindex tp - -@node LValue index -@unnumbered LValue index -Index of variables, constant preprocessor values, and lvalue macros. -@printindex lv +@include reusable/titlepage.texinfo +@setheadings{} -@node Function index -@unnumbered Function index -Index of functions and callable macros. -@printindex fn +@include content.texinfo @bye diff --git a/doc/info/titlepage-data.texinfo b/doc/info/titlepage-data.texinfo new file mode 100644 index 0000000..271c119 --- /dev/null +++ b/doc/info/titlepage-data.texinfo @@ -0,0 +1,24 @@ +@c The title and the subtitle of the manual. +@set title Stockholm C Standard Library +@set subtitle The @command{slibc} reference manual + +@c The full name of the documented program or package. +@set programname Stockholm C Standard Library +@set programnamewiththe the Stockholm C Standard Library + + +@c Authors of the manual. Included at the bottom +@c of the titlepage on TeX processed output. +@macro authors{} +@author by Mattias Andrée (maandree) +@end macro + + +@c Dedication for TeX processed output. +@c @set HAVE_DEDICATION +@c @macro dedication{} +@c TODO I do not have a quote for this manual yet. +@c @center `' +@c @end macro +@c (I don't use dedications, I use quotes.) + |