Documentation updates; autogeneration of documentation from init.h.

--HG--
branch : HEAD

Makefile.am

@@ -51,8 +51,9 @@ EXTRA_DIST = COPYRIGHT GPL OPS OPS.PGP TODO configure acconfig.h attach.h \
 	mutt_regex.h mutt_socket.h mx.h pager.h parse.h pgp.h protos.h  \
 	reldate.h rfc1524.h rfc2047.h rfc2231.h rfc822.h sha.h sha_locl.h \
 	sort.h mime.types VERSION prepare _regex.h OPS.MIX	\
-	README.SECURITY remailer.c remailer.h browser.h Muttrc.in \
-	lib.h extlib.c pgpewrap pgplib.h
+	README.SECURITY remailer.c remailer.h browser.h \
+	lib.h extlib.c pgpewrap pgplib.h Muttrc.head Muttrc \
+	makedoc.c
 
 
 mutt_dotlock_SOURCES = mutt_dotlock.c
@@ -66,7 +67,7 @@ pgpring_DEPENDENCIES = @LIBOBJS@ $(INTLDEPS)
 mutt_dotlock.c: dotlock.c
 	cp $(srcdir)/dotlock.c mutt_dotlock.c
 
-CLEANFILES = mutt_dotlock.c
+CLEANFILES = mutt_dotlock.c stamp-doc-rc
 
 ACLOCAL_AMFLAGS = -I m4
 
@@ -144,3 +145,13 @@ us-dist: us-distdir
 	-chmod -R a+r $(distdir)-us
 	GZIP=$(GZIP) $(TAR) chozf $(distdir)-us.tar.gz $(distdir)-us
 	-rm -rf $(distdir)-us
+
+update-doc: stamp-doc-rc
+	(cd doc && make update-doc)
+
+stamp-doc-rc: $(srcdir)/init.h makedoc Muttrc.head
+	cpp -D_MAKEDOC -C -I. -I $(srcdir) -include config.h	\
+		$(srcdir)/init.h | ./makedoc -c | cat Muttrc.head - \
+		> Muttrc
+	touch stamp-doc-rc
+

Muttrc.head

@@ -0,0 +1,34 @@
+#
+# System configuration file for Mutt
+#
+
+# default list of header fields to weed when displaying
+#
+ignore "from " received content- mime-version status x-status message-id
+ignore sender references return-path lines
+
+# imitate the old search-body function
+macro index \eb '/~b ' 'search in message bodies'
+
+# simluate the old url menu
+macro index \cb |urlview\n 'call urlview to extract URLs out of a message'
+macro pager \cb |urlview\n 'call urlview to extract URLs out of a message'
+
+# Show documentation when pressing F1
+macro generic <f1> "!less /usr/local/doc/mutt/manual.txt\n" "Show Mutt documentation"
+macro index   <f1> "!less /usr/local/doc/mutt/manual.txt\n" "Show Mutt documentation"
+macro pager   <f1> "!less /usr/local/doc/mutt/manual.txt\n" "Show Mutt documentation"
+
+# If Mutt is unable to determine your site's domain name correctly, you can
+# set the default here.
+#
+# set hostname=cs.hmc.edu
+
+# If your sendmail supports the -B8BITMIME flag, enable the following
+#
+# set use_8bitmime
+
+##
+## More settings
+##
+

NEWS

@@ -1,6 +1,22 @@
 Major changes since 0.96.3
 --------------------------
 
+- The master source of the configuration option reference has been
+  moved from the SGML document into special comments in init.h.
+  "makedoc" is used to extract this information into a new,
+  documented global Muttrc, into the SGML manual, and into a new
+  manual page describing muttrc, muttrc (5).
+
+  This way, _all_ options will automatically get minimal
+  documentation, with correct default values. :-)
+
+  For details, see doc/devel-notes.txt.
+
+- While the manual was under inspection, hopefully most of the
+  recent changes to mutt were documented.  Also, documentation on
+  some not-so-recent things such as mixmaster and PGP support was
+  added or improved.
+
 - The $in_reply_to configuration variable is gone.  The In-Reply-To
   header currently only contains the message-id of the message to
   which the reply refers.  This is to make sure that this header is
@@ -23,35 +39,14 @@ Major changes since 0.96.3
   to use IMAP folders for postponed messages, improved IMAP folder
   browsing, tab completion for IMAP folders, etc.
 
-- A new variable $from is added.
-
-  * $from is used as the default from address, if defined.
-    Otherwise, the local user nanme and (if the user wishes so) the
-    local domain are used.
-  * This address can be overridden by $reverse_name, if set.
-  * Now, send-hooks are evaluated.
-  * Afterwards, user headers are evaluated.  In this step, the from
-    header can be overridden using my_hdr From:.
-  * When there is no real name, $realname is used for it.  Note
-    that, when the default from header is used and $from defines a
-    real name, it takes precedence over $realname.
-
-- There is a new model for mailing list handling: We distinguish
-  between subscribed and unsubscribed lists.  With the configuration
-  command "lists", you add a list to the list of known mailing
-  lists.  With "subscribe", you add a list to the lists of known
-  _and_ subscribed lists.  With "unsubscribe", you remove a list
-  from the list of subscribed lists.  With "unlists", you remove a
-  list from the lists of subscribed and known mailing lists.
-
-  The list of known mailing lists is used for the list-reply command
-  and the $ignore_list_reply_to configuration optio.  The list of
-  subscribed mailig lists is used for header display, and the
-  construction of Mail-Followup-To headers.
-
-- The various weeding options are gone.  You have a global option
-  $weed now which can be influenced using confugration commands, or
-  using the display-headers or display-message functions.  This
+- A new variable $from is added.  See the manual for details.
+
+- There is a new model for mailing list handling.  See the manual
+  for details.
+
+- The various weeding options are gone.  You have one global option,
+  $weed, now which can be influenced using configuration commands,
+  or using the display-headers or display-message functions.  This
   option is applied when forwarding, replying, or printing messages.
   Essentially, this means that you have some "WYSIWIG-like"
   behaviour with respect to message header weeding.

configure.in

@@ -505,9 +505,8 @@ MUTTLOCALEDIR=$mutt_cv_prefix/$DATADIRNAME/locale
 AC_SUBST(MUTTLOCALEDIR)
 AC_DEFINE_UNQUOTED(MUTTLOCALEDIR, "$MUTTLOCALEDIR")
 
-output="Makefile intl/Makefile m4/Makefile po/Makefile.in Muttrc	\
-	doc/Makefile doc/manual.sgml doc/dotlock.man doc/mutt.man 	\
-	contrib/Makefile"
+output="Makefile intl/Makefile m4/Makefile po/Makefile.in 	\
+	doc/Makefile contrib/Makefile"
 
 if test -d $srcdir/charmaps ; then
 	output="$output charmaps/Makefile"