Robot
/
lnav
mirror of https://github.com/tstack/lnav.git
2
0
Fork 0
Code Issues Releases Wiki Activity

[docs] add refs to the vscode extension

This commit is contained in:
Tim Stack 2022-09-25 13:52:03 -07:00
parent 5b34b3a604
commit 45b812d063
2 changed files with 16 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/02_downloads.md
View File

@ -49,3 +49,10 @@ $ make install
If you would like to contribute to the development of lnav, visit our page on
[GitHub](https://github.com/tstack/lnav).
# VSCode Extension
The [lnav VSCode Extension](https://marketplace.visualstudio.com/items?itemName=lnav.lnav)
can be used to add syntax highlighting to lnav scripts.
![Screenshot of an lnav script](/assets/images/lnav-vscode-extension.png)

12
docs/source/formats.rst
View File

@ -389,15 +389,15 @@ with the following contents:
Scripts
-------
Format directories may also contain '.sql' and '.lnav' files to help automate
Format directories may also contain :file:`.sql` and :file:`.lnav` files to help automate
log file analysis. The SQL files are executed on startup to create any helper
tables or views and the '.lnav' script files can be executed using the pipe
hotkey (|). For example, **lnav** includes a "partition-by-boot" script that
hotkey :kbd:`|`. For example, **lnav** includes a "partition-by-boot" script that
partitions the log view based on boot messages from the Linux kernel. A script
can have a mix of SQL and **lnav** commands, as well as include other scripts.
The type of statement to execute is determined by the leading character on a
line: a semi-colon begins a SQL statement; a colon starts an **lnav** command;
and a pipe (|) denotes another script to be executed. Lines beginning with a
and a pipe :code:`|` denotes another script to be executed. Lines beginning with a
hash are treated as comments. The following variables are defined in a script:
.. envvar:: #
@ -442,6 +442,12 @@ header:
:eval :filter-out ${pattern}
VSCode Extension
^^^^^^^^^^^^^^^^
The `lnav VSCode Extension <https://marketplace.visualstudio.com/items?itemName=lnav.lnav>`_
can be installed to add syntax highlighting to lnav scripts.
Installing Formats
------------------