Documentation updates

README.md

@@ -50,7 +50,7 @@ The -f, -k, -r, -tf, -tp, and -u flags can be used multiple times, together, and
 Options:
 These modify or filter the transformation mode.
 
-  -b    Bypass map creation and use stdout as primary output.
+  -b    Bypass map creation and use stdout as primary output. Disables some options.
   -d int
         Enable debug mode with verbosity levels [0-2].
   -f value
@@ -66,7 +66,7 @@ These modify or filter the transformation mode.
   -n int
         Maximum number of items to return in output.
   -o string
-        Output to JSON file in addition to stdout.
+        Output to JSON file in addition to stdout. Accepts file names and paths.
   -p int
         Change parsing mode for URL input. [0 = Strict, 1 = Permissive, 2 = Maximum] [0-2].
   -r value
@@ -78,10 +78,10 @@ These modify or filter the transformation mode.
   -tf value
         Read additional files for transformations if applicable.
   -tp value
-        Read a template file for multiple transformations and operations.
+        Read a template file for multiple transformations and operations. Cannot be used with -t flag.
   -u value
         Read additional URLs for input.
-  -v    Show verbose output when possible.
+  -v    Show verbose output when possible. (Can show additional metadata in some modes.)
   -vv
         Show statistics output when possible.
   -vvv
@@ -119,21 +119,21 @@ These create or alter based on the selected mode.
   -t replace-all -tf [file]
         Transforms input by replacing all strings with all matches from a ':' separated file.
   -t rule-append
-        Transforms input into append rules.
+        Transforms input by creating append rules.
   -t rule-append-remove
-        Transforms input into append-remove rules.
+        Transforms input by creating append-remove rules.
   -t rule-insert -i [index]
-        Transforms input into insert rules starting at index.
+        Transforms input by creating insert rules starting at index.
   -t rule-overwrite -i [index]
-        Transforms input into overwrite rules starting at index.
+        Transforms input by creating overwrite rules starting at index.
   -t rule-prepend
-        Transforms input into prepend rules.
+        Transforms input by creating prepend rules.
   -t rule-prepend-remove
-        Transforms input into prepend-remove rules.
+        Transforms input by creating prepend-remove rules.
   -t rule-prepend-toggle
-        Transforms input into prepend-toggle rules. Creating camelCase and PascalCase.
+        Transforms input by creating prepend-toggle rules.
   -t rule-toggle -i [index]
-        Transforms input into toggle rules starting at index.
+        Transforms input by creating toggle rules starting at index.
   -t substring -i [index]
         Transforms input by extracting substrings starting at index and ending at index.
   -t swap-single -tf [file]

docs/USAGE.md

@@ -1,5 +1,5 @@
 # Password Transformation Tool (PTT) Usage Guide
-## Version 0.3.4
+## Version 0.3.5
 
 ### Table of Contents
 #### Getting Started
