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