Archives/lnav
2
0
Fork 0
mirror of https://github.com/tstack/lnav synced 2024-11-01 21:40:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #365 from aspiers/group-keybindings

Browse Source 
Group keybindings in built-in help text
This commit is contained in:
Tim Stack 2016-11-19 11:00:17 -08:00 committed by GitHub
commit ae5f4b5dd5
1 changed files with 99 additions and 81 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

180
src/help.txt
View File

@ -2,7 +2,7 @@
lnav - A fancy log file viewer
DESCRIPTION
-----------
===========
The log file navigator, lnav, is an enhanced log file viewer that
takes advantage of any semantic information that can be gleaned from
@ -15,7 +15,7 @@ efficiently zero in on problems.
OPENING PATHS/URLs
------------------
==================
The main arguments to lnav are the files, directories, glob patterns,
or URLs to be viewed. If no arguments are given, the default syslog
@ -29,7 +29,7 @@ host, the SSH agent can be used to do authentication.
OPTIONS
-------
=======
Lnav takes a list of files to view and/or you can use the flag
arguments to load well-known log files, such as the syslog or apache
@ -96,7 +96,7 @@ of IP addresses that dhclient has bound to in CSV format:
DISPLAY
-------
=======
The main part of the display shows the log lines from the files interleaved
based on time-of-day. New lines are automatically loaded as they are appended
@ -160,11 +160,10 @@ that you can always use 'q' to pop the top view off of the stack.
KEY BINDINGS
------------
============
To help navigate through the file there are many hotkeys that should
make it easy to zero-in on a specific section of the file or scan
through the file.
Views
-----
? View/leave this help message.
q Leave the current view or quit the program when in
@ -178,6 +177,11 @@ through the file.
The 'A' hotkey will try to match the top times between the
two views.
X Close the current text file or log file.
Spatial Navigation
------------------
g/home Move to the top of the file.
G/end Move to the end of the file. If the view is already
at the end, it will move to the last line.
@ -199,22 +203,28 @@ through the file.
>/< Move horizontally to the next/previous search hit.
P Switch to/from the pretty-printed view of the log or text
files currently displayed. In this view, structured data,
such as XML, will be reformatted to make it easier to read.
t Switch to/from the text file view. The text file view is
for any files that are not recognized as log files.
Ctrl-L (Lo-fi mode) Exit screen-mode and write the
displayed log lines in plain text to the terminal
until a key is pressed. Useful for copying long lines
from the terminal without picking up any of the extra
decorations.
o/O Move forward/backward to the log message with a matching
'operation ID' (opid) field.
u/U Move forward/backward through any user bookmarks
you have added using the 'm' key. This hotkey will
also jump to the start of any log partitions that have
been created with the 'partition-name' command.
y/Y Move forward/backward through the log view based on the
"log_line" column in the SQL result view.
s/S Move to the next/previous "slow down" in the log message
rate. A slow down is detected by measuring how quickly
the message rate has changed over the previous several
messages. For example, if one message is logged every
second for five seconds and then the last message arrives
five seconds later, the last message will be highlighted
as a slow down.
Chronological Navigation
------------------------
d/D Move forward/backward 24 hours from the current
position in the log file.
@ -233,6 +243,9 @@ through the file.
forward a minute again. Pressing 'R' will then move the
view in the opposite direction, so backwards a minute.
Bookmarks
---------
m Mark/unmark the line at the top of the display.
The line will be highlighted with reverse video to
indicate that it is a user bookmark. You can use
@ -253,10 +266,21 @@ through the file.
C Clear all marked lines.
u/U Move forward/backward through any user bookmarks
you have added using the 'm' key. This hotkey will
also jump to the start of any log partitions that have
been created with the 'partition-name' command.
Display options
---------------
P Switch to/from the pretty-printed view of the log or text
files currently displayed. In this view, structured data,
such as XML, will be reformatted to make it easier to read.
t Switch to/from the text file view. The text file view is
for any files that are not recognized as log files.
Ctrl-L (Lo-fi mode) Exit screen-mode and write the
displayed log lines in plain text to the terminal
until a key is pressed. Useful for copying long lines
from the terminal without picking up any of the extra
decorations.
T Toggle the display of the "elapsed time" column that shows
the time elapsed since the beginning of the logs or the
@ -267,14 +291,6 @@ through the file.
means it has sped up. You can use the "s/S" hotkeys to
scan through the slow downs.
s/S Move to the next/previous "slow down" in the log message
rate. A slow down is detected by measuring how quickly
the message rate has changed over the previous several
messages. For example, if one message is logged every
second for five seconds and then the last message arrives
five seconds later, the last message will be highlighted
as a slow down.
i View/leave a histogram of the log messages over
time. The histogram counts the number of
displayed log lines for each bucket of time. The
@ -293,6 +309,45 @@ through the file.
z/Shift Z Zoom in or out one step in the histogram view.
v Switch to/from the SQL result view.
V Switch between the log and SQL result views while
keeping the top line number in the log view in
sync with the log_line column in the SQL view.
For example, doing a query that selects for
"log_idle_msecs" and "log_line", you can move the
top of the SQL view to a line and hit 'V' to switch
to the log view and move to the line number that was
selected in the "log_line" column. If there is no
"log_line" column, lnav will find the first column with
a timestamp and move to corresponding time in the log
view.
TAB/Shift+TAB In the SQL result view, cycle through the columns that
are graphed. Initially, all number values are displayed
in a stacked graph. Pressing TAB will change the display
to only graph the first column. Repeatedly pressing TAB
will cycle through the columns until they are all graphed
again.
p In the log view: enable or disable the display of the
fields that the log message parser knows about or has
discovered. This overlay is temporarily enabled when the
semicolon key (;) is pressed so that it is easier to write
queries.
In the DB view: enable or disable the display of values
in columns containing JSON-encoded values in the top row.
The overlay will display the JSON-Pointer reference and
value for all fields in the JSON data.
CTRL-W Toggle word-wrapping.
F2 Toggle mouse support.
Query
-----
/<regexp> Start a search for the given regular expression.
The search is live, so when there is a pause in
typing, the currently running search will be
@ -346,63 +401,26 @@ through the file.
CTRL+] Abort command-line entry started with '/', ':', ';', or '|'.
y/Y Move forward/backward through the log view based on the
"log_line" column in the SQL result view.
v Switch to/from the SQL result view.
V Switch between the log and SQL result views while
keeping the top line number in the log view in
sync with the log_line column in the SQL view.
For example, doing a query that selects for
"log_idle_msecs" and "log_line", you can move the
top of the SQL view to a line and hit 'V' to switch
to the log view and move to the line number that was
selected in the "log_line" column. If there is no
"log_line" column, lnav will find the first column with
a timestamp and move to corresponding time in the log
view.
TAB/Shift+TAB In the SQL result view, cycle through the columns that
are graphed. Initially, all number values are displayed
in a stacked graph. Pressing TAB will change the display
to only graph the first column. Repeatedly pressing TAB
will cycle through the columns until they are all graphed
again.
p In the log view: enable or disable the display of the
fields that the log message parser knows about or has
discovered. This overlay is temporarily enabled when the
semicolon key (;) is pressed so that it is easier to write
queries.
In the DB view: enable or disable the display of values
in columns containing JSON-encoded values in the top row.
The overlay will display the JSON-Pointer reference and
value for all fields in the JSON data.
X Close the current text file or log file.
Session
-------
CTRL-R Reset the session state. This will save the current
session state (filters, highlights) and then reset the
state to the factory default.
CTRL-W Toggle word-wrapping.
F2 Toggle mouse support.
MOUSE SUPPORT (experimental)
----------------------------
============================
If you are using Xterm, or a compatible terminal, you can use the mouse to
mark lines of text and move the view by grabbing the scrollbar.
NOTE: You need to manually enable this feature by setting the LNAV_EXP
environment variable to "mouse".
environment variable to "mouse". F2 toggles mouse support.
COMMANDS
--------
========
help Switch to this help text view.
@ -633,7 +651,7 @@ COMMANDS
SQL QUERIES (experimental)
-----------
===========
Lnav has support for performing SQL queries on log files using the
Sqlite3 "virtual" table feature. For all supported log file types,
@ -732,7 +750,7 @@ example of a top ten query into the "/tmp/topten.db" file, you can do:
DYNAMIC LOG LINE TABLE (experimental)
----------------------
======================
(NOTE: This feature is still very new and not completely reliable yet,
use with care.)
@ -785,7 +803,7 @@ template.
OTHER SQL FEATURES
------------------
==================
Environment variables can be used in SQL statements by prefixing the
variable name with a dollar-sign ($). For example, to read the value of
@ -826,7 +844,7 @@ commands, which is especially useful when scripting lnav.
PAPERTRAIL INTEGRATION
----------------------
======================
Papertrail is a log management service with free and paid plans at:
@ -858,7 +876,7 @@ is done with a new query, the previous query will be closed first.
CONTACT
-------
=======
For more information, visit the lnav website at: