.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.TH cyme 1  "cyme 1.7.0" 
.SH NAME
cyme \- List system USB buses and devices; a modern cross\-platform `lsusb`
.SH SYNOPSIS
\fBcyme\fR [\fB\-l\fR|\fB\-\-lsusb\fR] [\fB\-t\fR|\fB\-\-tree\fR] [\fB\-d\fR|\fB\-\-vidpid\fR] [\fB\-s\fR|\fB\-\-show\fR] [\fB\-D\fR|\fB\-\-device\fR] [\fB\-\-filter\-name\fR] [\fB\-\-filter\-serial\fR] [\fB\-\-filter\-class\fR] [\fB\-v\fR|\fB\-\-verbose\fR]... [\fB\-b\fR|\fB\-\-blocks\fR] [\fB\-\-bus\-blocks\fR] [\fB\-\-config\-blocks\fR] [\fB\-\-interface\-blocks\fR] [\fB\-\-endpoint\-blocks\fR] [\fB\-m\fR|\fB\-\-more\fR] [\fB\-\-sort\-devices\fR] [\fB\-\-sort\-buses\fR] [\fB\-\-group\-devices\fR] [\fB\-\-hide\-buses\fR] [\fB\-\-hide\-hubs\fR] [\fB\-\-decimal\fR] [\fB\-\-no\-padding\fR] [\fB\-\-color\fR] [\fB\-\-encoding\fR] [\fB\-\-icon\fR] [\fB\-\-headings\fR] [\fB\-\-json\fR] [\fB\-\-from\-json\fR] [\fB\-F\fR|\fB\-\-force\-libusb\fR] [\fB\-c\fR|\fB\-\-config\fR] [\fB\-z\fR|\fB\-\-debug\fR]... [\fB\-\-mask\-serials\fR] [\fB\-h\fR|\fB\-\-help\fR] [\fB\-V\fR|\fB\-\-version\fR] 
.SH DESCRIPTION
List system USB buses and devices; a modern cross\-platform `lsusb`
.SH OPTIONS
.TP
\fB\-l\fR, \fB\-\-lsusb\fR
Attempt to maintain compatibility with lsusb output
.TP
\fB\-t\fR, \fB\-\-tree\fR
Dump USB device hierarchy as a tree
.TP
\fB\-d\fR, \fB\-\-vidpid\fR=\fIVIDPID\fR
Show only devices with the specified vendor and product ID numbers (in hexadecimal) in format VID:[PID]
.TP
\fB\-s\fR, \fB\-\-show\fR=\fISHOW\fR
Show only devices with specified device and/or bus numbers (in decimal) in format [[bus]:][devnum]
.TP
\fB\-D\fR, \fB\-\-device\fR=\fIDEVICE\fR
Selects which device lsusb will examine \- supplied as Linux /dev/bus/usb/BBB/DDD style path
.TP
\fB\-\-filter\-name\fR=\fIFILTER_NAME\fR
Filter on string contained in name
.TP
\fB\-\-filter\-serial\fR=\fIFILTER_SERIAL\fR
Filter on string contained in serial
.TP
\fB\-\-filter\-class\fR=\fIFILTER_CLASS\fR
Filter on USB class code
.br

