mischief/openbsd-src
1
0
Fork 0
mirror of https://github.com/openbsd/src.git synced 2025-01-10 06:47:55 -08:00
Code

- ~<, ~_ are undocumented aliases of ~r, ~:

Browse Source 
- missing documentation for ~.
- use compact list, and .Pp.  so that aliases could be listed
- reformat to fit aliases in tilde help
with help & ok jmc@, sobrado@, millert@
This commit is contained in:
martynas 2009-07-29 18:15:38 +00:00
parent 6fe37b1cd6
commit 3a53bb80c7
3 changed files with 79 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
usr.bin/mail/USD.doc/mail9.nr
View File

@ -1,4 +1,4 @@
.\" $OpenBSD: mail9.nr,v 1.7 2008/11/03 20:07:42 jmc Exp $ .\" $OpenBSD: mail9.nr,v 1.8 2009/07/29 18:15:38 martynas Exp $
.\" .\"
.\" Copyright (c) 1980, 1993 .\" Copyright (c) 1980, 1993
.\" The Regents of the University of California. All rights reserved. .\" The Regents of the University of California. All rights reserved.
@ -156,28 +156,29 @@ c ci ci
l li l. l li l.
Escape Arguments Description Escape Arguments Description
_ _
~b name ... Add names to "blind" Cc: list. ~b name ... Add names to "blind" Cc: list.
~c name ... Add names to Cc: field. ~c name ... Add names to Cc: field.
~d Read \fIdead.letter\fP into message. ~d Read \fIdead.letter\fP into message.
~e Invoke text editor on partial message. ~e Invoke text editor on partial message.
~F messages Same as ~f, but includes all headers. ~F messages Same as ~f, but includes all headers.
~f messages Read in messages. ~f messages Read in messages.
~h Edit the header fields. ~h Edit the header fields.
~M messages Same as ~m, but includes all headers. ~M messages Same as ~m, but includes all headers.
~m messages Read in messages, right shifted by a tab. ~m messages Read in messages, right shifted by a tab.
~p Print (show) the message buffer. ~p Print (show) the message buffer.
~q Abort message; optionally save copy to ~/dead.letter. ~q Abort message; optionally save copy to ~/dead.letter.
~r filename Read a file into the message buffer. ~r file | ~< file Read a file into the message buffer.
~s string Set Subject: field to \fIstring\fP. ~s string Set Subject: field to \fIstring\fP.
~t name ... Add names to To: field. ~t name ... Add names to To: field.
~v Invoke display editor on message. ~v Invoke display editor on message.
~w filename Write message to file. ~w filename Write message to file.
~x Abort message; no copy is saved. ~x Abort message; no copy is saved.
~? Print a brief summary of tilde escapes. ~? Print a brief summary of tilde escapes.
~!command Execute shell command. ~!command Execute shell command.
~|command Pipe message through \fIcommand\fP. ~|command Pipe message through \fIcommand\fP.
~:mail-command Execute a \fIMail\fP command. ~:command | ~_command Execute a \fIMail\fP command.
~~string Quote a single tilde. ~~string Quote a single tilde.
~. Simulate end of file on input.
.TE .TE
.)b .)b
.(b .(b

33
usr.bin/mail/mail.1
View File

@ -1,4 +1,4 @@
.\" $OpenBSD: mail.1,v 1.57 2009/02/10 19:27:03 jmc Exp $ .\" $OpenBSD: mail.1,v 1.58 2009/07/29 18:15:38 martynas Exp $
.\" .\"
.\" Copyright (c) 1980, 1990, 1993 .\" Copyright (c) 1980, 1990, 1993
.\" The Regents of the University of California. All rights reserved. .\" The Regents of the University of California. All rights reserved.
@ -29,7 +29,7 @@
.\" .\"
.\" @(#)mail.1 8.8 (Berkeley) 4/28/95 .\" @(#)mail.1 8.8 (Berkeley) 4/28/95
.\" .\"
.Dd $Mdocdate: February 10 2009 $ .Dd $Mdocdate: July 29 2009 $
.Dt MAIL 1 .Dt MAIL 1
.Os .Os
.Sh NAME .Sh NAME
@ -713,25 +713,31 @@ The name
is somewhat of a misnomer since the actual escape character can be set is somewhat of a misnomer since the actual escape character can be set
by the option by the option
.Ic escape . .Ic escape .
.Bl -tag -width Ds .Pp
.Bl -tag -width Ds -compact
.It Ic ~b Ns Ar name ... .It Ic ~b Ns Ar name ...
Add the given names to the list of carbon copy recipients but do not make Add the given names to the list of carbon copy recipients but do not make
the names visible in the Cc: line ("blind" carbon copy). the names visible in the Cc: line ("blind" carbon copy).
.Pp
.It Ic ~c Ns Ar name ... .It Ic ~c Ns Ar name ...
Add the given names to the list of carbon copy recipients. Add the given names to the list of carbon copy recipients.
.Pp
.It Ic ~d .It Ic ~d
Read the file Read the file
.Pa dead.letter .Pa dead.letter
from your home directory into the message. from your home directory into the message.
.Pp
.It Ic ~e .It Ic ~e
Invoke the text editor on the message collected so far. Invoke the text editor on the message collected so far.
After the After the
editing session is finished, you may continue appending text to the editing session is finished, you may continue appending text to the
message. message.
.Pp
.It Ic ~F Ns Ar messages .It Ic ~F Ns Ar messages
Identical to Identical to
.Ic ~f , .Ic ~f ,
except all message headers are included. except all message headers are included.
.Pp
.It Ic ~f Ns Ar messages .It Ic ~f Ns Ar messages
Read the named messages into the message being sent. Read the named messages into the message being sent.
If no messages are specified, read in the current message. If no messages are specified, read in the current message.
@ -740,14 +746,17 @@ Message headers currently being ignored (by the
or or
.Ic retain .Ic retain
command) are not included. command) are not included.
.Pp
.It Ic ~h .It Ic ~h
Edit the message header fields by typing each one in turn and allowing Edit the message header fields by typing each one in turn and allowing
the user to append text to the end or modify the field by using the the user to append text to the end or modify the field by using the
current terminal erase and kill characters. current terminal erase and kill characters.
.Pp
.It Ic ~M Ns Ar messages .It Ic ~M Ns Ar messages
Identical to Identical to
.Ic ~m , .Ic ~m ,
except all message headers are included. except all message headers are included.
.Pp
.It Ic ~m Ns Ar messages .It Ic ~m Ns Ar messages
Read the named messages into the message being sent, indented by a Read the named messages into the message being sent, indented by a
tab or by the value of tab or by the value of
@ -759,21 +768,28 @@ Message headers currently being ignored (by the
or or
.Ic retain .Ic retain
command) are not included. command) are not included.
.Pp
.It Ic ~p .It Ic ~p
Print out the message collected so far, prefaced by the message header Print out the message collected so far, prefaced by the message header
fields. fields.
.Pp
.It Ic ~q .It Ic ~q
Abort the message being sent, copying the message to Abort the message being sent, copying the message to
.Pa dead.letter .Pa dead.letter
in your home directory if in your home directory if
.Ic save .Ic save
is set. is set.
.Pp
.It Ic ~r Ns Ar filename .It Ic ~r Ns Ar filename
.It Ic ~< Ns Ar filename
Read the named file into the message. Read the named file into the message.
.Pp
.It Ic ~s Ns Ar string .It Ic ~s Ns Ar string
Cause the named string to become the current subject field. Cause the named string to become the current subject field.
.Pp
.It Ic ~t Ns Ar name ... .It Ic ~t Ns Ar name ...
Add the given names to the direct recipient list. Add the given names to the direct recipient list.
.Pp
.It Ic ~v .It Ic ~v
Invoke an alternate editor (defined by the Invoke an alternate editor (defined by the
.Ev VISUAL .Ev VISUAL
@ -783,8 +799,10 @@ Usually, the alternate editor will be a
screen editor. screen editor.
After you quit the editor, you may resume appending After you quit the editor, you may resume appending
text to the end of your message. text to the end of your message.
.Pp
.It Ic ~w Ns Ar filename .It Ic ~w Ns Ar filename
Write the message onto the named file. Write the message onto the named file.
.Pp
.It Ic ~x .It Ic ~x
Abort the message being sent. Abort the message being sent.
No message is copied to No message is copied to
@ -792,10 +810,13 @@ No message is copied to
even if even if
.Ic save .Ic save
is set. is set.
.Pp
.It Ic ~? .It Ic ~?
Prints a brief summary of tilde escapes. Prints a brief summary of tilde escapes.
.Pp
.It Ic ~! Ns Ar command .It Ic ~! Ns Ar command
Execute the indicated shell command, then return to the message. Execute the indicated shell command, then return to the message.
.Pp
.It Ic ~| Ns Ar command .It Ic ~| Ns Ar command
Pipe the message through the command as a filter. Pipe the message through the command as a filter.
If the command gives If the command gives
@ -806,14 +827,20 @@ The command
is often used as is often used as
.Ic command .Ic command
to rejustify the message. to rejustify the message.
.Pp
.It Ic ~: Ns Ar mail-command .It Ic ~: Ns Ar mail-command
.It Ic ~_ Ns Ar mail-command
Execute the given mail command. Execute the given mail command.
Not all commands, however, are allowed. Not all commands, however, are allowed.
.Pp
.It Ic ~~ Ns Ar string .It Ic ~~ Ns Ar string
Insert the string of text in the message prefaced by a single ~. Insert the string of text in the message prefaced by a single ~.
If If
you have changed the escape character, then you should double you have changed the escape character, then you should double
that character in order to send it. that character in order to send it.
.Pp
.It Ic ~.
Simulate end of file on input.
.El .El
.Ss Mail options .Ss Mail options
Options are controlled via Options are controlled via

49
usr.bin/mail/misc/mail.tildehelp
View File

@ -1,25 +1,26 @@
----------------------------------------------------------- ------------------------------------------------------------------------------
The following ~ escapes are defined: The following ~ escapes are defined:
~b name ... Add names to "blind" Cc: list. ~b name ... Add names to "blind" Cc: list.
~c name ... Add names to Cc: field. ~c name ... Add names to Cc: field.
~d Read dead.letter into message. ~d Read dead.letter into message.
~e Invoke text editor on partial message. ~e Invoke text editor on partial message.
~F messages Same as ~f, but includes all headers. ~F messages Same as ~f, but includes all headers.
~f messages Read in messages. ~f messages Read in messages.
~h Edit the header fields. ~h Edit the header fields.
~M messages Same as ~m, but includes all headers. ~M messages Same as ~m, but includes all headers.
~m messages Read in messages, right shifted by a tab. ~m messages Read in messages, right shifted by a tab.
~p Print (show) the message buffer. ~p Print (show) the message buffer.
~q Abort message; optionally save copy to ~/dead.letter. ~q Abort message; optionally save copy to ~/dead.letter.
~r filename Read a file into the message buffer. ~r file | ~< file Read a file into the message buffer.
~s string Set Subject: field to string. ~s string Set Subject: field to string.
~t name ... Add names to To: field. ~t name ... Add names to To: field.
~v Invoke display editor on message. ~v Invoke display editor on message.
~w filename Write message to file. ~w filename Write message to file.
~x Abort message; no copy is saved. ~x Abort message; no copy is saved.
~? Print a brief summary of tilde escapes. ~? Print a brief summary of tilde escapes.
~!command Execute shell command. ~!command Execute shell command.
~|command Pipe message through command. ~|command Pipe message through command.
~:mail-command Execute a Mail command. ~:command | ~_command Execute a Mail command.
~~string Quote a single tilde. ~~string Quote a single tilde.
----------------------------------------------------------- ~. Simulate end of file on input.
------------------------------------------------------------------------------