From 5707fcd8e16694462de32e07113eb35a1c76a9ab Mon Sep 17 00:00:00 2001 From: Simon Josefsson Date: Thu, 5 Aug 2004 04:27:55 +0000 Subject: Add. --- doc/gendocs.sh | 274 +++++++++++++++++++++++++++++++++++++++++++++++++++ doc/gendocs_template | 101 +++++++++++++++++++ doc/gnutls-logo.eps | 154 +++++++++++++++++++++++++++++ doc/gnutls-logo.pdf | Bin 0 -> 3159 bytes 4 files changed, 529 insertions(+) create mode 100755 doc/gendocs.sh create mode 100755 doc/gendocs_template create mode 100644 doc/gnutls-logo.eps create mode 100644 doc/gnutls-logo.pdf diff --git a/doc/gendocs.sh b/doc/gendocs.sh new file mode 100755 index 0000000000..f0b90d53a6 --- /dev/null +++ b/doc/gendocs.sh @@ -0,0 +1,274 @@ +#!/bin/sh +# gendocs.sh -- generate a GNU manual in many formats. This script is +# mentioned in maintain.texi. See the help message below for usage details. +# $Id$ +# +# Copyright (C) 2003, 2004 Free Software Foundation, Inc. +# +# This program is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 2, or (at your option) +# any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program; if not, you can either send email to this +# program's maintainer or write to: The Free Software Foundation, +# Inc.; 59 Temple Place, Suite 330; Boston, MA 02111-1307, USA. +# +# Original author: Mohit Agarwal. +# Send bug reports and any other correspondence to bug-texinfo@gnu.org. + +prog="`basename \"$0\"`" +srcdir=`pwd` + +scripturl="http://savannah.gnu.org/cgi-bin/viewcvs/texinfo/texinfo/util/gendocs.sh" +templateurl="http://savannah.gnu.org/cgi-bin/viewcvs/texinfo/texinfo/util/gendocs_template" + +: ${MAKEINFO="makeinfo"} +: ${TEXI2DVI="texi2dvi -t @finalout"} +: ${DVIPS="dvips"} +: ${DOCBOOK2TXT="docbook2txt"} +: ${DOCBOOK2HTML="docbook2html"} +: ${DOCBOOK2PDF="docbook2pdf"} +: ${DOCBOOK2PS="docbook2ps"} +: ${GENDOCS_TEMPLATE_DIR="."} +unset CDPATH + +rcs_revision='$Revision$' +rcs_version=`set - $rcs_revision; echo $2` +program=`echo $0 | sed -e 's!.*/!!'` +version="gendocs.sh $rcs_version + +Copyright (C) 2003 Free Software Foundation, Inc. +There is NO warranty. You may redistribute this software +under the terms of the GNU General Public License. +For more information about these matters, see the files named COPYING." + +usage="Usage: $prog [OPTION]... PACKAGE MANUAL-TITLE + +Generate various output formats from PACKAGE.texinfo (or .texi or .txi) source. +See the GNU Maintainers document for a more extensive discussion: + http://www.gnu.org/prep/maintain_toc.html + +Options: + -o OUTDIR write files into OUTDIR, instead of manual/. + --docbook convert to DocBook too (xml, txt, html, pdf and ps). + --html ARG pass indicated ARG to makeinfo for HTML targets. + --help display this help and exit successfully. + --version display version information and exit successfully. + +Simple example: $prog emacs \"GNU Emacs Manual\" + +Typical sequence: + cd YOURPACKAGESOURCE/doc + wget \"$scripturl\" + wget \"$templateurl\" + $prog YOURMANUAL \"GNU YOURMANUAL - One-line description\" + +Output will be in a new subdirectory \"manual\" (by default, use -o OUTDIR +to override). Move all the new files into your web CVS tree, as +explained in the Web Pages node of maintain.texi. + +MANUAL-TITLE is included as part of the HTML of the overall +manual/index.html file. It should include the name of the package being +documented. manual/index.html is created by substitution from the file +$GENDOCS_TEMPLATE_DIR/gendocs_template. (Feel free to modify the +generic template for your own purposes.) + +If you have several manuals, you'll need to run this script several +times with different YOURMANUAL values, specifying a different output +directory with -o each time. Then write (by hand) an overall index.html +with links to them all. + +You can set the environment variables MAKEINFO, TEXI2DVI, and DVIPS to +control the programs that get executed, and GENDOCS_TEMPLATE_DIR to +control where the gendocs_template file is looked for. + +Email bug reports or enhancement requests to bug-texinfo@gnu.org. +" + +calcsize() +{ + size="`ls -ksl $1 | awk '{print $1}'`" + echo $size +} + +outdir=manual +html= +PACKAGE= +MANUAL_TITLE= + +while test $# -gt 0; do + case $1 in + --help) echo "$usage"; exit 0;; + --version) echo "$version"; exit 0;; + -o) shift; outdir=$1;; + --docbook) docbook=yes;; + --html) shift; html=$1;; + -*) + echo "$0: Unknown or ambiguous option \`$1'." >&2 + echo "$0: Try \`--help' for more information." >&2 + exit 1;; + *) + if test -z "$PACKAGE"; then + PACKAGE=$1 + elif test -z "$MANUAL_TITLE"; then + MANUAL_TITLE=$1 + else + echo "$0: extra non-option argument \`$1'." >&2 + exit 1 + fi;; + esac + shift +done + +if test -s $srcdir/$PACKAGE.texinfo; then + srcfile=$srcdir/$PACKAGE.texinfo +elif test -s $srcdir/$PACKAGE.texi; then + srcfile=$srcdir/$PACKAGE.texi +elif test -s $srcdir/$PACKAGE.txi; then + srcfile=$srcdir/$PACKAGE.txi +else + echo "$0: cannot find .texinfo or .texi or .txi for $PACKAGE in $srcdir." >&2 + exit 1 +fi + +if test ! -r $GENDOCS_TEMPLATE_DIR/gendocs_template; then + echo "$0: cannot read $GENDOCS_TEMPLATE_DIR/gendocs_template." >&2 + echo "$0: it is available from $templateurl." >&2 + exit 1 +fi + +echo Generating output formats for $srcfile + +echo Generating info files... +${MAKEINFO} -o $PACKAGE.info $srcfile +mkdir -p $outdir/ +tar czf $outdir/$PACKAGE.info.tar.gz $PACKAGE.info* +info_tgz_size="`calcsize $outdir/$PACKAGE.info.tar.gz`" +# do not mv the info files, there's no point in having them available +# separately on the web. + +echo Generating dvi ... +${TEXI2DVI} $srcfile + +# now, before we compress dvi: +echo Generating postscript... +${DVIPS} $PACKAGE -o +gzip -f -9 $PACKAGE.ps +ps_gz_size="`calcsize $PACKAGE.ps.gz`" +mv $PACKAGE.ps.gz $outdir/ + +# compress/finish dvi: +gzip -f -9 $PACKAGE.dvi +dvi_gz_size="`calcsize $PACKAGE.dvi.gz`" +mv $PACKAGE.dvi.gz $outdir/ + +echo Generating pdf ... +${TEXI2DVI} --pdf $srcfile +pdf_size="`calcsize $PACKAGE.pdf`" +mv $PACKAGE.pdf $outdir/ + +echo Generating ASCII... +${MAKEINFO} -o $PACKAGE.txt --no-split --no-headers $srcfile +ascii_size="`calcsize $PACKAGE.txt`" +gzip -f -9 -c $PACKAGE.txt >$outdir/$PACKAGE.txt.gz +ascii_gz_size="`calcsize $outdir/$PACKAGE.txt.gz`" +mv $PACKAGE.txt $outdir/ + +echo Generating monolithic html... +rm -rf $PACKAGE.html # in case a directory is left over +${MAKEINFO} --no-split --html -o $PACKAGE.html $html $srcfile +html_mono_size="`calcsize $PACKAGE.html`" +gzip -f -9 -c $PACKAGE.html >$outdir/$PACKAGE.html.gz +html_mono_gz_size="`calcsize $outdir/$PACKAGE.html.gz`" +mv $PACKAGE.html $outdir/ + +echo Generating html by node... +${MAKEINFO} --html -o $PACKAGE.html $html $srcfile +split_html_dir=$PACKAGE.html +( + cd ${split_html_dir} || exit 1 + tar -czf ../$outdir/${PACKAGE}.html_node.tar.gz -- *.html +) +html_node_tgz_size="`calcsize $outdir/${PACKAGE}.html_node.tar.gz`" +rm -f $outdir/html_node/*.html +mkdir -p $outdir/html_node/ +mv ${split_html_dir}/*.html $outdir/html_node/ +rmdir ${split_html_dir} + +echo Making .tar.gz for sources... +srcfiles=`ls *.texinfo *.texi *.txi 2>/dev/null` +tar czfh $outdir/$PACKAGE.texi.tar.gz $srcfiles +texi_tgz_size="`calcsize $outdir/$PACKAGE.texi.tar.gz`" + +if test -n "$docbook"; then + echo Generating docbook XML... + ${MAKEINFO} -o - --docbook $srcfile > ${srcdir}/$PACKAGE-db.xml + docbook_xml_size="`calcsize $PACKAGE-db.xml`" + gzip -f -9 -c $PACKAGE-db.xml >$outdir/$PACKAGE-db.xml.gz + docbook_xml_gz_size="`calcsize $outdir/$PACKAGE-db.xml.gz`" + mv $PACKAGE-db.xml $outdir/ + + echo Generating docbook HTML... + split_html_db_dir=html_node_db + ${DOCBOOK2HTML} -o $split_html_db_dir ${outdir}/$PACKAGE-db.xml + ( + cd ${split_html_db_dir} || exit 1 + tar -czf ../$outdir/${PACKAGE}.html_node_db.tar.gz -- *.html + ) + html_node_db_tgz_size="`calcsize $outdir/${PACKAGE}.html_node_db.tar.gz`" + rm -f $outdir/html_node_db/*.html + mkdir -p $outdir/html_node_db + mv ${split_html_db_dir}/*.html $outdir/html_node_db/ + rmdir ${split_html_db_dir} + + echo Generating docbook ASCII... + ${DOCBOOK2TXT} ${outdir}/$PACKAGE-db.xml + docbook_ascii_size="`calcsize $PACKAGE-db.txt`" + mv $PACKAGE-db.txt $outdir/ + + echo Generating docbook PS... + ${DOCBOOK2PS} ${outdir}/$PACKAGE-db.xml + gzip -f -9 -c $PACKAGE-db.ps >$outdir/$PACKAGE-db.ps.gz + docbook_ps_gz_size="`calcsize $outdir/$PACKAGE-db.ps.gz`" + mv $PACKAGE-db.ps $outdir/ + + echo Generating docbook PDF... + ${DOCBOOK2PDF} ${outdir}/$PACKAGE-db.xml + docbook_pdf_size="`calcsize $PACKAGE-db.pdf`" + mv $PACKAGE-db.pdf $outdir/ +fi + +echo Writing index file... +curdate="`date '+%B %d, %Y'`" +sed \ + -e "s/%%TITLE%%/$MANUAL_TITLE/g" \ + -e "s/%%DATE%%/$curdate/g" \ + -e "s/%%PACKAGE%%/$PACKAGE/g" \ + -e "s/%%HTML_MONO_SIZE%%/$html_mono_size/g" \ + -e "s/%%HTML_MONO_GZ_SIZE%%/$html_mono_gz_size/g" \ + -e "s/%%HTML_NODE_TGZ_SIZE%%/$html_node_tgz_size/g" \ + -e "s/%%INFO_TGZ_SIZE%%/$info_tgz_size/g" \ + -e "s/%%DVI_GZ_SIZE%%/$dvi_gz_size/g" \ + -e "s/%%PDF_SIZE%%/$pdf_size/g" \ + -e "s/%%PS_GZ_SIZE%%/$ps_gz_size/g" \ + -e "s/%%ASCII_SIZE%%/$ascii_size/g" \ + -e "s/%%ASCII_GZ_SIZE%%/$ascii_gz_size/g" \ + -e "s/%%TEXI_TGZ_SIZE%%/$texi_tgz_size/g" \ + -e "s/%%DOCBOOK_HTML_NODE_TGZ_SIZE%%/$html_node_db_tgz_size/g" \ + -e "s/%%DOCBOOK_ASCII_SIZE%%/$docbook_ascii_size/g" \ + -e "s/%%DOCBOOK_PS_GZ_SIZE%%/$docbook_ps_gz_size/g" \ + -e "s/%%DOCBOOK_PDF_SIZE%%/$docbook_pdf_size/g" \ + -e "s/%%DOCBOOK_XML_SIZE%%/$docbook_xml_size/g" \ + -e "s/%%DOCBOOK_XML_GZ_SIZE%%/$docbook_xml_gz_size/g" \ + -e "s,%%SCRIPTURL%%,$scripturl,g" \ + -e "s/%%SCRIPTNAME%%/$prog/g" \ +$GENDOCS_TEMPLATE_DIR/gendocs_template >$outdir/index.html + +echo "Done! See $outdir/ subdirectory for new files." diff --git a/doc/gendocs_template b/doc/gendocs_template new file mode 100755 index 0000000000..f6970c3600 --- /dev/null +++ b/doc/gendocs_template @@ -0,0 +1,101 @@ +<?xml version="1.0" encoding="utf-8" ?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> +<!-- $Id$ --> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"> + +<head> +<title>%%TITLE%% - GNU Project - Free Software Foundation (FSF) + + + + + + + + + + + + + +

