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 "6 December 2009" "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 \-8
  27 Encode the mail in UTF-8.
  28 .TP
  29 .B \-c
  30 Set the \fBCc:\fR header.
  31 .TP
  32 .BI \-d\  nn
  33 Set debug level to \fInn\fP.
  34 .TP
  35 .BI \-dt
  36 Print timestamp in debug output.
  37 .TP
  38 .B \-f
  39 Set the \fBFrom:\fR header. If not specified,
  40 .B bsmtp
  41 will try to use your username.
  42 .TP
  43 .BI \-h\  mailhost:port
  44 Use mailhost:port as the SMTP server. (default port: 25)
  45 .TP
  46 .B \-s
  47 Set the \fBSubject:\fR header.
  48 .TP
  49 .B \-r
  50 Set the \fBReply-To:\fR: header.
  51 .TP
  52 .B \-l
  53 Set the maximum number of lines to be sent. (default: unlimited)
  54 .TP
  55 .B \-?
  56 Show version and usage of program.
  57
  58 .SH USAGE
  59 \fIrecipients\fR is a space separated list of email addresses.
  60
  61 The body of the email message is read from standard input. Message is
  62 ended by sending the EOF character (Ctrl-D on many systems) on the
  63 start of a new line, much like many 'mail' commands.
  64
  65 The actual, automated behavior of \fBbsmtp\fR will depend on the
  66 mail-related configuration of the Director in the \fIMessages\fR resource
  67 of \fIbacula-dir.conf\fR.
  68
  69 Interactive use of \fBbsmtp\fR is pertinent to manually test and ensure these
  70 configuration bits are valid. This is highly recommended.
  71
  72 .SH CONFIGURATION
  73 These commands should each appear on a single line in the configuration
  74 file.
  75
  76 Messages {
  77   Name = Standard
  78   mailcommand = "/home/bacula/bin/bsmtp \-h mail.domain.com \-f \\"\\(Bacula\\) \\<%r\\>\\"
  79                            \-s \\"Bacula: %t %e of %c %l\\" %r"
  80   operatorcommand = "/home/bacula/bin/bsmtp \-h mail.domain.com \-f \\"\\(Bacula\\) \\<%r\\>\\"
  81                                  \-s \\"Bacula: Intervention needed for %j\\" %r"
  82   mail = sysadmin@site.domain.com = all, !skipped
  83   operator = sysop@site.domain.com = mount
  84   console = all, !skipped, !saved
  85  }
  86
  87 \fIhome/bacula/bin\fR is replaced with the path to the Bacula
  88 binary directory, and mail.domain.com is replaced with the fully
  89 qualified name of an SMTP server, which usually listen on port 25.
  90
  91 .SH ENVIRONMENT
  92 If the \fB-h\fR option is not specified, \fBbsmtp\fR will use environment variable \fBSMTPSERVER\fR, or 'localhost' if not set.
  93
  94 .SH NOTES
  95 Since \fBbsmtp\fR always uses a TCP connection rather than writing to a
  96 spool file, you may find that your \fBFrom:\fR address is being rejected
  97 because it does not contain a valid domain, or because your
  98 message has gotten caught in spam filtering rules. Generally, you
  99 should specify a fully qualified domain name in the from field, and
 100 depending on whether your SMTP gateway is Exim or Sendmail, you may
 101 need to modify the syntax of the from part of the message.
 102
 103 If \fBbsmtp\fR cannot connect to the specified mail host, it will retry
 104 to connect to \fBlocalhost\fR.
 105
 106 .SH BUGS
 107 If you are getting incorrect dates (e.g. 1970) and you are
 108 running with a non-English locale, you might try setting the
 109 \fBLANG="en_US"\fR environment variable.
 110
 111 .SH AUTHOR
 112 This manual page was written by Jose Luis Tallon
 113 .nh
 114 <jltallon@adv\-solutions.net>, revised and edited by Lucas B. Cohen
 115 .nh
 116 <lbc@members.fsf.org>.
 117 .SH SEE ALSO
 118 .BR "bacula-dir" "(8) "
 119 .SH COPYRIGHT
 120 This man page document is released under the BSD 2-Clause license.