[docs] some doc updates

pull/835/head
Timothy Stack 3 years ago
parent 099b32b393
commit b5af750256

@ -27,6 +27,7 @@ The following software packages are required to build lnav:
re2c - The re2c scanner generator.
libcurl - The cURL library for downloading files from URLs. Version
7.23.0 or higher is required.
libarchive - The libarchive library for opening archive files, like zip/tgz.
INSTALLATION

@ -35,14 +35,15 @@ no setup.
The following software packages are required to build lnav:
* gcc/clang - A C++14-compatible compiler.
* libpcre - The Perl Compatible Regular Expression (PCRE) library.
* sqlite - The SQLite database engine. Version 3.9.0 or higher is required.
* ncurses - The ncurses text UI library.
* readline - The readline line editing library.
* zlib - The zlib compression library.
* bz2 - The bzip2 compression library.
* libcurl - The cURL library for downloading files from URLs. Version 7.23.0 or higher is required.
* gcc/clang - A C++14-compatible compiler.
* libpcre - The Perl Compatible Regular Expression (PCRE) library.
* sqlite - The SQLite database engine. Version 3.9.0 or higher is required.
* ncurses - The ncurses text UI library.
* readline - The readline line editing library.
* zlib - The zlib compression library.
* bz2 - The bzip2 compression library.
* libcurl - The cURL library for downloading files from URLs. Version 7.23.0 or higher is required.
* libarchive - The libarchive library for opening archive files, like zip/tgz.
## Installation

@ -196,3 +196,13 @@ Reference
^^^^^^^^^
.. jsonschema:: ../../src/internals/config-v1.schema.json#/properties/ui/properties/keymap-defs/patternProperties/([\w\-]+)
Tuning
------
The following configuration options can be used to tune the internals of
**lnav** to your liking. The options can be changed using the :code:`:config`
command.
.. jsonschema:: ../../src/internals/config-v1.schema.json#/properties/tuning

@ -189,7 +189,9 @@ Display
* - |ks| p |ke|
- Toggle the display of the log parser results
* - |ks| Tab |ke|
- Cycle through colums to graph in the SQL result view
- In the log/text views, focus on the configuration panel for editing
filters and examining the list of loaded files. In the SQL result view,
cycle through columns to display as bar graphs
* - |ks| Ctrl |ke| + |ks| l |ke|
- Switch to lo-fi mode. The displayed log lines will be dumped to the
terminal without any decorations so they can be copied easily.

@ -9,6 +9,7 @@ The information currently stored is:
* Position within the files being viewed.
* Active searches for each view.
* Any active log filters or highlights.
* Hidden files.
Bookmarks and log-time adjustments are stored separately on a per-file basis.
Note that the bookmarks are associated with files based on the content of the

@ -31,15 +31,38 @@ log file, you can enter the :ref:`SQL prompt<sql-ext>` by pressing |ks| ; |ke|.
Viewing Files
-------------
The files to view in **lnav** can be given on the command-line or passed to
the :ref:`:open<open>` command. If the path is a directory, all of the files
in the directory will be opened and the directory will be monitored for files
to be added or removed from the view. A
`glob pattern <https://en.wikipedia.org/wiki/Glob_(programming)>`_ can be
given to watch for files with a common name. The files that are found will be
scanned to identify their file format. Files that match a log format will be
collated by time and displayed in the LOG view. Plain text files can be viewed
in the TEXT view, which can be accessed by pressing |ks| t |ke|.
The files to view in **lnav** can be given on the command-line or passed to the
:ref:`:open<open>` command. A
`glob pattern <https://en.wikipedia.org/wiki/Glob_(programming)>`_ can be given
to watch for files with a common name. If the path is a directory, all of the
files in the directory will be opened and the directory will be monitored for
files to be added or removed from the view. If the path is an archive or
compressed file (and lnav was built with libarchive), the archive will be
extracted to a temporary location and the files within will be loaded. The
files that are found will be scanned to identify their file format. Files
that match a log format will be collated by time and displayed in the LOG
view. Plain text files can be viewed in the TEXT view, which can be accessed
by pressing |ks| t |ke|.
Archive Support
^^^^^^^^^^^^^^^
If **lnav** is compiled with "libarchive", any files to be opened will be
examined to see if they are a supported archive type. If so, the contents
of the archive will be extracted to the :code:`$TMPDIR/lnav-${UID}-archives/`
directory. Once extracted, the files within will be loaded into lnav. To
speed up opening large amounts of files, any file that meets the following
conditions will be automatically hidden and not indexed:
* Binary files
* Plain text files that are larger than 128KB
* Duplicate log files
The unpacked files will be left in the temporary directory after exiting
**lnav** so that opening the same archive again will be faster. Unpacked
archives that have not been accessed in the past two days will be automatically
deleted the next time **lnav** is started.
Searching
@ -78,6 +101,15 @@ or by doing an :code:`INSERT` into the
:ref:`lnav_view_filters<table_lnav_view_filters>` table.
SQLite Expression
^^^^^^^^^^^^^^^^^
Complex filtering can be done by passing a SQLite expression to the
:ref:`:filter-expr<filter_expr>` command. The expression will be executed for
every log message and if it returns true, the line will be shown in the log
view.
Time
^^^^
@ -93,7 +125,6 @@ Log level
To hide messages below a certain log level, you can use the
:ref:`:set-min-log-level<set_min_log_level>`.
Search Tables
-------------

Loading…
Cancel
Save