From d646926859b22eaf001aa2b6ac33d4aab6ce0add Mon Sep 17 00:00:00 2001 From: Gerhard Sittig Date: Wed, 1 May 2019 20:41:25 +0200 Subject: [PATCH] doc: discuss "colons in conn= specs" in the manpage This should be obvious, but it seems it's not. Extend the paragraph which introduces conn= specs for USB devices. Mention that colons are not available within conn= specs because they are used to separate -d fields from each other (driver name, and options like 'conn'). --- doc/sigrok-cli.1 | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/doc/sigrok-cli.1 b/doc/sigrok-cli.1 index 99b14cf..3ec6768 100644 --- a/doc/sigrok-cli.1 +++ b/doc/sigrok-cli.1 @@ -51,8 +51,10 @@ Openbench Logic Sniffer: .RB " $ " "sigrok\-cli \-\-driver=ols:conn=/dev/ttyACM0" " [...]" .sp Some USB devices don't use a unique VendorID/ProductID combination, and thus -need that specified as well. This also uses the \fBconn\fP option, using -either \fBVendorID.ProductID\fP or \fBbus.address\fP: +need that specified as well. Notice that colons are used to separate the +driver name from the \fBconn\fP option, thus colons cannot be used within the +\fBconn\fP option's argument. To select a specific USB device, use either +\fBVendorID.ProductID\fP or \fBbus.address\fP: .sp USB \fBVendorID.ProductID\fP example: .sp -- 2.11.4.GIT