Automated generation of mh-chart.man7.
authormarkus schnalke <meillo@marmaro.de>
Tue, 27 Mar 2012 15:39:32 +0000 (17:39 +0200)
committermarkus schnalke <meillo@marmaro.de>
Tue, 27 Mar 2012 15:39:32 +0000 (17:39 +0200)
Moved mh-chart from section 1 to section 7, in the same go.

Based upon a pull-in from nmh. Thanks a lot to David Levine.
Autogenerating is the only sensible approach to mh-chart.

.gitignore
man/Makefile.in
man/mh-chart-gen.sh [new file with mode: 0755]
man/mh-chart.man1 [deleted file]
man/pick.man1
man/prompter.man1
man/sendfiles.man1

index b5b89d6..d83d870 100644 (file)
@@ -15,6 +15,7 @@
 /h/Makefile
 /man/Makefile
 /man/man.sed
+/man/mh-chart.man7
 /sbr/Makefile
 /sbr/dtimep.c
 /sbr/libmh.a
index e7f58be..08a2bc1 100644 (file)
@@ -30,7 +30,7 @@ INSTALL      = @INSTALL@
 INSTALL_DATA = @INSTALL_DATA@
 
 SED = sed
-SEDMAN = @$(SED) -f man.sed $< > $@
+SEDMAN = $(SED) -f man.sed $< > $@
 
 .SUFFIXES:
 .SUFFIXES: .man1 .man5 .man7 .man8 \
@@ -50,7 +50,7 @@ SEDMAN = @$(SED) -f man.sed $< > $@
 
 # man pages to install in $(mandir)/$(manext1)
 MAN1SRC = ali. anno. burst. comp. dist. flist. flists. folder. folders.    \
-       forw. inc. mark. mh-chart. mhbuild. mhl. mhlist. mmh.               \
+       forw. inc. mark. mhbuild. mhl. mhlist. mmh.               \
        mhmail. mhparam. mhpath. mhshow. mhstore. msgchk. new. fnext.       \
        fprev. unseen. next. packf. pick. prev. prompter. rcvdist. rcvpack. \
        rcvstore. refile. repl. rmf. rmm. scan. send. sendfiles.    \
@@ -58,7 +58,7 @@ MAN1SRC = ali. anno. burst. comp. dist. flist. flists. folder. folders.    \
 
 MAN5SRC = mh-alias. mh-format. mh-mail. mh-profile. mh-tailor.
 
-MAN7SRC = mmh-intro. mh-draft. mh-sequence. 
+MAN7SRC = mmh-intro. mh-chart. mh-draft. mh-sequence. 
 
 MAN8SRC = ap. dp. fmtdump. post.
 
@@ -74,15 +74,19 @@ DIST_MAN7 = $(MAN7SRC:.=.man7)
 DIST_MAN8 = $(MAN8SRC:.=.man8)
 
 # auxiliary files
-AUX = Makefile.in
+AUX = Makefile.in mh-chart-gen.sh
 
 # all files in this directory included in the distribution
 DIST = $(DIST_MAN1) $(DIST_MAN5) $(DIST_MAN7) $(DIST_MAN8) $(AUX)
+ALLPROGS = $(DIST_MAN1) $(DIST_MAN8)
 
 # ========= DEFAULT TARGET ==========
 
 all: $(MAN1) $(MAN5) $(MAN7) $(MAN8)
 
+mh-chart.man7: $(ALLPROGS)
+       $(srcdir)/mh-chart-gen.sh $(ALLPROGS) >$@
+
 $(MAN1) $(MAN5) $(MAN7) $(MAN8): man.sed
 
 # create the sed file for building man pages
@@ -179,7 +183,8 @@ mostlyclean:
        rm -f *~
 
 clean: mostlyclean
-       rm -f man.sed *.$(manext1) *.$(manext5) *.$(manext7) *.$(manext8)
+       rm -f $(MAN1) $(MAN5) $(MAN7) $(MAN8)
+       rm -f man.sed mh-chart.man7
 
 distclean: clean
        rm -f Makefile
