Add usage()

1 files changed, 26 insertions, 2 deletions

@@ -15,13 +15,37 @@
 
 ### Code:
 
+wf=/tmp/thesauracles
 dict_server="dict.org"
 dict_database="moby-thesaurus"
 thesaurus_header_lines=3
 
-wf=/tmp/thesauracles
+usage() {
+        cat <<EOF
+thesauracles: the wise sage of synonyms
+
+USAGE:
+        thesauracles -h
+        thesauracles [OPTIONS] WORD
 
-hops=3
+FLAGS:
+ -h     Show this help
+ -q     Be quiet (only exclaim the final word).
+
+OPTIONS:
+ -c DEGREE      The DEGREE of creativity Thesauracles should use.
+                Higher creativity means a more interesting synonym.
+                Default: $degree.
+ -s SERVER      Specify the dict:// SERVER to use.
+                Default: $dict_server.
+ -t THESAURUS   Specify the dict:// THESAURUS to use.
+                Default: $dict_database.
+ -l LINES       Number of LINES to skip from the server output.
+                Might need to change this if you change the server.
+                Default: $thesaurus_header_lines.
+EOF
+        exit ${1:-0}
+}
 
 query() {
         response="/tmp/$1.thesauracles"