Mercurial > hgrepos > FreeBSD > ports > sysutils > local-bsdtools
annotate docs/man/man8/bsmtp2dma.rst @ 693:3633a41b862b
fpkg: Use modern documentation: "#:" instead of ': ...'.
While there: fix some documented behaviour: some command run in all
running jails (not only in compatible jails).
| author | Franz Glasner <fzglas.hg@dom66.de> |
|---|---|
| date | Tue, 01 Oct 2024 16:16:28 +0200 |
| parents | 54c6eecbe53f |
| children |
| rev | line source |
|---|---|
| 317 | 1 .. -*- coding: utf-8; indent-tabs-mode: nil; -*- |
| 2 | |
| 3 bsmtp2dma | |
| 4 ========= | |
| 5 | |
| 6 Synopsis | |
| 7 -------- | |
| 8 | |
| 9 **bsmtp2dma** **-V** | |
| 10 | |
| 11 **bsmtp2dma** [**-8**] [**-c** `address`] [**-d** `n`] [**-f** `address`] [**-h** `mailhost:port`] [**-l** `number`] [**-r** `address`] [**-s** `subject`] `recipient` ... | |
| 12 | |
| 13 | |
| 14 Description | |
| 15 ----------- | |
| 16 | |
| 17 A Bacula compatible mail submission programm and an alternative to Bacula's | |
| 18 :command:`bsmtp` SMTP client. | |
| 19 | |
| 20 Bacula's :command:`bsmtp` needs an underlying mailer that listens on a | |
| 21 TCP port. :command:`bsmtp2dma` can be used if the underlying mailer does `not` | |
| 22 listen to an SMTP port (e.g. :manpage:`dma(8)`, :command:`ssmtp` et al.). | |
| 23 | |
| 24 The underlying mailer should be compatible to :command:`sendmail`. | |
| 25 | |
| 26 | |
| 27 Options | |
| 28 ------- | |
| 29 | |
| 30 .. program:: bsmtp2dma | |
| 31 | |
| 32 .. option:: -V | |
| 33 | |
| 34 Show the program version and usage and exit. | |
| 35 | |
| 36 .. option:: -8 | |
| 37 | |
| 38 Does nothing. Act as a compatibility option for :command:`bsmtp`. | |
| 39 | |
|
622
54c6eecbe53f
Docs: as per the Sphinx docs: option argument names should be enclosed in angle brackets
Franz Glasner <fzglas.hg@dom66.de>
parents:
414
diff
changeset
|
40 .. option:: -c <address> |
| 317 | 41 |
| 42 Set the ``CC:`` header to `address` | |
| 43 | |
|
622
54c6eecbe53f
Docs: as per the Sphinx docs: option argument names should be enclosed in angle brackets
Franz Glasner <fzglas.hg@dom66.de>
parents:
414
diff
changeset
|
44 .. option:: -d <n> |
| 317 | 45 |
| 46 Does nothing. Act as a compatibility option for :command:`bsmtp`. | |
| 47 | |
|
622
54c6eecbe53f
Docs: as per the Sphinx docs: option argument names should be enclosed in angle brackets
Franz Glasner <fzglas.hg@dom66.de>
parents:
414
diff
changeset
|
48 .. option:: -f <address> |
| 317 | 49 |
| 50 Set the ``FROM:`` header to `address`. | |
| 51 | |
| 52 If not given it it set to the sender's address. | |
| 53 | |
|
622
54c6eecbe53f
Docs: as per the Sphinx docs: option argument names should be enclosed in angle brackets
Franz Glasner <fzglas.hg@dom66.de>
parents:
414
diff
changeset
|
54 .. option:: -h <mailhost:port> |
| 317 | 55 |
| 56 Does nothing. Act as a compatibility option for :command:`bsmtp`. | |
| 57 | |
|
622
54c6eecbe53f
Docs: as per the Sphinx docs: option argument names should be enclosed in angle brackets
Franz Glasner <fzglas.hg@dom66.de>
parents:
414
diff
changeset
|
58 .. option:: -l <number> |
| 317 | 59 |
| 60 Does nothing. Act as a compatibility option for :command:`bsmtp`. | |
| 61 | |
|
622
54c6eecbe53f
Docs: as per the Sphinx docs: option argument names should be enclosed in angle brackets
Franz Glasner <fzglas.hg@dom66.de>
parents:
414
diff
changeset
|
62 .. option:: -r <address> |
| 317 | 63 |
| 64 Set the ``Reply-To:`` header to `address`. | |
| 65 | |
|
622
54c6eecbe53f
Docs: as per the Sphinx docs: option argument names should be enclosed in angle brackets
Franz Glasner <fzglas.hg@dom66.de>
parents:
414
diff
changeset
|
66 .. option:: -s <subject> |
| 317 | 67 |
| 68 Set the "Subject:" header to `subject`. | |
| 69 | |
| 70 | |
| 71 Implementation Notes | |
| 72 -------------------- | |
| 73 | |
| 74 The body of the email message is read from standard input. Message is | |
| 75 terminated by sending the ``EOF`` character (:kbd:`Control-d` on many | |
| 76 systems) on the start of a new line, much like many :command:`mail` | |
| 77 commands. | |
| 78 | |
| 79 The message is collected into a temporary file and send to all given | |
| 80 recipients by using the configured underlying mail command. | |
| 81 | |
| 82 | |
| 83 Files | |
| 84 ----- | |
| 85 | |
| 86 :command:`bsmtp2dma` reads a configuration file -- if available -- from | |
| 87 :file:`/usr/local/etc/local-bsdtools/bsmtp2dma.conf`. | |
| 88 | |
|
414
3ac1e09c1fa1
More manpage content for bsmtp2dma(5)
Franz Glasner <fzglas.hg@dom66.de>
parents:
317
diff
changeset
|
89 It is a shell style configuration file which is sourced in at program start. |
| 317 | 90 |
| 91 The following configuration settings are currently supported: | |
| 92 | |
| 93 ``MAILER`` | |
| 94 The absolute path to the underlying mail command. | |
| 95 | |
| 96 The default is :command:`/usr/sbin/sendmail`. | |
|
414
3ac1e09c1fa1
More manpage content for bsmtp2dma(5)
Franz Glasner <fzglas.hg@dom66.de>
parents:
317
diff
changeset
|
97 |
|
3ac1e09c1fa1
More manpage content for bsmtp2dma(5)
Franz Glasner <fzglas.hg@dom66.de>
parents:
317
diff
changeset
|
98 |
|
3ac1e09c1fa1
More manpage content for bsmtp2dma(5)
Franz Glasner <fzglas.hg@dom66.de>
parents:
317
diff
changeset
|
99 See Also |
|
3ac1e09c1fa1
More manpage content for bsmtp2dma(5)
Franz Glasner <fzglas.hg@dom66.de>
parents:
317
diff
changeset
|
100 -------- |
|
3ac1e09c1fa1
More manpage content for bsmtp2dma(5)
Franz Glasner <fzglas.hg@dom66.de>
parents:
317
diff
changeset
|
101 |
|
3ac1e09c1fa1
More manpage content for bsmtp2dma(5)
Franz Glasner <fzglas.hg@dom66.de>
parents:
317
diff
changeset
|
102 :manpage:`bsmtp2dma.conf(5)` |