Skip to content

Commit

Permalink
Added more doc
Browse files Browse the repository at this point in the history
  • Loading branch information
RunDevelopment committed Jun 9, 2021
1 parent cf5247c commit e29f331
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion src/main/java/org/netspeak/usage/Cli.java
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,12 @@
"A CLI for the Netspeak 4 data preporcessing and indexing process." }, optionListHeading = "%nOptions:%n", mixinStandardHelpOptions = true)
public class Cli implements Runnable {

@Option(names = { "-c", "--config" }, description = { "The path of a config file to pass" })
@Option(names = { "-c", "--config" }, description = { "The path of a `.properties` config file.",
"The keys of the file are interpreeted as long-name arguments passed to the CLI (unknown arguments will be ignored)."
+ " This means that the CLI can be used by simply passing in a config file."
+ " Note: If an argument is defined in the config file and passed explicitly to the CLI, the CLI argument will be used.",
"To pass in multiple input paths, separate the paths using a semicolon (';')."
+ " Leading and trailing spaces around paths will be removed." })
Path config;

@Option(names = { "-l", "--lang" }, description = { "The language of the data set(s) to process.",
Expand Down

0 comments on commit e29f331

Please sign in to comment.