Skip to content

Improvements to VQL reference documentation and minor fixes #949

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
scudette merged 6 commits into from
Nov 26, 2024
Merged

Improvements to VQL reference documentation and minor fixes #949

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
78cd3d5
Improvements to VQL reference documentation and minor fixes
predictiple Nov 25, 2024
71bdc77
Improvements to VQL reference documentation and minor fixes
predictiple Nov 25, 2024
8d1b164
Improvements to VQL reference documentation and minor fixes
predictiple Nov 25, 2024
7fbd5f5
Improvements to VQL reference documentation and minor fixes
predictiple Nov 25, 2024
497e3d6
Merge branch 'master' into vql-ref-update1
predictiple Nov 25, 2024
f736e59
Minor fixes and style improvements
predictiple Nov 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
16 changes: 14 additions & 2 deletions .wordlist.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1551,7 +1551,6 @@ vhdx
vmdk
--------------------------------------------------------------------------------

Misspelled words:
<url-free> content/blog/2024/2024-09-10-release-notes-0.73/_index.md
--------------------------------------------------------------------------------
Paginator
Expand All @@ -1562,7 +1561,6 @@ timesketch
vmdk
--------------------------------------------------------------------------------

Misspelled words:
<url-free> content/blog/2024/2024-09-12-timelines/_index.md
--------------------------------------------------------------------------------
Timelining
Expand All @@ -1578,3 +1576,17 @@ CRUU
KIE
ds
AES

<url-free> content/vql_reference/misc/ebpf_events/_index.md
--------------------------------------------------------------------------------
ebpf

<url-free> content/vql_reference/misc/watch_ebpf/_index.md
--------------------------------------------------------------------------------
eBPF
tracee

<url-free> content/vql_reference/basic/now/_index.md
--------------------------------------------------------------------------------
datetime

2 changes: 1 addition & 1 deletion content/vql_reference/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,6 @@ pre: <i class="fas fa-book"></i>
head: <hr>
---

Search for documentation on VQL plugins or functions.
Search for documentation on VQL plugins, functions and accessors.

{{% reference %}}
2 changes: 1 addition & 1 deletion content/vql_reference/accessors/auto/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ no_edit: true


## auto
<span class='vql_type pull-right page-header'>Accessor</span>
<span class='vql_type label label-warning pull-right page-header'>Accessor</span>


### Description
Expand Down
2 changes: 1 addition & 1 deletion content/vql_reference/accessors/bzip2/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ no_edit: true


## bzip2
<span class='vql_type pull-right page-header'>Accessor</span>
<span class='vql_type label label-warning pull-right page-header'>Accessor</span>


### Description
Expand Down
2 changes: 1 addition & 1 deletion content/vql_reference/accessors/collector/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ no_edit: true


## collector
<span class='vql_type pull-right page-header'>Accessor</span>
<span class='vql_type label label-warning pull-right page-header'>Accessor</span>


### Description
Expand Down
2 changes: 1 addition & 1 deletion content/vql_reference/accessors/collector_sparse/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ no_edit: true


## collector_sparse
<span class='vql_type pull-right page-header'>Accessor</span>
<span class='vql_type label label-warning pull-right page-header'>Accessor</span>


### Description
Expand Down
2 changes: 1 addition & 1 deletion content/vql_reference/accessors/data/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ no_edit: true


## data
<span class='vql_type pull-right page-header'>Accessor</span>
<span class='vql_type label label-warning pull-right page-header'>Accessor</span>


### Description
Expand Down
2 changes: 1 addition & 1 deletion content/vql_reference/accessors/ewf/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ no_edit: true


## ewf
<span class='vql_type pull-right page-header'>Accessor</span>
<span class='vql_type label label-warning pull-right page-header'>Accessor</span>


### Description
Expand Down
2 changes: 1 addition & 1 deletion content/vql_reference/accessors/ext4/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ no_edit: true


## ext4
<span class='vql_type pull-right page-header'>Accessor</span>
<span class='vql_type label label-warning pull-right page-header'>Accessor</span>


### Description
Expand Down
2 changes: 1 addition & 1 deletion content/vql_reference/accessors/fat/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ no_edit: true


## fat
<span class='vql_type pull-right page-header'>Accessor</span>
<span class='vql_type label label-warning pull-right page-header'>Accessor</span>


### Description
Expand Down
2 changes: 1 addition & 1 deletion content/vql_reference/accessors/file/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ no_edit: true


