A mail formatter.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 

134 lines
2.6 KiB

  1. .TH FMAIL 1 2019-01-12 "fmail @PACKAGE_VERSION@"
  2. .SH NAME
  3. fmail \- mail formatter
  4. .SH SYNOPSIS
  5. .SY fmail
  6. .RB [ \-h | --help ]
  7. .RB [ \-v | --version ]
  8. .RB [ \-a | --attach
  9. .IR file ]
  10. .RB [ \-s | --sign ]
  11. .RB [ \-E | --encrypt
  12. .IR recipient ]
  13. .RB [ \-e | --edit ]
  14. .RB [ \-f | --footer
  15. .IR file ]
  16. .RB [ \-H | --header
  17. .IR header ]
  18. .RB [ \-F | --from
  19. .IR sender ]
  20. .RB [ \-T | --to
  21. .IR recipient ]
  22. .RB [ \-C | --cc
  23. .IR recipient ]
  24. .RB [ \-S | --subject
  25. .IR subject ]
  26. .RB [ \-U | --user-agent ]
  27. .RB [ \-D | --date ]
  28. .YS
  29. .SH DESCRIPTION
  30. .PP
  31. .B fmail
  32. formats text read on standard input into a mail message
  33. ready to be sent to a mail submission agent.
  34. .PP
  35. The formatting process includes: encoding the text body in
  36. .I Quoted-Printable\fR;
  37. creating appropriate MIME parts for attachments and
  38. OpenPGP signature; encoding attachments (in
  39. .I Base64
  40. or
  41. .I Quoted-Printable
  42. depending on their type); adding appropriate mail headers;
  43. and encrypting to one or several OpenPGP public keys.
  44. .PP
  45. The resulting message is printed on standard output and can
  46. be piped directly to a program such as
  47. .B sendmail(8)
  48. to effectively send the message to a mail server.
  49. .PP
  50. The first lines of the input message, up to the first blank
  51. line, are treated as mail headers; everything from the first
  52. blank line to the end of file is treated as the mail body.
  53. .SH OPTIONS
  54. .TP
  55. .BR -h ", " --help
  56. Display the help message.
  57. .TP
  58. .BR -v ", " --version
  59. Display the version message.
  60. .TP
  61. .BR -a ", " --attach " " \fIfile\fR
  62. Attach the specified
  63. .I file\fR.
  64. .TP
  65. .BR -s ", " --sign
  66. Sign the message.
  67. .TP
  68. .BR -E ", " --encrypt " " \fIrecipient\fR
  69. Encrypt the message to the public key of
  70. the specified recipient.
  71. .TP
  72. .BR -e ", " --edit
  73. Fire an editor to type the mail body instead of
  74. reading it from standard input.
  75. .TP
  76. .BR -f ", " --footer " " \fIfile\fR
  77. Append the contents of the specified
  78. .I file
  79. as the mail footer.
  80. .TP
  81. .BR -H ", " --header " " \fIheader\fR
  82. Add an arbitrary header.
  83. .TP
  84. .BR -F ", " --from " " \fIsender\fR
  85. Set the
  86. .B From:
  87. header.
  88. .TP
  89. .BR -T ", " --to " " \fIrecipient\fR
  90. Add a
  91. .B To:
  92. header.
  93. .TP
  94. .BR -C ", " --cc " " \fIrecipient\fR
  95. Add a
  96. .B Cc:
  97. header.
  98. .TP
  99. .BR -S ", " --subject " " \fIsubject\fR
  100. Set the
  101. .B Subject:
  102. header.
  103. .TP
  104. .BR -U ", " --user-agent
  105. Add a
  106. .B User-Agent:
  107. header.
  108. .TP
  109. .BR -D ", " --date
  110. Add an automatically generated
  111. .B Date:
  112. header with the current date.
  113. .SH REPORTING BUGS
  114. .PP
  115. Report bugs to
  116. .MT @PACKAGE_BUGREPORT@
  117. Damien Goutte-Gattat
  118. .ME .
  119. .SH COPYRIGHT
  120. .ad l
  121. .PP
  122. Copyright \(co 2011,2018,2019 Damien Goutte-Gattat
  123. .PP
  124. This program is released under the GNU General Public License.
  125. See the COPYING file in the source distribution or
  126. .UR http://www.gnu.org/licenses/gpl.html
  127. .UE .