From owner-svn-src-projects@FreeBSD.ORG  Mon Aug  1 13:46:48 2011
Return-Path: <owner-svn-src-projects@FreeBSD.ORG>
Delivered-To: svn-src-projects@freebsd.org
Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34])
	by hub.freebsd.org (Postfix) with ESMTP id 317611065677;
	Mon,  1 Aug 2011 13:46:48 +0000 (UTC) (envelope-from mav@FreeBSD.org)
Received: from svn.freebsd.org (svn.freebsd.org [IPv6:2001:4f8:fff6::2c])
	by mx1.freebsd.org (Postfix) with ESMTP id 219F18FC14;
	Mon,  1 Aug 2011 13:46:48 +0000 (UTC)
Received: from svn.freebsd.org (localhost [127.0.0.1])
	by svn.freebsd.org (8.14.4/8.14.4) with ESMTP id p71DkmFf099412;
	Mon, 1 Aug 2011 13:46:48 GMT (envelope-from mav@svn.freebsd.org)
Received: (from mav@localhost)
	by svn.freebsd.org (8.14.4/8.14.4/Submit) id p71Dkmps099410;
	Mon, 1 Aug 2011 13:46:48 GMT (envelope-from mav@svn.freebsd.org)
Message-Id: <201108011346.p71Dkmps099410@svn.freebsd.org>
From: Alexander Motin <mav@FreeBSD.org>
Date: Mon, 1 Aug 2011 13:46:48 +0000 (UTC)
To: src-committers@freebsd.org, svn-src-projects@freebsd.org
X-SVN-Group: projects
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
Cc: 
Subject: svn commit: r224576 - projects/hid/usr.bin/usbhidctl
X-BeenThere: svn-src-projects@freebsd.org
X-Mailman-Version: 2.1.5
Precedence: list
List-Id: "SVN commit messages for the src &quot; projects&quot;
	tree" <svn-src-projects.freebsd.org>
List-Unsubscribe: <http://lists.freebsd.org/mailman/listinfo/svn-src-projects>, 
	<mailto:svn-src-projects-request@freebsd.org?subject=unsubscribe>
List-Archive: <http://lists.freebsd.org/pipermail/svn-src-projects>
List-Post: <mailto:svn-src-projects@freebsd.org>
List-Help: <mailto:svn-src-projects-request@freebsd.org?subject=help>
List-Subscribe: <http://lists.freebsd.org/mailman/listinfo/svn-src-projects>, 
	<mailto:svn-src-projects-request@freebsd.org?subject=subscribe>
X-List-Received-Date: Mon, 01 Aug 2011 13:46:48 -0000

Author: mav
Date: Mon Aug  1 13:46:47 2011
New Revision: 224576
URL: http://svn.freebsd.org/changeset/base/224576

Log:
  Add SYNTAX section to manual page.

Modified:
  projects/hid/usr.bin/usbhidctl/usbhidctl.1

Modified: projects/hid/usr.bin/usbhidctl/usbhidctl.1
==============================================================================
--- projects/hid/usr.bin/usbhidctl/usbhidctl.1	Mon Aug  1 13:41:38 2011	(r224575)
+++ projects/hid/usr.bin/usbhidctl/usbhidctl.1	Mon Aug  1 13:46:47 2011	(r224576)
@@ -103,6 +103,37 @@ Reset reports to zero before processing
 .Fl w
 arguments. If not specified, current values will be requested from device.
 .El
+.Sh SYNTAX
+.Nm
+compares the names of items specified on the command line against the human
+interface items reported by the USB device.
+Each human interface item is mapped from its native form to a human readable
+name, using the HID usage table file.
+Command line items are compared with the generated item names,
+and the USB HID device is operated on when a match is found.
+.Pp
+Each human interface item is named by the
+.Qq page
+it appears in, the
+.Qq usage
+within that page, and the list of
+.Qq collections
+containing the item.
+Each collection in turn is also identified by page, and
+the usage within that page.
+.Pp
+On the
+.Nm
+command line the page name is separated from the usage name with the character
+.Sq Cm \&: .
+The collections are separated by the character
+.Sq Cm \&. .
+.Pp
+Some devices give the same name to more than one item.
+.Nm
+supports isolating each item by appending a
+.Sq Cm \&# .
+character and a decimal item instance number, starting at zero.
 .Sh FILES
 .Pa /usr/share/misc/usb_hid_usages
 The default HID usage table.