@@ -114,7 +114,7 @@ These flags work with files and directories.
 
 #### Options:
 ```
-  -b    Bypass map creation and use stdout as primary output.
+  -b    Bypass map creation and use stdout as primary output. Disables some options.
   -d int
         Enable debug mode with verbosity levels [0-2].
   -f value
@@ -130,7 +130,7 @@ These flags work with files and directories.
   -n int
         Maximum number of items to return in output.
   -o string
-        Output to JSON file in addition to stdout.
+        Output to JSON file in addition to stdout. Accepts file names and paths.
   -p int
         Change parsing mode for URL input. [0 = Strict, 1 = Permissive, 2 = Maximum] [0-2].
   -r value
@@ -142,10 +142,10 @@ These flags work with files and directories.
   -tf value
         Read additional files for transformations if applicable.
   -tp value
-        Read a template file for multiple transformations and operations.
+        Read a template file for multiple transformations and operations. Cannot be used with -t flag.
   -u value
         Read additional URLs for input.
-  -v    Show verbose output when possible.
+  -v    Show verbose output when possible. (Can show additional metadata in some modes.)
   -vv
         Show statistics output when possible.
   -vvv
@@ -184,21 +184,21 @@ The following transformations can be used with the `-t` flag:
   -t replace-all -tf [file]
         Transforms input by replacing all strings with all matches from a ':' separated file.
   -t rule-append
-        Transforms input into append rules.
+        Transforms input by creating append rules.
   -t rule-append-remove
-        Transforms input into append-remove rules.
+        Transforms input by creating append-remove rules.
   -t rule-insert -i [index]
-        Transforms input into insert rules starting at index.
+        Transforms input by creating insert rules starting at index.
   -t rule-overwrite -i [index]
-        Transforms input into overwrite rules starting at index.
+        Transforms input by creating overwrite rules starting at index.
   -t rule-prepend
-        Transforms input into prepend rules.
+        Transforms input by creating prepend rules.
   -t rule-prepend-remove
-        Transforms input into prepend-remove rules.
+        Transforms input by creating prepend-remove rules.
   -t rule-prepend-toggle
-        Transforms input into prepend-toggle rules. Creating camelCase and PascalCase.
+        Transforms input by creating prepend-toggle rules.
   -t rule-toggle -i [index]
-        Transforms input into toggle rules starting at index.
+        Transforms input by creating toggle rules starting at index.
   -t substring -i [index]
         Transforms input by extracting substrings starting at index and ending at index.
   -t swap-single -tf [file]

main.go

@@ -44,14 +44,14 @@ func main() {
 		fmt.Fprintln(os.Stderr, "\nTransformation Modes:")
 		fmt.Fprintf(os.Stderr, "These create or alter based on the selected mode.\n\n")
 		modes := map[string]string{
-			"rule-append":                        "Transforms input into append rules.",
-			"rule-append-remove":                 "Transforms input into append-remove rules.",
-			"rule-prepend":                       "Transforms input into prepend rules.",
-			"rule-prepend-remove":                "Transforms input into prepend-remove rules.",
-			"rule-prepend-toggle":                "Transforms input into prepend-toggle rules. Creating camelCase and PascalCase.",
-			"rule-insert -i [index]":             "Transforms input into insert rules starting at index.",
-			"rule-overwrite -i [index]":          "Transforms input into overwrite rules starting at index.",
-			"rule-toggle -i [index]":             "Transforms input into toggle rules starting at index.",
+			"rule-append":                        "Transforms input by creating append rules.",
+			"rule-append-remove":                 "Transforms input by creating append-remove rules.",
+			"rule-prepend":                       "Transforms input by creating prepend rules.",
+			"rule-prepend-remove":                "Transforms input by creating prepend-remove rules.",
+			"rule-prepend-toggle":                "Transforms input by creating prepend-toggle rules.",
+			"rule-insert -i [index]":             "Transforms input by creating insert rules starting at index.",
+			"rule-overwrite -i [index]":          "Transforms input by creating overwrite rules starting at index.",
+			"rule-toggle -i [index]":             "Transforms input by creating toggle rules starting at index.",
 			"encode":                             "Transforms input by HTML and Unicode escape encoding.",
 			"decode":                             "Transforms input by HTML and Unicode escape decoding.",
 			"hex":                                "Transforms input by encoding strings into $HEX[...] format.",
@@ -84,22 +84,22 @@ func main() {
 	}
 
 	// Define command line flags
-	verbose := flag.Bool("v", false, "Show verbose output when possible.")
+	verbose := flag.Bool("v", false, "Show verbose output when possible. (Can show additional metadata in some modes.)")
 	verbose2 := flag.Bool("vv", false, "Show statistics output when possible.")
 	verbose3 := flag.Bool("vvv", false, "Show verbose statistics output when possible.")
 	minimum := flag.Int("m", 0, "Minimum numerical frequency to include in output.")
 	outputVerboseMax := flag.Int("n", 0, "Maximum number of items to return in output.")
 	transformation := flag.String("t", "", "Transformation to apply to input.")
 	replacementMask := flag.String("rm", "uldsbt", "Replacement mask for transformations if applicable.")
-	jsonOutput := flag.String("o", "", "Output to JSON file in addition to stdout.")
-	bypassMap := flag.Bool("b", false, "Bypass map creation and use stdout as primary output.")
+	jsonOutput := flag.String("o", "", "Output to JSON file in addition to stdout. Accepts file names and paths.")
+	bypassMap := flag.Bool("b", false, "Bypass map creation and use stdout as primary output. Disables some options.")
 	debugMode := flag.Int("d", 0, "Enable debug mode with verbosity levels [0-2].")
 	URLParsingMode := flag.Int("p", 0, "Change parsing mode for URL input. [0 = Strict, 1 = Permissive, 2 = Maximum] [0-2].")
 	flag.Var(&retain, "k", "Only keep items in a file.")
 	flag.Var(&remove, "r", "Only keep items not in a file.")
 	flag.Var(&readFiles, "f", "Read additional files for input.")
 	flag.Var(&transformationFiles, "tf", "Read additional files for transformations if applicable.")
-	flag.Var(&templateFiles, "tp", "Read a template file for multiple transformations and operations.")
+	flag.Var(&templateFiles, "tp", "Read a template file for multiple transformations and operations. Cannot be used with -t flag.")
 	flag.Var(&intRange, "i", "Starting index for transformations if applicable. Accepts ranges separated by '-'.")
 	flag.Var(&lenRange, "l", "Only output items of a certain length (does not adjust for rules). Accepts ranges separated by '-'.")
 	flag.Var(&wordRange, "w", "Number of words for transformations if applicable. Accepts ranges separated by '-'.")