usr.bin/logger/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. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)logger.1    8.1 (Berkeley) 6/6/93
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd March 16, 2022
  32 .Dt LOGGER 1
  33 .Os
  34 .Sh NAME
  35 .Nm logger
  36 .Nd make entries in the system log
  37 .Sh SYNOPSIS
  38 .Nm
  39 .Op Fl 46Ais
  40 .Op Fl f Ar file
  41 .Op Fl H Ar hostname
  42 .Op Fl h Ar host
  43 .Op Fl P Ar port
  44 .Op Fl p Ar pri
  45 .Op Fl S Ar addr Ns \&: Ns Ar port
  46 .Op Fl t Ar tag
  47 .Op Ar message ...
  48 .Sh DESCRIPTION
  49 The
  50 .Nm
  51 utility provides a shell command interface to the
  52 .Xr syslog 3
  53 system log module.
  54 .Pp
  55 The following options are available:
  56 .Bl -tag -width indent
  57 .It Fl 4
  58 Force
  59 .Nm
  60 to use IPv4 addresses only.
  61 .It Fl 6
  62 Force
  63 .Nm
  64 to use IPv6 addresses only.
  65 .It Fl A
  66 By default,
  67 .Nm
  68 tries to send the message to only one address,
  69 even if the host has more than one A or AAAA record.
  70 If this option is specified,
  71 .Nm
  72 tries to send the message to all addresses.
  73 .It Fl i
  74 Log the process id of the logger process
  75 with each line.
  76 This flag is ignored and the process id is always logged.
  77 .It Fl s
  78 Log the message to standard error, as well as the system log.
  79 .It Fl f Ar file
  80 Read the contents of the specified file into syslog.
  81 This option is ignored when a message is also specified.
  82 .It Fl H Ar hostname
  83 Set the hostname in the header of the message to specified value.
  84 If not specified, host part of
  85 .Xr gethostname 3
  86 will be used.
  87 .It Fl h Ar host
  88 Send the message to the remote system
  89 .Ar host
  90 instead of logging it locally.
  91 Note that
  92 .Nm
  93 currently supports
  94 .Li AF_INET
  95 .Pq IPv4 ,
  96 .Li AF_INET6
  97 .Pq IPv6 ,
  98 and
  99 .Li AF_LOCAL
 100 .Pq Unix-domain socket
 101 address families.
 102 The following address formats are valid in
 103 .Ar host :
 104 .Pp
 105 .Bl -tag -width "AF_LOCAL" -compact
 106 .It Li AF_INET
 107 192.168.2.1
 108 .It Li AF_INET6
 109 2001:db8::1
 110 .It Li AF_LOCAL
 111 .Pa /var/run/log
 112 .El
 113 .It Fl P Ar port
 114 Send the message to the specified
 115 .Ar port
 116 number on a remote system,
 117 which can be specified as a service name
 118 or as a decimal number.
 119 The default is
 120 .Dq Li syslog .
 121 If an unknown service name is used,
 122 .Nm
 123 prints a warning and falls back to port 514.
 124 .It Fl p Ar pri
 125 Enter the message with the specified priority.
 126 The priority may be specified numerically or as a
 127 .Li facility.level
 128 pair.
 129 For example,
 130 .Dq Fl p Li local3.info
 131 logs the message(s) as
 132 .Ar info Ns rmational
 133 level in the
 134 .Ar local3
 135 facility.
 136 The default is
 137 .Dq Li user.notice .
 138 .It Fl S Ar addr Ns \&: Ns Ar port
 139 Specify source address and/or source port when using
 140 .Fl h
 141 option.
 142 The same address will be used for all of the remote addresses
 143 when
 144 .Fl A
 145 flag is enabled.
 146 Note that a numeric IPv6 address in
 147 .Ar addr
 148 must be enclosed with
 149 .Dq \&[
 150 and
 151 .Dq \&] .
 152 .It Fl t Ar tag
 153 Mark every line in the log with the specified
 154 .Ar tag
 155 rather than the default of current login name.
 156 .It Ar message
 157 Write the message to log; if not specified, and the
 158 .Fl f
 159 flag is not
 160 provided, standard input is logged.
 161 .El
 162 .Sh EXIT STATUS
 163 .Ex -std
 164 .Sh EXAMPLES
 165 .Bd -literal -offset indent -compact
 166 logger System rebooted
 167
 168 logger \-p local0.notice \-t HOSTIDM \-f /dev/idmc
 169 .Ed
 170 .Sh SEE ALSO
 171 .Xr syslog 3 ,
 172 .Xr syslogd 8
 173 .Sh STANDARDS
 174 The
 175 .Nm
 176 command is expected to be
 177 .St -p1003.2
 178 compatible.