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 December 5, 2017
  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 .It Fl s
  77 Log the message to standard error, as well as the system log.
  78 .It Fl f Ar file
  79 Read the contents of the specified file into syslog.
  80 This option is ignored when a message is also specified.
  81 .It Fl H Ar hostname
  82 Set the hostname in the header of the message to specified value.
  83 If not specified, host part of
  84 .Xr gethostname 3
  85 will be used.
  86 .It Fl h Ar host
  87 Send the message to the remote system
  88 .Ar host
  89 instead of logging it locally.
  90 Note that
  91 .Nm
  92 currently supports
  93 .Li AF_INET
  94 .Pq IPv4 ,
  95 .Li AF_INET6
  96 .Pq IPv6 ,
  97 and
  98 .Li AF_LOCAL
  99 .Pq Unix-domain socket
 100 address families.
 101 The following address formats are valid in
 102 .Ar host :
 103 .Pp
 104 .Bl -tag -width "AF_LOCAL" -compact
 105 .It Li AF_INET
 106 192.168.2.1
 107 .It Li AF_INET6
 108 2001:db8::1
 109 .It Li AF_LOCAL
 110 .Pa /var/run/log
 111 .El
 112 .It Fl P Ar port
 113 Send the message to the specified
 114 .Ar port
 115 number on a remote system,
 116 which can be specified as a service name
 117 or as a decimal number.
 118 The default is
 119 .Dq Li syslog .
 120 If an unknown service name is used,
 121 .Nm
 122 prints a warning and falls back to port 514.
 123 .It Fl p Ar pri
 124 Enter the message with the specified priority.
 125 The priority may be specified numerically or as a
 126 .Li facility.level
 127 pair.
 128 For example,
 129 .Dq Fl p Li local3.info
 130 logs the message(s) as
 131 .Ar info Ns rmational
 132 level in the
 133 .Ar local3
 134 facility.
 135 The default is
 136 .Dq Li user.notice .
 137 .It Fl S Ar addr Ns \&: Ns Ar port
 138 Specify source address and/or source port when using
 139 .Fl h
 140 option.
 141 The same address will be used for all of the remote addresses
 142 when
 143 .Fl A
 144 flag is enabled.
 145 Note that a numeric IPv6 address in
 146 .Ar addr
 147 must be enclosed with
 148 .Dq \&[
 149 and
 150 .Dq \&] .
 151 .It Fl t Ar tag
 152 Mark every line in the log with the specified
 153 .Ar tag
 154 rather than the default of current login name.
 155 .It Ar message
 156 Write the message to log; if not specified, and the
 157 .Fl f
 158 flag is not
 159 provided, standard input is logged.
 160 .El
 161 .Sh EXIT STATUS
 162 .Ex -std
 163 .Sh EXAMPLES
 164 .Bd -literal -offset indent -compact
 165 logger System rebooted
 166
 167 logger \-p local0.notice \-t HOSTIDM \-f /dev/idmc
 168 .Ed
 169 .Sh SEE ALSO
 170 .Xr syslog 3 ,
 171 .Xr syslogd 8
 172 .Sh STANDARDS
 173 The
 174 .Nm
 175 command is expected to be
 176 .St -p1003.2
 177 compatible.