summaryrefslogtreecommitdiffstats
path: root/doc/man/nvme_scan_topology.2
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/nvme_scan_topology.2')
-rw-r--r--doc/man/nvme_scan_topology.220
1 files changed, 20 insertions, 0 deletions
diff --git a/doc/man/nvme_scan_topology.2 b/doc/man/nvme_scan_topology.2
new file mode 100644
index 0000000..602d8ae
--- /dev/null
+++ b/doc/man/nvme_scan_topology.2
@@ -0,0 +1,20 @@
+.TH "nvme_scan_topology" 9 "nvme_scan_topology" "April 2022" "libnvme API manual" LINUX
+.SH NAME
+nvme_scan_topology \- Scan NVMe topology and apply filter
+.SH SYNOPSIS
+.B "int" nvme_scan_topology
+.BI "(nvme_root_t r " ","
+.BI "nvme_scan_filter_t f " ","
+.BI "void *f_args " ");"
+.SH ARGUMENTS
+.IP "r" 12
+nvme_root_t object
+.IP "f" 12
+filter to apply
+.IP "f_args" 12
+user-specified argument to \fIf\fP
+.SH "DESCRIPTION"
+Scans the NVMe topology and filters out the resulting elements
+by applying \fIf\fP.
+.SH "RETURN"
+Number of elements scanned