Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
PauMAVA committed Apr 22, 2023
1 parent 1a7c880 commit 352e1ee
Showing 1 changed file with 52 additions and 0 deletions.
52 changes: 52 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,55 @@ SUBCOMMANDS:
remount Remount an existing ramdisk
unmount Unmount an existing ramdisk
```
#### Copying data back to disk
In order to copy data back to disk you can use the flag `-c` or `--copy-to` in the `mount` and `unmount` subcommands.

#### Sub-commands usage
Cargo ramdisk has three main subcommands for its operation each one with its options and flags.

##### mount
```
Mount a ramdisk, same as not specifying a subcommand
USAGE:
cargo ramdisk mount [FLAGS] [OPTIONS]
FLAGS:
-c, --copy-to Copy the contents of the target folder to the ramdisk
-h, --help Prints help information
-V, --version Prints version information
OPTIONS:
-t, --target <target> The path to the target folder where compilation output is written [default: ./target]
```

##### remount
```
Remount an existing ramdisk
USAGE:
cargo ramdisk remount [OPTIONS]
FLAGS:
-h, --help Prints help information
-V, --version Prints version information
OPTIONS:
-t, --target <target> The path to the target folder where compilation output is written [default: target]
```

##### unmount
```
Unmount an existing ramdisk
USAGE:
cargo ramdisk unmount [FLAGS] [OPTIONS]
FLAGS:
-c, --copy-back Copy back the contents of the ramdisk to the target folder
-h, --help Prints help information
-V, --version Prints version information
OPTIONS:
-t, --target <target> The path to the target folder where compilation output is written [default: target]
```

0 comments on commit 352e1ee

Please sign in to comment.