[docs] some more readme tweaks

pull/1242/head
Tim Stack 3 months ago
parent 0ef8957588
commit acccc9f7a6

@ -17,7 +17,7 @@ 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;
- tail the files and follow renames;
- build an index of errors and warnings.
Then, in the **lnav** TUI, you can:
@ -37,17 +37,33 @@ displayed with highlights. Errors are red and warnings are yellow.
[![Screenshot](docs/assets/images/lnav-syslog-thumb.png)](docs/assets/images/lnav-syslog.png)
## Why not **just** use `tail`/`grep`/`less`?
The standard Unix utilities are great for processing raw text lines,
however, they do not understand log messages. Tail can watch
multiple files at a time, but it won't display messages in order by
time and you can't scroll backwards. Grep will only find matching
lines, but won't return a full multi-line log message. Less can only
display a single file at a time. Also, none of these basic tools
handle compressed files.
## Installation
[Download a statically-linked binary for Linux/MacOS from the release page](https://github.com/tstack/lnav/releases/latest#release-artifacts)
### Brew on MacOS
```console
$ brew install lnav
```
## Usage
Simply point **lnav** at the files or directories you want to
monitor, it will figure out the rest:
```
$ lnav /path/to/file
```console
$ lnav /path/to/file1 /path/to/dir ...
```
The **lnav** TUI will pop up right away and begin indexing the
@ -57,6 +73,9 @@ 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).
See the [Usage section](https://docs.lnav.org/en/latest/usage.html)
of the online documentation for more information.
[1] - Files that do not contain log messages can be seen in the
TEXT view (reachable by pressing `t`).

@ -27,7 +27,7 @@ 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;
• tail the files and follow renames;
• build an index of errors and warnings.
Then, in the lnav TUI, you can:
@ -61,6 +61,16 @@ 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
Why not just use  tail / grep / less ?
The standard Unix utilities are great for processing raw text lines,
however, they do not understand log messages. Tail can watch multiple
files at a time, but it won't display messages in order by time and
you can't scroll backwards. Grep will only find matching lines, but
won't return a full multi-line log message. Less can only display a
single file at a time. Also, none of these basic tools handle
compressed files.
Installation
]8;;https://github.com/tstack/lnav/releases/latest#release-artifacts\Download a statically-linked binary for Linux/MacOS from the release]8;;\
@ -68,12 +78,16 @@ with highlights. Errors are red and warnings are yellow.
▌[1] - https://github.com/tstack/lnav/releases/latest#release-artifacts
Brew on MacOS
$ brew install lnav 
Usage
Simply point lnav at the files or directories you want to monitor, it
will figure out the rest:
$ lnav /path/to/file 
$ lnav /path/to/file1 /path/to/dir ... 
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
@ -81,6 +95,11 @@ 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).
See the ]8;;https://docs.lnav.org/en/latest/usage.html\Usage section]8;;\[1] of the online documentation for more
information.
▌[1] - https://docs.lnav.org/en/latest/usage.html
[1] - Files that do not contain log messages can be seen in the TEXT
view (reachable by pressing  t ).

@ -8,6 +8,16 @@ 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
Why not just use  tail / grep / less ?
The standard Unix utilities are great for processing raw text lines,
however, they do not understand log messages. Tail can watch multiple
files at a time, but it won't display messages in order by time and
you can't scroll backwards. Grep will only find matching lines, but
won't return a full multi-line log message. Less can only display a
single file at a time. Also, none of these basic tools handle
compressed files.
Installation
]8;;https://github.com/tstack/lnav/releases/latest#release-artifacts\Download a statically-linked binary for Linux/MacOS from the release]8;;\
@ -15,12 +25,16 @@ with highlights. Errors are red and warnings are yellow.
▌[1] - https://github.com/tstack/lnav/releases/latest#release-artifacts
Brew on MacOS
$ brew install lnav 
Usage
Simply point lnav at the files or directories you want to monitor, it
will figure out the rest:
$ lnav /path/to/file 
$ lnav /path/to/file1 /path/to/dir ... 
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
@ -28,6 +42,11 @@ 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).
See the ]8;;https://docs.lnav.org/en/latest/usage.html\Usage section]8;;\[1] of the online documentation for more
information.
▌[1] - https://docs.lnav.org/en/latest/usage.html
[1] - Files that do not contain log messages can be seen in the TEXT
view (reachable by pressing  t ).

@ -46,6 +46,9 @@
},
{
"display_value": "Usage"
},
{
"display_value": "Why not just use tail / grep / less ?"
}
]
},

@ -8,6 +8,16 @@ 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
Why not just use  tail / grep / less ?
The standard Unix utilities are great for processing raw text lines,
however, they do not understand log messages. Tail can watch multiple
files at a time, but it won't display messages in order by time and
you can't scroll backwards. Grep will only find matching lines, but
won't return a full multi-line log message. Less can only display a
single file at a time. Also, none of these basic tools handle
compressed files.
Installation
]8;;https://github.com/tstack/lnav/releases/latest#release-artifacts\Download a statically-linked binary for Linux/MacOS from the release]8;;\
@ -15,12 +25,16 @@ with highlights. Errors are red and warnings are yellow.
▌[1] - https://github.com/tstack/lnav/releases/latest#release-artifacts
Brew on MacOS
$ brew install lnav 
Usage
Simply point lnav at the files or directories you want to monitor, it
will figure out the rest:
$ lnav /path/to/file 
$ lnav /path/to/file1 /path/to/dir ... 
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
@ -28,6 +42,11 @@ 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).
See the ]8;;https://docs.lnav.org/en/latest/usage.html\Usage section]8;;\[1] of the online documentation for more
information.
▌[1] - https://docs.lnav.org/en/latest/usage.html
[1] - Files that do not contain log messages can be seen in the TEXT
view (reachable by pressing  t ).

Loading…
Cancel
Save