X-Git-Url: http://git.marmaro.de/?p=mmh;a=blobdiff_plain;f=docs%2FREADME.manpages;h=40025d36bb7f5dfa2ca59ef014487e63eabc0e5e;hp=84275e946b58c18193631cff508d9f7ba8745b17;hb=4112940aea5591648b03a81907408752c08b33aa;hpb=5459cb05a6f5bba960e6501b9f03d7e16bc54f41 diff --git a/docs/README.manpages b/docs/README.manpages index 84275e9..40025d3 100644 --- a/docs/README.manpages +++ b/docs/README.manpages @@ -4,20 +4,19 @@ nmh manpages should be in this general form: .\" .\" %nmhwarning% -.\" $Id$ .\" .TH COMP %manext1% "%nmhdate%" MH.6.8 [%nmhversion%] .SH NAME comp \- compose a message .SH SYNOPSIS .HP 5 -.B comp +.B comp .RI [ +folder ] .RI [ msgs ] .RB [ \-form .IR formfile ] .RB [ \-use " | " \-nouse ] -.RB [ \-version ] +.RB [ \-Version ] .RB [ \-help ] .SH DESCRIPTION .B Comp @@ -70,8 +69,8 @@ Source files .PP Of course, replace "components" with a unique identifier that - reflects the content being included, like "mts_conf" for - etc/mts.conf. Then, add two lines to the man.sed target in + reflects the content being included, like "mhl_reply" for + etc/mhl.reply. Then, add two lines to the man.sed target in Makefile.in like: echo '/%components%/r $(top_srcdir)/etc/components' >> $@ @@ -101,12 +100,12 @@ SYNPOSIS section Literal text (such as flags) should be in bold. Parameters should be italicized. Mutually exclusive options (like - "-foo" and "-nofoo") should be grouped together and seperated + "-foo" and "-nofoo") should be grouped together and separated by a "|": .RI [ +folder ] <---- parameter .RI [ msgs ] <---- parameter - .RB [ \-version ] <---- flag + .RB [ \-Version ] <---- flag .RB [ \-editor <---- flag with .IR editor ] parameter .RB [ \-use " | " \-nouse ] <---- exclusive parameters @@ -157,17 +156,26 @@ Other italicized text Italicize file names, profile entries, and folder names: If a file named - .RI \*(lq components \*(rq + .RI ` components ' exists in the user's nmh directory, If the user's profile contains a - .RI \*(lq "Msg\-Protect: nnn" \*(rq + .RI ` "Msg\-Protect: nnn" ' entry, it - The \*(lq+\*(rq after + The `+' after .I inbox indicates that it is the current folder. Enclose the file names and profile entries in lq/rq quotes, too. +Pointer manpages + + Certain manpages are shared between one or more programs + (such as folder/folders). The secondary program should + have a man page that only contains: + + .so man1/folder.1 + + Also, add this manpage to the appropriate section in Makefile.in