[docs] update readme a bit

README.md

@@ -11,24 +11,31 @@ _This is the source repository for **lnav**, visit [https://lnav.org](https://ln
 
 # LNAV -- The Logfile Navigator
 
-The Log File Navigator, **lnav** for short, is a log file viewer for
-the terminal.
+The Logfile Navigator is a log file viewer for the terminal.  Given a
+set of files, **lnav** will:
 
-## Screenshot
+- decompress as needed;
+- detect their format;
+- merge the files together by time into a single view;
+- monitor the files for new data or renames;
+- build an index of errors and warnings.
 
-The following screenshot shows a syslog file. Log lines are displayed with
-highlights. Errors are red and warnings are yellow.
+Then, in the **lnav** TUI, you can:
 
-[![Screenshot](docs/assets/images/lnav-syslog-thumb.png)](docs/assets/images/lnav-syslog.png)
+- jump quickly to the previous/next error ([press `e`/`E`](https://docs.lnav.org/en/latest/hotkeys.html#spatial-navigation));
+- search using regular expressions ([press `/`](https://docs.lnav.org/en/latest/hotkeys.html#spatial-navigation));
+- highlight text with a regular expression ([`:highlight`](https://docs.lnav.org/en/latest/commands.html#highlight-pattern) command);
+- filter messages using [regular expressions](https://docs.lnav.org/en/latest/usage.html#regular-expression-match) or [SQLite expressions](https://docs.lnav.org/en/latest/usage.html#sqlite-expression);
+- pretty-print structured text ([press `P`](https://docs.lnav.org/en/latest/hotkeys.html#display));
+- view a histogram of messages over time ([press `i`](https://docs.lnav.org/en/latest/hotkeys.html#display));
+- query messages using SQLite ([press `;`](https://docs.lnav.org/en/latest/sqlext.html))
 
-## Features
+## Screenshot
 
-- Log messages from different files are collated together into a single view
-- Automatic detection of log format
-- Automatic decompression of GZip and BZip2 files
-- Filter log messages based on regular expressions
-- Use SQL to analyze your logs
-- And more...
+The following screenshot shows a syslog file. Log lines are 
+displayed with highlights. Errors are red and warnings are yellow.
+
+[![Screenshot](docs/assets/images/lnav-syslog-thumb.png)](docs/assets/images/lnav-syslog.png)
 
 ## Installation
 
@@ -36,18 +43,22 @@ highlights. Errors are red and warnings are yellow.
 
 ## Usage
 
-The only file installed is the executable, `lnav`.  You can execute it
-with no arguments to view the default set of files:
+Simply point **lnav** at the files or directories you want to
+monitor, it will figure out the rest:
 
 ```
-$ lnav
+$ lnav /path/to/file
 ```
 
-You can view all the syslog messages by running:
+The **lnav** TUI will pop up right away and begin indexing the 
+files. Progress is displayed in the "Files" panel at the 
+bottom. Once the indexing has finished, the LOG view will display 
+the log messages that were recognized[1]. You can then use the 
+usual hotkeys to move around the view (arrow keys or
+`j`/`k`/`h`/`l` to move down/up/left/right).
 
-```
-$ lnav /var/log/messages*
-```
+[1] - Files that do not contain log messages can be seen in the 
+      TEXT view (reachable by pressing `t`).
 
 ### Usage with `systemd-journald`
 

test/expected/test_text_file.sh_5b51b55dff7332c5bee2c9b797c401c5614d574a.out

@@ -21,8 +21,35 @@
 
 LNAV – The Logfile Navigator
 
-The Log File Navigator, lnav for short, is a log file viewer for the
-terminal.
+The Logfile Navigator is a log file viewer for the terminal.  Given a
+set of files, lnav will:
+
+ • decompress as needed;
+ • detect their format;
+ • merge the files together by time into a single view;
+ • monitor the files for new data or renames;
+ • build an index of errors and warnings.
+
+Then, in the lnav TUI, you can:
+
+ • jump quickly to the previous/next error (]8;;https://docs.lnav.org/en/latest/hotkeys.html#spatial-navigation\press ]8;;\]8;;https://docs.lnav.org/en/latest/hotkeys.html#spatial-navigation\ e ]8;;\]8;;https://docs.lnav.org/en/latest/hotkeys.html#spatial-navigation\/]8;;\]8;;https://docs.lnav.org/en/latest/hotkeys.html#spatial-navigation\ E ]8;;\[1]);
+ • search using regular expressions (]8;;https://docs.lnav.org/en/latest/hotkeys.html#spatial-navigation\press ]8;;\]8;;https://docs.lnav.org/en/latest/hotkeys.html#spatial-navigation\ / ]8;;\[2]);
+ • highlight text with a regular expression (]8;;https://docs.lnav.org/en/latest/commands.html#highlight-pattern\ :highlight ]8;;\[3]
+   command);
+ • filter messages using ]8;;https://docs.lnav.org/en/latest/usage.html#regular-expression-match\regular expressions]8;;\[4] or ]8;;https://docs.lnav.org/en/latest/usage.html#sqlite-expression\SQLite]8;;\
+   ]8;;https://docs.lnav.org/en/latest/usage.html#sqlite-expression\expressions]8;;\[5];
+ • pretty-print structured text (]8;;https://docs.lnav.org/en/latest/hotkeys.html#display\press ]8;;\]8;;https://docs.lnav.org/en/latest/hotkeys.html#display\ P ]8;;\[6]);
+ • view a histogram of messages over time (]8;;https://docs.lnav.org/en/latest/hotkeys.html#display\press ]8;;\]8;;https://docs.lnav.org/en/latest/hotkeys.html#display\ i ]8;;\[7]);
+ • query messages using SQLite (]8;;https://docs.lnav.org/en/latest/sqlext.html\press ]8;;\]8;;https://docs.lnav.org/en/latest/sqlext.html\ ; ]8;;\[8])
+
+ ▌[1] - https://docs.lnav.org/en/latest/hotkeys.html#spatial-navigation     
+ ▌[2] - https://docs.lnav.org/en/latest/hotkeys.html#spatial-navigation     
+ ▌[3] - https://docs.lnav.org/en/latest/commands.html#highlight-pattern     
+ ▌[4] - https://docs.lnav.org/en/latest/usage.html#regular-expression-match 
+ ▌[5] - https://docs.lnav.org/en/latest/usage.html#sqlite-expression        
+ ▌[6] - https://docs.lnav.org/en/latest/hotkeys.html#display                
+ ▌[7] - https://docs.lnav.org/en/latest/hotkeys.html#display                
+ ▌[8] - https://docs.lnav.org/en/latest/sqlext.html                         
 
 Screenshot
 
@@ -34,16 +61,6 @@ with highlights. Errors are red and warnings are yellow.
  ▌[1] - file://{top_srcdir}/docs/assets/images/lnav-syslog-thumb.png 
  ▌[2] - file://{top_srcdir}/docs/assets/images/lnav-syslog.png       
 
-Features
-
- • Log messages from different files are collated
-   together into a single view
- • Automatic detection of log format
- • Automatic decompression of GZip and BZip2 files
- • Filter log messages based on regular expressions
- • Use SQL to analyze your logs
- • And more...
-
 Installation
 
 ]8;;https://github.com/tstack/lnav/releases/latest#release-artifacts\Download a statically-linked binary for Linux/MacOS from the release]8;;\
@@ -53,14 +70,19 @@ with highlights. Errors are red and warnings are yellow.
 
 Usage
 
-The only file installed is the executable,  lnav .  You can execute it
-with no arguments to view the default set of files:
+Simply point lnav at the files or directories you want to monitor, it
+will figure out the rest:
 
- ▌$ lnav                                  
+ ▌$ lnav /path/to/file                    
 
-You can view all the syslog messages by running:
+The lnav TUI will pop up right away and begin indexing the files.
+Progress is displayed in the "Files" panel at the bottom. Once the
+indexing has finished, the LOG view will display the log messages that
+were recognized[1]. You can then use the usual hotkeys to move around
+the view (arrow keys or  j / k / h / l  to move down/up/left/right).
 
- ▌$ lnav /var/log/messages*               
+[1] - Files that do not contain log messages can be seen in the TEXT
+view (reachable by pressing  t ).
 
 Usage with  systemd-journald 
 

test/expected/test_text_file.sh_6a24078983cf1b7a80b6fb65d5186cd125498136.out

@@ -8,16 +8,6 @@ with highlights. Errors are red and warnings are yellow.
  ▌[1] - file://{top_srcdir}/docs/assets/images/lnav-syslog-thumb.png 
  ▌[2] - file://{top_srcdir}/docs/assets/images/lnav-syslog.png       
 
-Features
-
- • Log messages from different files are collated
-   together into a single view
- • Automatic detection of log format
- • Automatic decompression of GZip and BZip2 files
- • Filter log messages based on regular expressions
- • Use SQL to analyze your logs
- • And more...
-
 Installation
 
 ]8;;https://github.com/tstack/lnav/releases/latest#release-artifacts\Download a statically-linked binary for Linux/MacOS from the release]8;;\
@@ -27,14 +17,19 @@ with highlights. Errors are red and warnings are yellow.
 
 Usage
 
-The only file installed is the executable,  lnav .  You can execute it
-with no arguments to view the default set of files:
+Simply point lnav at the files or directories you want to monitor, it
+will figure out the rest:
 
- ▌$ lnav                                  
+ ▌$ lnav /path/to/file                    
 
-You can view all the syslog messages by running:
+The lnav TUI will pop up right away and begin indexing the files.
+Progress is displayed in the "Files" panel at the bottom. Once the
+indexing has finished, the LOG view will display the log messages that
+were recognized[1]. You can then use the usual hotkeys to move around
+the view (arrow keys or  j / k / h / l  to move down/up/left/right).
 
- ▌$ lnav /var/log/messages*               
+[1] - Files that do not contain log messages can be seen in the TEXT
+view (reachable by pressing  t ).
 
 Usage with  systemd-journald 
 

test/expected/test_text_file.sh_c2a346ca1da2da4346f1d310212e166767993ce9.out

@@ -2,7 +2,7 @@
     {
         "top_meta": {
             "file": "{top_srcdir}/README.md",
-            "anchor": "#support",
+            "anchor": "#usage-with-systemd-journald-",
             "breadcrumbs": [
                 {
                     "display_value": "README.md",
@@ -23,15 +23,12 @@
                     ]
                 },
                 {
-                    "display_value": "Support",
+                    "display_value": "Usage",
                     "search_placeholder": "",
                     "possibilities": [
                         {
                             "display_value": "Contributing"
                         },
-                        {
-                            "display_value": "Features"
-                        },
                         {
                             "display_value": "Installation"
                         },
@@ -51,6 +48,15 @@
                             "display_value": "Usage"
                         }
                     ]
+                },
+                {
+                    "display_value": "Usage with  systemd-journald ",
+                    "search_placeholder": "",
+                    "possibilities": [
+                        {
+                            "display_value": "Usage with  systemd-journald "
+                        }
+                    ]
                 }
             ]
         }

test/expected/test_text_file.sh_e088ea61a5382458cc48a2607e2639e52b0be1da.out

@@ -8,16 +8,6 @@ with highlights. Errors are red and warnings are yellow.
  ▌[1] - file://{top_srcdir}/docs/assets/images/lnav-syslog-thumb.png 
  ▌[2] - file://{top_srcdir}/docs/assets/images/lnav-syslog.png       
 
-Features
-
- • Log messages from different files are collated
-   together into a single view
- • Automatic detection of log format
- • Automatic decompression of GZip and BZip2 files
- • Filter log messages based on regular expressions
- • Use SQL to analyze your logs
- • And more...
-
 Installation
 
 ]8;;https://github.com/tstack/lnav/releases/latest#release-artifacts\Download a statically-linked binary for Linux/MacOS from the release]8;;\
@@ -27,14 +17,19 @@ with highlights. Errors are red and warnings are yellow.
 
 Usage
 
-The only file installed is the executable,  lnav .  You can execute it
-with no arguments to view the default set of files:
+Simply point lnav at the files or directories you want to monitor, it
+will figure out the rest:
 
- ▌$ lnav                                  
+ ▌$ lnav /path/to/file                    
 
-You can view all the syslog messages by running:
+The lnav TUI will pop up right away and begin indexing the files.
+Progress is displayed in the "Files" panel at the bottom. Once the
+indexing has finished, the LOG view will display the log messages that
+were recognized[1]. You can then use the usual hotkeys to move around
+the view (arrow keys or  j / k / h / l  to move down/up/left/right).
 
- ▌$ lnav /var/log/messages*               
+[1] - Files that do not contain log messages can be seen in the TEXT
+view (reachable by pressing  t ).
 
 Usage with  systemd-journald