Command Line Interface
Command-line syntax cheat sheet
Notation | Example | Description |
---|---|---|
Text without brackets | command | Items which must be typed as shown. |
Text in square brackets | [optional] | Optional parameter. |
Text in angle brackets | <value> | Placeholder for user-provided values. |
Text in curly braces | { required_value =0|=1 } | Group of required choices. At least one option must be included. |
Pipe | option_1|option_2 | Divider between alternative options. Only one option can be selected. |
Run the command line utility:
$ /opt/ftusbrdp/bin/ftusbrdpctl <command> [options]
To see the list of all supported commands, run:
$ /opt/ftusbrdp/bin/ftusbrdpctl help
To see the list of the devices available:
$ /opt/ftusbrdp/bin/ftusbrdpctl list ID VID PID REV Location Status Device name 0006 0bda:8771:0200 1-1 Shared Bluetooth Radio 0005 0c45:6341:0000 5-2 Shared USB 2.0 Camera 0004 1a2c:4094:0110 1-4 Unshared USB Keyboard 0003 093a:2510:0100 1-5 Unshared USB Optical Mouse 0002 152d:0567:2105 6-1 Shared PHD 3.0 Silicon-Power
Here the columns are:
- ID
- Unique device identifier.
- VID:PID:REV
- Device hardware identifier (vendor ID, product ID, revision).
- Location
- USB device topology (can be "unknown" if your system cannot report the device topology).
- Device name and status
- Displays the name of the device and its current status (shared/unshared/connected).
You can share the device by its unique ID (an example below shows how to share USB mass storage device from the list above):
$ /opt/ftusbrdp/bin/ftusbrdpctl share 2
NOTE: Sharing by the device ID allows you to share separately one of the devices that have identical VID:PID:REV.
To unshare the device use unshare command with the same syntax as share:
$ /opt/ftusbrdp/bin/ftusbrdpctl unshare 2
To view details about the device:
$ /opt/ftusbrdp/bin/ftusbrdpctl info 2 VID: 0x152d PID: 0x0567 Revision: 0x2105 Port: 6-1 Device name: PHD 3.0 Silicon-Power Serial: 15001161019030000146 Device: class 0x00, subclass 0x00, protocol 0x00 Interface #000: Mass storage