git.sur5r.net Git - bacula/bacula/blob - bacula/manpages/bsmtp.1

   1 .\"                                      Hey, EMACS: -*- nroff -*-
   2 .\" First parameter, NAME, should be all caps
   3 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
   4 .\" other parameters are allowed: see man(7), man(1)
   5 .TH BSMTP 1 "3 July 2012" "Kern Sibbald" "Network backup, recovery and verification"
   6 .\" Please adjust this date whenever revising the manpage.
   7 .\"
   8 .SH NAME
   9  bsmtp \- Bacula's SMTP client (mail submission program)
  10
  11 .SH SYNOPSIS
  12 .B bsmtp
  13 .RI [ options ]
  14 .I <recipient> <...>
  15
  16 .SH DESCRIPTION
  17 .B bsmtp
  18 is a simple mail user agent designed to permit more flexibility
  19 than the standard mail programs typically found on Unix systems, and to
  20 ease portability. It can even run on Windows machines. It is used
  21 by the Director daemon to send notifications and requests to the
  22 operator.
  23
  24 .SH OPTIONS
  25 .TP
  26 .B \-4
  27 Forces bsmtp to use IPv4 addresses only.
  28 .TP
  29 .B \-6
  30 Forces bsmtp to use IPv6 addresses only.
  31 .TP
  32 .B \-8
  33 Encode the mail in UTF-8.
  34 .TP
  35 .B \-a
  36 Use any ip protocol for address resolution.
  37 .TP
  38 .B \-c
  39 Set the \fBCc:\fR header.
  40 .TP
  41 .BI \-d\  nn
  42 Set debug level to \fInn\fP.
  43 .TP
  44 .BI \-dt
  45 Print timestamp in debug output.
  46 .TP
  47 .B \-f
  48 Set the \fBFrom:\fR header. If not specified,
  49 .B bsmtp
  50 will try to use your username.
  51 .TP
  52 .BI \-h\  mailhost:port
  53 Use mailhost:port as the SMTP server. (default port: 25)
  54 .TP
  55 .B \-s
  56 Set the \fBSubject:\fR header.
  57 .TP
  58 .B \-r
  59 Set the \fBReply-To:\fR: header.
  60 .TP
  61 .B \-l
  62 Set the maximum number of lines to be sent. (default: unlimited)
  63 .TP
  64 .B \-?
  65 Show version and usage of program.
  66
  67 .SH USAGE
  68 \fIrecipients\fR is a space separated list of email addresses.
  69
  70 The body of the email message is read from standard input. Message is
  71 ended by sending the EOF character (Ctrl-D on many systems) on the
  72 start of a new line, much like many 'mail' commands.
  73
  74 The actual, automated behavior of \fBbsmtp\fR will depend on the
  75 mail-related configuration of the Director in the \fIMessages\fR resource
  76 of \fIbacula-dir.conf\fR.
  77
  78 Interactive use of \fBbsmtp\fR is pertinent to manually test and ensure these
  79 configuration bits are valid. This is highly recommended.
  80
  81 .SH CONFIGURATION
  82 These commands should each appear on a single line in the configuration
  83 file.
  84
  85 Messages {
  86   Name = Standard
  87   mailcommand = "/home/bacula/bin/bsmtp \-h mail.domain.com \-f \\"\\(Bacula\\) \\<%r\\>\\"
  88                            \-s \\"Bacula: %t %e of %c %l\\" %r"
  89   operatorcommand = "/home/bacula/bin/bsmtp \-h mail.domain.com \-f \\"\\(Bacula\\) \\<%r\\>\\"
  90                                  \-s \\"Bacula: Intervention needed for %j\\" %r"
  91   mail = sysadmin@site.domain.com = all, !skipped
  92   operator = sysop@site.domain.com = mount
  93   console = all, !skipped, !saved
  94  }
  95
  96 \fIhome/bacula/bin\fR is replaced with the path to the Bacula
  97 binary directory, and mail.domain.com is replaced with the fully
  98 qualified name of an SMTP server, which usually listen on port 25.
  99
 100 .SH ENVIRONMENT
 101 If the \fB-h\fR option is not specified, \fBbsmtp\fR will use environment variable \fBSMTPSERVER\fR, or 'localhost' if not set.
 102
 103 .SH NOTES
 104 Since \fBbsmtp\fR always uses a TCP connection rather than writing to a
 105 spool file, you may find that your \fBFrom:\fR address is being rejected
 106 because it does not contain a valid domain, or because your
 107 message has gotten caught in spam filtering rules. Generally, you
 108 should specify a fully qualified domain name in the from field, and
 109 depending on whether your SMTP gateway is Exim or Sendmail, you may
 110 need to modify the syntax of the from part of the message.
 111
 112 If \fBbsmtp\fR cannot connect to the specified mail host, it will retry
 113 to connect to \fBlocalhost\fR.
 114
 115 .SH BUGS
 116 If you are getting incorrect dates (e.g. 1970) and you are
 117 running with a non-English locale, you might try setting the
 118 \fBLANG="en_US"\fR environment variable.
 119
 120 .SH AUTHOR
 121 This manual page was written by Jose Luis Tallon
 122 .nh
 123 <jltallon@adv\-solutions.net>, revised and edited by Lucas B. Cohen
 124 .nh
 125 <lbc@members.fsf.org>.
 126 .SH SEE ALSO
 127 .BR "bacula-dir" "(8) "