From 52dab0fb91fc5417e2c61f62f9eb67b3c6f721a9 Mon Sep 17 00:00:00 2001 From: Jeremy Baxter Date: Mon, 17 Jun 2024 07:44:22 +1200 Subject: [PATCH] mal.1: add man page Closes: https://todo.sr.ht/~jeremy/mal/1 --- mal.1 | 134 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 134 insertions(+) create mode 100644 mal.1 diff --git a/mal.1 b/mal.1 new file mode 100644 index 0000000..23ee565 --- /dev/null +++ b/mal.1 @@ -0,0 +1,134 @@ +.Dd $Mdocdate: June 17 2024 $ +.Dt MAL 1 +.Os +.Sh NAME +.Nm mal +.Nd send mail +.Sh SYNOPSIS +.Nm mal +.Bk -words +.Op Fl ksV +.Op Fl a Ar server +.Op Fl F Ar fqdn +.Op Fl H Ar header +.Op Fl n Ar name +.Op Fl P Ar passphrase +.Op Fl p Ar port +.Op Fl S Ar subject +.Op Fl t Ar toaddress +.Op Fl u Ar user +.No { Ns Fl M Ar file | Fl m Ar message Ns } +.Ar fromaddress +.Ek +.Sh DESCRIPTION +.Nm +sends mail to one or more recipients, +whose addresses are specified by the +.Fl t +option. +The mail is sent from the address specified by +.Ar fromaddress , +and if +.Fl t +is not given, mail will be sent back to the sender's address. +The +.Fl P +option specifies a passphrase. +.Pp +The options are as follows: +.Bl -tag -width 123456 +.It Fl a Ar server +Specify the address of the SMTP server to connect to. +By default this is the domain segment of +.Ar fromaddress . +.It Fl F Ar fqdn +Specify the FQDN to pass to the SMTP server. +By default this is set to the system's hostname with +.Dq .local +appended to the end. +.It Fl H Ar header +Add a header to the request. +This is necessary if you would like to, for instance +CC someone in your mail. +See the +.Sx EXAMPLES +section below for an example using this option. +.It Fl k +Use an insecure SMTP connection. +By default +.Nm mal +will attempt to connect with secure SMTPS, +but if your server doesn't support this you should use +.Fl k . +See also +.Fl s +for forcing a secure connection. +.It Fl M Ar file +Specify a file which contains the message's contents. +.It Fl m Ar message +Specify a message on the command line. +.It Fl n Ar name +Specify a real name to identify the sender of the mail. +.It Fl P Ar passphrase +Specify a passphrase to use to authenticate the SMTP user. +Without this option no authentication will be used. +.It Fl p Ar port +Override the SMTP server port. +By default this will be +465 for SMTPS servers +or 587 for plain SMTP servers. +See also the +.Fl k +flag. +.It Fl S Ar subject +Specify the subject line of the mail. +.It Fl s +Force a secure SMTPS connection. +This is the default and only required if you want to override +a previous +.Fl k +flag. +.It Fl t Ar toaddress +Specify a recipient for the mail. +If you would like to CC someone instead, +see the +.Fl H +option. +If this option is not given, +the mail will be sent to the sender's address. +This option can be specified multiple times +to send email to multiple recipients. +.It Fl u Ar user +Specify the SMTP user. +By default this is the sender's address. +.It Fl V +Print the version number and exit. +.El +.Sh EXAMPLES +Send an email to +.Mt joe@example.org +with the message +.Dq Hello : +.Pp +.Dl mal -m Hello -t joe@example.org -P mypasswd you@example.org +.Pp +Read the message from the file +.Dq mesg +instead: +.Pp +.Dl mal -M mesg -t joe@example.org -P mypasswd you@example.org +.Pp +CC +.Mt jane@example.org : +.Pp +.Dl mal -M mesg -t joe@example.org -H 'Cc: ' -P mypasswd you@example.org +.Pp +.Sh AUTHORS +.An Jeremy Baxter Aq Mt jeremy@baxters.nz +.Sh BUGS +.Pp +Currently known bugs or issues can be found at the tracker: +.Lk https://todo.sr.ht/~jeremy/mal +.Pp +If you happen to find a bug, +please report it to me using my address above.