* guile/mu4e: refactor doc building a bit

This commit is contained in:
djcb
2012-10-19 16:00:41 +03:00
parent 47286442e1
commit f0be196209
7 changed files with 75 additions and 50 deletions

View File

@ -28,7 +28,7 @@ else
mu4e= mu4e=
endif endif
SUBDIRS=m4 man lib $(guile) mu $(mu4e) contrib toys SUBDIRS=m4 texi man lib $(guile) mu $(mu4e) contrib toys
ACLOCAL_AMFLAGS=-I m4 ACLOCAL_AMFLAGS=-I m4

View File

@ -303,16 +303,15 @@ AS_IF([test "x$PMCCABE" = "xno"],[
],[have_pmccabe="yes"]) ],[have_pmccabe="yes"])
############################################################################### ###############################################################################
AC_CONFIG_FILES([ AC_CONFIG_FILES([
Makefile Makefile
texi/version.texi
mu/Makefile mu/Makefile
mu/tests/Makefile mu/tests/Makefile
lib/Makefile lib/Makefile
lib/tests/Makefile lib/tests/Makefile
mu4e/Makefile mu4e/Makefile
mu4e/mu4e-meta.el mu4e/mu4e-meta.el
mu4e/version.texi
guile/Makefile guile/Makefile
guile/mu/Makefile guile/mu/Makefile
guile/examples/Makefile guile/examples/Makefile

View File

@ -2,13 +2,15 @@
@c %**start of header @c %**start of header
@setfilename mu-guile.info @setfilename mu-guile.info
@settitle mu-guile user manual @settitle mu-guile user manual
@documentencoding utf-8
@c %**end of header
@dircategory The Algorithmic Language Scheme @c Use proper quote and backtick for code sections in PDF output
@direntry @c Cf. Texinfo manual 14.2
* mu-guile manual: (mu-guile). Guile bindings for the @t{mu} e-mail indexer/searcher. @set txicodequoteundirected
@end direntry @set txicodequotebacktick
@documentencoding UTF-8
@c %**end of header
@include ../texi/version.texi
@copying @copying
Copyright @copyright{} 2012 Dirk-Jan C. Binnema Copyright @copyright{} 2012 Dirk-Jan C. Binnema
@ -23,14 +25,39 @@ Documentation License.''
@end quotation @end quotation
@end copying @end copying
@titlepage
@title @t{mu-guile} - extending @t{mu} with Guile Scheme
@subtitle{version @value{mu-version}}
@author Dirk-Jan C. Binnema
@c The following two commands start the copyright page.
@page
@vskip 0pt plus 1filll
@insertcopying
@end titlepage
@dircategory The Algorithmic Language Scheme
@direntry
* Mu-guile: (mu-guile). Guile-bindings for the mu e-mail indexer/searcher
@end direntry
@contents
@ifnottex
@node Top @node Top
@top mu4e Manual @top mu-guile manual
@end ifnottex
@iftex
@node Welcome to mu-guile
@unnumbered Welcome to mu-guile
@end iftex
Welcome to @t{mu-guile}! Welcome to @t{mu-guile}!
@t{mu-guile} is a binding of the @t{mu} email search engine for the @t{guile} @t{mu-guile} is a binding of the @t{mu} email search-engine for the @t{guile}
programming language. That means that you can write simple (and not so simple) programming language. Using this binding, you can write simple (and not so
programs to data-mine your e-mail database. simple) programs/scripts to data-mine your e-mail corpus.
@menu @menu
* Introduction:: * Introduction::
@ -50,7 +77,7 @@ Appendices
@node Introduction @node Introduction
@chapter Introduction @chapter Introduction
@t{mu} is a program for indexing / searching e-mails stored in Maildirs. @t{mu} is a program for indexing and searching e-mails stored in maildirs.
@t{guile} is the @emph{GNU Ubiquitous Intelligent Language for Extensions} - a @t{guile} is the @emph{GNU Ubiquitous Intelligent Language for Extensions} - a
version of the @emph{Scheme} programming language and the official GNU version of the @emph{Scheme} programming language and the official GNU
@ -185,16 +212,16 @@ Geiser@footnote{@url{http://www.nongnu.org/geiser/}}.
@node Initializing mu-guile @node Initializing mu-guile
@chapter Initializing mu-guile @chapter Initializing mu-guile
It is of course possible to write separate programs with @t{mu-guile}, but for It is possible to write separate programs with @t{mu-guile}, but for now we'll
now we'll do things @emph{interactively}, i.e., from the Guile-prompt do things @emph{interactively}, i.e., from the Guile-prompt (``@abbr{REPL}'').
(``@abbr{REPL}'').
We start our @t{mu-guile} session by starting @t{guile}: We start our @t{mu-guile} session by starting @t{guile}:
@cartouche
@verbatim @verbatim
$ guile $ guile
GNU Guile 2.0.3.82-a2c66 GNU Guile 2.0.5.123-4bd53
Copyright (C) 1995-2011 Free Software Foundation, Inc. Copyright (C) 1995-2012 Free Software Foundation, Inc.
Guile comes with ABSOLUTELY NO WARRANTY; for details type `,show w'. Guile comes with ABSOLUTELY NO WARRANTY; for details type `,show w'.
This program is free software, and you are welcome to redistribute it This program is free software, and you are welcome to redistribute it
@ -203,6 +230,7 @@ under certain conditions; type `,show c' for details.
Enter `,help' for help. Enter `,help' for help.
scheme@(guile-user)> scheme@(guile-user)>
@end verbatim @end verbatim
@end cartouche
The first thing we need to do is loading the modules. All the basics are in The first thing we need to do is loading the modules. All the basics are in
the @t{(mu)} module, with some statistical extras in @t{(mu stats)}, and some the @t{(mu)} module, with some statistical extras in @t{(mu stats)}, and some
@ -739,6 +767,7 @@ exec guile -s $0 $@
(mu:plot (mail-per-hour-table) "Mail per hour" "Hour" "Frequency" #t) (mu:plot (mail-per-hour-table) "Mail per hour" "Hour" "Frequency" #t)
@end lisp @end lisp
@cartouche
@verbatim @verbatim
Mail per hour Mail per hour
Frequency Frequency
@ -763,9 +792,10 @@ exec guile -s $0 $@
0 1 2 3 4 5 6 7 8 910 11 12 1314 15 16 17 1819 20 21 22 23 0 1 2 3 4 5 6 7 8 910 11 12 1314 15 16 17 1819 20 21 22 23
Hour Hour
@end verbatim @end verbatim
@end cartouche
@node GNU Free Documentation License @node GNU Free Documentation License
@appendix GNU Free Documentation License @appendix GNU Free Documentation License
@include fdl.texi @include ../texi/fdl.texi
@bye @bye

View File

@ -19,7 +19,6 @@ include $(top_srcdir)/gtest.mk
SUBDIRS= SUBDIRS=
info_TEXINFOS=mu4e.texi info_TEXINFOS=mu4e.texi
mu4e_TEXINFOS=fdl.texi
lispdir=${prefix}/share/emacs/site-lisp/mu4e/ lispdir=${prefix}/share/emacs/site-lisp/mu4e/
@ -40,9 +39,6 @@ dist_lisp_LISP= \
mu4e.el \ mu4e.el \
org-mu4e.el org-mu4e.el
# BUILT_SOURCES= \
# mu4e-about.el
mu4e-about.el: mu4e-about.org mu4e-about.el: mu4e-about.org
@echo ";; auto-generated" > mu4e-about.el @echo ";; auto-generated" > mu4e-about.el
@echo "(defconst mu4e-about \"" >> mu4e-about.el @echo "(defconst mu4e-about \"" >> mu4e-about.el

View File

@ -1,3 +0,0 @@
@c the version for mu/mu4e
@set mu4e-version @VERSION@

3
texi/version.texi.in Normal file
View File

@ -0,0 +1,3 @@
@c the version for mu for including in texinfo docs
@set mu-version @VERSION@