search

volatilityfoundation / volatility3

Volatility 3.0 development
http://volatilityfoundation.org/
Other
2.72k stars 463 forks source link

Print plugin description on plugin --help #1340

Closed joren485 closed 2 weeks ago

joren485 commented 2 weeks ago

This makes plugins print their description when using --help:

Before

usage: volatility linux.pslist.PsList [-h] [--pid [PID ...]] [--threads] [--decorate-comm] [--dump]

options:
  -h, --help       show this help message and exit
  --pid [PID ...]  Filter on specific process IDs
  --threads        Include user threads
  --decorate-comm  Show `user threads` comm in curly brackets, and `kernel threads` comm in square brackets
  --dump           Extract listed processes

After

Volatility 3 Framework 2.11.0
usage: volatility linux.pslist.PsList [-h] [--pid [PID ...]] [--threads] [--decorate-comm] [--dump]

Lists the processes present in a particular linux memory image.

options:
  -h, --help       show this help message and exit
  --pid [PID ...]  Filter on specific process IDs
  --threads        Include user threads
  --decorate-comm  Show `user threads` comm in curly brackets, and `kernel threads` comm in square brackets
  --dump           Extract listed processes