.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.48.5.
.TH HW-PROBE "1" "August 2021" "Hardware Probe 1.6" "User Commands"
.SH NAME
hw-probe \- Hardware probe and system info collection tool
.SH DESCRIPTION
.SS "NAME:"
.IP
Hardware Probe (hw\-probe)
A tool to probe for hardware, check operability and find drivers
.SS "DESCRIPTION:"
.IP
Hardware Probe (hw\-probe) is a tool to probe for hardware,
check its operability and upload result to the BSD hardware database.
.IP
By creating probes you contribute to the "HDD/SSD Desktop\-Class Reliability
Test" study: https://github.com/linuxhw/SMART
.SS "USAGE:"
.IP
hw\-probe [options]
.SS "EXAMPLE:"
.IP
hw\-probe \fB\-all\fR \fB\-upload\fR
.SS "PRIVACY:"
.IP
Private information (including the username, machine's hostname, IP addresses,
MAC addresses and serial numbers) is NOT uploaded to the database.
.IP
The tool uploads 32\-byte prefix of salted SHA512 hash of MAC addresses and serial
numbers to properly identify unique computers and hard drives. All the data is
uploaded securely via HTTPS.
.SS "INFORMATION OPTIONS:"
.HP
\fB\-h\fR|\-help
.IP
Print this help.
.HP
\fB\-v\fR|\-version
.IP
Print version info.
.HP
\fB\-dumpversion\fR
.IP
Print the tool version (1.6) and don't do anything else.
.SS "GENERAL OPTIONS:"
.HP
\fB\-all\fR
.IP
Enable all probes.
.HP
\fB\-probe\fR
.IP
Probe for hardware. Collect only
hardware related logs.
.HP
\fB\-logs\fR
.IP
Collect system logs.
.HP
\fB\-log\-level\fR N
.IP
Set the logging level to N.
Available values:
.IP
\- minimal
\- default
\- maximal
.HP
\fB\-minimal\fR|\-min
.IP
Collect minimal number of logs. Equal to \fB\-\-log\-level\fR=\fI\,min\/\fR.
.HP
\fB\-maximal\fR|\-max
.IP
Collect maximal number of logs. Equal to \fB\-\-log\-level\fR=\fI\,max\/\fR.
.HP
\fB\-enable\fR LIST
.IP
Comma separated list of logs to enable in addition to
current log level.
.HP
\fB\-disable\fR LIST
.IP
Comma separated list of logs to disable in current
log level. Some logs cannot be disabled. For example,
you can disable collecting of 'fstab', but you cannot
disable logging of 'smartctl'.
.HP
\fB\-printers\fR
.IP
Probe for printers.
.HP
\fB\-scanners\fR
.IP
Probe for scanners.
.HP
\fB\-check\fR
.IP
Check devices operability.
.HP
\fB\-id\fR|\-name DESC
.IP
Any description of the probe.
.HP
\fB\-upload\fR
.IP
Upload result to the hardware database. You will get
a permanent URL to view the probe.
.IP
By use of this option you confirm uploading of 32\-byte
prefix of salted SHA512 hash of MAC addresses and serial
numbers to prevent duplication of computers in the DB.
.HP
\fB\-hwinfo\-path\fR PATH
.IP
Path to a local hwinfo binary.
.SS "INVENTORY OPTIONS:"
.HP
\fB\-i\fR|\-inventory\-id ID
.IP
Mark the probe by inventory ID.
.HP
\fB\-generate\-inventory\-id\fR
.IP
Generate new inventory ID.
.HP
\fB\-email\fR ADDR
.IP
Email for node status notifications.
.SS "MONITORING OPTIONS (COMING SOON!):"
.HP
\fB\-start\fR
.IP
Start monitoring of the node.
.HP
\fB\-stop\fR
.IP
Stop monitoring of the node.
.HP
\fB\-remind\-inventory\fR
.IP
Remind node inventory ID.
.SS "OTHER OPTIONS:"
.HP
\fB\-save\fR DIR
.IP
Save probe package to DIR. This is useful if you are offline
and need to upload a probe later (with the help of \fB\-src\fR option).
.HP
\fB\-src\fR|\-source PATH
.IP
A probe to upload.
.HP
\fB\-fix\fR PATH
.IP
Update list of devices and host info
in the probe using probe data.
.HP
\fB\-show\-devices\fR
.IP
Show devices list.
.HP
\fB\-show\fR
.IP
Show host info and devices list.
.HP
\fB\-show\-host\fR
.IP
Show host info only.
.HP
\fB\-verbose\fR
.IP
Use with \fB\-show\fR option to show type and status of the device.
.TP
\fB\-pci\-ids\fR
PATH
.TP
\fB\-usb\-ids\fR
PATH
.HP
\fB\-sdio\-ids\fR PATH
.TP
\fB\-pnp\-ids\fR
PATH
.IP
Path to {pci,usb,sdio,pnp}.ids file to read missed device names.
.HP
\fB\-list\fR
.IP
List executed probes (for debugging).
.HP
\fB\-clean\fR
.IP
Do nothing. Obsolete option.
.HP
\fB\-save\-uploaded\fR
.IP
Save uploaded probes.
.HP
\fB\-debug\fR|\-d
.IP
Do nothing. Obsolete option.
.HP
\fB\-dump\-acpi\fR
.IP
Probe for ACPI table.
.HP
\fB\-decode\-acpi\fR
.IP
Decode ACPI table.
.HP
\fB\-import\fR DIR
.IP
Import probes from the database to DIR for offline use.
.IP
If you are using Snap or Flatpak package, then DIR will be created
in the sandbox data directory.
.IP
Provide inventory ID by \fB\-i\fR option in order to import your inventory.
.SS "DATA LOCATION:"
.IP
Probes info is saved in the \fI\,/root/HW_PROBE\/\fP directory.
.PP
A tool to probe for hardware, check operability and find drivers
License: LGPL\-2.1\-or\-later OR BSD\-4\-Clause
.PP
Usage: hw\-probe [options]
Example: hw\-probe \fB\-all\fR \fB\-upload\fR
.SH AUTHOR
This manual page was written by Mathieu Malaterre <malat@debian.org> for the
Debian GNU/Linux system (but may be used by others).