.br
\fIPossible values:\fR
.RS 14
.IP \(bu 2
use\-interface\-descriptor: Device class is unspecified, interface descriptors are used to determine needed drivers
.IP \(bu 2
audio: Speaker, microphone, sound card, MIDI
.IP \(bu 2
cdc\-communications: The modern serial interface; appears as a UART/RS232 port on most systems
.IP \(bu 2
hid: Human Interface Device; game controllers, keyboards, mice etc. Also commonly used as a device data interface rather then creating something from scratch
.IP \(bu 2
physical: Force feedback joystick
.IP \(bu 2
image: Still imaging device; scanners, cameras
.IP \(bu 2
printer: Laser printer, inkjet printer, CNC machine
.IP \(bu 2
mass\-storage: Mass storage devices (MSD): USB flash drive, memory card reader, digital audio player, digital camera, external drive
.IP \(bu 2
hub: High speed USB hub
.IP \(bu 2
cdc\-data: Used together with class 02h (Communications and CDC Control) above
.IP \(bu 2
smart\-cart: USB smart card reader
.IP \(bu 2
content\-security: Fingerprint reader
.IP \(bu 2
video: Webcam
.IP \(bu 2
personal\-healthcare: Pulse monitor (watch)
.IP \(bu 2
audio\-video: Webcam, TV
.IP \(bu 2
billboard: Describes USB\-C alternate modes supported by device
.IP \(bu 2
usb\-type\-c\-bridge: An interface to expose and configure the USB Type\-C capabilities of Connectors on USB Hubs or Alternate Mode Adapters
.IP \(bu 2
bdp: This base class is defined for devices that conform to the “VESA USB BDP Device Specification” found at the VESA website. This specification defines the usable set of SubClass and Protocol values. Values outside of this defined spec are reserved. These class codes can only be used in Interface Descriptors
.IP \(bu 2
mctp: This base class is defined for devices that conform to the “MCTP over USB” found at the DMTF website as DSP0283. This specification defines the usable set of SubClass and Protocol values. Values outside of this defined spec are reserved. These class codes can only be used in Interface Descriptors
.IP \(bu 2
i3c\-device: An interface to expose and configure I3C function within a USB device to allow interaction between host software and the I3C device, to drive transaction on the I3C bus to/from target devices
.IP \(bu 2
diagnostic: Trace and debugging equipment
.IP \(bu 2
wireless\-controller: Wireless controllers: Bluetooth adaptors, Microsoft RNDIS
.IP \(bu 2
miscellaneous: This base class is defined for miscellaneous device definitions. Some matching SubClass and Protocols are defined on the USB\-IF website
.IP \(bu 2
application\-specific\-interface: This base class is defined for devices that conform to several class specifications found on the USB\-IF website
.IP \(bu 2
vendor\-specific\-class: This base class is defined for vendors to use as they please
.RE
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Verbosity level: 1 prints device configurations; 2 prints interfaces; 3 prints interface endpoints; 4 prints everything and all blocks
.TP
\fB\-b\fR, \fB\-\-blocks\fR=\fIBLOCKS\fR
Specify the blocks which will be displayed for each device and in what order
.br

.br
\fIPossible values:\fR
.RS 14
.IP \(bu 2
bus\-number: Number of bus device is attached
.IP \(bu 2
device\-number: Bus issued device number
.IP \(bu 2
branch\-position: Position of device in parent branch
.IP \(bu 2
port\-path: Linux style port path
.IP \(bu 2
sys\-path: Linux udev reported syspath
.IP \(bu 2
driver: Linux udev reported driver loaded for device
.IP \(bu 2
icon: Icon based on VID/PID
.IP \(bu 2
vendor\-id: Unique vendor identifier \- purchased from USB IF
.IP \(bu 2
product\-id: Vendor unique product identifier
.IP \(bu 2
name: The device name as reported in descriptor or using usb_ids if None
.IP \(bu 2
manufacturer: The device manufacturer as provided in descriptor or using usb_ids if None
.IP \(bu 2
product\-name: The device product name as reported by usb_ids vidpid lookup
.IP \(bu 2
vendor\-name: The device vendor name as reported by usb_ids vid lookup
.IP \(bu 2
serial: Device serial string as reported by descriptor
.IP \(bu 2
speed: Advertised device capable speed
.IP \(bu 2
tree\-positions: Position along all branches back to trunk device
.IP \(bu 2
bus\-power: macOS system_profiler only \- actually bus current in mA not power!
.IP \(bu 2
bus\-power\-used: macOS system_profiler only \- actually bus current used in mA not power!
.IP \(bu 2
extra\-current\-used: macOS system_profiler only \- actually bus current used in mA not power!
.IP \(bu 2
bcd\-device: The device version
.IP \(bu 2
bcd\-usb: The supported USB version
.IP \(bu 2
class\-code: Base class enum of interface provided by USB IF \- only available when using libusb
.IP \(bu 2
sub\-class: Sub\-class value of interface provided by USB IF \- only available when using libusb
.IP \(bu 2
protocol: Prototol value for interface provided by USB IF \- only available when using libusb
.IP \(bu 2
uid\-class: Class name from USB IDs repository
.IP \(bu 2
uid\-sub\-class: Sub\-class name from USB IDs repository
.IP \(bu 2
uid\-protocol: Protocol name from USB IDs repository
.IP \(bu 2
class: Fully defined USB Class Code based on Class/SubClass/Protocol triplet
.IP \(bu 2
class\-value: Base class as number value
.RE
.TP
\fB\-\-bus\-blocks\fR=\fIBUS_BLOCKS\fR
Specify the blocks which will be displayed for each bus and in what order
.br

.br
\fIPossible values:\fR
.RS 14
.IP \(bu 2
bus\-number: System bus number identifier
.IP \(bu 2
icon: Icon based on VID/PID
.IP \(bu 2
name: Bus name from descriptor or usb_ids
.IP \(bu 2
host\-controller: Host Controller on macOS, vendor put here when using libusb
.IP \(bu 2
pci\-vendor: Understood to be vendor ID \- it is when using libusb
.IP \(bu 2
pci\-device: Understood to be product ID \- it is when using libusb
.IP \(bu 2
pci\-revision: Revsision of hardware
.IP \(bu 2
port\-path: syspath style port path to bus, applicable to Linux only
.RE
.TP
\fB\-\-config\-blocks\fR=\fICONFIG_BLOCKS\fR
Specify the blocks which will be displayed for each configuration and in what order
.br

.br
\fIPossible values:\fR
.RS 14
.IP \(bu 2
name: Name from string descriptor
.IP \(bu 2
number: Number of config, bConfigurationValue; value to set to enable to configuration
.IP \(bu 2
num\-interfaces: Interfaces available for this configuruation
.IP \(bu 2
attributes: Attributes of configuration, bmAttributes
.IP \(bu 2
icon\-attributes: Icon representation of bmAttributes
.IP \(bu 2
max\-power: Maximum current consumption in mA
.RE
.TP
\fB\-\-interface\-blocks\fR=\fIINTERFACE_BLOCKS\fR
Specify the blocks which will be displayed for each interface and in what order
.br

.br
\fIPossible values:\fR
.RS 14
.IP \(bu 2
name: Name from string descriptor
.IP \(bu 2
number: Interface number
.IP \(bu 2
port\-path: Interface port path, applicable to Linux
.IP \(bu 2
class\-code: Class enum of interface provided by USB IF
.IP \(bu 2
sub\-class: Sub\-class value of interface provided by USB IF
.IP \(bu 2
protocol: Prototol value for interface provided by USB IF
.IP \(bu 2
alt\-setting: Interfaces can have the same number but an alternate settings defined here
.IP \(bu 2
driver: Driver obtained from udev on Linux only
.IP \(bu 2
sys\-path: syspath obtained from udev on Linux only
.IP \(bu 2
num\-endpoints: An interface can have many endpoints
.IP \(bu 2
icon: Icon based on ClassCode/SubCode/Protocol
.IP \(bu 2
uid\-class: Class name from USB IDs repository
.IP \(bu 2
uid\-sub\-class: Sub\-class name from USB IDs repository
.IP \(bu 2
uid\-protocol: Protocol name from USB IDs repository
.IP \(bu 2
class: Fully defined USB Class Code based on Class/SubClass/Protocol triplet
.IP \(bu 2
class\-value: Base class as number value
.RE
.TP
\fB\-\-endpoint\-blocks\fR=\fIENDPOINT_BLOCKS\fR
Specify the blocks which will be displayed for each endpoint and in what order
.br

.br
\fIPossible values:\fR
.RS 14
.IP \(bu 2
number: Endpoint number on interface
.IP \(bu 2
direction: Direction of data into endpoint
.IP \(bu 2
transfer\-type: Type of data transfer endpoint accepts
.IP \(bu 2
sync\-type: Synchronisation type (Iso mode)
.IP \(bu 2
usage\-type: Usage type (Iso mode)
.IP \(bu 2
max\-packet\-size: Maximum packet size in bytes endpoint can send/recieve
.IP \(bu 2
interval: Interval for polling endpoint data transfers. Value in frame counts. Ignored for Bulk & Control Endpoints. Isochronous must equal 1 and field may range from 1 to 255 for interrupt endpoints
.RE
.TP
\fB\-m\fR, \fB\-\-more\fR
Print more blocks by default at each verbosity
.TP
\fB\-\-sort\-devices\fR=\fISORT_DEVICES\fR
Sort devices by value
.br

.br
\fIPossible values:\fR
.RS 14
.IP \(bu 2
branch\-position: Sort by position in parent branch
.IP \(bu 2
device\-number: Sort by bus device number
.IP \(bu 2
no\-sort: No sorting; whatever order it was parsed
.RE
.TP
\fB\-\-sort\-buses\fR
Sort devices by bus number
.TP
\fB\-\-group\-devices\fR=\fIGROUP_DEVICES\fR [default: no\-group]
Group devices by value when listing
.br

.br
\fIPossible values:\fR
.RS 14
.IP \(bu 2
no\-group: No grouping
.IP \(bu 2
bus: Group into buses with bus info as heading \- like a flat tree
.RE
.TP
\fB\-\-hide\-buses\fR
Hide empty buses when printing tree; those with no devices. When listing will hide Linux root_hubs
.TP
\fB\-\-hide\-hubs\fR
Hide empty hubs when printing tree; those with no devices. When listing will hide hubs regardless of whether empty of not
.TP
\fB\-\-decimal\fR
Show base16 values as base10 decimal instead
.TP
\fB\-\-no\-padding\fR
Disable padding to align blocks \- will cause \-\-headings to become maligned
.TP
\fB\-\-color\fR=\fICOLOR\fR [default: always]
Output coloring mode
.br

.br
\fIPossible values:\fR
.RS 14
.IP \(bu 2
auto: Show colours if the output goes to an interactive console
.IP \(bu 2
always: Always apply colouring to the output
.IP \(bu 2
never: Never apply colouring to the output
.RE
.TP
\fB\-\-encoding\fR=\fIENCODING\fR [default: glyphs]
Output charactor encoding
.br

.br
\fIPossible values:\fR
.RS 14
.IP \(bu 2
glyphs: Use UTF\-8 private use area charactors such as those used by NerdFont to show glyph icons
.IP \(bu 2
utf8: Use only standard UTF\-8 charactors for the output; no private use area glyph icons
.IP \(bu 2
ascii: Use only ASCII charactors for the output; 0x00 \- 0x7F (127 chars)
.RE
.TP
\fB\-\-icon\fR=\fIICON\fR [default: auto]
When to print icon blocks
.br

.br
\fIPossible values:\fR
.RS 14
.IP \(bu 2
auto: Show icon blocks if the [`Encoding`] supports icons matched in the [`icon::IconTheme`]
.IP \(bu 2
always: Always print icon blocks if included in configured blocks
.IP \(bu 2
never: Never print icon blocks
.RE
.TP
\fB\-\-headings\fR
Show block headings
.TP
\fB\-\-json\fR
Output as json format after sorting, filters and tree settings are applied; without \-tree will be flattened dump of devices
.TP
\fB\-\-from\-json\fR=\fIFROM_JSON\fR
Read from json output rather than profiling system \- must use \-\-tree json dump
.TP
\fB\-F\fR, \fB\-\-force\-libusb\fR
Force libusb profiler on macOS rather than using/combining system_profiler output
.TP
\fB\-c\fR, \fB\-\-config\fR=\fICONFIG\fR
Path to user config file to use for custom icons, colours and default settings
.TP
\fB\-z\fR, \fB\-\-debug\fR
Turn debugging information on. Alternatively can use RUST_LOG env: INFO, DEBUG, TRACE
.TP
\fB\-\-mask\-serials\fR=\fIMASK_SERIALS\fR
Mask serial numbers with \*(Aq*\*(Aq or random chars
.br

.br
\fIPossible values:\fR
.RS 14
.IP \(bu 2
hide: Hide with \*(Aq*\*(Aq char
.IP \(bu 2
scramble: Mask by randomising existing chars
.IP \(bu 2
replace: Mask by replacing length with random chars
.RE
.TP
\fB\-h\fR, \fB\-\-help\fR
Print help (see a summary with \*(Aq\-h\*(Aq)
.TP
\fB\-V\fR, \fB\-\-version\fR
Print version
.SH VERSION
v1.7.0
.SH AUTHORS
John Whittington <john@jbrengineering.co.uk>