## file
<span class='vql_type pull-right page-header'>Accessor</span>
<span class='vql_type label label-warning pull-right page-header'>Accessor</span>


### Description
Expand Down
2 changes: 1 addition & 1 deletion content/vql_reference/accessors/file_links/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ no_edit: true


## file_links
<span class='vql_type pull-right page-header'>Accessor</span>
<span class='vql_type label label-warning pull-right page-header'>Accessor</span>


### Description
Expand Down
2 changes: 1 addition & 1 deletion content/vql_reference/accessors/file_nocase/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ no_edit: true


## file_nocase
<span class='vql_type pull-right page-header'>Accessor</span>
<span class='vql_type label label-warning pull-right page-header'>Accessor</span>


### Description
Expand Down
2 changes: 1 addition & 1 deletion content/vql_reference/accessors/fs/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ no_edit: true


## fs
<span class='vql_type pull-right page-header'>Accessor</span>
<span class='vql_type label label-warning pull-right page-header'>Accessor</span>


### Description
Expand Down
2 changes: 1 addition & 1 deletion content/vql_reference/accessors/fs_sparse/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ no_edit: true


## fs_sparse
<span class='vql_type pull-right page-header'>Accessor</span>
<span class='vql_type label label-warning pull-right page-header'>Accessor</span>


### Description
Expand Down
2 changes: 1 addition & 1 deletion content/vql_reference/accessors/gzip/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ no_edit: true


## gzip
<span class='vql_type pull-right page-header'>Accessor</span>
<span class='vql_type label label-warning pull-right page-header'>Accessor</span>


### Description
Expand Down
2 changes: 1 addition & 1 deletion content/vql_reference/accessors/lazy_ntfs/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ no_edit: true


## lazy_ntfs
<span class='vql_type pull-right page-header'>Accessor</span>
<span class='vql_type label label-warning pull-right page-header'>Accessor</span>


### Description
Expand Down
2 changes: 1 addition & 1 deletion content/vql_reference/accessors/me/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ no_edit: true


## me
<span class='vql_type pull-right page-header'>Accessor</span>
<span class='vql_type label label-warning pull-right page-header'>Accessor</span>


### Description
Expand Down
2 changes: 1 addition & 1 deletion content/vql_reference/accessors/mft/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ no_edit: true


## mft
<span class='vql_type pull-right page-header'>Accessor</span>
<span class='vql_type label label-warning pull-right page-header'>Accessor</span>


### Description
Expand Down
2 changes: 1 addition & 1 deletion content/vql_reference/accessors/mscfb/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ no_edit: true


## mscfb
<span class='vql_type pull-right page-header'>Accessor</span>
<span class='vql_type label label-warning pull-right page-header'>Accessor</span>


### Description
Expand Down
2 changes: 1 addition & 1 deletion content/vql_reference/accessors/ntfs/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ no_edit: true


## ntfs
<span class='vql_type pull-right page-header'>Accessor</span>
<span class='vql_type label label-warning pull-right page-header'>Accessor</span>


### Description
Expand Down
2 changes: 1 addition & 1 deletion content/vql_reference/accessors/ntfs_vss/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ no_edit: true


## ntfs_vss
<span class='vql_type pull-right page-header'>Accessor</span>
<span class='vql_type label label-warning pull-right page-header'>Accessor</span>


### Description
Expand Down
2 changes: 1 addition & 1 deletion content/vql_reference/accessors/offset/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ no_edit: true


## offset
<span class='vql_type pull-right page-header'>Accessor</span>
<span class='vql_type label label-warning pull-right page-header'>Accessor</span>


### Description
Expand Down
2 changes: 1 addition & 1 deletion content/vql_reference/accessors/pipe/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ no_edit: true


## pipe
<span class='vql_type pull-right page-header'>Accessor</span>
<span class='vql_type label label-warning pull-right page-header'>Accessor</span>


### Description
Expand Down
2 changes: 1 addition & 1 deletion content/vql_reference/accessors/process/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ no_edit: true


## process
<span class='vql_type pull-right page-header'>Accessor</span>
<span class='vql_type label label-warning pull-right page-header'>Accessor</span>


### Description
Expand Down
2 changes: 1 addition & 1 deletion content/vql_reference/accessors/ranged/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ no_edit: true


