commit 799d2a6f17601b11382be759a2bbea9daf485a35
parent b1c171c969ffc7fc3d0cb0cdd5acff2ad7593746
Author: Yuval Langer <yuval.langer@gmail.com>
Date: Mon, 22 Jan 2024 11:57:18 +0200
Add texinfo manual.
Diffstat:
| A | doc/fdl-1.3.texi | | | 505 | +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
| A | doc/guile-rsv.texi | | | 1096 | +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
2 files changed, 1601 insertions(+), 0 deletions(-)
diff --git a/doc/fdl-1.3.texi b/doc/fdl-1.3.texi
@@ -0,0 +1,505 @@
+@c The GNU Free Documentation License.
+@center Version 1.3, 3 November 2008
+
+@c This file is intended to be included within another document,
+@c hence no sectioning command or @node.
+
+@display
+Copyright @copyright{} 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc.
+@uref{http://fsf.org/}
+
+Everyone is permitted to copy and distribute verbatim copies
+of this license document, but changing it is not allowed.
+@end display
+
+@enumerate 0
+@item
+PREAMBLE
+
+The purpose of this License is to make a manual, textbook, or other
+functional and useful document @dfn{free} in the sense of freedom: to
+assure everyone the effective freedom to copy and redistribute it,
+with or without modifying it, either commercially or noncommercially.
+Secondarily, this License preserves for the author and publisher a way
+to get credit for their work, while not being considered responsible
+for modifications made by others.
+
+This License is a kind of ``copyleft'', which means that derivative
+works of the document must themselves be free in the same sense. It
+complements the GNU General Public License, which is a copyleft
+license designed for free software.
+
+We have designed this License in order to use it for manuals for free
+software, because free software needs free documentation: a free
+program should come with manuals providing the same freedoms that the
+software does. But this License is not limited to software manuals;
+it can be used for any textual work, regardless of subject matter or
+whether it is published as a printed book. We recommend this License
+principally for works whose purpose is instruction or reference.
+
+@item
+APPLICABILITY AND DEFINITIONS
+
+This License applies to any manual or other work, in any medium, that
+contains a notice placed by the copyright holder saying it can be
+distributed under the terms of this License. Such a notice grants a
+world-wide, royalty-free license, unlimited in duration, to use that
+work under the conditions stated herein. The ``Document'', below,
+refers to any such manual or work. Any member of the public is a
+licensee, and is addressed as ``you''. You accept the license if you
+copy, modify or distribute the work in a way requiring permission
+under copyright law.
+
+A ``Modified Version'' of the Document means any work containing the
+Document or a portion of it, either copied verbatim, or with
+modifications and/or translated into another language.
+
+A ``Secondary Section'' is a named appendix or a front-matter section
+of the Document that deals exclusively with the relationship of the
+publishers or authors of the Document to the Document's overall
+subject (or to related matters) and contains nothing that could fall
+directly within that overall subject. (Thus, if the Document is in
+part a textbook of mathematics, a Secondary Section may not explain
+any mathematics.) The relationship could be a matter of historical
+connection with the subject or with related matters, or of legal,
+commercial, philosophical, ethical or political position regarding
+them.
+
+The ``Invariant Sections'' are certain Secondary Sections whose titles
+are designated, as being those of Invariant Sections, in the notice
+that says that the Document is released under this License. If a
+section does not fit the above definition of Secondary then it is not
+allowed to be designated as Invariant. The Document may contain zero
+Invariant Sections. If the Document does not identify any Invariant
+Sections then there are none.
+
+The ``Cover Texts'' are certain short passages of text that are listed,
+as Front-Cover Texts or Back-Cover Texts, in the notice that says that
+the Document is released under this License. A Front-Cover Text may
+be at most 5 words, and a Back-Cover Text may be at most 25 words.
+
+A ``Transparent'' copy of the Document means a machine-readable copy,
+represented in a format whose specification is available to the
+general public, that is suitable for revising the document
+straightforwardly with generic text editors or (for images composed of
+pixels) generic paint programs or (for drawings) some widely available
+drawing editor, and that is suitable for input to text formatters or
+for automatic translation to a variety of formats suitable for input
+to text formatters. A copy made in an otherwise Transparent file
+format whose markup, or absence of markup, has been arranged to thwart
+or discourage subsequent modification by readers is not Transparent.
+An image format is not Transparent if used for any substantial amount
+of text. A copy that is not ``Transparent'' is called ``Opaque''.
+
+Examples of suitable formats for Transparent copies include plain
+ASCII without markup, Texinfo input format, La@TeX{} input
+format, SGML or XML using a publicly available
+DTD, and standard-conforming simple HTML,
+PostScript or PDF designed for human modification. Examples
+of transparent image formats include PNG, XCF and
+JPG. Opaque formats include proprietary formats that can be
+read and edited only by proprietary word processors, SGML or
+XML for which the DTD and/or processing tools are
+not generally available, and the machine-generated HTML,
+PostScript or PDF produced by some word processors for
+output purposes only.
+
+The ``Title Page'' means, for a printed book, the title page itself,
+plus such following pages as are needed to hold, legibly, the material
+this License requires to appear in the title page. For works in
+formats which do not have any title page as such, ``Title Page'' means
+the text near the most prominent appearance of the work's title,
+preceding the beginning of the body of the text.
+
+The ``publisher'' means any person or entity that distributes copies
+of the Document to the public.
+
+A section ``Entitled XYZ'' means a named subunit of the Document whose
+title either is precisely XYZ or contains XYZ in parentheses following
+text that translates XYZ in another language. (Here XYZ stands for a
+specific section name mentioned below, such as ``Acknowledgements'',
+``Dedications'', ``Endorsements'', or ``History''.) To ``Preserve the Title''
+of such a section when you modify the Document means that it remains a
+section ``Entitled XYZ'' according to this definition.
+
+The Document may include Warranty Disclaimers next to the notice which
+states that this License applies to the Document. These Warranty
+Disclaimers are considered to be included by reference in this
+License, but only as regards disclaiming warranties: any other
+implication that these Warranty Disclaimers may have is void and has
+no effect on the meaning of this License.
+
+@item
+VERBATIM COPYING
+
+You may copy and distribute the Document in any medium, either
+commercially or noncommercially, provided that this License, the
+copyright notices, and the license notice saying this License applies
+to the Document are reproduced in all copies, and that you add no other
+conditions whatsoever to those of this License. You may not use
+technical measures to obstruct or control the reading or further
+copying of the copies you make or distribute. However, you may accept
+compensation in exchange for copies. If you distribute a large enough
+number of copies you must also follow the conditions in section 3.
+
+You may also lend copies, under the same conditions stated above, and
+you may publicly display copies.
+
+@item
+COPYING IN QUANTITY
+
+If you publish printed copies (or copies in media that commonly have
+printed covers) of the Document, numbering more than 100, and the
+Document's license notice requires Cover Texts, you must enclose the
+copies in covers that carry, clearly and legibly, all these Cover
+Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
+the back cover. Both covers must also clearly and legibly identify
+you as the publisher of these copies. The front cover must present
+the full title with all words of the title equally prominent and
+visible. You may add other material on the covers in addition.
+Copying with changes limited to the covers, as long as they preserve
+the title of the Document and satisfy these conditions, can be treated
+as verbatim copying in other respects.
+
+If the required texts for either cover are too voluminous to fit
+legibly, you should put the first ones listed (as many as fit
+reasonably) on the actual cover, and continue the rest onto adjacent
+pages.
+
+If you publish or distribute Opaque copies of the Document numbering
+more than 100, you must either include a machine-readable Transparent
+copy along with each Opaque copy, or state in or with each Opaque copy
+a computer-network location from which the general network-using
+public has access to download using public-standard network protocols
+a complete Transparent copy of the Document, free of added material.
+If you use the latter option, you must take reasonably prudent steps,
+when you begin distribution of Opaque copies in quantity, to ensure
+that this Transparent copy will remain thus accessible at the stated
+location until at least one year after the last time you distribute an
+Opaque copy (directly or through your agents or retailers) of that
+edition to the public.
+
+It is requested, but not required, that you contact the authors of the
+Document well before redistributing any large number of copies, to give
+them a chance to provide you with an updated version of the Document.
+
+@item
+MODIFICATIONS
+
+You may copy and distribute a Modified Version of the Document under
+the conditions of sections 2 and 3 above, provided that you release
+the Modified Version under precisely this License, with the Modified
+Version filling the role of the Document, thus licensing distribution
+and modification of the Modified Version to whoever possesses a copy
+of it. In addition, you must do these things in the Modified Version:
+
+@enumerate A
+@item
+Use in the Title Page (and on the covers, if any) a title distinct
+from that of the Document, and from those of previous versions
+(which should, if there were any, be listed in the History section
+of the Document). You may use the same title as a previous version
+if the original publisher of that version gives permission.
+
+@item
+List on the Title Page, as authors, one or more persons or entities
+responsible for authorship of the modifications in the Modified
+Version, together with at least five of the principal authors of the
+Document (all of its principal authors, if it has fewer than five),
+unless they release you from this requirement.
+
+@item
+State on the Title page the name of the publisher of the
+Modified Version, as the publisher.
+
+@item
+Preserve all the copyright notices of the Document.
+
+@item
+Add an appropriate copyright notice for your modifications
+adjacent to the other copyright notices.
+
+@item
+Include, immediately after the copyright notices, a license notice
+giving the public permission to use the Modified Version under the
+terms of this License, in the form shown in the Addendum below.
+
+@item
+Preserve in that license notice the full lists of Invariant Sections
+and required Cover Texts given in the Document's license notice.
+
+@item
+Include an unaltered copy of this License.
+
+@item
+Preserve the section Entitled ``History'', Preserve its Title, and add
+to it an item stating at least the title, year, new authors, and
+publisher of the Modified Version as given on the Title Page. If
+there is no section Entitled ``History'' in the Document, create one
+stating the title, year, authors, and publisher of the Document as
+given on its Title Page, then add an item describing the Modified
+Version as stated in the previous sentence.
+
+@item
+Preserve the network location, if any, given in the Document for
+public access to a Transparent copy of the Document, and likewise
+the network locations given in the Document for previous versions
+it was based on. These may be placed in the ``History'' section.
+You may omit a network location for a work that was published at
+least four years before the Document itself, or if the original
+publisher of the version it refers to gives permission.
+
+@item
+For any section Entitled ``Acknowledgements'' or ``Dedications'', Preserve
+the Title of the section, and preserve in the section all the
+substance and tone of each of the contributor acknowledgements and/or
+dedications given therein.
+
+@item
+Preserve all the Invariant Sections of the Document,
+unaltered in their text and in their titles. Section numbers
+or the equivalent are not considered part of the section titles.
+
+@item
+Delete any section Entitled ``Endorsements''. Such a section
+may not be included in the Modified Version.
+
+@item
+Do not retitle any existing section to be Entitled ``Endorsements'' or
+to conflict in title with any Invariant Section.
+
+@item
+Preserve any Warranty Disclaimers.
+@end enumerate
+
+If the Modified Version includes new front-matter sections or
+appendices that qualify as Secondary Sections and contain no material
+copied from the Document, you may at your option designate some or all
+of these sections as invariant. To do this, add their titles to the
+list of Invariant Sections in the Modified Version's license notice.
+These titles must be distinct from any other section titles.
+
+You may add a section Entitled ``Endorsements'', provided it contains
+nothing but endorsements of your Modified Version by various
+parties---for example, statements of peer review or that the text has
+been approved by an organization as the authoritative definition of a
+standard.
+
+You may add a passage of up to five words as a Front-Cover Text, and a
+passage of up to 25 words as a Back-Cover Text, to the end of the list
+of Cover Texts in the Modified Version. Only one passage of
+Front-Cover Text and one of Back-Cover Text may be added by (or
+through arrangements made by) any one entity. If the Document already
+includes a cover text for the same cover, previously added by you or
+by arrangement made by the same entity you are acting on behalf of,
+you may not add another; but you may replace the old one, on explicit
+permission from the previous publisher that added the old one.
+
+The author(s) and publisher(s) of the Document do not by this License
+give permission to use their names for publicity for or to assert or
+imply endorsement of any Modified Version.
+
+@item
+COMBINING DOCUMENTS
+
+You may combine the Document with other documents released under this
+License, under the terms defined in section 4 above for modified
+versions, provided that you include in the combination all of the
+Invariant Sections of all of the original documents, unmodified, and
+list them all as Invariant Sections of your combined work in its
+license notice, and that you preserve all their Warranty Disclaimers.
+
+The combined work need only contain one copy of this License, and
+multiple identical Invariant Sections may be replaced with a single
+copy. If there are multiple Invariant Sections with the same name but
+different contents, make the title of each such section unique by
+adding at the end of it, in parentheses, the name of the original
+author or publisher of that section if known, or else a unique number.
+Make the same adjustment to the section titles in the list of
+Invariant Sections in the license notice of the combined work.
+
+In the combination, you must combine any sections Entitled ``History''
+in the various original documents, forming one section Entitled
+``History''; likewise combine any sections Entitled ``Acknowledgements'',
+and any sections Entitled ``Dedications''. You must delete all
+sections Entitled ``Endorsements.''
+
+@item
+COLLECTIONS OF DOCUMENTS
+
+You may make a collection consisting of the Document and other documents
+released under this License, and replace the individual copies of this
+License in the various documents with a single copy that is included in
+the collection, provided that you follow the rules of this License for
+verbatim copying of each of the documents in all other respects.
+
+You may extract a single document from such a collection, and distribute
+it individually under this License, provided you insert a copy of this
+License into the extracted document, and follow this License in all
+other respects regarding verbatim copying of that document.
+
+@item
+AGGREGATION WITH INDEPENDENT WORKS
+
+A compilation of the Document or its derivatives with other separate
+and independent documents or works, in or on a volume of a storage or
+distribution medium, is called an ``aggregate'' if the copyright
+resulting from the compilation is not used to limit the legal rights
+of the compilation's users beyond what the individual works permit.
+When the Document is included in an aggregate, this License does not
+apply to the other works in the aggregate which are not themselves
+derivative works of the Document.
+
+If the Cover Text requirement of section 3 is applicable to these
+copies of the Document, then if the Document is less than one half of
+the entire aggregate, the Document's Cover Texts may be placed on
+covers that bracket the Document within the aggregate, or the
+electronic equivalent of covers if the Document is in electronic form.
+Otherwise they must appear on printed covers that bracket the whole
+aggregate.
+
+@item
+TRANSLATION
+
+Translation is considered a kind of modification, so you may
+distribute translations of the Document under the terms of section 4.
+Replacing Invariant Sections with translations requires special
+permission from their copyright holders, but you may include
+translations of some or all Invariant Sections in addition to the
+original versions of these Invariant Sections. You may include a
+translation of this License, and all the license notices in the
+Document, and any Warranty Disclaimers, provided that you also include
+the original English version of this License and the original versions
+of those notices and disclaimers. In case of a disagreement between
+the translation and the original version of this License or a notice
+or disclaimer, the original version will prevail.
+
+If a section in the Document is Entitled ``Acknowledgements'',
+``Dedications'', or ``History'', the requirement (section 4) to Preserve
+its Title (section 1) will typically require changing the actual
+title.
+
+@item
+TERMINATION
+
+You may not copy, modify, sublicense, or distribute the Document
+except as expressly provided under this License. Any attempt
+otherwise to copy, modify, sublicense, or distribute it is void, and
+will automatically terminate your rights under this License.
+
+However, if you cease all violation of this License, then your license
+from a particular copyright holder is reinstated (a) provisionally,
+unless and until the copyright holder explicitly and finally
+terminates your license, and (b) permanently, if the copyright holder
+fails to notify you of the violation by some reasonable means prior to
+60 days after the cessation.
+
+Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License. If your rights have been terminated and not permanently
+reinstated, receipt of a copy of some or all of the same material does
+not give you any rights to use it.
+
+@item
+FUTURE REVISIONS OF THIS LICENSE
+
+The Free Software Foundation may publish new, revised versions
+of the GNU Free Documentation License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns. See
+@uref{http://www.gnu.org/copyleft/}.
+
+Each version of the License is given a distinguishing version number.
+If the Document specifies that a particular numbered version of this
+License ``or any later version'' applies to it, you have the option of
+following the terms and conditions either of that specified version or
+of any later version that has been published (not as a draft) by the
+Free Software Foundation. If the Document does not specify a version
+number of this License, you may choose any version ever published (not
+as a draft) by the Free Software Foundation. If the Document
+specifies that a proxy can decide which future versions of this
+License can be used, that proxy's public statement of acceptance of a
+version permanently authorizes you to choose that version for the
+Document.
+
+@item
+RELICENSING
+
+``Massive Multiauthor Collaboration Site'' (or ``MMC Site'') means any
+World Wide Web server that publishes copyrightable works and also
+provides prominent facilities for anybody to edit those works. A
+public wiki that anybody can edit is an example of such a server. A
+``Massive Multiauthor Collaboration'' (or ``MMC'') contained in the
+site means any set of copyrightable works thus published on the MMC
+site.
+
+``CC-BY-SA'' means the Creative Commons Attribution-Share Alike 3.0
+license published by Creative Commons Corporation, a not-for-profit
+corporation with a principal place of business in San Francisco,
+California, as well as future copyleft versions of that license
+published by that same organization.
+
+``Incorporate'' means to publish or republish a Document, in whole or
+in part, as part of another Document.
+
+An MMC is ``eligible for relicensing'' if it is licensed under this
+License, and if all works that were first published under this License
+somewhere other than this MMC, and subsequently incorporated in whole
+or in part into the MMC, (1) had no cover texts or invariant sections,
+and (2) were thus incorporated prior to November 1, 2008.
+
+The operator of an MMC Site may republish an MMC contained in the site
+under CC-BY-SA on the same site at any time before August 1, 2009,
+provided the MMC is eligible for relicensing.
+
+@end enumerate
+
+@page
+@heading ADDENDUM: How to use this License for your documents
+
+To use this License in a document you have written, include a copy of
+the License in the document and put the following copyright and
+license notices just after the title page:
+
+@smallexample
+@group
+ Copyright (C) @var{year} @var{your name}.
+ Permission is granted to copy, distribute and/or modify this document
+ under the terms of the GNU Free Documentation License, Version 1.3
+ or any later version published by the Free Software Foundation;
+ with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
+ Texts. A copy of the license is included in the section entitled ``GNU
+ Free Documentation License''.
+@end group
+@end smallexample
+
+If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts,
+replace the ``with@dots{}Texts.''@: line with this:
+
+@smallexample
+@group
+ with the Invariant Sections being @var{list their titles}, with
+ the Front-Cover Texts being @var{list}, and with the Back-Cover Texts
+ being @var{list}.
+@end group
+@end smallexample
+
+If you have Invariant Sections without Cover Texts, or some other
+combination of the three, merge those two alternatives to suit the
+situation.
+
+If your document contains nontrivial examples of program code, we
+recommend releasing these examples in parallel under your choice of
+free software license, such as the GNU General Public License,
+to permit their use in free software.
+
+@c Local Variables:
+@c ispell-local-pdict: "ispell-dict"
+@c End:
diff --git a/doc/guile-rsv.texi b/doc/guile-rsv.texi
@@ -0,0 +1,1096 @@
+\input texinfo @c -*-texinfo-*-
+
+@c %**start of header
+@documentencoding UTF-8
+@documentlanguage en
+@setfilename guile-rsv.info
+@settitle guile-rsv Reference Manual
+@set VERSION 1.0.0
+@c %**end of header
+
+@c XXX @include version.texi
+
+@copying
+Copyright @copyright{} 2024 Yuval Langer@*
+
+Permission is granted to copy, distribute and/or modify this document
+under the terms of the GNU Free Documentation License, Version 1.3 or
+any later version published by the Free Software Foundation; with no
+Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
+copy of the license is included in the section entitled ``GNU Free
+Documentation License''.
+@end copying
+
+@dircategory The Algorithmic Language Scheme
+@direntry
+* guile-rsv: An R7RS compliant RSV (Rows of String Values) library.
+@end direntry
+
+@titlepage
+@title guile-rsv Reference Manual
+@subtitle Using guile-rsv
+@author The Haunt Developers
+
+@page
+@vskip 0pt plus 1filll
+@c XXX Edition @value{EDITION} @*
+@c XXX @value{UPDATED} @*
+
+@insertcopying
+@end titlepage
+
+@contents
+
+@node Top
+@top guile-rsv
+
+This document describes guile-rsv version @value{VERSION}, a Rows of
+String Values (RSV) R7RS compliant libraray.
+generator.
+@c * Installation:: Installing Haunt.
+
+@menu
+* Introduction:: About guile-rsv
+* Installation:: Installing Haunt
+* Tutorial:: How to get started quickly.
+* Command-line Interface:: Using guile-rsv from the command-line.
+* Programming Interface:: Using the Haunt API in Scheme.
+* Contributing:: How to contribute to guile-rsv.
+* GNU Free Documentation License:: The license of this manual.
+* Concept Index:: Concepts.
+* Programming Index:: Data types, procedures, syntax, and variables.
+@end menu
+
+@node Introduction
+@chapter Introduction
+
+Rows of String Values is a data format used to represent a list of
+list of unicode strings (or nulls), as shown in this BNF:
+
+@code
+RSV := RSV-row*
+RSV-row := RSV-string-or-null* Row-Terminator-Byte
+RSV-string-or-null := ( String | Null-Value-Byte ) Value-Terminator-Byte
+String := a Unicode string encoded as UTF-8
+Row-Terminator-Byte := 0xFD
+Value-Terminator-Byte := 0xFF
+Null-Value-Byte := 0xFE
+@end code
+
+Because all three bytes used to represent Row-Terminator-Byte,
+Value-Terminator-Byte, and Null-Value-Byte are not used to encode
+UTF-8, we can freely use them as punctuation between the strings.
+This result with us not having to escape any
+
+@node Installation
+@chapter Installation
+
+@menu
+* Downloading:: Downloading the source code.
+* Guix Installation:: Installing from Guix.
+* Requirements:: guile-rsv Requirements.
+* Building:: Building from source code.
+@end menu
+
+@node Downloading
+@section Downloading
+
+Official guile-rsv source code is available from
+@url{https://codeberg.org/kakafarm/guile-rsv, Codeberg},
+@url{https://git.sr.ht/~kakafarm/guile-rsv, Sourcehut}, or
+@url{https://kaka.farm/stagit/guile-rsv, Kaka Farm's Stagit}.
+
+@node Guix Installation
+@section Guix Installation
+
+Add the Guix Kaka Farm Channel from
+@url{https://codeberg.org/kakafarm/guix-kakafarm-channel, codeberg},
+@url{https://git.sr.ht/~kakafarm/guix-kakafarm-channel/, Sourcehut},
+or @url{https://kaka.farm/stagit/guile-rsv/log.html, Kaka Farm's
+Stagit} to your @code{~/.config/guix/channels.scm}.
+
+@node Requirements
+@section Requirements
+
+guile-rsv depends on the following packages:
+
+@itemize
+@item
+@url{https://gnu.org/software/guile, GNU Guile}
+@item
+@url{https://gnu.org/software/bash, GNU Bash}
+@end itemize
+
+@node Command-line Interface
+@chapter Command-line Interface
+
+@menu
+* Invoking rsv2scm:: Convert RSV into lists of lists of strings.
+* Invoking scm2rsv:: Convert Lists of lists of strings into RSV.
+@end menu
+
+The Haunt command-line interface is composed of many subcommands. The
+general syntax for all Haunt commands is:
+
+@example
+haunt @var{subcommand} @var{options}@dots{}
+@end example
+
+@node Invoking rsv2scm
+@section Invoking @command{rsv2scm}
+
+The @command{haunt build} command realizes a Haunt site configuration
+file by compiling web pages and copying static assets to the output
+directory. For details on how to configure a Haunt site,
+@pxref{Sites}.
+
+Example:
+
+@example
+haunt build --config=haunt.scm
+@end example
+
+@table @code
+
+@item --config=@var{configuration-file}
+@itemx -c @var{configuration-file}
+Load the Haunt site declaration from @var{configuration-file}.
+
+@end table
+
+@node Invoking scm2rsv
+@section Invoking @command{scm2rsv}
+
+The @command{haunt serve} command allows one to quickly view a local
+preview of the generated website before publishing the finished
+product to a remote web server. When @command{haunt serve} runs, a
+local HTTP server is spawned. Visit the server using a web browser to
+inspect the results of the build. By default, the web server listens
+on port 8080, so the URL to visit would be
+@url{http://localhost:8080}.
+
+While developing, it is common to rebuild the site frequently to view
+the results of incremental changes. Rather than manually running
+@command{haunt build} (@ref{Invoking haunt build}) each time changes
+are made, the @code{--watch} flag can be used to automatically rebuild
+the site when a source file changes on disk.
+
+@table @code
+
+@item --config=@var{configuration-file}
+@itemx -c @var{configuration-file}
+Load the Haunt site declaration from @var{configuration-file}.
+
+@item --port=@var{port}
+@itemx -p @var{port}
+
+Listen for HTTP requests on @var{port}. Defaults to 8080.
+
+@item --host=@var{host}
+@itemx -p @var{host}
+
+Listen for HTTP requests on @var{host}. Accepts an IP address (IPv4
+or IPv6), @code{localhost} or @code{loopback} to serve on the local
+loopback device (the default), or @code{any} to bind on all local
+available ports (useful if you want to show off your website to
+someone else on your LAN, or something.)
+
+@item --watch
+@itemx -w
+
+Automatically rebuild the site when source files change.
+
+@end table
+
+@node Programming Interface
+@chapter Programming Interface
+
+@menu
+* Sites:: Description of the site and how to build it.
+* Posts:: Articles, prose, blog posts, etc.
+* Readers:: Post interpreters.
+* Builders:: Web page builders.
+* Publishers:: How to publish your site.
+* Artifacts:: The build outputs that form a website.
+* Assets:: Images, stylesheets, etc.
+@end menu
+
+Haunt is a fully-programmable system composed of several Guile Scheme
+modules. This section documents the public API.
+
+@node Sites
+@section Sites
+
+@example
+(use-modules (haunt site))
+@end example
+
+A site object defines all of the properties for a Haunt website: The
+site name, domain name, where blog posts are found, what post formats
+are understood, which procedures are used to build the site, where the
+output files are written to, etc.
+
+@deffn {Procedure} site [#:title "This Place is Haunted"] @
+ [#:domain "example.com"] [#:posts-directory "posts"] @
+ [#:file-filter @code{default-file-filter}] @
+ [#:build-directory "site"] [#:default-metadata '()] @
+ [#:make-slug @code{post-slug}] [#:readers '()] @
+ [#:builders '()] [#:publishers '()]
+Create a new site object. All arguments are optional:
+
+@table @var
+
+@item title
+The name of the site.
+
+@item posts-directory
+The directory where posts are found.
+
+@item file-filter
+A predicate procedure that returns @code{#f} when a post file should
+be ignored, and @code{#t} otherwise. Emacs temporary files are
+ignored by default.
+
+@item build-directory
+The directory that generated pages are stored in.
+
+@item default-metadata
+An alist of arbitrary default metadata for posts whose keys are
+symbols.
+
+@item make-slug
+A procedure generating a file name slug from a post.
+
+@item readers
+A list of reader objects for processing posts.
+
+@item builders
+A list of procedures for building pages from posts.
+
+@item publishers
+A list of publisher objects for upload site contents to a remote location
+
+@end table
+
+@end deffn
+
+@deffn {Procedure} site? @var{obj}
+Return @code{#t} if @var{obj} is a site object.
+@end deffn
+
+@deffn {Procedure} site-title @var{site}
+Return the title of @var{site}.
+@end deffn
+
+@deffn {Procedure} site-domain @var{site}
+Return the domain of @var{site}.
+@end deffn
+
+@deffn {Procedure} site-posts-directory @var{site}
+Return the posts directory for @var{site}.
+@end deffn
+
+@deffn {Procedure} site-file-filter @var{site}
+Return the file filter procedure for @var{site}.
+@end deffn
+
+@deffn {Procedure} site-build-directory @var{site}
+Return the build directory of @var{site}.
+@end deffn
+
+@deffn {Procedure} site-make-slug @var{site}
+Return the slug constructor for @var{site}.
+@end deffn
+
+@deffn {Procedure} site-readers @var{site}
+Return the list of reader procedures for @var{site}.
+@end deffn
+
+@deffn {Procedure} site-builders @var{site}
+Return the list of builder procedures for @var{site}.
+@end deffn
+
+@deffn {Procedure} site-publishers @var{site}
+Return the list of publisher objects for upload @var{site} contents to a
+remote location.
+@end deffn
+
+@node Posts
+@section Posts
+
+@example
+(use-modules (haunt post))
+@end example
+
+Posts represent the articles that are kept in a site's post directory
+and written in a markup format that Haunt can understand.
+@xref{Readers} for how files on disk can be transformed into posts.
+
+@deffn {Procedure} make-post @var{file-name} @var{metadata} @var{sxml}
+Create a new post object that represents the contents of the file
+@var{file-name}. The body of the post, @var{sxml}, is represented as
+an SXML tree (@pxref{SXML, SXML,, guile, GNU Guile Reference Manual})
+and the metadata is an association list (@pxref{Association Lists,
+Association Lists,, guile, GNU Guile Reference Manual}) of arbitrary
+key/value pairs.
+@end deffn
+
+@deffn {Procedure} post? @var{object}
+Return @code{#t} if @var{object} is a post.
+@end deffn
+
+@deffn {Procedure} post-file-name @var{post}
+Return the file name for @var{post}.
+@end deffn
+
+@deffn {Procedure} post-metadata @var{post}
+Return the metadata association list for @var{post}.
+@end deffn
+
+@deffn {Procedure} post-sxml @var{post}
+Return the SXML tree for @var{post}.
+@end deffn
+
+@deffn {Procedure} post-ref @var{post} @var{key}
+Return the metadata value corresponding to @var{key} within
+@var{post}.
+@end deffn
+
+@deffn {Procedure} post-slug post
+Return a URL slug suitable for the file name of @var{post}. If a
+custom @code{slug} metadata value exists for @var{post} then that is
+returned. Otherwise, a slug is automatically generated from the
+@code{title} metadata value.
+@end deffn
+
+The original @code{post-slug} procedure above has some less than ideal
+behavior. One issue is that version numbers like ``1.2.3'' get
+transformed to ``123'' rather than something more sensible like
+``1-2-3''. Unfortunately, changing this behavior would mean breaking
+the URLs for existing Haunt sites. Instead, users may opt-in to using
+@code{post-slug-v2} by passing it as the @code{#:make-slug} argument
+to @code{make-site}. @xref{Sites} for more information.
+
+@deffn {Procedure} post-slug-v2 post
+Transform the title of @var{post} into a URL slug. This second
+revision does a better job than the original. Like @code{post-slug},
+if a custom @code{slug} metadata value exists for @var{post} then that
+is returned. Otherwise, a slug is automatically generated from the
+@code{title} metadata value.
+@end deffn
+
+@defvr {Variable} %default-date
+The default date of a post when no other date is specified in the
+metadata association list.
+@end defvr
+
+@deffn {Procedure} post-date @var{post}
+Return the date for @var{post}, or @code{%default-date} if no date is
+specified.
+@end deffn
+
+@deffn {Procedure} posts/reverse-chronological @var{posts}
+Sort @var{posts}, a list of posts, in reverse chronological order.
+@end deffn
+
+@deffn {Procedure} post-author @var{post}
+Return the author of @var{post}, or @code{#f} if no author is
+specified.
+@end deffn
+
+@deffn {Procedure} post-tags @var{post}
+Return list of tags for @var{post}, or the empty list if no tags are
+specified.
+@end deffn
+
+@deffn {Procedure} post-title @var{post}
+Return the title of @var{post}, or @code{#f} if no title is
+specified.
+@end deffn
+
+@deffn {Procedure} posts/group-by-tag @var{posts}
+Create an association list of tags mapped to the posts in the list
+@var{posts} that used them.
+@end deffn
+
+@node Readers
+@section Readers
+
+@menu
+* Reader:: Reader interface and basic readers
+* Texinfo:: Texinfo reader
+* Skribe:: Skribe reader
+* CommonMark:: CommonMark reader
+@end menu
+
+@node Reader
+@subsection Reader
+@example
+(use-modules (haunt reader))
+@end example
+
+The purpose of a reader is to translate the markup within a post file
+into an SXML tree representing the HTML structure and associate some
+metadata with it.
+
+@deffn {Procedure} make-reader @var{matcher} @var{proc}
+Create a new reader. The reader is to be activated when
+@var{matcher}, a procedure that accepts a file name as its only
+argument, returns @code{#t}. When a post file matches, the procedure
+@var{proc}, which also accepts a file name as its only argument, reads
+the contents and returns a post object (@pxref{Posts}).
+@end deffn
+
+@deffn {Procedure} reader? @var{object}
+Return @code{#t} if @var{object} is a reader.
+@end deffn
+
+@deffn {Procedure} reader-matcher @var{reader}
+Return the match procedure for @var{reader}.
+@end deffn
+
+@deffn {Procedure} reader-proc @var{reader}
+Return the read procedure for @var{reader}.
+@end deffn
+
+@deffn {Procedure} reader-match? @var{reader} @var{file-name}
+Return @code{#t} if @var{file-name} is a file supported by
+@var{reader}.
+@end deffn
+
+@deffn {Procedure} reader-find? readers file-name
+Return the first reader in @var{readers} that can parse
+@var{file-name}, or @code{#f} if there is no such reader.
+@end deffn
+
+@deffn {Procedure} reader-read reader file-name
+Parse @var{file-name} using @var{reader} and return two values: an
+alist of metadata and an SXML tree.
+@end deffn
+
+@deffn {Procedure} read-post @var{reader} @var{file-name} [@var{default-metadata}]
+Read a post object from @var{file-name} using @var{reader}, merging
+its metadata with @var{default-metadata}, or the empty list if not
+specified.
+@end deffn
+
+@deffn {Procedure} read-posts @var{directory} @var{keep?} @var{readers} [@var{default-metadata}]
+Read all of the files in @var{directory} that match @var{keep?} as
+post objects. The @var{readers} list must contain a matching reader
+for every post.
+@end deffn
+
+@deffn {Procedure} make-file-extension-matcher @var{ext}
+Create a procedure that returns @code{#t} when a file name ends with
+``.ext''.
+@end deffn
+
+@defvr {Procedure} sxml-reader
+A basic reader for posts written as Scheme code that evaluates to an
+an association list. The special key @code{content} contains the post
+body as an SXML tree.
+
+Example:
+
+@example
+(use-modules (haunt utils))
+
+`((title . "Hello, world!")
+ (date . ,(string->date* "2015-04-10 23:00"))
+ (tags "foo" "bar")
+ (summary . "Just a test")
+ (content
+ ((h2 "Hello!")
+ (p "This is Haunt. A static site generator for GNU Guile."))))
+@end example
+
+@end defvr
+
+@defvr {Procedure} html-reader
+A basic reader for posts written in plain ol' HTML. Metadata is
+encoded as the @code{key: value} pairs, one per line, at the beginning
+of the file. A line with the @code{---} sentinel marks the end of the
+metadata section and the rest of the file is encoded as HTML.
+
+Example:
+
+@example
+title: A Foo Walks Into a Bar
+date: 2015-04-11 20:00
+tags: bar
+---
+<p>
+ This is an example using raw HTML, because Guile doesn't have a
+ Markdown parser.
+</p>
+@end example
+
+@end defvr
+
+@node Texinfo
+@subsection Texinfo
+@example
+(use-modules (haunt reader texinfo))
+@end example
+
+@defvr {Procedure} texinfo-reader
+A reader for posts written in texinfo, the official documentation format
+of the GNU project. Metadata is encoded as @code{key: value} pairs, one
+per line, at the beginning of the file. A line with the @code{---}
+sentinel marks the end of the metadata section and the rest of the file
+is encoded as HTML.
+
+Example:
+
+@example
+title: Hello, Texi!
+date: 2016-08-20 12:00
+tags: texinfo, foo
+---
+
+@@emph@{Texinfo@} is the official documentation format of the
+@@url@{http://www.gnu.org/, GNU project@}. It was invented by Richard
+Stallman and Bob Chassell many years ago, loosely based on Brian
+Reid's Scribe and other formatting languages of the time. It is
+used by many non-GNU projects as well.
+@end example
+
+@end defvr
+
+@node Skribe
+@subsection Skribe
+@example
+(use-modules (haunt reader skribe))
+@end example
+
+@defvr {Procedure} skribe-reader
+A reader for posts written in Skribe, a markup language with the full power
+of Scheme. Skribe posts are created with the @code{post} expression with
+metadata encoded as @code{:key expression} pairs at the beginning of the
+@code{post} expression. After the metadata section, the rest of the @code{post}
+expression is encoded as HTML.
+
+Example:
+
+@example
+(post
+ :title "Hello, Skribe!"
+ :date (make-date* 2016 08 20 12 00)
+ :tags '("skribe" "foo" "baz")
+
+ (h2 [This is a Skribe post])
+
+ (p [Skribe is a ,(em [really]) cool document authoring format
+ that provides all the power of Scheme whilst giving the user
+ a means to write literal text without stuffing it into a
+ string literal. If this sort of thing suits you, be sure to
+ check out ,(anchor "Skribilo"
+ "http://www.nongnu.org/skribilo/"), too.]))
+@end example
+
+@end defvr
+
+@node CommonMark
+@subsection CommonMark
+@example
+(use-modules (haunt reader commonmark))
+@end example
+
+@defvr {Procedure} commonmark-reader
+A reader for posts written in CommonMark, a fully specified variant of
+Markdown. Metadata is encoded as @code{key: value} pairs, one per line,
+at the beginning of the file. A line with the @code{---} sentinel marks
+the end of the metadata section and the rest of the file is encoded as HTML.
+
+Example:
+
+@example
+title: Hello, CommonMark!
+date: 2016-08-20 12:00
+tags: markdown, commonmark
+---
+
+## This is a CommonMark post
+
+CommonMark is a **strongly** defined, *highly* compatible
+specification of Markdown, learn more about CommomMark
+[here](http://commonmark.org/).
+@end example
+
+@end defvr
+
+@node Builders
+@section Builders
+
+@menu
+* Static Assets:: Images, CSS, JavaScript, etc.
+* Flat pages:: Simple static pages.
+* Blog:: Dear diary...
+* Atom:: Atom feeds.
+* RSS:: RSS feeds.
+* Redirects:: Client-side redirects.
+@end menu
+
+Builders are procedures that return one or more artifacts
+(@pxref{Artifacts}) when applied. A builder accepts two arguments: A
+site (@pxref{Sites}) and a list of posts (@pxref{Posts}).
+
+Haunt comes with a few convenient builders to help users who want to
+create a simple blog with an Atom feed.
+
+@node Static Assets
+@subsection Static Assets
+
+@example
+(use-modules (haunt builder assets))
+@end example
+
+@deffn {Procedure} static-directory @var{directory} [@var{dest}]
+
+Create a builder procedure that recursively copies all of the files in
+@var{directory}, a file name relative to a site's source directory,
+and copies them into @var{dest}, a prefix relative to a site's target
+output directory. By default, @var{dest} is @var{directory}.
+@end deffn
+
+@node Flat pages
+@subsection Flat pages
+
+@example
+(use-modules (haunt builder flat-pages))
+@end example
+
+Flat pages cover the simple case of converting a tree of files written
+in some markup language to full web pages. Flat pages work great for
+the more informational parts of a website that don't require any fancy
+programming to generate, like an ``About me'' page.
+
+@deffn {Procedure} flat-pages directory [#:template] [#:prefix]
+
+Return a procedure that parses the files in @var{directory} and
+returns a list of HTML pages, one for each file. The files are parsed
+using the readers configured for the current site.
+
+Each flat page starts with a metadata header. Only a single piece of
+metadata is used, though: the title.
+
+Here's what a flat page written in Markdown might look like:
+
+@example
+title: About me
+---
+
+# About me
+
+Hello, I am Alice! I'm a fictitious person made up for the purposes
+of demonstrating Haunt's flat page functionality. I live here in this
+manual with my two cats: Bob and Carol.
+@end example
+
+The content of each flat page is inserted into a complete HTML
+document by the @var{template} procedure. This procedure takes three
+arguments:
+
+@itemize
+@item the site object
+@item the page title string (from the metadata header)
+@item an SXML tree of the page body
+@end itemize
+
+@var{template} should return a single value: a new SXML tree
+representing a complete HTML page that presumably wraps the page body.
+
+Conveniently, the signature of @var{template} matches the blog theme
+layout procedure so that it can be reused for flat pages. @xref{Blog}
+for more information.
+
+The structure of @var{directory} is preserved in the resulting pages
+and may be optionally nested within the directory @var{prefix}. If no
+prefix is specified, the files are placed starting at the root of the
+site.
+
+@end deffn
+
+@node Blog
+@subsection Blog
+
+@example
+(use-modules (haunt builder blog))
+@end example
+
+@deffn {Procedure} theme [#:name "Untitled"] [#:layout] [#:post-template] @
+ [#:collection-template] [#:pagination-template]
+Create a new theme named @var{name}.
+
+The procedure @var{layout} accepts three arguments: a site, a page
+title string, and an SXML tree. Its purpose is to wrap the contents
+of a post with the theme's header/footer and return the complete SXML
+tree for a web page.
+
+The procedure @var{post-template} accepts a single argument: a post.
+Its purpose is to return an SXML tree containing the contents of the
+post, applying any desired post-processing operations.
+
+The procedure @var{collection-template} accepts four arguments: a
+site, a title string, a list of posts, and a URL prefix string. Its
+purpose is to return an SXML tree containing the body of the
+collection page.
+
+The procedure @var{pagination-template} accepts four arguments: a
+site, an SXML tree, the file name of the previous page, and the file
+name of the next page. Its purpose is to incorporate the given SXML
+tree into a larger document that incorporates previous/next page
+links.
+@end deffn
+
+@deffn {Procedure} theme? @var{object}
+Return @code{#t} if @var{object} is a theme object.
+@end deffn
+
+@deffn {Procedure} blog [#:theme] [#:prefix] [#:post-prefix] @
+ [#:collections `(("Recent Posts" "index.html" ,posts/reverse-chronological))] @
+ [#:posts-per-page]
+
+Create a builder procedure that transforms a list of posts into pages
+decorated by @var{theme}, a theme object, whose URLs start with
+@var{prefix}. Post pages may be nested deeper in the file hierarchy
+than collection pages by specifying the @var{post-prefix} argument.
+
+Additionally, this builder creates pages that aggregate previews of
+many posts corresponding to what is specified in the list
+@var{collections}. Each collection is a three element list in the
+form @code{(title file-name filter)}.
+
+@table @var
+
+@item title
+The human readable name of the collection.
+
+@item file-name
+The HTML file that will contain the rendered collection.
+
+@item filter
+A procedure that accepts a list of posts as its only argument and
+returns a new list of posts. The filter procedure is used to remove
+and/or sort the posts into the desired form for the collection. For
+example, a filter could sort posts in reverse chronological order or
+select all posts that are written by a particular author.
+
+@end table
+
+By default, a single collection is created that lists posts in reverse
+chronological order and writes to @file{index.html}.
+
+Also by default, collection pages are not paginated. When there are a
+lot of posts in one or more collections, it is best to paginate them.
+To do so, pass the @var{posts-per-page} argument.
+
+The default theme is intended only for testing purposes.
+
+@end deffn
+
+@node Atom
+@subsection Atom
+
+@example
+(use-modules (haunt builder atom))
+@end example
+
+@deffn {Procedure} atom-feed [#:file-name "feed.xml"] [#:subtitle "Recent Posts"] @
+ [#:filter posts/reverse-chronological] @
+ [#:last-updated (current-date)] @
+ [#:max-entries 20] [#:blog-prefix ""]
+Return a builder procedure that renders a site's posts as an Atom
+feed. All arguments are optional:
+
+@table @var
+
+@item file-name:
+The page file name.
+
+@item subtitle
+The feed subtitle.
+
+@item filter
+The procedure called to manipulate the posts list before rendering.
+
+@item last-updated
+The feed last updated date. Defaults to the current date.
+
+@item max-entries
+The maximum number of posts to render in the feed.
+
+@item blog-prefix
+The prefix for all post URLs, which is the combination of the blog's
+prefix and post prefix. @xref{Blog} for more information.
+
+@end table
+
+@end deffn
+
+@deffn {Procedure} atom-feeds-by-tag [#:prefix "feeds/tags"] @
+ [#:filter posts/reverse-chronological] @
+ [#:last-updated (current-date)] @
+ [#:max-entries 20] [#:blog-prefix ""]
+Return a builder procedure that renders an atom feed for every tag
+used in a post. All arguments are optional:
+
+@table @var
+
+@item prefix
+The directory in which to write the feeds.
+
+@item filter
+The procedure called to manipulate the posts list before rendering.
+
+@item last-updated
+The feed last updated date. Defaults to the current date.
+
+@item max-entries
+The maximum number of posts to render in each feed.
+
+@item blog-prefix
+The prefix for all post URLs, which is the combination of the blog's
+prefix and post prefix. @xref{Blog} for more information.
+
+@end table
+
+@end deffn
+
+@node RSS
+@subsection RSS
+
+@example
+(use-modules (haunt builder rss))
+@end example
+
+@deffn {Procedure} rss-feed [#:file-name "rss-feed.xml"] [#:subtitle "Recent Posts"] @
+ [#:filter posts/reverse-chronological] @
+ [#:publication-date (current-date)] @
+ [#:max-entries 20] [#:blog-prefix ""]
+Return a builder procedure that renders a list of posts as an RSS
+feed. All arguments are optional:
+
+@table @var
+
+@item file-name
+The page file name.
+
+@item subtitle
+The feed subtitle.
+
+@item filter
+The procedure called to manipulate the posts list before rendering.
+
+@item publication-date
+The feed publication date. Defaults to the current date.
+
+@item max-entries
+The maximum number of posts to render in the feed.
+
+@item blog-prefix
+The prefix for all post URLs, which is the combination of the blog's
+prefix and post prefix. @xref{Blog} for more information.
+
+@end table
+
+@end deffn
+
+@node Redirects
+@subsection Redirects
+
+@example
+(use-modules (haunt builder redirects))
+@end example
+
+The redirects builder creates pages that trigger browser redirects to
+another URL. This allows for easily specifying redirects as part of a
+Haunt site configuration and without the need for modifying the
+configuration of the production web server that is hosting the site.
+
+@deffn {Procedure} redirects specs
+Return a procedure that transforms a list of redirect tuples in
+@var{specs}, with the form @code{(from to)}, into a list of pages that
+trigger a browser-initiated redirect.
+
+@code{from} values must be local page file names, @emph{not} URLs, but
+@var{to} values may be either local page file names or full URLs to
+other websites.
+
+@example
+(redirects '(("/about.html" "/about/me.html") ; local
+ ("/guile.html" "https://gnu.org/software/guile"))) ; remote
+@end example
+
+@end deffn
+
+@node Publishers
+@section Publishers
+
+@example
+(use-modules (haunt publisher))
+@end example
+
+The purpose of a publisher is to deploy a built site. Haunt comes
+with some built-in publishers, but custom publishers can be created
+with the following interface.
+
+@deffn {Procedure} make-publisher @var{name} @var{proc}
+Create a new publisher.
+@end deffn
+
+@deffn {Procedure} publisher? @var{object}
+Return @code{#t} if @var{object} is a publisher.
+@end deffn
+
+@deffn {Procedure} publisher-name @var{publisher}
+Return the publisher name.
+@end deffn
+
+@deffn {Procedure} publisher-proc @var{reader}
+Return the publisher procedure for @var{publisher}.
+@end deffn
+
+@deffn {Procedure} publish @var{publisher} @var{site}
+Publish @var{site} with @var{publisher}.
+@end deffn
+
+@deffn {Procedure} run-command @var{program} @var{args}
+Run command @var{program} with @var{args} arguments.
+@end deffn
+
+Haunt comes with the following built-in publishers:
+
+@node Rsync
+@subsection Rsync
+
+@example
+(use-modules (haunt publisher rsync))
+@end example
+
+@deffn {Procedure} rsync-publisher [#:name 'production] [#:destination] @@
+ [#:user] [#:host] [#:name] [#:rsync] @@
+ [#:flags '("--compress" "--delete" "--progress" "--recursive" "--verbose")]
+
+Return a new publisher named @var{name} that publishes a site to
+@var{destination}, either locally or to a remote host if @var{host}
+and/or @var{user} arguments are specified. Passing @var{rsync}
+overrides the @command{rsync} executable used. Passing @var{flags}
+overrides the set of command line flags used.
+@end deffn
+
+@node Sourcehut
+@subsection Sourcehut
+@example
+(use-modules (haunt publisher sourcehut))
+@end example
+
+@deffn {Procedure} sourcehut-publisher [#:name 'production] [#:hut] [#:tar]
+Return a new publisher named @var{name} that publishes a site to
+@url{https://srht.site/, sourcehut pages} using the site's configured
+domain. Passing @var{hut} and/or @var{tar} overrides the default
+@command{hut} and @command{tar} executables used.
+
+For the publisher to work, the @command{hut} CLI tool that is used
+under the hood has to be configured. One can do so by creating
+@file{~/.config/hut/config} manually or by running the @command{hut
+init} command. In both cases an OAuth access token needs to be
+generated via @url{https://meta.sr.ht/oauth2, sourcehut meta}.
+@end deffn
+
+@node Artifacts
+@section Artifacts
+
+@example
+(use-modules (haunt artifact))
+@end example
+
+Artifacts are objects that represent the output of a build. A
+collection of artifacts forms a complete website. Artifacts are quite
+simple: They contain a file name string that specifies where the
+artifact belongs in the build output directory, and a writer procedure
+that populates that file with data.
+
+For example, making an artifact that writes ``Hello, world!'' to
+@file{/hello.txt} would look like this:
+
+@example
+(make-artifact "/hello.txt"
+ (lambda (output)
+ (call-with-output-file output
+ (lambda (port)
+ (display "Hello, world!\n" port)))))
+@end example
+
+Previous versions of Haunt made a distinction between pages, whose
+content is defined algorithmically, and assets, whose content is
+copied verbatim from an input file such as an image. The artifact
+data type is a unifying primitive that replaces both pages and assets.
+
+Artifacts that require serializing some input, such as SXML, should
+use @code{serialize-artifact}. Artifacts that make a verbatim copy of
+an input file should use @code{verbatim-artifact}. Unless you are
+implementing a custom builder, it's unlikely that these procedures
+will be need to used directly.
+
+@deffn {Procedure} serialized-artifact destination obj serialize
+Return a new artifact whose writer serializes @var{obj} using the
+procedure @var{serialize} to the @var{destination} in the build output
+directory.
+@end deffn
+
+@deffn {Procedure} verbatim-artifact source destination
+Return a new artifact that copies the file @var{source} verbatim to
+@var{destination} within the build output directory.
+@end deffn
+
+@node Assets
+@section Assets
+
+@example
+(use-modules (haunt asset))
+@end example
+
+Assets represent files on disk that should be copied verbatim to a
+site's output directory. Common types of assets include CSS,
+JavaScript, images, and fonts. It is often the case that there are
+entire directories full of static assets to copy over, thus there is a
+convenient @code{directory-assets} procedure. However, it's unlikely
+that this procedure needs to be used directly. See @pxref{Static
+Assets} for a convenient builder.
+
+@deffn {Procedure} directory-assets @var{directory} @var{keep?} @var{dest}
+Create a list of asset objects to be stored within @var{dest} for all
+files in @var{directory} that match @var{keep?}, recursively.
+@end deffn
+
+@node Contributing
+@chapter Contributing
+
+guile-rsv is developed using the Git version control system. The official
+repository is hosted at @url{https://git.dthompson.us/haunt.git}.
+
+Send patches and bug reports to @email{yuval.langer@gmail.com}.
+
+@c *********************************************************************
+@node GNU Free Documentation License
+@appendix GNU Free Documentation License
+
+@include fdl-1.3.texi
+
+@c *********************************************************************
+@node Concept Index
+@unnumbered Concept Index
+@printindex cp
+
+@node Programming Index
+@unnumbered Programming Index
+@syncodeindex tp fn
+@syncodeindex vr fn
+@printindex fn
+
+@bye
+
+@c Local Variables:
+@c ispell-local-dictionary: "american";
+@c End:
