Mercurial > hgrepos > FreeBSD > ports > sysutils > local-bsdtools
changeset 317:ebe98c3b0835
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 | dc3ac7fc06ea |
| children | 58ad548487c4 |
| files | docs/conf.py docs/man/index8.rst docs/man/man8/bsmtp2dma.rst pkg-plist sbin/bsmtp2dma |
| diffstat | 5 files changed, 99 insertions(+), 7 deletions(-) [+] |
line wrap: on
line diff
--- a/docs/conf.py Sat Nov 26 17:16:51 2022 +0100 +++ b/docs/conf.py Sun Nov 27 15:07:31 2022 +0100 @@ -72,6 +72,7 @@ # (source start file, name, description, authors, manual section). man_pages = [ ("man/man8/local-bsdtools", "local-bsdtools", 'FreeBSD administration helper tools v%s' % release, [author], 8), + ("man/man8/bsmtp2dma", "bsmtp2dma", "Bacula compatible mail submission program", [author], 8), ("man/man8/fjail", "fjail", "Management of Jails", [author], 8), #("man/man8/fjail-configure", "fjail", "Basic Configuration of Jails", [author], 8), #("man/man8/fjail-copy", "fjail-copy", "Recursively copy ZFS datasets including all properties", [author], 8),
--- a/docs/man/index8.rst Sat Nov 26 17:16:51 2022 +0100 +++ b/docs/man/index8.rst Sun Nov 27 15:07:31 2022 +0100 @@ -9,6 +9,7 @@ .. toctree:: man8/local-bsdtools + man8/bsmtp2dma man8/fjail man8/ftjail man8/ftjail-build-etcupdate-current-tmpl
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/docs/man/man8/bsmtp2dma.rst Sun Nov 27 15:07:31 2022 +0100 @@ -0,0 +1,96 @@ +.. -*- coding: utf-8; indent-tabs-mode: nil; -*- + +bsmtp2dma +========= + +Synopsis +-------- + +**bsmtp2dma** **-V** + +**bsmtp2dma** [**-8**] [**-c** `address`] [**-d** `n`] [**-f** `address`] [**-h** `mailhost:port`] [**-l** `number`] [**-r** `address`] [**-s** `subject`] `recipient` ... + + +Description +----------- + +A Bacula compatible mail submission programm and an alternative to Bacula's +:command:`bsmtp` SMTP client. + +Bacula's :command:`bsmtp` needs an underlying mailer that listens on a +TCP port. :command:`bsmtp2dma` can be used if the underlying mailer does `not` +listen to an SMTP port (e.g. :manpage:`dma(8)`, :command:`ssmtp` et al.). + +The underlying mailer should be compatible to :command:`sendmail`. + + +Options +------- + +.. program:: bsmtp2dma + +.. option:: -V + + Show the program version and usage and exit. + +.. option:: -8 + + Does nothing. Act as a compatibility option for :command:`bsmtp`. + +.. option:: -c address + + Set the ``CC:`` header to `address` + +.. option:: -d n + + Does nothing. Act as a compatibility option for :command:`bsmtp`. + +.. option:: -f address + + Set the ``FROM:`` header to `address`. + + If not given it it set to the sender's address. + +.. option:: -h mailhost:port + + Does nothing. Act as a compatibility option for :command:`bsmtp`. + +.. option:: -l number + + Does nothing. Act as a compatibility option for :command:`bsmtp`. + +.. option:: -r address + + Set the ``Reply-To:`` header to `address`. + +.. option:: -s subject + + Set the "Subject:" header to `subject`. + + +Implementation Notes +-------------------- + +The body of the email message is read from standard input. Message is +terminated by sending the ``EOF`` character (:kbd:`Control-d` on many +systems) on the start of a new line, much like many :command:`mail` +commands. + +The message is collected into a temporary file and send to all given +recipients by using the configured underlying mail command. + + +Files +----- + +:command:`bsmtp2dma` reads a configuration file -- if available -- from +:file:`/usr/local/etc/local-bsdtools/bsmtp2dma.conf`. + +It is a shell style configuration file which is sourced in a program start. + +The following configuration settings are currently supported: + + ``MAILER`` + The absolute path to the underlying mail command. + + The default is :command:`/usr/sbin/sendmail`.
--- a/pkg-plist Sat Nov 26 17:16:51 2022 +0100 +++ b/pkg-plist Sun Nov 27 15:07:31 2022 +0100 @@ -7,6 +7,7 @@ sbin/fpkg sbin/fzfs %%DOCS%%man/man8/local-bsdtools.8.gz +%%DOCS%%man/man8/bsmtp2dma.8.gz %%DOCS%%man/man8/fjail.8.gz %%DOCS%%man/man8/ftjail.8.gz %%DOCS%%man/man8/ftjail-build-etcupdate-current-tmpl.8.gz
--- a/sbin/bsmtp2dma Sat Nov 26 17:16:51 2022 +0100 +++ b/sbin/bsmtp2dma Sun Nov 27 15:07:31 2022 +0100 @@ -40,13 +40,6 @@ -s SUBJECT Set the "Subject:" header -Usage: - - The body of the email message is read from standard input. Message is - ended by sending the `EOF` character (`Ctrl-D` on many systems) on the - start of a new line, much like many `mail` commands. - - Files: The shell style configuration file in
