From: simon <simon@cda61777-01e9-0310-a592-d414129be87e>
Date: Wed, 14 Apr 2004 18:14:41 +0000 (+0000)
Subject: ... oh, except that minimal documentation might be helpful.
X-Git-Url: https://git.distorted.org.uk/~mdw/sgt/halibut/commitdiff_plain/0287083aa74241e08a9557a9a0482d6cc5a55bba

... oh, except that minimal documentation might be helpful.


git-svn-id: svn://svn.tartarus.org/sgt/halibut@4075 cda61777-01e9-0310-a592-d414129be87e
---

diff --git a/doc/Makefile b/doc/Makefile
index 762b1d1..8b56d43 100644
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -4,10 +4,11 @@ INPUTS = $(patsubst %,%.but,$(CHAPTERS))
 
 HALIBUT = ../build/halibut
 
-all: Contents.html halibut.1
+all: index.html halibut.1
 
-Contents.html: $(INPUTS) $(HALIBUT)
-	$(HALIBUT) --text=halibut.txt --html --info=halibut.info $(INPUTS)
+index.html: $(INPUTS) $(HALIBUT)
+	$(HALIBUT) --text=halibut.txt --html --info=halibut.info \
+		--ps=halibut.ps --pdf=halibut.pdf $(INPUTS)
 
 halibut.1: manpage.but
 	$(HALIBUT) --man=halibut.1 manpage.but
diff --git a/doc/intro.but b/doc/intro.but
index 1312021..cd73832 100644
--- a/doc/intro.but
+++ b/doc/intro.but
@@ -23,8 +23,9 @@ Currently Halibut supports the following output formats:
 
 \b GNU \c{info} format.
 
-Several other formats have been planned (notably PostScript and
-PDF), but the need for them has not yet been urgent.
+\b PostScript.
+
+\b PDF.
 
 \H{intro-features} Features supported by Halibut
 
diff --git a/doc/manpage.but b/doc/manpage.but
index 4e0b472..371b15d 100644
--- a/doc/manpage.but
+++ b/doc/manpage.but
@@ -83,6 +83,30 @@ you specify; the subsidiary files will have suffixes \c{-1}, \c{-2}
 etc.
 }
 
+\dt \cw{--ps}[\cw{=}\e{filename}]
+
+\dd Makes Halibut generate an output file in PostScript format. If
+the optional \e{filename} parameter is supplied, the PostScript
+output file will be given that name. Otherwise, the name of
+the output PostScript file will be as specified in the input files,
+or \c{output.ps} if none is specified at all.
+
+\dt \cw{--pdf}[\cw{=}\e{filename}]
+
+\dd Makes Halibut generate an output file in PDF format. If
+the optional \e{filename} parameter is supplied, the PDF
+output file will be given that name. Otherwise, the name of
+the output PDF file will be as specified in the input files,
+or \c{output.pdf} if none is specified at all.
+
+\dt \cw{--man}[\cw{=}\e{filename}]
+
+\dd Makes Halibut generate an output file in Unix \cw{man} page
+format. If the optional \e{filename} parameter is supplied, the
+output \cw{man} page will be given that name. Otherwise, the name of
+the output \cw{man} page will be as specified in the input files, or
+\c{output.1} if none is specified at all.
+
 \dt \cw{-C}\e{word}\cw{:}\e{word}[\cw{:}\e{word}...]
 
 \dd Adds a configuration directive to the input processed by
@@ -123,5 +147,3 @@ This man page isn't terribly complete.
 The HTML output isn't very good.
 
 Unicode handling is atrocious.
-
-Several more output formats (PostScript, PDF) are missing.
diff --git a/doc/output.but b/doc/output.but
index 74f4c2c..dde85af 100644
--- a/doc/output.but
+++ b/doc/output.but
@@ -841,3 +841,43 @@ if the output file were called \c{mygames.info} and the keyword
 \c{chess} had been used to define Chapter 3 of the document.
 
 }
+
+\H{output-ps} \i{PostScript}
+
+This output format generates a printable manual in PostScript format.
+
+This format is currently very new and is not yet configurable. There
+is only one available configuration option:
+
+\dt \I{\cw{\\cfg\{ps-filename\}}}\cw{\\cfg\{ps-filename\}\{}\e{filename}\cw{\}}
+
+\dd Sets the \i{output file name} in which to store the PostScript
+file. This directive is implicitly generated if you provide a file
+name parameter after the command-line option \i\c{--ps} (see
+\k{running-options}).
+
+The \i{default settings} for the PostScript output format are:
+
+\c \cfg{ps-filename}{output.ps}
+
+\H{output-pdf} \i{PDF}
+
+This output format generates a printable manual in PDF format. This
+should look exactly identical to the PostScript output (see
+\k{output-ps}), but also uses some PDF interactive features to
+provide an outline of all the document's sections and clickable
+cross-references between sections.
+
+This format is currently very new and is not yet configurable. There
+is only one available configuration option:
+
+\dt \I{\cw{\\cfg\{pdf-filename\}}}\cw{\\cfg\{pdf-filename\}\{}\e{filename}\cw{\}}
+
+\dd Sets the \i{output file name} in which to store the PDF file.
+This directive is implicitly generated if you provide a file name
+parameter after the command-line option \i\c{--pdf} (see
+\k{running-options}).
+
+The \i{default settings} for the PDF output format are:
+
+\c \cfg{pdf-filename}{output.pdf}
diff --git a/doc/running.but b/doc/running.but
index d8c0d4c..e0c0e78 100644
--- a/doc/running.but
+++ b/doc/running.but
@@ -39,6 +39,10 @@ have configured Halibut to generate a single file, it will be called
 \c{output.info-2} etc., will be files suitable for use with GNU
 \c{info}.
 
+\b \c{output.ps} will be a printable PostScript manual.
+
+\b \c{output.pdf} will be a printable PDF manual.
+
 \H{running-options} \ii{Command-line options}
 
 Halibut supports command-line options in case you don't want to use
@@ -117,6 +121,18 @@ additional files \c{output.info-1}, \c{output.info-2} and so on.
 
 }
 
+\dt \i\cw{--ps}[\cw{=}\e{filename}]
+
+\dd Specifies that you want to generate PostScript output. You
+can optionally specify a file name (e.g. \c{--man=myfile.ps}), in
+which case Halibut will change the name of the output file as well.
+
+\dt \i\cw{--pdf}[\cw{=}\e{filename}]
+
+\dd Specifies that you want to generate PDF output. You
+can optionally specify a file name (e.g. \c{--man=myfile.pdf}), in
+which case Halibut will change the name of the output file as well.
+
 If you do not specify any of the above options, Halibut will simply
 produce \e{all} of its output formats.