Mercurial > hgrepos > FreeBSD > ports > sysutils > local-bsdtools

comparison docs/man/man8/bsmtp2dma.rst @ 317:ebe98c3b0835

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
A manpage for bsmtp2dma. Remove the "Implementation Notes" from the script's help message because an extended version is included in the manual now.
author Franz Glasner <fzglas.hg@dom66.de>
date Sun, 27 Nov 2022 15:07:31 +0100
parents
children 3ac1e09c1fa1
comparison
equal deleted inserted replaced
316:dc3ac7fc06ea 317:ebe98c3b0835
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
40 .. option:: -c address
41
42 Set the ``CC:`` header to `address`
43
44 .. option:: -d n
45
46 Does nothing. Act as a compatibility option for :command:`bsmtp`.
47
48 .. option:: -f address
49
50 Set the ``FROM:`` header to `address`.
51
52 If not given it it set to the sender's address.
53
54 .. option:: -h mailhost:port
55
56 Does nothing. Act as a compatibility option for :command:`bsmtp`.
57
58 .. option:: -l number
59
60 Does nothing. Act as a compatibility option for :command:`bsmtp`.
61
62 .. option:: -r address
63
64 Set the ``Reply-To:`` header to `address`.
65
66 .. option:: -s subject
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
89 It is a shell style configuration file which is sourced in a program start.
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`.