Skip to content

Commit

Permalink
update the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
HikariKnight committed Mar 16, 2023
1 parent 6b00926 commit 0164ea6
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,16 @@ More extended functionality is planned.
![screenshot](https://user-images.githubusercontent.com/2557889/223729837-66461127-997c-4ce4-9183-9d2b85219a07.png)

## Features
* Has a flag to generate default ouptut text compatible with the bash version of ls-iommu (--legacy)
* Has a flag to generate default ouptut text compatible with the bash version of ls-iommu (`--legacy`)
* Can locate and display only GPUs, USB Controllers and Network cards
* List devices of individual or multiple IOMMU groups
* Can show you kernel driver info for the devices
* Can attempt to get related devices (devices that share vendorID) or devices located in the same IOMMU group as the device(s), the best method is used for -r depending on what you look for.
* Flag to list only VendorID:DeviceID for all devices found
* Flag to list only PCI Address for all devices found
* A flag you can use to ignore specific VendorIDs when doing a related devices search
* Can show only the info you are interested in on the device line using -F and then providing a comma separated list of objects you want to show on the device line (this does not affect the extra lines provided by `-k`)
* Has a flag to get the vbios path for gpus (`-g --rom` or `-g -i X --rom`)


## Build instructions
Expand All @@ -30,7 +32,7 @@ Prerequisites:
```bash
git clone https://github.com/HikariKnight/ls-iommu.git
cd ls-iommu
go build
CGO_ENABLED=0 go build
```

The binary `ls-iommu` will now be located the root of the project directory.

0 comments on commit 0164ea6

Please sign in to comment.