annotate docs/man/man8/bsmtp2dma.rst @ 825:89bccf22e5b7 default tip

Use the proper canonical casing for ABI=
author Franz Glasner <fzglas.hg@dom66.de>
date Sun, 16 Mar 2025 12:14:54 +0100
parents 54c6eecbe53f
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
317
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
1 .. -*- coding: utf-8; indent-tabs-mode: nil; -*-
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
2
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
3 bsmtp2dma
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
4 =========
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
5
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
6 Synopsis
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
7 --------
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
8
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
9 **bsmtp2dma** **-V**
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
10
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
11 **bsmtp2dma** [**-8**] [**-c** `address`] [**-d** `n`] [**-f** `address`] [**-h** `mailhost:port`] [**-l** `number`] [**-r** `address`] [**-s** `subject`] `recipient` ...
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
12
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
13
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
14 Description
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
15 -----------
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
16
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
17 A Bacula compatible mail submission programm and an alternative to Bacula's
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
18 :command:`bsmtp` SMTP client.
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
19
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
20 Bacula's :command:`bsmtp` needs an underlying mailer that listens on a
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
21 TCP port. :command:`bsmtp2dma` can be used if the underlying mailer does `not`
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
22 listen to an SMTP port (e.g. :manpage:`dma(8)`, :command:`ssmtp` et al.).
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
23
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
24 The underlying mailer should be compatible to :command:`sendmail`.
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
25
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
26
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
27 Options
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
28 -------
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
29
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
30 .. program:: bsmtp2dma
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
31
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
32 .. option:: -V
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
33
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
34 Show the program version and usage and exit.
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
35
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
36 .. option:: -8
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
37
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
38 Does nothing. Act as a compatibility option for :command:`bsmtp`.
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
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
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
41
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
42 Set the ``CC:`` header to `address`
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
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
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
45
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
46 Does nothing. Act as a compatibility option for :command:`bsmtp`.
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
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
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
49
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
50 Set the ``FROM:`` header to `address`.
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
51
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
52 If not given it it set to the sender's address.
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
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
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
55
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
56 Does nothing. Act as a compatibility option for :command:`bsmtp`.
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
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
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
59
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
60 Does nothing. Act as a compatibility option for :command:`bsmtp`.
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
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
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
63
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
64 Set the ``Reply-To:`` header to `address`.
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
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
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
67
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
68 Set the "Subject:" header to `subject`.
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
69
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
70
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
71 Implementation Notes
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
72 --------------------
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
73
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
74 The body of the email message is read from standard input. Message is
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
75 terminated by sending the ``EOF`` character (:kbd:`Control-d` on many
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
76 systems) on the start of a new line, much like many :command:`mail`
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
77 commands.
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
78
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
79 The message is collected into a temporary file and send to all given
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
80 recipients by using the configured underlying mail command.
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
81
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
82
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
83 Files
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
84 -----
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
85
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
86 :command:`bsmtp2dma` reads a configuration file -- if available -- from
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
87 :file:`/usr/local/etc/local-bsdtools/bsmtp2dma.conf`.
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
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
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
90
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
91 The following configuration settings are currently supported:
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
92
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
93 ``MAILER``
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
94 The absolute path to the underlying mail command.
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
95
ebe98c3b0835 A manpage for bsmtp2dma.
Franz Glasner <fzglas.hg@dom66.de>
parents:
diff changeset
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)`