2013-08-21 01:41:15 +00:00
|
|
|
.\" Some roff macros, for reference:
|
|
|
|
|
.\" .nh disable hyphenation
|
|
|
|
|
.\" .hy enable hyphenation
|
|
|
|
|
.\" .ad l left justify
|
|
|
|
|
.\" .ad b justify to both left and right margins
|
|
|
|
|
.\" .nf disable filling
|
|
|
|
|
.\" .fi enable filling
|
|
|
|
|
.\" .br insert line break
|
|
|
|
|
.\" .sp <n> insert n+1 empty lines
|
|
|
|
|
.\" for manpage-specific macros, see man(7)
|
|
|
|
|
.\" Define macros
|
|
|
|
|
.de Vb \" Begin verbatim text
|
|
|
|
|
.ft CW
|
|
|
|
|
.nf
|
|
|
|
|
.ne \\$1
|
|
|
|
|
..
|
|
|
|
|
.de Ve \" End verbatim text
|
|
|
|
|
.ft R
|
|
|
|
|
.fi
|
|
|
|
|
..
|
2024-04-07 14:52:07 +00:00
|
|
|
.TH LNAV "1" "April 2024"
|
2013-08-21 01:41:15 +00:00
|
|
|
.SH NAME
|
2024-04-07 14:52:07 +00:00
|
|
|
lnav \- log file viewer for the terminal
|
2013-08-21 01:41:15 +00:00
|
|
|
.SH SYNOPSIS
|
|
|
|
|
.B lnav
|
2024-04-07 14:52:07 +00:00
|
|
|
[options] [logfile1 logfile2 ...]
|
2013-08-21 01:41:15 +00:00
|
|
|
.SH DESCRIPTION
|
2024-04-07 14:52:07 +00:00
|
|
|
The Logfile Navigator, lnav, is a log file viewer for the terminal.
|
|
|
|
|
Given a set of files/directories, lnav will:
|
|
|
|
|
.TP
|
|
|
|
|
- decompress as needed;
|
|
|
|
|
.TP
|
|
|
|
|
- detect their format;
|
|
|
|
|
.TP
|
|
|
|
|
- merge the files together by time into a single view;
|
|
|
|
|
.TP
|
|
|
|
|
- tail the files, follow renames, find new files in directories;
|
|
|
|
|
.TP
|
|
|
|
|
- build an index of errors and warnings;
|
|
|
|
|
.TP
|
|
|
|
|
- pretty-print JSON-lines.
|
2013-08-21 01:41:15 +00:00
|
|
|
.SH KEY BINDINGS
|
|
|
|
|
.TP
|
|
|
|
|
?
|
|
|
|
|
View/leave the online help text.
|
|
|
|
|
.TP
|
|
|
|
|
q
|
|
|
|
|
Quit the program.
|
|
|
|
|
.SH OPTIONS
|
|
|
|
|
.TP
|
|
|
|
|
\fB\-h\fR
|
|
|
|
|
Print help and exit
|
2014-02-10 15:53:56 +00:00
|
|
|
.TP
|
|
|
|
|
\fB\-H\fR
|
|
|
|
|
Display the internal help text.
|
2013-08-21 01:41:15 +00:00
|
|
|
.TP
|
2014-11-05 17:01:09 +00:00
|
|
|
\fB\-I\fR path
|
|
|
|
|
Add the given configuration directory to the search path.
|
|
|
|
|
.TP
|
2024-04-07 14:52:07 +00:00
|
|
|
\fB\-W\fR
|
|
|
|
|
Print warnings related to lnav's configuration.
|
2014-11-05 17:01:09 +00:00
|
|
|
.TP
|
2022-08-09 06:14:02 +00:00
|
|
|
\fB\-u\fR
|
|
|
|
|
Update formats installed from git repositories.
|
|
|
|
|
.TP
|
2013-08-21 01:41:15 +00:00
|
|
|
\fB\-d\fR file
|
|
|
|
|
Write debug messages to the given file.
|
|
|
|
|
.TP
|
|
|
|
|
\fB\-V\fR
|
|
|
|
|
Print version information.
|
|
|
|
|
.TP
|
|
|
|
|
\fB\-r\fR
|
2019-03-15 05:24:57 +00:00
|
|
|
Recursively load files from the given directories.
|
|
|
|
|
.TP
|
|
|
|
|
\fB\-R\fR
|
2013-08-21 01:41:15 +00:00
|
|
|
Load older rotated log files as well.
|
|
|
|
|
.TP
|
2024-04-07 14:52:07 +00:00
|
|
|
\fB\-c\fR cmd
|
|
|
|
|
Execute a command after the files have been loaded.
|
|
|
|
|
.TP
|
|
|
|
|
\fB\-f\fR path
|
|
|
|
|
Execute the commands in the given file.
|
|
|
|
|
.TP
|
|
|
|
|
\fB\-e\fR cmd
|
|
|
|
|
Execute a shell command-line.
|
|
|
|
|
.TP
|
2013-08-21 01:41:15 +00:00
|
|
|
\fB\-t\fR
|
|
|
|
|
Prepend timestamps to the lines of data being read in
|
|
|
|
|
on the standard input.
|
2024-04-07 14:52:07 +00:00
|
|
|
.TP
|
|
|
|
|
\fB\-n\fR
|
|
|
|
|
Run without the curses UI. (headless mode)
|
|
|
|
|
.TP
|
|
|
|
|
\fB\-N\fR
|
|
|
|
|
Do not open the default syslog file if no files are given.
|
|
|
|
|
.TP
|
|
|
|
|
\fB\-q\fR
|
|
|
|
|
Quiet mode. Do not print the log messages after executing all of the commands.
|
2013-08-21 01:41:15 +00:00
|
|
|
.SS "Optional arguments:"
|
|
|
|
|
.TP
|
|
|
|
|
logfile1
|
|
|
|
|
The log files or directories to view. If a
|
|
|
|
|
directory is given, all of the files in the
|
|
|
|
|
directory will be loaded.
|
2024-04-07 14:52:07 +00:00
|
|
|
.SH MANAGEMENT-MODE OPTIONS
|
|
|
|
|
.TP
|
|
|
|
|
\fB\-i\fR
|
|
|
|
|
Install the given format files in the $HOME/.lnav/formats/installed directory
|
|
|
|
|
and exit.
|
|
|
|
|
.TP
|
|
|
|
|
\fB\-m\fR
|
|
|
|
|
Switch to the management command-line mode. This mode is
|
|
|
|
|
used to work with lnav's configuration.
|
|
|
|
|
.TP
|
|
|
|
|
\fB\-C\fR
|
|
|
|
|
Check the configuration and exit. The log format files will be loaded and
|
|
|
|
|
checked. Any files given on the command-line will be loaded checked to make
|
|
|
|
|
sure they match a log format.
|
2013-08-21 01:41:15 +00:00
|
|
|
.SH EXAMPLES
|
|
|
|
|
To load and follow the syslog file:
|
|
|
|
|
.PP
|
|
|
|
|
.Vb 1
|
2019-10-23 20:31:08 +00:00
|
|
|
\& lnav
|
2013-08-21 01:41:15 +00:00
|
|
|
.Ve
|
|
|
|
|
.PP
|
|
|
|
|
To load all of the files in /var/log:
|
|
|
|
|
.PP
|
|
|
|
|
.Vb 1
|
|
|
|
|
\& lnav /var/log
|
|
|
|
|
.Ve
|
|
|
|
|
.PP
|
|
|
|
|
To watch the output of make with timestamps prepended:
|
|
|
|
|
.PP
|
|
|
|
|
.Vb 1
|
|
|
|
|
\& make 2>&1 | lnav \-t
|
|
|
|
|
.Ve
|
|
|
|
|
.SH AUTHOR
|
|
|
|
|
This manual page was written by Salvatore Bonaccorso <carnil@debian.org>
|
|
|
|
|
for the Debian system (but may be used by others).
|
