usr.bin/logger/logger.1

   1 .\"     $NetBSD: logger.1,v 1.15 2012/05/13 17:08:31 njoly Exp $
   2 .\"
   3 .\" Copyright (c) 1983, 1990, 1993
   4 .\"     The Regents of the University of California.  All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. Neither the name of the University nor the names of its contributors
  15 .\"    may be used to endorse or promote products derived from this software
  16 .\"    without specific prior written permission.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28 .\" SUCH DAMAGE.
  29 .\"
  30 .\"     @(#)logger.1    8.1 (Berkeley) 6/6/93
  31 .\"
  32 .Dd April 26, 2012
  33 .Dt LOGGER 1
  34 .Os
  35 .Sh NAME
  36 .Nm logger
  37 .Nd make entries in the system log
  38 .Sh SYNOPSIS
  39 .Nm
  40 .Op Fl cins
  41 .Op Fl d Ar SD
  42 .Op Fl f Ar file
  43 .Op Fl m Ar msgid
  44 .Op Fl p Ar pri
  45 .Op Fl t Ar tag
  46 .Op Ar message ...
  47 .Sh DESCRIPTION
  48 .Nm
  49 provides a shell command interface to the
  50 .Xr syslog 3
  51 system log module.
  52 .Pp
  53 Options:
  54 .Pp
  55 .Bl -tag -width "messageXX"
  56 .It Fl c
  57 Log to console
  58 .Dv ( LOG_CONS ) .
  59 .It Fl d Ar sd
  60 Log this in the structured data (SD) field.
  61 .Po
  62 .Ar sd
  63 has to be passed as one argument and will require careful quoting when used from
  64 the shell.
  65 .Pc
  66 .It Fl f Ar file
  67 Log the specified file.
  68 .It Fl i
  69 Log the process id of the logger process
  70 with each line
  71 .Dv ( LOG_PID ) .
  72 .It Fl m Ar msgid
  73 The MSGID used for the message.
  74 .It Fl n
  75 Open log file immediately
  76 .Dv ( LOG_NDELAY ) .
  77 .It Fl p Ar pri
  78 Enter the message with the specified priority.
  79 The priority may be specified numerically or as a
  80 .Dq facility.level
  81 pair.
  82 For example,
  83 .Dq \-p local3.info
  84 logs the message(s) as
  85 .Ar info Ns rmational
  86 level in the
  87 .Ar local3
  88 facility.
  89 The default is
  90 .Dq user.notice .
  91 .It Fl s
  92 Log the message to standard error, as well as the system log
  93 .Dv ( LOG_PERROR ) .
  94 .It Fl t Ar tag
  95 Mark every line in the log with the specified
  96 .Ar tag  .
  97 .It Ar message
  98 Write the message to log; if not specified, and the
  99 .Fl f
 100 flag is not provided, standard input is logged.
 101 .El
 102 .Sh EXIT STATUS
 103 .Ex -std logger
 104 .Sh EXAMPLES
 105 .Bd -literal -offset indent -compact
 106 logger System rebooted
 107
 108 logger \-p local0.notice \-t HOSTIDM \-f /dev/idmc
 109 .Ed
 110 .Sh SEE ALSO
 111 .Xr syslog 3 ,
 112 .Xr syslogd 8
 113 .Sh STANDARDS
 114 The
 115 .Nm
 116 utility conforms to
 117 .St -p1003.2-92 .