help: Document the archiving flags

The only caveat is the limitations of the man library will not
allow me to write more in-depth documentation of the new flags. Maybe if
I go through refactoring the binary side using clap this will be easier.
This commit is contained in:
Lux Aliaga 2023-02-19 13:28:19 -03:00
parent d148a96e06
commit 75fb04d674
Signed by: lux
GPG Key ID: B56C805968637437
2 changed files with 36 additions and 0 deletions

View File

@ -62,6 +62,30 @@ fn vento() -> Result<Page> {
.long("--undo")
.help("Undoes the last action"),
)
.flag(
Flag::new()
.short("-e")
.long("--export-inv")
.help("Exports an inventory"),
)
.flag(
Flag::new()
.short("-E")
.long("--export-dir")
.help("Exports the Vento directory"),
)
.flag(
Flag::new()
.short("-g")
.long("--import-inv")
.help("Imports an inventory archive"),
)
.flag(
Flag::new()
.short("-G")
.long("--import-dir")
.help("Imports a Vento directory archive"),
)
.flag(
Flag::new()
.short("-i")

View File

@ -30,6 +30,10 @@ pub fn vento() -> Result<()> {
- {}: Lists files in selected inventory
- {}: Switches slots
- {}: Undoes the last action
- {}: Exports an inventory
- {}: Exports the Vento directory
- {}: Imports an inventory archive
- {}: Imports a Vento directory archive
- {}: Initializes Vento
- {}: Displays this message",
"Vento".bold().blue(),
@ -39,6 +43,14 @@ pub fn vento() -> Result<()> {
.green(),
"vento ( -c | --switch )".bold().green(),
"vento ( -u | --undo )".bold().green(),
"vento ( -e | --export-inv ) [ slot ] [ output ]"
.bold()
.green(),
"vento ( -E | --export-dir ) [ output ]".bold().green(),
"vento ( -g | --import-inv ) [ input ] [ slot ]"
.bold()
.green(),
"vento ( -G | --import-dir ) [ input ]".bold().green(),
"vento ( -i | --init )".bold().green(),
"vento ( -h | --help )".bold().green()
);