misc-utils/logger.1

   1 .\" Copyright (c) 1983, 1990, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)logger.1    8.1 (Berkeley) 6/6/93
  33 .\"
  34 .\" Section on valid facitily and level strings added by
  35 .\" and1000@debian.org, 26 Oct 1997.
  36 .Dd June 6, 1993
  37 .Dt LOGGER 1
  38 .Os BSD 4.3
  39 .Sh NAME
  40 .Nm logger
  41 .Nd make entries in the system log
  42 .Sh SYNOPSIS
  43 .Nm logger
  44 .Op Fl isd
  45 .Op Fl f Ar file
  46 .Op Fl p Ar pri
  47 .Op Fl t Ar tag
  48 .Op Fl u Ar socket
  49 .Op Ar message ...
  50 .Sh DESCRIPTION
  51 .Nm Logger
  52 provides a shell command interface to the
  53 .Xr syslog  3
  54 system log module.
  55 .Pp
  56 Options:
  57 .Pp
  58 .Bl -tag -width "message"
  59 .It Fl i
  60 Log the process id of the logger process
  61 with each line.
  62 .It Fl s
  63 Log the message to standard error, as well as the system log.
  64 .It Fl f Ar file
  65 Log the specified file.
  66 .It Fl p Ar pri
  67 Enter the message with the specified priority.
  68 The priority may be specified numerically or as a ``facility.level''
  69 pair.
  70 For example, ``\-p local3.info'' logs the message(s) as
  71 .Ar info Ns rmational
  72 level in the
  73 .Ar local3
  74 facility.
  75 The default is ``user.notice.''
  76 .It Fl t Ar tag
  77 Mark every line in the log with the specified
  78 .Ar tag  .
  79 .It Fl u Ar sock
  80 Write to socket as specified with
  81 .Ar socket
  82 instead of builtin syslog routines.
  83 .It Fl d
  84 Use a datagram instead of a stream connection to this socket.
  85 .It --
  86 End the argument list. This is to allow the
  87 .Ar message
  88 to start with a hyphen (\-).
  89 .It Ar message
  90 Write the message to log; if not specified, and the
  91 .Fl f
  92 flag is not
  93 provided, standard input is logged.
  94 .El
  95 .Pp
  96 The
  97 .Nm logger
  98 utility exits 0 on success, and >0 if an error occurs.
  99 .Pp
 100 Valid facility names are: auth, authpriv (for security information of
 101 a sensitive nature), cron, daemon, ftp, kern, lpr, mail, news,
 102 security (deprecated synonym for auth), syslog, user, uucp, and local0
 103 to local7, inclusive.
 104 .Pp
 105 Valid level names are: alert, crit, debug, emerg, err, error
 106 (deprecated synonym for err), info, notice, panic (deprecated synonym
 107 for emerg), warning, warn (deprecated synonym for warning).
 108 .Sh EXAMPLES
 109 .Bd -literal -offset indent -compact
 110 logger System rebooted
 111
 112 logger \-p local0.notice \-t HOSTIDM \-f /dev/idmc
 113 .Ed
 114 .Sh SEE ALSO
 115 .Xr syslog 3 ,
 116 .Xr syslogd 8
 117 .Sh STANDARDS
 118 The
 119 .Nm logger
 120 command is expected to be
 121 .St -p1003.2
 122 compatible.