@@ -36,50 +36,66 @@ This will install:
3636- A command line tool ` usbipd ` .\
3737 The location of this tool will be added to the ` PATH ` environment variable.
3838- A firewall rule called ` usbipd ` to allow all local subnets to connect to the service.\
39- You can modify this firewall rule to fine tune access control.\
40- :information_source : \
41- If you are using a third-party firewall, you may have to reconfigure it to allow
42- incoming connections on TCP port 3240.
39+ You can modify this firewall rule to fine tune access control.
40+
41+ > [ !NOTE]
42+ > If you are using a third-party firewall, you may have to reconfigure it to allow
43+ > incoming connections on TCP port 3240.
4344
4445## How to use
4546
4647### Share Devices
4748
4849By default devices are not shared with USBIP clients.
49- To lookup and share devices, open a command prompt as an Administrator and use the ` usbipd ` tool.
50- For example:
50+ To lookup and share devices, run the following commands with administrator privileges:
5151
5252``` powershell
5353usbipd --help
5454usbipd list
5555usbipd bind --busid=<BUSID>
5656```
5757
58+ Sharing a device is persistent; it survives reboots.
59+
60+ > [ !TIP]
61+ > See the [ wiki] ( https://github.com/dorssel/usbipd-win/wiki/Tested-Devices ) for a list of tested devices.
62+
5863### Connecting Devices
5964
60- From another (possibly virtual) machine running Linux, use ` usbip ` to claim the USB device:
65+ Attaching devices to a client is non-persistent. You will have to re-attach after a reboot,
66+ or when the device resets or is physically unplugged/replugged.
67+
68+ #### Non-WSL 2
69+
70+ From another (possibly virtual) machine running Linux, use the ` usbip ` client-side tool:
6171
6272``` bash
6373usbip list --remote=< HOST>
6474sudo usbip attach --remote=< HOST> --busid=< BUSID>
6575```
6676
67- A list of tested devices can be found on the [ wiki] ( https://github.com/dorssel/usbipd-win/wiki ) .
68- Please file an issue if your device is not working.
77+ > [ !NOTE]
78+ > Client-side tooling exists for other operating systems such as Microsoft Windows, but not as part of this project.
79+
80+ #### WSL 2
6981
70- ### WSL 2
82+ > [ !TIP]
83+ > In case you have used ` usbipd ` with WSL 2 before, the following has changed since version 4.0.0:
84+ >
85+ > - You have to share the device using ` usbipd bind ` first.
86+ > - You no longer have to install any client-side tooling.
87+ > - You no longer have to specify a specific distribution.
88+ > - The syntax for the command to attach has changed slightly.
7189
72- You can use the ` usbipd wsl ` subcommand to share and connect a device with a single command.
73- For example, open a command prompt:
90+ You can attach the device from within Windows with the following command, which does not require administrator privileges:
7491
7592``` powershell
76- usbipd wsl --help
77- usbipd wsl list
78- usbipd wsl attach --busid=<BUSID>
93+ usbipd attach --wsl --busid=<BUSID>
7994```
8095
81- :information_source : \
82- Instructions on how to prepare WSL 2 for USBIP can be found on the [ wiki] ( https://github.com/dorssel/usbipd-win/wiki/WSL-support ) .
96+ > [ !TIP]
97+ > See the [ wiki] ( https://github.com/dorssel/usbipd-win/wiki/WSL-support ) on how to add drivers
98+ > for USB devices that are not supported by the default WSL 2 kernel.
8399
84100### GUI
85101
@@ -97,5 +113,3 @@ Alternatively, use the Windows Package Manager:
97113``` powershell
98114winget uninstall usbipd
99115```
100-
101- There should be no left-overs; please file an issue if you do find any.
0 commit comments