diff --git a/man/mh-chart-gen.sh b/man/mh-chart-gen.sh
new file mode 100755 (executable)
index 0000000..72a2b38
--- /dev/null
@@ -0,0 +1,33 @@
+#! /bin/sh
+#
+# Generates mh-chart man page from other man page source files that have a
+# SYNOPSIS section.
+
+cat <<!
+.\"
+.\" %nmhwarning%
+.\"
+.TH MH-CHART %manext7% "%nmhdate%" MH.6.8 [%nmhversion%]
+.SH NAME
+mh-chart \- Chart of mmh Commands
+.SH SYNOPSIS
+.na
+!
+
+for i do
+       #### Extract lines from just after .SH SYNOPSIS to just before .ad.
+       <"$i" awk '
+               /.SH SYNOPSIS/ {p=1}
+               /^\.ad/ {p=0}
+               /^(\.SH SYNOPSIS|\.na|\.ad)/ {next}
+               p
+       '
+       echo
+done
+
+cat <<!
+.ad
+
+.SH "SEE ALSO"
+mmh(1)
+!
diff --git a/man/mh-chart.man1 b/man/mh-chart.man1
deleted file mode 100644 (file)
index 9190405..0000000
+++ /dev/null
@@ -1,619 +0,0 @@
-.\"
-.\" %nmhwarning%
-.\"
-.TH MH-CHART %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
-.SH NAME
-mh-chart \- Chart of nmh Commands
-.SH SYNOPSIS
-.na
-.HP 5
-.B ali
-.RB [ \-alias
-.IR aliasfile ]
-.RB [ \-list " | " \-nolist ]
-.RB [ \-normalize " | " \-nonormalize ]
-.RB [ \-user " | " \-nouser ]
-.RB [ \-version ]
-.RB [ \-help ]
-.RI [ aliases " ...]"
-
-.HP 5
-.B anno
-.RI [ +folder ]
-.RI [ msgs ]
-.RB [ \-component
-.IR field ]
-.RB [ \-date " | " \-nodate ]
-.RB [ \-version ]
-.RB [ \-help ]
-.RB [ \-text
-.IR body ]
-
-.HP 5
-.B %libdir%/ap
-.RB [ \-form
-.IR formatfile ]
-.RB [ \-normalize " | " \-nonormalize ]
-.RB [ \-version ]
-.RB [ \-help ]
-.I addrs
-\&...
-
-.HP 5
-.B burst
-.RI [ +folder ]
-.RI [ msgs ]
-.RB [ \-inplace " | " \-noinplace ]
-.RB [ \-quiet " | " \-noquiet ]
-.RB [ \-verbose " | " \-noverbose ]
-.RB [ \-version ]
-.RB [ \-help ]
-
-.HP 5
-.B comp
-.RI [ +folder ]
-.RI [ msgs ]
-.RB [ \-form
-.IR formfile ]
-.RB [ \-use " | " \-nouse ]
-.RB [ \-editor
-.IR editor ]
-.RB [ \-noedit ]
-.RB [ \-whatnowproc
-.IR program ]
-.RB [ \-nowhatnowproc ]
-.RB [ \-version ]
-.RB [ \-help ]
-
-.HP 5
-.B dist
-.RI [ +folder ]
-.RI [ msgs ]
-.RB [ \-form
-.IR formfile ]
-.RB [ \-annotate " | " \-noannotate ]
-.RB [ \-editor
-.IR editor ]
-.RB [ \-noedit ]
-.RB [ \-whatnowproc
-.IR program ]
-.RB [ \-nowhatnowproc ]
-.RB [ \-version ]
-.RB [ \-help ]
-
-.HP 5
-.B %libdir%/dp
-.RB [ \-form
-.IR formatfile ]
-.RB [ \-version ]
-.RB [ \-help ]
-.I dates
-\&...
-
-.HP 5
-.B flist
-.RI [ +folder1
-.RI [ +folder2
-\&...]]
-.RB [ \-sequence
-.I name1
-.RB [ \-sequence
-.I name2
-\&...]]
-.RB [ \-all " | " \-noall ]
-.RB [ \-showzero " | " \-noshowzero ]
-.RB [ \-recurse " | " \-norecurse ]
-.RB [ \-fast " | " \-nofast ]
-.RB [ \-alpha " | " \-noalpha ]
-.RB [ \-version ]
-.RB [ \-help ]
-.PP
-.HP 5
-.B flists
-is equivalent to
-.B flist
-.B \-all
-
-.HP 5
-.B %libdir%/fmtdump
-.RB [ \-form
-.IR formatfile ]
-.RB [ \-version ]
-.RB [ \-help ]
-
-.HP 5
-.B folder
-.RI [ +folder ]
-.RI [ msgs ]
-.RB [ \-all " | " \-noall ]
-.RB [ \-create " | " \-nocreate ]
-.RB [ \-fast " | " \-nofast ]
-.RB [ \-header " | " \-noheader ]
-.RB [ \-recurse " | " \-norecurse ]
-.RB [ \-total " | " \-nototal ]
-.RB [ \-list " | " \-nolist ]
-.RB [ \-push " | " \-pop ]
-.RB [ \-pack " | " \-nopack ]
-.RB [ \-print ]
-.RB [ \-verbose " | " \-noverbose ]
-.RB [ \-version ]
-.RB [ \-help ]
-.PP
-.HP 5
-.B folders
-is equivalent to
-.B folder
-.B \-all
-
-.HP 5
-.B forw
-.RI [ +folder ]
-.RI [ msgs ]
-.RB [ \-annotate " | " \-noannotate ]
-.RB [ \-form
-.IR formfile ]
-.RB [ \-editor
-.IR editor ]
-.RB [ \-noedit ]
-.RB [ \-whatnowproc
-.IR program ]
-.RB [ \-nowhatnowproc ]
-.RB [ \-build ]
-.RB [ \-version ]
-.RB [ \-help ]
-.PP
-.HP 5
-.B forw
-.RI [ +folder ]
-.RI [ msgs ]
-.RB [ \-digest
-.IR list ]
-.RB [ \-issue
-.IR number ]
-.RB [ \-volume
-.IR number ]
-[other\ switches\ for
-.BR forw ]
-.RB [ \-version ]
-.RB [ \-help ]
-
-.HP 5
-.B inc
-.RI [ +folder ]
-.RB [ \-audit
-.IR audit\-file ]
-.RB [ \-noaudit ]
-.RB [ \-changecur " | " \-nochangecur ]
-.RB [ \-form
-.IR formfile ]
-.RB [ \-file
-.IR name ]
-.RB [ \-silent " | " \-nosilent ]
-.RB [ \-truncate " | " \-notruncate ]
-.RB [ \-width
-.IR columns ]
-.RB [ \-version ]
-.RB [ \-help ]
-
-.HP 5
-.B mmh
-.RB [ \-check ]
-.RB [ \-version ]
-.RB [ \-help ]
-
-.HP 5
-.B mark
-.RI [ +folder ]
-.RI [ msgs ]
-.RB [ \-sequence
-.I name
-\&...]
-.RB [ \-add " | " \-delete ]
-.RB [ \-list ]
-.RB [ \-public " | " \-nopublic ]
-.RB [ \-zero " | " \-nozero ]
-.RB [ \-version ]
-.RB [ \-help ]
-
-.HP 5
-.B mhlist
-.RI [ +folder ]
-.RI [ msgs ]
-.RB [ \-file
-.IR file ]
-.RB [ \-part
-.IR number ]
-\&...
-.RB [ \-type
-.IR content ]
-\&...
-.RB [ \-headers " | " \-noheaders ]
-.RB [ \-realsize " | " \-norealsize ]
-.RB [ \-rcache
-.IR policy ]
-.RB [ \-wcache
-.IR policy ]
-.RB [ \-check " | " \-nocheck ]
-.RB [ \-verbose " | " \-noverbose ]
-.RB [ \-version ]
-.RB [ \-help ]
-
-.HP 5
-.B mhl
-.RB [ \-folder
-.IR +folder ]
-.RB [ \-form
-.IR formfile ]
-.RB [ \-width
-.IR columns ]
-.RI [ files
-.IR \&... ]
-.RB [ \-version ]
-.RB [ \-help ]
-
-.HP 5
-.B mhmail
-.RI [ addrs
-\&...]
-.RB [ \-body
-.IR text ]
-.RB [ \-cc
-.I addrs
-\&...]
-.RB [ \-from
-.IR addr ]
-.RB [ \-subject
-.IR subject ]
-.RB [ \-version ]
-.RB [ \-help ]
-
-.HP 5
-.B mhpath
-.RI [ +folder ]
-.RI [ msgs ]
-.RB [ \-version ]
-.RB [ \-help ]
-
-.HP 5
-.B mhshow
-.RI [ +folder ]
-.RI [ msgs ]
-.RB [ \-file
-.IR file ]
-.RB [ \-part
-.IR number ]
-\&...
-.RB [ \-type
-.IR content ]
-\&...
-.RB [ \-serialonly " | " \-noserialonly ]
-.RB [ \-form
-.IR formfile ]
-.RB [ \-rcache
-.IR policy ]
-.RB [ \-wcache
-.IR policy ]
-.RB [ \-check " | " \-nocheck ]
-.RB [ \-version ]
-.RB [ \-help ]
-
-.HP 5
-.B mhstore
-.RI [ +folder ]
-.RI [ msgs ]
-.RB [ \-file
-.IR file ]
-.RB [ \-part
-.IR number ]
-\&...
-.RB [ \-type
-.IR content ]
-\&...
-.RB [ \-auto " | " \-noauto ]
-.RB [ \-rcache
-.IR policy ]
-.RB [ \-wcache
-.IR policy ]
-.RB [ \-check " | " \-nocheck ]
-.RB [ \-version ]
-.RB [ \-help ]
-
-.HP 5
-.B msgchk
-.RB [ \-date " | " \-nodate ]
-.RB [ \-notify
-all/mail/nomail ]
-.RB [ \-nonotify
-all/mail/nomail ]
-.RI [ users
-\&... ]
-.RB [ \-version ]
-.RB [ \-help ]
-
-.HP 5
-.B next
-.RI [ +folder ]
-.RB [\-showproc
-.IR program ]
-.RB [ \-showmimeproc
-.IR program ]
-.RB [ \-header " | " \-noheader ]
-.RB [ \-checkmime " | " \-nocheckmime ]
-[switches\ for
-.I showproc
-or
-.IR showmimeproc ]
-.RB [ \-version ]
-.RB [ \-help ]
-
-.HP 5
-.B packf
-.RI [ +folder ]
-.RI [ msgs ]
-.RB [ \-file
-.IR name ]
-.RB [ \-version ]
-.RB [ \-help ]
-
-.HP 5
-.B pick
-.RI [ +folder ]
-.RI [ msgs ]
-.RB [ \-and
-\&...]
-.RB [ \-or
-\&...]
-.RB [ \-not
-\&...]
-.RB [ \-lbrace
-\&...
-.BR \-rbrace ]
-.RB [ \-\|\-component
-.IR pattern ]
-.RB [ \-cc
-.IR pattern ]
-.RB [ \-date
-.IR pattern ]
-.RB [ \-from
-.IR pattern ]
-.RB [ \-search
-.IR pattern ]
-.RB [ \-subject
-.IR pattern ]
-.RB [ \-to
-.IR pattern ]
-.RB [ \-after
-.IR date ]
-.RB [ \-before
-.IR date ]
-.RB [ \-datefield
-.IR field ]
-.RB [ \-sequence
-.I name
-\&...]
-.RB [ \-public " | " \-nopublic ]
-.RB [ \-zero " | " \-nozero ]
-.RB [ \-list " | " \-nolist ]
-.RB [ \-version ]
-.RB [ \-help ]
-
-.HP 5
-.B spost
-.RB [ \-alias
-.IR aliasfile
-.RB " | " \-noalias ]
-.RB [ \-dist ]
-.RB [ \-push " | " \-nopush ]
-.RB [ \-verbose " | " \-noverbose ]
-.RB [ \-watch " | " \-nowatch ]
-.I file
-.RB [ \-version ]
-.RB [ \-help ]
-
-.HP 5
-.B prev
-.RI [ +folder ]
-.RB [\-showproc
-.IR program ]
-.RB [ \-showmimeproc
-.IR program ]
-.RB [ \-header " | " \-noheader ]
-.RB [ \-checkmime " | " \-nocheckmime ]
-[switches\ for
-.I showproc
-or
-.IR showmimeproc ]
-.RB [ \-version ]
-.RB [ \-help ]
-
-.HP 5
-.B rcvdist
-.RB [ \-form
-.IR formfile ]
-[switches\ for
-.BR spost ]
-.I address1
-\&...
-.RB [ \-version ]
-.RB [ \-help ]
-
-.HP 5
-.B rcvpack
-.I file
-.RB [ \-version ]
-.RB [ \-help ]
-
-.HP 5
-.B rcvstore
-.RI [ +folder ]
-.RB [ \-create " | " \-nocreate ]
-.RB [ \-unseen " | " \-nounseen ]
-.RB [ \-zero " | " \-nozero ]
-.RB [ \-sequence
-.I name
-\&...]
-.RB [ \-public " | " \-nopublic ]
-.RB [ \-version ]
-.RB [ \-help ]
-
-.HP 5
-.B refile
-.RI [ msgs ]
-.RB [ \-draft ]
-.RB [ \-link " | " \-nolink ]
-.RB [ \-preserve " | " \-nopreserve ]
-.RB [ \-unlink " | " \-nounlink ]
-.RB [ \-src
-.IR +folder ]
-.RB [ \-file
-.IR file ]
-.RB [ \-rmmproc
-.IR program ]
-.RB [ \-normmproc ]
-.I +folder1
-\&...
-.RB [ \-version ]
-.RB [ \-help ]
-
-.HP 5
-.B repl
-.RI [ +folder ]
-.RI [ msgs ]
-.RB [ \-annotate " | " \-noannotate ]
-.RB [ \-group " | " \-nogroup ]
-.RB [ \-cc
-all/to/cc/me]
-.RB [ \-nocc
-all/to/cc/me]
-.RB [ \-query " | " \-noquery ]
-.RB [ \-form
-.IR formfile ]
-.RB [ \-filter
-.IR filterfile
-.RB " | " \-nofilter ]
-.RB [ \-mime " | " \-nomime ]
-.RB [ \-editor
-.IR editor ]
-.RB [ \-noedit ]
-.RB [ \-whatnowproc
-.IR program ]
-.RB [ \-nowhatnowproc ]
-.RB [ \-build ]
-.RB [ \-file
-.IR msgfile ]
-.RB [ \-version ]
-.RB [ \-help ]
-
-.HP 5
-.B rmf
-.RI [ +folder ]
-.RB [ \-interactive " | " \-nointeractive ]
-.RB [ \-version ]
-.RB [ \-help ]
-
-.HP 5
-.B rmm
-.RI [ +folder ]
-.RI [ msgs ]
-.RB [ \-link " | " \-nolink ]
-.RB [ \-version ]
-.RB [ \-help ]
-
-.HP 5
-.B scan
-.RI [ +folder ]
-.RI [ msgs ]
-.RB [ \-form
-.IR formatfile ]
-.RB [ \-width
-.IR columns ]
-.RB [ \-file
-.IR filename ]
-.RB [ \-version ]
-.RB [ \-help ]
-
-.HP 5
-.B send
-.RB [ \-alias
-.IR aliasfile ]
-.RB [ \-forward " | " \-noforward ]
-.RB [ \-push " | " \-nopush ]
-.RB [ \-verbose " | " \-noverbose ]
-.RB [ \-watch " | " \-nowatch ]
-.RB [ file
-\&...]
-.RB [ \-version ]
-.RB [ \-help ]
-
-.HP 5
-.B show
-.RI [ +folder ]
-.RI [ msgs ]
-.RB [ \-draft ]
-.RB [\-showproc
-.IR program ]
-.RB [ \-showmimeproc
-.IR program ]
-.RB [ \-header " | " \-noheader ]
-.RB [ \-checkmime " | " \-nocheckmime ]
-[switches\ for
-.I showproc
-or
-.IR showmimeproc ]
-.RB [ \-version ]
-.RB [ \-help ]
-
-.HP 5
-.B slocal
-[address\ info\ sender]
-.RB [ \-addr
-.IR address ]
-.RB [ \-info
-.IR data ]
-.RB [ \-sender
-.IR sender ]
-.RB [ \-user
-.IR username ]
-.RB [ \-mailbox
-.IR mbox ]
-.\" \%[\-home\ homedir]
-.RB [ \-file
-.IR file ]
-.RB [ \-maildelivery
-.IR deliveryfile ]
-.RB [ \-verbose " | " \-noverbose ]
-.RB [ \-debug ]
-.RB [ \-version ]
-.RB [ \-help ]
-
-.HP 5
-.B sortm
-.RI [ +folder ]
-.RI [ msgs ]
-.RB [ \-datefield
-.IR field ]
-.RB [ \-textfield
-.IR field ]
-.RB [ \-notextfield ]
-.RB [ \-limit
-.IR days ]
-.RB [ \-nolimit ]
-.RB [ \-verbose " | " \-noverbose ]
-.RB [ \-version ]
-.RB [ \-help ]
-
-.HP 5
-.B whatnow
-.RB [ \-editor
-.IR editor ]
-.RB [ \-noedit ]
-.RB [ \-prompt
-.IR string ]
-.RI [ file ]
-.RB [ \-version ]
-.RB [ \-help ]
-
-.ad
-
-.SH "SEE ALSO"
-nmh(1)
index b55b748..e9d1941 100644 (file)
@@ -47,6 +47,7 @@ pick \- search for messages by content
 .RB [ \-list " | " \-nolist ]
 .RB [ \-version ]
 .RB [ \-help ]
+.ad
 .PP
 typical usage:
 .PP
index aa7b4fc..9f183e3 100644 (file)
@@ -18,7 +18,7 @@ prompter \- prompting editor front-end for nmh
 .I file
 .RB [ \-version ]
 .RB [ \-help ]
-.fi
+.ad
 .SH DESCRIPTION
 .B Prompter
 is an editor front\-end for
index f2015b4..2920b69 100644 (file)
@@ -5,7 +5,7 @@
 .SH NAME
 sendfiles \- send multiple files in a MIME message
 .SH SYNOPSIS
-.HP
+.HP 5
 .na
 .B sendfiles
 .I recipient