[docs] update the on-line docs

pull/97/head
Timothy Stack 10 years ago
parent 530a0a94b5
commit ed296d46d7

@ -4,3 +4,61 @@
Command Reference Command Reference
================= =================
This reference covers the commands used to control **lnav**. Consult the
`built-in help <https://github.com/tstack/lnav/blob/master/src/help.txt>`_ in
**lnav** for a more detailed explanation of each command.
Note that almost all commands support TAB-completion for their arguments, so
if you are in doubt as to what to type for an argument, you can double tap the
TAB key to get suggestions.
Filtering
---------
The set of log messages that are displayed in the log view can be controlled
with the following commands:
* filter-in <regex> - Only display log lines that match a regex.
* filter-out <regex> - Do not display log lines that match a regex.
* disable-filter <regex> - Disable the given filter.
* enable-filter <regex> - Enable the given filter.
* set-min-log-level <level> - Only display log lines with the given log level
or higher.
Navigation
----------
* goto <line#|N%|time> - Go to the given line number, N percent into the
file, or the given timestamp in the log view.
Time
----
* adjust-log-time <date> - Change the timestamps for a log file.
* unix-time <secs-or-date> - Convert a unix-timestamp in seconds to a
human-readable form or vice-versa.
* current-time - Print the current time in human-readable form and as
a unix-timestamp.
Display
-------
* help - Display the built-in help text.
* disable-word-wrap - Disable word wrapping in the log and text file views.
* enable-word-wrap - Enable word wrapping in the log and text file views.
* highlight <regex> - Colorize text that matches the given regex.
* switch-to-view <name> - Switch to the given view name (e.g. log, text, ...)
Output
------
* append-to <file> - Append any bookmarked lines in the current view to the
given file.
* write-to <file> - Overwrite the given file with any bookmarked lines in
the current view.
* write-csv-to <file> - Write SQL query results to the given file in CSV format.
* write-json-to <file> - Write SQL query results to the given file in JSON
format.

@ -36,7 +36,9 @@ Hotkey Reference
} }
</style> </style>
This reference covers the keys used to control **lnav**. This reference covers the keys used to control **lnav**. Consult the `built-in
help <https://github.com/tstack/lnav/blob/master/src/help.txt>`_ in **lnav** for
a more detailed explanation of each key.
Spatial Navigation Spatial Navigation
------------------ ------------------
@ -74,11 +76,11 @@ Spatial Navigation
- -
- Right half a page - Right half a page
* - |ks| Home |ke| * - |ks| Home |ke|
- - |ks| g |ke|
- -
- Top of the view - Top of the view
* - |ks| End |ke| * - |ks| End |ke|
- - |ks| G |ke|
- -
- Bottom of the view - Bottom of the view
* - |ks| e |ke| * - |ks| e |ke|
@ -109,6 +111,10 @@ Spatial Navigation
- |ks| Shift |ke| + |ks| y |ke| - |ks| Shift |ke| + |ks| y |ke|
- -
- Next/prevous SQL result - Next/prevous SQL result
* - |ks| s |ke|
- |ks| Shift |ke| + |ks| s |ke|
-
- Next/prevous slow down in the log message rate
Chronological Navigation Chronological Navigation
------------------------ ------------------------
@ -174,7 +180,7 @@ Display
- Switch to/from the text file view - Switch to/from the text file view
* - |ks| i |ke| * - |ks| i |ke|
- Switch to/from the histogram view - Switch to/from the histogram view
* - |ks| Shift |ke| + |ks| i |ke|- * - |ks| Shift |ke| + |ks| i |ke|
- Switch to/from the histogram view - Switch to/from the histogram view
* - |ks| v |ke| * - |ks| v |ke|
- Switch to/from the SQL result view - Switch to/from the SQL result view
@ -200,4 +206,6 @@ Query
* - |ks| ; |ke| * - |ks| ; |ke|
- Execute an SQL query - Execute an SQL query
* - |ks| : |ke| * - |ks| : |ke|
- Execute an internal command - Execute an internal command, see :ref:`commands` for more information
* - |ks| Ctrl |ke| + |ks| ] |ke|
- Abort a

Binary file not shown.

Before

Width:  |  Height:  |  Size: 255 KiB

After

Width:  |  Height:  |  Size: 327 KiB

@ -18,13 +18,20 @@ On color displays, the log messages will be highlighted as follows:
* Errors will be colored in red; * Errors will be colored in red;
* warnings will be yellow; * warnings will be yellow;
* search hits are reverse video;
* various color highlights will be applied to: IP addresses, SQL keywords, * various color highlights will be applied to: IP addresses, SQL keywords,
XML tags, file and line numbers in Java backtraces, and quoted strings; XML tags, file and line numbers in Java backtraces, and quoted strings;
* "identifiers" in the messages will be randomly assigned colors based on their * "identifiers" in the messages will be randomly assigned colors based on their
content (works best on "xterm-256color" terminals). content (works best on "xterm-256color" terminals).
The right side of the display has a proportionally sized 'scrollbar' that The right side of the display has a proportionally sized 'scrollbar' that
indicates your current position in the file. shows:
* your current position in the file;
* the locations of errors/warnings in the log files by using a red or yellow
coloring;
* the locations of search hits by using a tick-mark pointing to the left;
* the locations of bookmarks by using a tick-mark pointing to the right.
Above and below the main body are status lines that display: Above and below the main body are status lines that display:
@ -34,7 +41,7 @@ Above and below the main body are status lines that display:
* the current view; * the current view;
* the line number for the top line in the display; * the line number for the top line in the display;
* the current search hit and the total number of hits; * the current search hit and the total number of hits;
* the number of lines not displayed because of filtering. * the number of lines that are **not** displayed because of filtering.
Finally, the last line on the display is where you can enter search Finally, the last line on the display is where you can enter search
patterns and execute internal commands, such as converting a patterns and execute internal commands, such as converting a

Loading…
Cancel
Save