%%TITLE%%

+ +
Free Software Foundation
+
last updated %%DATE%%
+

+ +  [image of the head of a GNU] + +(no gifs due to patent problems) +

+
+ +

This manual (for %%PACKAGE%%) is available in the following formats:

+ + + +

(This page generated by the %%SCRIPTNAME%% script.) +

+ + + + + diff --git a/doc/gnutls-logo.eps b/doc/gnutls-logo.eps new file mode 100644 index 0000000000..8ca3af9e19 --- /dev/null +++ b/doc/gnutls-logo.eps @@ -0,0 +1,154 @@ +%!PS-Adobe-3.0 EPSF-3.0 +%%Creator: GIMP PostScript file plugin V 1.11 by Peter Kirchgessner +%%Title: /usr/home/nmav/cvs/gnutls/doc/tex/gnutls-logo.ps +%%CreationDate: Thu Jan 17 13:17:01 2002 +%%DocumentData: Clean7Bit +%%LanguageLevel: 2 +%%Pages: 1 +%%BoundingBox: 14 14 60 56 +%%EndComments +%%BeginPreview: 94 86 1 86 +% 0000001ff000000000000000 +% 000000ffff00000000000000 +% 000003ffffc0000000000000 +% 00000ffffff0000000000000 +% 00003ffffffc000000000000 +% 00007ffffffe000000000000 +% 0000ffc007ff000000000000 +% 0001ff0000ff800000000000 +% 0003fc00003fc00000000000 +% 0007f800001fe00000000000 +% 0007f000000fe00000000000 +% 000fe0000007f00000000000 +% 000fc0000003f00000000000 +% 001f80000001f80000000000 +% 001f80000001f80000000000 +% 003f00000000fc0000000000 +% 003f00000000fc0000000000 +% 003e000000007c0000000000 +% 007e000000007e0000000000 +% 007e000000007e0000000000 +% 007e000000007e0000000000 +% 007c000000007e0000000000 +% 007e000000003e0000000000 +% 007c000000007e0000000000 +% 007c000000003e0000000000 +% 007e000000007e0000000000 +% 007c000000003e0000000000 +% 077ffffff7ffffc000000000 +% 03ffffffffffffc000000000 +% 07ffffffffffffe000000000 +% 07ffffffffffffc000000000 +% 07ffffffffffffe000000000 +% 03ffffffffffffc000000000 +% 07ffffffffffffe000000000 +% 07ffffffffffffc000000000 +% 87ffffffffffffe000000000 +% 03ffffffffffffc000000000 +% 87ffffff7fffffe000000000 +% 07fffff81fffffc0fffffe00 +% 87fffff00fffffe0fffffe00 +% 03fffff00fffffc0ffffff00 +% 87ffffe00fffffe0ffffff00 +% 07fffff007ffffc0f8000700 +% 83fffff00fffffe0f8000780 +% 07fffff00fffffc0f8000380 +% 07fffff81fffffe0f80003c0 +% 87fffffc3fffffc0f80003c0 +% 83fffff81fffffe0f80001c0 +% 07fffff81fffffc0f80001e0 +% 87fffff00fffffe0f80001e0 +% 07fffff00fffffc0f80000e0 +% 83ffffe007ffffe0f80000f0 +% 07ffffe007ffffc0f80000f0 +% 87ffffffffffffe0f8000070 +% 07ffffffffffffc0f8000078 +% 83ffffffffffffe0f8000078 +% 07ffffffffffffc0f800003c +% 87ffffffffffffe0fdb5b5bc +% 07ffffffffffffc0fffffffc +% 83ffffffffffffe0fffffffc +% 07ffffffffffffc0fffffffc +% 87ffffffffffffe0fffffffc +% 07ffffffffffffc0fffffffc +% 8000000000000000fffffffc +% 0000000000000000fffffffc +% 8000000000000000fffffffc +% aab5b5b5b5b5b5b7fffffffc +% fffffffffffffffffffffffc +% fffc0fffe07ffffffff07ffc +% fff003ff801fffffffc00ffc +% ffe3f1ff1f87ffffff0fc7fc +% ffcffcfe7fe3fffffe3ff3fc +% ff9ffe7cfff3fffffe7ff9fc +% ff3fff39fff9fffffcfff9fc +% ff3fff39fffdfffffdfffcfc +% fe7fff9bfffcfffff9fffcfc +% fe7fff93fffcfffff9fffe7c +% 807fff83fffc000003fffe00 +% 007fff83fffc000001fffe00 +% 807fff83fffc000001fffe00 +% 007fff83fffc000001fffc00 +% 003fff01fff8000000fffc00 +% 803fff00fff8000000fffc00 +% 801ffe00fff00000007ff800 +% 000ffc003fe00000003fe000 +% 8003f0001f800000000f8000 +%%EndPreview +%%BeginProlog +% Use own dictionary to avoid conflicts +10 dict begin +%%EndProlog +%%Page: 1 1 +% Translate for offset +14.173228 14.173228 translate +% Translate to begin of first scanline +0.000000 41.290570 translate +45.131554 -41.290570 scale +% Image geometry +94 86 8 +% Transformation matrix +[ 94 0 0 86 0 0 ] +currentfile /ASCII85Decode filter /RunLengthDecode filter +%%BeginData: 2608 ASCII Bytes +image +kl2+`\s,o`!WW3(9hgqeoZI4"rr_u)9cNa*"!)!bps&j*rrJN8mf3A=T$IB(rrK\TlMpr3^sN,M +rrIQWkl:bpK(IFjnc&[]7KN5`!%Rq=!%7I?!CQM.s760jffT!0"?F'kAGZ?--ctcU +!S\[n!!31;rn%2CrrBP*!!+>5li."I6Mg`_^XrMYrr=>B!!+J8l2Le<*;fd:/D'pqrrAPd!!*8\ +kPkS8"T/6"LY2Y$rrMjCqu?_ojo5=Pqu?a>pt>]ArrAkm!!,7[jo5AX2Z*OTXP*XKrrN*Vr;Zj! +Z/bibWWE%u!BpG9s7lToh#%-P3T9u<0`1nNjP'Y/rrASe!!&#;rrAPd!!&hKs7lTo;Z$LpiSje: +g&(gM>2'#Orr=VK!!+8AiVrrR*W5s<1tr!)rr<-!!!#UJrr>=_!!!D\s7lTo!rW*!HJe`&Er>t< +$ekXUrr<-!!!&;ArrA&W!!!D\s7uZqklUe`!0uIA!-\;@!"7N\q#:#A5LA_)Lrr?]u!!$*rrr>j]!!%!:rrB(s!!)BVrrZs8!&FKPr;Qb0li7%m +e,0.Gh?E6G!-%o:!35qs!:9:V"MFd8"kW_Qr;Qb0lMpr?li$hagd(0*!-%o:!35qs!:9:V"S<]7 +!-8&UFoli7$)rVlktqu?``nG`L'rW!"rs8W#s +!,(Wu!8.,I!71!3!-%o:!35qs!:94T#6#>;!)`drr;Qb0m/R,dq!.tC4RE+KE;fe:Wr)hsm-jrX +BE/#dEQ!,'OV!-%o:!35qs!:91S!5/:2!KmE[rr?]V!!%!:rrB(s!!)BSrrr$7!!#1^r;Qb0 +bl@`_rVlktqu?``mf*E$!!!&Br;Qb0bl@`_rVlktqu?``mf*9trVuq@r;Qb0bl@`_rVlktqu?_/ +mV`5A#64`Ir;Qb0bl@`_rVlktirK#W!,'OV!-%o:!35&Zr;Qb0bl@`_rVlktirK#W!,'OV!-%o: +!35&Zr;Qb0bl@`_rVlktirK#W!9qb^!:'O_!35&Z_Z'V9irHsr!35&Z_K5cPirJTLrs8#m!*jLpR3p&Odd$Tc0)s8'ULrr<#0 +1&(_L,,P;=#1:^TuaSo'0!!l6r\,cR0V>kW0!!=87i!o#Q!snbg'(l5+M#V_s!;ZZs49)PV!!]q45l`##c1:o: +LAtTH!!79BE:a,4&F/KdquHQn!g!@So)Jtis*ar_s*=29!ZM*Eli7+.mM5#jhTmm,%:5!^$FFr;Zg!qR?UrrrVcl"q0V\\F9G'nc/a+s1@[.!W&#N +!!5%Xir-@ec1q;=!qQBm&+oi#!!r,q!5Ih!!2K)b!&aWQq#:@/0cq +rrMX\q#CFqo_8@dJ.28S!C?>^R3K)>?Cp&>?s_,V4!!HH,p>Z)R +q6`Wi!!4Nqg@kPs~> +%%EndData +showpage +%%Trailer +end +%%EOF diff --git a/doc/gnutls-logo.pdf b/doc/gnutls-logo.pdf new file mode 100644 index 0000000000..489d77f8f4 Binary files /dev/null and b/doc/gnutls-logo.pdf differ -- cgit v1.2.1