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