Improve usbconfig(8) manual page by adding descriptions for subcommands.
Details
- Reviewers
• hselasky - Group Reviewers
manpages - Commits
- rS356402: MFC r327382:
rS327382: Improve usbconfig(8) manual page by adding descriptions for subcommands.
Diff Detail
- Repository
- rS FreeBSD src repository - subversion
- Lint
Lint Passed - Unit
No Test Coverage - Build Status
Buildable 13897 Build 14102: arc lint + arc unit
Event Timeline
Check my comments and update. Thanks!
usr.sbin/usbconfig/usbconfig.8 | ||
---|---|---|
146 | 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 | |
150 | -d ugen1.2 or -d 1.2 are both valid syntaxes. | |
153 | Usually there is no need to change the alternate interface selection for a USB device from userspace. | |
200 | By default only HUBs have this feature turned on by default. | |
207 | This is the default command if no commands are given to usbconfig. |
usr.sbin/usbconfig/usbconfig.8 | ||
---|---|---|
146 | What exactly does it mean to "unconfigure the device"? Prevent the driver from attaching, or restore some kind of default value? | |
150 | 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. | |
200 | The default for other devices is "on", right? |
usr.sbin/usbconfig/usbconfig.8 | ||
---|---|---|
146 | "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. | |
150 | No problem. | |
200 | Yes: HUBs are default power_save, all other devices unless the attach driver requests, are power_on . |
usr.sbin/usbconfig/usbconfig.8 | ||
---|---|---|
146 | Can be used to prevent devices from charging, if the vendor follows the USB.org standards. |