shithub: Nail

Download patch

ref: f5b72c448dd87ddb2ad5392e637cf89a20a2a0e6
parent: 1d3858eee15e06ebca88004ac454d1f534a2322f
author: Ori Bernstein <[email protected]>
date: Sat Nov 14 14:37:03 EST 2020

manpage

--- a/mkfile
+++ b/mkfile
@@ -9,7 +9,16 @@
 	win.$O
 
 HFILES=mail.h
+MAN=/sys/man/1/
 
 BIN=/acme/bin/$objtype
 
 </sys/src/cmd/mkone
+
+# Ugh. man doesn't handle uppercase
+# names for manpages.
+
+man:V: $MAN/nail
+
+$MAN/nail: nail.man
+	cp $prereq $target
--- /dev/null
+++ b/nail.man
@@ -1,0 +1,121 @@
+.TH NAIL 4
+.SH NAME
+Nail \- view mail in acme
+
+.SH SYNOPSIS
+
+Nail
+[
+.B -Ts
+]
+[
+.B -f
+.I maildir
+]
+
+.SH DESCRIPTION
+.PP
+.B Nail
+edits a mailbox in an
+.IR acme (1)
+environment.
+The default mailbox is /mail/fs/mbox.
+Nail shows 3 views:
+The list view, the message view, and the composition view.
+
+.PP
+At startup,
+.B Nail
+takes the following options:
+.PD 0
+.TP
+.B -T
+Disable threading
+.PD 0
+.TP
+.BI -f " maildir
+Open the maildir
+.I maildir
+instead of the default
+.I -s
+Accept sendmail plumb messages. By default, only
+the Nail instance viewing /mail/fs/mbox will
+accept plumb messages.
+
+.PP
+Nail presents a typical acme interface. When started,
+text commands are inserted into the tag bar. In the message
+view, the commands typically apply to the selected messages.
+In the message and composition views, they typically apply
+to the current message.
+
+.PP
+The following text commands are recognized by the message
+list:
+
+.TP
+.B Put
+Flush pending chnages back to
+.IR upasfs (4).
+.PD 0
+.TP
+.B Delmesg, Undelmesg
+Flags a message for deletion on the next
+.I Put
+invocation.
+.PD 0
+.TP
+.B Next
+Select the next unread message in the mailbox.
+.PD 0
+.TP
+.B Mark [±flags]
+Add or remove message flags. The flags recognized
+are listed in
+.IR upasfs (4)
+.PD 0
+.TP
+.B Redraw
+Redraws the contents of the mailbox.
+
+.PP
+The following text commands are recognized by the message
+view:
+
+.TP
+.B [Q] Reply [all]
+Replies to a message. If 'Q' is specified, quote the open message.
+If all is specified, reply to all addresses on the message.
+.PD 0
+.TP
+.B Delmesg, Undelmesg
+As with the message view, but applied to the open message.
+.PD 0
+.TP
+.B Mark
+As with the message view, but applied to the open message.
+
+.PP
+The following text commands are recognized by the composition
+window:
+
+.TP
+.B Post
+Sends the message currently being composed.
+
+.SH FILES
+
+.SH "SEE ALSO"
+.IR mail (1),
+.IR aliasmail (8),
+.IR filter (1),
+.IR marshal (1),
+.IR mlmgr (1),
+.IR nedmail (1),
+.IR upasfs (4),
+.IR smtp (8),
+.IR faces (1),
+.IR rewrite (6)
+
+.SH BUGS
+Probably.