Improve usbconfig(8) manual page by adding descriptions for subcommands.
Details
Details
- Reviewers
• hselasky - Group Reviewers
manpages - Commits
- rS356402: MFC r327382:
rS327382: Improve usbconfig(8) manual page by adding descriptions for subcommands.
Diff Detail
Diff Detail
- Repository
- rS FreeBSD src repository - subversion
- Lint
Lint Not Applicable - Unit
Tests Not Applicable
Event Timeline
Comment Actions
Check my comments and update. Thanks!
| usr.sbin/usbconfig/usbconfig.8 | ||
|---|---|---|
| 68 ↗ | (On Diff #36455) | Can you add this: The cnf_index value starts at zero and always increments by one. A value of 255 means unconfigure the device. --HPS |
| 75 ↗ | (On Diff #36455) | Usually there is no need to change the alternate interface selection for a USB device from userspace. |
| 122 ↗ | (On Diff #36455) | By default only HUBs have this feature turned on by default. |
| 129 ↗ | (On Diff #36455) | This is the default command if no commands are given to usbconfig. |
| 140 ↗ | (On Diff #36455) | -d ugen1.2 or -d 1.2 are both valid syntaxes. |
| usr.sbin/usbconfig/usbconfig.8 | ||
|---|---|---|
| 68 ↗ | (On Diff #36455) | What exactly does it mean to "unconfigure the device"? Prevent the driver from attaching, or restore some kind of default value? |
| 122 ↗ | (On Diff #36455) | The default for other devices is "on", right? |
| 140 ↗ | (On Diff #36455) | Indeed, but it might be easier for the user if we limit examples to one kind of those, in this case to what's there in "usbconfig list" output. |
| usr.sbin/usbconfig/usbconfig.8 | ||
|---|---|---|
| 68 ↗ | (On Diff #36455) | "unconfigure the device" is a USB terminologi, which bascially means detach all drivers and reduce power consumption to a minimum, but do not go into power save mode or disappear from USB. |
| 122 ↗ | (On Diff #36455) | Yes: HUBs are default power_save, all other devices unless the attach driver requests, are power_on . |
| 140 ↗ | (On Diff #36455) | No problem. |
| usr.sbin/usbconfig/usbconfig.8 | ||
|---|---|---|
| 68 ↗ | (On Diff #36455) | Can be used to prevent devices from charging, if the vendor follows the USB.org standards. |