mirror of
https://github.com/Lencerf/p9cpu.git
synced 2024-10-23 05:06:23 +00:00
66 lines
1.7 KiB
Markdown
66 lines
1.7 KiB
Markdown
|
rust-9p
|
||
|
|
=====
|
||
|
|
Tokio-based asynchronous filesystems library using 9P2000.L protocol, an extended variant of 9P from Plan 9.
|
||
|
|
|
||
|
|
[](https://travis-ci.org/pfpacket/rust-9p)
|
||
|
|
|
||
|
|
[Documentation](https://pfpacket.github.io/rust-9p/rs9p/index.html)
|
||
|
|
|
||
|
|
|
||
|
|
## Build
|
||
|
|
Use Rust nightly.
|
||
|
|
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
Add the following to your crate:
|
||
|
|
|
||
|
|
```rust
|
||
|
|
extern crate rs9p;
|
||
|
|
```
|
||
|
|
|
||
|
|
|
||
|
|
## unpfs
|
||
|
|
`unpfs` is the reference implementation of a file server which exports your filesystem.
|
||
|
|
You can build unpfs with the following commands below:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
cd example/unpfs/
|
||
|
|
cargo build --verbose --release
|
||
|
|
```
|
||
|
|
and run unpfs with the following command to export `/exportdir`:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
# TCP
|
||
|
|
cargo run --release 'tcp!0.0.0.0!564' /exportdir
|
||
|
|
# or
|
||
|
|
./target/release/unpfs 'tcp!0.0.0.0!564' /exportdir
|
||
|
|
|
||
|
|
# Unix domain socket:
|
||
|
|
# port number is a suffix to the unix domain socket
|
||
|
|
# 'unix!/tmp/unpfs-socket!n' creates `/tmp/unpfs-socket:n`
|
||
|
|
cargo run --release 'unix!/tmp/unpfs-socket!0' /exportdir
|
||
|
|
```
|
||
|
|
You are now ready to import/mount the remote filesystem.
|
||
|
|
Let's mount it at `/mountdir`:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
# TCP
|
||
|
|
sudo mount -t 9p -o version=9p2000.L,trans=tcp,port=564,uname=$USER 127.0.0.1 /mountdir
|
||
|
|
# Unix domain socket
|
||
|
|
sudo mount -t 9p -o version=9p2000.L,trans=unix,uname=$USER /tmp/unpfs-socket:0 /mountdir
|
||
|
|
```
|
||
|
|
|
||
|
|
| Mount option | Value |
|
||
|
|
|---|---|
|
||
|
|
| version | must be "9p2000.L" |
|
||
|
|
| trans | an alternative v9fs transport. "tcp" or "unix" |
|
||
|
|
| port | port to connect to on the remote server |
|
||
|
|
| uname | user name to attempt mount as on the remote server |
|
||
|
|
|
||
|
|
See [v9fs documentation](https://www.kernel.org/doc/Documentation/filesystems/9p.txt) for more details.
|
||
|
|
|
||
|
|
|
||
|
|
## License
|
||
|
|
rust-9p is distributed under the BSD 3-Clause License.
|
||
|
|
See LICENSE for details.
|