[bins] add manpage

Related to #1176

.github/workflows/bins.yml

@@ -43,7 +43,7 @@ jobs:
         run: >-
           mkdir ${{ env.LNAV_BASENAME }} &&
           cd ${{ env.LNAV_BASENAME }} &&
-          cp ../NEWS.md ../README . &&
+          cp ../NEWS.md ../README ../lnav.1 . &&
           cp ../lbuild/src/lnav . &&
           cd .. &&
           zip -r ${{ env.LNAV_ZIPNAME }} ${{ env.LNAV_BASENAME }}
@@ -96,7 +96,7 @@ jobs:
           cd ${{ github.workspace }} &&
           mkdir ${{ env.LNAV_BASENAME }} &&
           cd ${{ env.LNAV_BASENAME }} &&
-          cp ../NEWS.md ../README . &&
+          cp ../NEWS.md ../README ../lnav.1 . &&
           cp ../lbuild/src/lnav . &&
           cd .. &&
           zip -r ${{ env.LNAV_ZIPNAME }} ${{ env.LNAV_BASENAME }}
@@ -149,7 +149,7 @@ jobs:
         run: >-
           mkdir ${{ env.LNAV_BASENAME }} &&
           cd ${{ env.LNAV_BASENAME }} &&
-          cp ../NEWS.md ../README . &&
+          cp ../NEWS.md ../README ../lnav.1 . &&
           cp ../src/lnav . &&
           cd .. &&
           zip -r ${{ env.LNAV_ZIPNAME }} ${{ env.LNAV_BASENAME }}

lnav.1

@@ -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
+The Logfile Navigator, lnav, is a log file viewer for the terminal.
-takes advantage of any semantic information that can be gleaned from
+Given a set of files/directories, lnav will:
-the files being viewed, such as timestamps and log levels.  Using this
+.TP
-extra semantic information, lnav can do things like interleaving
+- decompress as needed;
-messages from different files, generate histograms of messages over
+.TP
-time, and providing hotkeys for navigating through the file.  It is
+- detect their format;
-hoped that these features will allow the user to quickly and
+.TP
-efficiently zero in on problems.
+- 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
+\fB\-W\fR
-Do not open the default syslog file if no files are given.
+Print warnings related to lnav's configuration.
-.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.
 .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,15 +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\-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