contrib/openbsm/bin/auditdistd/auditdistd.8

   1 .\" Copyright (c) 2012 The FreeBSD Foundation
   2 .\" All rights reserved.
   3 .\"
   4 .\" This documentation was written by Pawel Jakub Dawidek under sponsorship
   5 .\" from the FreeBSD Foundation.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\" $FreeBSD$
  29 .\"
  30 .Dd March 5, 2012
  31 .Dt AUDITDISTD 8
  32 .Os
  33 .Sh NAME
  34 .Nm auditdistd
  35 .Nd "Audit trail files distribution daemon"
  36 .Sh SYNOPSIS
  37 .Nm
  38 .Op Fl dFhl
  39 .Op Fl c Ar config
  40 .Op Fl P Ar pidfile
  41 .Sh DESCRIPTION
  42 The
  43 .Nm
  44 daemon is responsible for distributing audit trail files over TCP/IP network in
  45 a secure and reliable way.
  46 .Pp
  47 The
  48 .Nm
  49 daemon can be started with the following command line arguments:
  50 .Bl -tag -width ".Fl P Ar pidfile"
  51 .It Fl c Ar config
  52 Specify alternative location of the configuration file.
  53 The default location is
  54 .Pa /etc/security/auditdistd.conf .
  55 Note: the configuration file may contain passwords.
  56 Care should be taken to configure proper permissions on this file
  57 .Li ( eg. 0600 ) .
  58 .It Fl d
  59 Print or log debugging information.
  60 This option can be specified multiple times to raise the verbosity
  61 level.
  62 .It Fl F
  63 Start the
  64 .Nm
  65 daemon in the foreground.
  66 By default
  67 .Nm
  68 starts in the background.
  69 .It Fl h
  70 Print the
  71 .Nm
  72 usage message.
  73 .It Fl l
  74 Start in a launchd-friendly mode, ie. do not use
  75 .Xr daemon 3 .
  76 .It Fl P Ar pidfile
  77 Specify alternative location of a file where main process PID will be
  78 stored.
  79 The default location is
  80 .Pa /var/run/auditdistd.pid .
  81 .El
  82 .Sh FILES
  83 .Bl -tag -width ".Pa /etc/security/auditdistd.conf" -compact
  84 .It Pa /etc/security/auditdistd.conf
  85 The configuration file for
  86 .Nm .
  87 .It Pa /var/run/auditdistd.pid
  88 The default location of the
  89 .Nm
  90 PID file.
  91 .El
  92 .Sh EXIT STATUS
  93 Exit status is 0 on success, or one of the values described in
  94 .Xr sysexits 3
  95 on failure.
  96 .Sh SEE ALSO
  97 .Xr sysexits 3 ,
  98 .Xr audit 4 ,
  99 .Xr auditdistd.conf 5 ,
 100 .Xr auditd 8
 101 .Sh AUTHORS
 102 The
 103 .Nm
 104 was developed by
 105 .An Pawel Jakub Dawidek Aq pawel@dawidek.net
 106 under sponsorship of the FreeBSD Foundation.