Skip to content

Commit

Permalink
Update help text with descriptions of options
Browse files Browse the repository at this point in the history
  • Loading branch information
triarius committed Jan 19, 2024
1 parent ab4c1d5 commit 8e33911
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ cargo install --git https://github.com/triarius/riceware
Usage: riceware [OPTIONS]
Options:
-n, --num-words <NUM_WORDS> [default: 4]
-s, --separator <SEPARATOR> [default: " "]
-d, --dict-path <DICT_PATH>
-n, --num-words <NUM_WORDS> The number of words in the passphrase [default: 4]
-s, --separator <SEPARATOR> The string to separate words in the passphrase [default: " "]
-d, --dict-path <DICT_PATH> A path to a dictionary file. A builtin dictionary is used if not provided
-h, --help Print help
-V, --version Print version
```
3 changes: 3 additions & 0 deletions src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,15 @@ use eyre::Result;
#[derive(Parser, Debug)]
#[command(author, version, about, long_about = None)]
struct Args {
/// The number of words in the passphrase
#[arg(short, long, default_value = "4")]
num_words: usize,

/// The string to separate words in the passphrase
#[arg(short, long, default_value = " ")]
separator: String,

/// A path to a dictionary file. A builtin dictionary is used if not provided.
#[arg(short, long)]
dict_path: Option<String>,
}
Expand Down

0 comments on commit 8e33911

Please sign in to comment.