1lcm-logger(1) Lightweight Communications and Marshalling (LCM) lcm-logger(1)
2
6 lcm-logger - data logger
7
9 lcm-logger [options] [FILE]
10
13 LCM message logging utility. Subscribes to all channels on an LCM net‐
14 work, and records all messages received to FILE. If FILE is not speci‐
15 fied, then a filename is automatically chosen.
16
19 The following options are provided by lcm-logger
20 -c, --channel=CHAN
22 Channel string to pass to lcm_subscribe. (default: ".*")
23 --flush-interval=MS
25 Flush the log file to disk every MS milliseconds. (default: 100)
26 -f, --force
28 Overwrite existing files. The default behavior is to fail if
29 the output file already exists.
30 -h, --help
32 Shows some help text and exits
33 -i, --increment
35 Automatically append a suffix to FILE such that the resulting
36 filename does not already exist. This option precludes -f and
37 --rotate.
38 -l, --lcm-url=URL
40 Log messages on the specified LCM URL
41 -m, --max-unwritten-mb=SIZE
43 Maximum size of received but unwritten messages to store in mem‐
44 ory before dropping messages. (default: 100 MB)
45 --rotate=NUM
47 When creating a new log file, rename existing files out of the
48 way and always write to FILE.0. If FILE.0 already exists, it is
49 renamed to FILE.1. If FILE.1 exists, it is renamed to FILE.2,
50 etc. If FILE.NUM exists, then it is deleted. This option pre‐
51 cludes -i.
52 --split-mb=N
54 Automatically start writing to a new log file once the log file
55 exceeds N MB in size (can be fractional). This option requires
56 -i or --rotate.
57 -q, --quiet
59 Suppress normal output and only report errors.
60 -s, --strftime
62 Format FILE with strftime.
63 -v, --invert-channels
65 Invert channels. Log evertyhing that CHAN does not match.
66
69 For long-term logging, lcm-logger can rotate through a fixed number of
70 log files, moving to a new log file as existing files reach a maximum
71 size. To do this, use --rotate and --split-mb. For example:
72 # Rotate through logfile.0, logfile.1, ... logfile.4
74 lcm-logger --rotate=5 --split-mb=2 logfile
75 Moving to a new file happens either when the current log file size
77 exceeds the limit specified by --split-mb, or when lcm-logger receives
78 a SIGHUP.
79
82 On platforms defining SIGHUP, lcm-logger will react to HUP by closing
83 the active log file and opening a new one.
84
87 strftime(3)
88
91 lcm-logger is part of the Lightweight Communications and Marshalling
92 (LCM) project. Permission is granted to copy, distribute and/or modify
93 it under the terms of the GNU Lesser General Public License as pub‐
94 lished by the Free Software Foundation; either version 2.1 of the
95 License, or (at your option) any later version. See the file COPYING
96 in the LCM distribution for more details regarding distribution.
97 LCM is distributed in the hope that it will be useful, but WITHOUT ANY
99 WARRANTY; without even the implied warranty of MERCHANTABILITY or FIT‐
100 NESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
101 License for more details. You should have received a copy of the GNU
102 Lesser General Public License along with LCM; if not, write to the Free
103 Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
104 02110-1301 USA
105
108 This manual page was written by Albert Huang.
109LCM 2009-07-28 lcm-logger(1)