diff options
Diffstat (limited to '')
| -rw-r--r-- | lnav.1 | 87 |
1 files changed, 50 insertions, 37 deletions
@@ -1,4 +1,3 @@ -.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.43.3.
.\" Some roff macros, for reference:
.\" .nh disable hyphenation
.\" .hy enable hyphenation
@@ -19,21 +18,27 @@ .ft R
.fi
..
-.TH LNAV "1" "August 2022"
+.TH LNAV "1" "April 2024"
.SH NAME
-lnav \- ncurses-based log file viewer
+lnav \- log file viewer for the terminal
.SH SYNOPSIS
.B lnav
-[\-hVsar] [logfile1 logfile2 ...]
+[options] [logfile1 logfile2 ...]
.SH DESCRIPTION
-The log file navigator, lnav, is an enhanced log file viewer that
-takes advantage of any semantic information that can be gleaned from
-the files being viewed, such as timestamps and log levels. Using this
-extra semantic information, lnav can do things like interleaving
-messages from different files, generate histograms of messages over
-time, and providing hotkeys for navigating through the file. It is
-hoped that these features will allow the user to quickly and
-efficiently zero in on problems.
+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.
.SH KEY BINDINGS
.TP
?
@@ -49,36 +54,15 @@ Print help and exit \fB\-H\fR
Display the internal help text.
.TP
-\fB\-n\fR
-Run without the curses UI. (headless mode)
-.TP
-\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\-I\fR path
Add the given configuration directory to the search path.
.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.
-.TP
-\fB\-i\fR
-Install the given format files in the $HOME/.lnav/formats/installed directory
-and exit.
+\fB\-W\fR
+Print warnings related to lnav's configuration.
.TP
\fB\-u\fR
Update formats installed from git repositories.
.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.
-.TP
\fB\-d\fR file
Write debug messages to the given file.
.TP
@@ -91,18 +75,47 @@ Recursively load files from the given directories. \fB\-R\fR
Load older rotated log files as well.
.TP
+\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
\fB\-t\fR
Prepend timestamps to the lines of data being read in
on the standard input.
.TP
-\fB\-w\fR file
-Write the contents of the standard input to this file.
+\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.
.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.
+.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.
.SH EXAMPLES
To load and follow the syslog file:
.PP
|