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 facility 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 a shell command interface to the syslog(3) system log module
  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 makes entries in the system log.
  53 It provides a shell command interface to the
  54 .Xr syslog  3
  55 system log module.
  56 .Pp
  57 Options:
  58 .Pp
  59 .Bl -tag -width "message"
  60 .It Fl i
  61 Log the process id of the logger process
  62 with each line.
  63 .It Fl s
  64 Log the message to standard error, as well as the system log.
  65 .It Fl f Ar file
  66 Log the specified file.
  67 .It Fl p Ar pri
  68 Enter the message with the specified priority.
  69 The priority may be specified numerically or as a ``facility.level''
  70 pair.
  71 For example, ``\-p local3.info'' logs the message(s) as
  72 .Ar info Ns rmational
  73 level in the
  74 .Ar local3
  75 facility.
  76 The default is ``user.notice.''
  77 .It Fl t Ar tag
  78 Mark every line in the log with the specified
  79 .Ar tag  .
  80 .It Fl u Ar sock
  81 Write to socket as specified with
  82 .Ar socket
  83 instead of builtin syslog routines.
  84 .It Fl d
  85 Use a datagram instead of a stream connection to this socket.
  86 .It --
  87 End the argument list. This is to allow the
  88 .Ar message
  89 to start with a hyphen (\-).
  90 .It Ar message
  91 Write the message to log; if not specified, and the
  92 .Fl f
  93 flag is not
  94 provided, standard input is logged.
  95 .El
  96 .Pp
  97 The
  98 .Nm logger
  99 utility exits 0 on success, and >0 if an error occurs.
 100 .Pp
 101 Valid facility names are: auth, authpriv (for security information of
 102 a sensitive nature), cron, daemon, ftp, kern, lpr, mail, news,
 103 security (deprecated synonym for auth), syslog, user, uucp, and local0
 104 to local7, inclusive.
 105 .Pp
 106 Valid level names are):
 107 alert, crit, debug, emerg, err, error (deprecated synonym for err),
 108 info, notice, panic (deprecated synonym for emerg), warning,
 109 warn (deprecated synonym for warning).
 110 For the priority order and intended purposes of these levels, see
 111 .Xr syslog 3 .
 112 .Sh EXAMPLES
 113 .Bd -literal -offset indent -compact
 114 logger System rebooted
 115
 116 logger \-p local0.notice \-t HOSTIDM \-f /dev/idmc
 117 .Ed
 118 .Sh SEE ALSO
 119 .Xr syslog 3 ,
 120 .Xr syslogd 8
 121 .Sh STANDARDS
 122 The
 123 .Nm logger
 124 command is expected to be
 125 .St -p1003.2
 126 compatible.
 127 .Sh AVAILABILITY
 128 The logger command is part of the util-linux-ng package and is available from
 129 ftp://ftp.kernel.org/pub/linux/utils/util-linux-ng/.