## ranged
<span class='vql_type pull-right page-header'>Accessor</span>
<span class='vql_type label label-warning pull-right page-header'>Accessor</span>


### Description
Expand Down
2 changes: 1 addition & 1 deletion content/vql_reference/accessors/raw_ext4/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ no_edit: true


## raw_ext4
<span class='vql_type pull-right page-header'>Accessor</span>
<span class='vql_type label label-warning pull-right page-header'>Accessor</span>


### Description
Expand Down
2 changes: 1 addition & 1 deletion content/vql_reference/accessors/raw_file/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ no_edit: true


## raw_file
<span class='vql_type pull-right page-header'>Accessor</span>
<span class='vql_type label label-warning pull-right page-header'>Accessor</span>


### Description
Expand Down
2 changes: 1 addition & 1 deletion content/vql_reference/accessors/raw_ntfs/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ no_edit: true


## raw_ntfs
<span class='vql_type pull-right page-header'>Accessor</span>
<span class='vql_type label label-warning pull-right page-header'>Accessor</span>


### Description
Expand Down
2 changes: 1 addition & 1 deletion content/vql_reference/accessors/raw_reg/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ no_edit: true


## raw_reg
<span class='vql_type pull-right page-header'>Accessor</span>
<span class='vql_type label label-warning pull-right page-header'>Accessor</span>


### Description
Expand Down
2 changes: 1 addition & 1 deletion content/vql_reference/accessors/reg/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ no_edit: true


## reg
<span class='vql_type pull-right page-header'>Accessor</span>
<span class='vql_type label label-warning pull-right page-header'>Accessor</span>


### Description
Expand Down
2 changes: 1 addition & 1 deletion content/vql_reference/accessors/registry/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ no_edit: true


## registry
<span class='vql_type pull-right page-header'>Accessor</span>
<span class='vql_type label label-warning pull-right page-header'>Accessor</span>


### Description
Expand Down
2 changes: 1 addition & 1 deletion content/vql_reference/accessors/s3/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ no_edit: true


## s3
<span class='vql_type pull-right page-header'>Accessor</span>
<span class='vql_type label label-warning pull-right page-header'>Accessor</span>


### Description
Expand Down
2 changes: 1 addition & 1 deletion content/vql_reference/accessors/scope/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ no_edit: true


## scope
<span class='vql_type pull-right page-header'>Accessor</span>
<span class='vql_type label label-warning pull-right page-header'>Accessor</span>


### Description
Expand Down
2 changes: 1 addition & 1 deletion content/vql_reference/accessors/smb/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ no_edit: true


## smb
<span class='vql_type pull-right page-header'>Accessor</span>
<span class='vql_type label label-warning pull-right page-header'>Accessor</span>


### Description
Expand Down
2 changes: 1 addition & 1 deletion content/vql_reference/accessors/sparse/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ no_edit: true


## sparse
<span class='vql_type pull-right page-header'>Accessor</span>
<span class='vql_type label label-warning pull-right page-header'>Accessor</span>


### Description
Expand Down
2 changes: 1 addition & 1 deletion content/vql_reference/accessors/ssh/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ no_edit: true


## ssh
<span class='vql_type pull-right page-header'>Accessor</span>
<span class='vql_type label label-warning pull-right page-header'>Accessor</span>


### Description
Expand Down
2 changes: 1 addition & 1 deletion content/vql_reference/accessors/vfs/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ no_edit: true


## vfs
<span class='vql_type pull-right page-header'>Accessor</span>
<span class='vql_type label label-warning pull-right page-header'>Accessor</span>


### Description
Expand Down
2 changes: 1 addition & 1 deletion content/vql_reference/accessors/vhdx/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ no_edit: true


## vhdx
<span class='vql_type pull-right page-header'>Accessor</span>
<span class='vql_type label label-warning pull-right page-header'>Accessor</span>


### Description
Expand Down
2 changes: 1 addition & 1 deletion content/vql_reference/accessors/vmdk/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ no_edit: true


## vmdk
<span class='vql_type pull-right page-header'>Accessor</span>
<span class='vql_type label label-warning pull-right page-header'>Accessor</span>


### Description
Expand Down
2 changes: 1 addition & 1 deletion content/vql_reference/accessors/winpmem/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ no_edit: true


## winpmem
<span class='vql_type pull-right page-header'>Accessor</span>
<span class='vql_type label label-warning pull-right page-header'>Accessor</span>


### Description
Expand Down
Loading