diff --git a/docs/1.-How-to-Use-JPlag.md b/docs/1.-How-to-Use-JPlag.md index a68e3c43b..ac231b6f4 100644 --- a/docs/1.-How-to-Use-JPlag.md +++ b/docs/1.-How-to-Use-JPlag.md @@ -11,79 +11,56 @@ A list of language specific options can be obtained by requesting the help page The following arguments can be used to control JPlag: ``` -Usage: jplag [OPTIONS] [root-dirs[,root-dirs...]...] [COMMAND] - +Parameter descriptions: [root-dirs[,root-dirs...]...] - Root-directory with submissions to check for plagiarism - + Root-directory with submissions to check for plagiarism. -bc, --bc, --base-code= - Path of the directory containing the base code - (common framework used in all submissions) - - -h, --help display this help and exit - -l, --language= - Select the language to parse the submissions (default: - java). The language names are the same as the - subcommands. - - -n, --shown-comparisons= - The maximum number of comparisons that will be shown - in the generated report, if set to -1 all comparisons - will be shown (default: 100) - + Path to the base code directory (common framework used in all submissions). + -l, --language= + Select the language of the submissions (default: java). See subcommands below. + -M, --mode=<{RUN, VIEW, RUN_AND_VIEW}> + The mode of JPlag: either only run analysis, only open the viewer, or do both (default: null) + -n, --shown-comparisons= + The maximum number of comparisons that will be shown in the generated report, if set to -1 all comparisons will be shown (default: 500) -new, --new=[,...] - Root-directory with submissions to check for plagiarism - (same as the root directory) - + Root-directories with submissions to check for plagiarism (same as root). + --normalize Activate the normalization of tokens. Supported for languages: Java, C++. -old, --old=[,...] - Root-directory with prior submissions to compare against - - -r, --result-directory= - Name of the directory in which the comparison results - will be stored (default: result) - - -t, --min-tokens= - Tunes the comparison sensitivity by adjusting the - minimum token required to be counted as a matching - section. A smaller increases the sensitivity but - might lead to more false-positives + Root-directories with prior submissions to compare against. + -r, --result-file= + Name of the file in which the comparison results will be stored (default: results). Missing .zip endings will be automatically added. + -t, --min-tokens= + Tunes the comparison sensitivity by adjusting the minimum token required to be counted as a matching section. A smaller value increases the sensitivity but might lead to more + false-positives. Advanced - -d, --debug Debug parser. Non-parsable files will be stored - (default: false) - - -m, --similarity-threshold= - Comparison similarity threshold [0.0-1.0]: All - comparisons above this threshold will be saved - (default: 0.0) - - -p, --suffixes=[,...] - comma-separated list of all filename suffixes that are - included - - -s, --subdirectory= - Look in directories /*/ for programs - - -x, --exclusion-file= - All files named in this file will be ignored in the - comparison (line-separated list) + --csv-export Export pairwise similarity values as a CSV file. + -d, --debug Store on-parsable files in error folder. + -m, --similarity-threshold= + Comparison similarity threshold [0.0-1.0]: All comparisons above this threshold will be saved (default: 0.0). + -p, --suffixes=[,...] + comma-separated list of all filename suffixes that are included. + -P, --port= The port used for the internal report viewer (default: 1996). + -s, --subdirectory= + Look in directories /*/ for programs. + -x, --exclusion-file= + All files named in this file will be ignored in the comparison (line-separated list). Clustering - --cluster-alg, --cluster-algorithm= - Which clustering algorithm to use. Agglomerative merges - similar submissions bottom up. Spectral clustering is - combined with Bayesian Optimization to execute - the k-Means clustering algorithm multiple times, - hopefully finding a "good" clustering - automatically. (default: spectral) - - --cluster-metric= - The metric used for clustering. AVG is intersection - over union, MAX can expose some attempts of - obfuscation. (default: MAX) - - --cluster-skip Skips the clustering (default: false) -Commands: + --cluster-alg, --cluster-algorithm=<{AGGLOMERATIVE, SPECTRAL}> + Specifies the clustering algorithm (default: spectral). + --cluster-metric=<{AVG, MIN, MAX, INTERSECTION}> + The similarity metric used for clustering (default: average similarity). + --cluster-skip Skips the cluster calculation. + +Subsequence Match Merging + --gap-size= + Maximal gap between neighboring matches to be merged (between 1 and minTokenMatch, default: 6). + --match-merging Enables merging of neighboring matches to counteract obfuscation attempts. + --neighbor-length= + Minimal length of neighboring matches to be merged (between 1 and minTokenMatch, default: 2). + +Subcommands (supported languages): c cpp csharp